@sonoransoftware/sonoran.js 1.0.34 → 1.0.36

package/dist/managers/CADManager.d.ts

@@ -1,6 +1,7 @@
 import { Instance } from '../instance/Instance';
 import { CADSubscriptionVersionEnum } from '../constants';
 import { REST } from '../libs/rest/src';
+import type { CADPenalCodeStruct, CADSetAPIIDStruct, CADNewEditRecordOptionOneStruct, CADNewEditRecordOptionTwoStruct, CADLookupByIntStruct, CADLookupStruct, CADModifyAccountPermsStruct, CADKickBanUserStruct, CADSetPostalStruct, CADModifyIdentifierStruct, CADAddBlipStruct, CADModifyBlipStruct, CADGetCallsStruct, CADGetActiveUnitsStruct, CADNewDispatchStruct, CADStreetSignStruct, CADUnitLocationStruct } from '../libs/rest/src';
 import { BaseManager } from './BaseManager';
 import * as globalTypes from '../constants';
 import { CADServerManager } from './CADServerManager';
@@ -15,6 +16,12 @@ export declare class CADManager extends BaseManager {
     servers: CADServerManager | undefined;
     constructor(instance: Instance);
     protected buildManager(instance: Instance): Promise<void>;
+    private getRest;
+    private executeCadRequest;
+    /**
+     * Retrieves the community's CAD subscription version.
+     */
+    getVersion(): Promise<number>;
     /**
      * Gets a community account by `accId` or `apiId`.
      * @param {Object} params The object that contains parameters to get a community account.
@@ -26,4 +33,220 @@ export declare class CADManager extends BaseManager {
         apiId?: string;
         username?: string;
     }): Promise<globalTypes.CADGetAccountPromiseResult>;
+    /**
+     * Updates the CAD clock to match in-game time.
+     */
+    setClockTime(data: {
+        serverId: number;
+        currentUtc: string;
+        currentGame: string;
+        secondsPerHour: number;
+    }): Promise<globalTypes.CADSetClockTimePromiseResult>;
+    /**
+     * Adds accounts to the community via the join community endpoint.
+     * NOTE: This endpoint is intended for internal CMS use and requires an internal key.
+     */
+    joinCommunity(internalKey: string, accounts: string | {
+        account: string;
+    } | Array<string | {
+        account: string;
+    }>): Promise<globalTypes.CADJoinCommunityPromiseResult>;
+    /**
+     * Removes accounts from the community via the leave community endpoint.
+     * NOTE: This endpoint is intended for internal CMS use and requires an internal key.
+     */
+    leaveCommunity(internalKey: string, accounts: string | {
+        account: string;
+    } | Array<string | {
+        account: string;
+    }>): Promise<globalTypes.CADLeaveCommunityPromiseResult>;
+    /**
+     * Updates the penal code configuration for the community.
+     */
+    setPenalCodes(codes: CADPenalCodeStruct[]): Promise<globalTypes.CADStandardResponse>;
+    /**
+     * Assigns API IDs to a community account.
+     */
+    setAccountApiIds(data: CADSetAPIIDStruct): Promise<globalTypes.CADStandardResponse>;
+    /**
+     * Retrieves record templates filtered by a specific record type.
+     */
+    getRecordTemplates(recordTypeId?: number): Promise<globalTypes.CADStandardResponse>;
+    /**
+     * Creates a new record entry.
+     */
+    createRecord(data: CADNewEditRecordOptionOneStruct | CADNewEditRecordOptionTwoStruct): Promise<globalTypes.CADStandardResponse>;
+    /**
+     * Updates an existing record entry.
+     */
+    updateRecord(data: CADNewEditRecordOptionOneStruct | CADNewEditRecordOptionTwoStruct): Promise<globalTypes.CADStandardResponse>;
+    /**
+     * Removes a record by its identifier.
+     */
+    removeRecord(id: number): Promise<globalTypes.CADStandardResponse>;
+    /**
+     * Performs an internal lookup using the CAD lookup by identifier endpoint.
+     */
+    lookupByInt(data: CADLookupByIntStruct): Promise<globalTypes.CADStandardResponse>;
+    /**
+     * Executes a CAD lookup using first/last name, plate, or other values.
+     */
+    lookupRecords(data: CADLookupStruct): Promise<globalTypes.CADStandardResponse>;
+    /**
+     * Checks whether the provided API ID exists.
+     */
+    checkApiId(apiId: string): Promise<globalTypes.CADStandardResponse>;
+    /**
+     * Applies a permission key to an account.
+     */
+    applyPermissionKey(apiId: string | undefined, permissionKey: string): Promise<globalTypes.CADStandardResponse>;
+    /**
+     * Sets account permissions for a CAD user.
+     */
+    setAccountPermissions(data: CADModifyAccountPermsStruct): Promise<globalTypes.CADStandardResponse>;
+    /**
+     * Bans or kicks a CAD user.
+     */
+    banUser(data: CADKickBanUserStruct): Promise<globalTypes.CADStandardResponse>;
+    /**
+     * Verifies a secret string against CAD configuration.
+     */
+    verifySecret(secret: string): Promise<globalTypes.CADStandardResponse>;
+    /**
+     * Authorizes street sign changes for a CAD server.
+     */
+    authorizeStreetSigns(serverId: number): Promise<globalTypes.CADStandardResponse>;
+    /**
+     * Replaces the community postal list.
+     */
+    setPostals(data: CADSetPostalStruct[]): Promise<globalTypes.CADStandardResponse>;
+    /**
+     * Sends a photo to CAD for the provided API ID.
+     */
+    sendPhoto(apiId: string | undefined, url: string): Promise<globalTypes.CADStandardResponse>;
+    /**
+     * Retrieves characters belonging to an API ID.
+     */
+    getCharacters(apiId: string): Promise<globalTypes.CADStandardResponse>;
+    /**
+     * Creates a new civilian character.
+     */
+    createCharacter(data: CADNewEditRecordOptionOneStruct | CADNewEditRecordOptionTwoStruct): Promise<globalTypes.CADStandardResponse>;
+    /**
+     * Updates an existing civilian character.
+     */
+    updateCharacter(data: CADNewEditRecordOptionOneStruct | CADNewEditRecordOptionTwoStruct): Promise<globalTypes.CADStandardResponse>;
+    /**
+     * Removes a civilian character by identifier.
+     */
+    removeCharacter(id: number): Promise<globalTypes.CADStandardResponse>;
+    /**
+     * Retrieves identifiers assigned to an API ID.
+     */
+    getIdentifiers(apiId: string): Promise<globalTypes.CADStandardResponse>;
+    /**
+     * Modifies identifiers for an account.
+     */
+    modifyIdentifier(data: CADModifyIdentifierStruct): Promise<globalTypes.CADStandardResponse>;
+    /**
+     * Sets the active identifier by identifier ID.
+     */
+    setIdentifier(apiId: string | undefined, identId: number): Promise<globalTypes.CADStandardResponse>;
+    /**
+     * Toggles panic state for a unit.
+     */
+    setUnitPanic(apiId: string | undefined, isPanic: boolean): Promise<globalTypes.CADStandardResponse>;
+    /**
+     * Updates a unit's status.
+     */
+    setUnitStatus(apiId: string | undefined, status: number, serverId: number): Promise<globalTypes.CADStandardResponse>;
+    /**
+     * Retrieves live map blips for a CAD server.
+     */
+    getBlips(serverId: number): Promise<globalTypes.CADStandardResponse>;
+    /**
+     * Adds blips to the CAD map.
+     */
+    addBlips(blips: CADAddBlipStruct | CADAddBlipStruct[]): Promise<globalTypes.CADStandardResponse>;
+    /**
+     * Updates existing CAD map blips.
+     */
+    updateBlips(blips: CADModifyBlipStruct | CADModifyBlipStruct[]): Promise<globalTypes.CADStandardResponse>;
+    /**
+     * Removes a CAD map blip.
+     */
+    removeBlip(id: number): Promise<globalTypes.CADStandardResponse>;
+    /**
+     * Creates a new 911 call entry.
+     */
+    create911Call(params: {
+        serverId: number;
+        isEmergency: boolean;
+        caller: string;
+        location: string;
+        description: string;
+        metaData?: Record<string, string>;
+    }): Promise<globalTypes.CADStandardResponse>;
+    /**
+     * Removes a 911 call by its identifier.
+     */
+    remove911Call(callId: number): Promise<globalTypes.CADStandardResponse>;
+    /**
+     * Retrieves dispatch calls with optional pagination.
+     */
+    getCalls(options: CADGetCallsStruct): Promise<globalTypes.CADStandardResponse>;
+    /**
+     * Retrieves active units for the provided filters.
+     */
+    getActiveUnits(options: CADGetActiveUnitsStruct): Promise<globalTypes.CADStandardResponse>;
+    /**
+     * Kicks an active unit from the CAD.
+     */
+    kickUnit(apiId: string | undefined, reason: string, serverId: number): Promise<globalTypes.CADStandardResponse>;
+    /**
+     * Creates a new dispatch call.
+     */
+    createDispatch(data: CADNewDispatchStruct): Promise<globalTypes.CADStandardResponse>;
+    /**
+     * Attaches units to an existing dispatch call.
+     */
+    attachUnits(serverId: number, callId: number, units: string[]): Promise<globalTypes.CADStandardResponse>;
+    /**
+     * Detaches units from dispatch calls.
+     */
+    detachUnits(serverId: number, units: string[]): Promise<globalTypes.CADStandardResponse>;
+    /**
+     * Updates the postal code on a call.
+     */
+    setCallPostal(serverId: number, callId: number, postal: string): Promise<globalTypes.CADStandardResponse>;
+    /**
+     * Updates a call's primary unit.
+     */
+    setCallPrimary(serverId: number, callId: number, primary: number, trackPrimary: boolean): Promise<globalTypes.CADStandardResponse>;
+    /**
+     * Adds a note to an active call.
+     */
+    addCallNote(serverId: number, callId: number, note: string): Promise<globalTypes.CADStandardResponse>;
+    /**
+     * Closes a CAD call.
+     */
+    closeCall(serverId: number, callId: number): Promise<globalTypes.CADStandardResponse>;
+    /**
+     * Updates live unit locations on the CAD map.
+     */
+    updateUnitLocations(locations: CADUnitLocationStruct[]): Promise<globalTypes.CADStandardResponse>;
+    /**
+     * Replaces the street sign configuration for a server.
+     */
+    setStreetSignConfig(serverId: number, signConfig: CADStreetSignStruct[]): Promise<globalTypes.CADStandardResponse>;
+    /**
+     * Updates an existing street sign's text.
+     */
+    updateStreetSign(serverId: number, signData: {
+        ids: number[];
+        text1: string;
+        text2: string;
+        text3: string;
+    }): Promise<globalTypes.CADStandardResponse>;
+    private normalizeAccountEntries;
 }