Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 | import {
api400Body, api401Body, api403Body, api404Body, api500Body
} from './_shared';
import { Validator } from '@/types/backend/validation';
export interface FullTalkgroupObject {
ID: number;
Name?: string;
InUse?: 'Y' | 'N';
HasEvents?: 'Y' | 'N';
Count?: number;
EventsCount?: number;
/**
* Map of device ID to number of times it has been seen transmitting on this talkgroup
*/
Devices?: {
[key: string]: number;
};
/**
* Key of the last "Added" key that was processed
*/
LastDeviceAdded?: number;
DoneDevices?: boolean;
}
type SmallTalkgroupObject = Omit<FullTalkgroupObject, 'Devices'>;
/**
* Retrieve a list of talkgroups that match the given filters
* @summary Retrieve Talkgroups List
* @tags Talkgroups
*/
export type GetAllTalkgroupsApi = {
path: '/api/v2/talkgroups/';
method: 'GET';
query: {
/**
* Pass 'y' to access all talkgroups. The default behavior is to only return talkgroups that
* have recordings associated with them
*/
all?: 'y';
};
responses: {
/**
* @contentType application/json
*/
200: {
count: number;
loadedAll: boolean;
runs: number;
talkgroups: SmallTalkgroupObject[];
};
/**
* @contentType application/json
*/
400: typeof api400Body;
/**
* @contentType application/json
*/
500: typeof api500Body;
};
};
export const getAllTalkgroupsApiQueryValidator: Validator<GetAllTalkgroupsApi['query']> = {
all: {
required: false,
types: {
string: {
exact: [ 'y', ],
},
},
},
};
/**
* Retrieve the metadata of a specific talkgroup
* @summary Retrieve Talkgroup Information
* @tags Talkgroups
*/
export type GetTalkgroupApi = {
path: '/api/v2/talkgroups/{id}/';
method: 'GET';
params: {
id: number;
};
responses: {
/**
* @contentType application/json
*/
200: FullTalkgroupObject;
/**
* @contentType application/json
*/
400: typeof api400Body;
/**
* @contentType application/json
*/
404: typeof api404Body;
/**
* @contentType application/json
*/
500: typeof api500Body;
};
};
/**
* Update the name of a talkgroup
* @summary Set Talkgroup Name
* @tags Talkgroups
* @body.contentType application/json
* @contentType application/json
*/
export type PatchTalkgroupApi = {
path: '/api/v2/talkgroups/{id}/';
method: 'PATCH';
params: {
/**
* Talkgroup ID (should be an integer)
*/
id: number;
};
body: {
/**
* New name for the talkgroup. Pass null to delete the name. Name may not contain newline or
* tab characters
*/
name: string | null;
};
responses: {
/**
* @contentType application/json
*/
200: FullTalkgroupObject;
/**
* @contentType application/json
*/
400: typeof api400Body;
/**
* @contentType application/json
*/
401: typeof api401Body;
/**
* @contentType application/json
*/
403: typeof api403Body;
/**
* @contentType application/json
*/
404: typeof api404Body;
/**
* @contentType application/json
*/
500: typeof api500Body;
};
security: [{
cookie: [],
}];
};
export const talkgroupParamsValidator: Validator<PatchTalkgroupApi['params']> = {
id: {
required: true,
parse: v => Number(v),
types: {
number: {},
},
},
};
export const talkgroupBodyValidator: Validator<PatchTalkgroupApi['body']> = {
name: {
required: true,
types: {
string: {
regex: /^[^\n\t]+$/,
},
null: {},
},
},
};
|