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 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 | import {
api200Body, api400Body, api401Body, api403Body, api500Body
} from './_shared';
import {
UserDepartment, validDepartments
} from './users';
import { Validator } from '@/types/backend/validation';
export const textTypes = [
'page',
'alert',
'account',
'transcript',
'pageAnnounce',
'department',
'departmentAnnounce',
'departmentAlert',
] as const;
export type TextTypes = typeof textTypes[number];
export interface FullTextObject {
datetime: number;
body?: string;
// Only on pages section
pageId?: string;
/**
* The phone numbers of the users who have opened the link to the page
*/
csLooked?: number[];
/**
* Timestamps of when each person clicked the link the first time
*/
csLookedTime?: number[];
talkgroup?: number;
/**
* First letter - was this a test text message, second letter - was this a page
*/
testPageIndex?: 'yy' | 'yn' | 'ny' | 'nn';
type?: TextTypes;
department?: UserDepartment;
/**
* Comma separated list of URLs that can be used to view media sent with the text
*/
mediaUrls?: string | string[];
recipients?: number;
sent?: number[];
sentPhone?: number[];
delivered?: number[]; // Timestamp
deliveredPhone?: number[]; // Phone #
undelivered?: number[]; // Timestamp
undeliveredPhone?: number[]; // Phone #
fromNumber?: string;
isPage?: boolean;
isTest?: boolean;
}
export const allowedFrontendTextFields = [
'datetime',
'body',
'pageId',
'csLookedTime',
'talkgroup',
'testPageIndex',
'type',
'department',
'mediaUrls',
'recipients',
'sent',
'delivered',
'undelivered',
'fromNumber',
'isPage',
'isTest',
] as const;
export type FrontendTextObject = Pick<
FullTextObject,
typeof allowedFrontendTextFields[number]
>;
/**
* Retrieve a list of files that match the given filters
* @summary Retrieve Texts List
* @tags Texts
*/
export type GetAllTextsApi = {
path: '/api/v2/texts/';
method: 'GET';
query: {
/**
* The type of texts to retrieve
*/
type?: TextTypes;
/**
* The department to retrieve texts from
*/
department?: UserDepartment;
/**
* The timestamp to return messages before, in ms since epoch
*/
before?: number;
/**
* Pass 'y' to return texts with 0 recipients
*/
all?: 'y';
};
responses: {
/**
* @contentType application/json
*/
200: {
count: number;
scanned: number;
texts: FrontendTextObject[];
};
/**
* @contentType application/json
*/
400: typeof api400Body;
/**
* @contentType application/json
*/
401: typeof api401Body;
/**
* @contentType application/json
*/
403: typeof api403Body;
/**
* @contentType application/json
*/
500: typeof api500Body;
};
security: [{
cookie: [],
}];
};
export const getAllTextsApiQueryValidator: Validator<GetAllTextsApi['query']> = {
before: {
required: false,
parse: v => Number(v),
types: {
number: {},
},
},
type: {
required: false,
types: {
string: {
exact: textTypes,
},
},
},
department: {
required: false,
types: {
string: {
exact: validDepartments,
},
},
},
all: {
required: false,
types: {
string: {
exact: [ 'y', ],
},
},
},
};
/**
* Update which users have opened the link in the paging message
* @summary Mark Text Opened
* @tags Texts
* @body.contentType application/json
*/
export type UpdateTextSeenApi = {
path: '/api/v2/texts/{id}/';
method: 'PATCH';
params: {
/**
* The text ID that was opened
*/
id: number;
};
body: {
/**
* The phone number that opened the message
*/
phone: number;
};
responses: {
/**
* @contentType application/json
*/
200: typeof api200Body;
/**
* @contentType application/json
*/
400: typeof api400Body;
/**
* @contentType application/json
*/
500: typeof api500Body;
};
};
export const updateTextSeenApiParamsValidator: Validator<UpdateTextSeenApi['params']> = {
id: {
required: true,
parse: v => Number(v),
types: {
number: {},
},
},
};
export const updateTextSeenApiBodyValidator: Validator<UpdateTextSeenApi['body']> = {
phone: {
required: true,
types: {
number: {},
},
},
};
|