onehook-api-client 1.0.43 → 1.0.45
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/README.md +0 -147
- package/dist-cjs/events/catalog.js +141 -0
- package/dist-cjs/events/details.js +129 -0
- package/dist-cjs/events/index.js +5 -0
- package/dist-cjs/telemetry/index.js +59 -3
- package/dist-es/events/catalog.js +137 -0
- package/dist-es/events/details.js +126 -0
- package/dist-es/events/index.js +2 -0
- package/dist-es/telemetry/index.js +59 -3
- package/dist-types/events/catalog.d.ts +145 -0
- package/dist-types/events/details.d.ts +734 -0
- package/dist-types/events/index.d.ts +2 -0
- package/dist-types/graphql/types.d.ts +52 -4
- package/dist-types/models/models_0.d.ts +496 -496
- package/dist-types/telemetry/index.d.ts +30 -2
- package/manifest/ApiManifest.kt +135 -0
- package/manifest/ApiManifest.swift +137 -0
- package/manifest/api-manifest.json +816 -0
- package/openapi/OneHookService.openapi.json +19202 -0
- package/package.json +12 -2
- package/telemetry/TELEMETRY_CONTRACT.txt +35 -0
- package/telemetry/TelemetryCatalog.kt +33 -5
- package/telemetry/TelemetryCatalog.swift +61 -5
- package/telemetry/telemetry-catalog.json +505 -3
|
@@ -9,9 +9,9 @@ import { DocumentType as __DocumentType } from "@smithy/types";
|
|
|
9
9
|
* @public
|
|
10
10
|
*/
|
|
11
11
|
export interface AiContextPolicy {
|
|
12
|
-
profileAllowed: boolean
|
|
13
|
-
messageHistoryAllowed: boolean
|
|
14
|
-
policyVersion: string
|
|
12
|
+
profileAllowed: boolean;
|
|
13
|
+
messageHistoryAllowed: boolean;
|
|
14
|
+
policyVersion: string;
|
|
15
15
|
}
|
|
16
16
|
/**
|
|
17
17
|
* Allow-listed, AI-visible profile fields. Every field is optional: the server emits only
|
|
@@ -44,7 +44,7 @@ export interface AiContextParticipant {
|
|
|
44
44
|
* and bounds these on receipt.
|
|
45
45
|
* @public
|
|
46
46
|
*/
|
|
47
|
-
visibleProfile: AiVisibleProfile
|
|
47
|
+
visibleProfile: AiVisibleProfile;
|
|
48
48
|
}
|
|
49
49
|
/**
|
|
50
50
|
* The consent-gated, AI-visible projection of an active match. Mirrors the shape the
|
|
@@ -55,10 +55,10 @@ export interface AiContextParticipant {
|
|
|
55
55
|
* @public
|
|
56
56
|
*/
|
|
57
57
|
export interface AiContextMatch {
|
|
58
|
-
matchId: string
|
|
59
|
-
status: string
|
|
60
|
-
requestingUser: AiContextParticipant
|
|
61
|
-
matchedUser: AiContextParticipant
|
|
58
|
+
matchId: string;
|
|
59
|
+
status: string;
|
|
60
|
+
requestingUser: AiContextParticipant;
|
|
61
|
+
matchedUser: AiContextParticipant;
|
|
62
62
|
/**
|
|
63
63
|
* The server's decision about what the model may use for this match. Fails closed:
|
|
64
64
|
* `profileAllowed` / `messageHistoryAllowed` are false unless an active, mutually
|
|
@@ -66,13 +66,13 @@ export interface AiContextMatch {
|
|
|
66
66
|
* which policy produced the decision.
|
|
67
67
|
* @public
|
|
68
68
|
*/
|
|
69
|
-
contextPolicy: AiContextPolicy
|
|
69
|
+
contextPolicy: AiContextPolicy;
|
|
70
70
|
}
|
|
71
71
|
/**
|
|
72
72
|
* @public
|
|
73
73
|
*/
|
|
74
74
|
export interface GetAiContextMatchRequest {
|
|
75
|
-
matchId: string
|
|
75
|
+
matchId: string;
|
|
76
76
|
/**
|
|
77
77
|
* The acting member, asserted by the trusted caller via the `X-OneHook-User-Id`
|
|
78
78
|
* request header. The endpoint fails closed (404) unless this user is an active
|
|
@@ -80,7 +80,7 @@ export interface GetAiContextMatchRequest {
|
|
|
80
80
|
* named user is genuinely part of.
|
|
81
81
|
* @public
|
|
82
82
|
*/
|
|
83
|
-
requestingUserId: string
|
|
83
|
+
requestingUserId: string;
|
|
84
84
|
}
|
|
85
85
|
/**
|
|
86
86
|
* 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
|
|
@@ -94,7 +94,7 @@ export declare class ForbiddenError extends __BaseException {
|
|
|
94
94
|
* Human-readable message. Clients may log it but must not branch on it.
|
|
95
95
|
* @public
|
|
96
96
|
*/
|
|
97
|
-
error: string
|
|
97
|
+
error: string;
|
|
98
98
|
/**
|
|
99
99
|
* Stable machine code in UPPER_SNAKE_CASE (for example `BAD_REQUEST`, `NOT_FOUND`,
|
|
100
100
|
* `MATCHING_PROFILE_INCOMPLETE`). Clients branch on this. Errors API Gateway answers itself
|
|
@@ -103,7 +103,7 @@ export declare class ForbiddenError extends __BaseException {
|
|
|
103
103
|
* `INTEGRATION_TIMEOUT`.
|
|
104
104
|
* @public
|
|
105
105
|
*/
|
|
106
|
-
code: string
|
|
106
|
+
code: string;
|
|
107
107
|
/**
|
|
108
108
|
* Request id to quote to support, when the service has one.
|
|
109
109
|
* @public
|
|
@@ -132,7 +132,7 @@ export declare class BadGatewayError extends __BaseException {
|
|
|
132
132
|
* Human-readable message. Clients may log it but must not branch on it.
|
|
133
133
|
* @public
|
|
134
134
|
*/
|
|
135
|
-
error: string
|
|
135
|
+
error: string;
|
|
136
136
|
/**
|
|
137
137
|
* Stable machine code in UPPER_SNAKE_CASE (for example `BAD_REQUEST`, `NOT_FOUND`,
|
|
138
138
|
* `MATCHING_PROFILE_INCOMPLETE`). Clients branch on this. Errors API Gateway answers itself
|
|
@@ -141,7 +141,7 @@ export declare class BadGatewayError extends __BaseException {
|
|
|
141
141
|
* `INTEGRATION_TIMEOUT`.
|
|
142
142
|
* @public
|
|
143
143
|
*/
|
|
144
|
-
code: string
|
|
144
|
+
code: string;
|
|
145
145
|
/**
|
|
146
146
|
* Request id to quote to support, when the service has one.
|
|
147
147
|
* @public
|
|
@@ -169,7 +169,7 @@ export declare class ServiceUnavailableError extends __BaseException {
|
|
|
169
169
|
* Human-readable message. Clients may log it but must not branch on it.
|
|
170
170
|
* @public
|
|
171
171
|
*/
|
|
172
|
-
error: string
|
|
172
|
+
error: string;
|
|
173
173
|
/**
|
|
174
174
|
* Stable machine code in UPPER_SNAKE_CASE (for example `BAD_REQUEST`, `NOT_FOUND`,
|
|
175
175
|
* `MATCHING_PROFILE_INCOMPLETE`). Clients branch on this. Errors API Gateway answers itself
|
|
@@ -178,7 +178,7 @@ export declare class ServiceUnavailableError extends __BaseException {
|
|
|
178
178
|
* `INTEGRATION_TIMEOUT`.
|
|
179
179
|
* @public
|
|
180
180
|
*/
|
|
181
|
-
code: string
|
|
181
|
+
code: string;
|
|
182
182
|
/**
|
|
183
183
|
* Request id to quote to support, when the service has one.
|
|
184
184
|
* @public
|
|
@@ -205,7 +205,7 @@ export declare class UnauthorizedError extends __BaseException {
|
|
|
205
205
|
* Human-readable message. Clients may log it but must not branch on it.
|
|
206
206
|
* @public
|
|
207
207
|
*/
|
|
208
|
-
error: string
|
|
208
|
+
error: string;
|
|
209
209
|
/**
|
|
210
210
|
* Stable machine code in UPPER_SNAKE_CASE (for example `BAD_REQUEST`, `NOT_FOUND`,
|
|
211
211
|
* `MATCHING_PROFILE_INCOMPLETE`). Clients branch on this. Errors API Gateway answers itself
|
|
@@ -214,7 +214,7 @@ export declare class UnauthorizedError extends __BaseException {
|
|
|
214
214
|
* `INTEGRATION_TIMEOUT`.
|
|
215
215
|
* @public
|
|
216
216
|
*/
|
|
217
|
-
code: string
|
|
217
|
+
code: string;
|
|
218
218
|
/**
|
|
219
219
|
* Request id to quote to support, when the service has one.
|
|
220
220
|
* @public
|
|
@@ -241,7 +241,7 @@ export declare class BadRequestError extends __BaseException {
|
|
|
241
241
|
* Human-readable message. Clients may log it but must not branch on it.
|
|
242
242
|
* @public
|
|
243
243
|
*/
|
|
244
|
-
error: string
|
|
244
|
+
error: string;
|
|
245
245
|
/**
|
|
246
246
|
* Stable machine code in UPPER_SNAKE_CASE (for example `BAD_REQUEST`, `NOT_FOUND`,
|
|
247
247
|
* `MATCHING_PROFILE_INCOMPLETE`). Clients branch on this. Errors API Gateway answers itself
|
|
@@ -250,7 +250,7 @@ export declare class BadRequestError extends __BaseException {
|
|
|
250
250
|
* `INTEGRATION_TIMEOUT`.
|
|
251
251
|
* @public
|
|
252
252
|
*/
|
|
253
|
-
code: string
|
|
253
|
+
code: string;
|
|
254
254
|
/**
|
|
255
255
|
* Request id to quote to support, when the service has one.
|
|
256
256
|
* @public
|
|
@@ -277,7 +277,7 @@ export declare class InternalServerError extends __BaseException {
|
|
|
277
277
|
* Human-readable message. Clients may log it but must not branch on it.
|
|
278
278
|
* @public
|
|
279
279
|
*/
|
|
280
|
-
error: string
|
|
280
|
+
error: string;
|
|
281
281
|
/**
|
|
282
282
|
* Stable machine code in UPPER_SNAKE_CASE (for example `BAD_REQUEST`, `NOT_FOUND`,
|
|
283
283
|
* `MATCHING_PROFILE_INCOMPLETE`). Clients branch on this. Errors API Gateway answers itself
|
|
@@ -286,7 +286,7 @@ export declare class InternalServerError extends __BaseException {
|
|
|
286
286
|
* `INTEGRATION_TIMEOUT`.
|
|
287
287
|
* @public
|
|
288
288
|
*/
|
|
289
|
-
code: string
|
|
289
|
+
code: string;
|
|
290
290
|
/**
|
|
291
291
|
* Request id to quote to support, when the service has one.
|
|
292
292
|
* @public
|
|
@@ -314,7 +314,7 @@ export declare class NotFoundError extends __BaseException {
|
|
|
314
314
|
* Human-readable message. Clients may log it but must not branch on it.
|
|
315
315
|
* @public
|
|
316
316
|
*/
|
|
317
|
-
error: string
|
|
317
|
+
error: string;
|
|
318
318
|
/**
|
|
319
319
|
* Stable machine code in UPPER_SNAKE_CASE (for example `BAD_REQUEST`, `NOT_FOUND`,
|
|
320
320
|
* `MATCHING_PROFILE_INCOMPLETE`). Clients branch on this. Errors API Gateway answers itself
|
|
@@ -323,7 +323,7 @@ export declare class NotFoundError extends __BaseException {
|
|
|
323
323
|
* `INTEGRATION_TIMEOUT`.
|
|
324
324
|
* @public
|
|
325
325
|
*/
|
|
326
|
-
code: string
|
|
326
|
+
code: string;
|
|
327
327
|
/**
|
|
328
328
|
* Request id to quote to support, when the service has one.
|
|
329
329
|
* @public
|
|
@@ -352,7 +352,7 @@ export declare class TooManyRequestsError extends __BaseException {
|
|
|
352
352
|
* Human-readable message. Clients may log it but must not branch on it.
|
|
353
353
|
* @public
|
|
354
354
|
*/
|
|
355
|
-
error: string
|
|
355
|
+
error: string;
|
|
356
356
|
/**
|
|
357
357
|
* Stable machine code in UPPER_SNAKE_CASE (for example `BAD_REQUEST`, `NOT_FOUND`,
|
|
358
358
|
* `MATCHING_PROFILE_INCOMPLETE`). Clients branch on this. Errors API Gateway answers itself
|
|
@@ -361,7 +361,7 @@ export declare class TooManyRequestsError extends __BaseException {
|
|
|
361
361
|
* `INTEGRATION_TIMEOUT`.
|
|
362
362
|
* @public
|
|
363
363
|
*/
|
|
364
|
-
code: string
|
|
364
|
+
code: string;
|
|
365
365
|
/**
|
|
366
366
|
* Request id to quote to support, when the service has one.
|
|
367
367
|
* @public
|
|
@@ -381,8 +381,8 @@ export declare class TooManyRequestsError extends __BaseException {
|
|
|
381
381
|
* @public
|
|
382
382
|
*/
|
|
383
383
|
export interface ReplyLatency {
|
|
384
|
-
count: number
|
|
385
|
-
avgMs: number
|
|
384
|
+
count: number;
|
|
385
|
+
avgMs: number;
|
|
386
386
|
minMs?: number | undefined;
|
|
387
387
|
maxMs?: number | undefined;
|
|
388
388
|
}
|
|
@@ -391,12 +391,12 @@ export interface ReplyLatency {
|
|
|
391
391
|
* @public
|
|
392
392
|
*/
|
|
393
393
|
export interface ConversationMetrics {
|
|
394
|
-
messageCount: number
|
|
395
|
-
messagesByUser: Record<string, number
|
|
396
|
-
participantCount: number
|
|
397
|
-
oneSided: boolean
|
|
398
|
-
responded: boolean
|
|
399
|
-
ghosted: boolean
|
|
394
|
+
messageCount: number;
|
|
395
|
+
messagesByUser: Record<string, number>;
|
|
396
|
+
participantCount: number;
|
|
397
|
+
oneSided: boolean;
|
|
398
|
+
responded: boolean;
|
|
399
|
+
ghosted: boolean;
|
|
400
400
|
whoMessagedFirst?: string | undefined;
|
|
401
401
|
/**
|
|
402
402
|
* Same as `whoMessagedFirst`.
|
|
@@ -411,7 +411,7 @@ export interface ConversationMetrics {
|
|
|
411
411
|
* @public
|
|
412
412
|
*/
|
|
413
413
|
firstResponseLatencyMs?: number | undefined;
|
|
414
|
-
replyCount: number
|
|
414
|
+
replyCount: number;
|
|
415
415
|
avgReplyMs?: number | undefined;
|
|
416
416
|
minReplyMs?: number | undefined;
|
|
417
417
|
maxReplyMs?: number | undefined;
|
|
@@ -419,21 +419,21 @@ export interface ConversationMetrics {
|
|
|
419
419
|
* Reply latency per replier.
|
|
420
420
|
* @public
|
|
421
421
|
*/
|
|
422
|
-
replyLatencyByUser: Record<string, ReplyLatency
|
|
423
|
-
sessionCount: number
|
|
424
|
-
totalActiveMs: number
|
|
425
|
-
longestSessionMs: number
|
|
422
|
+
replyLatencyByUser: Record<string, ReplyLatency>;
|
|
423
|
+
sessionCount: number;
|
|
424
|
+
totalActiveMs: number;
|
|
425
|
+
longestSessionMs: number;
|
|
426
426
|
avgSessionMs?: number | undefined;
|
|
427
427
|
}
|
|
428
428
|
/**
|
|
429
429
|
* @public
|
|
430
430
|
*/
|
|
431
431
|
export interface ConversationSummary {
|
|
432
|
-
messageCount: number
|
|
433
|
-
responded: boolean
|
|
434
|
-
ghosted: boolean
|
|
432
|
+
messageCount: number;
|
|
433
|
+
responded: boolean;
|
|
434
|
+
ghosted: boolean;
|
|
435
435
|
avgReplyMs?: number | undefined;
|
|
436
|
-
sessionCount: number
|
|
436
|
+
sessionCount: number;
|
|
437
437
|
/**
|
|
438
438
|
* Epoch millis.
|
|
439
439
|
* @public
|
|
@@ -444,7 +444,7 @@ export interface ConversationSummary {
|
|
|
444
444
|
* @public
|
|
445
445
|
*/
|
|
446
446
|
export interface GraphInvitesRequest {
|
|
447
|
-
userId: string
|
|
447
|
+
userId: string;
|
|
448
448
|
/**
|
|
449
449
|
* Levels to walk. Not a positive number means 4; capped at 8.
|
|
450
450
|
* @public
|
|
@@ -455,7 +455,7 @@ export interface GraphInvitesRequest {
|
|
|
455
455
|
* @public
|
|
456
456
|
*/
|
|
457
457
|
export interface GraphMatch {
|
|
458
|
-
matchId: string
|
|
458
|
+
matchId: string;
|
|
459
459
|
userA?: string | undefined;
|
|
460
460
|
userB?: string | undefined;
|
|
461
461
|
/**
|
|
@@ -472,26 +472,26 @@ export interface GraphMatch {
|
|
|
472
472
|
* Conversation metrics of one match. Times are epoch millis, durations millis.
|
|
473
473
|
* @public
|
|
474
474
|
*/
|
|
475
|
-
metrics: ConversationMetrics
|
|
475
|
+
metrics: ConversationMetrics;
|
|
476
476
|
}
|
|
477
477
|
/**
|
|
478
478
|
* @public
|
|
479
479
|
*/
|
|
480
480
|
export interface GraphMatchRequest {
|
|
481
|
-
matchId: string
|
|
481
|
+
matchId: string;
|
|
482
482
|
}
|
|
483
483
|
/**
|
|
484
484
|
* @public
|
|
485
485
|
*/
|
|
486
486
|
export interface GraphUserBehavior {
|
|
487
|
-
messagesSent: number
|
|
488
|
-
matchesMessaged: number
|
|
487
|
+
messagesSent: number;
|
|
488
|
+
matchesMessaged: number;
|
|
489
489
|
/**
|
|
490
490
|
* Two decimals; 0 when the member messaged no match.
|
|
491
491
|
* @public
|
|
492
492
|
*/
|
|
493
|
-
messagesPerMatchedConversation: number
|
|
494
|
-
matchesInitiated: number
|
|
493
|
+
messagesPerMatchedConversation: number;
|
|
494
|
+
matchesInitiated: number;
|
|
495
495
|
/**
|
|
496
496
|
* Three decimals. Absent without matches.
|
|
497
497
|
* @public
|
|
@@ -502,20 +502,20 @@ export interface GraphUserBehavior {
|
|
|
502
502
|
* @public
|
|
503
503
|
*/
|
|
504
504
|
avgReplyMs?: number | undefined;
|
|
505
|
-
replyCount: number
|
|
505
|
+
replyCount: number;
|
|
506
506
|
/**
|
|
507
507
|
* Epoch millis of the last message the member sent.
|
|
508
508
|
* @public
|
|
509
509
|
*/
|
|
510
510
|
lastActiveAt?: number | undefined;
|
|
511
|
-
recentlyActive24h: boolean
|
|
512
|
-
recentlyActive7d: boolean
|
|
511
|
+
recentlyActive24h: boolean;
|
|
512
|
+
recentlyActive7d: boolean;
|
|
513
513
|
}
|
|
514
514
|
/**
|
|
515
515
|
* @public
|
|
516
516
|
*/
|
|
517
517
|
export interface GraphUser {
|
|
518
|
-
userId: string
|
|
518
|
+
userId: string;
|
|
519
519
|
/**
|
|
520
520
|
* Who invited the member, when known.
|
|
521
521
|
* @public
|
|
@@ -526,28 +526,28 @@ export interface GraphUser {
|
|
|
526
526
|
* @public
|
|
527
527
|
*/
|
|
528
528
|
createdAt?: number | undefined;
|
|
529
|
-
directInviteCount: number
|
|
530
|
-
matchCount: number
|
|
531
|
-
behavior: GraphUserBehavior
|
|
529
|
+
directInviteCount: number;
|
|
530
|
+
matchCount: number;
|
|
531
|
+
behavior: GraphUserBehavior;
|
|
532
532
|
}
|
|
533
533
|
/**
|
|
534
534
|
* @public
|
|
535
535
|
*/
|
|
536
536
|
export interface GraphUserRequest {
|
|
537
|
-
userId: string
|
|
537
|
+
userId: string;
|
|
538
538
|
}
|
|
539
539
|
/**
|
|
540
540
|
* @public
|
|
541
541
|
*/
|
|
542
542
|
export interface PhotoStats {
|
|
543
|
-
mediaId: string
|
|
544
|
-
uniqueViewers: number
|
|
545
|
-
viewersMoreThanOnce: number
|
|
546
|
-
viewersMoreThan10: number
|
|
547
|
-
viewersMoreThan100: number
|
|
548
|
-
fullscreenViewers: number
|
|
549
|
-
totalViews: number
|
|
550
|
-
totalFullscreenOpens: number
|
|
543
|
+
mediaId: string;
|
|
544
|
+
uniqueViewers: number;
|
|
545
|
+
viewersMoreThanOnce: number;
|
|
546
|
+
viewersMoreThan10: number;
|
|
547
|
+
viewersMoreThan100: number;
|
|
548
|
+
fullscreenViewers: number;
|
|
549
|
+
totalViews: number;
|
|
550
|
+
totalFullscreenOpens: number;
|
|
551
551
|
/**
|
|
552
552
|
* Epoch millis of the last update. Absent before the first view.
|
|
553
553
|
* @public
|
|
@@ -558,7 +558,7 @@ export interface PhotoStats {
|
|
|
558
558
|
* @public
|
|
559
559
|
*/
|
|
560
560
|
export interface MediaStatsResponse {
|
|
561
|
-
photos: (PhotoStats)[]
|
|
561
|
+
photos: (PhotoStats)[];
|
|
562
562
|
}
|
|
563
563
|
/**
|
|
564
564
|
* @public
|
|
@@ -576,15 +576,15 @@ export interface GraphUserMatch {
|
|
|
576
576
|
* @public
|
|
577
577
|
*/
|
|
578
578
|
origin?: string | undefined;
|
|
579
|
-
summary: ConversationSummary
|
|
579
|
+
summary: ConversationSummary;
|
|
580
580
|
}
|
|
581
581
|
/**
|
|
582
582
|
* @public
|
|
583
583
|
*/
|
|
584
584
|
export interface GraphUserMatches {
|
|
585
|
-
userId: string
|
|
586
|
-
matchCount: number
|
|
587
|
-
matches: (GraphUserMatch)[]
|
|
585
|
+
userId: string;
|
|
586
|
+
matchCount: number;
|
|
587
|
+
matches: (GraphUserMatch)[];
|
|
588
588
|
}
|
|
589
589
|
/**
|
|
590
590
|
* One client signal. Validated one by one against the telemetry catalog
|
|
@@ -596,12 +596,12 @@ export interface RawSignal {
|
|
|
596
596
|
* Client-minted id (1 to 100 characters), used to drop duplicates.
|
|
597
597
|
* @public
|
|
598
598
|
*/
|
|
599
|
-
clientEventId: string
|
|
599
|
+
clientEventId: string;
|
|
600
600
|
/**
|
|
601
601
|
* A signal type from the telemetry catalog.
|
|
602
602
|
* @public
|
|
603
603
|
*/
|
|
604
|
-
type: string
|
|
604
|
+
type: string;
|
|
605
605
|
/**
|
|
606
606
|
* Client clock, epoch millis, within 24 hours of the server's.
|
|
607
607
|
* @public
|
|
@@ -632,24 +632,24 @@ export interface IngestSignalsRequest {
|
|
|
632
632
|
* @public
|
|
633
633
|
*/
|
|
634
634
|
export interface IngestSignalsResponse {
|
|
635
|
-
accepted: number
|
|
636
|
-
rejected: number
|
|
635
|
+
accepted: number;
|
|
636
|
+
rejected: number;
|
|
637
637
|
/**
|
|
638
638
|
* Rejected signals per reason.
|
|
639
639
|
* @public
|
|
640
640
|
*/
|
|
641
|
-
reasons: Record<string, number
|
|
641
|
+
reasons: Record<string, number>;
|
|
642
642
|
}
|
|
643
643
|
/**
|
|
644
644
|
* @public
|
|
645
645
|
*/
|
|
646
646
|
export interface CreateMediaDownloadUrlRequest {
|
|
647
|
-
matchId: string
|
|
647
|
+
matchId: string;
|
|
648
648
|
/**
|
|
649
649
|
* Must be under `<matchId>/`; anything else is rejected as forbidden.
|
|
650
650
|
* @public
|
|
651
651
|
*/
|
|
652
|
-
objectKey: string
|
|
652
|
+
objectKey: string;
|
|
653
653
|
}
|
|
654
654
|
/**
|
|
655
655
|
* @public
|
|
@@ -659,8 +659,8 @@ export interface CreateMediaDownloadUrlResponse {
|
|
|
659
659
|
* Presigned GET returning ciphertext.
|
|
660
660
|
* @public
|
|
661
661
|
*/
|
|
662
|
-
downloadUrl: string
|
|
663
|
-
expiresInSeconds: number
|
|
662
|
+
downloadUrl: string;
|
|
663
|
+
expiresInSeconds: number;
|
|
664
664
|
}
|
|
665
665
|
/**
|
|
666
666
|
* @public
|
|
@@ -684,7 +684,7 @@ export interface CreateMediaUploadUrlRequest {
|
|
|
684
684
|
* Conversation the attachment belongs to. The caller must be a participant.
|
|
685
685
|
* @public
|
|
686
686
|
*/
|
|
687
|
-
matchId: string
|
|
687
|
+
matchId: string;
|
|
688
688
|
/**
|
|
689
689
|
* Byte length of the CIPHERTEXT to upload, which the presigned URL is bound to.
|
|
690
690
|
*
|
|
@@ -692,7 +692,7 @@ export interface CreateMediaUploadUrlRequest {
|
|
|
692
692
|
* parking arbitrary amounts of data in the bucket.
|
|
693
693
|
* @public
|
|
694
694
|
*/
|
|
695
|
-
contentLength: number
|
|
695
|
+
contentLength: number;
|
|
696
696
|
/**
|
|
697
697
|
* Not read by the service today; the authoritative kind is in the encrypted payload.
|
|
698
698
|
* @public
|
|
@@ -708,25 +708,25 @@ export interface CreateMediaUploadUrlResponse {
|
|
|
708
708
|
* it; the matchId prefix is what makes prefix deletion on HookReleased possible.
|
|
709
709
|
* @public
|
|
710
710
|
*/
|
|
711
|
-
objectKey: string
|
|
711
|
+
objectKey: string;
|
|
712
712
|
/**
|
|
713
713
|
* Presigned PUT, valid only for the requested byte length.
|
|
714
714
|
* @public
|
|
715
715
|
*/
|
|
716
|
-
uploadUrl: string
|
|
717
|
-
expiresInSeconds: number
|
|
716
|
+
uploadUrl: string;
|
|
717
|
+
expiresInSeconds: number;
|
|
718
718
|
}
|
|
719
719
|
/**
|
|
720
720
|
* @public
|
|
721
721
|
*/
|
|
722
722
|
export interface DeleteMatchMessagesRequest {
|
|
723
|
-
matchId: string
|
|
723
|
+
matchId: string;
|
|
724
724
|
}
|
|
725
725
|
/**
|
|
726
726
|
* @public
|
|
727
727
|
*/
|
|
728
728
|
export interface DeleteMatchMessagesResponse {
|
|
729
|
-
deleted: number
|
|
729
|
+
deleted: number;
|
|
730
730
|
}
|
|
731
731
|
/**
|
|
732
732
|
* @public
|
|
@@ -736,7 +736,7 @@ export interface DeletePushTokenRequest {
|
|
|
736
736
|
* UUID-ish opaque device identifier minted by the client, bounded to 64 chars.
|
|
737
737
|
* @public
|
|
738
738
|
*/
|
|
739
|
-
deviceId: string
|
|
739
|
+
deviceId: string;
|
|
740
740
|
}
|
|
741
741
|
/**
|
|
742
742
|
* @public
|
|
@@ -746,13 +746,13 @@ export interface DeletePushTokenResponse {
|
|
|
746
746
|
* UUID-ish opaque device identifier minted by the client, bounded to 64 chars.
|
|
747
747
|
* @public
|
|
748
748
|
*/
|
|
749
|
-
deviceId: string
|
|
749
|
+
deviceId: string;
|
|
750
750
|
/**
|
|
751
751
|
* True when a token row was removed; false when there was none. Safe to expose because this is the
|
|
752
752
|
* caller's OWN device.
|
|
753
753
|
* @public
|
|
754
754
|
*/
|
|
755
|
-
deleted: boolean
|
|
755
|
+
deleted: boolean;
|
|
756
756
|
}
|
|
757
757
|
/**
|
|
758
758
|
* A wrap as a client sends it. Its epoch is the request's.
|
|
@@ -768,8 +768,8 @@ export interface AhkWrapInput {
|
|
|
768
768
|
* `ESCROW`, `PRF` or `DEVICE`.
|
|
769
769
|
* @public
|
|
770
770
|
*/
|
|
771
|
-
method: string
|
|
772
|
-
wrapId: string
|
|
771
|
+
method: string;
|
|
772
|
+
wrapId: string;
|
|
773
773
|
/**
|
|
774
774
|
* Absent (or "") for `ESCROW`.
|
|
775
775
|
* @public
|
|
@@ -784,14 +784,14 @@ export interface EstablishHistoryEpochRequest {
|
|
|
784
784
|
* Must be `expectedEpoch + 1` (and at least 1).
|
|
785
785
|
* @public
|
|
786
786
|
*/
|
|
787
|
-
epoch: number
|
|
787
|
+
epoch: number;
|
|
788
788
|
/**
|
|
789
789
|
* The epoch the caller believes is active; 0 when the account has none. Defaults to 0.
|
|
790
790
|
* @public
|
|
791
791
|
*/
|
|
792
792
|
expectedEpoch?: number | undefined;
|
|
793
|
-
keyId: string
|
|
794
|
-
publicKey: string
|
|
793
|
+
keyId: string;
|
|
794
|
+
publicKey: string;
|
|
795
795
|
/**
|
|
796
796
|
* Epoch millis. Required when replacing an existing epoch (a reset), rejected on the first one.
|
|
797
797
|
* @public
|
|
@@ -801,21 +801,21 @@ export interface EstablishHistoryEpochRequest {
|
|
|
801
801
|
* At least one: an epoch nothing can recover is refused.
|
|
802
802
|
* @public
|
|
803
803
|
*/
|
|
804
|
-
wraps: (AhkWrapInput)[]
|
|
804
|
+
wraps: (AhkWrapInput)[];
|
|
805
805
|
}
|
|
806
806
|
/**
|
|
807
807
|
* One epoch of the account history key. Only the public half is ever stored or returned.
|
|
808
808
|
* @public
|
|
809
809
|
*/
|
|
810
810
|
export interface HistoryEpoch {
|
|
811
|
-
epoch: number
|
|
812
|
-
keyId: string
|
|
813
|
-
publicKey: string
|
|
811
|
+
epoch: number;
|
|
812
|
+
keyId: string;
|
|
813
|
+
publicKey: string;
|
|
814
814
|
/**
|
|
815
815
|
* Epoch millis.
|
|
816
816
|
* @public
|
|
817
817
|
*/
|
|
818
|
-
createdAt: number
|
|
818
|
+
createdAt: number;
|
|
819
819
|
/**
|
|
820
820
|
* Epoch millis. Present only on an epoch created by a reset: older history cannot be read.
|
|
821
821
|
* @public
|
|
@@ -830,12 +830,12 @@ export interface EstablishHistoryEpochResponse {
|
|
|
830
830
|
* Always true on a 200 (a lost race is a 409).
|
|
831
831
|
* @public
|
|
832
832
|
*/
|
|
833
|
-
established: boolean
|
|
833
|
+
established: boolean;
|
|
834
834
|
/**
|
|
835
835
|
* Every epoch after this one was recorded.
|
|
836
836
|
* @public
|
|
837
837
|
*/
|
|
838
|
-
epochs: (HistoryEpoch)[]
|
|
838
|
+
epochs: (HistoryEpoch)[];
|
|
839
839
|
}
|
|
840
840
|
/**
|
|
841
841
|
* 409: the request conflicts with the current state (code `CONFLICT`, or a more specific one such
|
|
@@ -849,7 +849,7 @@ export declare class ConflictError extends __BaseException {
|
|
|
849
849
|
* Human-readable message. Clients may log it but must not branch on it.
|
|
850
850
|
* @public
|
|
851
851
|
*/
|
|
852
|
-
error: string
|
|
852
|
+
error: string;
|
|
853
853
|
/**
|
|
854
854
|
* Stable machine code in UPPER_SNAKE_CASE (for example `BAD_REQUEST`, `NOT_FOUND`,
|
|
855
855
|
* `MATCHING_PROFILE_INCOMPLETE`). Clients branch on this. Errors API Gateway answers itself
|
|
@@ -858,7 +858,7 @@ export declare class ConflictError extends __BaseException {
|
|
|
858
858
|
* `INTEGRATION_TIMEOUT`.
|
|
859
859
|
* @public
|
|
860
860
|
*/
|
|
861
|
-
code: string
|
|
861
|
+
code: string;
|
|
862
862
|
/**
|
|
863
863
|
* Request id to quote to support, when the service has one.
|
|
864
864
|
* @public
|
|
@@ -965,20 +965,20 @@ export interface GetChatSettingsResponse {
|
|
|
965
965
|
* optional so the same shape serves partial updates; a GET response always populates every member.
|
|
966
966
|
* @public
|
|
967
967
|
*/
|
|
968
|
-
settings: ChatSettings
|
|
968
|
+
settings: ChatSettings;
|
|
969
969
|
}
|
|
970
970
|
/**
|
|
971
971
|
* One stored way to recover an epoch's private key.
|
|
972
972
|
* @public
|
|
973
973
|
*/
|
|
974
974
|
export interface AhkWrap {
|
|
975
|
-
epoch: number
|
|
975
|
+
epoch: number;
|
|
976
976
|
/**
|
|
977
977
|
* `ESCROW`, `PRF` or `DEVICE`.
|
|
978
978
|
* @public
|
|
979
979
|
*/
|
|
980
|
-
method: string
|
|
981
|
-
wrapId: string
|
|
980
|
+
method: string;
|
|
981
|
+
wrapId: string;
|
|
982
982
|
/**
|
|
983
983
|
* The encrypted private key. Absent for `ESCROW`, which carries no ciphertext.
|
|
984
984
|
* @public
|
|
@@ -988,7 +988,7 @@ export interface AhkWrap {
|
|
|
988
988
|
* Epoch millis.
|
|
989
989
|
* @public
|
|
990
990
|
*/
|
|
991
|
-
createdAt: number
|
|
991
|
+
createdAt: number;
|
|
992
992
|
}
|
|
993
993
|
/**
|
|
994
994
|
* @public
|
|
@@ -998,7 +998,7 @@ export interface HistoryState {
|
|
|
998
998
|
* Every epoch of the account.
|
|
999
999
|
* @public
|
|
1000
1000
|
*/
|
|
1001
|
-
epochs: (HistoryEpoch)[]
|
|
1001
|
+
epochs: (HistoryEpoch)[];
|
|
1002
1002
|
/**
|
|
1003
1003
|
* The highest epoch. Absent when there is none.
|
|
1004
1004
|
* @public
|
|
@@ -1014,24 +1014,24 @@ export interface HistoryState {
|
|
|
1014
1014
|
* @public
|
|
1015
1015
|
*/
|
|
1016
1016
|
export interface GetParticipantRegistryRequest {
|
|
1017
|
-
userId: string
|
|
1017
|
+
userId: string;
|
|
1018
1018
|
/**
|
|
1019
1019
|
* The match the caller shares with the target user; used to authorize the read.
|
|
1020
1020
|
* @public
|
|
1021
1021
|
*/
|
|
1022
|
-
matchId: string
|
|
1022
|
+
matchId: string;
|
|
1023
1023
|
}
|
|
1024
1024
|
/**
|
|
1025
1025
|
* Immutable per-account history key. Registered first-write-wins and never overwritten.
|
|
1026
1026
|
* @public
|
|
1027
1027
|
*/
|
|
1028
1028
|
export interface AccountHistoryKey {
|
|
1029
|
-
keyId: string
|
|
1029
|
+
keyId: string;
|
|
1030
1030
|
/**
|
|
1031
1031
|
* A device long-term public key, SPKI DER encoded then base64 (standard or URL-safe alphabet).
|
|
1032
1032
|
* @public
|
|
1033
1033
|
*/
|
|
1034
|
-
publicKey: string
|
|
1034
|
+
publicKey: string;
|
|
1035
1035
|
}
|
|
1036
1036
|
/**
|
|
1037
1037
|
* @public
|
|
@@ -1054,17 +1054,17 @@ export interface Device {
|
|
|
1054
1054
|
* UUID-ish opaque device identifier minted by the client, bounded to 64 chars.
|
|
1055
1055
|
* @public
|
|
1056
1056
|
*/
|
|
1057
|
-
deviceId: string
|
|
1057
|
+
deviceId: string;
|
|
1058
1058
|
/**
|
|
1059
1059
|
* A device long-term public key, SPKI DER encoded then base64 (standard or URL-safe alphabet).
|
|
1060
1060
|
* @public
|
|
1061
1061
|
*/
|
|
1062
|
-
publicKey: string
|
|
1062
|
+
publicKey: string;
|
|
1063
1063
|
/**
|
|
1064
1064
|
* Client platform the device runs on.
|
|
1065
1065
|
* @public
|
|
1066
1066
|
*/
|
|
1067
|
-
platform: Platform
|
|
1067
|
+
platform: Platform;
|
|
1068
1068
|
/**
|
|
1069
1069
|
* Human-friendly device label shown in the "your devices" UI.
|
|
1070
1070
|
* @public
|
|
@@ -1074,29 +1074,29 @@ export interface Device {
|
|
|
1074
1074
|
* Highest E2EE envelope/wire version this device understands. Bumped as the protocol evolves.
|
|
1075
1075
|
* @public
|
|
1076
1076
|
*/
|
|
1077
|
-
maxEnvelopeVersion: number
|
|
1077
|
+
maxEnvelopeVersion: number;
|
|
1078
1078
|
/**
|
|
1079
1079
|
* Epoch-millis the device was first registered.
|
|
1080
1080
|
* @public
|
|
1081
1081
|
*/
|
|
1082
|
-
createdAt: number
|
|
1082
|
+
createdAt: number;
|
|
1083
1083
|
/**
|
|
1084
1084
|
* Epoch-millis the device was last seen (updated on every re-register).
|
|
1085
1085
|
* @public
|
|
1086
1086
|
*/
|
|
1087
|
-
lastSeenAt: number
|
|
1087
|
+
lastSeenAt: number;
|
|
1088
1088
|
/**
|
|
1089
1089
|
* True for the most recently registered device of the user.
|
|
1090
1090
|
* @public
|
|
1091
1091
|
*/
|
|
1092
|
-
current: boolean
|
|
1092
|
+
current: boolean;
|
|
1093
1093
|
}
|
|
1094
1094
|
/**
|
|
1095
1095
|
* @public
|
|
1096
1096
|
*/
|
|
1097
1097
|
export interface GetParticipantRegistryResponse {
|
|
1098
|
-
userId: string
|
|
1099
|
-
devices: (Device)[]
|
|
1098
|
+
userId: string;
|
|
1099
|
+
devices: (Device)[];
|
|
1100
1100
|
/**
|
|
1101
1101
|
* Immutable per-account history key. Registered first-write-wins and never overwritten.
|
|
1102
1102
|
* @public
|
|
@@ -1112,7 +1112,7 @@ export interface ListMyDevicesRequest {
|
|
|
1112
1112
|
* @public
|
|
1113
1113
|
*/
|
|
1114
1114
|
export interface ListMyDevicesResponse {
|
|
1115
|
-
devices: (Device)[]
|
|
1115
|
+
devices: (Device)[];
|
|
1116
1116
|
/**
|
|
1117
1117
|
* Immutable per-account history key. Registered first-write-wins and never overwritten.
|
|
1118
1118
|
* @public
|
|
@@ -1123,9 +1123,9 @@ export interface ListMyDevicesResponse {
|
|
|
1123
1123
|
* @public
|
|
1124
1124
|
*/
|
|
1125
1125
|
export interface PutHistoryWrapRequest {
|
|
1126
|
-
epoch: number
|
|
1127
|
-
method: string
|
|
1128
|
-
wrapId: string
|
|
1126
|
+
epoch: number;
|
|
1127
|
+
method: string;
|
|
1128
|
+
wrapId: string;
|
|
1129
1129
|
wrappedKey?: string | undefined;
|
|
1130
1130
|
}
|
|
1131
1131
|
/**
|
|
@@ -1136,7 +1136,7 @@ export interface PutHistoryWrapResponse {
|
|
|
1136
1136
|
* The stored wrap. A single wrap despite the plural name.
|
|
1137
1137
|
* @public
|
|
1138
1138
|
*/
|
|
1139
|
-
wraps: AhkWrap
|
|
1139
|
+
wraps: AhkWrap;
|
|
1140
1140
|
}
|
|
1141
1141
|
/**
|
|
1142
1142
|
* 409 `DEVICE_LIMIT`: registering a new device would exceed the per-user active-device cap.
|
|
@@ -1149,7 +1149,7 @@ export declare class DeviceLimitError extends __BaseException {
|
|
|
1149
1149
|
* Human-readable message. Clients may log it but must not branch on it.
|
|
1150
1150
|
* @public
|
|
1151
1151
|
*/
|
|
1152
|
-
error: string
|
|
1152
|
+
error: string;
|
|
1153
1153
|
/**
|
|
1154
1154
|
* Stable machine code in UPPER_SNAKE_CASE (for example `BAD_REQUEST`, `NOT_FOUND`,
|
|
1155
1155
|
* `MATCHING_PROFILE_INCOMPLETE`). Clients branch on this. Errors API Gateway answers itself
|
|
@@ -1158,7 +1158,7 @@ export declare class DeviceLimitError extends __BaseException {
|
|
|
1158
1158
|
* `INTEGRATION_TIMEOUT`.
|
|
1159
1159
|
* @public
|
|
1160
1160
|
*/
|
|
1161
|
-
code: string
|
|
1161
|
+
code: string;
|
|
1162
1162
|
/**
|
|
1163
1163
|
* Request id to quote to support, when the service has one.
|
|
1164
1164
|
* @public
|
|
@@ -1182,17 +1182,17 @@ export interface RegisterDeviceRequest {
|
|
|
1182
1182
|
* UUID-ish opaque device identifier minted by the client, bounded to 64 chars.
|
|
1183
1183
|
* @public
|
|
1184
1184
|
*/
|
|
1185
|
-
deviceId: string
|
|
1185
|
+
deviceId: string;
|
|
1186
1186
|
/**
|
|
1187
1187
|
* A device long-term public key, SPKI DER encoded then base64 (standard or URL-safe alphabet).
|
|
1188
1188
|
* @public
|
|
1189
1189
|
*/
|
|
1190
|
-
publicKey: string
|
|
1190
|
+
publicKey: string;
|
|
1191
1191
|
/**
|
|
1192
1192
|
* Client platform the device runs on.
|
|
1193
1193
|
* @public
|
|
1194
1194
|
*/
|
|
1195
|
-
platform: Platform
|
|
1195
|
+
platform: Platform;
|
|
1196
1196
|
/**
|
|
1197
1197
|
* Human-friendly device label shown in the "your devices" UI.
|
|
1198
1198
|
* @public
|
|
@@ -1202,13 +1202,13 @@ export interface RegisterDeviceRequest {
|
|
|
1202
1202
|
* Highest E2EE envelope/wire version this device understands. Bumped as the protocol evolves.
|
|
1203
1203
|
* @public
|
|
1204
1204
|
*/
|
|
1205
|
-
maxEnvelopeVersion: number
|
|
1205
|
+
maxEnvelopeVersion: number;
|
|
1206
1206
|
}
|
|
1207
1207
|
/**
|
|
1208
1208
|
* @public
|
|
1209
1209
|
*/
|
|
1210
1210
|
export interface RegisterDeviceResponse {
|
|
1211
|
-
device: Device
|
|
1211
|
+
device: Device;
|
|
1212
1212
|
/**
|
|
1213
1213
|
* The account's active history key (public half). Absent while the account has none.
|
|
1214
1214
|
* @public
|
|
@@ -1235,18 +1235,18 @@ export interface RegisterPushTokenRequest {
|
|
|
1235
1235
|
* UUID-ish opaque device identifier minted by the client, bounded to 64 chars.
|
|
1236
1236
|
* @public
|
|
1237
1237
|
*/
|
|
1238
|
-
deviceId: string
|
|
1238
|
+
deviceId: string;
|
|
1239
1239
|
/**
|
|
1240
1240
|
* The APNs device token or FCM registration token, as issued by the platform.
|
|
1241
1241
|
* @public
|
|
1242
1242
|
*/
|
|
1243
|
-
token: string
|
|
1243
|
+
token: string;
|
|
1244
1244
|
/**
|
|
1245
1245
|
* Which push service issued the token. Decides which SNS platform application the endpoint is
|
|
1246
1246
|
* created against, so a wrong value means the push silently never arrives.
|
|
1247
1247
|
* @public
|
|
1248
1248
|
*/
|
|
1249
|
-
platform: Platform
|
|
1249
|
+
platform: Platform;
|
|
1250
1250
|
/**
|
|
1251
1251
|
* `ALERT` (default): an ordinary APNs/FCM token for notifications. `VOIP`: an iOS PushKit token,
|
|
1252
1252
|
* used ONLY to ring incoming calls and stored separately (`VOIP#<deviceId>`), because iOS kills an
|
|
@@ -1263,14 +1263,14 @@ export interface RegisterPushTokenResponse {
|
|
|
1263
1263
|
* UUID-ish opaque device identifier minted by the client, bounded to 64 chars.
|
|
1264
1264
|
* @public
|
|
1265
1265
|
*/
|
|
1266
|
-
deviceId: string
|
|
1266
|
+
deviceId: string;
|
|
1267
1267
|
/**
|
|
1268
1268
|
* True once the token is stored. Deliberately does NOT report whether an SNS endpoint was created:
|
|
1269
1269
|
* endpoint creation happens at delivery time, so claiming it here would assert something the
|
|
1270
1270
|
* registration call has not verified.
|
|
1271
1271
|
* @public
|
|
1272
1272
|
*/
|
|
1273
|
-
registered: boolean
|
|
1273
|
+
registered: boolean;
|
|
1274
1274
|
}
|
|
1275
1275
|
/**
|
|
1276
1276
|
* @public
|
|
@@ -1280,7 +1280,7 @@ export interface RevokeDeviceRequest {
|
|
|
1280
1280
|
* UUID-ish opaque device identifier minted by the client, bounded to 64 chars.
|
|
1281
1281
|
* @public
|
|
1282
1282
|
*/
|
|
1283
|
-
deviceId: string
|
|
1283
|
+
deviceId: string;
|
|
1284
1284
|
}
|
|
1285
1285
|
/**
|
|
1286
1286
|
* @public
|
|
@@ -1290,29 +1290,29 @@ export interface RevokeDeviceResponse {
|
|
|
1290
1290
|
* UUID-ish opaque device identifier minted by the client, bounded to 64 chars.
|
|
1291
1291
|
* @public
|
|
1292
1292
|
*/
|
|
1293
|
-
deviceId: string
|
|
1294
|
-
revoked: boolean
|
|
1293
|
+
deviceId: string;
|
|
1294
|
+
revoked: boolean;
|
|
1295
1295
|
}
|
|
1296
1296
|
/**
|
|
1297
1297
|
* @public
|
|
1298
1298
|
*/
|
|
1299
1299
|
export interface RevokeHistoryWrapRequest {
|
|
1300
|
-
epoch: number
|
|
1301
|
-
method: string
|
|
1302
|
-
wrapId: string
|
|
1300
|
+
epoch: number;
|
|
1301
|
+
method: string;
|
|
1302
|
+
wrapId: string;
|
|
1303
1303
|
}
|
|
1304
1304
|
/**
|
|
1305
1305
|
* @public
|
|
1306
1306
|
*/
|
|
1307
1307
|
export interface RevokeHistoryWrapResponse {
|
|
1308
|
-
epoch: number
|
|
1309
|
-
method: string
|
|
1310
|
-
wrapId: string
|
|
1308
|
+
epoch: number;
|
|
1309
|
+
method: string;
|
|
1310
|
+
wrapId: string;
|
|
1311
1311
|
/**
|
|
1312
1312
|
* Always true on a 200.
|
|
1313
1313
|
* @public
|
|
1314
1314
|
*/
|
|
1315
|
-
revoked: boolean
|
|
1315
|
+
revoked: boolean;
|
|
1316
1316
|
}
|
|
1317
1317
|
/**
|
|
1318
1318
|
* @public
|
|
@@ -1352,20 +1352,20 @@ export interface UpdateChatSettingsResponse {
|
|
|
1352
1352
|
* optional so the same shape serves partial updates; a GET response always populates every member.
|
|
1353
1353
|
* @public
|
|
1354
1354
|
*/
|
|
1355
|
-
settings: ChatSettings
|
|
1355
|
+
settings: ChatSettings;
|
|
1356
1356
|
}
|
|
1357
1357
|
/**
|
|
1358
1358
|
* @public
|
|
1359
1359
|
*/
|
|
1360
1360
|
export interface AuthSocialRequest {
|
|
1361
|
-
provider: string
|
|
1362
|
-
token: string
|
|
1361
|
+
provider: string;
|
|
1362
|
+
token: string;
|
|
1363
1363
|
}
|
|
1364
1364
|
/**
|
|
1365
1365
|
* @public
|
|
1366
1366
|
*/
|
|
1367
1367
|
export interface AuthSocialResponse {
|
|
1368
|
-
status: string
|
|
1368
|
+
status: string;
|
|
1369
1369
|
userId?: string | undefined;
|
|
1370
1370
|
isNewUser?: boolean | undefined;
|
|
1371
1371
|
}
|
|
@@ -1373,7 +1373,7 @@ export interface AuthSocialResponse {
|
|
|
1373
1373
|
* @public
|
|
1374
1374
|
*/
|
|
1375
1375
|
export interface CheckUsernameAvailabilityRequest {
|
|
1376
|
-
username: string
|
|
1376
|
+
username: string;
|
|
1377
1377
|
}
|
|
1378
1378
|
/**
|
|
1379
1379
|
* @public
|
|
@@ -1397,8 +1397,8 @@ export interface CheckUsernameAvailabilityResponse {
|
|
|
1397
1397
|
* The handle that was checked, as submitted.
|
|
1398
1398
|
* @public
|
|
1399
1399
|
*/
|
|
1400
|
-
username: string
|
|
1401
|
-
status: UsernameAvailability
|
|
1400
|
+
username: string;
|
|
1401
|
+
status: UsernameAvailability;
|
|
1402
1402
|
/**
|
|
1403
1403
|
* Why an `INVALID` handle cannot be used. Absent for every other status.
|
|
1404
1404
|
* @public
|
|
@@ -1414,7 +1414,7 @@ export interface CreateAdminInviteRequest {
|
|
|
1414
1414
|
* @public
|
|
1415
1415
|
*/
|
|
1416
1416
|
phoneNumber?: string | undefined;
|
|
1417
|
-
referrerId: string
|
|
1417
|
+
referrerId: string;
|
|
1418
1418
|
/**
|
|
1419
1419
|
* Optional invite lifetime in days. Defaults to 14 when omitted; bounded to 1..30.
|
|
1420
1420
|
* @public
|
|
@@ -1425,30 +1425,30 @@ export interface CreateAdminInviteRequest {
|
|
|
1425
1425
|
* @public
|
|
1426
1426
|
*/
|
|
1427
1427
|
export interface CreateAdminInviteResponse {
|
|
1428
|
-
inviteCode: string
|
|
1429
|
-
expiresAt: number
|
|
1430
|
-
maxUses: number
|
|
1428
|
+
inviteCode: string;
|
|
1429
|
+
expiresAt: number;
|
|
1430
|
+
maxUses: number;
|
|
1431
1431
|
}
|
|
1432
1432
|
/**
|
|
1433
1433
|
* @public
|
|
1434
1434
|
*/
|
|
1435
1435
|
export interface GenerateInviteRequest {
|
|
1436
|
-
referrerId: string
|
|
1436
|
+
referrerId: string;
|
|
1437
1437
|
maxUses?: number | undefined;
|
|
1438
1438
|
}
|
|
1439
1439
|
/**
|
|
1440
1440
|
* @public
|
|
1441
1441
|
*/
|
|
1442
1442
|
export interface GenerateInviteResponse {
|
|
1443
|
-
inviteCode: string
|
|
1444
|
-
expiresAt: number
|
|
1445
|
-
maxUses: number
|
|
1443
|
+
inviteCode: string;
|
|
1444
|
+
expiresAt: number;
|
|
1445
|
+
maxUses: number;
|
|
1446
1446
|
}
|
|
1447
1447
|
/**
|
|
1448
1448
|
* @public
|
|
1449
1449
|
*/
|
|
1450
1450
|
export interface GetAccountStateRequest {
|
|
1451
|
-
userId: string
|
|
1451
|
+
userId: string;
|
|
1452
1452
|
}
|
|
1453
1453
|
/**
|
|
1454
1454
|
* @public
|
|
@@ -1474,13 +1474,13 @@ export interface GetAccountStateResponse {
|
|
|
1474
1474
|
* the `AccountStateChanged` event.
|
|
1475
1475
|
* @public
|
|
1476
1476
|
*/
|
|
1477
|
-
state: AccountState
|
|
1477
|
+
state: AccountState;
|
|
1478
1478
|
/**
|
|
1479
1479
|
* Epoch ms the state expires; absent for ACTIVE and BANNED.
|
|
1480
1480
|
* @public
|
|
1481
1481
|
*/
|
|
1482
1482
|
until?: number | undefined;
|
|
1483
|
-
version: number
|
|
1483
|
+
version: number;
|
|
1484
1484
|
/**
|
|
1485
1485
|
* The reason code for the current state; absent when ACTIVE.
|
|
1486
1486
|
* @public
|
|
@@ -1491,7 +1491,7 @@ export interface GetAccountStateResponse {
|
|
|
1491
1491
|
* @public
|
|
1492
1492
|
*/
|
|
1493
1493
|
export interface GetAdminPhoneStatusRequest {
|
|
1494
|
-
phoneNumber: string
|
|
1494
|
+
phoneNumber: string;
|
|
1495
1495
|
}
|
|
1496
1496
|
/**
|
|
1497
1497
|
* @public
|
|
@@ -1501,13 +1501,13 @@ export interface GetAdminPhoneStatusResponse {
|
|
|
1501
1501
|
* True when the phone is bound to an existing account OR claimed by an in-progress registration.
|
|
1502
1502
|
* @public
|
|
1503
1503
|
*/
|
|
1504
|
-
registered: boolean
|
|
1504
|
+
registered: boolean;
|
|
1505
1505
|
}
|
|
1506
1506
|
/**
|
|
1507
1507
|
* @public
|
|
1508
1508
|
*/
|
|
1509
1509
|
export interface GetCredentialReadinessRequest {
|
|
1510
|
-
userId: string
|
|
1510
|
+
userId: string;
|
|
1511
1511
|
}
|
|
1512
1512
|
/**
|
|
1513
1513
|
* @public
|
|
@@ -1531,25 +1531,25 @@ export interface GetCredentialReadinessResponse {
|
|
|
1531
1531
|
* True only when EVERY portable credential the profile advertises is live in Cognito.
|
|
1532
1532
|
* @public
|
|
1533
1533
|
*/
|
|
1534
|
-
ready: boolean
|
|
1534
|
+
ready: boolean;
|
|
1535
1535
|
/**
|
|
1536
1536
|
* Empty when ready. Machine-readable so the caller can explain the specific gap.
|
|
1537
1537
|
* @public
|
|
1538
1538
|
*/
|
|
1539
|
-
gaps: (CredentialGap)[]
|
|
1539
|
+
gaps: (CredentialGap)[];
|
|
1540
1540
|
}
|
|
1541
1541
|
/**
|
|
1542
1542
|
* @public
|
|
1543
1543
|
*/
|
|
1544
1544
|
export interface GetInviteEdgesRequest {
|
|
1545
|
-
userId: string
|
|
1545
|
+
userId: string;
|
|
1546
1546
|
nextToken?: string | undefined;
|
|
1547
1547
|
}
|
|
1548
1548
|
/**
|
|
1549
1549
|
* @public
|
|
1550
1550
|
*/
|
|
1551
1551
|
export interface GetInviteEdgesResponse {
|
|
1552
|
-
userId: string
|
|
1552
|
+
userId: string;
|
|
1553
1553
|
/**
|
|
1554
1554
|
* The member who invited this one, if any.
|
|
1555
1555
|
* @public
|
|
@@ -1559,26 +1559,26 @@ export interface GetInviteEdgesResponse {
|
|
|
1559
1559
|
* Members this one invited (one page).
|
|
1560
1560
|
* @public
|
|
1561
1561
|
*/
|
|
1562
|
-
invitees: (string)[]
|
|
1562
|
+
invitees: (string)[];
|
|
1563
1563
|
nextToken?: string | undefined;
|
|
1564
1564
|
}
|
|
1565
1565
|
/**
|
|
1566
1566
|
* @public
|
|
1567
1567
|
*/
|
|
1568
1568
|
export interface GetPreservationHoldRequest {
|
|
1569
|
-
userId: string
|
|
1569
|
+
userId: string;
|
|
1570
1570
|
}
|
|
1571
1571
|
/**
|
|
1572
1572
|
* @public
|
|
1573
1573
|
*/
|
|
1574
1574
|
export interface GetPreservationHoldResponse {
|
|
1575
|
-
active: boolean
|
|
1575
|
+
active: boolean;
|
|
1576
1576
|
/**
|
|
1577
1577
|
* Epoch ms the hold expires; absent when inactive.
|
|
1578
1578
|
* @public
|
|
1579
1579
|
*/
|
|
1580
1580
|
until?: number | undefined;
|
|
1581
|
-
version: number
|
|
1581
|
+
version: number;
|
|
1582
1582
|
/**
|
|
1583
1583
|
* The reason code for the current hold; absent when inactive.
|
|
1584
1584
|
* @public
|
|
@@ -1611,13 +1611,13 @@ export interface GetPreservationHoldResponse {
|
|
|
1611
1611
|
* @public
|
|
1612
1612
|
*/
|
|
1613
1613
|
export interface GetUserRequest {
|
|
1614
|
-
userId: string
|
|
1614
|
+
userId: string;
|
|
1615
1615
|
}
|
|
1616
1616
|
/**
|
|
1617
1617
|
* @public
|
|
1618
1618
|
*/
|
|
1619
1619
|
export interface UserResponse {
|
|
1620
|
-
userId: string
|
|
1620
|
+
userId: string;
|
|
1621
1621
|
email?: string | undefined;
|
|
1622
1622
|
phoneNumber?: string | undefined;
|
|
1623
1623
|
displayName?: string | undefined;
|
|
@@ -1637,53 +1637,53 @@ export interface UserResponse {
|
|
|
1637
1637
|
* @public
|
|
1638
1638
|
*/
|
|
1639
1639
|
export interface GetUserByEmailRequest {
|
|
1640
|
-
email: string
|
|
1640
|
+
email: string;
|
|
1641
1641
|
}
|
|
1642
1642
|
/**
|
|
1643
1643
|
* @public
|
|
1644
1644
|
*/
|
|
1645
1645
|
export interface GetUserIdByUsernameRequest {
|
|
1646
|
-
username: string
|
|
1646
|
+
username: string;
|
|
1647
1647
|
}
|
|
1648
1648
|
/**
|
|
1649
1649
|
* @public
|
|
1650
1650
|
*/
|
|
1651
1651
|
export interface GetUserIdByUsernameResponse {
|
|
1652
|
-
userId: string
|
|
1652
|
+
userId: string;
|
|
1653
1653
|
}
|
|
1654
1654
|
/**
|
|
1655
1655
|
* @public
|
|
1656
1656
|
*/
|
|
1657
1657
|
export interface LinkEmailRequest {
|
|
1658
|
-
email: string
|
|
1659
|
-
otp: string
|
|
1658
|
+
email: string;
|
|
1659
|
+
otp: string;
|
|
1660
1660
|
}
|
|
1661
1661
|
/**
|
|
1662
1662
|
* @public
|
|
1663
1663
|
*/
|
|
1664
1664
|
export interface LinkEmailResponse {
|
|
1665
|
-
status: string
|
|
1665
|
+
status: string;
|
|
1666
1666
|
}
|
|
1667
1667
|
/**
|
|
1668
1668
|
* @public
|
|
1669
1669
|
*/
|
|
1670
1670
|
export interface LinkSocialRequest {
|
|
1671
|
-
identityToken: string
|
|
1672
|
-
provider: string
|
|
1671
|
+
identityToken: string;
|
|
1672
|
+
provider: string;
|
|
1673
1673
|
}
|
|
1674
1674
|
/**
|
|
1675
1675
|
* @public
|
|
1676
1676
|
*/
|
|
1677
1677
|
export interface LinkSocialResponse {
|
|
1678
|
-
status: string
|
|
1678
|
+
status: string;
|
|
1679
1679
|
}
|
|
1680
1680
|
/**
|
|
1681
1681
|
* @public
|
|
1682
1682
|
*/
|
|
1683
1683
|
export interface RegisterPhoneRequest {
|
|
1684
|
-
phoneNumber: string
|
|
1685
|
-
otp: string
|
|
1686
|
-
inviteCode: string
|
|
1684
|
+
phoneNumber: string;
|
|
1685
|
+
otp: string;
|
|
1686
|
+
inviteCode: string;
|
|
1687
1687
|
displayName?: string | undefined;
|
|
1688
1688
|
/**
|
|
1689
1689
|
* Optional user-chosen handle. When omitted (or blank) a random handle is assigned; a
|
|
@@ -1696,33 +1696,33 @@ export interface RegisterPhoneRequest {
|
|
|
1696
1696
|
* @public
|
|
1697
1697
|
*/
|
|
1698
1698
|
export interface RegisterPhoneResponse {
|
|
1699
|
-
userId: string
|
|
1700
|
-
status: string
|
|
1699
|
+
userId: string;
|
|
1700
|
+
status: string;
|
|
1701
1701
|
}
|
|
1702
1702
|
/**
|
|
1703
1703
|
* @public
|
|
1704
1704
|
*/
|
|
1705
1705
|
export interface RequestEmailOtpRequest {
|
|
1706
|
-
email: string
|
|
1706
|
+
email: string;
|
|
1707
1707
|
password?: string | undefined;
|
|
1708
1708
|
}
|
|
1709
1709
|
/**
|
|
1710
1710
|
* @public
|
|
1711
1711
|
*/
|
|
1712
1712
|
export interface RequestEmailOtpResponse {
|
|
1713
|
-
status: string
|
|
1713
|
+
status: string;
|
|
1714
1714
|
}
|
|
1715
1715
|
/**
|
|
1716
1716
|
* @public
|
|
1717
1717
|
*/
|
|
1718
1718
|
export interface RequestPhoneOtpRequest {
|
|
1719
|
-
phoneNumber: string
|
|
1719
|
+
phoneNumber: string;
|
|
1720
1720
|
}
|
|
1721
1721
|
/**
|
|
1722
1722
|
* @public
|
|
1723
1723
|
*/
|
|
1724
1724
|
export interface RequestPhoneOtpResponse {
|
|
1725
|
-
status: string
|
|
1725
|
+
status: string;
|
|
1726
1726
|
}
|
|
1727
1727
|
/**
|
|
1728
1728
|
* Requests an OTP to be sent to a new phone number to prove ownership before updating a user's phone number.
|
|
@@ -1730,19 +1730,19 @@ export interface RequestPhoneOtpResponse {
|
|
|
1730
1730
|
* @public
|
|
1731
1731
|
*/
|
|
1732
1732
|
export interface RequestPhoneUpdateOtpRequest {
|
|
1733
|
-
phoneNumber: string
|
|
1733
|
+
phoneNumber: string;
|
|
1734
1734
|
}
|
|
1735
1735
|
/**
|
|
1736
1736
|
* @public
|
|
1737
1737
|
*/
|
|
1738
1738
|
export interface RequestPhoneUpdateOtpResponse {
|
|
1739
|
-
status: string
|
|
1739
|
+
status: string;
|
|
1740
1740
|
}
|
|
1741
1741
|
/**
|
|
1742
1742
|
* @public
|
|
1743
1743
|
*/
|
|
1744
1744
|
export interface RevokeUserAccessRequest {
|
|
1745
|
-
userId: string
|
|
1745
|
+
userId: string;
|
|
1746
1746
|
}
|
|
1747
1747
|
/**
|
|
1748
1748
|
* @public
|
|
@@ -1752,43 +1752,43 @@ export interface RevokeUserAccessResponse {
|
|
|
1752
1752
|
* Machine-readable outcome code (e.g. REVOKED). Never PII.
|
|
1753
1753
|
* @public
|
|
1754
1754
|
*/
|
|
1755
|
-
status: string
|
|
1755
|
+
status: string;
|
|
1756
1756
|
}
|
|
1757
1757
|
/**
|
|
1758
1758
|
* @public
|
|
1759
1759
|
*/
|
|
1760
1760
|
export interface SendAdminLinkOtpRequest {
|
|
1761
|
-
userId: string
|
|
1761
|
+
userId: string;
|
|
1762
1762
|
}
|
|
1763
1763
|
/**
|
|
1764
1764
|
* @public
|
|
1765
1765
|
*/
|
|
1766
1766
|
export interface SendAdminLinkOtpResponse {
|
|
1767
|
-
status: string
|
|
1767
|
+
status: string;
|
|
1768
1768
|
/**
|
|
1769
1769
|
* The user's phone with only a short prefix and suffix shown, e.g. \{@code +91•••••••210\}. Never
|
|
1770
1770
|
* the full number.
|
|
1771
1771
|
* @public
|
|
1772
1772
|
*/
|
|
1773
|
-
maskedPhone: string
|
|
1773
|
+
maskedPhone: string;
|
|
1774
1774
|
}
|
|
1775
1775
|
/**
|
|
1776
1776
|
* @public
|
|
1777
1777
|
*/
|
|
1778
1778
|
export interface SetAccountStateRequest {
|
|
1779
|
-
userId: string
|
|
1779
|
+
userId: string;
|
|
1780
1780
|
/**
|
|
1781
1781
|
* The moderation account state a member can be in. Absent/`ACTIVE` means no restriction. Owned by
|
|
1782
1782
|
* Identity (sign-in and token refresh enforce it directly); Matching and the admin portal consume
|
|
1783
1783
|
* the `AccountStateChanged` event.
|
|
1784
1784
|
* @public
|
|
1785
1785
|
*/
|
|
1786
|
-
state: AccountState
|
|
1786
|
+
state: AccountState;
|
|
1787
1787
|
/**
|
|
1788
1788
|
* Machine-readable reason code (never free text / PII).
|
|
1789
1789
|
* @public
|
|
1790
1790
|
*/
|
|
1791
|
-
reasonCode: string
|
|
1791
|
+
reasonCode: string;
|
|
1792
1792
|
/**
|
|
1793
1793
|
* Epoch ms the RESTRICTED/SUSPENDED state expires. Required for those states; rejected for BANNED.
|
|
1794
1794
|
* @public
|
|
@@ -1798,7 +1798,7 @@ export interface SetAccountStateRequest {
|
|
|
1798
1798
|
* The admin actor id taking the action (audit).
|
|
1799
1799
|
* @public
|
|
1800
1800
|
*/
|
|
1801
|
-
actor: string
|
|
1801
|
+
actor: string;
|
|
1802
1802
|
/**
|
|
1803
1803
|
* Optional optimistic-concurrency token from GetAccountState; a mismatch returns 409.
|
|
1804
1804
|
* @public
|
|
@@ -1815,41 +1815,41 @@ export interface SetAccountStateResponse {
|
|
|
1815
1815
|
* the `AccountStateChanged` event.
|
|
1816
1816
|
* @public
|
|
1817
1817
|
*/
|
|
1818
|
-
state: AccountState
|
|
1818
|
+
state: AccountState;
|
|
1819
1819
|
/**
|
|
1820
1820
|
* Epoch ms the state expires; absent for ACTIVE and BANNED.
|
|
1821
1821
|
* @public
|
|
1822
1822
|
*/
|
|
1823
1823
|
until?: number | undefined;
|
|
1824
|
-
version: number
|
|
1824
|
+
version: number;
|
|
1825
1825
|
}
|
|
1826
1826
|
/**
|
|
1827
1827
|
* @public
|
|
1828
1828
|
*/
|
|
1829
1829
|
export interface SetPasswordRequest {
|
|
1830
|
-
password: string
|
|
1830
|
+
password: string;
|
|
1831
1831
|
}
|
|
1832
1832
|
/**
|
|
1833
1833
|
* @public
|
|
1834
1834
|
*/
|
|
1835
1835
|
export interface SetPasswordResponse {
|
|
1836
|
-
status: string
|
|
1836
|
+
status: string;
|
|
1837
1837
|
}
|
|
1838
1838
|
/**
|
|
1839
1839
|
* @public
|
|
1840
1840
|
*/
|
|
1841
1841
|
export interface SetPreservationHoldRequest {
|
|
1842
|
-
userId: string
|
|
1842
|
+
userId: string;
|
|
1843
1843
|
/**
|
|
1844
1844
|
* True to place/extend the hold; false to release it.
|
|
1845
1845
|
* @public
|
|
1846
1846
|
*/
|
|
1847
|
-
active: boolean
|
|
1847
|
+
active: boolean;
|
|
1848
1848
|
/**
|
|
1849
1849
|
* Machine-readable reason code: one of CHILD_SAFETY, LEGAL_REQUEST, OTHER_LEGAL (never free text).
|
|
1850
1850
|
* @public
|
|
1851
1851
|
*/
|
|
1852
|
-
reasonCode: string
|
|
1852
|
+
reasonCode: string;
|
|
1853
1853
|
/**
|
|
1854
1854
|
* Epoch ms the hold expires. Defaults to now + 180 days when activating; may only be extended
|
|
1855
1855
|
* forward. Ignored when releasing.
|
|
@@ -1860,7 +1860,7 @@ export interface SetPreservationHoldRequest {
|
|
|
1860
1860
|
* The admin actor id taking the action (audit).
|
|
1861
1861
|
* @public
|
|
1862
1862
|
*/
|
|
1863
|
-
actor: string
|
|
1863
|
+
actor: string;
|
|
1864
1864
|
/**
|
|
1865
1865
|
* Optional case reference for audit (e.g. an NCMEC/agency ticket id). Stored in Identity only;
|
|
1866
1866
|
* never travels in the PreservationHoldChanged event.
|
|
@@ -1877,13 +1877,13 @@ export interface SetPreservationHoldRequest {
|
|
|
1877
1877
|
* @public
|
|
1878
1878
|
*/
|
|
1879
1879
|
export interface SetPreservationHoldResponse {
|
|
1880
|
-
active: boolean
|
|
1880
|
+
active: boolean;
|
|
1881
1881
|
/**
|
|
1882
1882
|
* Epoch ms the hold expires; absent when released.
|
|
1883
1883
|
* @public
|
|
1884
1884
|
*/
|
|
1885
1885
|
until?: number | undefined;
|
|
1886
|
-
version: number
|
|
1886
|
+
version: number;
|
|
1887
1887
|
/**
|
|
1888
1888
|
* The reason code for the current hold; absent when released.
|
|
1889
1889
|
* @public
|
|
@@ -1894,13 +1894,13 @@ export interface SetPreservationHoldResponse {
|
|
|
1894
1894
|
* @public
|
|
1895
1895
|
*/
|
|
1896
1896
|
export interface UnlinkSocialRequest {
|
|
1897
|
-
provider: string
|
|
1897
|
+
provider: string;
|
|
1898
1898
|
}
|
|
1899
1899
|
/**
|
|
1900
1900
|
* @public
|
|
1901
1901
|
*/
|
|
1902
1902
|
export interface UnlinkSocialResponse {
|
|
1903
|
-
status: string
|
|
1903
|
+
status: string;
|
|
1904
1904
|
}
|
|
1905
1905
|
/**
|
|
1906
1906
|
* @public
|
|
@@ -1919,7 +1919,7 @@ export type SubscriptionTier = typeof SubscriptionTier[keyof typeof Subscription
|
|
|
1919
1919
|
* @public
|
|
1920
1920
|
*/
|
|
1921
1921
|
export interface UpdateEntitlementsRequest {
|
|
1922
|
-
userId: string
|
|
1922
|
+
userId: string;
|
|
1923
1923
|
/**
|
|
1924
1924
|
* A OneHook membership tier. The member values are the wire values persisted in Cognito
|
|
1925
1925
|
* (`custom:subscriptionTier`), DynamoDB and Postgres. Members are declared in ascending order
|
|
@@ -1927,7 +1927,7 @@ export interface UpdateEntitlementsRequest {
|
|
|
1927
1927
|
* treated as the lowest tier (Must) and raises the UnknownSubscriptionTier alarm.
|
|
1928
1928
|
* @public
|
|
1929
1929
|
*/
|
|
1930
|
-
subscriptionTier: SubscriptionTier
|
|
1930
|
+
subscriptionTier: SubscriptionTier;
|
|
1931
1931
|
/**
|
|
1932
1932
|
* Provenance of the entitlement decision (e.g. stripe / apple / google / sync). Advisory/audit.
|
|
1933
1933
|
* @public
|
|
@@ -1948,7 +1948,7 @@ export interface UpdateEntitlementsRequest {
|
|
|
1948
1948
|
* @public
|
|
1949
1949
|
*/
|
|
1950
1950
|
export interface UpdateEntitlementsResponse {
|
|
1951
|
-
status: string
|
|
1951
|
+
status: string;
|
|
1952
1952
|
/**
|
|
1953
1953
|
* A OneHook membership tier. The member values are the wire values persisted in Cognito
|
|
1954
1954
|
* (`custom:subscriptionTier`), DynamoDB and Postgres. Members are declared in ascending order
|
|
@@ -1956,14 +1956,14 @@ export interface UpdateEntitlementsResponse {
|
|
|
1956
1956
|
* treated as the lowest tier (Must) and raises the UnknownSubscriptionTier alarm.
|
|
1957
1957
|
* @public
|
|
1958
1958
|
*/
|
|
1959
|
-
subscriptionTier: SubscriptionTier
|
|
1959
|
+
subscriptionTier: SubscriptionTier;
|
|
1960
1960
|
}
|
|
1961
1961
|
/**
|
|
1962
1962
|
* @public
|
|
1963
1963
|
*/
|
|
1964
1964
|
export interface PhoneResponse {
|
|
1965
|
-
status: string
|
|
1966
|
-
phoneNumber: string
|
|
1965
|
+
status: string;
|
|
1966
|
+
phoneNumber: string;
|
|
1967
1967
|
}
|
|
1968
1968
|
/**
|
|
1969
1969
|
* Updates a user's phone number. This is step 2 of the 2-step phone number update process.
|
|
@@ -1971,12 +1971,12 @@ export interface PhoneResponse {
|
|
|
1971
1971
|
* @public
|
|
1972
1972
|
*/
|
|
1973
1973
|
export interface UpdatePhoneNumberRequest {
|
|
1974
|
-
phoneNumber: string
|
|
1974
|
+
phoneNumber: string;
|
|
1975
1975
|
/**
|
|
1976
1976
|
* The OTP sent to the new phone number.
|
|
1977
1977
|
* @public
|
|
1978
1978
|
*/
|
|
1979
|
-
otp: string
|
|
1979
|
+
otp: string;
|
|
1980
1980
|
}
|
|
1981
1981
|
/**
|
|
1982
1982
|
* Changes the authenticated caller's user-chosen handle. The new handle is claimed atomically and
|
|
@@ -1984,57 +1984,57 @@ export interface UpdatePhoneNumberRequest {
|
|
|
1984
1984
|
* @public
|
|
1985
1985
|
*/
|
|
1986
1986
|
export interface UpdateUsernameRequest {
|
|
1987
|
-
username: string
|
|
1987
|
+
username: string;
|
|
1988
1988
|
}
|
|
1989
1989
|
/**
|
|
1990
1990
|
* @public
|
|
1991
1991
|
*/
|
|
1992
1992
|
export interface UsernameResponse {
|
|
1993
|
-
status: string
|
|
1994
|
-
username: string
|
|
1993
|
+
status: string;
|
|
1994
|
+
username: string;
|
|
1995
1995
|
}
|
|
1996
1996
|
/**
|
|
1997
1997
|
* @public
|
|
1998
1998
|
*/
|
|
1999
1999
|
export interface ValidateInviteRequest {
|
|
2000
|
-
inviteCode: string
|
|
2000
|
+
inviteCode: string;
|
|
2001
2001
|
}
|
|
2002
2002
|
/**
|
|
2003
2003
|
* @public
|
|
2004
2004
|
*/
|
|
2005
2005
|
export interface ValidateInviteResponse {
|
|
2006
|
-
status: string
|
|
2006
|
+
status: string;
|
|
2007
2007
|
referrerId?: string | undefined;
|
|
2008
|
-
usedCount: number
|
|
2009
|
-
maxUses: number
|
|
2008
|
+
usedCount: number;
|
|
2009
|
+
maxUses: number;
|
|
2010
2010
|
}
|
|
2011
2011
|
/**
|
|
2012
2012
|
* @public
|
|
2013
2013
|
*/
|
|
2014
2014
|
export interface VerifyAdminLinkOtpRequest {
|
|
2015
|
-
userId: string
|
|
2016
|
-
code: string
|
|
2015
|
+
userId: string;
|
|
2016
|
+
code: string;
|
|
2017
2017
|
}
|
|
2018
2018
|
/**
|
|
2019
2019
|
* @public
|
|
2020
2020
|
*/
|
|
2021
2021
|
export interface VerifyAdminLinkOtpResponse {
|
|
2022
|
-
verified: boolean
|
|
2023
|
-
userId: string
|
|
2024
|
-
username: string
|
|
2022
|
+
verified: boolean;
|
|
2023
|
+
userId: string;
|
|
2024
|
+
username: string;
|
|
2025
2025
|
}
|
|
2026
2026
|
/**
|
|
2027
2027
|
* @public
|
|
2028
2028
|
*/
|
|
2029
2029
|
export interface ParameterMetadata {
|
|
2030
|
-
name: string
|
|
2031
|
-
description: string
|
|
2032
|
-
hypothesis: string
|
|
2033
|
-
tuningGuidance: string
|
|
2034
|
-
unit: string
|
|
2035
|
-
minValue: number
|
|
2036
|
-
maxValue: number
|
|
2037
|
-
defaultValue: number
|
|
2030
|
+
name: string;
|
|
2031
|
+
description: string;
|
|
2032
|
+
hypothesis: string;
|
|
2033
|
+
tuningGuidance: string;
|
|
2034
|
+
unit: string;
|
|
2035
|
+
minValue: number;
|
|
2036
|
+
maxValue: number;
|
|
2037
|
+
defaultValue: number;
|
|
2038
2038
|
}
|
|
2039
2039
|
/**
|
|
2040
2040
|
* An A/B experiment between policy variants. When enabled with an allocation, the allocation must sum
|
|
@@ -2042,9 +2042,9 @@ export interface ParameterMetadata {
|
|
|
2042
2042
|
* @public
|
|
2043
2043
|
*/
|
|
2044
2044
|
export interface ABExperiment {
|
|
2045
|
-
experimentId: string
|
|
2046
|
-
name: string
|
|
2047
|
-
description: string
|
|
2045
|
+
experimentId: string;
|
|
2046
|
+
name: string;
|
|
2047
|
+
description: string;
|
|
2048
2048
|
/**
|
|
2049
2049
|
* Default false.
|
|
2050
2050
|
* @public
|
|
@@ -2128,19 +2128,19 @@ export interface GetScoringPolicyResponse {
|
|
|
2128
2128
|
* The full policy document. Every member has a default, so `\{\}` is the calibrated baseline.
|
|
2129
2129
|
* @public
|
|
2130
2130
|
*/
|
|
2131
|
-
policy: ScoringPolicyConfig
|
|
2131
|
+
policy: ScoringPolicyConfig;
|
|
2132
2132
|
/**
|
|
2133
2133
|
* Keyed by the snake_case parameter name, e.g. `exposure_deficit_boost`.
|
|
2134
2134
|
* @public
|
|
2135
2135
|
*/
|
|
2136
|
-
metadata: Record<string, ParameterMetadata
|
|
2136
|
+
metadata: Record<string, ParameterMetadata>;
|
|
2137
2137
|
}
|
|
2138
2138
|
/**
|
|
2139
2139
|
* @public
|
|
2140
2140
|
*/
|
|
2141
2141
|
export interface SimulationScenario {
|
|
2142
|
-
viewerId: string
|
|
2143
|
-
targetId: string
|
|
2142
|
+
viewerId: string;
|
|
2143
|
+
targetId: string;
|
|
2144
2144
|
/**
|
|
2145
2145
|
* Default 3500.
|
|
2146
2146
|
* @public
|
|
@@ -2181,7 +2181,7 @@ export interface SimulationScenario {
|
|
|
2181
2181
|
* @public
|
|
2182
2182
|
*/
|
|
2183
2183
|
export interface SimulateScoringPolicyRequest {
|
|
2184
|
-
scenario: SimulationScenario
|
|
2184
|
+
scenario: SimulationScenario;
|
|
2185
2185
|
/**
|
|
2186
2186
|
* Parameter name (camelCase or snake_case) to value.
|
|
2187
2187
|
* @public
|
|
@@ -2196,15 +2196,15 @@ export interface SimulationOutput {
|
|
|
2196
2196
|
* The scenario as scored, with defaults filled in.
|
|
2197
2197
|
* @public
|
|
2198
2198
|
*/
|
|
2199
|
-
scenario: SimulationScenario
|
|
2200
|
-
baselineScore: number
|
|
2201
|
-
simulatedScore: number
|
|
2202
|
-
delta: number
|
|
2199
|
+
scenario: SimulationScenario;
|
|
2200
|
+
baselineScore: number;
|
|
2201
|
+
simulatedScore: number;
|
|
2202
|
+
delta: number;
|
|
2203
2203
|
/**
|
|
2204
2204
|
* `baselineViewScore`, `baselineSwipeScore`, `simulatedViewScore`, `simulatedSwipeScore`.
|
|
2205
2205
|
* @public
|
|
2206
2206
|
*/
|
|
2207
|
-
breakdown: Record<string, number
|
|
2207
|
+
breakdown: Record<string, number>;
|
|
2208
2208
|
}
|
|
2209
2209
|
/**
|
|
2210
2210
|
* @public
|
|
@@ -2219,7 +2219,7 @@ export interface UpdateScoringPolicyRequest {
|
|
|
2219
2219
|
* The full policy document. Every member has a default, so `\{\}` is the calibrated baseline.
|
|
2220
2220
|
* @public
|
|
2221
2221
|
*/
|
|
2222
|
-
policy: ScoringPolicyConfig
|
|
2222
|
+
policy: ScoringPolicyConfig;
|
|
2223
2223
|
}
|
|
2224
2224
|
/**
|
|
2225
2225
|
* @public
|
|
@@ -2229,17 +2229,17 @@ export interface UpdateScoringPolicyResponse {
|
|
|
2229
2229
|
* Always `updated`.
|
|
2230
2230
|
* @public
|
|
2231
2231
|
*/
|
|
2232
|
-
status: string
|
|
2232
|
+
status: string;
|
|
2233
2233
|
/**
|
|
2234
2234
|
* The saved version (bumped when it equalled the expected version).
|
|
2235
2235
|
* @public
|
|
2236
2236
|
*/
|
|
2237
|
-
version: string
|
|
2237
|
+
version: string;
|
|
2238
2238
|
/**
|
|
2239
2239
|
* The full policy document. Every member has a default, so `\{\}` is the calibrated baseline.
|
|
2240
2240
|
* @public
|
|
2241
2241
|
*/
|
|
2242
|
-
policy: ScoringPolicyConfig
|
|
2242
|
+
policy: ScoringPolicyConfig;
|
|
2243
2243
|
}
|
|
2244
2244
|
/**
|
|
2245
2245
|
* @public
|
|
@@ -2271,8 +2271,8 @@ export type DiscoveryCategory = typeof DiscoveryCategory[keyof typeof DiscoveryC
|
|
|
2271
2271
|
* @public
|
|
2272
2272
|
*/
|
|
2273
2273
|
export interface DiscoverRequest {
|
|
2274
|
-
lat: number
|
|
2275
|
-
lon: number
|
|
2274
|
+
lat: number;
|
|
2275
|
+
lon: number;
|
|
2276
2276
|
/**
|
|
2277
2277
|
* Optional. Omit (or `ALL`) for the mixed deck. Other values need Super or above.
|
|
2278
2278
|
* @public
|
|
@@ -2345,18 +2345,18 @@ export interface MatchHighlight {
|
|
|
2345
2345
|
* Where a match highlight comes from. Traditional systems mirror `Tradition`.
|
|
2346
2346
|
* @public
|
|
2347
2347
|
*/
|
|
2348
|
-
source: MatchHighlightSource
|
|
2348
|
+
source: MatchHighlightSource;
|
|
2349
2349
|
/**
|
|
2350
2350
|
* Display name of `source`, e.g. "Kundali", "Mr. OneHook".
|
|
2351
2351
|
* @public
|
|
2352
2352
|
*/
|
|
2353
|
-
label: string
|
|
2354
|
-
verdict: MatchVerdict
|
|
2353
|
+
label: string;
|
|
2354
|
+
verdict: MatchVerdict;
|
|
2355
2355
|
/**
|
|
2356
2356
|
* Why, in plain language. Never reveals the other member's birth date, time or place.
|
|
2357
2357
|
* @public
|
|
2358
2358
|
*/
|
|
2359
|
-
reason: string
|
|
2359
|
+
reason: string;
|
|
2360
2360
|
}
|
|
2361
2361
|
/**
|
|
2362
2362
|
* @public
|
|
@@ -2374,25 +2374,25 @@ export type SuggestionBasis = typeof SuggestionBasis[keyof typeof SuggestionBasi
|
|
|
2374
2374
|
* @public
|
|
2375
2375
|
*/
|
|
2376
2376
|
export interface CandidateDto {
|
|
2377
|
-
userId: string
|
|
2378
|
-
distanceKm: number
|
|
2379
|
-
score: number
|
|
2377
|
+
userId: string;
|
|
2378
|
+
distanceKm: number;
|
|
2379
|
+
score: number;
|
|
2380
2380
|
/**
|
|
2381
2381
|
* Who found this candidate. How (and whether) to show it is up to the client.
|
|
2382
2382
|
* @public
|
|
2383
2383
|
*/
|
|
2384
|
-
matchFinder: MatchFinder
|
|
2384
|
+
matchFinder: MatchFinder;
|
|
2385
2385
|
/**
|
|
2386
2386
|
* Display name of `matchFinder`: "OneHook Intelligence" or "Mr. OneHook".
|
|
2387
2387
|
* @public
|
|
2388
2388
|
*/
|
|
2389
|
-
matchFinderLabel: string
|
|
2389
|
+
matchFinderLabel: string;
|
|
2390
2390
|
/**
|
|
2391
2391
|
* Why this candidate is shown, for the caller (e.g. "You asked OneHook for an outdoorsy reader ·
|
|
2392
2392
|
* You both like hiking").
|
|
2393
2393
|
* @public
|
|
2394
2394
|
*/
|
|
2395
|
-
reasoning: string
|
|
2395
|
+
reasoning: string;
|
|
2396
2396
|
/**
|
|
2397
2397
|
* Only for `MR_ONEHOOK`: the OneHook suggestion that surfaced this candidate.
|
|
2398
2398
|
* @public
|
|
@@ -2424,7 +2424,7 @@ export interface CandidateDto {
|
|
|
2424
2424
|
* @public
|
|
2425
2425
|
*/
|
|
2426
2426
|
export interface DiscoverResponse {
|
|
2427
|
-
candidates: (CandidateDto)[]
|
|
2427
|
+
candidates: (CandidateDto)[];
|
|
2428
2428
|
/**
|
|
2429
2429
|
* View pass (`aud` profile.matching, 10 minutes) for this page's candidates: send it as
|
|
2430
2430
|
* `X-View-Pass` to `GET /profile/\{id\}/matching` and to the media download route. Absent when
|
|
@@ -2432,18 +2432,18 @@ export interface DiscoverResponse {
|
|
|
2432
2432
|
* @public
|
|
2433
2433
|
*/
|
|
2434
2434
|
viewPass?: string | undefined;
|
|
2435
|
-
count: number
|
|
2436
|
-
algorithm: string
|
|
2435
|
+
count: number;
|
|
2436
|
+
algorithm: string;
|
|
2437
2437
|
/**
|
|
2438
2438
|
* The category that was applied.
|
|
2439
2439
|
* @public
|
|
2440
2440
|
*/
|
|
2441
|
-
category: DiscoveryCategory
|
|
2441
|
+
category: DiscoveryCategory;
|
|
2442
2442
|
/**
|
|
2443
2443
|
* Categories the caller's tier may request, for rendering a selector.
|
|
2444
2444
|
* @public
|
|
2445
2445
|
*/
|
|
2446
|
-
availableCategories: (DiscoveryCategory)[]
|
|
2446
|
+
availableCategories: (DiscoveryCategory)[];
|
|
2447
2447
|
}
|
|
2448
2448
|
/**
|
|
2449
2449
|
* @public
|
|
@@ -2453,7 +2453,7 @@ export interface GetPartnerDistanceRequest {
|
|
|
2453
2453
|
* The partner to locate (not the caller).
|
|
2454
2454
|
* @public
|
|
2455
2455
|
*/
|
|
2456
|
-
userId: string
|
|
2456
|
+
userId: string;
|
|
2457
2457
|
}
|
|
2458
2458
|
/**
|
|
2459
2459
|
* @public
|
|
@@ -2464,36 +2464,36 @@ export interface PartnerDistance {
|
|
|
2464
2464
|
* @public
|
|
2465
2465
|
*/
|
|
2466
2466
|
distanceKm?: number | undefined;
|
|
2467
|
-
available: boolean
|
|
2467
|
+
available: boolean;
|
|
2468
2468
|
}
|
|
2469
2469
|
/**
|
|
2470
2470
|
* @public
|
|
2471
2471
|
*/
|
|
2472
2472
|
export interface GetPreferencesRequest {
|
|
2473
|
-
userId: string
|
|
2473
|
+
userId: string;
|
|
2474
2474
|
}
|
|
2475
2475
|
/**
|
|
2476
2476
|
* The member's OneHook suggestion as shown in their preferences. The prompt is never returned.
|
|
2477
2477
|
* @public
|
|
2478
2478
|
*/
|
|
2479
2479
|
export interface CurrentSuggestion {
|
|
2480
|
-
suggestionId: string
|
|
2480
|
+
suggestionId: string;
|
|
2481
2481
|
/**
|
|
2482
2482
|
* Why OneHook is suggesting these people (shown on the cards too).
|
|
2483
2483
|
* @public
|
|
2484
2484
|
*/
|
|
2485
|
-
reasoning: string
|
|
2485
|
+
reasoning: string;
|
|
2486
2486
|
/**
|
|
2487
2487
|
* ISO-8601 time the member asked for it.
|
|
2488
2488
|
* @public
|
|
2489
2489
|
*/
|
|
2490
|
-
createdAt: string
|
|
2490
|
+
createdAt: string;
|
|
2491
2491
|
}
|
|
2492
2492
|
/**
|
|
2493
2493
|
* @public
|
|
2494
2494
|
*/
|
|
2495
2495
|
export interface UserPreferencesResponse {
|
|
2496
|
-
userId: string
|
|
2496
|
+
userId: string;
|
|
2497
2497
|
/**
|
|
2498
2498
|
* The member's current OneHook suggestion (what they last asked Mr OneHook for). Absent when none.
|
|
2499
2499
|
* @public
|
|
@@ -2566,7 +2566,7 @@ export interface ReceivedLike {
|
|
|
2566
2566
|
* The user who liked the caller.
|
|
2567
2567
|
* @public
|
|
2568
2568
|
*/
|
|
2569
|
-
fromUserId: string
|
|
2569
|
+
fromUserId: string;
|
|
2570
2570
|
/**
|
|
2571
2571
|
* The liker's comment. Absent when the liker sent none (Super and Infinity may like without a
|
|
2572
2572
|
* comment); `likeTargetType` and `likeTargetRef` are then absent too.
|
|
@@ -2589,7 +2589,7 @@ export interface ReceivedLike {
|
|
|
2589
2589
|
* When the like was recorded, ISO-8601 (UTC).
|
|
2590
2590
|
* @public
|
|
2591
2591
|
*/
|
|
2592
|
-
createdAt: string
|
|
2592
|
+
createdAt: string;
|
|
2593
2593
|
}
|
|
2594
2594
|
/**
|
|
2595
2595
|
* The pending likes the caller has received, newest first, plus their count. See
|
|
@@ -2597,13 +2597,13 @@ export interface ReceivedLike {
|
|
|
2597
2597
|
* @public
|
|
2598
2598
|
*/
|
|
2599
2599
|
export interface GetReceivedLikesResponse {
|
|
2600
|
-
likes: (ReceivedLike)[]
|
|
2600
|
+
likes: (ReceivedLike)[];
|
|
2601
2601
|
/**
|
|
2602
2602
|
* View pass for the likers' matching profiles. Absent when there are no likes.
|
|
2603
2603
|
* @public
|
|
2604
2604
|
*/
|
|
2605
2605
|
viewPass?: string | undefined;
|
|
2606
|
-
count: number
|
|
2606
|
+
count: number;
|
|
2607
2607
|
}
|
|
2608
2608
|
/**
|
|
2609
2609
|
* The caller's rose availability for the current UTC day. See `GetRoses`.
|
|
@@ -2614,17 +2614,17 @@ export interface GetRosesResponse {
|
|
|
2614
2614
|
* Roses the caller may still send today (never negative).
|
|
2615
2615
|
* @public
|
|
2616
2616
|
*/
|
|
2617
|
-
remaining: number
|
|
2617
|
+
remaining: number;
|
|
2618
2618
|
/**
|
|
2619
2619
|
* The caller's per-day rose allowance, from their stored tier (Must=1, Super=3, Infinity=10).
|
|
2620
2620
|
* @public
|
|
2621
2621
|
*/
|
|
2622
|
-
limit: number
|
|
2622
|
+
limit: number;
|
|
2623
2623
|
/**
|
|
2624
2624
|
* The next UTC midnight (ISO-8601), when `remaining` resets to `limit`.
|
|
2625
2625
|
* @public
|
|
2626
2626
|
*/
|
|
2627
|
-
resetsAt: string
|
|
2627
|
+
resetsAt: string;
|
|
2628
2628
|
}
|
|
2629
2629
|
/**
|
|
2630
2630
|
* @public
|
|
@@ -2655,34 +2655,34 @@ export interface TraditionSetting {
|
|
|
2655
2655
|
* Stable id, e.g. `KUNDALI`.
|
|
2656
2656
|
* @public
|
|
2657
2657
|
*/
|
|
2658
|
-
id: string
|
|
2659
|
-
label: string
|
|
2660
|
-
description: string
|
|
2661
|
-
enabled: boolean
|
|
2658
|
+
id: string;
|
|
2659
|
+
label: string;
|
|
2660
|
+
description: string;
|
|
2661
|
+
enabled: boolean;
|
|
2662
2662
|
/**
|
|
2663
2663
|
* The least birth data it uses: `DATE`, `TIME` (birth time) or `PLACE` (time and birthplace).
|
|
2664
2664
|
* @public
|
|
2665
2665
|
*/
|
|
2666
|
-
needs: string
|
|
2666
|
+
needs: string;
|
|
2667
2667
|
}
|
|
2668
2668
|
/**
|
|
2669
2669
|
* @public
|
|
2670
2670
|
*/
|
|
2671
2671
|
export interface TraditionPreferencesResponse {
|
|
2672
|
-
traditions: (TraditionSetting)[]
|
|
2672
|
+
traditions: (TraditionSetting)[];
|
|
2673
2673
|
}
|
|
2674
2674
|
/**
|
|
2675
2675
|
* @public
|
|
2676
2676
|
*/
|
|
2677
2677
|
export interface StatusResponse {
|
|
2678
|
-
status: string
|
|
2678
|
+
status: string;
|
|
2679
2679
|
}
|
|
2680
2680
|
/**
|
|
2681
2681
|
* @public
|
|
2682
2682
|
*/
|
|
2683
2683
|
export interface LocationRequest {
|
|
2684
|
-
lat: number
|
|
2685
|
-
lon: number
|
|
2684
|
+
lat: number;
|
|
2685
|
+
lon: number;
|
|
2686
2686
|
}
|
|
2687
2687
|
/**
|
|
2688
2688
|
* @public
|
|
@@ -2692,7 +2692,7 @@ export interface IssueViewPassesRequest {
|
|
|
2692
2692
|
* Members to open, 1 to 25.
|
|
2693
2693
|
* @public
|
|
2694
2694
|
*/
|
|
2695
|
-
targetIds: (string)[]
|
|
2695
|
+
targetIds: (string)[];
|
|
2696
2696
|
}
|
|
2697
2697
|
/**
|
|
2698
2698
|
* @public
|
|
@@ -2707,7 +2707,7 @@ export interface IssueViewPassesResponse {
|
|
|
2707
2707
|
* The members the pass names.
|
|
2708
2708
|
* @public
|
|
2709
2709
|
*/
|
|
2710
|
-
targetIds: (string)[]
|
|
2710
|
+
targetIds: (string)[];
|
|
2711
2711
|
}
|
|
2712
2712
|
/**
|
|
2713
2713
|
* @public
|
|
@@ -2717,18 +2717,18 @@ export interface RecordSuggestionRequest {
|
|
|
2717
2717
|
* OneHook AI's analysis of what the caller wants (3 to 1000 characters). Embedded, never logged.
|
|
2718
2718
|
* @public
|
|
2719
2719
|
*/
|
|
2720
|
-
prompt: string
|
|
2720
|
+
prompt: string;
|
|
2721
2721
|
/**
|
|
2722
2722
|
* Why OneHook is suggesting these people, shown to the caller on each card (1 to 280 characters).
|
|
2723
2723
|
* @public
|
|
2724
2724
|
*/
|
|
2725
|
-
reasoning: string
|
|
2725
|
+
reasoning: string;
|
|
2726
2726
|
}
|
|
2727
2727
|
/**
|
|
2728
2728
|
* @public
|
|
2729
2729
|
*/
|
|
2730
2730
|
export interface RecordSuggestionResponse {
|
|
2731
|
-
suggestionId: string
|
|
2731
|
+
suggestionId: string;
|
|
2732
2732
|
}
|
|
2733
2733
|
/**
|
|
2734
2734
|
* @public
|
|
@@ -2738,9 +2738,9 @@ export interface RecordSuggestionInternalRequest {
|
|
|
2738
2738
|
* The member's Cognito ID token, as proof of their live session.
|
|
2739
2739
|
* @public
|
|
2740
2740
|
*/
|
|
2741
|
-
memberToken: string
|
|
2742
|
-
prompt: string
|
|
2743
|
-
reasoning: string
|
|
2741
|
+
memberToken: string;
|
|
2742
|
+
prompt: string;
|
|
2743
|
+
reasoning: string;
|
|
2744
2744
|
}
|
|
2745
2745
|
/**
|
|
2746
2746
|
* @public
|
|
@@ -2766,8 +2766,8 @@ export interface RemoveSuggestionResponse {
|
|
|
2766
2766
|
* @public
|
|
2767
2767
|
*/
|
|
2768
2768
|
export interface SwipeRequest {
|
|
2769
|
-
targetId: string
|
|
2770
|
-
direction: string
|
|
2769
|
+
targetId: string;
|
|
2770
|
+
direction: string;
|
|
2771
2771
|
/**
|
|
2772
2772
|
* The profile section the swiper was viewing at swipe time (e.g. PHOTOS, BIO, PROMPTS,
|
|
2773
2773
|
* BASICS, LIFESTYLE, INTENT, INTERESTS, BACKGROUND). Persisted with the swipe so a LEFT
|
|
@@ -2827,8 +2827,8 @@ export interface SwipeRequest {
|
|
|
2827
2827
|
* @public
|
|
2828
2828
|
*/
|
|
2829
2829
|
export interface SwipeResponse {
|
|
2830
|
-
status: string
|
|
2831
|
-
matched: boolean
|
|
2830
|
+
status: string;
|
|
2831
|
+
matched: boolean;
|
|
2832
2832
|
/**
|
|
2833
2833
|
* The match id if this was a mutual match
|
|
2834
2834
|
* @public
|
|
@@ -2839,7 +2839,7 @@ export interface SwipeResponse {
|
|
|
2839
2839
|
* @public
|
|
2840
2840
|
*/
|
|
2841
2841
|
export interface UpdatePreferencesRequest {
|
|
2842
|
-
userId: string
|
|
2842
|
+
userId: string;
|
|
2843
2843
|
minAge?: number | undefined;
|
|
2844
2844
|
maxAge?: number | undefined;
|
|
2845
2845
|
maxDistanceKm?: number | undefined;
|
|
@@ -2998,13 +2998,13 @@ export interface UpdateTraditionPreferencesRequest {
|
|
|
2998
2998
|
* Tradition ids (from `GET /matching/traditions`) to opt out of.
|
|
2999
2999
|
* @public
|
|
3000
3000
|
*/
|
|
3001
|
-
disabled: (string)[]
|
|
3001
|
+
disabled: (string)[];
|
|
3002
3002
|
}
|
|
3003
3003
|
/**
|
|
3004
3004
|
* @public
|
|
3005
3005
|
*/
|
|
3006
3006
|
export interface CompleteLivenessSessionRequest {
|
|
3007
|
-
sessionId: string
|
|
3007
|
+
sessionId: string;
|
|
3008
3008
|
}
|
|
3009
3009
|
/**
|
|
3010
3010
|
* @public
|
|
@@ -3015,24 +3015,24 @@ export interface CompleteLivenessSessionResponse {
|
|
|
3015
3015
|
* asynchronously and surfaced later via the profile's `verified` field.
|
|
3016
3016
|
* @public
|
|
3017
3017
|
*/
|
|
3018
|
-
status: string
|
|
3018
|
+
status: string;
|
|
3019
3019
|
}
|
|
3020
3020
|
/**
|
|
3021
3021
|
* @public
|
|
3022
3022
|
*/
|
|
3023
3023
|
export interface CorrectBirthDateRequest {
|
|
3024
|
-
userId: string
|
|
3024
|
+
userId: string;
|
|
3025
3025
|
/**
|
|
3026
3026
|
* The corrected birth date, `yyyy-MM-dd` (must give an age of 18 to 120).
|
|
3027
3027
|
* @public
|
|
3028
3028
|
*/
|
|
3029
|
-
date: string
|
|
3029
|
+
date: string;
|
|
3030
3030
|
/**
|
|
3031
3031
|
* The approver's reasoning (10-500 characters), e.g. "Passport shows 1991-03-02". Kept so anyone
|
|
3032
3032
|
* reviewing the change later can follow the decision.
|
|
3033
3033
|
* @public
|
|
3034
3034
|
*/
|
|
3035
|
-
reason: string
|
|
3035
|
+
reason: string;
|
|
3036
3036
|
/**
|
|
3037
3037
|
* Optional support ticket or case reference.
|
|
3038
3038
|
* @public
|
|
@@ -3043,15 +3043,15 @@ export interface CorrectBirthDateRequest {
|
|
|
3043
3043
|
* @public
|
|
3044
3044
|
*/
|
|
3045
3045
|
export interface CorrectBirthDateResponse {
|
|
3046
|
-
userId: string
|
|
3047
|
-
date: string
|
|
3048
|
-
age: number
|
|
3046
|
+
userId: string;
|
|
3047
|
+
date: string;
|
|
3048
|
+
age: number;
|
|
3049
3049
|
/**
|
|
3050
3050
|
* Corrections used for this member, including this one.
|
|
3051
3051
|
* @public
|
|
3052
3052
|
*/
|
|
3053
|
-
correctionsUsed: number
|
|
3054
|
-
correctionsRemaining: number
|
|
3053
|
+
correctionsUsed: number;
|
|
3054
|
+
correctionsRemaining: number;
|
|
3055
3055
|
}
|
|
3056
3056
|
/**
|
|
3057
3057
|
* @public
|
|
@@ -3062,13 +3062,13 @@ export interface CreateLivenessSessionRequest {
|
|
|
3062
3062
|
* @public
|
|
3063
3063
|
*/
|
|
3064
3064
|
export interface CreateLivenessSessionResponse {
|
|
3065
|
-
sessionId: string
|
|
3065
|
+
sessionId: string;
|
|
3066
3066
|
}
|
|
3067
3067
|
/**
|
|
3068
3068
|
* @public
|
|
3069
3069
|
*/
|
|
3070
3070
|
export interface DeleteProfileRequest {
|
|
3071
|
-
userId: string
|
|
3071
|
+
userId: string;
|
|
3072
3072
|
}
|
|
3073
3073
|
/**
|
|
3074
3074
|
* @public
|
|
@@ -3078,7 +3078,7 @@ export interface MediaDownloadUrlRequest {
|
|
|
3078
3078
|
* The S3 object key to sign, e.g. "media/\{userId\}/matching/\{uuid\}".
|
|
3079
3079
|
* @public
|
|
3080
3080
|
*/
|
|
3081
|
-
key: string
|
|
3081
|
+
key: string;
|
|
3082
3082
|
/**
|
|
3083
3083
|
* Required for another member's media: a chat pass for `media/\{u\}/chat/...`, a matching pass for
|
|
3084
3084
|
* `media/\{u\}/matching/...`, naming that member. Not needed for your own media.
|
|
@@ -3094,12 +3094,12 @@ export interface MediaDownloadUrlResponse {
|
|
|
3094
3094
|
* Short-lived presigned GET URL for the requested object.
|
|
3095
3095
|
* @public
|
|
3096
3096
|
*/
|
|
3097
|
-
downloadUrl: string
|
|
3097
|
+
downloadUrl: string;
|
|
3098
3098
|
/**
|
|
3099
3099
|
* Seconds until the presigned URL expires.
|
|
3100
3100
|
* @public
|
|
3101
3101
|
*/
|
|
3102
|
-
expiresInSeconds: number
|
|
3102
|
+
expiresInSeconds: number;
|
|
3103
3103
|
}
|
|
3104
3104
|
/**
|
|
3105
3105
|
* @public
|
|
@@ -3117,44 +3117,44 @@ export type MediaPurpose = typeof MediaPurpose[keyof typeof MediaPurpose];
|
|
|
3117
3117
|
* @public
|
|
3118
3118
|
*/
|
|
3119
3119
|
export interface MediaUploadUrlRequest {
|
|
3120
|
-
contentType: string
|
|
3121
|
-
contentLength: number
|
|
3120
|
+
contentType: string;
|
|
3121
|
+
contentLength: number;
|
|
3122
3122
|
/**
|
|
3123
3123
|
* Which profile the media is for. The key is `pending/\{you\}/chat/...` or `pending/\{you\}/matching/...`,
|
|
3124
3124
|
* and only the matching kind is erased when matching is turned off.
|
|
3125
3125
|
* @public
|
|
3126
3126
|
*/
|
|
3127
|
-
purpose: MediaPurpose
|
|
3127
|
+
purpose: MediaPurpose;
|
|
3128
3128
|
}
|
|
3129
3129
|
/**
|
|
3130
3130
|
* @public
|
|
3131
3131
|
*/
|
|
3132
3132
|
export interface MediaUploadUrlResponse {
|
|
3133
|
-
uploadUrl: string
|
|
3134
|
-
objectKey: string
|
|
3135
|
-
formData: Record<string, string
|
|
3133
|
+
uploadUrl: string;
|
|
3134
|
+
objectKey: string;
|
|
3135
|
+
formData: Record<string, string>;
|
|
3136
3136
|
}
|
|
3137
3137
|
/**
|
|
3138
3138
|
* @public
|
|
3139
3139
|
*/
|
|
3140
3140
|
export interface GetBirthDateStatusRequest {
|
|
3141
|
-
userId: string
|
|
3141
|
+
userId: string;
|
|
3142
3142
|
}
|
|
3143
3143
|
/**
|
|
3144
3144
|
* @public
|
|
3145
3145
|
*/
|
|
3146
3146
|
export interface GetBirthDateStatusResponse {
|
|
3147
|
-
userId: string
|
|
3147
|
+
userId: string;
|
|
3148
3148
|
/**
|
|
3149
3149
|
* `yyyy-MM-dd`; absent for a legacy profile that never had one.
|
|
3150
3150
|
* @public
|
|
3151
3151
|
*/
|
|
3152
3152
|
date?: string | undefined;
|
|
3153
3153
|
age?: number | undefined;
|
|
3154
|
-
provisional: boolean
|
|
3155
|
-
birthDateOnFile: boolean
|
|
3156
|
-
correctionsUsed: number
|
|
3157
|
-
correctionsRemaining: number
|
|
3154
|
+
provisional: boolean;
|
|
3155
|
+
birthDateOnFile: boolean;
|
|
3156
|
+
correctionsUsed: number;
|
|
3157
|
+
correctionsRemaining: number;
|
|
3158
3158
|
/**
|
|
3159
3159
|
* Epoch seconds of the most recent correction.
|
|
3160
3160
|
* @public
|
|
@@ -3192,7 +3192,7 @@ export interface BirthDetails {
|
|
|
3192
3192
|
* @public
|
|
3193
3193
|
*/
|
|
3194
3194
|
export interface ChatProfile {
|
|
3195
|
-
userId: string
|
|
3195
|
+
userId: string;
|
|
3196
3196
|
displayName?: string | undefined;
|
|
3197
3197
|
/**
|
|
3198
3198
|
* Absent while the avatar awaits moderation (for everyone but the owner).
|
|
@@ -3221,7 +3221,7 @@ export interface ChatProfile {
|
|
|
3221
3221
|
* @public
|
|
3222
3222
|
*/
|
|
3223
3223
|
export interface GetOtherProfileRequest {
|
|
3224
|
-
userId: string
|
|
3224
|
+
userId: string;
|
|
3225
3225
|
/**
|
|
3226
3226
|
* The view pass (see the operation). Optional in the model; required in practice.
|
|
3227
3227
|
* @public
|
|
@@ -3232,7 +3232,7 @@ export interface GetOtherProfileRequest {
|
|
|
3232
3232
|
* @public
|
|
3233
3233
|
*/
|
|
3234
3234
|
export interface GetInternalProfileRequest {
|
|
3235
|
-
userId: string
|
|
3235
|
+
userId: string;
|
|
3236
3236
|
}
|
|
3237
3237
|
/**
|
|
3238
3238
|
* @public
|
|
@@ -3253,15 +3253,15 @@ export type MatchingProfileStatus = typeof MatchingProfileStatus[keyof typeof Ma
|
|
|
3253
3253
|
* @public
|
|
3254
3254
|
*/
|
|
3255
3255
|
export interface Opener {
|
|
3256
|
-
text: string
|
|
3256
|
+
text: string;
|
|
3257
3257
|
imageKey?: string | undefined;
|
|
3258
3258
|
}
|
|
3259
3259
|
/**
|
|
3260
3260
|
* @public
|
|
3261
3261
|
*/
|
|
3262
3262
|
export interface ProfilePrompt {
|
|
3263
|
-
promptId: string
|
|
3264
|
-
answer: string
|
|
3263
|
+
promptId: string;
|
|
3264
|
+
answer: string;
|
|
3265
3265
|
imageKey?: string | undefined;
|
|
3266
3266
|
}
|
|
3267
3267
|
/**
|
|
@@ -3269,7 +3269,7 @@ export interface ProfilePrompt {
|
|
|
3269
3269
|
* @public
|
|
3270
3270
|
*/
|
|
3271
3271
|
export interface InternalProfile {
|
|
3272
|
-
userId: string
|
|
3272
|
+
userId: string;
|
|
3273
3273
|
/**
|
|
3274
3274
|
* `ACTIVE` exactly when the matching fields below are present.
|
|
3275
3275
|
* @public
|
|
@@ -3289,7 +3289,7 @@ export interface InternalProfile {
|
|
|
3289
3289
|
* True when a real (non-provisional) birth date is on file.
|
|
3290
3290
|
* @public
|
|
3291
3291
|
*/
|
|
3292
|
-
birthDateOnFile: boolean
|
|
3292
|
+
birthDateOnFile: boolean;
|
|
3293
3293
|
bio?: string | undefined;
|
|
3294
3294
|
gender?: string | undefined;
|
|
3295
3295
|
interestedIn?: (string)[] | undefined;
|
|
@@ -3342,7 +3342,7 @@ export interface LivenessStatusResponse {
|
|
|
3342
3342
|
* Authoritative liveness status: one of NONE | PENDING | APPROVED | REJECTED.
|
|
3343
3343
|
* @public
|
|
3344
3344
|
*/
|
|
3345
|
-
status: string
|
|
3345
|
+
status: string;
|
|
3346
3346
|
}
|
|
3347
3347
|
/**
|
|
3348
3348
|
* The matching profile's optional birth time and place. They only refine traditional compatibility:
|
|
@@ -3385,7 +3385,7 @@ export interface BirthTimePlace {
|
|
|
3385
3385
|
* @public
|
|
3386
3386
|
*/
|
|
3387
3387
|
export interface MatchingProfile {
|
|
3388
|
-
userId: string
|
|
3388
|
+
userId: string;
|
|
3389
3389
|
/**
|
|
3390
3390
|
* Owner only.
|
|
3391
3391
|
* @public
|
|
@@ -3483,12 +3483,12 @@ export interface MatchingProfile {
|
|
|
3483
3483
|
* @public
|
|
3484
3484
|
*/
|
|
3485
3485
|
export interface MatchingReadiness {
|
|
3486
|
-
ready: boolean
|
|
3486
|
+
ready: boolean;
|
|
3487
3487
|
/**
|
|
3488
3488
|
* What is missing: `PHOTOS`, `GENDER`, `INTERESTED_IN`, `NO_CHAT_PROFILE`, `NO_MATCHING_PROFILE`.
|
|
3489
3489
|
* @public
|
|
3490
3490
|
*/
|
|
3491
|
-
gaps: (string)[]
|
|
3491
|
+
gaps: (string)[];
|
|
3492
3492
|
}
|
|
3493
3493
|
/**
|
|
3494
3494
|
* Both of the caller's profiles.
|
|
@@ -3499,7 +3499,7 @@ export interface MyProfileResponse {
|
|
|
3499
3499
|
* A chat profile. `birthDetails` and `fieldModerationStatus` are returned to the owner only.
|
|
3500
3500
|
* @public
|
|
3501
3501
|
*/
|
|
3502
|
-
chat: ChatProfile
|
|
3502
|
+
chat: ChatProfile;
|
|
3503
3503
|
/**
|
|
3504
3504
|
* Absent until the member saves a matching profile, and after it is erased.
|
|
3505
3505
|
* @public
|
|
@@ -3510,17 +3510,17 @@ export interface MyProfileResponse {
|
|
|
3510
3510
|
* @public
|
|
3511
3511
|
*/
|
|
3512
3512
|
export interface GetPlaceRequest {
|
|
3513
|
-
placeId: string
|
|
3513
|
+
placeId: string;
|
|
3514
3514
|
lang?: string | undefined;
|
|
3515
3515
|
}
|
|
3516
3516
|
/**
|
|
3517
3517
|
* @public
|
|
3518
3518
|
*/
|
|
3519
3519
|
export interface GetPlaceResponse {
|
|
3520
|
-
placeId: string
|
|
3521
|
-
label: string
|
|
3522
|
-
latitude: number
|
|
3523
|
-
longitude: number
|
|
3520
|
+
placeId: string;
|
|
3521
|
+
label: string;
|
|
3522
|
+
latitude: number;
|
|
3523
|
+
longitude: number;
|
|
3524
3524
|
/**
|
|
3525
3525
|
* IANA time zone, e.g. `Asia/Kolkata`. Absent when Amazon Location has none for the place.
|
|
3526
3526
|
* @public
|
|
@@ -3531,7 +3531,7 @@ export interface GetPlaceResponse {
|
|
|
3531
3531
|
* @public
|
|
3532
3532
|
*/
|
|
3533
3533
|
export interface RepublishMatchingProfileRequest {
|
|
3534
|
-
userId: string
|
|
3534
|
+
userId: string;
|
|
3535
3535
|
}
|
|
3536
3536
|
/**
|
|
3537
3537
|
* @public
|
|
@@ -3541,18 +3541,18 @@ export interface RepublishMatchingProfileResponse {
|
|
|
3541
3541
|
* Always `REPUBLISHED`: the profile is queued for publication.
|
|
3542
3542
|
* @public
|
|
3543
3543
|
*/
|
|
3544
|
-
status: string
|
|
3544
|
+
status: string;
|
|
3545
3545
|
/**
|
|
3546
3546
|
* The matching generation of the published profile.
|
|
3547
3547
|
* @public
|
|
3548
3548
|
*/
|
|
3549
|
-
generation: number
|
|
3549
|
+
generation: number;
|
|
3550
3550
|
}
|
|
3551
3551
|
/**
|
|
3552
3552
|
* @public
|
|
3553
3553
|
*/
|
|
3554
3554
|
export interface SearchPlacesRequest {
|
|
3555
|
-
q: string
|
|
3555
|
+
q: string;
|
|
3556
3556
|
/**
|
|
3557
3557
|
* BCP-47 language for labels, e.g. `en`, `hi`.
|
|
3558
3558
|
* @public
|
|
@@ -3563,14 +3563,14 @@ export interface SearchPlacesRequest {
|
|
|
3563
3563
|
* @public
|
|
3564
3564
|
*/
|
|
3565
3565
|
export interface PlaceSuggestion {
|
|
3566
|
-
placeId: string
|
|
3567
|
-
label: string
|
|
3566
|
+
placeId: string;
|
|
3567
|
+
label: string;
|
|
3568
3568
|
}
|
|
3569
3569
|
/**
|
|
3570
3570
|
* @public
|
|
3571
3571
|
*/
|
|
3572
3572
|
export interface SearchPlacesResponse {
|
|
3573
|
-
places: (PlaceSuggestion)[]
|
|
3573
|
+
places: (PlaceSuggestion)[];
|
|
3574
3574
|
}
|
|
3575
3575
|
/**
|
|
3576
3576
|
* The chat profile: what every account needs, and all a chat-only member has.
|
|
@@ -3652,12 +3652,12 @@ export interface MatchingProfileUpsertResponse {
|
|
|
3652
3652
|
* DRAFT until matching is turned on; ACTIVE while it is on.
|
|
3653
3653
|
* @public
|
|
3654
3654
|
*/
|
|
3655
|
-
status: MatchingProfileStatus
|
|
3655
|
+
status: MatchingProfileStatus;
|
|
3656
3656
|
/**
|
|
3657
3657
|
* Epoch seconds of this edit.
|
|
3658
3658
|
* @public
|
|
3659
3659
|
*/
|
|
3660
|
-
lastEditedAt: number
|
|
3660
|
+
lastEditedAt: number;
|
|
3661
3661
|
/**
|
|
3662
3662
|
* DRAFT only: epoch seconds when the draft is erased unless edited again (30 days after the last edit).
|
|
3663
3663
|
* @public
|
|
@@ -3668,18 +3668,18 @@ export interface MatchingProfileUpsertResponse {
|
|
|
3668
3668
|
* @public
|
|
3669
3669
|
*/
|
|
3670
3670
|
export interface AcceptHookRequestResponse {
|
|
3671
|
-
matchId: string
|
|
3671
|
+
matchId: string;
|
|
3672
3672
|
/**
|
|
3673
3673
|
* The member who sent the request, now the caller's hook partner.
|
|
3674
3674
|
* @public
|
|
3675
3675
|
*/
|
|
3676
|
-
peerId: string
|
|
3676
|
+
peerId: string;
|
|
3677
3677
|
}
|
|
3678
3678
|
/**
|
|
3679
3679
|
* @public
|
|
3680
3680
|
*/
|
|
3681
3681
|
export interface HookRequestIdRequest {
|
|
3682
|
-
requestId: string
|
|
3682
|
+
requestId: string;
|
|
3683
3683
|
}
|
|
3684
3684
|
/**
|
|
3685
3685
|
* @public
|
|
@@ -3701,7 +3701,7 @@ export type BlockReason = typeof BlockReason[keyof typeof BlockReason];
|
|
|
3701
3701
|
* @public
|
|
3702
3702
|
*/
|
|
3703
3703
|
export interface BlockUserRequest {
|
|
3704
|
-
blockedUserId: string
|
|
3704
|
+
blockedUserId: string;
|
|
3705
3705
|
/**
|
|
3706
3706
|
* Defaults to OTHER.
|
|
3707
3707
|
* @public
|
|
@@ -3717,18 +3717,18 @@ export interface BlockUserRequest {
|
|
|
3717
3717
|
* @public
|
|
3718
3718
|
*/
|
|
3719
3719
|
export interface BlockView {
|
|
3720
|
-
blockedUserId: string
|
|
3720
|
+
blockedUserId: string;
|
|
3721
3721
|
/**
|
|
3722
3722
|
* Why a member blocked someone.
|
|
3723
3723
|
* @public
|
|
3724
3724
|
*/
|
|
3725
|
-
reason: BlockReason
|
|
3725
|
+
reason: BlockReason;
|
|
3726
3726
|
details?: string | undefined;
|
|
3727
3727
|
/**
|
|
3728
3728
|
* Epoch seconds the block started.
|
|
3729
3729
|
* @public
|
|
3730
3730
|
*/
|
|
3731
|
-
createdAt: number
|
|
3731
|
+
createdAt: number;
|
|
3732
3732
|
/**
|
|
3733
3733
|
* The blocked member's chat display name as it was when the block was made. A snapshot: it
|
|
3734
3734
|
* never updates when they change their name. Absent when it could not be read at the time.
|
|
@@ -3740,7 +3740,7 @@ export interface BlockView {
|
|
|
3740
3740
|
* @public
|
|
3741
3741
|
*/
|
|
3742
3742
|
export interface TargetUserRequest {
|
|
3743
|
-
targetUserId: string
|
|
3743
|
+
targetUserId: string;
|
|
3744
3744
|
}
|
|
3745
3745
|
/**
|
|
3746
3746
|
* One override change, as stored. Every member is optional because older entries carry fewer fields.
|
|
@@ -3775,18 +3775,18 @@ export interface OverrideHistoryEntry {
|
|
|
3775
3775
|
* @public
|
|
3776
3776
|
*/
|
|
3777
3777
|
export interface TierOverride {
|
|
3778
|
-
userId: string
|
|
3778
|
+
userId: string;
|
|
3779
3779
|
/**
|
|
3780
3780
|
* The tier the member pays for.
|
|
3781
3781
|
* @public
|
|
3782
3782
|
*/
|
|
3783
|
-
billingTier: SubscriptionTier
|
|
3783
|
+
billingTier: SubscriptionTier;
|
|
3784
3784
|
/**
|
|
3785
3785
|
* The tier in force now (the override while it is active, otherwise the billing tier).
|
|
3786
3786
|
* @public
|
|
3787
3787
|
*/
|
|
3788
|
-
effectiveTier: SubscriptionTier
|
|
3789
|
-
overrideActive: boolean
|
|
3788
|
+
effectiveTier: SubscriptionTier;
|
|
3789
|
+
overrideActive: boolean;
|
|
3790
3790
|
/**
|
|
3791
3791
|
* A OneHook membership tier. The member values are the wire values persisted in Cognito
|
|
3792
3792
|
* (`custom:subscriptionTier`), DynamoDB and Postgres. Members are declared in ascending order
|
|
@@ -3815,12 +3815,12 @@ export interface TierOverride {
|
|
|
3815
3815
|
* Concurrent hooks allowed by the effective tier.
|
|
3816
3816
|
* @public
|
|
3817
3817
|
*/
|
|
3818
|
-
maxConnections: number
|
|
3818
|
+
maxConnections: number;
|
|
3819
3819
|
/**
|
|
3820
3820
|
* Newest first.
|
|
3821
3821
|
* @public
|
|
3822
3822
|
*/
|
|
3823
|
-
overrideHistory: (OverrideHistoryEntry)[]
|
|
3823
|
+
overrideHistory: (OverrideHistoryEntry)[];
|
|
3824
3824
|
}
|
|
3825
3825
|
/**
|
|
3826
3826
|
* @public
|
|
@@ -3835,7 +3835,7 @@ export interface DisableMatchingRequest {
|
|
|
3835
3835
|
* Must be "ERASE_MATCHING": the client confirms the member understood what is erased.
|
|
3836
3836
|
* @public
|
|
3837
3837
|
*/
|
|
3838
|
-
confirm: string
|
|
3838
|
+
confirm: string;
|
|
3839
3839
|
}
|
|
3840
3840
|
/**
|
|
3841
3841
|
* @public
|
|
@@ -3861,8 +3861,8 @@ export interface MatchingStatusResponse {
|
|
|
3861
3861
|
* Whether the member uses matching. OFF members use chat only and Matching holds nothing about them.
|
|
3862
3862
|
* @public
|
|
3863
3863
|
*/
|
|
3864
|
-
status: MatchingMode
|
|
3865
|
-
generation: number
|
|
3864
|
+
status: MatchingMode;
|
|
3865
|
+
generation: number;
|
|
3866
3866
|
}
|
|
3867
3867
|
/**
|
|
3868
3868
|
* 409 from `EnableMatching`. Codes: `MATCHING_PROFILE_INCOMPLETE` (with `gaps`), `NOT_READY` (still
|
|
@@ -3877,7 +3877,7 @@ export declare class EnableMatchingConflictError extends __BaseException {
|
|
|
3877
3877
|
* Human-readable message. Clients may log it but must not branch on it.
|
|
3878
3878
|
* @public
|
|
3879
3879
|
*/
|
|
3880
|
-
error: string
|
|
3880
|
+
error: string;
|
|
3881
3881
|
/**
|
|
3882
3882
|
* Stable machine code in UPPER_SNAKE_CASE (for example `BAD_REQUEST`, `NOT_FOUND`,
|
|
3883
3883
|
* `MATCHING_PROFILE_INCOMPLETE`). Clients branch on this. Errors API Gateway answers itself
|
|
@@ -3886,7 +3886,7 @@ export declare class EnableMatchingConflictError extends __BaseException {
|
|
|
3886
3886
|
* `INTEGRATION_TIMEOUT`.
|
|
3887
3887
|
* @public
|
|
3888
3888
|
*/
|
|
3889
|
-
code: string
|
|
3889
|
+
code: string;
|
|
3890
3890
|
/**
|
|
3891
3891
|
* Request id to quote to support, when the service has one.
|
|
3892
3892
|
* @public
|
|
@@ -3939,18 +3939,18 @@ export interface SnapshotBlock {
|
|
|
3939
3939
|
* The other member of the block.
|
|
3940
3940
|
* @public
|
|
3941
3941
|
*/
|
|
3942
|
-
counterpartId: string
|
|
3943
|
-
direction: BlockDirection
|
|
3942
|
+
counterpartId: string;
|
|
3943
|
+
direction: BlockDirection;
|
|
3944
3944
|
/**
|
|
3945
3945
|
* The pair's block version (orders Matching's `UserBlocked` projection).
|
|
3946
3946
|
* @public
|
|
3947
3947
|
*/
|
|
3948
|
-
version: number
|
|
3948
|
+
version: number;
|
|
3949
3949
|
/**
|
|
3950
3950
|
* Epoch seconds.
|
|
3951
3951
|
* @public
|
|
3952
3952
|
*/
|
|
3953
|
-
blockedAt: number
|
|
3953
|
+
blockedAt: number;
|
|
3954
3954
|
}
|
|
3955
3955
|
/**
|
|
3956
3956
|
* @public
|
|
@@ -3974,18 +3974,18 @@ export type HookOrigin = typeof HookOrigin[keyof typeof HookOrigin];
|
|
|
3974
3974
|
* @public
|
|
3975
3975
|
*/
|
|
3976
3976
|
export interface SnapshotCurrentHook {
|
|
3977
|
-
matchId: string
|
|
3978
|
-
peerId: string
|
|
3977
|
+
matchId: string;
|
|
3978
|
+
peerId: string;
|
|
3979
3979
|
/**
|
|
3980
3980
|
* How a hook was formed.
|
|
3981
3981
|
* @public
|
|
3982
3982
|
*/
|
|
3983
|
-
origin: HookOrigin
|
|
3983
|
+
origin: HookOrigin;
|
|
3984
3984
|
/**
|
|
3985
3985
|
* Epoch seconds.
|
|
3986
3986
|
* @public
|
|
3987
3987
|
*/
|
|
3988
|
-
hookedAt: number
|
|
3988
|
+
hookedAt: number;
|
|
3989
3989
|
}
|
|
3990
3990
|
/**
|
|
3991
3991
|
* @public
|
|
@@ -3995,12 +3995,12 @@ export interface MatchingStatus {
|
|
|
3995
3995
|
* Whether the member uses matching. OFF members use chat only and Matching holds nothing about them.
|
|
3996
3996
|
* @public
|
|
3997
3997
|
*/
|
|
3998
|
-
status: MatchingMode
|
|
3998
|
+
status: MatchingMode;
|
|
3999
3999
|
/**
|
|
4000
4000
|
* Increments every time matching is turned on.
|
|
4001
4001
|
* @public
|
|
4002
4002
|
*/
|
|
4003
|
-
generation: number
|
|
4003
|
+
generation: number;
|
|
4004
4004
|
}
|
|
4005
4005
|
/**
|
|
4006
4006
|
* @public
|
|
@@ -4032,28 +4032,28 @@ export type HookEndReason = typeof HookEndReason[keyof typeof HookEndReason];
|
|
|
4032
4032
|
* @public
|
|
4033
4033
|
*/
|
|
4034
4034
|
export interface SnapshotPastHook {
|
|
4035
|
-
matchId: string
|
|
4036
|
-
peerId: string
|
|
4035
|
+
matchId: string;
|
|
4036
|
+
peerId: string;
|
|
4037
4037
|
/**
|
|
4038
4038
|
* How a hook was formed.
|
|
4039
4039
|
* @public
|
|
4040
4040
|
*/
|
|
4041
|
-
origin: HookOrigin
|
|
4041
|
+
origin: HookOrigin;
|
|
4042
4042
|
/**
|
|
4043
4043
|
* Epoch seconds.
|
|
4044
4044
|
* @public
|
|
4045
4045
|
*/
|
|
4046
|
-
hookedAt: number
|
|
4046
|
+
hookedAt: number;
|
|
4047
4047
|
/**
|
|
4048
4048
|
* Epoch seconds.
|
|
4049
4049
|
* @public
|
|
4050
4050
|
*/
|
|
4051
|
-
releasedAt: number
|
|
4051
|
+
releasedAt: number;
|
|
4052
4052
|
/**
|
|
4053
4053
|
* Why a hook ended.
|
|
4054
4054
|
* @public
|
|
4055
4055
|
*/
|
|
4056
|
-
endReason: HookEndReason
|
|
4056
|
+
endReason: HookEndReason;
|
|
4057
4057
|
/**
|
|
4058
4058
|
* The member who ended it, when one did.
|
|
4059
4059
|
* @public
|
|
@@ -4064,50 +4064,50 @@ export interface SnapshotPastHook {
|
|
|
4064
4064
|
* @public
|
|
4065
4065
|
*/
|
|
4066
4066
|
export interface DiscoverySnapshot {
|
|
4067
|
-
userId: string
|
|
4067
|
+
userId: string;
|
|
4068
4068
|
/**
|
|
4069
4069
|
* Increments on every change to the member's control record.
|
|
4070
4070
|
* @public
|
|
4071
4071
|
*/
|
|
4072
|
-
stateVersion: number
|
|
4073
|
-
discoveryPaused: boolean
|
|
4074
|
-
matching: MatchingStatus
|
|
4075
|
-
currentHooks: (SnapshotCurrentHook)[]
|
|
4076
|
-
pastHooks: (SnapshotPastHook)[]
|
|
4072
|
+
stateVersion: number;
|
|
4073
|
+
discoveryPaused: boolean;
|
|
4074
|
+
matching: MatchingStatus;
|
|
4075
|
+
currentHooks: (SnapshotCurrentHook)[];
|
|
4076
|
+
pastHooks: (SnapshotPastHook)[];
|
|
4077
4077
|
/**
|
|
4078
4078
|
* Blocks in force both ways.
|
|
4079
4079
|
* @public
|
|
4080
4080
|
*/
|
|
4081
|
-
blocks: (SnapshotBlock)[]
|
|
4081
|
+
blocks: (SnapshotBlock)[];
|
|
4082
4082
|
}
|
|
4083
4083
|
/**
|
|
4084
4084
|
* @public
|
|
4085
4085
|
*/
|
|
4086
4086
|
export interface InternalMatchingStatus {
|
|
4087
|
-
userId: string
|
|
4087
|
+
userId: string;
|
|
4088
4088
|
/**
|
|
4089
4089
|
* Whether the member uses matching. OFF members use chat only and Matching holds nothing about them.
|
|
4090
4090
|
* @public
|
|
4091
4091
|
*/
|
|
4092
|
-
status: MatchingMode
|
|
4093
|
-
generation: number
|
|
4092
|
+
status: MatchingMode;
|
|
4093
|
+
generation: number;
|
|
4094
4094
|
}
|
|
4095
4095
|
/**
|
|
4096
4096
|
* @public
|
|
4097
4097
|
*/
|
|
4098
4098
|
export interface GetMatchRequest {
|
|
4099
|
-
matchId: string
|
|
4099
|
+
matchId: string;
|
|
4100
4100
|
}
|
|
4101
4101
|
/**
|
|
4102
4102
|
* @public
|
|
4103
4103
|
*/
|
|
4104
4104
|
export interface MatchRecord {
|
|
4105
|
-
matchId: string
|
|
4106
|
-
userA: string
|
|
4107
|
-
userB: string
|
|
4108
|
-
status: string
|
|
4109
|
-
createdAt: number
|
|
4110
|
-
updatedAt: number
|
|
4105
|
+
matchId: string;
|
|
4106
|
+
userA: string;
|
|
4107
|
+
userB: string;
|
|
4108
|
+
status: string;
|
|
4109
|
+
createdAt: number;
|
|
4110
|
+
updatedAt: number;
|
|
4111
4111
|
endedAt?: number | undefined;
|
|
4112
4112
|
latestMessageSenderId?: string | undefined;
|
|
4113
4113
|
latestMessageTimestamp?: number | undefined;
|
|
@@ -4128,7 +4128,7 @@ export interface MatchRecord {
|
|
|
4128
4128
|
* @public
|
|
4129
4129
|
*/
|
|
4130
4130
|
export interface GetModerationReportRequest {
|
|
4131
|
-
reportId: string
|
|
4131
|
+
reportId: string;
|
|
4132
4132
|
}
|
|
4133
4133
|
/**
|
|
4134
4134
|
* @public
|
|
@@ -4155,32 +4155,32 @@ export type ReportCategory = typeof ReportCategory[keyof typeof ReportCategory];
|
|
|
4155
4155
|
* @public
|
|
4156
4156
|
*/
|
|
4157
4157
|
export interface ModerationReport {
|
|
4158
|
-
reportId: string
|
|
4158
|
+
reportId: string;
|
|
4159
4159
|
/**
|
|
4160
4160
|
* The reporter's Cognito `sub`.
|
|
4161
4161
|
* @public
|
|
4162
4162
|
*/
|
|
4163
|
-
reporterUserId: string
|
|
4164
|
-
reportedUserId: string
|
|
4163
|
+
reporterUserId: string;
|
|
4164
|
+
reportedUserId: string;
|
|
4165
4165
|
/**
|
|
4166
4166
|
* What a report is about.
|
|
4167
4167
|
* @public
|
|
4168
4168
|
*/
|
|
4169
|
-
category: ReportCategory
|
|
4169
|
+
category: ReportCategory;
|
|
4170
4170
|
/**
|
|
4171
4171
|
* `critical`, `high` or `standard`.
|
|
4172
4172
|
* @public
|
|
4173
4173
|
*/
|
|
4174
|
-
severity: string
|
|
4174
|
+
severity: string;
|
|
4175
4175
|
details?: string | undefined;
|
|
4176
4176
|
conversationId?: string | undefined;
|
|
4177
|
-
evidenceOffered: boolean
|
|
4178
|
-
alsoBlocked: boolean
|
|
4177
|
+
evidenceOffered: boolean;
|
|
4178
|
+
alsoBlocked: boolean;
|
|
4179
4179
|
/**
|
|
4180
4180
|
* ISO-8601 with second precision.
|
|
4181
4181
|
* @public
|
|
4182
4182
|
*/
|
|
4183
|
-
createdAt: string
|
|
4183
|
+
createdAt: string;
|
|
4184
4184
|
/**
|
|
4185
4185
|
* `report` or `block`.
|
|
4186
4186
|
* @public
|
|
@@ -4191,9 +4191,9 @@ export interface ModerationReport {
|
|
|
4191
4191
|
* @public
|
|
4192
4192
|
*/
|
|
4193
4193
|
export interface BlocksReceivedSignals {
|
|
4194
|
-
total: number
|
|
4195
|
-
distinctBlockers: number
|
|
4196
|
-
last30d: number
|
|
4194
|
+
total: number;
|
|
4195
|
+
distinctBlockers: number;
|
|
4196
|
+
last30d: number;
|
|
4197
4197
|
}
|
|
4198
4198
|
/**
|
|
4199
4199
|
* @public
|
|
@@ -4203,7 +4203,7 @@ export interface ConversationSignals {
|
|
|
4203
4203
|
* Current plus past hooks, both origins.
|
|
4204
4204
|
* @public
|
|
4205
4205
|
*/
|
|
4206
|
-
matchesTotal: number
|
|
4206
|
+
matchesTotal: number;
|
|
4207
4207
|
/**
|
|
4208
4208
|
* Not computed (always null).
|
|
4209
4209
|
* @public
|
|
@@ -4214,32 +4214,32 @@ export interface ConversationSignals {
|
|
|
4214
4214
|
* @public
|
|
4215
4215
|
*/
|
|
4216
4216
|
export interface ReportsFiledSignals {
|
|
4217
|
-
total: number
|
|
4218
|
-
last30d: number
|
|
4217
|
+
total: number;
|
|
4218
|
+
last30d: number;
|
|
4219
4219
|
}
|
|
4220
4220
|
/**
|
|
4221
4221
|
* @public
|
|
4222
4222
|
*/
|
|
4223
4223
|
export interface ReportsReceivedSignals {
|
|
4224
|
-
total: number
|
|
4225
|
-
last24h: number
|
|
4226
|
-
last7d: number
|
|
4227
|
-
last30d: number
|
|
4228
|
-
distinctReporters: number
|
|
4224
|
+
total: number;
|
|
4225
|
+
last24h: number;
|
|
4226
|
+
last7d: number;
|
|
4227
|
+
last30d: number;
|
|
4228
|
+
distinctReporters: number;
|
|
4229
4229
|
/**
|
|
4230
4230
|
* Report count per `ReportCategory`.
|
|
4231
4231
|
* @public
|
|
4232
4232
|
*/
|
|
4233
|
-
byCategory: Record<string, number
|
|
4233
|
+
byCategory: Record<string, number>;
|
|
4234
4234
|
}
|
|
4235
4235
|
/**
|
|
4236
4236
|
* @public
|
|
4237
4237
|
*/
|
|
4238
4238
|
export interface ModerationSignals {
|
|
4239
|
-
reportsReceived: ReportsReceivedSignals
|
|
4240
|
-
reportsFiled: ReportsFiledSignals
|
|
4241
|
-
blocksReceived: BlocksReceivedSignals
|
|
4242
|
-
conversations: ConversationSignals
|
|
4239
|
+
reportsReceived: ReportsReceivedSignals;
|
|
4240
|
+
reportsFiled: ReportsFiledSignals;
|
|
4241
|
+
blocksReceived: BlocksReceivedSignals;
|
|
4242
|
+
conversations: ConversationSignals;
|
|
4243
4243
|
/**
|
|
4244
4244
|
* Absent (null) when the account's creation time is unknown.
|
|
4245
4245
|
* @public
|
|
@@ -4249,35 +4249,35 @@ export interface ModerationSignals {
|
|
|
4249
4249
|
* Reports this member filed against someone who also reported them.
|
|
4250
4250
|
* @public
|
|
4251
4251
|
*/
|
|
4252
|
-
reciprocalReports: number
|
|
4252
|
+
reciprocalReports: number;
|
|
4253
4253
|
}
|
|
4254
4254
|
/**
|
|
4255
4255
|
* @public
|
|
4256
4256
|
*/
|
|
4257
4257
|
export interface GetStateRequest {
|
|
4258
|
-
userId: string
|
|
4258
|
+
userId: string;
|
|
4259
4259
|
}
|
|
4260
4260
|
/**
|
|
4261
4261
|
* One of the member's current hooks.
|
|
4262
4262
|
* @public
|
|
4263
4263
|
*/
|
|
4264
4264
|
export interface HookSummary {
|
|
4265
|
-
matchId: string
|
|
4265
|
+
matchId: string;
|
|
4266
4266
|
/**
|
|
4267
4267
|
* The other member of the hook.
|
|
4268
4268
|
* @public
|
|
4269
4269
|
*/
|
|
4270
|
-
peerId: string
|
|
4270
|
+
peerId: string;
|
|
4271
4271
|
/**
|
|
4272
4272
|
* How a hook was formed.
|
|
4273
4273
|
* @public
|
|
4274
4274
|
*/
|
|
4275
|
-
origin: HookOrigin
|
|
4275
|
+
origin: HookOrigin;
|
|
4276
4276
|
/**
|
|
4277
4277
|
* Epoch seconds when the hook was created.
|
|
4278
4278
|
* @public
|
|
4279
4279
|
*/
|
|
4280
|
-
hookedAt: number
|
|
4280
|
+
hookedAt: number;
|
|
4281
4281
|
/**
|
|
4282
4282
|
* True while the conversation is suspended (a member of it must choose which hooks to keep).
|
|
4283
4283
|
* @public
|
|
@@ -4288,14 +4288,14 @@ export interface HookSummary {
|
|
|
4288
4288
|
* @public
|
|
4289
4289
|
*/
|
|
4290
4290
|
export interface UserStateResponse {
|
|
4291
|
-
userId: string
|
|
4292
|
-
state: string
|
|
4293
|
-
activeConnections: number
|
|
4291
|
+
userId: string;
|
|
4292
|
+
state: string;
|
|
4293
|
+
activeConnections: number;
|
|
4294
4294
|
/**
|
|
4295
4295
|
* Ids of the member's current hooks. Derived from `hooks`; kept while clients move to `hooks`.
|
|
4296
4296
|
* @public
|
|
4297
4297
|
*/
|
|
4298
|
-
matchIds: (string)[]
|
|
4298
|
+
matchIds: (string)[];
|
|
4299
4299
|
/**
|
|
4300
4300
|
* A OneHook membership tier. The member values are the wire values persisted in Cognito
|
|
4301
4301
|
* (`custom:subscriptionTier`), DynamoDB and Postgres. Members are declared in ascending order
|
|
@@ -4303,7 +4303,7 @@ export interface UserStateResponse {
|
|
|
4303
4303
|
* treated as the lowest tier (Must) and raises the UnknownSubscriptionTier alarm.
|
|
4304
4304
|
* @public
|
|
4305
4305
|
*/
|
|
4306
|
-
subscriptionTier: SubscriptionTier
|
|
4306
|
+
subscriptionTier: SubscriptionTier;
|
|
4307
4307
|
/**
|
|
4308
4308
|
* The member's current hooks, with the partner of each. Both hook origins count toward capacity.
|
|
4309
4309
|
* @public
|
|
@@ -4364,7 +4364,7 @@ export interface InitUserRequest {
|
|
|
4364
4364
|
* @public
|
|
4365
4365
|
*/
|
|
4366
4366
|
export interface KeepHooksRequest {
|
|
4367
|
-
matchIds: (string)[]
|
|
4367
|
+
matchIds: (string)[];
|
|
4368
4368
|
}
|
|
4369
4369
|
/**
|
|
4370
4370
|
* @public
|
|
@@ -4379,7 +4379,7 @@ export interface ListBlocksResponse {
|
|
|
4379
4379
|
* Newest first.
|
|
4380
4380
|
* @public
|
|
4381
4381
|
*/
|
|
4382
|
-
blocks: (BlockView)[]
|
|
4382
|
+
blocks: (BlockView)[];
|
|
4383
4383
|
}
|
|
4384
4384
|
/**
|
|
4385
4385
|
* @public
|
|
@@ -4401,19 +4401,19 @@ export interface ListHookRequestsRequest {
|
|
|
4401
4401
|
* Which side of the caller's requests to list.
|
|
4402
4402
|
* @public
|
|
4403
4403
|
*/
|
|
4404
|
-
direction: HookRequestDirection
|
|
4404
|
+
direction: HookRequestDirection;
|
|
4405
4405
|
}
|
|
4406
4406
|
/**
|
|
4407
4407
|
* One hook request, as the caller may see it.
|
|
4408
4408
|
* @public
|
|
4409
4409
|
*/
|
|
4410
4410
|
export interface HookRequestItem {
|
|
4411
|
-
requestId: string
|
|
4411
|
+
requestId: string;
|
|
4412
4412
|
/**
|
|
4413
4413
|
* Epoch seconds when it was sent.
|
|
4414
4414
|
* @public
|
|
4415
4415
|
*/
|
|
4416
|
-
createdAt: number
|
|
4416
|
+
createdAt: number;
|
|
4417
4417
|
/**
|
|
4418
4418
|
* INCOMING only: true while the caller has no free slot. A locked request does not name its
|
|
4419
4419
|
* sender ("Unhook to see this request") and cannot be accepted.
|
|
@@ -4435,7 +4435,7 @@ export interface HookRequestItem {
|
|
|
4435
4435
|
* Epoch seconds when it expires (30 days after it was sent).
|
|
4436
4436
|
* @public
|
|
4437
4437
|
*/
|
|
4438
|
-
expiresAt: number
|
|
4438
|
+
expiresAt: number;
|
|
4439
4439
|
}
|
|
4440
4440
|
/**
|
|
4441
4441
|
* @public
|
|
@@ -4445,8 +4445,8 @@ export interface ListHookRequestsResponse {
|
|
|
4445
4445
|
* Which side of the caller's requests to list.
|
|
4446
4446
|
* @public
|
|
4447
4447
|
*/
|
|
4448
|
-
direction: HookRequestDirection
|
|
4449
|
-
requests: (HookRequestItem)[]
|
|
4448
|
+
direction: HookRequestDirection;
|
|
4449
|
+
requests: (HookRequestItem)[];
|
|
4450
4450
|
/**
|
|
4451
4451
|
* INCOMING only: view pass (`aud` profile.chat) naming the senders of the unlocked requests.
|
|
4452
4452
|
* @public
|
|
@@ -4473,12 +4473,12 @@ export interface ListMatchingOnMembersRequest {
|
|
|
4473
4473
|
* @public
|
|
4474
4474
|
*/
|
|
4475
4475
|
export interface MatchingOnMember {
|
|
4476
|
-
userId: string
|
|
4476
|
+
userId: string;
|
|
4477
4477
|
/**
|
|
4478
4478
|
* The member's current matching generation.
|
|
4479
4479
|
* @public
|
|
4480
4480
|
*/
|
|
4481
|
-
generation: number
|
|
4481
|
+
generation: number;
|
|
4482
4482
|
}
|
|
4483
4483
|
/**
|
|
4484
4484
|
* @public
|
|
@@ -4488,7 +4488,7 @@ export interface ListMatchingOnMembersResponse {
|
|
|
4488
4488
|
* At most `limit` members. A page may be empty while `nextToken` is present.
|
|
4489
4489
|
* @public
|
|
4490
4490
|
*/
|
|
4491
|
-
members: (MatchingOnMember)[]
|
|
4491
|
+
members: (MatchingOnMember)[];
|
|
4492
4492
|
/**
|
|
4493
4493
|
* Absent on the last page.
|
|
4494
4494
|
* @public
|
|
@@ -4499,12 +4499,12 @@ export interface ListMatchingOnMembersResponse {
|
|
|
4499
4499
|
* @public
|
|
4500
4500
|
*/
|
|
4501
4501
|
export interface ReportMemberRequest {
|
|
4502
|
-
reportedUserId: string
|
|
4502
|
+
reportedUserId: string;
|
|
4503
4503
|
/**
|
|
4504
4504
|
* What a report is about.
|
|
4505
4505
|
* @public
|
|
4506
4506
|
*/
|
|
4507
|
-
category: ReportCategory
|
|
4507
|
+
category: ReportCategory;
|
|
4508
4508
|
/**
|
|
4509
4509
|
* Required for OTHER; at most 2000 characters.
|
|
4510
4510
|
* @public
|
|
@@ -4526,13 +4526,13 @@ export interface ReportMemberRequest {
|
|
|
4526
4526
|
* @public
|
|
4527
4527
|
*/
|
|
4528
4528
|
export interface ReportMemberResponse {
|
|
4529
|
-
reportId: string
|
|
4529
|
+
reportId: string;
|
|
4530
4530
|
/**
|
|
4531
4531
|
* critical, high or standard.
|
|
4532
4532
|
* @public
|
|
4533
4533
|
*/
|
|
4534
|
-
severity: string
|
|
4535
|
-
evidenceAllowed: boolean
|
|
4534
|
+
severity: string;
|
|
4535
|
+
evidenceAllowed: boolean;
|
|
4536
4536
|
}
|
|
4537
4537
|
/**
|
|
4538
4538
|
* @public
|
|
@@ -4542,7 +4542,7 @@ export interface SendHookRequestRequest {
|
|
|
4542
4542
|
* The recipient's username, as the sender typed it.
|
|
4543
4543
|
* @public
|
|
4544
4544
|
*/
|
|
4545
|
-
username: string
|
|
4545
|
+
username: string;
|
|
4546
4546
|
}
|
|
4547
4547
|
/**
|
|
4548
4548
|
* @public
|
|
@@ -4552,7 +4552,7 @@ export interface SetMatchingTabHiddenRequest {
|
|
|
4552
4552
|
* True hides the Matching tab while matching is not ON; false shows it again.
|
|
4553
4553
|
* @public
|
|
4554
4554
|
*/
|
|
4555
|
-
hidden: boolean
|
|
4555
|
+
hidden: boolean;
|
|
4556
4556
|
}
|
|
4557
4557
|
/**
|
|
4558
4558
|
* @public
|
|
@@ -4562,13 +4562,13 @@ export interface SetMatchingTabHiddenResponse {
|
|
|
4562
4562
|
* The stored value.
|
|
4563
4563
|
* @public
|
|
4564
4564
|
*/
|
|
4565
|
-
hidden: boolean
|
|
4565
|
+
hidden: boolean;
|
|
4566
4566
|
}
|
|
4567
4567
|
/**
|
|
4568
4568
|
* @public
|
|
4569
4569
|
*/
|
|
4570
4570
|
export interface SetTierOverrideRequest {
|
|
4571
|
-
targetUserId: string
|
|
4571
|
+
targetUserId: string;
|
|
4572
4572
|
/**
|
|
4573
4573
|
* A OneHook membership tier. The member values are the wire values persisted in Cognito
|
|
4574
4574
|
* (`custom:subscriptionTier`), DynamoDB and Postgres. Members are declared in ascending order
|
|
@@ -4576,29 +4576,29 @@ export interface SetTierOverrideRequest {
|
|
|
4576
4576
|
* treated as the lowest tier (Must) and raises the UnknownSubscriptionTier alarm.
|
|
4577
4577
|
* @public
|
|
4578
4578
|
*/
|
|
4579
|
-
tier: SubscriptionTier
|
|
4579
|
+
tier: SubscriptionTier;
|
|
4580
4580
|
/**
|
|
4581
4581
|
* Why the member gets the tier for free. Required: an unexplained payment bypass is unauditable.
|
|
4582
4582
|
* @public
|
|
4583
4583
|
*/
|
|
4584
|
-
reason: string
|
|
4584
|
+
reason: string;
|
|
4585
4585
|
/**
|
|
4586
4586
|
* Epoch seconds, in the future. Required: every override must end.
|
|
4587
4587
|
* @public
|
|
4588
4588
|
*/
|
|
4589
|
-
expiresAt: number
|
|
4589
|
+
expiresAt: number;
|
|
4590
4590
|
}
|
|
4591
4591
|
/**
|
|
4592
4592
|
* @public
|
|
4593
4593
|
*/
|
|
4594
4594
|
export interface UnblockUserRequest {
|
|
4595
|
-
blockedUserId: string
|
|
4595
|
+
blockedUserId: string;
|
|
4596
4596
|
}
|
|
4597
4597
|
/**
|
|
4598
4598
|
* @public
|
|
4599
4599
|
*/
|
|
4600
4600
|
export interface UnhookRequest {
|
|
4601
|
-
matchId: string
|
|
4601
|
+
matchId: string;
|
|
4602
4602
|
reason?: string | undefined;
|
|
4603
4603
|
}
|
|
4604
4604
|
/**
|
|
@@ -4610,14 +4610,14 @@ export interface UpgradeUserRequest {
|
|
|
4610
4610
|
* @public
|
|
4611
4611
|
*/
|
|
4612
4612
|
export interface InviteNode {
|
|
4613
|
-
userId: string
|
|
4614
|
-
depth: number
|
|
4613
|
+
userId: string;
|
|
4614
|
+
depth: number;
|
|
4615
4615
|
/**
|
|
4616
4616
|
* Epoch millis. Absent for the root.
|
|
4617
4617
|
* @public
|
|
4618
4618
|
*/
|
|
4619
4619
|
invitedAt?: number | undefined;
|
|
4620
|
-
children: (InviteNode)[]
|
|
4620
|
+
children: (InviteNode)[];
|
|
4621
4621
|
/**
|
|
4622
4622
|
* True when this node has invitees the walk did not include.
|
|
4623
4623
|
* @public
|
|
@@ -4628,11 +4628,11 @@ export interface InviteNode {
|
|
|
4628
4628
|
* @public
|
|
4629
4629
|
*/
|
|
4630
4630
|
export interface GraphInviteTree {
|
|
4631
|
-
root: InviteNode
|
|
4632
|
-
totalInvitees: number
|
|
4631
|
+
root: InviteNode;
|
|
4632
|
+
totalInvitees: number;
|
|
4633
4633
|
/**
|
|
4634
4634
|
* True when the depth or node budget cut the walk short.
|
|
4635
4635
|
* @public
|
|
4636
4636
|
*/
|
|
4637
|
-
truncated: boolean
|
|
4637
|
+
truncated: boolean;
|
|
4638
4638
|
}
|