onehook-api-client 1.0.27 → 1.0.29
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 +35 -0
- package/dist-cjs/OneHook.js +10 -0
- package/dist-cjs/commands/DiscoverByIntentCommand.js +21 -0
- package/dist-cjs/commands/DiscoverSuggestedCommand.js +21 -0
- package/dist-cjs/commands/GetAccountStateCommand.js +21 -0
- package/dist-cjs/commands/GetAdminPhoneStatusCommand.js +21 -0
- package/dist-cjs/commands/SetAccountStateCommand.js +21 -0
- package/dist-cjs/commands/index.js +5 -0
- package/dist-cjs/models/models_0.js +30 -1
- package/dist-cjs/protocols/Aws_restJson1.js +190 -3
- package/dist-cjs/telemetry/index.js +38 -2
- package/dist-es/OneHook.js +10 -0
- package/dist-es/commands/DiscoverByIntentCommand.js +17 -0
- package/dist-es/commands/DiscoverSuggestedCommand.js +17 -0
- package/dist-es/commands/GetAccountStateCommand.js +17 -0
- package/dist-es/commands/GetAdminPhoneStatusCommand.js +17 -0
- package/dist-es/commands/SetAccountStateCommand.js +17 -0
- package/dist-es/commands/index.js +5 -0
- package/dist-es/models/models_0.js +28 -0
- package/dist-es/protocols/Aws_restJson1.js +178 -1
- package/dist-es/telemetry/index.js +38 -2
- package/dist-types/OneHook.d.ts +35 -0
- package/dist-types/OneHookClient.d.ts +7 -2
- package/dist-types/commands/DiscoverByIntentCommand.d.ts +97 -0
- package/dist-types/commands/DiscoverCommand.d.ts +4 -0
- package/dist-types/commands/DiscoverSuggestedCommand.d.ts +92 -0
- package/dist-types/commands/GetAccountStateCommand.d.ts +83 -0
- package/dist-types/commands/GetAdminPhoneStatusCommand.d.ts +86 -0
- package/dist-types/commands/SetAccountStateCommand.d.ts +95 -0
- package/dist-types/commands/index.d.ts +5 -0
- package/dist-types/models/models_0.d.ts +188 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +45 -0
- package/dist-types/telemetry/index.d.ts +22 -2
- package/package.json +1 -1
- package/telemetry/TelemetryCatalog.kt +22 -4
- package/telemetry/TelemetryCatalog.swift +38 -4
- package/telemetry/telemetry-catalog.json +264 -2
|
@@ -657,6 +657,65 @@ export interface GenerateInviteResponse {
|
|
|
657
657
|
expiresAt: number | undefined;
|
|
658
658
|
maxUses: number | undefined;
|
|
659
659
|
}
|
|
660
|
+
/**
|
|
661
|
+
* @public
|
|
662
|
+
*/
|
|
663
|
+
export interface GetAccountStateRequest {
|
|
664
|
+
userId: string | undefined;
|
|
665
|
+
}
|
|
666
|
+
/**
|
|
667
|
+
* @public
|
|
668
|
+
* @enum
|
|
669
|
+
*/
|
|
670
|
+
export declare const AccountState: {
|
|
671
|
+
readonly ACTIVE: "ACTIVE";
|
|
672
|
+
readonly BANNED: "BANNED";
|
|
673
|
+
readonly RESTRICTED: "RESTRICTED";
|
|
674
|
+
readonly SUSPENDED: "SUSPENDED";
|
|
675
|
+
};
|
|
676
|
+
/**
|
|
677
|
+
* @public
|
|
678
|
+
*/
|
|
679
|
+
export type AccountState = typeof AccountState[keyof typeof AccountState];
|
|
680
|
+
/**
|
|
681
|
+
* @public
|
|
682
|
+
*/
|
|
683
|
+
export interface GetAccountStateResponse {
|
|
684
|
+
/**
|
|
685
|
+
* The moderation account state a member can be in. Absent/`ACTIVE` means no restriction. Owned by
|
|
686
|
+
* Identity (sign-in and token refresh enforce it directly); Matching and the admin portal consume
|
|
687
|
+
* the `AccountStateChanged` event.
|
|
688
|
+
* @public
|
|
689
|
+
*/
|
|
690
|
+
state: AccountState | undefined;
|
|
691
|
+
/**
|
|
692
|
+
* Epoch ms the state expires; absent for ACTIVE and BANNED.
|
|
693
|
+
* @public
|
|
694
|
+
*/
|
|
695
|
+
until?: number | undefined;
|
|
696
|
+
version: number | undefined;
|
|
697
|
+
/**
|
|
698
|
+
* The reason code for the current state; absent when ACTIVE.
|
|
699
|
+
* @public
|
|
700
|
+
*/
|
|
701
|
+
reasonCode?: string | undefined;
|
|
702
|
+
}
|
|
703
|
+
/**
|
|
704
|
+
* @public
|
|
705
|
+
*/
|
|
706
|
+
export interface GetAdminPhoneStatusRequest {
|
|
707
|
+
phoneNumber: string | undefined;
|
|
708
|
+
}
|
|
709
|
+
/**
|
|
710
|
+
* @public
|
|
711
|
+
*/
|
|
712
|
+
export interface GetAdminPhoneStatusResponse {
|
|
713
|
+
/**
|
|
714
|
+
* True when the phone is bound to an existing account OR claimed by an in-progress registration.
|
|
715
|
+
* @public
|
|
716
|
+
*/
|
|
717
|
+
registered: boolean | undefined;
|
|
718
|
+
}
|
|
660
719
|
/**
|
|
661
720
|
* @public
|
|
662
721
|
*/
|
|
@@ -836,6 +895,69 @@ export interface SendAdminLinkOtpResponse {
|
|
|
836
895
|
*/
|
|
837
896
|
maskedPhone: string | undefined;
|
|
838
897
|
}
|
|
898
|
+
/**
|
|
899
|
+
* @public
|
|
900
|
+
*/
|
|
901
|
+
export declare class ConflictError extends __BaseException {
|
|
902
|
+
readonly name: "ConflictError";
|
|
903
|
+
readonly $fault: "client";
|
|
904
|
+
error: string | undefined;
|
|
905
|
+
/**
|
|
906
|
+
* @internal
|
|
907
|
+
*/
|
|
908
|
+
constructor(opts: __ExceptionOptionType<ConflictError, __BaseException>);
|
|
909
|
+
}
|
|
910
|
+
/**
|
|
911
|
+
* @public
|
|
912
|
+
*/
|
|
913
|
+
export interface SetAccountStateRequest {
|
|
914
|
+
userId: string | undefined;
|
|
915
|
+
/**
|
|
916
|
+
* The moderation account state a member can be in. Absent/`ACTIVE` means no restriction. Owned by
|
|
917
|
+
* Identity (sign-in and token refresh enforce it directly); Matching and the admin portal consume
|
|
918
|
+
* the `AccountStateChanged` event.
|
|
919
|
+
* @public
|
|
920
|
+
*/
|
|
921
|
+
state: AccountState | undefined;
|
|
922
|
+
/**
|
|
923
|
+
* Machine-readable reason code (never free text / PII).
|
|
924
|
+
* @public
|
|
925
|
+
*/
|
|
926
|
+
reasonCode: string | undefined;
|
|
927
|
+
/**
|
|
928
|
+
* Epoch ms the RESTRICTED/SUSPENDED state expires. Required for those states; rejected for BANNED.
|
|
929
|
+
* @public
|
|
930
|
+
*/
|
|
931
|
+
until?: number | undefined;
|
|
932
|
+
/**
|
|
933
|
+
* The admin actor id taking the action (audit).
|
|
934
|
+
* @public
|
|
935
|
+
*/
|
|
936
|
+
actor: string | undefined;
|
|
937
|
+
/**
|
|
938
|
+
* Optional optimistic-concurrency token from GetAccountState; a mismatch returns 409.
|
|
939
|
+
* @public
|
|
940
|
+
*/
|
|
941
|
+
expectedVersion?: number | undefined;
|
|
942
|
+
}
|
|
943
|
+
/**
|
|
944
|
+
* @public
|
|
945
|
+
*/
|
|
946
|
+
export interface SetAccountStateResponse {
|
|
947
|
+
/**
|
|
948
|
+
* The moderation account state a member can be in. Absent/`ACTIVE` means no restriction. Owned by
|
|
949
|
+
* Identity (sign-in and token refresh enforce it directly); Matching and the admin portal consume
|
|
950
|
+
* the `AccountStateChanged` event.
|
|
951
|
+
* @public
|
|
952
|
+
*/
|
|
953
|
+
state: AccountState | undefined;
|
|
954
|
+
/**
|
|
955
|
+
* Epoch ms the state expires; absent for ACTIVE and BANNED.
|
|
956
|
+
* @public
|
|
957
|
+
*/
|
|
958
|
+
until?: number | undefined;
|
|
959
|
+
version: number | undefined;
|
|
960
|
+
}
|
|
839
961
|
/**
|
|
840
962
|
* @public
|
|
841
963
|
*/
|
|
@@ -976,6 +1098,38 @@ export interface DiscoverRequest {
|
|
|
976
1098
|
lat: number | undefined;
|
|
977
1099
|
lon: number | undefined;
|
|
978
1100
|
}
|
|
1101
|
+
/**
|
|
1102
|
+
* @public
|
|
1103
|
+
* @enum
|
|
1104
|
+
*/
|
|
1105
|
+
export declare const MatchFinder: {
|
|
1106
|
+
/**
|
|
1107
|
+
* OneHook suggested the candidate: the caller asked OneHook AI (`DiscoverByIntent`) or OneHook
|
|
1108
|
+
* inferred the caller's inclination (`DiscoverSuggested`).
|
|
1109
|
+
*/
|
|
1110
|
+
readonly MR_ONEHOOK: "MR_ONEHOOK";
|
|
1111
|
+
/**
|
|
1112
|
+
* The candidate's profile details match the caller's details and preferences (standard
|
|
1113
|
+
* discovery, `Discover`).
|
|
1114
|
+
*/
|
|
1115
|
+
readonly ONEHOOK_INTELLIGENCE: "ONEHOOK_INTELLIGENCE";
|
|
1116
|
+
};
|
|
1117
|
+
/**
|
|
1118
|
+
* @public
|
|
1119
|
+
*/
|
|
1120
|
+
export type MatchFinder = typeof MatchFinder[keyof typeof MatchFinder];
|
|
1121
|
+
/**
|
|
1122
|
+
* @public
|
|
1123
|
+
* @enum
|
|
1124
|
+
*/
|
|
1125
|
+
export declare const SuggestionBasis: {
|
|
1126
|
+
readonly EXPLICIT_REQUEST: "EXPLICIT_REQUEST";
|
|
1127
|
+
readonly INFERRED_INCLINATION: "INFERRED_INCLINATION";
|
|
1128
|
+
};
|
|
1129
|
+
/**
|
|
1130
|
+
* @public
|
|
1131
|
+
*/
|
|
1132
|
+
export type SuggestionBasis = typeof SuggestionBasis[keyof typeof SuggestionBasis];
|
|
979
1133
|
/**
|
|
980
1134
|
* @public
|
|
981
1135
|
*/
|
|
@@ -983,6 +1137,28 @@ export interface CandidateDto {
|
|
|
983
1137
|
userId: string | undefined;
|
|
984
1138
|
distanceKm: number | undefined;
|
|
985
1139
|
score: number | undefined;
|
|
1140
|
+
/**
|
|
1141
|
+
* Who found this candidate. How (and whether) to show it is up to the client.
|
|
1142
|
+
* @public
|
|
1143
|
+
*/
|
|
1144
|
+
matchFinder: MatchFinder | undefined;
|
|
1145
|
+
/**
|
|
1146
|
+
* Display name of `matchFinder`: "OneHook Intelligence" or "Mr. OneHook".
|
|
1147
|
+
* @public
|
|
1148
|
+
*/
|
|
1149
|
+
matchFinderLabel: string | undefined;
|
|
1150
|
+
/**
|
|
1151
|
+
* Only for `MR_ONEHOOK`: whether the caller asked (`EXPLICIT_REQUEST`) or OneHook inferred the
|
|
1152
|
+
* inclination from the caller's likes (`INFERRED_INCLINATION`).
|
|
1153
|
+
* @public
|
|
1154
|
+
*/
|
|
1155
|
+
suggestionBasis?: SuggestionBasis | undefined;
|
|
1156
|
+
/**
|
|
1157
|
+
* Only for `MR_ONEHOOK`: cosine similarity (-1 to 1) between the request or inferred
|
|
1158
|
+
* inclination and the candidate's profile. Higher is closer.
|
|
1159
|
+
* @public
|
|
1160
|
+
*/
|
|
1161
|
+
similarity?: number | undefined;
|
|
986
1162
|
}
|
|
987
1163
|
/**
|
|
988
1164
|
* @public
|
|
@@ -992,6 +1168,18 @@ export interface DiscoverResponse {
|
|
|
992
1168
|
count: number | undefined;
|
|
993
1169
|
algorithm: string | undefined;
|
|
994
1170
|
}
|
|
1171
|
+
/**
|
|
1172
|
+
* @public
|
|
1173
|
+
*/
|
|
1174
|
+
export interface DiscoverByIntentRequest {
|
|
1175
|
+
lat: number | undefined;
|
|
1176
|
+
lon: number | undefined;
|
|
1177
|
+
/**
|
|
1178
|
+
* Who the caller is looking for, in their own words (3 to 1000 characters).
|
|
1179
|
+
* @public
|
|
1180
|
+
*/
|
|
1181
|
+
description: string | undefined;
|
|
1182
|
+
}
|
|
995
1183
|
/**
|
|
996
1184
|
* @public
|
|
997
1185
|
*/
|
|
@@ -8,10 +8,14 @@ import { CreateMediaUploadUrlCommandInput, CreateMediaUploadUrlCommandOutput } f
|
|
|
8
8
|
import { DeleteMatchMessagesCommandInput, DeleteMatchMessagesCommandOutput } from "../commands/DeleteMatchMessagesCommand";
|
|
9
9
|
import { DeleteProfileCommandInput, DeleteProfileCommandOutput } from "../commands/DeleteProfileCommand";
|
|
10
10
|
import { DeletePushTokenCommandInput, DeletePushTokenCommandOutput } from "../commands/DeletePushTokenCommand";
|
|
11
|
+
import { DiscoverByIntentCommandInput, DiscoverByIntentCommandOutput } from "../commands/DiscoverByIntentCommand";
|
|
11
12
|
import { DiscoverCommandInput, DiscoverCommandOutput } from "../commands/DiscoverCommand";
|
|
13
|
+
import { DiscoverSuggestedCommandInput, DiscoverSuggestedCommandOutput } from "../commands/DiscoverSuggestedCommand";
|
|
12
14
|
import { GenerateDownloadUrlCommandInput, GenerateDownloadUrlCommandOutput } from "../commands/GenerateDownloadUrlCommand";
|
|
13
15
|
import { GenerateInviteCommandInput, GenerateInviteCommandOutput } from "../commands/GenerateInviteCommand";
|
|
14
16
|
import { GenerateUploadUrlCommandInput, GenerateUploadUrlCommandOutput } from "../commands/GenerateUploadUrlCommand";
|
|
17
|
+
import { GetAccountStateCommandInput, GetAccountStateCommandOutput } from "../commands/GetAccountStateCommand";
|
|
18
|
+
import { GetAdminPhoneStatusCommandInput, GetAdminPhoneStatusCommandOutput } from "../commands/GetAdminPhoneStatusCommand";
|
|
15
19
|
import { GetAiContextMatchCommandInput, GetAiContextMatchCommandOutput } from "../commands/GetAiContextMatchCommand";
|
|
16
20
|
import { GetChatSettingsCommandInput, GetChatSettingsCommandOutput } from "../commands/GetChatSettingsCommand";
|
|
17
21
|
import { GetCredentialReadinessCommandInput, GetCredentialReadinessCommandOutput } from "../commands/GetCredentialReadinessCommand";
|
|
@@ -42,6 +46,7 @@ import { RequestPhoneOtpCommandInput, RequestPhoneOtpCommandOutput } from "../co
|
|
|
42
46
|
import { RequestPhoneUpdateOtpCommandInput, RequestPhoneUpdateOtpCommandOutput } from "../commands/RequestPhoneUpdateOtpCommand";
|
|
43
47
|
import { RevokeDeviceCommandInput, RevokeDeviceCommandOutput } from "../commands/RevokeDeviceCommand";
|
|
44
48
|
import { SendAdminLinkOtpCommandInput, SendAdminLinkOtpCommandOutput } from "../commands/SendAdminLinkOtpCommand";
|
|
49
|
+
import { SetAccountStateCommandInput, SetAccountStateCommandOutput } from "../commands/SetAccountStateCommand";
|
|
45
50
|
import { SwipeByUsernameCommandInput, SwipeByUsernameCommandOutput } from "../commands/SwipeByUsernameCommand";
|
|
46
51
|
import { SwipeCommandInput, SwipeCommandOutput } from "../commands/SwipeCommand";
|
|
47
52
|
import { UnhookCommandInput, UnhookCommandOutput } from "../commands/UnhookCommand";
|
|
@@ -117,6 +122,14 @@ export declare const se_CreateAdminInviteCommand: (input: CreateAdminInviteComma
|
|
|
117
122
|
* serializeAws_restJson1GenerateInviteCommand
|
|
118
123
|
*/
|
|
119
124
|
export declare const se_GenerateInviteCommand: (input: GenerateInviteCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
125
|
+
/**
|
|
126
|
+
* serializeAws_restJson1GetAccountStateCommand
|
|
127
|
+
*/
|
|
128
|
+
export declare const se_GetAccountStateCommand: (input: GetAccountStateCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
129
|
+
/**
|
|
130
|
+
* serializeAws_restJson1GetAdminPhoneStatusCommand
|
|
131
|
+
*/
|
|
132
|
+
export declare const se_GetAdminPhoneStatusCommand: (input: GetAdminPhoneStatusCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
120
133
|
/**
|
|
121
134
|
* serializeAws_restJson1GetCredentialReadinessCommand
|
|
122
135
|
*/
|
|
@@ -161,6 +174,10 @@ export declare const se_RequestPhoneUpdateOtpCommand: (input: RequestPhoneUpdate
|
|
|
161
174
|
* serializeAws_restJson1SendAdminLinkOtpCommand
|
|
162
175
|
*/
|
|
163
176
|
export declare const se_SendAdminLinkOtpCommand: (input: SendAdminLinkOtpCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
177
|
+
/**
|
|
178
|
+
* serializeAws_restJson1SetAccountStateCommand
|
|
179
|
+
*/
|
|
180
|
+
export declare const se_SetAccountStateCommand: (input: SetAccountStateCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
164
181
|
/**
|
|
165
182
|
* serializeAws_restJson1UnlinkSocialCommand
|
|
166
183
|
*/
|
|
@@ -189,6 +206,14 @@ export declare const se_VerifyAdminLinkOtpCommand: (input: VerifyAdminLinkOtpCom
|
|
|
189
206
|
* serializeAws_restJson1DiscoverCommand
|
|
190
207
|
*/
|
|
191
208
|
export declare const se_DiscoverCommand: (input: DiscoverCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
209
|
+
/**
|
|
210
|
+
* serializeAws_restJson1DiscoverByIntentCommand
|
|
211
|
+
*/
|
|
212
|
+
export declare const se_DiscoverByIntentCommand: (input: DiscoverByIntentCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
213
|
+
/**
|
|
214
|
+
* serializeAws_restJson1DiscoverSuggestedCommand
|
|
215
|
+
*/
|
|
216
|
+
export declare const se_DiscoverSuggestedCommand: (input: DiscoverSuggestedCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
192
217
|
/**
|
|
193
218
|
* serializeAws_restJson1GetNotificationPreferencesCommand
|
|
194
219
|
*/
|
|
@@ -345,6 +370,14 @@ export declare const de_CreateAdminInviteCommand: (output: __HttpResponse, conte
|
|
|
345
370
|
* deserializeAws_restJson1GenerateInviteCommand
|
|
346
371
|
*/
|
|
347
372
|
export declare const de_GenerateInviteCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GenerateInviteCommandOutput>;
|
|
373
|
+
/**
|
|
374
|
+
* deserializeAws_restJson1GetAccountStateCommand
|
|
375
|
+
*/
|
|
376
|
+
export declare const de_GetAccountStateCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetAccountStateCommandOutput>;
|
|
377
|
+
/**
|
|
378
|
+
* deserializeAws_restJson1GetAdminPhoneStatusCommand
|
|
379
|
+
*/
|
|
380
|
+
export declare const de_GetAdminPhoneStatusCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetAdminPhoneStatusCommandOutput>;
|
|
348
381
|
/**
|
|
349
382
|
* deserializeAws_restJson1GetCredentialReadinessCommand
|
|
350
383
|
*/
|
|
@@ -389,6 +422,10 @@ export declare const de_RequestPhoneUpdateOtpCommand: (output: __HttpResponse, c
|
|
|
389
422
|
* deserializeAws_restJson1SendAdminLinkOtpCommand
|
|
390
423
|
*/
|
|
391
424
|
export declare const de_SendAdminLinkOtpCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<SendAdminLinkOtpCommandOutput>;
|
|
425
|
+
/**
|
|
426
|
+
* deserializeAws_restJson1SetAccountStateCommand
|
|
427
|
+
*/
|
|
428
|
+
export declare const de_SetAccountStateCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<SetAccountStateCommandOutput>;
|
|
392
429
|
/**
|
|
393
430
|
* deserializeAws_restJson1UnlinkSocialCommand
|
|
394
431
|
*/
|
|
@@ -417,6 +454,14 @@ export declare const de_VerifyAdminLinkOtpCommand: (output: __HttpResponse, cont
|
|
|
417
454
|
* deserializeAws_restJson1DiscoverCommand
|
|
418
455
|
*/
|
|
419
456
|
export declare const de_DiscoverCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DiscoverCommandOutput>;
|
|
457
|
+
/**
|
|
458
|
+
* deserializeAws_restJson1DiscoverByIntentCommand
|
|
459
|
+
*/
|
|
460
|
+
export declare const de_DiscoverByIntentCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DiscoverByIntentCommandOutput>;
|
|
461
|
+
/**
|
|
462
|
+
* deserializeAws_restJson1DiscoverSuggestedCommand
|
|
463
|
+
*/
|
|
464
|
+
export declare const de_DiscoverSuggestedCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DiscoverSuggestedCommandOutput>;
|
|
420
465
|
/**
|
|
421
466
|
* deserializeAws_restJson1GetNotificationPreferencesCommand
|
|
422
467
|
*/
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
export declare const TELEMETRY_CATALOG_VERSION = "1.
|
|
2
|
-
export declare const TELEMETRY_CATALOG_HASH = "
|
|
1
|
+
export declare const TELEMETRY_CATALOG_VERSION = "1.5.0";
|
|
2
|
+
export declare const TELEMETRY_CATALOG_HASH = "4ab81c4d5f20cdb7";
|
|
3
3
|
/** Every signal type the ingest accepts. */
|
|
4
4
|
export declare const SignalType: {
|
|
5
5
|
readonly SCREEN_VIEW: "screen_view";
|
|
@@ -35,6 +35,8 @@ export declare const Screen: {
|
|
|
35
35
|
readonly LANDING: "LANDING";
|
|
36
36
|
readonly LOGIN: "LOGIN";
|
|
37
37
|
readonly REDEEM_INVITE: "REDEEM_INVITE";
|
|
38
|
+
readonly ADMISSIONS: "ADMISSIONS";
|
|
39
|
+
readonly ADMISSIONS_STATUS: "ADMISSIONS_STATUS";
|
|
38
40
|
readonly ONBOARDING: "ONBOARDING";
|
|
39
41
|
readonly DISCOVER: "DISCOVER";
|
|
40
42
|
readonly LIKE_COMPOSER: "LIKE_COMPOSER";
|
|
@@ -61,6 +63,8 @@ export declare const ViewableScreen: {
|
|
|
61
63
|
readonly LANDING: "LANDING";
|
|
62
64
|
readonly LOGIN: "LOGIN";
|
|
63
65
|
readonly REDEEM_INVITE: "REDEEM_INVITE";
|
|
66
|
+
readonly ADMISSIONS: "ADMISSIONS";
|
|
67
|
+
readonly ADMISSIONS_STATUS: "ADMISSIONS_STATUS";
|
|
64
68
|
readonly ONBOARDING: "ONBOARDING";
|
|
65
69
|
readonly DISCOVER: "DISCOVER";
|
|
66
70
|
readonly LIKE_COMPOSER: "LIKE_COMPOSER";
|
|
@@ -221,6 +225,22 @@ export declare const UiElement: {
|
|
|
221
225
|
readonly REDEEM_INVITE_LOGIN: "redeem_invite.login";
|
|
222
226
|
readonly REDEEM_INVITE_CLOSE: "redeem_invite.close";
|
|
223
227
|
readonly REDEEM_INVITE_RESEND_CODE: "redeem_invite.resend_code";
|
|
228
|
+
readonly REDEEM_INVITE_GET_INVITE_VIDEO: "redeem_invite.get_invite_video";
|
|
229
|
+
readonly ADMISSIONS_SUBMIT: "admissions.submit";
|
|
230
|
+
readonly ADMISSIONS_RESEND_CODE: "admissions.resend_code";
|
|
231
|
+
readonly ADMISSIONS_CONSENT_TOGGLE: "admissions.consent_toggle";
|
|
232
|
+
readonly ADMISSIONS_PRIVACY_POLICY: "admissions.privacy_policy";
|
|
233
|
+
readonly ADMISSIONS_RECORD_START: "admissions.record_start";
|
|
234
|
+
readonly ADMISSIONS_RECORD_STOP: "admissions.record_stop";
|
|
235
|
+
readonly ADMISSIONS_RETAKE: "admissions.retake";
|
|
236
|
+
readonly ADMISSIONS_PREVIEW_PLAY: "admissions.preview_play";
|
|
237
|
+
readonly ADMISSIONS_UPLOAD_RETRY: "admissions.upload_retry";
|
|
238
|
+
readonly ADMISSIONS_CLOSE: "admissions.close";
|
|
239
|
+
readonly ADMISSIONS_OPEN_SETTINGS: "admissions.open_settings";
|
|
240
|
+
readonly ADMISSIONS_STATUS_REFRESH: "admissions_status.refresh";
|
|
241
|
+
readonly ADMISSIONS_STATUS_CONTINUE_INVITE: "admissions_status.continue_invite";
|
|
242
|
+
readonly ADMISSIONS_STATUS_WITHDRAW: "admissions_status.withdraw";
|
|
243
|
+
readonly ADMISSIONS_STATUS_TRAINING_OPT_OUT: "admissions_status.training_opt_out";
|
|
224
244
|
readonly ONBOARDING_NEXT: "onboarding.next";
|
|
225
245
|
readonly ONBOARDING_BACK: "onboarding.back";
|
|
226
246
|
readonly ONBOARDING_FINISH: "onboarding.finish";
|
package/package.json
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
// GENERATED FILE - DO NOT EDIT.
|
|
2
|
-
// telemetry-integrity: sha256
|
|
2
|
+
// telemetry-integrity: sha256 3091bbcbb567b7b47f66e7efd890d871ed488d5b19bd71540620db946df92c97
|
|
3
3
|
// Source of truth: OneHookBackend/packages/telemetry/src/catalog.ts
|
|
4
4
|
// Regenerate: (OneHookBackend) npm run telemetry:generate && npm run telemetry:sync
|
|
5
|
-
// Catalog version 1.
|
|
5
|
+
// Catalog version 1.5.0, hash 4ab81c4d5f20cdb7.
|
|
6
6
|
//
|
|
7
7
|
// HARD RULE: every user interaction MUST emit ui_interaction with an id from THIS file, and
|
|
8
8
|
// ids are controlled by the backend. Read TELEMETRY_CONTRACT.txt (printed by every build).
|
|
@@ -12,8 +12,8 @@
|
|
|
12
12
|
package club.onehook.telemetry
|
|
13
13
|
|
|
14
14
|
object TelemetryCatalog {
|
|
15
|
-
const val VERSION = "1.
|
|
16
|
-
const val HASH = "
|
|
15
|
+
const val VERSION = "1.5.0"
|
|
16
|
+
const val HASH = "4ab81c4d5f20cdb7"
|
|
17
17
|
/** The only allowed `telemetry-exempt: <category>: <reason>` categories (see the catalog). */
|
|
18
18
|
val EXEMPT_CATEGORIES: List<String> = listOf("duplicate", "backdrop", "gesture", "continuous", "disabled")
|
|
19
19
|
}
|
|
@@ -61,6 +61,8 @@ enum class TelemetryScreen(val wire: String, val viewable: Boolean) {
|
|
|
61
61
|
LANDING("LANDING", true),
|
|
62
62
|
LOGIN("LOGIN", true),
|
|
63
63
|
REDEEM_INVITE("REDEEM_INVITE", true),
|
|
64
|
+
ADMISSIONS("ADMISSIONS", true),
|
|
65
|
+
ADMISSIONS_STATUS("ADMISSIONS_STATUS", true),
|
|
64
66
|
ONBOARDING("ONBOARDING", true),
|
|
65
67
|
DISCOVER("DISCOVER", true),
|
|
66
68
|
LIKE_COMPOSER("LIKE_COMPOSER", true),
|
|
@@ -274,6 +276,22 @@ enum class UiElement(
|
|
|
274
276
|
REDEEM_INVITE_LOGIN("redeem_invite.login", TelemetryScreen.REDEEM_INVITE, UiElementKind.LINK, listOf(UiAction.TAP), null, listOf(TelemetryPlatform.WEB, TelemetryPlatform.IOS, TelemetryPlatform.ANDROID)),
|
|
275
277
|
REDEEM_INVITE_CLOSE("redeem_invite.close", TelemetryScreen.REDEEM_INVITE, UiElementKind.BUTTON, listOf(UiAction.TAP), null, listOf(TelemetryPlatform.IOS, TelemetryPlatform.ANDROID)),
|
|
276
278
|
REDEEM_INVITE_RESEND_CODE("redeem_invite.resend_code", TelemetryScreen.REDEEM_INVITE, UiElementKind.LINK, listOf(UiAction.TAP), null, listOf(TelemetryPlatform.WEB, TelemetryPlatform.IOS)),
|
|
279
|
+
REDEEM_INVITE_GET_INVITE_VIDEO("redeem_invite.get_invite_video", TelemetryScreen.REDEEM_INVITE, UiElementKind.BUTTON, listOf(UiAction.TAP), null, listOf(TelemetryPlatform.IOS, TelemetryPlatform.ANDROID)),
|
|
280
|
+
ADMISSIONS_SUBMIT("admissions.submit", TelemetryScreen.ADMISSIONS, UiElementKind.BUTTON, listOf(UiAction.SUBMIT), listOf("send_code", "verify_code", "submit_application"), listOf(TelemetryPlatform.IOS, TelemetryPlatform.ANDROID)),
|
|
281
|
+
ADMISSIONS_RESEND_CODE("admissions.resend_code", TelemetryScreen.ADMISSIONS, UiElementKind.LINK, listOf(UiAction.TAP), null, listOf(TelemetryPlatform.IOS, TelemetryPlatform.ANDROID)),
|
|
282
|
+
ADMISSIONS_CONSENT_TOGGLE("admissions.consent_toggle", TelemetryScreen.ADMISSIONS, UiElementKind.TOGGLE, listOf(UiAction.TOGGLE), listOf("checked", "unchecked"), listOf(TelemetryPlatform.IOS, TelemetryPlatform.ANDROID)),
|
|
283
|
+
ADMISSIONS_PRIVACY_POLICY("admissions.privacy_policy", TelemetryScreen.ADMISSIONS, UiElementKind.LINK, listOf(UiAction.TAP), null, listOf(TelemetryPlatform.IOS, TelemetryPlatform.ANDROID)),
|
|
284
|
+
ADMISSIONS_RECORD_START("admissions.record_start", TelemetryScreen.ADMISSIONS, UiElementKind.BUTTON, listOf(UiAction.TAP), null, listOf(TelemetryPlatform.IOS, TelemetryPlatform.ANDROID)),
|
|
285
|
+
ADMISSIONS_RECORD_STOP("admissions.record_stop", TelemetryScreen.ADMISSIONS, UiElementKind.BUTTON, listOf(UiAction.TAP), null, listOf(TelemetryPlatform.IOS, TelemetryPlatform.ANDROID)),
|
|
286
|
+
ADMISSIONS_RETAKE("admissions.retake", TelemetryScreen.ADMISSIONS, UiElementKind.BUTTON, listOf(UiAction.TAP), null, listOf(TelemetryPlatform.IOS, TelemetryPlatform.ANDROID)),
|
|
287
|
+
ADMISSIONS_PREVIEW_PLAY("admissions.preview_play", TelemetryScreen.ADMISSIONS, UiElementKind.TOGGLE, listOf(UiAction.TOGGLE), listOf("play", "pause"), listOf(TelemetryPlatform.IOS, TelemetryPlatform.ANDROID)),
|
|
288
|
+
ADMISSIONS_UPLOAD_RETRY("admissions.upload_retry", TelemetryScreen.ADMISSIONS, UiElementKind.BUTTON, listOf(UiAction.TAP), null, listOf(TelemetryPlatform.IOS, TelemetryPlatform.ANDROID)),
|
|
289
|
+
ADMISSIONS_CLOSE("admissions.close", TelemetryScreen.ADMISSIONS, UiElementKind.BUTTON, listOf(UiAction.TAP), null, listOf(TelemetryPlatform.IOS, TelemetryPlatform.ANDROID)),
|
|
290
|
+
ADMISSIONS_OPEN_SETTINGS("admissions.open_settings", TelemetryScreen.ADMISSIONS, UiElementKind.BUTTON, listOf(UiAction.TAP), null, listOf(TelemetryPlatform.IOS, TelemetryPlatform.ANDROID)),
|
|
291
|
+
ADMISSIONS_STATUS_REFRESH("admissions_status.refresh", TelemetryScreen.ADMISSIONS_STATUS, UiElementKind.BUTTON, listOf(UiAction.TAP), null, listOf(TelemetryPlatform.IOS, TelemetryPlatform.ANDROID)),
|
|
292
|
+
ADMISSIONS_STATUS_CONTINUE_INVITE("admissions_status.continue_invite", TelemetryScreen.ADMISSIONS_STATUS, UiElementKind.BUTTON, listOf(UiAction.TAP), null, listOf(TelemetryPlatform.IOS, TelemetryPlatform.ANDROID)),
|
|
293
|
+
ADMISSIONS_STATUS_WITHDRAW("admissions_status.withdraw", TelemetryScreen.ADMISSIONS_STATUS, UiElementKind.BUTTON, listOf(UiAction.TAP), null, listOf(TelemetryPlatform.IOS, TelemetryPlatform.ANDROID)),
|
|
294
|
+
ADMISSIONS_STATUS_TRAINING_OPT_OUT("admissions_status.training_opt_out", TelemetryScreen.ADMISSIONS_STATUS, UiElementKind.BUTTON, listOf(UiAction.TAP), null, listOf(TelemetryPlatform.IOS, TelemetryPlatform.ANDROID)),
|
|
277
295
|
ONBOARDING_NEXT("onboarding.next", TelemetryScreen.ONBOARDING, UiElementKind.BUTTON, listOf(UiAction.SUBMIT), listOf("basics", "photos", "media", "prompts", "details"), listOf(TelemetryPlatform.WEB, TelemetryPlatform.IOS)),
|
|
278
296
|
ONBOARDING_BACK("onboarding.back", TelemetryScreen.ONBOARDING, UiElementKind.BUTTON, listOf(UiAction.TAP), null, listOf(TelemetryPlatform.WEB, TelemetryPlatform.IOS)),
|
|
279
297
|
ONBOARDING_FINISH("onboarding.finish", TelemetryScreen.ONBOARDING, UiElementKind.BUTTON, listOf(UiAction.SUBMIT), null, listOf(TelemetryPlatform.WEB, TelemetryPlatform.IOS, TelemetryPlatform.ANDROID)),
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
// GENERATED FILE - DO NOT EDIT.
|
|
2
|
-
// telemetry-integrity: sha256
|
|
2
|
+
// telemetry-integrity: sha256 bda676ec3a051338adba1b581d582d5b79111d166504f9ea42c3318cf2895d98
|
|
3
3
|
// Source of truth: OneHookBackend/packages/telemetry/src/catalog.ts
|
|
4
4
|
// Regenerate: (OneHookBackend) npm run telemetry:generate && npm run telemetry:sync
|
|
5
|
-
// Catalog version 1.
|
|
5
|
+
// Catalog version 1.5.0, hash 4ab81c4d5f20cdb7.
|
|
6
6
|
//
|
|
7
7
|
// HARD RULE: every user interaction MUST emit ui_interaction with an id from THIS file, and
|
|
8
8
|
// ids are controlled by the backend. Read TELEMETRY_CONTRACT.txt (printed by every build).
|
|
@@ -10,8 +10,8 @@
|
|
|
10
10
|
import Foundation
|
|
11
11
|
|
|
12
12
|
public enum TelemetryCatalog {
|
|
13
|
-
public static let version = "1.
|
|
14
|
-
public static let hash = "
|
|
13
|
+
public static let version = "1.5.0"
|
|
14
|
+
public static let hash = "4ab81c4d5f20cdb7"
|
|
15
15
|
/// The only allowed `telemetry-exempt: <category>: <reason>` categories (see the catalog).
|
|
16
16
|
public static let exemptCategories: [String] = ["duplicate", "backdrop", "gesture", "continuous", "disabled"]
|
|
17
17
|
}
|
|
@@ -51,6 +51,8 @@ public enum TelemetryScreen: String, CaseIterable, Codable, Sendable {
|
|
|
51
51
|
case landing = "LANDING"
|
|
52
52
|
case login = "LOGIN"
|
|
53
53
|
case redeemInvite = "REDEEM_INVITE"
|
|
54
|
+
case admissions = "ADMISSIONS"
|
|
55
|
+
case admissionsStatus = "ADMISSIONS_STATUS"
|
|
54
56
|
case onboarding = "ONBOARDING"
|
|
55
57
|
case discover = "DISCOVER"
|
|
56
58
|
case likeComposer = "LIKE_COMPOSER"
|
|
@@ -224,6 +226,22 @@ public enum UiElement: String, CaseIterable, Codable, Sendable {
|
|
|
224
226
|
case redeemInviteLogin = "redeem_invite.login"
|
|
225
227
|
case redeemInviteClose = "redeem_invite.close"
|
|
226
228
|
case redeemInviteResendCode = "redeem_invite.resend_code"
|
|
229
|
+
case redeemInviteGetInviteVideo = "redeem_invite.get_invite_video"
|
|
230
|
+
case admissionsSubmit = "admissions.submit"
|
|
231
|
+
case admissionsResendCode = "admissions.resend_code"
|
|
232
|
+
case admissionsConsentToggle = "admissions.consent_toggle"
|
|
233
|
+
case admissionsPrivacyPolicy = "admissions.privacy_policy"
|
|
234
|
+
case admissionsRecordStart = "admissions.record_start"
|
|
235
|
+
case admissionsRecordStop = "admissions.record_stop"
|
|
236
|
+
case admissionsRetake = "admissions.retake"
|
|
237
|
+
case admissionsPreviewPlay = "admissions.preview_play"
|
|
238
|
+
case admissionsUploadRetry = "admissions.upload_retry"
|
|
239
|
+
case admissionsClose = "admissions.close"
|
|
240
|
+
case admissionsOpenSettings = "admissions.open_settings"
|
|
241
|
+
case admissionsStatusRefresh = "admissions_status.refresh"
|
|
242
|
+
case admissionsStatusContinueInvite = "admissions_status.continue_invite"
|
|
243
|
+
case admissionsStatusWithdraw = "admissions_status.withdraw"
|
|
244
|
+
case admissionsStatusTrainingOptOut = "admissions_status.training_opt_out"
|
|
227
245
|
case onboardingNext = "onboarding.next"
|
|
228
246
|
case onboardingBack = "onboarding.back"
|
|
229
247
|
case onboardingFinish = "onboarding.finish"
|
|
@@ -450,6 +468,22 @@ public enum UiElement: String, CaseIterable, Codable, Sendable {
|
|
|
450
468
|
case .redeemInviteLogin: return UiElementSpec(screen: .redeemInvite, kind: .link, actions: [.tap], allowedValues: nil, platforms: [.web, .ios, .android])
|
|
451
469
|
case .redeemInviteClose: return UiElementSpec(screen: .redeemInvite, kind: .button, actions: [.tap], allowedValues: nil, platforms: [.ios, .android])
|
|
452
470
|
case .redeemInviteResendCode: return UiElementSpec(screen: .redeemInvite, kind: .link, actions: [.tap], allowedValues: nil, platforms: [.web, .ios])
|
|
471
|
+
case .redeemInviteGetInviteVideo: return UiElementSpec(screen: .redeemInvite, kind: .button, actions: [.tap], allowedValues: nil, platforms: [.ios, .android])
|
|
472
|
+
case .admissionsSubmit: return UiElementSpec(screen: .admissions, kind: .button, actions: [.submit], allowedValues: ["send_code", "verify_code", "submit_application"], platforms: [.ios, .android])
|
|
473
|
+
case .admissionsResendCode: return UiElementSpec(screen: .admissions, kind: .link, actions: [.tap], allowedValues: nil, platforms: [.ios, .android])
|
|
474
|
+
case .admissionsConsentToggle: return UiElementSpec(screen: .admissions, kind: .toggle, actions: [.toggle], allowedValues: ["checked", "unchecked"], platforms: [.ios, .android])
|
|
475
|
+
case .admissionsPrivacyPolicy: return UiElementSpec(screen: .admissions, kind: .link, actions: [.tap], allowedValues: nil, platforms: [.ios, .android])
|
|
476
|
+
case .admissionsRecordStart: return UiElementSpec(screen: .admissions, kind: .button, actions: [.tap], allowedValues: nil, platforms: [.ios, .android])
|
|
477
|
+
case .admissionsRecordStop: return UiElementSpec(screen: .admissions, kind: .button, actions: [.tap], allowedValues: nil, platforms: [.ios, .android])
|
|
478
|
+
case .admissionsRetake: return UiElementSpec(screen: .admissions, kind: .button, actions: [.tap], allowedValues: nil, platforms: [.ios, .android])
|
|
479
|
+
case .admissionsPreviewPlay: return UiElementSpec(screen: .admissions, kind: .toggle, actions: [.toggle], allowedValues: ["play", "pause"], platforms: [.ios, .android])
|
|
480
|
+
case .admissionsUploadRetry: return UiElementSpec(screen: .admissions, kind: .button, actions: [.tap], allowedValues: nil, platforms: [.ios, .android])
|
|
481
|
+
case .admissionsClose: return UiElementSpec(screen: .admissions, kind: .button, actions: [.tap], allowedValues: nil, platforms: [.ios, .android])
|
|
482
|
+
case .admissionsOpenSettings: return UiElementSpec(screen: .admissions, kind: .button, actions: [.tap], allowedValues: nil, platforms: [.ios, .android])
|
|
483
|
+
case .admissionsStatusRefresh: return UiElementSpec(screen: .admissionsStatus, kind: .button, actions: [.tap], allowedValues: nil, platforms: [.ios, .android])
|
|
484
|
+
case .admissionsStatusContinueInvite: return UiElementSpec(screen: .admissionsStatus, kind: .button, actions: [.tap], allowedValues: nil, platforms: [.ios, .android])
|
|
485
|
+
case .admissionsStatusWithdraw: return UiElementSpec(screen: .admissionsStatus, kind: .button, actions: [.tap], allowedValues: nil, platforms: [.ios, .android])
|
|
486
|
+
case .admissionsStatusTrainingOptOut: return UiElementSpec(screen: .admissionsStatus, kind: .button, actions: [.tap], allowedValues: nil, platforms: [.ios, .android])
|
|
453
487
|
case .onboardingNext: return UiElementSpec(screen: .onboarding, kind: .button, actions: [.submit], allowedValues: ["basics", "photos", "media", "prompts", "details"], platforms: [.web, .ios])
|
|
454
488
|
case .onboardingBack: return UiElementSpec(screen: .onboarding, kind: .button, actions: [.tap], allowedValues: nil, platforms: [.web, .ios])
|
|
455
489
|
case .onboardingFinish: return UiElementSpec(screen: .onboarding, kind: .button, actions: [.submit], allowedValues: nil, platforms: [.web, .ios, .android])
|