/** * Generated by orval v6.25.0 🍺 * Do not edit manually. * Aptaero.VisitorPass.WebAPI * OpenAPI spec version: 1.0 */ export type PublicAccessVisitorAllotmentAvailabilityParams = { isNewPass: boolean; lastName: string; firstName: string; dOB: string; gender: GenderType; scheduledArrivalTime: string; airportID: string; terminalID?: string; carrierID?: string; categoryID?: string; requesterCompanyID?: string; escortCompanyID?: string; deviceID?: string; deviceType?: DeviceType; }; export type PublicAccessVisitorGetParams = { scheduledStartDate: string; scheduledEndDate: string; searchQuery?: string; sortColumn?: AirportVisitorDBSortableColumn; sortDescending?: boolean; pageNumber?: number; pageSize?: number; }; export type MidfieldTripReportReservationHistoryParams = { airportID?: string; startDateTime: string; endDateTime: string; midfieldTripStatuses?: MidfieldTripStatus[]; midfieldPersonID?: string; }; export type MidfieldTripGetDetailParams = { includePhotos?: boolean; }; export type MidfieldTripGetParams = { dateStart: string; dateEnd: string; statuses?: MidfieldTripStatus[]; searchQuery?: string; sortColumn?: MidfieldTripDBSortableColumn; sortDescending?: boolean; pageNumber?: number; pageSize?: number; includePhotos?: boolean; }; export type MidfieldPersonGetParams = { searchQuery: string; }; export type VisitorType = typeof VisitorType[keyof typeof VisitorType]; export declare const VisitorType: { readonly PublicAccess: "PublicAccess"; }; export type UserStatus = typeof UserStatus[keyof typeof UserStatus]; export declare const UserStatus: { readonly Inactive: "Inactive"; readonly Active: "Active"; readonly Invited: "Invited"; }; export type UserGetParams = { status?: UserStatus; }; export interface UserSaveModel { email: string; firstName: string; lastName: string; loginMethod?: LoginMethod; roleIDs: string[]; username: string; } export type UserMfaVerificationType = typeof UserMfaVerificationType[keyof typeof UserMfaVerificationType]; export declare const UserMfaVerificationType: { readonly Email: "Email"; readonly AuthenticatorApp: "AuthenticatorApp"; }; export interface UserModel { email?: string; firstName: string; id: string; lastLoginTimestampUTC?: string; lastName: string; loginMethod?: LoginMethod; mfaVerificationType?: UserMfaVerificationType; passwordChangedTimestampUTC?: string; roleIDs: string[]; status: UserStatus; telephone?: string; /** @deprecated */ temporaryPassword?: string; username: string; } export interface UserAuditTrailModel { records: AuditTrailModel[]; } export interface TerminalModel { airportID: string; email?: string; id: string; name: string; } export type StoplistMatchType = typeof StoplistMatchType[keyof typeof StoplistMatchType]; export declare const StoplistMatchType: { readonly NotMatch: "NotMatch"; readonly Match: "Match"; readonly Acknowledge: "Acknowledge"; }; export interface StoplistMatchResolveRequestModel { matchID?: string; matchType: StoplistMatchType; } export interface StoplistMatchModel { dob?: string; firstName: string; gender?: GenderType; id: string; isAlertOnly: boolean; lastName: string; middleName?: string; nationality?: string; remarks?: string; travelDocExpiryDate?: string; travelDocNumber?: string; } export type SecureFlightVettingResponseCode = typeof SecureFlightVettingResponseCode[keyof typeof SecureFlightVettingResponseCode]; export declare const SecureFlightVettingResponseCode: { readonly Cleared: "Cleared"; readonly Inhibited: "Inhibited"; readonly Selectee: "Selectee"; readonly Known: "Known"; readonly Insufficient: "Insufficient"; readonly Error: "Error"; readonly Unknown: "Unknown"; }; export interface RoleDictionaryModel { description?: string; id: string; name: string; } export type RestrictionLookup = typeof RestrictionLookup[keyof typeof RestrictionLookup]; export declare const RestrictionLookup: { readonly ViewUsers: "ViewUsers"; readonly ManageUsers: "ManageUsers"; readonly ViewMobileIdentities: "ViewMobileIdentities"; readonly ManageMobileIdentities: "ManageMobileIdentities"; readonly ViewOfficeVisitors: "ViewOfficeVisitors"; readonly ManageOfficeVisitors: "ManageOfficeVisitors"; readonly ViewPublicAccessVisitors: "ViewPublicAccessVisitors"; readonly ManagePublicAccessVisitors: "ManagePublicAccessVisitors"; readonly ViewMidfieldVisitors: "ViewMidfieldVisitors"; readonly ManageMidfieldVisitors: "ManageMidfieldVisitors"; readonly WebhookMidfieldVisitors: "WebhookMidfieldVisitors"; readonly ViewMidfieldPersonProfiles: "ViewMidfieldPersonProfiles"; readonly ViewAllotments: "ViewAllotments"; readonly ManageAllotments: "ManageAllotments"; readonly ViewCompanies: "ViewCompanies"; readonly ManageCompanies: "ManageCompanies"; readonly ViewOfficeVisitorCategories: "ViewOfficeVisitorCategories"; readonly ManageOfficeVisitorCategories: "ManageOfficeVisitorCategories"; readonly ViewOfficeVisitorCategoryDictionary: "ViewOfficeVisitorCategoryDictionary"; readonly ViewRoleDictionary: "ViewRoleDictionary"; readonly ViewCategoryDictionary: "ViewCategoryDictionary"; readonly ViewCompanyDictionary: "ViewCompanyDictionary"; readonly ViewDepartmentDictionary: "ViewDepartmentDictionary"; readonly ViewDepartments: "ViewDepartments"; readonly ManageDepartments: "ManageDepartments"; }; export interface PublicAccessVisitorSaveModel { airportID: string; carrierID?: string; categoryID?: string; dob: string; docExpiryDate?: string; docIssuedBy?: string; docIsVerified?: boolean; docNo?: string; docTypeID?: DocumentType; escortBadgeNo?: string; escortCompanyID?: string; escortEmail?: string; escortName?: string; escortTelephone?: string; firstName: string; gender: GenderType; isOvernightWork?: boolean; lastName: string; middleName?: string; redressNo?: string; remarks?: string; requesterCompanyID?: string; requesterEmail?: string; requesterName?: string; requesterTelephone?: string; scheduledArrivalTime: string; terminalID?: string; } export interface PublicAccessVisitorModel { airportID: string; canModify: boolean; canPrint: boolean; canVet: boolean; carrierID?: string; categoryID?: string; createdBy: string; createdTimestampUTC: string; dob: string; docExpiryDate?: string; docIssuedBy?: string; docIssuedDate?: string; docIsVerified?: boolean; docNo?: string; docTypeID?: DocumentType; escortBadgeNo?: string; escortCompanyID?: string; escortEmail?: string; escortName?: string; escortTelephone?: string; firstName: string; gender: GenderType; id: string; isOvernightWork?: boolean; lastName: string; middleName?: string; printCount: number; printTimestampUTC?: string; recordLocator: string; redressNo?: string; remarks?: string; requesterCompanyID?: string; requesterEmail?: string; requesterName?: string; requesterTelephone?: string; scheduledArrivalTime: string; secureFlightVettingInstructions?: string; secureFlightVettingResponseCode?: SecureFlightVettingResponseCode; status: AirportVisitorStatus; statusRemarks?: string; stoplistMatchID?: string; surveySentTimestampUTC?: string; terminalID?: string; } export interface PublicAccessVisitorVetResponseModel { stoplistPersonMatches?: StoplistMatchModel[]; visitor: PublicAccessVisitorModel; } export interface PublicAccessVisitorPrintResponseModel { pdfDocument: DataContentModel; visitor: PublicAccessVisitorModel; } export interface PublicAccessVisitorModelPaginationResultModel { records: PublicAccessVisitorModel[]; totalRecords: number; } export interface PublicAccessAllotmentAvailabilityResponseModel { isAvailable: boolean; message?: string; } export interface ProblemDetails { detail?: string; instance?: string; status?: number; title?: string; type?: string; } export interface OfficeVisitorsOutlookAddinApplicationModel { applicationID: string; environment?: string; scopes: string[]; tentantID: string; } export interface OfficeVisitorsApplicationModel { captchaSiteKey?: string; environment?: string; visitorCategories: OfficeVisitorCategoryDictionaryModel[]; } export interface OfficeVisitorVetResponseModel { stoplistPersonMatches?: StoplistMatchModel[]; visitor: OfficeVisitorModel; } export type OfficeVisitorStatus = typeof OfficeVisitorStatus[keyof typeof OfficeVisitorStatus]; export declare const OfficeVisitorStatus: { readonly NeedsApproval: "NeedsApproval"; readonly Registered: "Registered"; readonly SignedIn: "SignedIn"; readonly SignedOut: "SignedOut"; readonly Canceled: "Canceled"; readonly Denied: "Denied"; readonly Expired: "Expired"; }; export type OfficeVisitorReportParams = { airportID?: string; dateStart: string; dateEnd: string; statuses?: OfficeVisitorStatus[]; }; export type OfficeVisitorGetParams = { scheduledArrivalDateStart: string; scheduledArrivalDateEnd: string; searchQuery?: string; firstName?: string; lastName?: string; dOB?: string; gender?: GenderType; statuses?: OfficeVisitorStatus[]; sortColumn?: OfficeVisitorDBSortableColumn; sortDescending?: boolean; pageNumber?: number; pageSize?: number; }; export interface OfficeVisitorSaveModel { airportID: string; company?: string; dob?: string; email?: string; facePhotoData?: string; firstName: string; gender?: GenderType; lastName: string; officeVisitorCategoryID: string; phone?: string; remarks?: string; scheduledArrivalTime: string; visitDurationInHours: number; visiting: string; visitingDepartmentID?: string; visitingEmail?: string; } export interface OfficeVisitorRegistrationSaveModel { captchaResponse?: string; company?: string; dob: string; email: string; facePhoto?: string; firstName: string; gender: GenderType; lastName: string; phone?: string; } export interface OfficeVisitorRegistrationModel { company?: string; firstName: string; isApproved: boolean; lastName: string; scheduledArrivalTime: string; visiting?: string; } export interface OfficeVisitorModel { airportID: string; badgeNumber: string; canModify: boolean; canModifyBadge: boolean; canPrint: boolean; canSignIn: boolean; canVet: boolean; company?: string; createdTimestampUTC: string; dob?: string; email?: string; expirationTimestampUTC?: string; facePhotoMediaID: string; firstName: string; gender?: GenderType; id: string; lastName: string; officeVisitorCategoryID: string; phone?: string; printTimestampUTC?: string; remarks?: string; scheduledArrivalTime: string; secureFlightVettingInstructions?: string; secureFlightVettingResponseCode?: SecureFlightVettingResponseCode; signInTimestampUTC?: string; signOutTimestampUTC?: string; status: OfficeVisitorStatus; stoplistMatchID: string; visitDurationInHours: number; visiting: string; visitingDepartmentID?: string; visitingEmail?: string; } export interface OfficeVisitorPrintResponseModel { pdfDocument: DataContentModel; visitor: OfficeVisitorModel; } export interface OfficeVisitorModelPaginationResultModel { records: OfficeVisitorModel[]; totalRecords: number; } export interface OfficeVisitorInvitationModel { hostEmail: string; hostFullName: string; visitDateTimes: string[]; } export interface OfficeVisitorInvitationContentResponseModel { invitationContent: string; invitationLink: string; } export interface OfficeVisitorInvitationContentRequestModel { endDateTimeUTC: string; startDateTimeUTC: string; visitorCategoryID?: string; } export interface OfficeVisitorHostProfileModel { defaultVisitorCategoryID?: string; departmentID?: string; email: string; fullName: string; } export type OfficeVisitorDBSortableColumn = typeof OfficeVisitorDBSortableColumn[keyof typeof OfficeVisitorDBSortableColumn]; export declare const OfficeVisitorDBSortableColumn: { readonly VisitorCategoryID: "VisitorCategoryID"; readonly Status: "Status"; readonly LastName: "LastName"; readonly FirstName: "FirstName"; readonly Company: "Company"; readonly Visiting: "Visiting"; readonly VisitingEmail: "VisitingEmail"; readonly ScheduledArrivalTime: "ScheduledArrivalTime"; readonly SignInTimestampUTC: "SignInTimestampUTC"; readonly SignOutTimestampUTC: "SignOutTimestampUTC"; readonly Remarks: "Remarks"; readonly DOB: "DOB"; readonly Gender: "Gender"; readonly VisitingDepartmentID: "VisitingDepartmentID"; }; export interface OfficeVisitorCategoryToggleDefaultModel { isDefault: boolean; } export interface OfficeVisitorCategorySaveModel { isDefault: boolean; name: string; } export interface OfficeVisitorCategoryModel { id: string; isDefault: boolean; name: string; totalVisitors: number; } export interface OfficeVisitorHostProfileResponseModel { departments: DepartmentModel[]; profile?: OfficeVisitorHostProfileModel; visitorCategories: OfficeVisitorCategoryModel[]; } export interface OfficeVisitorCategoryDictionaryModel { id: string; isDefault: boolean; name: string; } export interface OfficeVisitorAuditTrailModel { records: AuditTrailModel[]; } export type MobileIdentityType = typeof MobileIdentityType[keyof typeof MobileIdentityType]; export declare const MobileIdentityType: { readonly Midfield: "Midfield"; }; export interface MobileIdentitySaveModel { name: string; type: MobileIdentityType; } export interface MobileIdentityModel { authenticationCode: string; id: string; lastLoginTimestampUTC?: string; name: string; type: MobileIdentityType; updatedTimestampUTC: string; } export interface MobileIdentityAuditTrailModel { records: AuditTrailModel[]; } export type MidfieldTripStatus = typeof MidfieldTripStatus[keyof typeof MidfieldTripStatus]; export declare const MidfieldTripStatus: { readonly Active: "Active"; readonly Expired: "Expired"; readonly Cancelled: "Cancelled"; readonly Completed: "Completed"; readonly Denied: "Denied"; }; export interface MidfieldTripStartModel { airportID?: string; driverID: string; passengerIDs?: string[]; } export interface MidfieldTripStartErrorModel { errors: ErrorModel[]; } export type MidfieldTripPersonType = typeof MidfieldTripPersonType[keyof typeof MidfieldTripPersonType]; export declare const MidfieldTripPersonType: { readonly Passenger: "Passenger"; readonly Driver: "Driver"; }; export interface MidfieldTripPersonModel { badgeNo?: string; company?: string; facePhoto?: string; facePhotoMediaID?: string; firstName: string; id: string; lastName: string; type: MidfieldTripPersonType; } export interface MidfieldTripPersonAuthenticationRequestModel { authenticatePersonType: MidfieldTripPersonType; facePhoto: string; } export interface MidfieldTripModel { airportID: string; canExtend: boolean; checkpoint?: string; driver: MidfieldTripPersonModel; endDateTimeUTC: string; extensionCount: number; externalID: string; id: string; lastExtensionTimestampUTC?: string; passengers: MidfieldTripPersonModel[]; startDateTimeUTC: string; status: MidfieldTripStatus; updatedTimestampUTC: string; } export interface MidfieldTripModelPaginationResultModel { records: MidfieldTripModel[]; totalRecords: number; } export type MidfieldTripDBSortableColumn = typeof MidfieldTripDBSortableColumn[keyof typeof MidfieldTripDBSortableColumn]; export declare const MidfieldTripDBSortableColumn: { readonly ExternalID: "ExternalID"; readonly Status: "Status"; readonly StartDateTime: "StartDateTime"; readonly EndDateTime: "EndDateTime"; readonly LastExtensionTimestampUTC: "LastExtensionTimestampUTC"; readonly ExtensionCount: "ExtensionCount"; readonly UpdatedTimestampUTC: "UpdatedTimestampUTC"; readonly DriverFirstName: "DriverFirstName"; readonly DriverLastName: "DriverLastName"; readonly DriverBadgeNo: "DriverBadgeNo"; readonly TotalPassengers: "TotalPassengers"; readonly Checkpoint: "Checkpoint"; }; export interface MidfieldTripAuditTrailModel { records: AuditTrailModel[]; } export interface MidfieldPersonModel { badgeNo?: string; firstName: string; id: string; lastName: string; } export type LoginMethod = typeof LoginMethod[keyof typeof LoginMethod]; export declare const LoginMethod: { readonly Hybrid: "Hybrid"; readonly Database: "Database"; readonly SingleSignOn: "SingleSignOn"; }; export interface IdentityUserAuthenticateRequestModel { password: string; username: string; } export interface IdentityUserAuthenticatePasswordChangeRequestModel { newPassword: string; } export interface IdentityUserAuthenticateMfaRequestModel { code: string; } export type IdentitySignInResponseType = typeof IdentitySignInResponseType[keyof typeof IdentitySignInResponseType]; export declare const IdentitySignInResponseType: { readonly Authenticated: "Authenticated"; readonly ChangePassword: "ChangePassword"; readonly MfaRequired: "MfaRequired"; readonly LinkExternalAccount: "LinkExternalAccount"; }; export interface IdentityUserAuthenticateResponseModel { mfaVerificationType?: UserMfaVerificationType; token?: string; type: IdentitySignInResponseType; } export interface IdentityPcmAuthenticateResponseModel { token: string; } export interface IdentityPcmAuthenticateRequestModel { deviceName: string; } export interface IdentityMobileAuthenticateResponseModel { accessApiKey: string; } export interface IdentityMobileAuthenticateRequestModel { authenticationCode: string; } export type GenderType = typeof GenderType[keyof typeof GenderType]; export declare const GenderType: { readonly NotSet: "NotSet"; readonly Male: "Male"; readonly Female: "Female"; readonly Undisclosed: "Undisclosed"; readonly Unspecified: "Unspecified"; }; export interface FaceDetectionModel { imageBase64: string; } export type ExternalProvider = typeof ExternalProvider[keyof typeof ExternalProvider]; export declare const ExternalProvider: { readonly Microsoft: "Microsoft"; }; export interface IdentityExternalUserAuthenticateRequestModel { idToken: string; provider: ExternalProvider; } export interface ErrorModel { errorMessage: string; recordID?: string; } export type DocumentType = typeof DocumentType[keyof typeof DocumentType]; export declare const DocumentType: { readonly Passport: "Passport"; readonly DriversLicense: "DriversLicense"; }; export type DeviceType = typeof DeviceType[keyof typeof DeviceType]; export declare const DeviceType: { readonly NotSet: "NotSet"; readonly Counter: "Counter"; readonly Web: "Web"; readonly Kiosk: "Kiosk"; }; export interface DeploymentModel { airports: AirportModel[]; terminals: TerminalModel[]; } export interface DepartmentSaveModel { name: string; } export interface DepartmentModel { id: string; name: string; totalOfficeVisitors: number; } export interface DepartmentDictionaryModel { id: string; name: string; } export type DayOfWeek = typeof DayOfWeek[keyof typeof DayOfWeek]; export declare const DayOfWeek: { readonly Sunday: "Sunday"; readonly Monday: "Monday"; readonly Tuesday: "Tuesday"; readonly Wednesday: "Wednesday"; readonly Thursday: "Thursday"; readonly Friday: "Friday"; readonly Saturday: "Saturday"; }; export interface DataContentModel { contentType: string; data: string; } export interface CompanyToggleActiveModel { isActive: boolean; } export interface CompanySaveModel { code: string; email?: string; id?: string; isActive: boolean; name: string; } export interface CompanyModel { code: string; email?: string; id: string; isActive: boolean; name: string; } export interface CompanyDictionaryModel { id: string; isActive: boolean; name: string; } export interface CategoryDictionaryModel { id: string; name: string; } export interface AuditTrailObjectChangePropertyModel { from?: string; name: string; to?: string; } export interface AuditTrailObjectChangeModel { changes: AuditTrailObjectChangePropertyModel[]; isNew: boolean; } export interface AuditTrailModel { identityName?: string; message: string; objectChange?: AuditTrailObjectChangeModel; timestampUTC: string; } export interface AllotmentWeekDayHourDetailModel { hour: number; limit: number; } export interface AllotmentWeekDayDetailModel { dayOfWeek: DayOfWeek; hourlyLimits?: AllotmentWeekDayHourDetailModel[]; limit?: number; } export type AllotmentType = typeof AllotmentType[keyof typeof AllotmentType]; export declare const AllotmentType: { readonly DateRange: "DateRange"; readonly Week: "Week"; }; export interface AllotmentToggleActiveModel { isActive: boolean; } export interface AllotmentSettingsModel { individualRestrictionsEnabled: boolean; individualRestrictionsNumberOfDays: number; individualRestrictionsRequestLimit: number; } export interface AllotmentDetailFiltersModel { airportID?: string; categoryID?: string; escortCompanyID?: string; isAlwaysMatch: boolean; requesterCompanyID?: string; terminalID?: string; } export interface AllotmentWeekDetailModel { dailyLimits?: AllotmentWeekDayDetailModel[]; filters: AllotmentDetailFiltersModel; id?: string; isActive: boolean; limit: number; name: string; priority?: number; visitorType: VisitorType; } export interface AllotmentModel { filters: AllotmentDetailFiltersModel; id: string; isActive: boolean; name: string; priority: number; type: AllotmentType; visitorType: VisitorType; } export interface AllotmentDateRangeDetailModel { endDateTime: string; filters: AllotmentDetailFiltersModel; id?: string; isActive: boolean; limit: number; name: string; priority?: number; startDateTime: string; visitorType: VisitorType; } export type AirportVisitorStatus = typeof AirportVisitorStatus[keyof typeof AirportVisitorStatus]; export declare const AirportVisitorStatus: { readonly Pending: "Pending"; readonly Approved: "Approved"; readonly Issued: "Issued"; readonly Canceled: "Canceled"; readonly Denied: "Denied"; readonly Expired: "Expired"; }; export type AirportVisitorDBSortableColumn = typeof AirportVisitorDBSortableColumn[keyof typeof AirportVisitorDBSortableColumn]; export declare const AirportVisitorDBSortableColumn: { readonly Status: "Status"; readonly AirportID: "AirportID"; readonly TerminalID: "TerminalID"; readonly CategoryID: "CategoryID"; readonly RecordLocator: "RecordLocator"; readonly RedressNo: "RedressNo"; readonly FirstName: "FirstName"; readonly LastName: "LastName"; readonly MiddleName: "MiddleName"; readonly DOB: "DOB"; readonly Gender: "Gender"; readonly ScheduledArrivalTime: "ScheduledArrivalTime"; readonly DocTypeID: "DocTypeID"; readonly DocNo: "DocNo"; readonly DocIssuedBy: "DocIssuedBy"; readonly DocExpiryDate: "DocExpiryDate"; readonly DocIsVerified: "DocIsVerified"; readonly RequesterCompanyID: "RequesterCompanyID"; readonly RequesterName: "RequesterName"; readonly EscortCompanyID: "EscortCompanyID"; readonly EscortBadgeNo: "EscortBadgeNo"; readonly EscortName: "EscortName"; readonly IsOvernightWork: "IsOvernightWork"; readonly PrintTimestampUTC: "PrintTimestampUTC"; readonly SurveySentTimestampUTC: "SurveySentTimestampUTC"; readonly Remarks: "Remarks"; }; export interface AirportModel { code: string; id: string; name: string; timezone: string; } export interface AdminPortalApplicationMidfieldFeaturesModel { logo?: string; } export type AdminPortalApplicationLoginProviderModelConfiguration = { [key: string]: string; }; export interface AdminPortalApplicationLoginProviderModel { configuration: AdminPortalApplicationLoginProviderModelConfiguration; name: ExternalProvider; } export interface AdminPortalApplicationHelpPanelModel { email?: string; message: string; phone?: string; } export interface AdminPortalApplicationFeaturesModel { midfield?: AdminPortalApplicationMidfieldFeaturesModel; } export interface AdminPortalApplicationModel { companyLogo?: string; environment?: string; features: AdminPortalApplicationFeaturesModel; helpPanel?: AdminPortalApplicationHelpPanelModel; loginExternalProviders: AdminPortalApplicationLoginProviderModel[]; loginMethod: LoginMethod; websiteCss?: string; } export interface AccountModel { email?: string; firstName: string; id: string; lastName: string; mfaVerificationType?: UserMfaVerificationType; restrictions: RestrictionLookup[]; username: string; } export interface AccountMfaAuthenticatorAppSetupModel { setupManualCode: string; setupQRCode: string; } export interface AccountMfaAuthenticatorAppEnableModel { code: string; } export interface AccountChangePasswordModel { newPassword?: string; oldPassword?: string; }