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 | import {
api200Body, api302Body, api400Body, api403Body, api500Body
} from './_shared';
import { FrontendUserObject } from '@/types/api/users';
import { Validator } from '@/types/backend/validation';
/**
* Request that a login code be sent to the user's phone
* @summary Request Login Code
* @tags Authentication
*/
export type GetLoginCodeApi = {
path: '/api/v2/login/{id}/';
method: 'GET';
params: {
/**
* The user ID (10 digit phone number) to send the code for
*/
id: number;
};
responses: {
/**
* @contentType application/json
*/
200: typeof api200Body;
/**
* @contentType application/json
*/
400: typeof api400Body;
/**
* @contentType application/json
*/
500: typeof api500Body;
};
};
/**
* Submit a login code to authenticate a user
* @summary Submit Login Code
* @tags Authentication
* @body.contentType application/json
*/
export type SubmitLoginCodeApi = {
path: '/api/v2/login/{id}/';
method: 'POST';
params: {
/**
* The user ID (10 digit phone number) to authenticate as
*/
id: number;
};
body: {
code: string;
};
responses: {
/**
* @contentType application/json
*/
200: FrontendUserObject;
/**
* @contentType application/json
*/
400: typeof api400Body;
/**
* @contentType application/json
*/
403: typeof api403Body;
/**
* @contentType application/json
*/
500: typeof api500Body;
};
};
export const loginApiParamsValidator: Validator<GetLoginCodeApi['params']> = {
id: {
required: true,
parse: v => Number(v),
types: {
number: {
regex: /^[0-9]{10}$/,
},
},
},
};
export const loginApiCodeBodyValidator: Validator<SubmitLoginCodeApi['body']> = {
code: {
required: true,
types: {
string: {
regex: /^[0-9]{6}$/,
},
},
},
};
/**
* Request that a login code be sent to the user's phone
* @summary Request Login Code
* @tags Authentication
*/
export type LogoutApi = {
path: '/api/v2/logout/';
method: 'GET';
query: {
/**
* The URL to redirect the user to after the logout is completed
*/
redirectTo?: string;
};
responses: {
/**
* @contentType application/json
*/
302: typeof api302Body;
/**
* @contentType application/json
*/
400: typeof api400Body;
/**
* @contentType application/json
*/
500: typeof api500Body;
};
};
export const logoutApiQueryValidator: Validator<LogoutApi['query']> = {
redirectTo: {
required: false,
types: {
string: {},
},
},
};
|