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 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 | import {
api400Body, api404Body, api500Body
} from './_shared';
import { Validator } from '@/types/backend/validation';
export interface FullFileObject {
Talkgroup: number;
DeviceProcessed?: boolean; // Temp field, delete
RadioID?: string; // Only actually on device files but added to make typing easier
/**
* Timestamp of when the file was added to S3
*/
Added: number;
Emergency?: 0 | 1;
/**
* Timestamp of the end of the recording (in seconds since epoch)
*/
EndTime?: number;
Freq?: number;
/**
* Location of the file in the S3 bucket
*/
Key?: string;
Len?: number;
Sources?: number[];
/**
* Timestamp of the start of the recording (in seconds since epoch)
*/
StartTime?: number;
Tone?: boolean;
ToneIndex?: 'y' | 'n';
Tower?: string;
Transcript?: string;
PageSent?: boolean;
}
export interface FileTranslationObject {
Key: string;
NewKey?: string;
TTL?: number;
}
/**
* Retrieve a list of files that match the given filters
* @summary Retrieve Files List
* @tags Files
*/
export type GetAllFilesApi = {
path: '/api/v2/files/';
method: 'GET';
query: {
/**
* The talkgroups to retrieve file from. This should be a pipe-separated list of integers
*/
tg?: number[];
/**
* The radio ID to retrieve files from. This should be a single integer
*/
radioId?: string;
/**
* Whether to exclusively return traffic that is marked as "emergency"
*/
emerg?: 'y' | 'n';
/**
* Whether to exclusively return traffic that includes a paging tone
*/
tone?: 'y' | 'n';
/**
* Return files with a start time less than this time
*/
before?: number;
/**
* Return files with a start time greater than this time
*/
after?: number;
/**
* Return files with an added time greater than this time
*/
afterAdded?: number;
};
responses: {
/**
* @contentType application/json
*/
200: {
before: number | null;
after: number | null;
afterAdded: number | null;
files: FullFileObject[];
};
/**
* @contentType application/json
*/
400: typeof api400Body;
/**
* @contentType application/json
*/
500: typeof api500Body;
};
};
export const getAllFilesApiQueryValidator: Validator<GetAllFilesApi['query']> = {
tg: {
required: false,
types: {
array: {},
},
},
radioId: {
required: false,
types: {
string: {
regex: /^[0-9]+$/,
},
},
},
emerg: {
required: false,
types: {
string: {
exact: [
'y',
'n',
],
},
},
},
tone: {
required: false,
types: {
string: {
exact: [
'y',
'n',
],
},
},
},
before: {
required: false,
parse: v => Number(v),
types: {
number: {},
},
},
after: {
required: false,
parse: v => Number(v),
types: {
number: {},
},
},
afterAdded: {
required: false,
parse: v => Number(v),
types: {
number: {},
},
},
};
/**
* Retrieve metadata for a specific file
* @summary Retrieve File Information
* @tags Files
*/
export type GetFileApi = {
path: '/api/v2/files/{id}/';
method: 'GET';
params: {
/**
* File ID in the format {Talkgroup}-{Added}
*/
id: string;
};
responses: {
/**
* @contentType application/json
*/
200: FullFileObject;
/**
* @contentType application/json
*/
400: typeof api400Body;
/**
* @contentType application/json
*/
404: typeof api404Body;
/**
* @contentType application/json
*/
500: typeof api500Body;
};
};
export const getFileApiParamsValidator: Validator<GetFileApi['params']> = {
id: {
required: true,
types: {
string: {
regex: /^[0-9]+-[0-9]+$/,
},
},
},
};
|