@sonoransoftware/sonoran.js 1.0.3 → 1.0.5

package/dist/constants.d.ts

@@ -115,6 +115,55 @@ export interface CMSCheckComApiIdPromiseResult {
     reason?: string;
     username?: string;
 }
+export interface CMSGetDepartmentsPromiseResult {
+    success: boolean;
+    reason?: string;
+    data?: CMSDepartment[];
+}
+export interface CMSSetAccountRanksPromiseResult {
+    success: boolean;
+    reason?: string;
+    data?: {
+        accId: string;
+        sysStatus: boolean;
+        comStatus: boolean;
+        joinDate: string;
+        lastLogin: string;
+        owner: boolean;
+        banned: boolean;
+        activeApiIds: string[];
+        primaryIdentifier: string;
+        secondaryIdentifiers: {
+            identifiers: {
+                id: string;
+                label: string;
+            }[];
+        };
+        primaryRank: string;
+        secondaryRanks: string[];
+        primaryDepartment: string;
+        secondaryDepartments: string[];
+    };
+}
+export interface CMSSetAccountRanksChangesObject {
+    set?: {
+        primary?: string | null;
+        secondary?: string[];
+    };
+    add: string[];
+    remove: string[];
+}
+export interface CMSDepartment {
+    uuid: string;
+    label: string;
+    labelTwo: string;
+    ranks: {
+        id: string;
+        label: string;
+        primaryOnly: boolean;
+        secondaryOnly: boolean;
+    }[];
+}
 export interface CADGetAccountPromiseResult {
     success: boolean;
     reason?: string;
@@ -172,3 +221,10 @@ export interface CADGetAccountPromiseResult {
         apiIds: string[];
     };
 }
+export interface clockInOutRequest {
+    id: number;
+    notes: any[];
+    endTime: string;
+    completed: boolean;
+    startTime: string;
+}

package/dist/libs/rest/src/lib/REST.js

@@ -78,7 +78,16 @@ class REST extends events_1.EventEmitter {
                 return {
                     apiId: args[0],
                     username: args[1],
-                    accId: args[2]
+                    accId: args[2],
+                    discord: args[3]
+                };
+            }
+            case 'GET_ACCOUNT_RANKS': {
+                return {
+                    apiId: args[0],
+                    username: args[1],
+                    accId: args[2],
+                    discord: args[3]
                 };
             }
             case 'CLOCK_IN_OUT': {
@@ -93,6 +102,14 @@ class REST extends events_1.EventEmitter {
                     apiId: args[0]
                 };
             }
+            case 'SET_ACCOUNT_RANKS': {
+                return {
+                    accountId: args[0],
+                    set: args[1].set,
+                    add: args[1].add,
+                    remove: args[1].remove,
+                };
+            }
             default: {
                 return args;
             }

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

@@ -32,7 +32,7 @@ export declare const EmergencyCADAPITypes: APITypeData[];
 export declare const GeneralCMSAPITypes: APITypeData[];
 export declare const ServersCMSAPITypes: APITypeData[];
 export declare const AllAPITypes: AllAPITypeData[];
-export declare 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' | 'FULL_WHITELIST' | 'GET_ACCOUNT_RANKS';
+export declare 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_DEPARTMENTS' | 'GET_SUB_VERSION' | 'CHECK_COM_APIID' | 'VERIFY_WHITELIST' | 'CLOCK_IN_OUT' | 'FULL_WHITELIST' | 'GET_ACCOUNT_RANKS' | 'SET_ACCOUNT_RANKS';
 export interface CMSServerAPIStruct {
     id: number;
     name: string;
@@ -386,7 +386,8 @@ export interface RESTTypedAPIDataStructs {
     GET_COM_ACCOUNT: [
         apiId?: string,
         username?: string,
-        accId?: string
+        accId?: string,
+        discord?: string
     ];
     GET_SUB_VERSION: [];
     CHECK_COM_APIID: [apiId: string];
@@ -395,10 +396,21 @@ export interface RESTTypedAPIDataStructs {
         accId?: string,
         forceClockIn?: boolean
     ];
+    GET_DEPARTMENTS: [];
     GET_ACCOUNT_RANKS: [
         apiId?: string,
         username?: string,
-        accId?: string
+        accId?: string,
+        discord?: string
+    ];
+    SET_ACCOUNT_RANKS: [
+        accountId: string,
+        set?: {
+            primary?: string | null;
+            secondary?: string[];
+        },
+        add?: string[],
+        remove?: string[]
     ];
     GET_GAME_SERVERS: [];
     VERIFY_WHITELIST: [
@@ -498,4 +510,12 @@ export declare type PossibleRequestData = undefined | {
 } | {
     apiId: string;
     forceClockIn: boolean;
+} | {
+    accountId: string;
+    set?: {
+        primary: string[];
+        secondary: string[];
+    };
+    add?: string[];
+    remove?: string[];
 };

package/dist/libs/rest/src/lib/utils/constants.js

@@ -322,6 +322,18 @@ exports.GeneralCMSAPITypes = [
         method: 'POST',
         minVersion: 2,
     },
+    {
+        type: 'SET_ACCOUNT_RANKS',
+        path: 'general/set_account_ranks',
+        method: 'POST',
+        minVersion: 2,
+    },
+    {
+        type: 'GET_DEPARTMENTS',
+        path: 'general/get_departments',
+        method: 'POST',
+        minVersion: 2,
+    },
     {
         type: 'GET_SUB_VERSION',
         path: 'general/get_sub_version',

package/dist/managers/CMSManager.d.ts

@@ -45,6 +45,7 @@ export declare class CMSManager extends BaseManager {
         accId?: string;
         apiId?: string;
         username?: string;
+        discord?: string;
     }): Promise<globalTypes.CMSGetComAccountPromiseResult>;
     /**
      * Gets a community account by `accId`, `apiId`, or `username`.
@@ -58,6 +59,7 @@ export declare class CMSManager extends BaseManager {
         accId?: string;
         apiId?: string;
         username?: string;
+        discord?: string;
     }): Promise<globalTypes.CMSGetAccountRanksPromiseResult>;
     /**
      * Clocks in or out an account by `accId` or `apiId`.
@@ -78,4 +80,21 @@ export declare class CMSManager extends BaseManager {
      * @returns {Promise} Promise object represents if the request was successful with reason for failure if needed.
      */
     checkComApiId(apiId: string): Promise<globalTypes.CMSCheckComApiIdPromiseResult>;
+    /**
+     * Gets all department information within the community CMS.
+     * @returns {Promise} Promise object represents if the request was successful with reason for failure if needed.
+     */
+    getDepartments(): Promise<globalTypes.CMSGetDepartmentsPromiseResult>;
+    /**
+     * Sets a community account's ranks for the CMS community.
+     * @param {string} accountId The object that contains critical data to clock in or out an account.
+     * @param {Object} changes The object that contains change data for setting account ranks.
+     * @param {Object} [changes.set] (Optional) The object that contains primary and secondary data for setting account ranks.
+     * @param {string} [changes.set.primary] (Optional) The primary rank ID wanting to set to the account.
+     * @param {string} [changes.set.secondary] (Optional) The secondary rank ID(s) wanting to set to the account.
+     * @param {Array} [changes.add] (Optional) The secondary rank IDs wanting to add to the account.
+     * @param {Array} [changes.remove] (Optional) The secondary rank IDs wanting to remove to the account.
+     * @returns {Promise} Promise object represents if the request was successful with reason for failure if needed.
+     */
+    setAccountRanks(accountId: string, changes: globalTypes.CMSSetAccountRanksChangesObject): Promise<globalTypes.CMSSetAccountRanksPromiseResult>;
 }

package/dist/managers/CMSManager.js

@@ -43,12 +43,16 @@ class CMSManager extends BaseManager_1.BaseManager {
         var _a;
         try {
             const versionResp = await ((_a = this.rest) === null || _a === void 0 ? void 0 : _a.request('GET_SUB_VERSION'));
+            const version = Number.parseInt(versionResp.replace(/(^\d+)(.+$)/i, '$1'));
             const mutableThis = this;
-            mutableThis.version = Number.parseInt(versionResp.replace(/(^\d+)(.+$)/i, '$1'));
-            if (this.version >= globalTypes.CMSSubscriptionVersionEnum.STANDARD) {
+            if (version >= globalTypes.CMSSubscriptionVersionEnum.STANDARD) {
                 this.servers = new CMSServerManager_1.CMSServerManager(instance, this);
             }
             mutableThis.ready = true;
+            mutableThis.version = version;
+            console.log(mutableThis.version);
+            console.log(this.version);
+            console.log(version);
             instance.isCMSSuccessful = true;
             instance.emit('CMS_SETUP_SUCCESSFUL');
         }
@@ -122,7 +126,7 @@ class CMSManager extends BaseManager_1.BaseManager {
         return new Promise(async (resolve, reject) => {
             var _a;
             try {
-                const getAccountRequest = await ((_a = this.rest) === null || _a === void 0 ? void 0 : _a.request('GET_COM_ACCOUNT', params.apiId, params.username, params.accId));
+                const getAccountRequest = await ((_a = this.rest) === null || _a === void 0 ? void 0 : _a.request('GET_COM_ACCOUNT', params.apiId, params.username, params.accId, params.discord));
                 resolve({ success: true, data: getAccountRequest });
             }
             catch (err) {
@@ -147,7 +151,7 @@ class CMSManager extends BaseManager_1.BaseManager {
         return new Promise(async (resolve, reject) => {
             var _a;
             try {
-                const getAccountRanksRequest = await ((_a = this.rest) === null || _a === void 0 ? void 0 : _a.request('GET_ACCOUNT_RANKS', params.apiId, params.username, params.accId));
+                const getAccountRanksRequest = await ((_a = this.rest) === null || _a === void 0 ? void 0 : _a.request('GET_ACCOUNT_RANKS', params.apiId, params.username, params.accId, params.discord));
                 resolve({ success: true, data: getAccountRanksRequest });
             }
             catch (err) {
@@ -173,8 +177,10 @@ class CMSManager extends BaseManager_1.BaseManager {
             var _a;
             try {
                 const clockInOutRequest = await ((_a = this.rest) === null || _a === void 0 ? void 0 : _a.request('CLOCK_IN_OUT', data.apiId, data.accId, !!data.forceClockIn));
-                const clockInOutRequestString = clockInOutRequest;
-                resolve({ success: true, clockedIn: clockInOutRequestString.includes('CLOCKED IN') });
+                const clockInOutResponse = clockInOutRequest;
+                if (!clockInOutResponse)
+                    resolve({ success: false, reason: clockInOutRequest });
+                resolve({ success: true, clockedIn: clockInOutResponse.completed });
             }
             catch (err) {
                 if (err instanceof src_1.APIError) {
@@ -208,5 +214,54 @@ class CMSManager extends BaseManager_1.BaseManager {
             }
         });
     }
+    /**
+     * Gets all department information within the community CMS.
+     * @returns {Promise} Promise object represents if the request was successful with reason for failure if needed.
+     */
+    async getDepartments() {
+        return new Promise(async (resolve, reject) => {
+            var _a;
+            try {
+                const getDepartmentsRequest = await ((_a = this.rest) === null || _a === void 0 ? void 0 : _a.request('GET_DEPARTMENTS'));
+                resolve({ success: true, data: getDepartmentsRequest });
+            }
+            catch (err) {
+                if (err instanceof src_1.APIError) {
+                    resolve({ success: false, reason: err.response });
+                }
+                else {
+                    reject(err);
+                }
+            }
+        });
+    }
+    /**
+     * Sets a community account's ranks for the CMS community.
+     * @param {string} accountId The object that contains critical data to clock in or out an account.
+     * @param {Object} changes The object that contains change data for setting account ranks.
+     * @param {Object} [changes.set] (Optional) The object that contains primary and secondary data for setting account ranks.
+     * @param {string} [changes.set.primary] (Optional) The primary rank ID wanting to set to the account.
+     * @param {string} [changes.set.secondary] (Optional) The secondary rank ID(s) wanting to set to the account.
+     * @param {Array} [changes.add] (Optional) The secondary rank IDs wanting to add to the account.
+     * @param {Array} [changes.remove] (Optional) The secondary rank IDs wanting to remove to the account.
+     * @returns {Promise} Promise object represents if the request was successful with reason for failure if needed.
+     */
+    async setAccountRanks(accountId, changes) {
+        return new Promise(async (resolve, reject) => {
+            var _a;
+            try {
+                const setAccountRanksRequest = await ((_a = this.rest) === null || _a === void 0 ? void 0 : _a.request('SET_ACCOUNT_RANKS', accountId, changes.set, changes.add, changes.remove));
+                resolve({ success: true, data: setAccountRanksRequest });
+            }
+            catch (err) {
+                if (err instanceof src_1.APIError) {
+                    resolve({ success: false, reason: err.response });
+                }
+                else {
+                    reject(err);
+                }
+            }
+        });
+    }
 }
 exports.CMSManager = CMSManager;

package/dist/managers/CMSServerManager.js

@@ -8,6 +8,11 @@ class CMSServerManager extends CacheManager_1.CacheManager {
         super(instance, CMSServer_1.CMSServer, []);
         (async () => {
             var _a;
+            while (!manager.ready) {
+                await new Promise((resolve) => {
+                    setTimeout(resolve, 100);
+                });
+            }
             try {
                 const serversRes = await ((_a = manager.rest) === null || _a === void 0 ? void 0 : _a.request('GET_GAME_SERVERS'));
                 const servers = serversRes.servers;
@@ -18,6 +23,7 @@ class CMSServerManager extends CacheManager_1.CacheManager {
                     };
                     this._add(serverStruct, true, server.id);
                 });
+                console.log(`Found ${servers.length} servers`);
             }
             catch (err) {
                 throw new Error(String(err));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sonoransoftware/sonoran.js",
-  "version": "1.0.3",
+  "version": "1.0.5",
   "description": "Sonoran.js is a library that allows you to interact with the Sonoran CAD and Sonoran CMS API. Based off of and utilizes several Discord.js library techniques for ease of use.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -18,7 +18,7 @@
   "license": "ISC",
   "devDependencies": {
     "@types/node": "^17.0.21",
-    "@types/node-fetch": "^2.6.1",
+    "@types/node-fetch": "^2.6.2",
     "eslint": "^8.10.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-import": "^2.25.4",

package/src/builders/cad/DispatchCall.ts

@@ -1,159 +1,159 @@
-import { CADNewDispatchBuilderOptions } from '../../constants';
-import { CADDispatchOriginEnums, CADDispatchStatusEnums } from '../../libs/rest/src';
-
-/**
- * Represents a constructed dispatch call for API requests
- */
-export class DispatchCallBuilder {
-  public readonly data: CADNewDispatchBuilderOptions;
-
-  /**
-   * Dispatch Call Builder used for API calls with Sonoran CAD to create a new dispatch call.
-   * @param data Data Options (CADNewDispatchBuilderOptions) used to build the new dispatch call
-   */
-  public constructor(data: CADNewDispatchBuilderOptions = {}) {
-    this.data = { ...data };
-  }
-
-  /**
-	 * Sets the origin for this dispatch call
-   * @param origin Origin enum used for this dispatch call for information purposes
-	 */
-  public setOrigin(origin: CADDispatchOriginEnums): this {
-    this.data.origin = origin;
-    return this;
-  }
-
-  /**
-	 * Sets the status for this dispatch call
-   * @param status Status enum used for the dispatch call for information purposes
-	 */
-  public setStatus(status: CADDispatchStatusEnums): this {
-    this.data.status = status;
-    return this;
-  }
-
-  /**
-	 * Sets the priority level for this dispatch call
-   * @param priority Priority level used for the dispatch call for information purposes
-	 */
-  public setPriority(priority: 1 | 2 | 3): this {
-    this.data.priority = priority;
-    return this;
-  }
-
-  /**
-	 * Sets the block for this dispatch call
-   * @param block Block used for the dispatch call for information purposes
-	 */
-  public setBlock(block: string): this {
-    this.data.block = block;
-    return this;
-  }
-
-  /**
-	 * Sets the address for this dispatch call
-   * @param address Address used for the dispatch call for information purposes
-	 */
-  public setAddress(address: string): this {
-    this.data.address = address;
-    return this;
-  }
-
-  /**
-	 * Sets the postal for this dispatch call
-   * @param postal Postal used for the dispatch call for information purposes
-	 */
-  public setPostal(postal: string): this {
-    this.data.postal = postal;
-    return this;
-  }
-
-  /**
-	 * Sets the title for this dispatch call
-   * @param title Title used for the dispatch call for information purposes
-	 */
-  public setTitle(title: string): this {
-    this.data.title = title;
-    return this;
-  }
-
-  /**
-	 * Sets the code for this dispatch call
-   * @param code Code used for the dispatch call for information purposes
-	 */
-  public setCode(code: string): this {
-    this.data.code = code;
-    return this;
-  }
-
-  /**
-	 * Sets the primary tracking preference for this dispatch call
-   * @param primaryUnit Primary unit identifier
-	 */
-  public setPrimary(primaryUnit: number): this {
-    this.data.primary = primaryUnit;
-    return this;
-  }
-
-  /**
-	 * Sets the track primary preference for this dispatch call
-   * @param preference Preference for tracking primary
-	 */
-  public setTrackPrimaryPreference(preference: boolean): this {
-    this.data.trackPrimary = preference;
-    return this;
-  }
-
-  /**
-	 * Sets the description for this dispatch call
-   * @param description Description for a dispatch call
-	 */
-  public setDescription(description: string): this {
-    this.data.description = description;
-    return this;
-  }
-
-  /**
-	 * Sets metadata for this dispatch call that can be used later on
-   * @param metaData Dictionary of metadata to store with a dispatch call, can be used later on
-	 */
-  public setMetadata(metaData: Record<string, string>): this {
-    this.data.metaData = metaData;
-    return this;
-  }
-
-  /**
-	 * Sets specified units for this dispatch call
-   * @param units Units to be removed from a call
-	 */
-  public setUnits(units: string[]): this {
-    this.data.units = units;
-    return this;
-  }
-
-  /**
-	 * Adds specified units from this dispatch call
-   * @param units Units to be removed from a call
-	 */
-  public addUnits(...units: string[]): this {
-    this.data.units?.push(...units);
-    return this;
-  }
-
-  /**
-	 * Removes specified units from this dispatch call
-   * @param units Units to be removed from a call
-	 */
-  public removeUnits(...units: string[]): this {
-    this.data.units?.filter((unit) => !units.includes(unit));
-    return this;
-  }
-
-  /**
-	 * Transforms the dispatch call to a plain object
-	 */
-  public toJSON(): CADNewDispatchBuilderOptions{
-    return { ...this.data };
-  }
+import { CADNewDispatchBuilderOptions } from '../../constants';
+import { CADDispatchOriginEnums, CADDispatchStatusEnums } from '../../libs/rest/src';
+
+/**
+ * Represents a constructed dispatch call for API requests
+ */
+export class DispatchCallBuilder {
+  public readonly data: CADNewDispatchBuilderOptions;
+
+  /**
+   * Dispatch Call Builder used for API calls with Sonoran CAD to create a new dispatch call.
+   * @param data Data Options (CADNewDispatchBuilderOptions) used to build the new dispatch call
+   */
+  public constructor(data: CADNewDispatchBuilderOptions = {}) {
+    this.data = { ...data };
+  }
+
+  /**
+	 * Sets the origin for this dispatch call
+   * @param origin Origin enum used for this dispatch call for information purposes
+	 */
+  public setOrigin(origin: CADDispatchOriginEnums): this {
+    this.data.origin = origin;
+    return this;
+  }
+
+  /**
+	 * Sets the status for this dispatch call
+   * @param status Status enum used for the dispatch call for information purposes
+	 */
+  public setStatus(status: CADDispatchStatusEnums): this {
+    this.data.status = status;
+    return this;
+  }
+
+  /**
+	 * Sets the priority level for this dispatch call
+   * @param priority Priority level used for the dispatch call for information purposes
+	 */
+  public setPriority(priority: 1 | 2 | 3): this {
+    this.data.priority = priority;
+    return this;
+  }
+
+  /**
+	 * Sets the block for this dispatch call
+   * @param block Block used for the dispatch call for information purposes
+	 */
+  public setBlock(block: string): this {
+    this.data.block = block;
+    return this;
+  }
+
+  /**
+	 * Sets the address for this dispatch call
+   * @param address Address used for the dispatch call for information purposes
+	 */
+  public setAddress(address: string): this {
+    this.data.address = address;
+    return this;
+  }
+
+  /**
+	 * Sets the postal for this dispatch call
+   * @param postal Postal used for the dispatch call for information purposes
+	 */
+  public setPostal(postal: string): this {
+    this.data.postal = postal;
+    return this;
+  }
+
+  /**
+	 * Sets the title for this dispatch call
+   * @param title Title used for the dispatch call for information purposes
+	 */
+  public setTitle(title: string): this {
+    this.data.title = title;
+    return this;
+  }
+
+  /**
+	 * Sets the code for this dispatch call
+   * @param code Code used for the dispatch call for information purposes
+	 */
+  public setCode(code: string): this {
+    this.data.code = code;
+    return this;
+  }
+
+  /**
+	 * Sets the primary tracking preference for this dispatch call
+   * @param primaryUnit Primary unit identifier
+	 */
+  public setPrimary(primaryUnit: number): this {
+    this.data.primary = primaryUnit;
+    return this;
+  }
+
+  /**
+	 * Sets the track primary preference for this dispatch call
+   * @param preference Preference for tracking primary
+	 */
+  public setTrackPrimaryPreference(preference: boolean): this {
+    this.data.trackPrimary = preference;
+    return this;
+  }
+
+  /**
+	 * Sets the description for this dispatch call
+   * @param description Description for a dispatch call
+	 */
+  public setDescription(description: string): this {
+    this.data.description = description;
+    return this;
+  }
+
+  /**
+	 * Sets metadata for this dispatch call that can be used later on
+   * @param metaData Dictionary of metadata to store with a dispatch call, can be used later on
+	 */
+  public setMetadata(metaData: Record<string, string>): this {
+    this.data.metaData = metaData;
+    return this;
+  }
+
+  /**
+	 * Sets specified units for this dispatch call
+   * @param units Units to be removed from a call
+	 */
+  public setUnits(units: string[]): this {
+    this.data.units = units;
+    return this;
+  }
+
+  /**
+	 * Adds specified units from this dispatch call
+   * @param units Units to be removed from a call
+	 */
+  public addUnits(...units: string[]): this {
+    this.data.units?.push(...units);
+    return this;
+  }
+
+  /**
+	 * Removes specified units from this dispatch call
+   * @param units Units to be removed from a call
+	 */
+  public removeUnits(...units: string[]): this {
+    this.data.units?.filter((unit) => !units.includes(unit));
+    return this;
+  }
+
+  /**
+	 * Transforms the dispatch call to a plain object
+	 */
+  public toJSON(): CADNewDispatchBuilderOptions{
+    return { ...this.data };
+  }
 }