onehook-api-client 1.0.26 → 1.0.28

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 (31) hide show
  1. package/README.md +28 -0
  2. package/dist-cjs/OneHook.js +8 -0
  3. package/dist-cjs/commands/CreateAdminInviteCommand.js +21 -0
  4. package/dist-cjs/commands/GetAdminPhoneStatusCommand.js +21 -0
  5. package/dist-cjs/commands/SendAdminLinkOtpCommand.js +21 -0
  6. package/dist-cjs/commands/VerifyAdminLinkOtpCommand.js +21 -0
  7. package/dist-cjs/commands/index.js +4 -0
  8. package/dist-cjs/protocols/Aws_restJson1.js +131 -3
  9. package/dist-cjs/telemetry/index.js +36 -2
  10. package/dist-es/OneHook.js +8 -0
  11. package/dist-es/commands/CreateAdminInviteCommand.js +17 -0
  12. package/dist-es/commands/GetAdminPhoneStatusCommand.js +17 -0
  13. package/dist-es/commands/SendAdminLinkOtpCommand.js +17 -0
  14. package/dist-es/commands/VerifyAdminLinkOtpCommand.js +17 -0
  15. package/dist-es/commands/index.js +4 -0
  16. package/dist-es/protocols/Aws_restJson1.js +120 -0
  17. package/dist-es/telemetry/index.js +36 -2
  18. package/dist-types/OneHook.d.ts +28 -0
  19. package/dist-types/OneHookClient.d.ts +6 -2
  20. package/dist-types/commands/CreateAdminInviteCommand.d.ts +87 -0
  21. package/dist-types/commands/GetAdminPhoneStatusCommand.d.ts +86 -0
  22. package/dist-types/commands/SendAdminLinkOtpCommand.d.ts +83 -0
  23. package/dist-types/commands/VerifyAdminLinkOtpCommand.d.ts +84 -0
  24. package/dist-types/commands/index.d.ts +4 -0
  25. package/dist-types/models/models_0.d.ts +69 -0
  26. package/dist-types/protocols/Aws_restJson1.d.ts +36 -0
  27. package/dist-types/telemetry/index.d.ts +21 -2
  28. package/package.json +1 -1
  29. package/telemetry/TelemetryCatalog.kt +21 -4
  30. package/telemetry/TelemetryCatalog.swift +36 -4
  31. package/telemetry/telemetry-catalog.json +250 -3
@@ -0,0 +1,83 @@
1
+ import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
2
+ import { SendAdminLinkOtpRequest, SendAdminLinkOtpResponse } 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 SendAdminLinkOtpCommand}.
14
+ */
15
+ export interface SendAdminLinkOtpCommandInput extends SendAdminLinkOtpRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link SendAdminLinkOtpCommand}.
21
+ */
22
+ export interface SendAdminLinkOtpCommandOutput extends SendAdminLinkOtpResponse, __MetadataBearer {
23
+ }
24
+ declare const SendAdminLinkOtpCommand_base: {
25
+ new (input: SendAdminLinkOtpCommandInput): import("@smithy/smithy-client").CommandImpl<SendAdminLinkOtpCommandInput, SendAdminLinkOtpCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: SendAdminLinkOtpCommandInput): import("@smithy/smithy-client").CommandImpl<SendAdminLinkOtpCommandInput, SendAdminLinkOtpCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Sends a one-time 6-digit code by SMS to a user's VERIFIED phone, so a portal admin can prove they
31
+ * own that OneHook account before the admin↔username link is recorded. Internal, IAM-authorized
32
+ * (SigV4). Reuses the existing OTP/SMS delivery path and rate limiting. The admin-link OTP is stored
33
+ * under a key namespace distinct from login/registration OTPs, so the two can never be cross-used.
34
+ * Unknown user → 404. The response returns only a masked phone, never the full number.
35
+ * @example
36
+ * Use a bare-bones client and the command you need to make an API call.
37
+ * ```javascript
38
+ * import { OneHookClient, SendAdminLinkOtpCommand } from "onehook-api-client"; // ES Modules import
39
+ * // const { OneHookClient, SendAdminLinkOtpCommand } = require("onehook-api-client"); // CommonJS import
40
+ * const client = new OneHookClient(config);
41
+ * const input = { // SendAdminLinkOtpRequest
42
+ * userId: "STRING_VALUE", // required
43
+ * };
44
+ * const command = new SendAdminLinkOtpCommand(input);
45
+ * const response = await client.send(command);
46
+ * // { // SendAdminLinkOtpResponse
47
+ * // status: "STRING_VALUE", // required
48
+ * // maskedPhone: "STRING_VALUE", // required
49
+ * // };
50
+ *
51
+ * ```
52
+ *
53
+ * @param SendAdminLinkOtpCommandInput - {@link SendAdminLinkOtpCommandInput}
54
+ * @returns {@link SendAdminLinkOtpCommandOutput}
55
+ * @see {@link SendAdminLinkOtpCommandInput} for command's `input` shape.
56
+ * @see {@link SendAdminLinkOtpCommandOutput} 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 SendAdminLinkOtpCommand extends SendAdminLinkOtpCommand_base {
72
+ /** @internal type navigation helper, not in runtime. */
73
+ protected static __types: {
74
+ api: {
75
+ input: SendAdminLinkOtpRequest;
76
+ output: SendAdminLinkOtpResponse;
77
+ };
78
+ sdk: {
79
+ input: SendAdminLinkOtpCommandInput;
80
+ output: SendAdminLinkOtpCommandOutput;
81
+ };
82
+ };
83
+ }
@@ -0,0 +1,84 @@
1
+ import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
2
+ import { VerifyAdminLinkOtpRequest, VerifyAdminLinkOtpResponse } 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 VerifyAdminLinkOtpCommand}.
14
+ */
15
+ export interface VerifyAdminLinkOtpCommandInput extends VerifyAdminLinkOtpRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link VerifyAdminLinkOtpCommand}.
21
+ */
22
+ export interface VerifyAdminLinkOtpCommandOutput extends VerifyAdminLinkOtpResponse, __MetadataBearer {
23
+ }
24
+ declare const VerifyAdminLinkOtpCommand_base: {
25
+ new (input: VerifyAdminLinkOtpCommandInput): import("@smithy/smithy-client").CommandImpl<VerifyAdminLinkOtpCommandInput, VerifyAdminLinkOtpCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: VerifyAdminLinkOtpCommandInput): import("@smithy/smithy-client").CommandImpl<VerifyAdminLinkOtpCommandInput, VerifyAdminLinkOtpCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Verifies an admin-link OTP previously sent by \{@link SendAdminLinkOtp\}. Internal, IAM-authorized
31
+ * (SigV4). On success returns the userId + username the portal records for the link. A wrong/expired
32
+ * code, or exceeding the per-code attempt cap, returns a generic 400 (no oracle). The code is
33
+ * single-use and expires in 5 minutes. Unknown user → 404.
34
+ * @example
35
+ * Use a bare-bones client and the command you need to make an API call.
36
+ * ```javascript
37
+ * import { OneHookClient, VerifyAdminLinkOtpCommand } from "onehook-api-client"; // ES Modules import
38
+ * // const { OneHookClient, VerifyAdminLinkOtpCommand } = require("onehook-api-client"); // CommonJS import
39
+ * const client = new OneHookClient(config);
40
+ * const input = { // VerifyAdminLinkOtpRequest
41
+ * userId: "STRING_VALUE", // required
42
+ * code: "STRING_VALUE", // required
43
+ * };
44
+ * const command = new VerifyAdminLinkOtpCommand(input);
45
+ * const response = await client.send(command);
46
+ * // { // VerifyAdminLinkOtpResponse
47
+ * // verified: true || false, // required
48
+ * // userId: "STRING_VALUE", // required
49
+ * // username: "STRING_VALUE", // required
50
+ * // };
51
+ *
52
+ * ```
53
+ *
54
+ * @param VerifyAdminLinkOtpCommandInput - {@link VerifyAdminLinkOtpCommandInput}
55
+ * @returns {@link VerifyAdminLinkOtpCommandOutput}
56
+ * @see {@link VerifyAdminLinkOtpCommandInput} for command's `input` shape.
57
+ * @see {@link VerifyAdminLinkOtpCommandOutput} for command's `response` shape.
58
+ * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
59
+ *
60
+ * @throws {@link BadRequestError} (client fault)
61
+ *
62
+ * @throws {@link NotFoundError} (client fault)
63
+ *
64
+ * @throws {@link InternalServerError} (server fault)
65
+ *
66
+ * @throws {@link OneHookServiceException}
67
+ * <p>Base exception class for all service exceptions from OneHook service.</p>
68
+ *
69
+ *
70
+ * @public
71
+ */
72
+ export declare class VerifyAdminLinkOtpCommand extends VerifyAdminLinkOtpCommand_base {
73
+ /** @internal type navigation helper, not in runtime. */
74
+ protected static __types: {
75
+ api: {
76
+ input: VerifyAdminLinkOtpRequest;
77
+ output: VerifyAdminLinkOtpResponse;
78
+ };
79
+ sdk: {
80
+ input: VerifyAdminLinkOtpCommandInput;
81
+ output: VerifyAdminLinkOtpCommandOutput;
82
+ };
83
+ };
84
+ }
@@ -11,7 +11,9 @@ export * from "./RegisterPushTokenCommand";
11
11
  export * from "./RevokeDeviceCommand";
12
12
  export * from "./UpdateChatSettingsCommand";
13
13
  export * from "./AuthSocialCommand";
14
+ export * from "./CreateAdminInviteCommand";
14
15
  export * from "./GenerateInviteCommand";
16
+ export * from "./GetAdminPhoneStatusCommand";
15
17
  export * from "./GetCredentialReadinessCommand";
16
18
  export * from "./GetUserCommand";
17
19
  export * from "./GetUserByEmailCommand";
@@ -22,11 +24,13 @@ export * from "./RegisterPhoneCommand";
22
24
  export * from "./RequestEmailOtpCommand";
23
25
  export * from "./RequestPhoneOtpCommand";
24
26
  export * from "./RequestPhoneUpdateOtpCommand";
27
+ export * from "./SendAdminLinkOtpCommand";
25
28
  export * from "./UnlinkSocialCommand";
26
29
  export * from "./UpdateEntitlementsCommand";
27
30
  export * from "./UpdatePhoneNumberCommand";
28
31
  export * from "./UpdateUsernameCommand";
29
32
  export * from "./ValidateInviteCommand";
33
+ export * from "./VerifyAdminLinkOtpCommand";
30
34
  export * from "./DiscoverCommand";
31
35
  export * from "./GetNotificationPreferencesCommand";
32
36
  export * from "./GetPreferencesCommand";
@@ -622,6 +622,26 @@ export interface AuthSocialResponse {
622
622
  userId?: string | undefined;
623
623
  isNewUser?: boolean | undefined;
624
624
  }
625
+ /**
626
+ * @public
627
+ */
628
+ export interface CreateAdminInviteRequest {
629
+ phoneNumber: string | undefined;
630
+ referrerId: string | undefined;
631
+ /**
632
+ * Optional invite lifetime in days. Defaults to 14 when omitted; bounded to 1..30.
633
+ * @public
634
+ */
635
+ ttlDays?: number | undefined;
636
+ }
637
+ /**
638
+ * @public
639
+ */
640
+ export interface CreateAdminInviteResponse {
641
+ inviteCode: string | undefined;
642
+ expiresAt: number | undefined;
643
+ maxUses: number | undefined;
644
+ }
625
645
  /**
626
646
  * @public
627
647
  */
@@ -637,6 +657,22 @@ export interface GenerateInviteResponse {
637
657
  expiresAt: number | undefined;
638
658
  maxUses: number | undefined;
639
659
  }
660
+ /**
661
+ * @public
662
+ */
663
+ export interface GetAdminPhoneStatusRequest {
664
+ phoneNumber: string | undefined;
665
+ }
666
+ /**
667
+ * @public
668
+ */
669
+ export interface GetAdminPhoneStatusResponse {
670
+ /**
671
+ * True when the phone is bound to an existing account OR claimed by an in-progress registration.
672
+ * @public
673
+ */
674
+ registered: boolean | undefined;
675
+ }
640
676
  /**
641
677
  * @public
642
678
  */
@@ -798,6 +834,24 @@ export interface RequestPhoneUpdateOtpRequest {
798
834
  export interface RequestPhoneUpdateOtpResponse {
799
835
  status: string | undefined;
800
836
  }
837
+ /**
838
+ * @public
839
+ */
840
+ export interface SendAdminLinkOtpRequest {
841
+ userId: string | undefined;
842
+ }
843
+ /**
844
+ * @public
845
+ */
846
+ export interface SendAdminLinkOtpResponse {
847
+ status: string | undefined;
848
+ /**
849
+ * The user's phone with only a short prefix and suffix shown, e.g. \{@code +91•••••••210\}. Never
850
+ * the full number.
851
+ * @public
852
+ */
853
+ maskedPhone: string | undefined;
854
+ }
801
855
  /**
802
856
  * @public
803
857
  */
@@ -916,6 +970,21 @@ export interface ValidateInviteResponse {
916
970
  usedCount: number | undefined;
917
971
  maxUses: number | undefined;
918
972
  }
973
+ /**
974
+ * @public
975
+ */
976
+ export interface VerifyAdminLinkOtpRequest {
977
+ userId: string | undefined;
978
+ code: string | undefined;
979
+ }
980
+ /**
981
+ * @public
982
+ */
983
+ export interface VerifyAdminLinkOtpResponse {
984
+ verified: boolean | undefined;
985
+ userId: string | undefined;
986
+ username: string | undefined;
987
+ }
919
988
  /**
920
989
  * @public
921
990
  */
@@ -1,6 +1,7 @@
1
1
  import { AuthSocialCommandInput, AuthSocialCommandOutput } from "../commands/AuthSocialCommand";
2
2
  import { CompleteLivenessSessionCommandInput, CompleteLivenessSessionCommandOutput } from "../commands/CompleteLivenessSessionCommand";
3
3
  import { CompleteOnboardingCommandInput, CompleteOnboardingCommandOutput } from "../commands/CompleteOnboardingCommand";
4
+ import { CreateAdminInviteCommandInput, CreateAdminInviteCommandOutput } from "../commands/CreateAdminInviteCommand";
4
5
  import { CreateLivenessSessionCommandInput, CreateLivenessSessionCommandOutput } from "../commands/CreateLivenessSessionCommand";
5
6
  import { CreateMediaDownloadUrlCommandInput, CreateMediaDownloadUrlCommandOutput } from "../commands/CreateMediaDownloadUrlCommand";
6
7
  import { CreateMediaUploadUrlCommandInput, CreateMediaUploadUrlCommandOutput } from "../commands/CreateMediaUploadUrlCommand";
@@ -11,6 +12,7 @@ import { DiscoverCommandInput, DiscoverCommandOutput } from "../commands/Discove
11
12
  import { GenerateDownloadUrlCommandInput, GenerateDownloadUrlCommandOutput } from "../commands/GenerateDownloadUrlCommand";
12
13
  import { GenerateInviteCommandInput, GenerateInviteCommandOutput } from "../commands/GenerateInviteCommand";
13
14
  import { GenerateUploadUrlCommandInput, GenerateUploadUrlCommandOutput } from "../commands/GenerateUploadUrlCommand";
15
+ import { GetAdminPhoneStatusCommandInput, GetAdminPhoneStatusCommandOutput } from "../commands/GetAdminPhoneStatusCommand";
14
16
  import { GetAiContextMatchCommandInput, GetAiContextMatchCommandOutput } from "../commands/GetAiContextMatchCommand";
15
17
  import { GetChatSettingsCommandInput, GetChatSettingsCommandOutput } from "../commands/GetChatSettingsCommand";
16
18
  import { GetCredentialReadinessCommandInput, GetCredentialReadinessCommandOutput } from "../commands/GetCredentialReadinessCommand";
@@ -40,6 +42,7 @@ import { RequestEmailOtpCommandInput, RequestEmailOtpCommandOutput } from "../co
40
42
  import { RequestPhoneOtpCommandInput, RequestPhoneOtpCommandOutput } from "../commands/RequestPhoneOtpCommand";
41
43
  import { RequestPhoneUpdateOtpCommandInput, RequestPhoneUpdateOtpCommandOutput } from "../commands/RequestPhoneUpdateOtpCommand";
42
44
  import { RevokeDeviceCommandInput, RevokeDeviceCommandOutput } from "../commands/RevokeDeviceCommand";
45
+ import { SendAdminLinkOtpCommandInput, SendAdminLinkOtpCommandOutput } from "../commands/SendAdminLinkOtpCommand";
43
46
  import { SwipeByUsernameCommandInput, SwipeByUsernameCommandOutput } from "../commands/SwipeByUsernameCommand";
44
47
  import { SwipeCommandInput, SwipeCommandOutput } from "../commands/SwipeCommand";
45
48
  import { UnhookCommandInput, UnhookCommandOutput } from "../commands/UnhookCommand";
@@ -52,6 +55,7 @@ import { UpdateProfileCommandInput, UpdateProfileCommandOutput } from "../comman
52
55
  import { UpdateUsernameCommandInput, UpdateUsernameCommandOutput } from "../commands/UpdateUsernameCommand";
53
56
  import { UpgradeUserCommandInput, UpgradeUserCommandOutput } from "../commands/UpgradeUserCommand";
54
57
  import { ValidateInviteCommandInput, ValidateInviteCommandOutput } from "../commands/ValidateInviteCommand";
58
+ import { VerifyAdminLinkOtpCommandInput, VerifyAdminLinkOtpCommandOutput } from "../commands/VerifyAdminLinkOtpCommand";
55
59
  import { HttpRequest as __HttpRequest, HttpResponse as __HttpResponse } from "@smithy/protocol-http";
56
60
  import { SerdeContext as __SerdeContext } from "@smithy/types";
57
61
  /**
@@ -106,10 +110,18 @@ export declare const se_UpdateChatSettingsCommand: (input: UpdateChatSettingsCom
106
110
  * serializeAws_restJson1AuthSocialCommand
107
111
  */
108
112
  export declare const se_AuthSocialCommand: (input: AuthSocialCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
113
+ /**
114
+ * serializeAws_restJson1CreateAdminInviteCommand
115
+ */
116
+ export declare const se_CreateAdminInviteCommand: (input: CreateAdminInviteCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
109
117
  /**
110
118
  * serializeAws_restJson1GenerateInviteCommand
111
119
  */
112
120
  export declare const se_GenerateInviteCommand: (input: GenerateInviteCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
121
+ /**
122
+ * serializeAws_restJson1GetAdminPhoneStatusCommand
123
+ */
124
+ export declare const se_GetAdminPhoneStatusCommand: (input: GetAdminPhoneStatusCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
113
125
  /**
114
126
  * serializeAws_restJson1GetCredentialReadinessCommand
115
127
  */
@@ -150,6 +162,10 @@ export declare const se_RequestPhoneOtpCommand: (input: RequestPhoneOtpCommandIn
150
162
  * serializeAws_restJson1RequestPhoneUpdateOtpCommand
151
163
  */
152
164
  export declare const se_RequestPhoneUpdateOtpCommand: (input: RequestPhoneUpdateOtpCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
165
+ /**
166
+ * serializeAws_restJson1SendAdminLinkOtpCommand
167
+ */
168
+ export declare const se_SendAdminLinkOtpCommand: (input: SendAdminLinkOtpCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
153
169
  /**
154
170
  * serializeAws_restJson1UnlinkSocialCommand
155
171
  */
@@ -170,6 +186,10 @@ export declare const se_UpdateUsernameCommand: (input: UpdateUsernameCommandInpu
170
186
  * serializeAws_restJson1ValidateInviteCommand
171
187
  */
172
188
  export declare const se_ValidateInviteCommand: (input: ValidateInviteCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
189
+ /**
190
+ * serializeAws_restJson1VerifyAdminLinkOtpCommand
191
+ */
192
+ export declare const se_VerifyAdminLinkOtpCommand: (input: VerifyAdminLinkOtpCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
173
193
  /**
174
194
  * serializeAws_restJson1DiscoverCommand
175
195
  */
@@ -322,10 +342,18 @@ export declare const de_UpdateChatSettingsCommand: (output: __HttpResponse, cont
322
342
  * deserializeAws_restJson1AuthSocialCommand
323
343
  */
324
344
  export declare const de_AuthSocialCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<AuthSocialCommandOutput>;
345
+ /**
346
+ * deserializeAws_restJson1CreateAdminInviteCommand
347
+ */
348
+ export declare const de_CreateAdminInviteCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<CreateAdminInviteCommandOutput>;
325
349
  /**
326
350
  * deserializeAws_restJson1GenerateInviteCommand
327
351
  */
328
352
  export declare const de_GenerateInviteCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GenerateInviteCommandOutput>;
353
+ /**
354
+ * deserializeAws_restJson1GetAdminPhoneStatusCommand
355
+ */
356
+ export declare const de_GetAdminPhoneStatusCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetAdminPhoneStatusCommandOutput>;
329
357
  /**
330
358
  * deserializeAws_restJson1GetCredentialReadinessCommand
331
359
  */
@@ -366,6 +394,10 @@ export declare const de_RequestPhoneOtpCommand: (output: __HttpResponse, context
366
394
  * deserializeAws_restJson1RequestPhoneUpdateOtpCommand
367
395
  */
368
396
  export declare const de_RequestPhoneUpdateOtpCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<RequestPhoneUpdateOtpCommandOutput>;
397
+ /**
398
+ * deserializeAws_restJson1SendAdminLinkOtpCommand
399
+ */
400
+ export declare const de_SendAdminLinkOtpCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<SendAdminLinkOtpCommandOutput>;
369
401
  /**
370
402
  * deserializeAws_restJson1UnlinkSocialCommand
371
403
  */
@@ -386,6 +418,10 @@ export declare const de_UpdateUsernameCommand: (output: __HttpResponse, context:
386
418
  * deserializeAws_restJson1ValidateInviteCommand
387
419
  */
388
420
  export declare const de_ValidateInviteCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<ValidateInviteCommandOutput>;
421
+ /**
422
+ * deserializeAws_restJson1VerifyAdminLinkOtpCommand
423
+ */
424
+ export declare const de_VerifyAdminLinkOtpCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<VerifyAdminLinkOtpCommandOutput>;
389
425
  /**
390
426
  * deserializeAws_restJson1DiscoverCommand
391
427
  */
@@ -1,5 +1,5 @@
1
- export declare const TELEMETRY_CATALOG_VERSION = "1.3.0";
2
- export declare const TELEMETRY_CATALOG_HASH = "52029d112aadcfd5";
1
+ export declare const TELEMETRY_CATALOG_VERSION = "1.4.0";
2
+ export declare const TELEMETRY_CATALOG_HASH = "5cf9f7740c92eebe";
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,21 @@ 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";
224
243
  readonly ONBOARDING_NEXT: "onboarding.next";
225
244
  readonly ONBOARDING_BACK: "onboarding.back";
226
245
  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.26",
4
+ "version": "1.0.28",
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 6d0faa787d71a97191f79c16baab74a5338190e36ce761594168784da8072af2
2
+ // telemetry-integrity: sha256 b2132f38e8304ee1cf24db09423818c9cc610d1f9b02171d4c66d864474251aa
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.3.0, hash 52029d112aadcfd5.
5
+ // Catalog version 1.4.0, hash 5cf9f7740c92eebe.
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.3.0"
16
- const val HASH = "52029d112aadcfd5"
15
+ const val VERSION = "1.4.0"
16
+ const val HASH = "5cf9f7740c92eebe"
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,21 @@ 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)),
277
294
  ONBOARDING_NEXT("onboarding.next", TelemetryScreen.ONBOARDING, UiElementKind.BUTTON, listOf(UiAction.SUBMIT), listOf("basics", "photos", "media", "prompts", "details"), listOf(TelemetryPlatform.WEB, TelemetryPlatform.IOS)),
278
295
  ONBOARDING_BACK("onboarding.back", TelemetryScreen.ONBOARDING, UiElementKind.BUTTON, listOf(UiAction.TAP), null, listOf(TelemetryPlatform.WEB, TelemetryPlatform.IOS)),
279
296
  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 e9f336f3402e1b9628fd2259412a5dae385c8d736a84f32adae388bcca9c3a68
2
+ // telemetry-integrity: sha256 b7b58bab688dee924a7c76fea46d4058a3e3e69c44043f9c86aa74d01e50c520
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.3.0, hash 52029d112aadcfd5.
5
+ // Catalog version 1.4.0, hash 5cf9f7740c92eebe.
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.3.0"
14
- public static let hash = "52029d112aadcfd5"
13
+ public static let version = "1.4.0"
14
+ public static let hash = "5cf9f7740c92eebe"
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,21 @@ 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"
227
244
  case onboardingNext = "onboarding.next"
228
245
  case onboardingBack = "onboarding.back"
229
246
  case onboardingFinish = "onboarding.finish"
@@ -450,6 +467,21 @@ public enum UiElement: String, CaseIterable, Codable, Sendable {
450
467
  case .redeemInviteLogin: return UiElementSpec(screen: .redeemInvite, kind: .link, actions: [.tap], allowedValues: nil, platforms: [.web, .ios, .android])
451
468
  case .redeemInviteClose: return UiElementSpec(screen: .redeemInvite, kind: .button, actions: [.tap], allowedValues: nil, platforms: [.ios, .android])
452
469
  case .redeemInviteResendCode: return UiElementSpec(screen: .redeemInvite, kind: .link, actions: [.tap], allowedValues: nil, platforms: [.web, .ios])
470
+ case .redeemInviteGetInviteVideo: return UiElementSpec(screen: .redeemInvite, kind: .button, actions: [.tap], allowedValues: nil, platforms: [.ios, .android])
471
+ case .admissionsSubmit: return UiElementSpec(screen: .admissions, kind: .button, actions: [.submit], allowedValues: ["send_code", "verify_code", "submit_application"], platforms: [.ios, .android])
472
+ case .admissionsResendCode: return UiElementSpec(screen: .admissions, kind: .link, actions: [.tap], allowedValues: nil, platforms: [.ios, .android])
473
+ case .admissionsConsentToggle: return UiElementSpec(screen: .admissions, kind: .toggle, actions: [.toggle], allowedValues: ["checked", "unchecked"], platforms: [.ios, .android])
474
+ case .admissionsPrivacyPolicy: return UiElementSpec(screen: .admissions, kind: .link, actions: [.tap], allowedValues: nil, platforms: [.ios, .android])
475
+ case .admissionsRecordStart: return UiElementSpec(screen: .admissions, kind: .button, actions: [.tap], allowedValues: nil, platforms: [.ios, .android])
476
+ case .admissionsRecordStop: return UiElementSpec(screen: .admissions, kind: .button, actions: [.tap], allowedValues: nil, platforms: [.ios, .android])
477
+ case .admissionsRetake: return UiElementSpec(screen: .admissions, kind: .button, actions: [.tap], allowedValues: nil, platforms: [.ios, .android])
478
+ case .admissionsPreviewPlay: return UiElementSpec(screen: .admissions, kind: .toggle, actions: [.toggle], allowedValues: ["play", "pause"], platforms: [.ios, .android])
479
+ case .admissionsUploadRetry: return UiElementSpec(screen: .admissions, kind: .button, actions: [.tap], allowedValues: nil, platforms: [.ios, .android])
480
+ case .admissionsClose: return UiElementSpec(screen: .admissions, kind: .button, actions: [.tap], allowedValues: nil, platforms: [.ios, .android])
481
+ case .admissionsOpenSettings: return UiElementSpec(screen: .admissions, kind: .button, actions: [.tap], allowedValues: nil, platforms: [.ios, .android])
482
+ case .admissionsStatusRefresh: return UiElementSpec(screen: .admissionsStatus, kind: .button, actions: [.tap], allowedValues: nil, platforms: [.ios, .android])
483
+ case .admissionsStatusContinueInvite: return UiElementSpec(screen: .admissionsStatus, kind: .button, actions: [.tap], allowedValues: nil, platforms: [.ios, .android])
484
+ case .admissionsStatusWithdraw: return UiElementSpec(screen: .admissionsStatus, kind: .button, actions: [.tap], allowedValues: nil, platforms: [.ios, .android])
453
485
  case .onboardingNext: return UiElementSpec(screen: .onboarding, kind: .button, actions: [.submit], allowedValues: ["basics", "photos", "media", "prompts", "details"], platforms: [.web, .ios])
454
486
  case .onboardingBack: return UiElementSpec(screen: .onboarding, kind: .button, actions: [.tap], allowedValues: nil, platforms: [.web, .ios])
455
487
  case .onboardingFinish: return UiElementSpec(screen: .onboarding, kind: .button, actions: [.submit], allowedValues: nil, platforms: [.web, .ios, .android])