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 246 247 248 | import {
api400Body, api401Body, api403Body, api500Body
} from './_shared';
import { TwilioAccounts } from '@/types/backend/department';
import { Validator } from '@/types/backend/validation';
export interface InvoiceItem {
type: 'aws' | 'twilio';
cat: string;
price: number;
usage: number;
usageUnit: string;
}
export interface Invoice {
id: string;
department?: string;
total?: number;
startDate?: string;
endDate?: string;
generatedDate?: string;
paidDate?: string;
s3Location?: string;
}
/**
* List invoices with filters
* @summary List Invoices
* @tags Invoices
* @body.contentType application/json
*/
export type ListInvoicesApi = {
path: '/api/v2/invoices/';
method: 'GET';
query: {
department?: Exclude<TwilioAccounts, ''> | 'all';
/**
* Find invoices with an end date before this date, format YYYY-MM-DD
*/
before?: string;
/**
* Find invoices with a start date after this date, format YYYY-MM-DD
*/
after?: string;
};
responses: {
/**
* @contentType application/json
*/
200: {
lastItem: string | null;
invoices: Invoice[];
};
/**
* @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: [],
}];
};
/**
* Get a specific invoice's PDF file
* @summary Get Invoice
* @tags Invoices
* @body.contentType application/json
*/
export type GetInvoiceApi = {
path: '/api/v2/invoices/{id}/';
method: 'GET';
params: { id: string; }
responses: {
/**
* @contentType application/pdf
*/
200: Buffer;
/**
* @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: [],
}];
};
/**
* Get a departments invoiced items for a given time period
* @summary Get Invoice Items
* @tags Invoices
* @body.contentType application/json
*/
export type GetInvoiceItemsApi = {
path: '/api/v2/invoices/{department}/items/';
method: 'GET';
params: { department: Exclude<TwilioAccounts, ''> | 'all'; }
query: {
month?: 'this' | 'last';
/**
* First day to report data for, format YYYY-MM-DD
*/
startDate?: string;
/**
* Day to end data on (goes until midnight on this day) YYYY-MM-DD
*/
endDate?: string;
/**
* Whether to group data by day or month, default is no grouping (all data in one bucket)
*/
by?: 'day' | 'month' | 'all';
};
responses: {
/**
* @contentType application/json
*/
200: {
start: string;
end: string;
items: InvoiceItem[];
};
/**
* @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 getInvoiceItemsApiParamsValidator: Validator<GetInvoiceItemsApi['params']> = {
department: {
required: true,
types: {
string: {
exact: [
'all',
'Baca',
'Crestone',
'NSCAD',
'Saguache',
],
},
},
},
};
export const getInvoiceItemsApiQueryValidator: Validator<GetInvoiceItemsApi['query']> = {
month: {
required: false,
types: {
string: {
exact: [
'last',
'this',
],
},
},
},
startDate: {
required: false,
types: {
string: {
regex: /[0-9]{4}-[0-9]{2}-[0-9]{2}/,
},
},
},
endDate: {
required: false,
types: {
string: {
regex: /[0-9]{4}-[0-9]{2}-[0-9]{2}/,
},
},
},
by: {
required: false,
types: {
string: {
exact: [
'day',
'month',
'all',
],
},
},
},
};
|