@altnovatrail/contracts 0.8.1 → 0.8.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/novatrail/api/v1/account_pb.d.ts +1563 -0
- package/novatrail/api/v1/account_pb.js +406 -0
- package/novatrail/api/v1/attempt_pb.d.ts +75 -2
- package/novatrail/api/v1/attempt_pb.js +16 -4
- package/novatrail/api/v1/cause_pb.d.ts +376 -11
- package/novatrail/api/v1/cause_pb.js +55 -3
- package/novatrail/api/v1/learning_pb.d.ts +754 -0
- package/novatrail/api/v1/learning_pb.js +171 -0
- package/novatrail/api/v1/module_pb.d.ts +320 -0
- package/novatrail/api/v1/module_pb.js +102 -0
- package/novatrail/api/v1/package_pb.d.ts +401 -0
- package/novatrail/api/v1/package_pb.js +133 -0
- package/novatrail/api/v1/progress_pb.d.ts +623 -0
- package/novatrail/api/v1/progress_pb.js +143 -0
- package/package.json +21 -1
|
@@ -0,0 +1,1563 @@
|
|
|
1
|
+
// @generated by protoc-gen-es v2.16.0 with parameter "target=js+dts,import_extension=js"
|
|
2
|
+
// @generated from file novatrail/api/v1/account.proto (package novatrail.api.v1, syntax proto3)
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
|
|
5
|
+
// The account and its profiles in the contract between `app` and `api`: the account and the list
|
|
6
|
+
// of its profiles, by which `app` erases on the device what was deleted elsewhere; the profile of
|
|
7
|
+
// the account's owner and a child's profile, which a consent comes before; the PIN of the section
|
|
8
|
+
// for adults; the voicing a learner sets; the own key checked when it is connected; deletion and
|
|
9
|
+
// export. What each message means, and what `app` does on each refusal, are the rules of
|
|
10
|
+
// contracts/README.md, section 15.
|
|
11
|
+
|
|
12
|
+
import type { GenEnum, GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
|
|
13
|
+
import type { Message } from "@bufbuild/protobuf";
|
|
14
|
+
import type { LessonRunRef, OpenAttemptRef } from "./learning_pb.js";
|
|
15
|
+
import type { Timestamp } from "@bufbuild/protobuf/wkt";
|
|
16
|
+
import type { OwnKey } from "./attempt_pb.js";
|
|
17
|
+
import type { Outcome } from "./cause_pb.js";
|
|
18
|
+
|
|
19
|
+
/**
|
|
20
|
+
* Describes the file novatrail/api/v1/account.proto.
|
|
21
|
+
*/
|
|
22
|
+
export declare const file_novatrail_api_v1_account: GenFile;
|
|
23
|
+
|
|
24
|
+
/**
|
|
25
|
+
* A request for the account: the user is the token's.
|
|
26
|
+
*
|
|
27
|
+
* @generated from message novatrail.api.v1.GetAccountRequest
|
|
28
|
+
*/
|
|
29
|
+
export declare type GetAccountRequest = Message<"novatrail.api.v1.GetAccountRequest"> & {
|
|
30
|
+
};
|
|
31
|
+
|
|
32
|
+
/**
|
|
33
|
+
* Describes the message novatrail.api.v1.GetAccountRequest.
|
|
34
|
+
* Use `create(GetAccountRequestSchema)` to create a new message.
|
|
35
|
+
*/
|
|
36
|
+
export declare const GetAccountRequestSchema: GenMessage<GetAccountRequest>;
|
|
37
|
+
|
|
38
|
+
/**
|
|
39
|
+
* The account.
|
|
40
|
+
*
|
|
41
|
+
* @generated from message novatrail.api.v1.GetAccountResponse
|
|
42
|
+
*/
|
|
43
|
+
export declare type GetAccountResponse = Message<"novatrail.api.v1.GetAccountResponse"> & {
|
|
44
|
+
/**
|
|
45
|
+
* The account, its profiles and its consents that have no profile yet.
|
|
46
|
+
*
|
|
47
|
+
* @generated from field: novatrail.api.v1.Account account = 1;
|
|
48
|
+
*/
|
|
49
|
+
account?: Account | undefined;
|
|
50
|
+
};
|
|
51
|
+
|
|
52
|
+
/**
|
|
53
|
+
* Describes the message novatrail.api.v1.GetAccountResponse.
|
|
54
|
+
* Use `create(GetAccountResponseSchema)` to create a new message.
|
|
55
|
+
*/
|
|
56
|
+
export declare const GetAccountResponseSchema: GenMessage<GetAccountResponse>;
|
|
57
|
+
|
|
58
|
+
/**
|
|
59
|
+
* The creation of an account.
|
|
60
|
+
*
|
|
61
|
+
* @generated from message novatrail.api.v1.CreateAccountRequest
|
|
62
|
+
*/
|
|
63
|
+
export declare type CreateAccountRequest = Message<"novatrail.api.v1.CreateAccountRequest"> & {
|
|
64
|
+
/**
|
|
65
|
+
* The invite code, as it was given.
|
|
66
|
+
*
|
|
67
|
+
* @generated from field: string invite_code = 1;
|
|
68
|
+
*/
|
|
69
|
+
inviteCode: string;
|
|
70
|
+
|
|
71
|
+
/**
|
|
72
|
+
* The owner's statement that they are 18 or older: true, or the request is refused
|
|
73
|
+
* `invalid_argument`. `api` keeps it with its date (privacy 9, П-6).
|
|
74
|
+
*
|
|
75
|
+
* @generated from field: bool adult_stated = 2;
|
|
76
|
+
*/
|
|
77
|
+
adultStated: boolean;
|
|
78
|
+
};
|
|
79
|
+
|
|
80
|
+
/**
|
|
81
|
+
* Describes the message novatrail.api.v1.CreateAccountRequest.
|
|
82
|
+
* Use `create(CreateAccountRequestSchema)` to create a new message.
|
|
83
|
+
*/
|
|
84
|
+
export declare const CreateAccountRequestSchema: GenMessage<CreateAccountRequest>;
|
|
85
|
+
|
|
86
|
+
/**
|
|
87
|
+
* The account created.
|
|
88
|
+
*
|
|
89
|
+
* @generated from message novatrail.api.v1.CreateAccountResponse
|
|
90
|
+
*/
|
|
91
|
+
export declare type CreateAccountResponse = Message<"novatrail.api.v1.CreateAccountResponse"> & {
|
|
92
|
+
/**
|
|
93
|
+
* The account, with no profile.
|
|
94
|
+
*
|
|
95
|
+
* @generated from field: novatrail.api.v1.Account account = 1;
|
|
96
|
+
*/
|
|
97
|
+
account?: Account | undefined;
|
|
98
|
+
};
|
|
99
|
+
|
|
100
|
+
/**
|
|
101
|
+
* Describes the message novatrail.api.v1.CreateAccountResponse.
|
|
102
|
+
* Use `create(CreateAccountResponseSchema)` to create a new message.
|
|
103
|
+
*/
|
|
104
|
+
export declare const CreateAccountResponseSchema: GenMessage<CreateAccountResponse>;
|
|
105
|
+
|
|
106
|
+
/**
|
|
107
|
+
* An account of `api`, by the token of its user.
|
|
108
|
+
*
|
|
109
|
+
* @generated from message novatrail.api.v1.Account
|
|
110
|
+
*/
|
|
111
|
+
export declare type Account = Message<"novatrail.api.v1.Account"> & {
|
|
112
|
+
/**
|
|
113
|
+
* The ID of the account in `api`: not the user's ID at the sign-in service, which another way of
|
|
114
|
+
* signing in would change. The registry of the device holds it, and another ID after a sign-in
|
|
115
|
+
* is another account.
|
|
116
|
+
*
|
|
117
|
+
* @generated from field: string account_id = 1;
|
|
118
|
+
*/
|
|
119
|
+
accountId: string;
|
|
120
|
+
|
|
121
|
+
/**
|
|
122
|
+
* Whether the PIN of the section for adults is set.
|
|
123
|
+
*
|
|
124
|
+
* @generated from field: bool pin_set = 2;
|
|
125
|
+
*/
|
|
126
|
+
pinSet: boolean;
|
|
127
|
+
|
|
128
|
+
/**
|
|
129
|
+
* The account's profiles: the owner's, when the owner learns, and the children's.
|
|
130
|
+
*
|
|
131
|
+
* @generated from field: repeated novatrail.api.v1.Profile profiles = 3;
|
|
132
|
+
*/
|
|
133
|
+
profiles: Profile[];
|
|
134
|
+
|
|
135
|
+
/**
|
|
136
|
+
* The consents for a child that have no profile yet: waiting, or confirmed and waiting for the
|
|
137
|
+
* profile.
|
|
138
|
+
*
|
|
139
|
+
* @generated from field: repeated novatrail.api.v1.ChildConsent child_consents = 4;
|
|
140
|
+
*/
|
|
141
|
+
childConsents: ChildConsent[];
|
|
142
|
+
};
|
|
143
|
+
|
|
144
|
+
/**
|
|
145
|
+
* Describes the message novatrail.api.v1.Account.
|
|
146
|
+
* Use `create(AccountSchema)` to create a new message.
|
|
147
|
+
*/
|
|
148
|
+
export declare const AccountSchema: GenMessage<Account>;
|
|
149
|
+
|
|
150
|
+
/**
|
|
151
|
+
* A profile, a learner in the account (concepts 13), as `api` keeps it, with its open attempt and
|
|
152
|
+
* its open lesson runs. Its date of the age given and its last activity stay in `api`; its
|
|
153
|
+
* interests come only once the module format gives a task a look by interests (concepts 13; R51).
|
|
154
|
+
*
|
|
155
|
+
* @generated from message novatrail.api.v1.Profile
|
|
156
|
+
*/
|
|
157
|
+
export declare type Profile = Message<"novatrail.api.v1.Profile"> & {
|
|
158
|
+
/**
|
|
159
|
+
* The ID of the profile.
|
|
160
|
+
*
|
|
161
|
+
* @generated from field: string profile_id = 1;
|
|
162
|
+
*/
|
|
163
|
+
profileId: string;
|
|
164
|
+
|
|
165
|
+
/**
|
|
166
|
+
* Whether this is the profile of the account's owner.
|
|
167
|
+
*
|
|
168
|
+
* @generated from field: bool owner = 2;
|
|
169
|
+
*/
|
|
170
|
+
owner: boolean;
|
|
171
|
+
|
|
172
|
+
/**
|
|
173
|
+
* The pseudonym the owner made up for the learner: never a real name.
|
|
174
|
+
*
|
|
175
|
+
* @generated from field: string pseudonym = 3;
|
|
176
|
+
*/
|
|
177
|
+
pseudonym: string;
|
|
178
|
+
|
|
179
|
+
/**
|
|
180
|
+
* The code of a picture of the set of `app`: no picture is uploaded. Empty when none was chosen;
|
|
181
|
+
* a code its build does not know `app` shows as its own picture.
|
|
182
|
+
*
|
|
183
|
+
* @generated from field: string avatar = 4;
|
|
184
|
+
*/
|
|
185
|
+
avatar: string;
|
|
186
|
+
|
|
187
|
+
/**
|
|
188
|
+
* The age category, by its code: "under_13", "from_13_to_consent", "from_consent_to_18" or
|
|
189
|
+
* "adult" (R46).
|
|
190
|
+
*
|
|
191
|
+
* @generated from field: string age_category = 5;
|
|
192
|
+
*/
|
|
193
|
+
ageCategory: string;
|
|
194
|
+
|
|
195
|
+
/**
|
|
196
|
+
* The learner's country, ISO 3166-1 alpha-2.
|
|
197
|
+
*
|
|
198
|
+
* @generated from field: string country = 6;
|
|
199
|
+
*/
|
|
200
|
+
country: string;
|
|
201
|
+
|
|
202
|
+
/**
|
|
203
|
+
* How the platform speaks and shows: what of it changes the words goes to AI, and nothing else.
|
|
204
|
+
*
|
|
205
|
+
* @generated from field: novatrail.api.v1.PresentationStyle presentation_style = 7;
|
|
206
|
+
*/
|
|
207
|
+
presentationStyle?: PresentationStyle | undefined;
|
|
208
|
+
|
|
209
|
+
/**
|
|
210
|
+
* The default mode, which the learner switches on the screen of a task until the end of the
|
|
211
|
+
* attempt. It goes to no AI.
|
|
212
|
+
*
|
|
213
|
+
* @generated from field: novatrail.api.v1.Mode default_mode = 8;
|
|
214
|
+
*/
|
|
215
|
+
defaultMode: Mode;
|
|
216
|
+
|
|
217
|
+
/**
|
|
218
|
+
* The language of the interface, a tag of BCP 47: absent when none is set, and then `app` speaks
|
|
219
|
+
* the language of the device. It goes to no AI (R92).
|
|
220
|
+
*
|
|
221
|
+
* @generated from field: optional string interface_language = 9;
|
|
222
|
+
*/
|
|
223
|
+
interfaceLanguage?: string | undefined;
|
|
224
|
+
|
|
225
|
+
/**
|
|
226
|
+
* The grade, from 1 to 12, as a module with grades asks for it (R49): absent when none is given.
|
|
227
|
+
*
|
|
228
|
+
* @generated from field: optional int32 grade = 10;
|
|
229
|
+
*/
|
|
230
|
+
grade?: number | undefined;
|
|
231
|
+
|
|
232
|
+
/**
|
|
233
|
+
* A child's setting, which an adult sets: the solution is shown by an action of an adult.
|
|
234
|
+
* Always false on a profile of the category `adult`.
|
|
235
|
+
*
|
|
236
|
+
* @generated from field: bool ask_before_showing = 11;
|
|
237
|
+
*/
|
|
238
|
+
askBeforeShowing: boolean;
|
|
239
|
+
|
|
240
|
+
/**
|
|
241
|
+
* The profile's open attempt: absent when it has none. A profile has one open attempt at most.
|
|
242
|
+
*
|
|
243
|
+
* @generated from field: novatrail.api.v1.OpenAttemptRef open_attempt = 12;
|
|
244
|
+
*/
|
|
245
|
+
openAttempt?: OpenAttemptRef | undefined;
|
|
246
|
+
|
|
247
|
+
/**
|
|
248
|
+
* The profile's open lesson runs, one at most for each lesson.
|
|
249
|
+
*
|
|
250
|
+
* @generated from field: repeated novatrail.api.v1.LessonRunRef open_lesson_runs = 13;
|
|
251
|
+
*/
|
|
252
|
+
openLessonRuns: LessonRunRef[];
|
|
253
|
+
};
|
|
254
|
+
|
|
255
|
+
/**
|
|
256
|
+
* Describes the message novatrail.api.v1.Profile.
|
|
257
|
+
* Use `create(ProfileSchema)` to create a new message.
|
|
258
|
+
*/
|
|
259
|
+
export declare const ProfileSchema: GenMessage<Profile>;
|
|
260
|
+
|
|
261
|
+
/**
|
|
262
|
+
* The presentation style of a profile. What else it holds comes with what a module may say of it
|
|
263
|
+
* (product 13, О-23).
|
|
264
|
+
*
|
|
265
|
+
* @generated from message novatrail.api.v1.PresentationStyle
|
|
266
|
+
*/
|
|
267
|
+
export declare type PresentationStyle = Message<"novatrail.api.v1.PresentationStyle"> & {
|
|
268
|
+
/**
|
|
269
|
+
* The voicing: the tutor's words and the open texts of a module read aloud by the device. It
|
|
270
|
+
* goes to no AI.
|
|
271
|
+
*
|
|
272
|
+
* @generated from field: novatrail.api.v1.Voicing voicing = 1;
|
|
273
|
+
*/
|
|
274
|
+
voicing?: Voicing | undefined;
|
|
275
|
+
};
|
|
276
|
+
|
|
277
|
+
/**
|
|
278
|
+
* Describes the message novatrail.api.v1.PresentationStyle.
|
|
279
|
+
* Use `create(PresentationStyleSchema)` to create a new message.
|
|
280
|
+
*/
|
|
281
|
+
export declare const PresentationStyleSchema: GenMessage<PresentationStyle>;
|
|
282
|
+
|
|
283
|
+
/**
|
|
284
|
+
* The voicing of a profile. The voice is chosen on the device, and the contract carries none.
|
|
285
|
+
*
|
|
286
|
+
* @generated from message novatrail.api.v1.Voicing
|
|
287
|
+
*/
|
|
288
|
+
export declare type Voicing = Message<"novatrail.api.v1.Voicing"> & {
|
|
289
|
+
/**
|
|
290
|
+
* Whether it is on. In a request, absent leaves it as it is, and a new profile's takes the
|
|
291
|
+
* default of its category.
|
|
292
|
+
*
|
|
293
|
+
* @generated from field: optional bool enabled = 1;
|
|
294
|
+
*/
|
|
295
|
+
enabled?: boolean | undefined;
|
|
296
|
+
|
|
297
|
+
/**
|
|
298
|
+
* Its speed. In a request, `VOICING_SPEED_UNSPECIFIED` leaves the speed as it is, and a new
|
|
299
|
+
* profile's is normal.
|
|
300
|
+
*
|
|
301
|
+
* @generated from field: novatrail.api.v1.VoicingSpeed speed = 2;
|
|
302
|
+
*/
|
|
303
|
+
speed: VoicingSpeed;
|
|
304
|
+
};
|
|
305
|
+
|
|
306
|
+
/**
|
|
307
|
+
* Describes the message novatrail.api.v1.Voicing.
|
|
308
|
+
* Use `create(VoicingSchema)` to create a new message.
|
|
309
|
+
*/
|
|
310
|
+
export declare const VoicingSchema: GenMessage<Voicing>;
|
|
311
|
+
|
|
312
|
+
/**
|
|
313
|
+
* The settings of a profile that an adult sets, when a profile is created or changed. A field sent
|
|
314
|
+
* is set; a field left out stays as it is, and on a new profile takes its default: the mode "by
|
|
315
|
+
* steps", the voicing on at the category `under_13` and off at the others, at normal speed, and on
|
|
316
|
+
* a child's profile "ask before showing" on. `app` sends only what changed, so it never writes back
|
|
317
|
+
* a value its build does not know. A field whose form the contract refuses gets the code
|
|
318
|
+
* `invalid_argument`.
|
|
319
|
+
*
|
|
320
|
+
* @generated from message novatrail.api.v1.ProfileSettings
|
|
321
|
+
*/
|
|
322
|
+
export declare type ProfileSettings = Message<"novatrail.api.v1.ProfileSettings"> & {
|
|
323
|
+
/**
|
|
324
|
+
* The pseudonym: from 1 to 30 Unicode code points once the spaces at its ends are trimmed.
|
|
325
|
+
* Needed when a profile is created.
|
|
326
|
+
*
|
|
327
|
+
* @generated from field: optional string pseudonym = 1;
|
|
328
|
+
*/
|
|
329
|
+
pseudonym?: string | undefined;
|
|
330
|
+
|
|
331
|
+
/**
|
|
332
|
+
* The code of a picture of the set of `app`, up to 64 ASCII characters; empty clears it.
|
|
333
|
+
*
|
|
334
|
+
* @generated from field: optional string avatar = 2;
|
|
335
|
+
*/
|
|
336
|
+
avatar?: string | undefined;
|
|
337
|
+
|
|
338
|
+
/**
|
|
339
|
+
* The voicing.
|
|
340
|
+
*
|
|
341
|
+
* @generated from field: novatrail.api.v1.Voicing voicing = 3;
|
|
342
|
+
*/
|
|
343
|
+
voicing?: Voicing | undefined;
|
|
344
|
+
|
|
345
|
+
/**
|
|
346
|
+
* The default mode: `MODE_UNSPECIFIED` leaves it as it is.
|
|
347
|
+
*
|
|
348
|
+
* @generated from field: novatrail.api.v1.Mode default_mode = 4;
|
|
349
|
+
*/
|
|
350
|
+
defaultMode: Mode;
|
|
351
|
+
|
|
352
|
+
/**
|
|
353
|
+
* The language of the interface, a well-formed tag of BCP 47, which `api` keeps with no list of
|
|
354
|
+
* its own (R92); empty clears it. On a new profile `app` sends the language of the section for
|
|
355
|
+
* adults.
|
|
356
|
+
*
|
|
357
|
+
* @generated from field: optional string interface_language = 5;
|
|
358
|
+
*/
|
|
359
|
+
interfaceLanguage?: string | undefined;
|
|
360
|
+
|
|
361
|
+
/**
|
|
362
|
+
* The grade, from 1 to 12; 0 clears it.
|
|
363
|
+
*
|
|
364
|
+
* @generated from field: optional int32 grade = 6;
|
|
365
|
+
*/
|
|
366
|
+
grade?: number | undefined;
|
|
367
|
+
|
|
368
|
+
/**
|
|
369
|
+
* "Ask before showing" the solution: a child's alone, and on a profile of the category `adult`
|
|
370
|
+
* the request is refused `invalid_argument`.
|
|
371
|
+
*
|
|
372
|
+
* @generated from field: optional bool ask_before_showing = 7;
|
|
373
|
+
*/
|
|
374
|
+
askBeforeShowing?: boolean | undefined;
|
|
375
|
+
};
|
|
376
|
+
|
|
377
|
+
/**
|
|
378
|
+
* Describes the message novatrail.api.v1.ProfileSettings.
|
|
379
|
+
* Use `create(ProfileSettingsSchema)` to create a new message.
|
|
380
|
+
*/
|
|
381
|
+
export declare const ProfileSettingsSchema: GenMessage<ProfileSettings>;
|
|
382
|
+
|
|
383
|
+
/**
|
|
384
|
+
* A consent for a child: what `api` records before the child's profile exists.
|
|
385
|
+
*
|
|
386
|
+
* @generated from message novatrail.api.v1.ChildConsent
|
|
387
|
+
*/
|
|
388
|
+
export declare type ChildConsent = Message<"novatrail.api.v1.ChildConsent"> & {
|
|
389
|
+
/**
|
|
390
|
+
* The ID of the consent, by which the child's profile is created.
|
|
391
|
+
*
|
|
392
|
+
* @generated from field: string consent_id = 1;
|
|
393
|
+
*/
|
|
394
|
+
consentId: string;
|
|
395
|
+
|
|
396
|
+
/**
|
|
397
|
+
* The age category that `api` worked out of the age and the country, by its code.
|
|
398
|
+
*
|
|
399
|
+
* @generated from field: string age_category = 2;
|
|
400
|
+
*/
|
|
401
|
+
ageCategory: string;
|
|
402
|
+
|
|
403
|
+
/**
|
|
404
|
+
* The child's country, ISO 3166-1 alpha-2.
|
|
405
|
+
*
|
|
406
|
+
* @generated from field: string country = 3;
|
|
407
|
+
*/
|
|
408
|
+
country: string;
|
|
409
|
+
|
|
410
|
+
/**
|
|
411
|
+
* Where the consent stands.
|
|
412
|
+
*
|
|
413
|
+
* @generated from field: novatrail.api.v1.ConsentState state = 4;
|
|
414
|
+
*/
|
|
415
|
+
state: ConsentState;
|
|
416
|
+
};
|
|
417
|
+
|
|
418
|
+
/**
|
|
419
|
+
* Describes the message novatrail.api.v1.ChildConsent.
|
|
420
|
+
* Use `create(ChildConsentSchema)` to create a new message.
|
|
421
|
+
*/
|
|
422
|
+
export declare const ChildConsentSchema: GenMessage<ChildConsent>;
|
|
423
|
+
|
|
424
|
+
/**
|
|
425
|
+
* The setting of the PIN.
|
|
426
|
+
*
|
|
427
|
+
* @generated from message novatrail.api.v1.SetPinRequest
|
|
428
|
+
*/
|
|
429
|
+
export declare type SetPinRequest = Message<"novatrail.api.v1.SetPinRequest"> & {
|
|
430
|
+
/**
|
|
431
|
+
* The PIN: from 4 to 6 digits.
|
|
432
|
+
*
|
|
433
|
+
* @generated from field: string pin = 1;
|
|
434
|
+
*/
|
|
435
|
+
pin: string;
|
|
436
|
+
|
|
437
|
+
/**
|
|
438
|
+
* The idempotency key of this action of the adult.
|
|
439
|
+
*
|
|
440
|
+
* @generated from field: string idempotency_key = 2;
|
|
441
|
+
*/
|
|
442
|
+
idempotencyKey: string;
|
|
443
|
+
};
|
|
444
|
+
|
|
445
|
+
/**
|
|
446
|
+
* Describes the message novatrail.api.v1.SetPinRequest.
|
|
447
|
+
* Use `create(SetPinRequestSchema)` to create a new message.
|
|
448
|
+
*/
|
|
449
|
+
export declare const SetPinRequestSchema: GenMessage<SetPinRequest>;
|
|
450
|
+
|
|
451
|
+
/**
|
|
452
|
+
* The PIN set.
|
|
453
|
+
*
|
|
454
|
+
* @generated from message novatrail.api.v1.SetPinResponse
|
|
455
|
+
*/
|
|
456
|
+
export declare type SetPinResponse = Message<"novatrail.api.v1.SetPinResponse"> & {
|
|
457
|
+
};
|
|
458
|
+
|
|
459
|
+
/**
|
|
460
|
+
* Describes the message novatrail.api.v1.SetPinResponse.
|
|
461
|
+
* Use `create(SetPinResponseSchema)` to create a new message.
|
|
462
|
+
*/
|
|
463
|
+
export declare const SetPinResponseSchema: GenMessage<SetPinResponse>;
|
|
464
|
+
|
|
465
|
+
/**
|
|
466
|
+
* A PIN to check.
|
|
467
|
+
*
|
|
468
|
+
* @generated from message novatrail.api.v1.VerifyPinRequest
|
|
469
|
+
*/
|
|
470
|
+
export declare type VerifyPinRequest = Message<"novatrail.api.v1.VerifyPinRequest"> & {
|
|
471
|
+
/**
|
|
472
|
+
* The PIN: from 4 to 6 digits.
|
|
473
|
+
*
|
|
474
|
+
* @generated from field: string pin = 1;
|
|
475
|
+
*/
|
|
476
|
+
pin: string;
|
|
477
|
+
|
|
478
|
+
/**
|
|
479
|
+
* The idempotency key of this action of the adult.
|
|
480
|
+
*
|
|
481
|
+
* @generated from field: string idempotency_key = 2;
|
|
482
|
+
*/
|
|
483
|
+
idempotencyKey: string;
|
|
484
|
+
};
|
|
485
|
+
|
|
486
|
+
/**
|
|
487
|
+
* Describes the message novatrail.api.v1.VerifyPinRequest.
|
|
488
|
+
* Use `create(VerifyPinRequestSchema)` to create a new message.
|
|
489
|
+
*/
|
|
490
|
+
export declare const VerifyPinRequestSchema: GenMessage<VerifyPinRequest>;
|
|
491
|
+
|
|
492
|
+
/**
|
|
493
|
+
* What a check of the PIN gave.
|
|
494
|
+
*
|
|
495
|
+
* @generated from message novatrail.api.v1.VerifyPinResponse
|
|
496
|
+
*/
|
|
497
|
+
export declare type VerifyPinResponse = Message<"novatrail.api.v1.VerifyPinResponse"> & {
|
|
498
|
+
/**
|
|
499
|
+
* The check.
|
|
500
|
+
*
|
|
501
|
+
* @generated from field: novatrail.api.v1.PinCheck check = 1;
|
|
502
|
+
*/
|
|
503
|
+
check?: PinCheck | undefined;
|
|
504
|
+
};
|
|
505
|
+
|
|
506
|
+
/**
|
|
507
|
+
* Describes the message novatrail.api.v1.VerifyPinResponse.
|
|
508
|
+
* Use `create(VerifyPinResponseSchema)` to create a new message.
|
|
509
|
+
*/
|
|
510
|
+
export declare const VerifyPinResponseSchema: GenMessage<VerifyPinResponse>;
|
|
511
|
+
|
|
512
|
+
/**
|
|
513
|
+
* The change of the PIN.
|
|
514
|
+
*
|
|
515
|
+
* @generated from message novatrail.api.v1.ChangePinRequest
|
|
516
|
+
*/
|
|
517
|
+
export declare type ChangePinRequest = Message<"novatrail.api.v1.ChangePinRequest"> & {
|
|
518
|
+
/**
|
|
519
|
+
* The PIN before it: from 4 to 6 digits.
|
|
520
|
+
*
|
|
521
|
+
* @generated from field: string pin = 1;
|
|
522
|
+
*/
|
|
523
|
+
pin: string;
|
|
524
|
+
|
|
525
|
+
/**
|
|
526
|
+
* The new PIN: from 4 to 6 digits.
|
|
527
|
+
*
|
|
528
|
+
* @generated from field: string new_pin = 2;
|
|
529
|
+
*/
|
|
530
|
+
newPin: string;
|
|
531
|
+
|
|
532
|
+
/**
|
|
533
|
+
* The idempotency key of this action of the adult.
|
|
534
|
+
*
|
|
535
|
+
* @generated from field: string idempotency_key = 3;
|
|
536
|
+
*/
|
|
537
|
+
idempotencyKey: string;
|
|
538
|
+
};
|
|
539
|
+
|
|
540
|
+
/**
|
|
541
|
+
* Describes the message novatrail.api.v1.ChangePinRequest.
|
|
542
|
+
* Use `create(ChangePinRequestSchema)` to create a new message.
|
|
543
|
+
*/
|
|
544
|
+
export declare const ChangePinRequestSchema: GenMessage<ChangePinRequest>;
|
|
545
|
+
|
|
546
|
+
/**
|
|
547
|
+
* What a change of the PIN gave.
|
|
548
|
+
*
|
|
549
|
+
* @generated from message novatrail.api.v1.ChangePinResponse
|
|
550
|
+
*/
|
|
551
|
+
export declare type ChangePinResponse = Message<"novatrail.api.v1.ChangePinResponse"> & {
|
|
552
|
+
/**
|
|
553
|
+
* The check of the PIN before it: the PIN is changed when it matches.
|
|
554
|
+
*
|
|
555
|
+
* @generated from field: novatrail.api.v1.PinCheck check = 1;
|
|
556
|
+
*/
|
|
557
|
+
check?: PinCheck | undefined;
|
|
558
|
+
};
|
|
559
|
+
|
|
560
|
+
/**
|
|
561
|
+
* Describes the message novatrail.api.v1.ChangePinResponse.
|
|
562
|
+
* Use `create(ChangePinResponseSchema)` to create a new message.
|
|
563
|
+
*/
|
|
564
|
+
export declare const ChangePinResponseSchema: GenMessage<ChangePinResponse>;
|
|
565
|
+
|
|
566
|
+
/**
|
|
567
|
+
* A check of a PIN, which `app` words in the language of its screen: what went wrong and what to
|
|
568
|
+
* do. The counter is the server's alone: one on the device would part from it.
|
|
569
|
+
*
|
|
570
|
+
* @generated from message novatrail.api.v1.PinCheck
|
|
571
|
+
*/
|
|
572
|
+
export declare type PinCheck = Message<"novatrail.api.v1.PinCheck"> & {
|
|
573
|
+
/**
|
|
574
|
+
* Whether the PIN matches the one set.
|
|
575
|
+
*
|
|
576
|
+
* @generated from field: bool matches = 1;
|
|
577
|
+
*/
|
|
578
|
+
matches: boolean;
|
|
579
|
+
|
|
580
|
+
/**
|
|
581
|
+
* Beside a wrong PIN: how many wrong PINs are left before the input closes; 0 when this one
|
|
582
|
+
* closed it.
|
|
583
|
+
*
|
|
584
|
+
* @generated from field: int32 attempts_left = 2;
|
|
585
|
+
*/
|
|
586
|
+
attemptsLeft: number;
|
|
587
|
+
|
|
588
|
+
/**
|
|
589
|
+
* Beside a wrong PIN that closed the input: when it opens.
|
|
590
|
+
*
|
|
591
|
+
* @generated from field: google.protobuf.Timestamp locked_until = 3;
|
|
592
|
+
*/
|
|
593
|
+
lockedUntil?: Timestamp | undefined;
|
|
594
|
+
};
|
|
595
|
+
|
|
596
|
+
/**
|
|
597
|
+
* Describes the message novatrail.api.v1.PinCheck.
|
|
598
|
+
* Use `create(PinCheckSchema)` to create a new message.
|
|
599
|
+
*/
|
|
600
|
+
export declare const PinCheckSchema: GenMessage<PinCheck>;
|
|
601
|
+
|
|
602
|
+
/**
|
|
603
|
+
* The change of a forgotten PIN.
|
|
604
|
+
*
|
|
605
|
+
* @generated from message novatrail.api.v1.ResetPinRequest
|
|
606
|
+
*/
|
|
607
|
+
export declare type ResetPinRequest = Message<"novatrail.api.v1.ResetPinRequest"> & {
|
|
608
|
+
/**
|
|
609
|
+
* The new PIN: from 4 to 6 digits.
|
|
610
|
+
*
|
|
611
|
+
* @generated from field: string new_pin = 1;
|
|
612
|
+
*/
|
|
613
|
+
newPin: string;
|
|
614
|
+
|
|
615
|
+
/**
|
|
616
|
+
* The idempotency key of this action of the adult.
|
|
617
|
+
*
|
|
618
|
+
* @generated from field: string idempotency_key = 2;
|
|
619
|
+
*/
|
|
620
|
+
idempotencyKey: string;
|
|
621
|
+
};
|
|
622
|
+
|
|
623
|
+
/**
|
|
624
|
+
* Describes the message novatrail.api.v1.ResetPinRequest.
|
|
625
|
+
* Use `create(ResetPinRequestSchema)` to create a new message.
|
|
626
|
+
*/
|
|
627
|
+
export declare const ResetPinRequestSchema: GenMessage<ResetPinRequest>;
|
|
628
|
+
|
|
629
|
+
/**
|
|
630
|
+
* The new PIN set.
|
|
631
|
+
*
|
|
632
|
+
* @generated from message novatrail.api.v1.ResetPinResponse
|
|
633
|
+
*/
|
|
634
|
+
export declare type ResetPinResponse = Message<"novatrail.api.v1.ResetPinResponse"> & {
|
|
635
|
+
};
|
|
636
|
+
|
|
637
|
+
/**
|
|
638
|
+
* Describes the message novatrail.api.v1.ResetPinResponse.
|
|
639
|
+
* Use `create(ResetPinResponseSchema)` to create a new message.
|
|
640
|
+
*/
|
|
641
|
+
export declare const ResetPinResponseSchema: GenMessage<ResetPinResponse>;
|
|
642
|
+
|
|
643
|
+
/**
|
|
644
|
+
* The creation of the owner's profile.
|
|
645
|
+
*
|
|
646
|
+
* @generated from message novatrail.api.v1.CreateOwnerProfileRequest
|
|
647
|
+
*/
|
|
648
|
+
export declare type CreateOwnerProfileRequest = Message<"novatrail.api.v1.CreateOwnerProfileRequest"> & {
|
|
649
|
+
/**
|
|
650
|
+
* The owner's country, ISO 3166-1 alpha-2.
|
|
651
|
+
*
|
|
652
|
+
* @generated from field: string country = 1;
|
|
653
|
+
*/
|
|
654
|
+
country: string;
|
|
655
|
+
|
|
656
|
+
/**
|
|
657
|
+
* The settings of the profile: the pseudonym at least.
|
|
658
|
+
*
|
|
659
|
+
* @generated from field: novatrail.api.v1.ProfileSettings settings = 2;
|
|
660
|
+
*/
|
|
661
|
+
settings?: ProfileSettings | undefined;
|
|
662
|
+
};
|
|
663
|
+
|
|
664
|
+
/**
|
|
665
|
+
* Describes the message novatrail.api.v1.CreateOwnerProfileRequest.
|
|
666
|
+
* Use `create(CreateOwnerProfileRequestSchema)` to create a new message.
|
|
667
|
+
*/
|
|
668
|
+
export declare const CreateOwnerProfileRequestSchema: GenMessage<CreateOwnerProfileRequest>;
|
|
669
|
+
|
|
670
|
+
/**
|
|
671
|
+
* The owner's profile created.
|
|
672
|
+
*
|
|
673
|
+
* @generated from message novatrail.api.v1.CreateOwnerProfileResponse
|
|
674
|
+
*/
|
|
675
|
+
export declare type CreateOwnerProfileResponse = Message<"novatrail.api.v1.CreateOwnerProfileResponse"> & {
|
|
676
|
+
/**
|
|
677
|
+
* The profile.
|
|
678
|
+
*
|
|
679
|
+
* @generated from field: novatrail.api.v1.Profile profile = 1;
|
|
680
|
+
*/
|
|
681
|
+
profile?: Profile | undefined;
|
|
682
|
+
};
|
|
683
|
+
|
|
684
|
+
/**
|
|
685
|
+
* Describes the message novatrail.api.v1.CreateOwnerProfileResponse.
|
|
686
|
+
* Use `create(CreateOwnerProfileResponseSchema)` to create a new message.
|
|
687
|
+
*/
|
|
688
|
+
export declare const CreateOwnerProfileResponseSchema: GenMessage<CreateOwnerProfileResponse>;
|
|
689
|
+
|
|
690
|
+
/**
|
|
691
|
+
* The first step of a child's profile: the consent asked for.
|
|
692
|
+
*
|
|
693
|
+
* @generated from message novatrail.api.v1.RequestChildConsentRequest
|
|
694
|
+
*/
|
|
695
|
+
export declare type RequestChildConsentRequest = Message<"novatrail.api.v1.RequestChildConsentRequest"> & {
|
|
696
|
+
/**
|
|
697
|
+
* The idempotency key of this action of the owner.
|
|
698
|
+
*
|
|
699
|
+
* @generated from field: string idempotency_key = 1;
|
|
700
|
+
*/
|
|
701
|
+
idempotencyKey: string;
|
|
702
|
+
|
|
703
|
+
/**
|
|
704
|
+
* The child's age in years, from 0 to 17, which `api` keeps nowhere: a learner of 18 or older is
|
|
705
|
+
* the owner of an account of their own. Needed: absent, the request is refused
|
|
706
|
+
* `invalid_argument`.
|
|
707
|
+
*
|
|
708
|
+
* @generated from field: optional int32 age_years = 2;
|
|
709
|
+
*/
|
|
710
|
+
ageYears?: number | undefined;
|
|
711
|
+
|
|
712
|
+
/**
|
|
713
|
+
* The child's country, ISO 3166-1 alpha-2.
|
|
714
|
+
*
|
|
715
|
+
* @generated from field: string country = 3;
|
|
716
|
+
*/
|
|
717
|
+
country: string;
|
|
718
|
+
};
|
|
719
|
+
|
|
720
|
+
/**
|
|
721
|
+
* Describes the message novatrail.api.v1.RequestChildConsentRequest.
|
|
722
|
+
* Use `create(RequestChildConsentRequestSchema)` to create a new message.
|
|
723
|
+
*/
|
|
724
|
+
export declare const RequestChildConsentRequestSchema: GenMessage<RequestChildConsentRequest>;
|
|
725
|
+
|
|
726
|
+
/**
|
|
727
|
+
* The consent recorded.
|
|
728
|
+
*
|
|
729
|
+
* @generated from message novatrail.api.v1.RequestChildConsentResponse
|
|
730
|
+
*/
|
|
731
|
+
export declare type RequestChildConsentResponse = Message<"novatrail.api.v1.RequestChildConsentResponse"> & {
|
|
732
|
+
/**
|
|
733
|
+
* The consent, which waits.
|
|
734
|
+
*
|
|
735
|
+
* @generated from field: novatrail.api.v1.ChildConsent consent = 1;
|
|
736
|
+
*/
|
|
737
|
+
consent?: ChildConsent | undefined;
|
|
738
|
+
};
|
|
739
|
+
|
|
740
|
+
/**
|
|
741
|
+
* Describes the message novatrail.api.v1.RequestChildConsentResponse.
|
|
742
|
+
* Use `create(RequestChildConsentResponseSchema)` to create a new message.
|
|
743
|
+
*/
|
|
744
|
+
export declare const RequestChildConsentResponseSchema: GenMessage<RequestChildConsentResponse>;
|
|
745
|
+
|
|
746
|
+
/**
|
|
747
|
+
* The second step: a child's profile created by its consent.
|
|
748
|
+
*
|
|
749
|
+
* @generated from message novatrail.api.v1.CreateChildProfileRequest
|
|
750
|
+
*/
|
|
751
|
+
export declare type CreateChildProfileRequest = Message<"novatrail.api.v1.CreateChildProfileRequest"> & {
|
|
752
|
+
/**
|
|
753
|
+
* The consent, confirmed.
|
|
754
|
+
*
|
|
755
|
+
* @generated from field: string consent_id = 1;
|
|
756
|
+
*/
|
|
757
|
+
consentId: string;
|
|
758
|
+
|
|
759
|
+
/**
|
|
760
|
+
* The settings of the profile: the pseudonym at least.
|
|
761
|
+
*
|
|
762
|
+
* @generated from field: novatrail.api.v1.ProfileSettings settings = 2;
|
|
763
|
+
*/
|
|
764
|
+
settings?: ProfileSettings | undefined;
|
|
765
|
+
};
|
|
766
|
+
|
|
767
|
+
/**
|
|
768
|
+
* Describes the message novatrail.api.v1.CreateChildProfileRequest.
|
|
769
|
+
* Use `create(CreateChildProfileRequestSchema)` to create a new message.
|
|
770
|
+
*/
|
|
771
|
+
export declare const CreateChildProfileRequestSchema: GenMessage<CreateChildProfileRequest>;
|
|
772
|
+
|
|
773
|
+
/**
|
|
774
|
+
* The child's profile created.
|
|
775
|
+
*
|
|
776
|
+
* @generated from message novatrail.api.v1.CreateChildProfileResponse
|
|
777
|
+
*/
|
|
778
|
+
export declare type CreateChildProfileResponse = Message<"novatrail.api.v1.CreateChildProfileResponse"> & {
|
|
779
|
+
/**
|
|
780
|
+
* The profile, of the consent's age category and country.
|
|
781
|
+
*
|
|
782
|
+
* @generated from field: novatrail.api.v1.Profile profile = 1;
|
|
783
|
+
*/
|
|
784
|
+
profile?: Profile | undefined;
|
|
785
|
+
};
|
|
786
|
+
|
|
787
|
+
/**
|
|
788
|
+
* Describes the message novatrail.api.v1.CreateChildProfileResponse.
|
|
789
|
+
* Use `create(CreateChildProfileResponseSchema)` to create a new message.
|
|
790
|
+
*/
|
|
791
|
+
export declare const CreateChildProfileResponseSchema: GenMessage<CreateChildProfileResponse>;
|
|
792
|
+
|
|
793
|
+
/**
|
|
794
|
+
* A change of a profile's settings.
|
|
795
|
+
*
|
|
796
|
+
* @generated from message novatrail.api.v1.UpdateProfileRequest
|
|
797
|
+
*/
|
|
798
|
+
export declare type UpdateProfileRequest = Message<"novatrail.api.v1.UpdateProfileRequest"> & {
|
|
799
|
+
/**
|
|
800
|
+
* The profile.
|
|
801
|
+
*
|
|
802
|
+
* @generated from field: string profile_id = 1;
|
|
803
|
+
*/
|
|
804
|
+
profileId: string;
|
|
805
|
+
|
|
806
|
+
/**
|
|
807
|
+
* The settings that change.
|
|
808
|
+
*
|
|
809
|
+
* @generated from field: novatrail.api.v1.ProfileSettings settings = 2;
|
|
810
|
+
*/
|
|
811
|
+
settings?: ProfileSettings | undefined;
|
|
812
|
+
};
|
|
813
|
+
|
|
814
|
+
/**
|
|
815
|
+
* Describes the message novatrail.api.v1.UpdateProfileRequest.
|
|
816
|
+
* Use `create(UpdateProfileRequestSchema)` to create a new message.
|
|
817
|
+
*/
|
|
818
|
+
export declare const UpdateProfileRequestSchema: GenMessage<UpdateProfileRequest>;
|
|
819
|
+
|
|
820
|
+
/**
|
|
821
|
+
* The profile changed.
|
|
822
|
+
*
|
|
823
|
+
* @generated from message novatrail.api.v1.UpdateProfileResponse
|
|
824
|
+
*/
|
|
825
|
+
export declare type UpdateProfileResponse = Message<"novatrail.api.v1.UpdateProfileResponse"> & {
|
|
826
|
+
/**
|
|
827
|
+
* The profile.
|
|
828
|
+
*
|
|
829
|
+
* @generated from field: novatrail.api.v1.Profile profile = 1;
|
|
830
|
+
*/
|
|
831
|
+
profile?: Profile | undefined;
|
|
832
|
+
};
|
|
833
|
+
|
|
834
|
+
/**
|
|
835
|
+
* Describes the message novatrail.api.v1.UpdateProfileResponse.
|
|
836
|
+
* Use `create(UpdateProfileResponseSchema)` to create a new message.
|
|
837
|
+
*/
|
|
838
|
+
export declare const UpdateProfileResponseSchema: GenMessage<UpdateProfileResponse>;
|
|
839
|
+
|
|
840
|
+
/**
|
|
841
|
+
* The voicing set from the screen of a task.
|
|
842
|
+
*
|
|
843
|
+
* @generated from message novatrail.api.v1.SetVoicingRequest
|
|
844
|
+
*/
|
|
845
|
+
export declare type SetVoicingRequest = Message<"novatrail.api.v1.SetVoicingRequest"> & {
|
|
846
|
+
/**
|
|
847
|
+
* The profile.
|
|
848
|
+
*
|
|
849
|
+
* @generated from field: string profile_id = 1;
|
|
850
|
+
*/
|
|
851
|
+
profileId: string;
|
|
852
|
+
|
|
853
|
+
/**
|
|
854
|
+
* The voicing.
|
|
855
|
+
*
|
|
856
|
+
* @generated from field: novatrail.api.v1.Voicing voicing = 2;
|
|
857
|
+
*/
|
|
858
|
+
voicing?: Voicing | undefined;
|
|
859
|
+
};
|
|
860
|
+
|
|
861
|
+
/**
|
|
862
|
+
* Describes the message novatrail.api.v1.SetVoicingRequest.
|
|
863
|
+
* Use `create(SetVoicingRequestSchema)` to create a new message.
|
|
864
|
+
*/
|
|
865
|
+
export declare const SetVoicingRequestSchema: GenMessage<SetVoicingRequest>;
|
|
866
|
+
|
|
867
|
+
/**
|
|
868
|
+
* The profile with its voicing.
|
|
869
|
+
*
|
|
870
|
+
* @generated from message novatrail.api.v1.SetVoicingResponse
|
|
871
|
+
*/
|
|
872
|
+
export declare type SetVoicingResponse = Message<"novatrail.api.v1.SetVoicingResponse"> & {
|
|
873
|
+
/**
|
|
874
|
+
* The profile.
|
|
875
|
+
*
|
|
876
|
+
* @generated from field: novatrail.api.v1.Profile profile = 1;
|
|
877
|
+
*/
|
|
878
|
+
profile?: Profile | undefined;
|
|
879
|
+
};
|
|
880
|
+
|
|
881
|
+
/**
|
|
882
|
+
* Describes the message novatrail.api.v1.SetVoicingResponse.
|
|
883
|
+
* Use `create(SetVoicingResponseSchema)` to create a new message.
|
|
884
|
+
*/
|
|
885
|
+
export declare const SetVoicingResponseSchema: GenMessage<SetVoicingResponse>;
|
|
886
|
+
|
|
887
|
+
/**
|
|
888
|
+
* The deletion of a profile.
|
|
889
|
+
*
|
|
890
|
+
* @generated from message novatrail.api.v1.DeleteProfileRequest
|
|
891
|
+
*/
|
|
892
|
+
export declare type DeleteProfileRequest = Message<"novatrail.api.v1.DeleteProfileRequest"> & {
|
|
893
|
+
/**
|
|
894
|
+
* The profile.
|
|
895
|
+
*
|
|
896
|
+
* @generated from field: string profile_id = 1;
|
|
897
|
+
*/
|
|
898
|
+
profileId: string;
|
|
899
|
+
};
|
|
900
|
+
|
|
901
|
+
/**
|
|
902
|
+
* Describes the message novatrail.api.v1.DeleteProfileRequest.
|
|
903
|
+
* Use `create(DeleteProfileRequestSchema)` to create a new message.
|
|
904
|
+
*/
|
|
905
|
+
export declare const DeleteProfileRequestSchema: GenMessage<DeleteProfileRequest>;
|
|
906
|
+
|
|
907
|
+
/**
|
|
908
|
+
* "Deleted": the profile and everything of it are gone.
|
|
909
|
+
*
|
|
910
|
+
* @generated from message novatrail.api.v1.DeleteProfileResponse
|
|
911
|
+
*/
|
|
912
|
+
export declare type DeleteProfileResponse = Message<"novatrail.api.v1.DeleteProfileResponse"> & {
|
|
913
|
+
};
|
|
914
|
+
|
|
915
|
+
/**
|
|
916
|
+
* Describes the message novatrail.api.v1.DeleteProfileResponse.
|
|
917
|
+
* Use `create(DeleteProfileResponseSchema)` to create a new message.
|
|
918
|
+
*/
|
|
919
|
+
export declare const DeleteProfileResponseSchema: GenMessage<DeleteProfileResponse>;
|
|
920
|
+
|
|
921
|
+
/**
|
|
922
|
+
* The deletion of the account: the account is the token's.
|
|
923
|
+
*
|
|
924
|
+
* @generated from message novatrail.api.v1.DeleteAccountRequest
|
|
925
|
+
*/
|
|
926
|
+
export declare type DeleteAccountRequest = Message<"novatrail.api.v1.DeleteAccountRequest"> & {
|
|
927
|
+
};
|
|
928
|
+
|
|
929
|
+
/**
|
|
930
|
+
* Describes the message novatrail.api.v1.DeleteAccountRequest.
|
|
931
|
+
* Use `create(DeleteAccountRequestSchema)` to create a new message.
|
|
932
|
+
*/
|
|
933
|
+
export declare const DeleteAccountRequestSchema: GenMessage<DeleteAccountRequest>;
|
|
934
|
+
|
|
935
|
+
/**
|
|
936
|
+
* "Deleted": the account is gone, and what its deletion has still to do `api` finishes itself.
|
|
937
|
+
*
|
|
938
|
+
* @generated from message novatrail.api.v1.DeleteAccountResponse
|
|
939
|
+
*/
|
|
940
|
+
export declare type DeleteAccountResponse = Message<"novatrail.api.v1.DeleteAccountResponse"> & {
|
|
941
|
+
};
|
|
942
|
+
|
|
943
|
+
/**
|
|
944
|
+
* Describes the message novatrail.api.v1.DeleteAccountResponse.
|
|
945
|
+
* Use `create(DeleteAccountResponseSchema)` to create a new message.
|
|
946
|
+
*/
|
|
947
|
+
export declare const DeleteAccountResponseSchema: GenMessage<DeleteAccountResponse>;
|
|
948
|
+
|
|
949
|
+
/**
|
|
950
|
+
* A request for a profile's part of the export.
|
|
951
|
+
*
|
|
952
|
+
* @generated from message novatrail.api.v1.ExportProfileRequest
|
|
953
|
+
*/
|
|
954
|
+
export declare type ExportProfileRequest = Message<"novatrail.api.v1.ExportProfileRequest"> & {
|
|
955
|
+
/**
|
|
956
|
+
* The profile.
|
|
957
|
+
*
|
|
958
|
+
* @generated from field: string profile_id = 1;
|
|
959
|
+
*/
|
|
960
|
+
profileId: string;
|
|
961
|
+
};
|
|
962
|
+
|
|
963
|
+
/**
|
|
964
|
+
* Describes the message novatrail.api.v1.ExportProfileRequest.
|
|
965
|
+
* Use `create(ExportProfileRequestSchema)` to create a new message.
|
|
966
|
+
*/
|
|
967
|
+
export declare const ExportProfileRequestSchema: GenMessage<ExportProfileRequest>;
|
|
968
|
+
|
|
969
|
+
/**
|
|
970
|
+
* The part of a profile's export that `api` holds.
|
|
971
|
+
*
|
|
972
|
+
* @generated from message novatrail.api.v1.ExportProfileResponse
|
|
973
|
+
*/
|
|
974
|
+
export declare type ExportProfileResponse = Message<"novatrail.api.v1.ExportProfileResponse"> & {
|
|
975
|
+
/**
|
|
976
|
+
* The part, in the export format, which `app` puts into the file of the export as it is, without
|
|
977
|
+
* reading it. The format is open and `spec`'s, epic E4 of RUN.md (R09).
|
|
978
|
+
*
|
|
979
|
+
* @generated from field: bytes part = 1;
|
|
980
|
+
*/
|
|
981
|
+
part: Uint8Array;
|
|
982
|
+
|
|
983
|
+
/**
|
|
984
|
+
* The version of the export format the part is written in.
|
|
985
|
+
*
|
|
986
|
+
* @generated from field: string export_format_version = 2;
|
|
987
|
+
*/
|
|
988
|
+
exportFormatVersion: string;
|
|
989
|
+
};
|
|
990
|
+
|
|
991
|
+
/**
|
|
992
|
+
* Describes the message novatrail.api.v1.ExportProfileResponse.
|
|
993
|
+
* Use `create(ExportProfileResponseSchema)` to create a new message.
|
|
994
|
+
*/
|
|
995
|
+
export declare const ExportProfileResponseSchema: GenMessage<ExportProfileResponse>;
|
|
996
|
+
|
|
997
|
+
/**
|
|
998
|
+
* A request for the account's part of the export: the account is the token's.
|
|
999
|
+
*
|
|
1000
|
+
* @generated from message novatrail.api.v1.ExportAccountRequest
|
|
1001
|
+
*/
|
|
1002
|
+
export declare type ExportAccountRequest = Message<"novatrail.api.v1.ExportAccountRequest"> & {
|
|
1003
|
+
};
|
|
1004
|
+
|
|
1005
|
+
/**
|
|
1006
|
+
* Describes the message novatrail.api.v1.ExportAccountRequest.
|
|
1007
|
+
* Use `create(ExportAccountRequestSchema)` to create a new message.
|
|
1008
|
+
*/
|
|
1009
|
+
export declare const ExportAccountRequestSchema: GenMessage<ExportAccountRequest>;
|
|
1010
|
+
|
|
1011
|
+
/**
|
|
1012
|
+
* The part of the account's export that `api` holds.
|
|
1013
|
+
*
|
|
1014
|
+
* @generated from message novatrail.api.v1.ExportAccountResponse
|
|
1015
|
+
*/
|
|
1016
|
+
export declare type ExportAccountResponse = Message<"novatrail.api.v1.ExportAccountResponse"> & {
|
|
1017
|
+
/**
|
|
1018
|
+
* The part, in the export format, which `app` puts into the file of the export as it is, without
|
|
1019
|
+
* reading it. The format is open and `spec`'s, epic E4 of RUN.md (R09).
|
|
1020
|
+
*
|
|
1021
|
+
* @generated from field: bytes part = 1;
|
|
1022
|
+
*/
|
|
1023
|
+
part: Uint8Array;
|
|
1024
|
+
|
|
1025
|
+
/**
|
|
1026
|
+
* The version of the export format the part is written in.
|
|
1027
|
+
*
|
|
1028
|
+
* @generated from field: string export_format_version = 2;
|
|
1029
|
+
*/
|
|
1030
|
+
exportFormatVersion: string;
|
|
1031
|
+
};
|
|
1032
|
+
|
|
1033
|
+
/**
|
|
1034
|
+
* Describes the message novatrail.api.v1.ExportAccountResponse.
|
|
1035
|
+
* Use `create(ExportAccountResponseSchema)` to create a new message.
|
|
1036
|
+
*/
|
|
1037
|
+
export declare const ExportAccountResponseSchema: GenMessage<ExportAccountResponse>;
|
|
1038
|
+
|
|
1039
|
+
/**
|
|
1040
|
+
* The check of an own key, when it is connected.
|
|
1041
|
+
*
|
|
1042
|
+
* @generated from message novatrail.api.v1.CheckOwnKeyRequest
|
|
1043
|
+
*/
|
|
1044
|
+
export declare type CheckOwnKeyRequest = Message<"novatrail.api.v1.CheckOwnKeyRequest"> & {
|
|
1045
|
+
/**
|
|
1046
|
+
* The owner's profile, of the category `adult`.
|
|
1047
|
+
*
|
|
1048
|
+
* @generated from field: string profile_id = 1;
|
|
1049
|
+
*/
|
|
1050
|
+
profileId: string;
|
|
1051
|
+
|
|
1052
|
+
/**
|
|
1053
|
+
* The key and its provider.
|
|
1054
|
+
*
|
|
1055
|
+
* @generated from field: novatrail.api.v1.OwnKey own_key = 2;
|
|
1056
|
+
*/
|
|
1057
|
+
ownKey?: OwnKey | undefined;
|
|
1058
|
+
};
|
|
1059
|
+
|
|
1060
|
+
/**
|
|
1061
|
+
* Describes the message novatrail.api.v1.CheckOwnKeyRequest.
|
|
1062
|
+
* Use `create(CheckOwnKeyRequestSchema)` to create a new message.
|
|
1063
|
+
*/
|
|
1064
|
+
export declare const CheckOwnKeyRequestSchema: GenMessage<CheckOwnKeyRequest>;
|
|
1065
|
+
|
|
1066
|
+
/**
|
|
1067
|
+
* What the check of an own key gave.
|
|
1068
|
+
*
|
|
1069
|
+
* @generated from message novatrail.api.v1.CheckOwnKeyResponse
|
|
1070
|
+
*/
|
|
1071
|
+
export declare type CheckOwnKeyResponse = Message<"novatrail.api.v1.CheckOwnKeyResponse"> & {
|
|
1072
|
+
/**
|
|
1073
|
+
* What the provider said of the key, or that the provider is closed to it at the profile:
|
|
1074
|
+
* `OWN_KEY_CHECK_UNSPECIFIED` when the provider gave no answer.
|
|
1075
|
+
*
|
|
1076
|
+
* @generated from field: novatrail.api.v1.OwnKeyCheck check = 1;
|
|
1077
|
+
*/
|
|
1078
|
+
check: OwnKeyCheck;
|
|
1079
|
+
|
|
1080
|
+
/**
|
|
1081
|
+
* Beside `OWN_KEY_CHECK_UNSPECIFIED`: `CAUSE_AI_FAILURE`, the provider gave no answer.
|
|
1082
|
+
*
|
|
1083
|
+
* @generated from field: novatrail.api.v1.Outcome outcome = 2;
|
|
1084
|
+
*/
|
|
1085
|
+
outcome?: Outcome | undefined;
|
|
1086
|
+
};
|
|
1087
|
+
|
|
1088
|
+
/**
|
|
1089
|
+
* Describes the message novatrail.api.v1.CheckOwnKeyResponse.
|
|
1090
|
+
* Use `create(CheckOwnKeyResponseSchema)` to create a new message.
|
|
1091
|
+
*/
|
|
1092
|
+
export declare const CheckOwnKeyResponseSchema: GenMessage<CheckOwnKeyResponse>;
|
|
1093
|
+
|
|
1094
|
+
/**
|
|
1095
|
+
* A request for the providers of an own key.
|
|
1096
|
+
*
|
|
1097
|
+
* @generated from message novatrail.api.v1.ListOwnKeyProvidersRequest
|
|
1098
|
+
*/
|
|
1099
|
+
export declare type ListOwnKeyProvidersRequest = Message<"novatrail.api.v1.ListOwnKeyProvidersRequest"> & {
|
|
1100
|
+
/**
|
|
1101
|
+
* The profile.
|
|
1102
|
+
*
|
|
1103
|
+
* @generated from field: string profile_id = 1;
|
|
1104
|
+
*/
|
|
1105
|
+
profileId: string;
|
|
1106
|
+
};
|
|
1107
|
+
|
|
1108
|
+
/**
|
|
1109
|
+
* Describes the message novatrail.api.v1.ListOwnKeyProvidersRequest.
|
|
1110
|
+
* Use `create(ListOwnKeyProvidersRequestSchema)` to create a new message.
|
|
1111
|
+
*/
|
|
1112
|
+
export declare const ListOwnKeyProvidersRequestSchema: GenMessage<ListOwnKeyProvidersRequest>;
|
|
1113
|
+
|
|
1114
|
+
/**
|
|
1115
|
+
* The providers of an own key at a profile.
|
|
1116
|
+
*
|
|
1117
|
+
* @generated from message novatrail.api.v1.ListOwnKeyProvidersResponse
|
|
1118
|
+
*/
|
|
1119
|
+
export declare type ListOwnKeyProvidersResponse = Message<"novatrail.api.v1.ListOwnKeyProvidersResponse"> & {
|
|
1120
|
+
/**
|
|
1121
|
+
* The providers open to an own key, in the order of the admission table.
|
|
1122
|
+
*
|
|
1123
|
+
* @generated from field: repeated novatrail.api.v1.OwnKeyProvider providers = 1;
|
|
1124
|
+
*/
|
|
1125
|
+
providers: OwnKeyProvider[];
|
|
1126
|
+
};
|
|
1127
|
+
|
|
1128
|
+
/**
|
|
1129
|
+
* Describes the message novatrail.api.v1.ListOwnKeyProvidersResponse.
|
|
1130
|
+
* Use `create(ListOwnKeyProvidersResponseSchema)` to create a new message.
|
|
1131
|
+
*/
|
|
1132
|
+
export declare const ListOwnKeyProvidersResponseSchema: GenMessage<ListOwnKeyProvidersResponse>;
|
|
1133
|
+
|
|
1134
|
+
/**
|
|
1135
|
+
* An AI provider open to an own key.
|
|
1136
|
+
*
|
|
1137
|
+
* @generated from message novatrail.api.v1.OwnKeyProvider
|
|
1138
|
+
*/
|
|
1139
|
+
export declare type OwnKeyProvider = Message<"novatrail.api.v1.OwnKeyProvider"> & {
|
|
1140
|
+
/**
|
|
1141
|
+
* The provider's code in the admission table: "openai", "anthropic".
|
|
1142
|
+
*
|
|
1143
|
+
* @generated from field: string provider = 1;
|
|
1144
|
+
*/
|
|
1145
|
+
provider: string;
|
|
1146
|
+
|
|
1147
|
+
/**
|
|
1148
|
+
* The provider's name in the admission table, which `app` shows as it is.
|
|
1149
|
+
*
|
|
1150
|
+
* @generated from field: string name = 2;
|
|
1151
|
+
*/
|
|
1152
|
+
name: string;
|
|
1153
|
+
};
|
|
1154
|
+
|
|
1155
|
+
/**
|
|
1156
|
+
* Describes the message novatrail.api.v1.OwnKeyProvider.
|
|
1157
|
+
* Use `create(OwnKeyProviderSchema)` to create a new message.
|
|
1158
|
+
*/
|
|
1159
|
+
export declare const OwnKeyProviderSchema: GenMessage<OwnKeyProvider>;
|
|
1160
|
+
|
|
1161
|
+
/**
|
|
1162
|
+
* The speed of the voicing. A speed its build does not know `app` reads as normal.
|
|
1163
|
+
*
|
|
1164
|
+
* @generated from enum novatrail.api.v1.VoicingSpeed
|
|
1165
|
+
*/
|
|
1166
|
+
export enum VoicingSpeed {
|
|
1167
|
+
/**
|
|
1168
|
+
* Not named: in a request, the speed stays as it is.
|
|
1169
|
+
*
|
|
1170
|
+
* @generated from enum value: VOICING_SPEED_UNSPECIFIED = 0;
|
|
1171
|
+
*/
|
|
1172
|
+
UNSPECIFIED = 0,
|
|
1173
|
+
|
|
1174
|
+
/**
|
|
1175
|
+
* Normal.
|
|
1176
|
+
*
|
|
1177
|
+
* @generated from enum value: VOICING_SPEED_NORMAL = 1;
|
|
1178
|
+
*/
|
|
1179
|
+
NORMAL = 1,
|
|
1180
|
+
|
|
1181
|
+
/**
|
|
1182
|
+
* Slow.
|
|
1183
|
+
*
|
|
1184
|
+
* @generated from enum value: VOICING_SPEED_SLOW = 2;
|
|
1185
|
+
*/
|
|
1186
|
+
SLOW = 2,
|
|
1187
|
+
}
|
|
1188
|
+
|
|
1189
|
+
/**
|
|
1190
|
+
* Describes the enum novatrail.api.v1.VoicingSpeed.
|
|
1191
|
+
*/
|
|
1192
|
+
export declare const VoicingSpeedSchema: GenEnum<VoicingSpeed>;
|
|
1193
|
+
|
|
1194
|
+
/**
|
|
1195
|
+
* A mode of the screen of a task (concepts 10). A mode its build does not know `app` reads as "by
|
|
1196
|
+
* steps".
|
|
1197
|
+
*
|
|
1198
|
+
* @generated from enum novatrail.api.v1.Mode
|
|
1199
|
+
*/
|
|
1200
|
+
export enum Mode {
|
|
1201
|
+
/**
|
|
1202
|
+
* Not named: in a request, the mode stays as it is, and a new profile's is "by steps".
|
|
1203
|
+
*
|
|
1204
|
+
* @generated from enum value: MODE_UNSPECIFIED = 0;
|
|
1205
|
+
*/
|
|
1206
|
+
UNSPECIFIED = 0,
|
|
1207
|
+
|
|
1208
|
+
/**
|
|
1209
|
+
* "By steps": the app leads through the module's solving steps.
|
|
1210
|
+
*
|
|
1211
|
+
* @generated from enum value: MODE_BY_STEPS = 1;
|
|
1212
|
+
*/
|
|
1213
|
+
BY_STEPS = 1,
|
|
1214
|
+
|
|
1215
|
+
/**
|
|
1216
|
+
* "Self": the app waits until the learner calls.
|
|
1217
|
+
*
|
|
1218
|
+
* @generated from enum value: MODE_SELF = 2;
|
|
1219
|
+
*/
|
|
1220
|
+
SELF = 2,
|
|
1221
|
+
}
|
|
1222
|
+
|
|
1223
|
+
/**
|
|
1224
|
+
* Describes the enum novatrail.api.v1.Mode.
|
|
1225
|
+
*/
|
|
1226
|
+
export declare const ModeSchema: GenEnum<Mode>;
|
|
1227
|
+
|
|
1228
|
+
/**
|
|
1229
|
+
* Where a consent for a child stands. A state its build does not know `app` reads as waiting.
|
|
1230
|
+
*
|
|
1231
|
+
* @generated from enum novatrail.api.v1.ConsentState
|
|
1232
|
+
*/
|
|
1233
|
+
export enum ConsentState {
|
|
1234
|
+
/**
|
|
1235
|
+
* Not named: never sent.
|
|
1236
|
+
*
|
|
1237
|
+
* @generated from enum value: CONSENT_STATE_UNSPECIFIED = 0;
|
|
1238
|
+
*/
|
|
1239
|
+
UNSPECIFIED = 0,
|
|
1240
|
+
|
|
1241
|
+
/**
|
|
1242
|
+
* It waits: it is not given and confirmed yet (epic E4 of RUN.md).
|
|
1243
|
+
*
|
|
1244
|
+
* @generated from enum value: CONSENT_STATE_WAITING = 1;
|
|
1245
|
+
*/
|
|
1246
|
+
WAITING = 1,
|
|
1247
|
+
|
|
1248
|
+
/**
|
|
1249
|
+
* It is confirmed, and the child's profile may be created.
|
|
1250
|
+
*
|
|
1251
|
+
* @generated from enum value: CONSENT_STATE_CONFIRMED = 2;
|
|
1252
|
+
*/
|
|
1253
|
+
CONFIRMED = 2,
|
|
1254
|
+
}
|
|
1255
|
+
|
|
1256
|
+
/**
|
|
1257
|
+
* Describes the enum novatrail.api.v1.ConsentState.
|
|
1258
|
+
*/
|
|
1259
|
+
export declare const ConsentStateSchema: GenEnum<ConsentState>;
|
|
1260
|
+
|
|
1261
|
+
/**
|
|
1262
|
+
* What the check of an own key gave (R84). A value its build does not know `app` words as a check
|
|
1263
|
+
* that did not go through.
|
|
1264
|
+
*
|
|
1265
|
+
* @generated from enum novatrail.api.v1.OwnKeyCheck
|
|
1266
|
+
*/
|
|
1267
|
+
export enum OwnKeyCheck {
|
|
1268
|
+
/**
|
|
1269
|
+
* No check: the provider gave no answer, and the outcome says so.
|
|
1270
|
+
*
|
|
1271
|
+
* @generated from enum value: OWN_KEY_CHECK_UNSPECIFIED = 0;
|
|
1272
|
+
*/
|
|
1273
|
+
UNSPECIFIED = 0,
|
|
1274
|
+
|
|
1275
|
+
/**
|
|
1276
|
+
* The key is accepted.
|
|
1277
|
+
*
|
|
1278
|
+
* @generated from enum value: OWN_KEY_CHECK_ACCEPTED = 1;
|
|
1279
|
+
*/
|
|
1280
|
+
ACCEPTED = 1,
|
|
1281
|
+
|
|
1282
|
+
/**
|
|
1283
|
+
* The key is not valid, or was revoked.
|
|
1284
|
+
*
|
|
1285
|
+
* @generated from enum value: OWN_KEY_CHECK_INVALID = 2;
|
|
1286
|
+
*/
|
|
1287
|
+
INVALID = 2,
|
|
1288
|
+
|
|
1289
|
+
/**
|
|
1290
|
+
* The key is valid, but has no right to the models it is needed for.
|
|
1291
|
+
*
|
|
1292
|
+
* @generated from enum value: OWN_KEY_CHECK_NO_PERMISSION = 3;
|
|
1293
|
+
*/
|
|
1294
|
+
NO_PERMISSION = 3,
|
|
1295
|
+
|
|
1296
|
+
/**
|
|
1297
|
+
* The admission function does not open the provider to an own key at this profile, or the
|
|
1298
|
+
* admission table does not know the provider: no call went.
|
|
1299
|
+
*
|
|
1300
|
+
* @generated from enum value: OWN_KEY_CHECK_PROVIDER_CLOSED = 4;
|
|
1301
|
+
*/
|
|
1302
|
+
PROVIDER_CLOSED = 4,
|
|
1303
|
+
}
|
|
1304
|
+
|
|
1305
|
+
/**
|
|
1306
|
+
* Describes the enum novatrail.api.v1.OwnKeyCheck.
|
|
1307
|
+
*/
|
|
1308
|
+
export declare const OwnKeyCheckSchema: GenEnum<OwnKeyCheck>;
|
|
1309
|
+
|
|
1310
|
+
/**
|
|
1311
|
+
* The requests on the account and its profiles, from the section for adults and from a learner's
|
|
1312
|
+
* session. Every method carries the ID token of the sign-in service in the header `Authorization`,
|
|
1313
|
+
* as `Bearer <token>`, and every one may get the refusals of every request with a token:
|
|
1314
|
+
* `unauthenticated` with no `Refusal`, when the token has expired, is revoked or its user is
|
|
1315
|
+
* disabled; `CAUSE_ACCOUNT_GONE`; `CAUSE_NO_ACCESS`, but for `CreateAccount`; and `unavailable`
|
|
1316
|
+
* with no `Refusal`, when the token could not be checked. A method on a profile names the right it
|
|
1317
|
+
* needs, `can_manage` or `can_learn`; a method on the account itself needs the account of the token
|
|
1318
|
+
* alone: it is an action of an adult, and the PIN in front of it is a barrier of the interface
|
|
1319
|
+
* (R04 api). A request without the right it needs
|
|
1320
|
+
* gets the code `permission_denied` with no `Refusal`, and a request whose form the contract
|
|
1321
|
+
* refuses the code `invalid_argument` with no `Refusal`. `app` reads the cause of a refusal before
|
|
1322
|
+
* it refreshes any token:
|
|
1323
|
+
* - `unauthenticated` with no `Refusal`: it refreshes the token and repeats the request, and opens
|
|
1324
|
+
* the sign-in window only if the refresh failed. Signing in again is signing in as the same
|
|
1325
|
+
* user, without signing out: signing out erases everything of the account on the device;
|
|
1326
|
+
* - `CAUSE_FRESH_SIGN_IN_NEEDED`: it signs in again by the window, on a press, and repeats the
|
|
1327
|
+
* action. Whether a sign-in is fresh it reads by the `authTime` of a token it has just
|
|
1328
|
+
* refreshed, against that token's `issuedAtTime`, not against the clock of the device; on
|
|
1329
|
+
* `auth/user-mismatch` it asks `GetAccount`;
|
|
1330
|
+
* - `CAUSE_ACCOUNT_GONE`: it erases everything of the account and signs out, without refreshing
|
|
1331
|
+
* the token;
|
|
1332
|
+
* - `CAUSE_NO_ACCESS` while the registry of the device holds an account: another account has
|
|
1333
|
+
* signed in, and `app` erases what is left of the one before it opens anything;
|
|
1334
|
+
* - `unavailable`: it repeats the request after a growing pause, for a short while.
|
|
1335
|
+
*
|
|
1336
|
+
* @generated from service novatrail.api.v1.AccountService
|
|
1337
|
+
*/
|
|
1338
|
+
export declare const AccountService: GenService<{
|
|
1339
|
+
/**
|
|
1340
|
+
* The account and its profiles, each with its fields, its open attempt and its open lesson runs,
|
|
1341
|
+
* and the consents that have no profile yet. `app` reads it when it starts and after signing in,
|
|
1342
|
+
* and erases the databases of the profiles that the list does not hold: only by an answer that
|
|
1343
|
+
* came, and for the account the registry of the device names; a failure of the network erases
|
|
1344
|
+
* nothing. By the open attempt and runs a device that keeps no state of them finds them. A user
|
|
1345
|
+
* with no account gets `CAUSE_NO_ACCESS`, and `app` asks for an invite code.
|
|
1346
|
+
*
|
|
1347
|
+
* @generated from rpc novatrail.api.v1.AccountService.GetAccount
|
|
1348
|
+
*/
|
|
1349
|
+
getAccount: {
|
|
1350
|
+
methodKind: "unary";
|
|
1351
|
+
input: typeof GetAccountRequestSchema;
|
|
1352
|
+
output: typeof GetAccountResponseSchema;
|
|
1353
|
+
},
|
|
1354
|
+
/**
|
|
1355
|
+
* Creates the account of the user signed in, by an invite code and the owner's statement that
|
|
1356
|
+
* they are 18 or older. Refusals: `CAUSE_ALREADY_EXISTS`, when the user has an account already,
|
|
1357
|
+
* checked before the code, so that a repeat gets it rather than a code redeemed; `app` then reads
|
|
1358
|
+
* the account by `GetAccount`. And `CAUSE_CODE_NOT_ACCEPTED`. It carries no idempotency key: it
|
|
1359
|
+
* repeats by the account's state.
|
|
1360
|
+
*
|
|
1361
|
+
* @generated from rpc novatrail.api.v1.AccountService.CreateAccount
|
|
1362
|
+
*/
|
|
1363
|
+
createAccount: {
|
|
1364
|
+
methodKind: "unary";
|
|
1365
|
+
input: typeof CreateAccountRequestSchema;
|
|
1366
|
+
output: typeof CreateAccountResponseSchema;
|
|
1367
|
+
},
|
|
1368
|
+
/**
|
|
1369
|
+
* Sets the PIN of the section for adults, while the account has none. Refusals:
|
|
1370
|
+
* `CAUSE_PIN_ALREADY_SET`, `CAUSE_KEY_ALREADY_USED` and `CAUSE_STILL_GOING`. A repeat with the
|
|
1371
|
+
* same idempotency key gets the same answer.
|
|
1372
|
+
*
|
|
1373
|
+
* @generated from rpc novatrail.api.v1.AccountService.SetPin
|
|
1374
|
+
*/
|
|
1375
|
+
setPin: {
|
|
1376
|
+
methodKind: "unary";
|
|
1377
|
+
input: typeof SetPinRequestSchema;
|
|
1378
|
+
output: typeof SetPinResponseSchema;
|
|
1379
|
+
},
|
|
1380
|
+
/**
|
|
1381
|
+
* Checks a PIN. A wrong one counts toward closing the input, and the answer says how many wrong
|
|
1382
|
+
* PINs are left before it closes, and when it opens, once it has closed. Refusals:
|
|
1383
|
+
* `CAUSE_PIN_LOCKED`, `CAUSE_NO_PIN`, `CAUSE_KEY_ALREADY_USED` and `CAUSE_STILL_GOING`. A repeat
|
|
1384
|
+
* with the same idempotency key gets the same check, and counts nothing again. The PIN is a
|
|
1385
|
+
* barrier of the interface, not of the server: when to ask for it `app` decides, and no request
|
|
1386
|
+
* carries proof that it was asked (R04 api).
|
|
1387
|
+
*
|
|
1388
|
+
* @generated from rpc novatrail.api.v1.AccountService.VerifyPin
|
|
1389
|
+
*/
|
|
1390
|
+
verifyPin: {
|
|
1391
|
+
methodKind: "unary";
|
|
1392
|
+
input: typeof VerifyPinRequestSchema;
|
|
1393
|
+
output: typeof VerifyPinResponseSchema;
|
|
1394
|
+
},
|
|
1395
|
+
/**
|
|
1396
|
+
* Changes the PIN by the PIN before it. A wrong PIN before counts toward closing the input as
|
|
1397
|
+
* `VerifyPin` counts it, and changes nothing. Refusals: `CAUSE_PIN_LOCKED`, `CAUSE_NO_PIN`,
|
|
1398
|
+
* `CAUSE_KEY_ALREADY_USED` and `CAUSE_STILL_GOING`. A repeat with the same idempotency key gets
|
|
1399
|
+
* the same check: a PIN changed already is not counted as wrong.
|
|
1400
|
+
*
|
|
1401
|
+
* @generated from rpc novatrail.api.v1.AccountService.ChangePin
|
|
1402
|
+
*/
|
|
1403
|
+
changePin: {
|
|
1404
|
+
methodKind: "unary";
|
|
1405
|
+
input: typeof ChangePinRequestSchema;
|
|
1406
|
+
output: typeof ChangePinResponseSchema;
|
|
1407
|
+
},
|
|
1408
|
+
/**
|
|
1409
|
+
* Changes a forgotten PIN by a fresh sign-in: it sets the new PIN, whether there was one or not,
|
|
1410
|
+
* and opens the input if it was closed. Refusals: `CAUSE_FRESH_SIGN_IN_NEEDED`, checked last,
|
|
1411
|
+
* `CAUSE_KEY_ALREADY_USED` and `CAUSE_STILL_GOING`. A repeat with the same idempotency key gets
|
|
1412
|
+
* the same answer.
|
|
1413
|
+
*
|
|
1414
|
+
* @generated from rpc novatrail.api.v1.AccountService.ResetPin
|
|
1415
|
+
*/
|
|
1416
|
+
resetPin: {
|
|
1417
|
+
methodKind: "unary";
|
|
1418
|
+
input: typeof ResetPinRequestSchema;
|
|
1419
|
+
output: typeof ResetPinResponseSchema;
|
|
1420
|
+
},
|
|
1421
|
+
/**
|
|
1422
|
+
* Creates the profile of the account's owner, of the age category `adult` by the owner's
|
|
1423
|
+
* statement, with no age asked. Refusals: `CAUSE_COUNTRY_NOT_ACCEPTED` and
|
|
1424
|
+
* `CAUSE_ALREADY_EXISTS`, when the owner has a profile already; `app` then reads the account. It
|
|
1425
|
+
* carries no idempotency key: it repeats by the account's state.
|
|
1426
|
+
*
|
|
1427
|
+
* @generated from rpc novatrail.api.v1.AccountService.CreateOwnerProfile
|
|
1428
|
+
*/
|
|
1429
|
+
createOwnerProfile: {
|
|
1430
|
+
methodKind: "unary";
|
|
1431
|
+
input: typeof CreateOwnerProfileRequestSchema;
|
|
1432
|
+
output: typeof CreateOwnerProfileResponseSchema;
|
|
1433
|
+
},
|
|
1434
|
+
/**
|
|
1435
|
+
* The first of a child's profile's two steps: the owner gives the child's age in years and the
|
|
1436
|
+
* child's country, and `api` works out the age category and records a consent that waits, with
|
|
1437
|
+
* the category and the country alone: no pseudonym and no other field of the profile. The age in
|
|
1438
|
+
* years `api` keeps nowhere. How the consent is given and confirmed is epic E4 of RUN.md (privacy
|
|
1439
|
+
* 9, П-1). Refusals: `CAUSE_COUNTRY_NOT_ACCEPTED`, `CAUSE_KEY_ALREADY_USED` and
|
|
1440
|
+
* `CAUSE_STILL_GOING`. A repeat with the same idempotency key gets the same consent.
|
|
1441
|
+
*
|
|
1442
|
+
* @generated from rpc novatrail.api.v1.AccountService.RequestChildConsent
|
|
1443
|
+
*/
|
|
1444
|
+
requestChildConsent: {
|
|
1445
|
+
methodKind: "unary";
|
|
1446
|
+
input: typeof RequestChildConsentRequestSchema;
|
|
1447
|
+
output: typeof RequestChildConsentResponseSchema;
|
|
1448
|
+
},
|
|
1449
|
+
/**
|
|
1450
|
+
* The second step: creates a child's profile by its consent, once the consent is confirmed.
|
|
1451
|
+
* Refusals: `CAUSE_NOT_FOUND`, `CAUSE_NO_CONSENT` while the consent waits, and
|
|
1452
|
+
* `CAUSE_ALREADY_EXISTS`, when the consent has its profile already; `app` then reads the account.
|
|
1453
|
+
* It carries no idempotency key: it repeats by the consent's state.
|
|
1454
|
+
*
|
|
1455
|
+
* @generated from rpc novatrail.api.v1.AccountService.CreateChildProfile
|
|
1456
|
+
*/
|
|
1457
|
+
createChildProfile: {
|
|
1458
|
+
methodKind: "unary";
|
|
1459
|
+
input: typeof CreateChildProfileRequestSchema;
|
|
1460
|
+
output: typeof CreateChildProfileResponseSchema;
|
|
1461
|
+
},
|
|
1462
|
+
/**
|
|
1463
|
+
* Changes a profile's settings, by an action of an adult with the right `can_manage`: the fields
|
|
1464
|
+
* sent change, and the others stay as they are. Refusals: `CAUSE_NO_PROFILE`.
|
|
1465
|
+
*
|
|
1466
|
+
* @generated from rpc novatrail.api.v1.AccountService.UpdateProfile
|
|
1467
|
+
*/
|
|
1468
|
+
updateProfile: {
|
|
1469
|
+
methodKind: "unary";
|
|
1470
|
+
input: typeof UpdateProfileRequestSchema;
|
|
1471
|
+
output: typeof UpdateProfileResponseSchema;
|
|
1472
|
+
},
|
|
1473
|
+
/**
|
|
1474
|
+
* Sets the voicing of a profile, whether it is on and its speed, and nothing else, from the
|
|
1475
|
+
* screen of a task: a learning request with the right `can_learn`. Refusals:
|
|
1476
|
+
* `CAUSE_NO_PROFILE`.
|
|
1477
|
+
*
|
|
1478
|
+
* @generated from rpc novatrail.api.v1.AccountService.SetVoicing
|
|
1479
|
+
*/
|
|
1480
|
+
setVoicing: {
|
|
1481
|
+
methodKind: "unary";
|
|
1482
|
+
input: typeof SetVoicingRequestSchema;
|
|
1483
|
+
output: typeof SetVoicingResponseSchema;
|
|
1484
|
+
},
|
|
1485
|
+
/**
|
|
1486
|
+
* Deletes a profile and everything of it, by an action of an adult with the right `can_manage`
|
|
1487
|
+
* and a fresh sign-in, checked last. The profile of the owner is deleted the same way, and the
|
|
1488
|
+
* last profile leaves the account without profiles. The answer is "deleted", and `app` erases
|
|
1489
|
+
* the profile's database. Refusals: `CAUSE_FRESH_SIGN_IN_NEEDED`, and `CAUSE_NO_PROFILE`, which
|
|
1490
|
+
* is the answer of a repeat too: `app` reads it as deleted already. It carries no idempotency
|
|
1491
|
+
* key: it repeats by the profile's state.
|
|
1492
|
+
*
|
|
1493
|
+
* @generated from rpc novatrail.api.v1.AccountService.DeleteProfile
|
|
1494
|
+
*/
|
|
1495
|
+
deleteProfile: {
|
|
1496
|
+
methodKind: "unary";
|
|
1497
|
+
input: typeof DeleteProfileRequestSchema;
|
|
1498
|
+
output: typeof DeleteProfileResponseSchema;
|
|
1499
|
+
},
|
|
1500
|
+
/**
|
|
1501
|
+
* Deletes the account and everything of it, with the user of the sign-in service, by a fresh
|
|
1502
|
+
* sign-in, checked last. The answer is "deleted", and `app` erases everything of the account on
|
|
1503
|
+
* the device and signs out, without refreshing the token. Other devices learn of it by
|
|
1504
|
+
* `CAUSE_ACCOUNT_GONE`. Refusals: `CAUSE_FRESH_SIGN_IN_NEEDED`; a repeat gets
|
|
1505
|
+
* `CAUSE_ACCOUNT_GONE`. It carries no idempotency key: it repeats by the account's state.
|
|
1506
|
+
*
|
|
1507
|
+
* @generated from rpc novatrail.api.v1.AccountService.DeleteAccount
|
|
1508
|
+
*/
|
|
1509
|
+
deleteAccount: {
|
|
1510
|
+
methodKind: "unary";
|
|
1511
|
+
input: typeof DeleteAccountRequestSchema;
|
|
1512
|
+
output: typeof DeleteAccountResponseSchema;
|
|
1513
|
+
},
|
|
1514
|
+
/**
|
|
1515
|
+
* The part of a profile's export that `api` holds, by an action of an adult with the right
|
|
1516
|
+
* `can_manage`, with no fresh sign-in. `app` makes the file of the export of it and of what the
|
|
1517
|
+
* device holds. Refusals: `CAUSE_NO_PROFILE`.
|
|
1518
|
+
*
|
|
1519
|
+
* @generated from rpc novatrail.api.v1.AccountService.ExportProfile
|
|
1520
|
+
*/
|
|
1521
|
+
exportProfile: {
|
|
1522
|
+
methodKind: "unary";
|
|
1523
|
+
input: typeof ExportProfileRequestSchema;
|
|
1524
|
+
output: typeof ExportProfileResponseSchema;
|
|
1525
|
+
},
|
|
1526
|
+
/**
|
|
1527
|
+
* The part of the account's export that `api` holds: the fields of the account and the parts of
|
|
1528
|
+
* every profile, with no fresh sign-in.
|
|
1529
|
+
*
|
|
1530
|
+
* @generated from rpc novatrail.api.v1.AccountService.ExportAccount
|
|
1531
|
+
*/
|
|
1532
|
+
exportAccount: {
|
|
1533
|
+
methodKind: "unary";
|
|
1534
|
+
input: typeof ExportAccountRequestSchema;
|
|
1535
|
+
output: typeof ExportAccountResponseSchema;
|
|
1536
|
+
},
|
|
1537
|
+
/**
|
|
1538
|
+
* Checks a key of the owner's at its provider, when it is connected, by a request with nothing of
|
|
1539
|
+
* a learner's: on the page where the key is entered, an action of an adult with the right
|
|
1540
|
+
* `can_manage` on the owner's profile of the age category `adult` (R84). A provider that gave no
|
|
1541
|
+
* answer is an outcome. Refusals: `CAUSE_NO_PROFILE` and `CAUSE_KEY_NOT_FOR_PROFILE`.
|
|
1542
|
+
*
|
|
1543
|
+
* @generated from rpc novatrail.api.v1.AccountService.CheckOwnKey
|
|
1544
|
+
*/
|
|
1545
|
+
checkOwnKey: {
|
|
1546
|
+
methodKind: "unary";
|
|
1547
|
+
input: typeof CheckOwnKeyRequestSchema;
|
|
1548
|
+
output: typeof CheckOwnKeyResponseSchema;
|
|
1549
|
+
},
|
|
1550
|
+
/**
|
|
1551
|
+
* The providers that the admission function opens to an own key at a profile, so that `app`
|
|
1552
|
+
* builds no list in: empty at a profile whose age category is not `adult`. An action of an adult
|
|
1553
|
+
* with the right `can_manage`. Refusals: `CAUSE_NO_PROFILE`.
|
|
1554
|
+
*
|
|
1555
|
+
* @generated from rpc novatrail.api.v1.AccountService.ListOwnKeyProviders
|
|
1556
|
+
*/
|
|
1557
|
+
listOwnKeyProviders: {
|
|
1558
|
+
methodKind: "unary";
|
|
1559
|
+
input: typeof ListOwnKeyProvidersRequestSchema;
|
|
1560
|
+
output: typeof ListOwnKeyProvidersResponseSchema;
|
|
1561
|
+
},
|
|
1562
|
+
}>;
|
|
1563
|
+
|