@sonoransoftware/sonoran.js 1.0.0

package/src/libs/rest/src/lib/utils/constants.ts

@@ -0,0 +1,919 @@
+import { productEnums } from '../../../../../constants';
+import type { RESTOptions } from '../REST';
+
+export const DefaultUserAgent = 'Sonoran.js NPM Module';
+
+export const DefaultCADRestOptions: Required<RESTOptions> = {
+	agent: {},
+	api: 'https://api.sonorancad.com',
+	headers: {},
+	rejectOnRateLimit: true
+};
+
+export const DefaultCMSRestOptions: Required<RESTOptions> = {
+	agent: {},
+	api: 'https://api.sonorancms.com',
+	headers: {},
+	rejectOnRateLimit: true
+};
+
+/**
+ * The events that the REST manager emits
+ */
+export const enum RESTEvents {
+	Debug = 'restDebug',
+	InvalidRequestWarning = 'invalidRequestWarning',
+	RateLimited = 'rateLimited',
+	Request = 'request',
+	Response = 'response'
+}
+
+export interface APITypeData {
+	type: string;
+	path: string;
+	method: 'POST' | 'GET' | 'DELETE' | 'PATCH';
+	minVersion: number;
+}
+
+export interface AllAPITypeData {
+	product: productEnums;
+	type: string;
+	path: string;
+	method: 'POST' | 'GET' | 'DELETE' | 'PATCH';
+	minVersion: number;
+}
+
+export const GeneralCADAPITypes: APITypeData[] = [
+	{
+		type: 'GET_SERVERS',
+		path: 'general/get_servers',
+		method: 'POST',
+		minVersion: 2
+	},
+	{
+		type: 'SET_SERVERS',
+		path: 'general/set_servers',
+		method: 'POST',
+		minVersion: 3
+	},
+	{
+		type: 'GET_VERSION',
+		path: 'general/get_version',
+		method: 'POST',
+		minVersion: 0
+	},
+	{
+		type: 'SET_PENAL_CODES',
+		path: 'general/set_penal_codes',
+		method: 'POST',
+		minVersion: 2
+	},
+	{
+		type: 'SET_API_ID',
+		path: 'general/set_api_id',
+		method: 'POST',
+		minVersion: 2
+	},
+	{
+		type: 'GET_TEMPLATES',
+		path: 'general/get_templates',
+		method: 'POST',
+		minVersion: 2
+	},
+	{
+		type: 'NEW_RECORD',
+		path: 'general/new_record',
+		method: 'POST',
+		minVersion: 3
+	},
+	{
+		type: 'EDIT_RECORD',
+		path: 'general/edit_record',
+		method: 'POST',
+		minVersion: 3
+	},
+	{
+		type: 'REMOVE_RECORD',
+		path: 'general/remove_record',
+		method: 'POST',
+		minVersion: 3
+	},
+	{
+		type: 'LOOKUP_INT',
+		path: 'general/lookup_int',
+		method: 'POST',
+		minVersion: 3
+	},
+	{
+		type: 'LOOKUP',
+		path: 'general/lookup',
+		method: 'POST',
+		minVersion: 3
+	},
+	{
+		type: 'GET_ACCOUNT',
+		path: 'general/get_account',
+		method: 'POST',
+		minVersion: 3
+	},
+	{
+		type: 'CHECK_APIID',
+		path: 'general/check_apiid',
+		method: 'POST',
+		minVersion: 2
+	},
+	{
+		type: 'APPLY_PERMISSION_KEY',
+		path: 'general/apply_permission_key',
+		method: 'POST',
+		minVersion: 3
+	},
+	{
+		type: 'SET_ACCOUNT_PERMISSIONS',
+		path: 'general/set_account_permissions',
+		method: 'POST',
+		minVersion: 3
+	},
+	{
+		type: 'BAN_USER',
+		path: 'general/ban_user',
+		method: 'POST',
+		minVersion: 3
+	},
+	{
+		type: 'VERIFY_SECRET',
+		path: 'general/verify_secret',
+		method: 'POST',
+		minVersion: 2
+	},
+	{
+		type: 'AUTH_STREETSIGNS',
+		path: 'general/auth_streetsigns',
+		method: 'POST',
+		minVersion: 4
+	},
+	{
+		type: 'SET_POSTALS',
+		path: 'general/set_postals',
+		method: 'POST',
+		minVersion: 4
+	},
+	{
+		type: 'SEND_PHOTO',
+		path: 'general/send_photo',
+		method: 'POST',
+		minVersion: 4
+	}
+];
+
+export const CivilianCADAPITypes: APITypeData[] = [
+	{
+		type: 'GET_CHARACTERS',
+		path: 'civilian/get_characters',
+		method: 'POST',
+		minVersion: 2
+	},
+	{
+		type: 'NEW_CHARACTER',
+		path: 'civilian/new_character',
+		method: 'POST',
+		minVersion: 2
+	},
+	{
+		type: 'EDIT_CHARACTER',
+		path: 'civilian/edit_characters',
+		method: 'POST',
+		minVersion: 2
+	},
+	{
+		type: 'REMOVE_CHARACTER',
+		path: 'civilian/remove_character',
+		method: 'POST',
+		minVersion: 2
+	}
+];
+
+export const EmergencyCADAPITypes: APITypeData[] = [
+	{
+		type: 'GET_IDENTIFIERS',
+		path: 'emergency/get_identifiers',
+		method: 'POST',
+		minVersion: 3
+	},
+	{
+		type: 'MODIFY_IDENTIFIER',
+		path: 'emergency/modify_identifier',
+		method: 'POST',
+		minVersion: 4
+	},
+	{
+		type: 'SET_IDENTIFIER',
+		path: 'emergency/set_identifier',
+		method: 'POST',
+		minVersion: 3
+	},
+	{
+		type: 'UNIT_PANIC',
+		path: 'emergency/unit_panic',
+		method: 'POST',
+		minVersion: 2
+	},
+	{
+		type: 'UNIT_STATUS',
+		path: 'emergency/unit_status',
+		method: 'POST',
+		minVersion: 2
+	},
+	{
+		type: 'GET_BLIPS',
+		path: 'emergency/get_blips',
+		method: 'POST',
+		minVersion: 4
+	},
+	{
+		type: 'ADD_BLIP',
+		path: 'emergency/add_blip',
+		method: 'POST',
+		minVersion: 4
+	},
+	{
+		type: 'MODIFY_BLIP',
+		path: 'emergency/modify_blip',
+		method: 'POST',
+		minVersion: 4
+	},
+	{
+		type: 'REMOVE_BLIP',
+		path: 'emergency/remove_blip',
+		method: 'POST',
+		minVersion: 4
+	},
+	{
+		type: '911_CALL',
+		path: 'emergency/911_call',
+		method: 'POST',
+		minVersion: 2
+	},
+	{
+		type: 'REMOVE_911',
+		path: 'emergency/remove_911',
+		method: 'POST',
+		minVersion: 2
+	},
+	{
+		type: 'GET_CALLS',
+		path: 'emergency/get_calls',
+		method: 'POST',
+		minVersion: 3
+	},
+	{
+		type: 'GET_ACTIVE_UNITS',
+		path: 'emergency/get_active_units',
+		method: 'POST',
+		minVersion: 3
+	},
+	{
+		type: 'KICK_UNIT',
+		path: 'emergency/kick_unit',
+		method: 'POST',
+		minVersion: 2
+	},
+	{
+		type: 'NEW_DISPATCH',
+		path: 'emergency/new_dispatch',
+		method: 'POST',
+		minVersion: 3
+	},
+	{
+		type: 'ATTACH_UNIT',
+		path: 'emergency/attach_unit',
+		method: 'POST',
+		minVersion: 3
+	},
+	{
+		type: 'DETACH_UNIT',
+		path: 'emergency/detach_unit',
+		method: 'POST',
+		minVersion: 3
+	},
+	{
+		type: 'SET_CALL_POSTAL',
+		path: 'emergency/set_call_postal',
+		method: 'POST',
+		minVersion: 3
+	},
+	{
+		type: 'SET_CALL_PRIMARY',
+		path: 'emergency/set_call_primary',
+		method: 'POST',
+		minVersion: 3
+	},
+	{
+		type: 'ADD_CALL_NOTE',
+		path: 'emergency/add_call_note',
+		method: 'POST',
+		minVersion: 3
+	},
+	{
+		type: 'CLOSE_CALL',
+		path: 'emergency/close_call',
+		method: 'POST',
+		minVersion: 2
+	},
+	{
+		type: 'UNIT_LOCATION',
+		path: 'emergency/unit_location',
+		method: 'POST',
+		minVersion: 2
+	},
+	{
+		type: 'SET_STREETSIGN_CONFIG',
+		path: 'emergency/set_streetsign_config',
+		method: 'POST',
+		minVersion: 4
+	},
+	{
+		type: 'UPDATE_STREETSIGN',
+		path: 'emergency/update_streetsign',
+		method: 'POST',
+		minVersion: 4
+	}
+];
+
+export const GeneralCMSAPITypes: APITypeData[] = [
+	{
+		type: 'GET_COM_ACCOUNT',
+		path: 'general/get_com_account',
+		method: 'POST', // Would've been 'GET' but fetch doesn't allow body with GET requests.
+		minVersion: 3
+	},
+	{
+		type: 'GET_SUB_VERSION',
+		path: 'general/get_sub_version',
+		method: 'POST', // Would've been 'GET' but fetch doesn't allow body with GET requests.
+		minVersion: 0
+	},
+	{
+		type: 'CHECK_COM_APIID',
+		path: 'general/check_com_apiid',
+		method: 'POST',
+		minVersion: 2
+	},
+	{
+		type: 'CLOCK_IN_OUT',
+		path: 'general/clock_in_out',
+		method: 'POST',
+		minVersion: 3
+	}
+];
+
+export const ServersCMSAPITypes: APITypeData[] = [
+	{
+		type: 'GET_GAME_SERVERS',
+		path: 'servers/get_game_servers',
+		method: 'POST', // Would've been 'GET' but fetch doesn't allow body with GET requests.
+		minVersion: 2
+	},
+	{
+		type: 'VERIFY_WHITELIST',
+		path: 'servers/verify_whitelist',
+		method: 'POST',
+		minVersion: 3
+	}
+];
+
+function formatForAll(array: APITypeData[], product: productEnums): AllAPITypeData[] {
+	return array.map((val) => {
+		return {
+			...val,
+			product
+		}
+	});
+}
+
+export const AllAPITypes: AllAPITypeData[] = [ ...formatForAll(GeneralCADAPITypes, productEnums.CAD), ...formatForAll(CivilianCADAPITypes, productEnums.CAD), ...formatForAll(EmergencyCADAPITypes, productEnums.CAD), ...formatForAll(GeneralCMSAPITypes, productEnums.CMS), ...formatForAll(ServersCMSAPITypes, productEnums.CMS) ];
+
+export type AllAPITypesType = 'GET_SERVERS' | 'SET_SERVERS' | 'GET_VERSION' | 'SET_PENAL_CODES' | 'SET_API_ID' | 'GET_TEMPLATES' | 'NEW_RECORD' | 'EDIT_RECORD' | 'REMOVE_RECORD' | 'LOOKUP_INT' | 'LOOKUP' | 'GET_ACCOUNT' | 'CHECK_APIID' | 'APPLY_PERMISSION_KEY' | 'SET_ACCOUNT_PERMISSIONS' | 'BAN_USER' | 'VERIFY_SECRET' | 'AUTH_STREETSIGNS' | 'SET_POSTALS' | 'SEND_PHOTO' | 'GET_CHARACTERS' | 'NEW_CHARACTER' | 'EDIT_CHARACTER' | 'REMOVE_CHARACTER' | 'GET_IDENTIFIERS' | 'MODIFY_IDENTIFIER' | 'SET_IDENTIFIER' | 'UNIT_PANIC' | 'UNIT_STATUS' | 'GET_BLIPS' | 'ADD_BLIP' | 'MODIFY_BLIP' | 'REMOVE_BLIP' | '911_CALL' | 'REMOVE_911' | 'GET_CALLS' | 'GET_ACTIVE_UNITS' | 'KICK_UNIT' | 'NEW_DISPATCH' | 'ATTACH_UNIT' | 'DETACH_UNIT' | 'SET_CALL_POSTAL' | 'SET_CALL_PRIMARY' | 'ADD_CALL_NOTE' | 'CLOSE_CALL' | 'UNIT_LOCATION' | 'SET_STREETSIGN_CONFIG' | 'UPDATE_STREETSIGN' | 'GET_COM_ACCOUNT' | 'GET_SUB_VERSION' | 'CHECK_COM_APIID' | 'VERIFY_WHITELIST' | 'CLOCK_IN_OUT';
+
+export interface CMSServerAPIStruct {
+	id: number;
+	name: string;
+	description: string;
+}
+
+export interface CADServerAPIStruct {
+	id: number;
+	name: string;
+	description: string;
+	signal: string;
+	mapUrl: string;
+	mapIp: string;
+	listenerPort: number;
+	differingOutbound: boolean;
+	outboundIp: string;
+	enableMap: boolean;
+	isStatic: boolean;
+	mapType: string;
+}
+
+export interface CADPenalCodeStruct {
+	code: string;
+	type: string;
+	title: string;
+	bondType: string;
+	jailTime: string;
+	bondAmount: number;
+}
+
+export interface CADSetAPIIDStruct {
+	username: string;
+	sessionId?: string;
+	apiIds: string[];
+	pushNew: boolean;
+}
+
+export enum CADRecordTypeEnums {
+	Warrant = 2,
+	Bolo = 3,
+	License = 4,
+	VehicleRegistration = 5,
+	Character = 7,
+	PoliceRecord = 8,
+	PoliceReport = 9,
+	MedicalRecord = 10,
+	MedicalReport = 11,
+	FireRecord = 12,
+	FireReport = 13,
+	DMVRecord = 14,
+	LawRecord = 15,
+	LawReport = 16
+}
+
+export enum CADRecordSectionCategoryEnums {
+	Custom,
+	Flags,
+	Speed = 5,
+	Charges = 6,
+	LinkedRecords = 9
+}
+
+export interface CADRecordDependencyStruct {
+	type: string;
+	fid: string;
+	acceptableValues: string[];
+}
+
+export interface CADRecordSectionFieldStruct {
+	type: 'INPUT' | 'TEXTAREA' | 'ADDRESS' | 'SELECT' | 'STATUS' | 'DATE' | 'TIME' | 'IMAGE' | 'CHECKBOXES' | 'LABEL' | 'UNIT_NUMBER' | 'UNIT_NAME' | 'UNIT_RANK' | 'UNIT_AGENCY' | 'UNIT_DEPARTMENT' | 'UNIT_SUBDIVISION' | 'UNIT_AGENCY_LOCATION' | 'UNIT_AGENCY_ZIP' | 'UNIT_LOCATION';
+	value: string;
+	size: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12;
+	data: Record<string | number | symbol, unknown>;
+	options: string[];
+	isPreviewed: boolean;
+	isSupervisor: boolean;
+	isRequired: boolean;
+	unique: boolean;
+	readOnly: boolean;
+	mask: string;
+	maskReverse: boolean;
+	dbMap: boolean;
+	isFromSync: boolean;
+	uid: string;
+	dependency: CADRecordDependencyStruct;
+}
+
+export interface CADRecordSectionStruct {
+	category: CADRecordSectionCategoryEnums;
+	label: string;
+	fields: CADRecordSectionFieldStruct[];
+	searchCiv: boolean;
+	searchVeh: boolean;
+	enableDuplicate: boolean;
+	dependency: CADRecordDependencyStruct;
+}
+
+export interface CADRecordStruct {
+	recordTypeId: number;
+	id: number;
+	syncId: string;
+	name: string;
+	type: CADRecordTypeEnums;
+	sections: CADRecordSectionStruct[];
+}
+
+export interface CADNewEditRecordOptionOneStruct {
+	user: string;
+	useDictionary: boolean;
+	recordTypeId: number;
+	replaceValues: Record<string, string>;
+}
+
+export interface CADNewEditRecordOptionTwoStruct {
+	user: string;
+	record: CADRecordStruct;
+}
+
+export enum CADLookupByIntSearchTypeEnums {
+	IDENTIFIER,
+	SUPERVISOR_STATUS,
+	ACTIVE_STATUS,
+	NUMBER
+}
+
+export interface CADLookupByIntStruct {
+	apiId?: string;
+	searchType: CADLookupByIntSearchTypeEnums;
+	value: number;
+	types: number[],
+	limit?: number;
+	offset?: number;
+}
+
+export interface CADLookupStruct {
+	apiId?: string;
+	types: number[];
+	first: string;
+	last: string;
+	mi: string;
+	plate: string;
+	partial: boolean;
+	agency?: string;
+	department?: string;
+	subdivision?: string;
+}
+
+export interface CADModifyAccountPermsStruct {
+	apiId?: string;
+	username?: string;
+	active?: boolean;
+	add: string[];
+	remove: string[];
+}
+
+export interface CADKickBanUserStruct {
+	apiId: string;
+	isBan?: boolean;
+	isKick?: boolean;
+}
+
+export interface CADSetPostalStruct {
+	code: string;
+	x: number;
+	y: number;
+}
+
+export enum CADModifyIdentifierActionEnums {
+	ADD,
+	EDIT,
+	REMOVE
+}
+
+export interface CADModifyIdentifierStruct {
+	apiId: string;
+	action: CADModifyIdentifierActionEnums;
+	identifier?: Record<string, string>;
+	identId?: number;
+}
+
+export interface CADBlipStruct {
+	id: number;
+	coordinates: {
+		x: number;
+		y: number;
+	};
+	icon: string;
+	color: string;
+	tooltip: string;
+}
+
+export interface CADAddBlipStruct {
+	serverId: number;
+	blip: CADBlipStruct;
+}
+
+export interface CADModifyBlipStruct {
+	id: number;
+	coordinates?: {
+		x: number;
+		y: number;
+	};
+	icon?: string;
+	color?: string;
+	tooltip?: string;
+}
+
+export interface CADGetCallsStruct {
+	serverId?: number;
+	closedLimit?: number;
+	closedOffset?: number;
+}
+
+export interface CADGetActiveUnitsStruct {
+	serverId?: number;
+	onlyUnits?: boolean;
+	includeOffline?: boolean;
+	limit?: number;
+	offset?: number;
+}
+
+export enum CADDispatchOriginEnums {
+	Caller,
+	RadioDispatch,
+	Observed,
+	WalkUp
+}
+
+export enum CADDispatchStatusEnums {
+	Pending,
+	Active,
+	Closed
+}
+
+export interface CADNewDispatchStruct {
+	serverId: number;
+	origin: CADDispatchOriginEnums;
+	status: CADDispatchStatusEnums;
+	priority: 1 | 2 | 3;
+	block: string;
+	address: string;
+	postal: string;
+	title: string;
+	code: string;
+	primary: number;
+	trackPrimary: boolean;
+	description: string;
+	metaData: Record<string, string>;
+	units: string[];
+}
+
+export interface CADStreetSignStruct {
+	id: number;
+	label: string;
+	text1: string;
+	text2: string;
+	text3: string;
+}
+
+export interface CADUnitLocationStruct {
+	apiId: string;
+	location: string;
+}
+
+export interface RESTTypedAPIDataStructs {
+	// CAD - General
+	GET_SERVERS: [];
+	SET_SERVERS: [
+		servers: CADServerAPIStruct[],
+		deployMap: boolean
+	];
+	GET_VERSION: [];
+	SET_PENAL_CODES: [data: CADPenalCodeStruct[]];
+	SET_API_ID: [data: CADSetAPIIDStruct];
+	GET_TEMPLATES: [recordTypeId?: number];
+	NEW_RECORD: [data: CADNewEditRecordOptionOneStruct | CADNewEditRecordOptionTwoStruct];
+	EDIT_RECORD: [data: CADNewEditRecordOptionOneStruct | CADNewEditRecordOptionTwoStruct];
+	REMOVE_RECORD: [id: number];
+	LOOKUP_INT: [data: CADLookupByIntStruct];
+	LOOKUP: [data: CADLookupStruct];
+	GET_ACCOUNT: [
+		apiId?: string,
+		username?: string
+	];
+	CHECK_APIID: [apiId: string];
+	APPLY_PERMISSION_KEY: [
+		apiId: string,
+		permissionKey: string
+	];
+	SET_ACCOUNT_PERMISSIONS: [data: CADModifyAccountPermsStruct];
+	BAN_USER: [data: CADKickBanUserStruct];
+	VERIFY_SECRET: [secret: string];
+	AUTH_STREETSIGNS: [serverId: number];
+	SET_POSTALS: [data: CADSetPostalStruct[]];
+	SEND_PHOTO: [
+		apiId: string,
+		url: string
+	];
+	// CAD - Civilian
+	GET_CHARACTERS: [apiId: string];
+	NEW_CHARACTER: [data: CADNewEditRecordOptionOneStruct | CADNewEditRecordOptionTwoStruct];	
+	EDIT_CHARACTER: [data: CADNewEditRecordOptionOneStruct | CADNewEditRecordOptionTwoStruct];
+	REMOVE_CHARACTER: [id: number];
+	// CAD - Emergency
+	GET_IDENTIFIERS: [apiId: string];
+	MODIFY_IDENTIFIER: [data: CADModifyIdentifierStruct];
+	SET_IDENTIFIER: [
+		apiId: string,
+		identId: number
+	];
+	UNIT_PANIC: [
+		apiId: string,
+		isPanic: boolean
+	];
+	UNIT_STATUS: [
+		apiId: string,
+		status: number,
+		serverId: number
+	];
+	GET_BLIPS: [serverId: number];
+	ADD_BLIP: [data: CADAddBlipStruct[]];
+	MODIFY_BLIP: [data: CADModifyBlipStruct[]];
+	REMOVE_BLIP: [id: number];
+	REMOVE_911: [callId: number];
+	GET_CALLS: [data: CADGetCallsStruct];
+	GET_ACTIVE_UNITS: [data: CADGetActiveUnitsStruct];
+	KICK_UNIT: [
+		apiId: string,
+		reason: string,
+		serverId: number
+	];
+	NEW_DISPATCH: [data: CADNewDispatchStruct];
+	ATTACH_UNIT: [
+		serverId: number,
+		callId: number,
+		units: string[]
+	];
+	DETACH_UNIT: [
+		serverId: number,
+		units: string[]
+	];
+	SET_CALL_POSTAL: [
+		serverId: number,
+		callId: number,
+		postal: string
+	];
+	SET_CALL_PRIMARY: [
+		serverId: number,
+		callId: number,
+		primary: number,
+		trackPrimary: boolean
+	];
+	ADD_CALL_NOTE: [
+		serverId: number,
+		callId: number,
+		note: string
+	];
+	CLOSE_CALL: [
+		serverId: number,
+		callId: number
+	];
+	'CALL_911': [
+		serverId: number,
+		isEmergency: boolean,
+		caller: string,
+		location: string,
+		description: string,
+		metaData: Record<string, string>
+	];
+	SET_STREETSIGN_CONFIG: [
+		serverId: number,
+		signConfig: CADStreetSignStruct[]
+	];
+	UPDATE_STREETSIGN: [
+		serverId: number,
+		signData: {
+			ids: number[],
+			text1: string,
+			text2: string,
+			text3: string
+		}
+	];
+	UNIT_LOCATION: [data: CADUnitLocationStruct[]];
+	// CMS - General
+	GET_COM_ACCOUNT: [
+		apiId?: string,
+		username?: string,
+		accId?: string
+	];
+	GET_SUB_VERSION: [];
+	CHECK_COM_APIID: [apiId: string];
+	CLOCK_IN_OUT: [
+		apiId?: string,
+		accId?: string,
+		forceClockIn?: boolean
+	];
+	// CMS - Servers
+	GET_GAME_SERVERS: [];
+	VERIFY_WHITELIST: [
+		apiId: string | undefined,
+		accId: string | undefined,
+		serverId: number
+	];
+}
+
+export type PossibleRequestData = 
+	undefined | 
+	{
+		data: CADPenalCodeStruct[] | CADSetAPIIDStruct | CADNewEditRecordOptionOneStruct | CADNewEditRecordOptionTwoStruct | CADLookupByIntStruct | CADLookupStruct | CADModifyAccountPermsStruct | CADKickBanUserStruct | CADSetPostalStruct[] | CADModifyIdentifierStruct | CADAddBlipStruct[] | CADModifyBlipStruct[] | CADGetCallsStruct | CADGetActiveUnitsStruct | CADNewDispatchStruct
+	} |
+	{
+		servers: CADServerAPIStruct[];
+		deployMap: boolean;
+	} |
+	{
+		id: number;
+	} |
+	{
+		recordTypeId?: number;
+	} |
+	{
+		apiId?: string;
+		username?: string;
+	} |
+	{
+		apiId: string
+	} |
+	{
+		apiId: string;
+		permissionKey: string;
+	} |
+	{
+		secret: string;
+	} |
+	{
+		serverId: number;
+	} |
+	{
+		serverId?: number;
+	} |
+	{
+		apiId: string;
+		url: string;
+	} |
+	{
+		apiId: string;
+		identId: number;
+	} |
+	{
+		apiId: string;
+		isPanic: boolean;
+	} |
+	{
+		apiId: string;
+		status: number;
+		serverId: number;
+	} |
+	{
+		callId: number;
+	} |
+	{
+		serverId: number;
+		callId: number;
+		units: string[];
+	} |
+	{
+		serverId: number;
+		units: string[];
+	} |
+	{
+		serverId: number;
+		callId: number;
+		postal: string;
+	} |
+	{
+		serverId: number;
+		callId: number;
+		primary: number;
+		trackPrimary: boolean;
+	} |
+	{
+		serverId: number;
+		callId: number;
+		note: string;
+	} |
+	{
+		serverId: number;
+		callId: number;
+	} |
+	{
+		serverId: number;
+		isEmergency: boolean;
+		caller: string;
+		location: string;
+		description: string;
+		metaData: Record<string, string>;
+	} |
+	{
+		serverId: number;
+		signConfig: CADStreetSignStruct[];
+	} |
+	{
+		serverId: number;
+		signData: {
+			ids: number[];
+			text1: string;
+			text2: string;
+			text3: string;
+		}
+	} |
+	{
+		apiId?: string;
+		username?: string;
+	} |
+	{
+		apiId: string;
+		serverId: number;
+	} |
+	{
+		apiId: string;
+		forceClockIn: boolean;
+	};