onehook-api-client 1.0.28 → 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.
Files changed (34) hide show
  1. package/README.md +28 -0
  2. package/dist-cjs/OneHook.js +8 -0
  3. package/dist-cjs/commands/DiscoverByIntentCommand.js +21 -0
  4. package/dist-cjs/commands/DiscoverSuggestedCommand.js +21 -0
  5. package/dist-cjs/commands/GetAccountStateCommand.js +21 -0
  6. package/dist-cjs/commands/SetAccountStateCommand.js +21 -0
  7. package/dist-cjs/commands/index.js +4 -0
  8. package/dist-cjs/models/models_0.js +30 -1
  9. package/dist-cjs/protocols/Aws_restJson1.js +159 -3
  10. package/dist-cjs/telemetry/index.js +4 -2
  11. package/dist-es/OneHook.js +8 -0
  12. package/dist-es/commands/DiscoverByIntentCommand.js +17 -0
  13. package/dist-es/commands/DiscoverSuggestedCommand.js +17 -0
  14. package/dist-es/commands/GetAccountStateCommand.js +17 -0
  15. package/dist-es/commands/SetAccountStateCommand.js +17 -0
  16. package/dist-es/commands/index.js +4 -0
  17. package/dist-es/models/models_0.js +28 -0
  18. package/dist-es/protocols/Aws_restJson1.js +149 -1
  19. package/dist-es/telemetry/index.js +4 -2
  20. package/dist-types/OneHook.d.ts +28 -0
  21. package/dist-types/OneHookClient.d.ts +6 -2
  22. package/dist-types/commands/DiscoverByIntentCommand.d.ts +97 -0
  23. package/dist-types/commands/DiscoverCommand.d.ts +4 -0
  24. package/dist-types/commands/DiscoverSuggestedCommand.d.ts +92 -0
  25. package/dist-types/commands/GetAccountStateCommand.d.ts +83 -0
  26. package/dist-types/commands/SetAccountStateCommand.d.ts +95 -0
  27. package/dist-types/commands/index.d.ts +4 -0
  28. package/dist-types/models/models_0.d.ts +172 -0
  29. package/dist-types/protocols/Aws_restJson1.d.ts +36 -0
  30. package/dist-types/telemetry/index.d.ts +3 -2
  31. package/package.json +1 -1
  32. package/telemetry/TelemetryCatalog.kt +5 -4
  33. package/telemetry/TelemetryCatalog.swift +6 -4
  34. package/telemetry/telemetry-catalog.json +17 -2
@@ -0,0 +1,83 @@
1
+ import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
2
+ import { GetAccountStateRequest, GetAccountStateResponse } from "../models/models_0";
3
+ import { Command as $Command } from "@smithy/smithy-client";
4
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link GetAccountStateCommand}.
14
+ */
15
+ export interface GetAccountStateCommandInput extends GetAccountStateRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetAccountStateCommand}.
21
+ */
22
+ export interface GetAccountStateCommandOutput extends GetAccountStateResponse, __MetadataBearer {
23
+ }
24
+ declare const GetAccountStateCommand_base: {
25
+ new (input: GetAccountStateCommandInput): import("@smithy/smithy-client").CommandImpl<GetAccountStateCommandInput, GetAccountStateCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: GetAccountStateCommandInput): import("@smithy/smithy-client").CommandImpl<GetAccountStateCommandInput, GetAccountStateCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Reads a member's current moderation account state. Internal, IAM-authorized (SigV4). An expired
31
+ * RESTRICTED/SUSPENDED window reads back as ACTIVE (no sweep required). The returned `version` is
32
+ * the optimistic-concurrency token to pass to the next SetAccountState.
33
+ * @example
34
+ * Use a bare-bones client and the command you need to make an API call.
35
+ * ```javascript
36
+ * import { OneHookClient, GetAccountStateCommand } from "onehook-api-client"; // ES Modules import
37
+ * // const { OneHookClient, GetAccountStateCommand } = require("onehook-api-client"); // CommonJS import
38
+ * const client = new OneHookClient(config);
39
+ * const input = { // GetAccountStateRequest
40
+ * userId: "STRING_VALUE", // required
41
+ * };
42
+ * const command = new GetAccountStateCommand(input);
43
+ * const response = await client.send(command);
44
+ * // { // GetAccountStateResponse
45
+ * // state: "STRING_VALUE", // required
46
+ * // until: Number("long"),
47
+ * // version: Number("int"), // required
48
+ * // reasonCode: "STRING_VALUE",
49
+ * // };
50
+ *
51
+ * ```
52
+ *
53
+ * @param GetAccountStateCommandInput - {@link GetAccountStateCommandInput}
54
+ * @returns {@link GetAccountStateCommandOutput}
55
+ * @see {@link GetAccountStateCommandInput} for command's `input` shape.
56
+ * @see {@link GetAccountStateCommandOutput} for command's `response` shape.
57
+ * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
58
+ *
59
+ * @throws {@link BadRequestError} (client fault)
60
+ *
61
+ * @throws {@link NotFoundError} (client fault)
62
+ *
63
+ * @throws {@link InternalServerError} (server fault)
64
+ *
65
+ * @throws {@link OneHookServiceException}
66
+ * <p>Base exception class for all service exceptions from OneHook service.</p>
67
+ *
68
+ *
69
+ * @public
70
+ */
71
+ export declare class GetAccountStateCommand extends GetAccountStateCommand_base {
72
+ /** @internal type navigation helper, not in runtime. */
73
+ protected static __types: {
74
+ api: {
75
+ input: GetAccountStateRequest;
76
+ output: GetAccountStateResponse;
77
+ };
78
+ sdk: {
79
+ input: GetAccountStateCommandInput;
80
+ output: GetAccountStateCommandOutput;
81
+ };
82
+ };
83
+ }
@@ -0,0 +1,95 @@
1
+ import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
2
+ import { SetAccountStateRequest, SetAccountStateResponse } from "../models/models_0";
3
+ import { Command as $Command } from "@smithy/smithy-client";
4
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link SetAccountStateCommand}.
14
+ */
15
+ export interface SetAccountStateCommandInput extends SetAccountStateRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link SetAccountStateCommand}.
21
+ */
22
+ export interface SetAccountStateCommandOutput extends SetAccountStateResponse, __MetadataBearer {
23
+ }
24
+ declare const SetAccountStateCommand_base: {
25
+ new (input: SetAccountStateCommandInput): import("@smithy/smithy-client").CommandImpl<SetAccountStateCommandInput, SetAccountStateCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: SetAccountStateCommandInput): import("@smithy/smithy-client").CommandImpl<SetAccountStateCommandInput, SetAccountStateCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Sets a member's moderation account state. Internal, IAM-authorized (SigV4) — NOT the Cognito
31
+ * user-pool authorizer — so the only caller is the admin portal's moderation module (its per-module
32
+ * invoke role). The write is optimistic-concurrency guarded: pass the `expectedVersion` read from
33
+ * GetAccountState and a concurrent change returns 409. Emits an `AccountStateChanged` domain event
34
+ * through the Identity transactional outbox. No PII is accepted or logged — the reason is a CODE.
35
+ *
36
+ * RESTRICTED/SUSPENDED require an `until` (epoch ms); BANNED is permanent and must NOT carry one.
37
+ * SUSPENDED and BANNED members are refused at sign-in and token refresh (ACCOUNT_SUSPENDED /
38
+ * ACCOUNT_BANNED); RESTRICTED members can still sign in but are hidden from discovery.
39
+ * @example
40
+ * Use a bare-bones client and the command you need to make an API call.
41
+ * ```javascript
42
+ * import { OneHookClient, SetAccountStateCommand } from "onehook-api-client"; // ES Modules import
43
+ * // const { OneHookClient, SetAccountStateCommand } = require("onehook-api-client"); // CommonJS import
44
+ * const client = new OneHookClient(config);
45
+ * const input = { // SetAccountStateRequest
46
+ * userId: "STRING_VALUE", // required
47
+ * state: "STRING_VALUE", // required
48
+ * reasonCode: "STRING_VALUE", // required
49
+ * until: Number("long"),
50
+ * actor: "STRING_VALUE", // required
51
+ * expectedVersion: Number("int"),
52
+ * };
53
+ * const command = new SetAccountStateCommand(input);
54
+ * const response = await client.send(command);
55
+ * // { // SetAccountStateResponse
56
+ * // state: "STRING_VALUE", // required
57
+ * // until: Number("long"),
58
+ * // version: Number("int"), // required
59
+ * // };
60
+ *
61
+ * ```
62
+ *
63
+ * @param SetAccountStateCommandInput - {@link SetAccountStateCommandInput}
64
+ * @returns {@link SetAccountStateCommandOutput}
65
+ * @see {@link SetAccountStateCommandInput} for command's `input` shape.
66
+ * @see {@link SetAccountStateCommandOutput} for command's `response` shape.
67
+ * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
68
+ *
69
+ * @throws {@link BadRequestError} (client fault)
70
+ *
71
+ * @throws {@link NotFoundError} (client fault)
72
+ *
73
+ * @throws {@link ConflictError} (client fault)
74
+ *
75
+ * @throws {@link InternalServerError} (server fault)
76
+ *
77
+ * @throws {@link OneHookServiceException}
78
+ * <p>Base exception class for all service exceptions from OneHook service.</p>
79
+ *
80
+ *
81
+ * @public
82
+ */
83
+ export declare class SetAccountStateCommand extends SetAccountStateCommand_base {
84
+ /** @internal type navigation helper, not in runtime. */
85
+ protected static __types: {
86
+ api: {
87
+ input: SetAccountStateRequest;
88
+ output: SetAccountStateResponse;
89
+ };
90
+ sdk: {
91
+ input: SetAccountStateCommandInput;
92
+ output: SetAccountStateCommandOutput;
93
+ };
94
+ };
95
+ }
@@ -13,6 +13,7 @@ export * from "./UpdateChatSettingsCommand";
13
13
  export * from "./AuthSocialCommand";
14
14
  export * from "./CreateAdminInviteCommand";
15
15
  export * from "./GenerateInviteCommand";
16
+ export * from "./GetAccountStateCommand";
16
17
  export * from "./GetAdminPhoneStatusCommand";
17
18
  export * from "./GetCredentialReadinessCommand";
18
19
  export * from "./GetUserCommand";
@@ -25,6 +26,7 @@ export * from "./RequestEmailOtpCommand";
25
26
  export * from "./RequestPhoneOtpCommand";
26
27
  export * from "./RequestPhoneUpdateOtpCommand";
27
28
  export * from "./SendAdminLinkOtpCommand";
29
+ export * from "./SetAccountStateCommand";
28
30
  export * from "./UnlinkSocialCommand";
29
31
  export * from "./UpdateEntitlementsCommand";
30
32
  export * from "./UpdatePhoneNumberCommand";
@@ -32,6 +34,8 @@ export * from "./UpdateUsernameCommand";
32
34
  export * from "./ValidateInviteCommand";
33
35
  export * from "./VerifyAdminLinkOtpCommand";
34
36
  export * from "./DiscoverCommand";
37
+ export * from "./DiscoverByIntentCommand";
38
+ export * from "./DiscoverSuggestedCommand";
35
39
  export * from "./GetNotificationPreferencesCommand";
36
40
  export * from "./GetPreferencesCommand";
37
41
  export * from "./GetReceivedLikesCommand";
@@ -657,6 +657,49 @@ 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
+ }
660
703
  /**
661
704
  * @public
662
705
  */
@@ -852,6 +895,69 @@ export interface SendAdminLinkOtpResponse {
852
895
  */
853
896
  maskedPhone: string | undefined;
854
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
+ }
855
961
  /**
856
962
  * @public
857
963
  */
@@ -992,6 +1098,38 @@ export interface DiscoverRequest {
992
1098
  lat: number | undefined;
993
1099
  lon: number | undefined;
994
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];
995
1133
  /**
996
1134
  * @public
997
1135
  */
@@ -999,6 +1137,28 @@ export interface CandidateDto {
999
1137
  userId: string | undefined;
1000
1138
  distanceKm: number | undefined;
1001
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;
1002
1162
  }
1003
1163
  /**
1004
1164
  * @public
@@ -1008,6 +1168,18 @@ export interface DiscoverResponse {
1008
1168
  count: number | undefined;
1009
1169
  algorithm: string | undefined;
1010
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
+ }
1011
1183
  /**
1012
1184
  * @public
1013
1185
  */
@@ -8,10 +8,13 @@ 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";
15
18
  import { GetAdminPhoneStatusCommandInput, GetAdminPhoneStatusCommandOutput } from "../commands/GetAdminPhoneStatusCommand";
16
19
  import { GetAiContextMatchCommandInput, GetAiContextMatchCommandOutput } from "../commands/GetAiContextMatchCommand";
17
20
  import { GetChatSettingsCommandInput, GetChatSettingsCommandOutput } from "../commands/GetChatSettingsCommand";
@@ -43,6 +46,7 @@ import { RequestPhoneOtpCommandInput, RequestPhoneOtpCommandOutput } from "../co
43
46
  import { RequestPhoneUpdateOtpCommandInput, RequestPhoneUpdateOtpCommandOutput } from "../commands/RequestPhoneUpdateOtpCommand";
44
47
  import { RevokeDeviceCommandInput, RevokeDeviceCommandOutput } from "../commands/RevokeDeviceCommand";
45
48
  import { SendAdminLinkOtpCommandInput, SendAdminLinkOtpCommandOutput } from "../commands/SendAdminLinkOtpCommand";
49
+ import { SetAccountStateCommandInput, SetAccountStateCommandOutput } from "../commands/SetAccountStateCommand";
46
50
  import { SwipeByUsernameCommandInput, SwipeByUsernameCommandOutput } from "../commands/SwipeByUsernameCommand";
47
51
  import { SwipeCommandInput, SwipeCommandOutput } from "../commands/SwipeCommand";
48
52
  import { UnhookCommandInput, UnhookCommandOutput } from "../commands/UnhookCommand";
@@ -118,6 +122,10 @@ export declare const se_CreateAdminInviteCommand: (input: CreateAdminInviteComma
118
122
  * serializeAws_restJson1GenerateInviteCommand
119
123
  */
120
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>;
121
129
  /**
122
130
  * serializeAws_restJson1GetAdminPhoneStatusCommand
123
131
  */
@@ -166,6 +174,10 @@ export declare const se_RequestPhoneUpdateOtpCommand: (input: RequestPhoneUpdate
166
174
  * serializeAws_restJson1SendAdminLinkOtpCommand
167
175
  */
168
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>;
169
181
  /**
170
182
  * serializeAws_restJson1UnlinkSocialCommand
171
183
  */
@@ -194,6 +206,14 @@ export declare const se_VerifyAdminLinkOtpCommand: (input: VerifyAdminLinkOtpCom
194
206
  * serializeAws_restJson1DiscoverCommand
195
207
  */
196
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>;
197
217
  /**
198
218
  * serializeAws_restJson1GetNotificationPreferencesCommand
199
219
  */
@@ -350,6 +370,10 @@ export declare const de_CreateAdminInviteCommand: (output: __HttpResponse, conte
350
370
  * deserializeAws_restJson1GenerateInviteCommand
351
371
  */
352
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>;
353
377
  /**
354
378
  * deserializeAws_restJson1GetAdminPhoneStatusCommand
355
379
  */
@@ -398,6 +422,10 @@ export declare const de_RequestPhoneUpdateOtpCommand: (output: __HttpResponse, c
398
422
  * deserializeAws_restJson1SendAdminLinkOtpCommand
399
423
  */
400
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>;
401
429
  /**
402
430
  * deserializeAws_restJson1UnlinkSocialCommand
403
431
  */
@@ -426,6 +454,14 @@ export declare const de_VerifyAdminLinkOtpCommand: (output: __HttpResponse, cont
426
454
  * deserializeAws_restJson1DiscoverCommand
427
455
  */
428
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>;
429
465
  /**
430
466
  * deserializeAws_restJson1GetNotificationPreferencesCommand
431
467
  */
@@ -1,5 +1,5 @@
1
- export declare const TELEMETRY_CATALOG_VERSION = "1.4.0";
2
- export declare const TELEMETRY_CATALOG_HASH = "5cf9f7740c92eebe";
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";
@@ -240,6 +240,7 @@ export declare const UiElement: {
240
240
  readonly ADMISSIONS_STATUS_REFRESH: "admissions_status.refresh";
241
241
  readonly ADMISSIONS_STATUS_CONTINUE_INVITE: "admissions_status.continue_invite";
242
242
  readonly ADMISSIONS_STATUS_WITHDRAW: "admissions_status.withdraw";
243
+ readonly ADMISSIONS_STATUS_TRAINING_OPT_OUT: "admissions_status.training_opt_out";
243
244
  readonly ONBOARDING_NEXT: "onboarding.next";
244
245
  readonly ONBOARDING_BACK: "onboarding.back";
245
246
  readonly ONBOARDING_FINISH: "onboarding.finish";
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "onehook-api-client",
3
3
  "description": "OneHook API Client",
4
- "version": "1.0.28",
4
+ "version": "1.0.29",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -1,8 +1,8 @@
1
1
  // GENERATED FILE - DO NOT EDIT.
2
- // telemetry-integrity: sha256 b2132f38e8304ee1cf24db09423818c9cc610d1f9b02171d4c66d864474251aa
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.4.0, hash 5cf9f7740c92eebe.
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.4.0"
16
- const val HASH = "5cf9f7740c92eebe"
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
  }
@@ -291,6 +291,7 @@ enum class UiElement(
291
291
  ADMISSIONS_STATUS_REFRESH("admissions_status.refresh", TelemetryScreen.ADMISSIONS_STATUS, UiElementKind.BUTTON, listOf(UiAction.TAP), null, listOf(TelemetryPlatform.IOS, TelemetryPlatform.ANDROID)),
292
292
  ADMISSIONS_STATUS_CONTINUE_INVITE("admissions_status.continue_invite", TelemetryScreen.ADMISSIONS_STATUS, UiElementKind.BUTTON, listOf(UiAction.TAP), null, listOf(TelemetryPlatform.IOS, TelemetryPlatform.ANDROID)),
293
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)),
294
295
  ONBOARDING_NEXT("onboarding.next", TelemetryScreen.ONBOARDING, UiElementKind.BUTTON, listOf(UiAction.SUBMIT), listOf("basics", "photos", "media", "prompts", "details"), listOf(TelemetryPlatform.WEB, TelemetryPlatform.IOS)),
295
296
  ONBOARDING_BACK("onboarding.back", TelemetryScreen.ONBOARDING, UiElementKind.BUTTON, listOf(UiAction.TAP), null, listOf(TelemetryPlatform.WEB, TelemetryPlatform.IOS)),
296
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 b7b58bab688dee924a7c76fea46d4058a3e3e69c44043f9c86aa74d01e50c520
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.4.0, hash 5cf9f7740c92eebe.
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.4.0"
14
- public static let hash = "5cf9f7740c92eebe"
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
  }
@@ -241,6 +241,7 @@ public enum UiElement: String, CaseIterable, Codable, Sendable {
241
241
  case admissionsStatusRefresh = "admissions_status.refresh"
242
242
  case admissionsStatusContinueInvite = "admissions_status.continue_invite"
243
243
  case admissionsStatusWithdraw = "admissions_status.withdraw"
244
+ case admissionsStatusTrainingOptOut = "admissions_status.training_opt_out"
244
245
  case onboardingNext = "onboarding.next"
245
246
  case onboardingBack = "onboarding.back"
246
247
  case onboardingFinish = "onboarding.finish"
@@ -482,6 +483,7 @@ public enum UiElement: String, CaseIterable, Codable, Sendable {
482
483
  case .admissionsStatusRefresh: return UiElementSpec(screen: .admissionsStatus, kind: .button, actions: [.tap], allowedValues: nil, platforms: [.ios, .android])
483
484
  case .admissionsStatusContinueInvite: return UiElementSpec(screen: .admissionsStatus, kind: .button, actions: [.tap], allowedValues: nil, platforms: [.ios, .android])
484
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])
485
487
  case .onboardingNext: return UiElementSpec(screen: .onboarding, kind: .button, actions: [.submit], allowedValues: ["basics", "photos", "media", "prompts", "details"], platforms: [.web, .ios])
486
488
  case .onboardingBack: return UiElementSpec(screen: .onboarding, kind: .button, actions: [.tap], allowedValues: nil, platforms: [.web, .ios])
487
489
  case .onboardingFinish: return UiElementSpec(screen: .onboarding, kind: .button, actions: [.submit], allowedValues: nil, platforms: [.web, .ios, .android])
@@ -1,5 +1,5 @@
1
1
  {
2
- "version": "1.4.0",
2
+ "version": "1.5.0",
3
3
  "screens": {
4
4
  "NAV": {
5
5
  "viewable": false,
@@ -1158,6 +1158,20 @@
1158
1158
  ],
1159
1159
  "deprecated": null
1160
1160
  },
1161
+ "admissions_status.training_opt_out": {
1162
+ "screen": "ADMISSIONS_STATUS",
1163
+ "kind": "button",
1164
+ "description": "Opt out of Admissions Assist model training: stop using my video/transcript and delete training records (opens a confirmation). The application itself is unchanged.",
1165
+ "actions": [
1166
+ "tap"
1167
+ ],
1168
+ "values": null,
1169
+ "platforms": [
1170
+ "ios",
1171
+ "android"
1172
+ ],
1173
+ "deprecated": null
1174
+ },
1161
1175
  "onboarding.next": {
1162
1176
  "screen": "ONBOARDING",
1163
1177
  "kind": "button",
@@ -3954,6 +3968,7 @@
3954
3968
  "admissions.upload_retry": "Web-only gap: the in-app application video upload is iOS/Android only (DESIGN.md §6.1.5); not built on web.",
3955
3969
  "admissions_status.continue_invite": "Web-only gap: the applicant status screen is in-app iOS/Android only (DESIGN.md §6.1.6); not built on web.",
3956
3970
  "admissions_status.refresh": "Web-only gap: the applicant status screen is in-app iOS/Android only (DESIGN.md §6.1.6); not built on web.",
3971
+ "admissions_status.training_opt_out": "Web-only gap: the applicant status screen (and its Admissions Assist training opt-out) is in-app iOS/Android only (DESIGN.md §6.1.6); not built on web.",
3957
3972
  "admissions_status.withdraw": "Web-only gap: the applicant status screen is in-app iOS/Android only (DESIGN.md §6.1.6); not built on web.",
3958
3973
  "call.camera_switch": "Web has no camera-switch control: the in-call UI uses the browser-selected camera and offers no front/back toggle.",
3959
3974
  "call.speaker": "Web has no speaker routing: the browser owns audio output.",
@@ -4607,5 +4622,5 @@
4607
4622
  }
4608
4623
  }
4609
4624
  },
4610
- "hash": "5cf9f7740c92eebe"
4625
+ "hash": "4ab81c4d5f20cdb7"
4611
4626
  }