onehook-api-client 1.0.38 → 1.0.40
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 +14 -0
- package/dist-cjs/OneHook.js +4 -0
- package/dist-cjs/commands/CheckUsernameAvailabilityCommand.js +21 -0
- package/dist-cjs/commands/SetPasswordCommand.js +21 -0
- package/dist-cjs/commands/index.js +2 -0
- package/dist-cjs/models/models_0.js +7 -1
- package/dist-cjs/protocols/Aws_restJson1.js +67 -5
- package/dist-cjs/telemetry/index.js +24 -7
- package/dist-es/OneHook.js +4 -0
- package/dist-es/commands/CheckUsernameAvailabilityCommand.js +17 -0
- package/dist-es/commands/SetPasswordCommand.js +17 -0
- package/dist-es/commands/index.js +2 -0
- package/dist-es/models/models_0.js +6 -0
- package/dist-es/protocols/Aws_restJson1.js +58 -0
- package/dist-es/telemetry/index.js +24 -7
- package/dist-types/OneHook.d.ts +14 -0
- package/dist-types/OneHookClient.d.ts +4 -2
- package/dist-types/commands/CheckUsernameAvailabilityCommand.d.ts +104 -0
- package/dist-types/commands/CreateAdminInviteCommand.d.ts +6 -5
- package/dist-types/commands/GetUserByEmailCommand.d.ts +1 -0
- package/dist-types/commands/GetUserCommand.d.ts +1 -0
- package/dist-types/commands/SetPasswordCommand.d.ts +107 -0
- package/dist-types/commands/index.d.ts +2 -0
- package/dist-types/models/models_0.d.ts +58 -1
- package/dist-types/protocols/Aws_restJson1.d.ts +18 -0
- package/dist-types/telemetry/index.d.ts +12 -2
- package/package.json +1 -1
- package/telemetry/TelemetryCatalog.kt +18 -10
- package/telemetry/TelemetryCatalog.swift +25 -10
- package/telemetry/telemetry-catalog.json +151 -14
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
export const TELEMETRY_CATALOG_VERSION = "1.
|
|
2
|
-
export const TELEMETRY_CATALOG_HASH = "
|
|
1
|
+
export const TELEMETRY_CATALOG_VERSION = "1.16.0";
|
|
2
|
+
export const TELEMETRY_CATALOG_HASH = "3d27632e55e2d44f";
|
|
3
3
|
export const SignalType = {
|
|
4
4
|
SCREEN_VIEW: "screen_view",
|
|
5
5
|
UI_INTERACTION: "ui_interaction",
|
|
@@ -35,6 +35,7 @@ export const Screen = {
|
|
|
35
35
|
ADMISSIONS_STATUS: "ADMISSIONS_STATUS",
|
|
36
36
|
ONBOARDING: "ONBOARDING",
|
|
37
37
|
DISCOVER: "DISCOVER",
|
|
38
|
+
MATCHING_INTRO: "MATCHING_INTRO",
|
|
38
39
|
LIKE_COMPOSER: "LIKE_COMPOSER",
|
|
39
40
|
LIKES_YOU: "LIKES_YOU",
|
|
40
41
|
CHAT: "CHAT",
|
|
@@ -62,6 +63,7 @@ export const ViewableScreen = {
|
|
|
62
63
|
ADMISSIONS_STATUS: "ADMISSIONS_STATUS",
|
|
63
64
|
ONBOARDING: "ONBOARDING",
|
|
64
65
|
DISCOVER: "DISCOVER",
|
|
66
|
+
MATCHING_INTRO: "MATCHING_INTRO",
|
|
65
67
|
LIKE_COMPOSER: "LIKE_COMPOSER",
|
|
66
68
|
LIKES_YOU: "LIKES_YOU",
|
|
67
69
|
CHAT: "CHAT",
|
|
@@ -85,6 +87,7 @@ export const TabScreen = {
|
|
|
85
87
|
LIKES_YOU: "LIKES_YOU",
|
|
86
88
|
CHAT: "CHAT",
|
|
87
89
|
PROFILE: "PROFILE",
|
|
90
|
+
MATCHING_INTRO: "MATCHING_INTRO",
|
|
88
91
|
};
|
|
89
92
|
export const UiAction = {
|
|
90
93
|
TAP: "tap",
|
|
@@ -249,6 +252,9 @@ export const UiElement = {
|
|
|
249
252
|
ADMISSIONS_STATUS_WITHDRAW: "admissions_status.withdraw",
|
|
250
253
|
ADMISSIONS_STATUS_TRAINING_OPT_OUT: "admissions_status.training_opt_out",
|
|
251
254
|
ONBOARDING_NEXT: "onboarding.next",
|
|
255
|
+
ONBOARDING_STEP_SKIP: "onboarding.step_skip",
|
|
256
|
+
ONBOARDING_SOCIAL_LINK: "onboarding.social_link",
|
|
257
|
+
ONBOARDING_RECOVERY_SETUP: "onboarding.recovery_setup",
|
|
252
258
|
ONBOARDING_BACK: "onboarding.back",
|
|
253
259
|
ONBOARDING_FINISH: "onboarding.finish",
|
|
254
260
|
ONBOARDING_SKIP_SIGN_OUT: "onboarding.skip_sign_out",
|
|
@@ -261,6 +267,8 @@ export const UiElement = {
|
|
|
261
267
|
ONBOARDING_VOICE_ADD: "onboarding.voice_add",
|
|
262
268
|
ONBOARDING_VOICE_REMOVE: "onboarding.voice_remove",
|
|
263
269
|
ONBOARDING_CHOICE_SELECT: "onboarding.choice_select",
|
|
270
|
+
MATCHING_INTRO_TURN_ON: "matching_intro.turn_on",
|
|
271
|
+
MATCHING_INTRO_SHOULD_I_JOIN: "matching_intro.should_i_join",
|
|
264
272
|
DISCOVER_PASS_BUTTON: "discover.pass_button",
|
|
265
273
|
DISCOVER_LIKE_BUTTON: "discover.like_button",
|
|
266
274
|
DISCOVER_ROSE_BUTTON: "discover.rose_button",
|
|
@@ -376,6 +384,8 @@ export const UiElement = {
|
|
|
376
384
|
NOTIFICATIONS_ITEM_OPEN: "notifications.item_open",
|
|
377
385
|
NOTIFICATIONS_ITEM_DISMISS: "notifications.item_dismiss",
|
|
378
386
|
PROFILE_EDIT_OPEN: "profile.edit_open",
|
|
387
|
+
PROFILE_MATCHING_OPEN: "profile.matching_open",
|
|
388
|
+
PROFILE_RECOVERY_OPEN: "profile.recovery_open",
|
|
379
389
|
PROFILE_PREVIEW_OPEN: "profile.preview_open",
|
|
380
390
|
PROFILE_PREFERENCES_OPEN: "profile.preferences_open",
|
|
381
391
|
PROFILE_SETTINGS_OPEN: "profile.settings_open",
|
|
@@ -467,7 +477,7 @@ export const UiElement = {
|
|
|
467
477
|
LIVENESS_CLOSE: "liveness.close",
|
|
468
478
|
};
|
|
469
479
|
export const UI_ELEMENTS = {
|
|
470
|
-
"nav.tab_select": { screen: "NAV", kind: "tab", actions: ["select"], values: ["DISCOVER", "LIKES_YOU", "CHAT", "PROFILE"], platforms: ["web", "ios", "android"] },
|
|
480
|
+
"nav.tab_select": { screen: "NAV", kind: "tab", actions: ["select"], values: ["DISCOVER", "LIKES_YOU", "CHAT", "PROFILE", "MATCHING_INTRO"], platforms: ["web", "ios", "android"] },
|
|
471
481
|
"nav.search_open": { screen: "NAV", kind: "button", actions: ["tap", "dismiss"], values: null, platforms: ["web"] },
|
|
472
482
|
"nav.menu_open": { screen: "NAV", kind: "button", actions: ["tap", "dismiss"], values: null, platforms: ["web"] },
|
|
473
483
|
"nav.back": { screen: "NAV", kind: "button", actions: ["tap"], values: null, platforms: ["web"] },
|
|
@@ -493,7 +503,7 @@ export const UI_ELEMENTS = {
|
|
|
493
503
|
"login.google": { screen: "LOGIN", kind: "button", actions: ["tap"], values: null, platforms: ["web", "ios", "android"] },
|
|
494
504
|
"login.apple": { screen: "LOGIN", kind: "button", actions: ["tap"], values: null, platforms: ["web", "ios"] },
|
|
495
505
|
"login.passkey": { screen: "LOGIN", kind: "button", actions: ["tap"], values: null, platforms: ["ios"] },
|
|
496
|
-
"login.identifier_mode": { screen: "LOGIN", kind: "toggle", actions: ["toggle"], values: ["phone", "email"], platforms: ["web", "ios", "android"] },
|
|
506
|
+
"login.identifier_mode": { screen: "LOGIN", kind: "toggle", actions: ["toggle"], values: ["phone", "email", "username"], platforms: ["web", "ios", "android"] },
|
|
497
507
|
"login.password_mode": { screen: "LOGIN", kind: "toggle", actions: ["toggle"], values: ["password", "otp"], platforms: ["web", "ios", "android"] },
|
|
498
508
|
"login.forgot_password": { screen: "LOGIN", kind: "link", actions: ["tap"], values: null, platforms: ["web", "ios", "android"] },
|
|
499
509
|
"login.resend_code": { screen: "LOGIN", kind: "link", actions: ["tap"], values: null, platforms: ["web", "ios"] },
|
|
@@ -521,8 +531,11 @@ export const UI_ELEMENTS = {
|
|
|
521
531
|
"admissions_status.continue_invite": { screen: "ADMISSIONS_STATUS", kind: "button", actions: ["tap"], values: null, platforms: ["ios", "android"] },
|
|
522
532
|
"admissions_status.withdraw": { screen: "ADMISSIONS_STATUS", kind: "button", actions: ["tap"], values: null, platforms: ["ios", "android"] },
|
|
523
533
|
"admissions_status.training_opt_out": { screen: "ADMISSIONS_STATUS", kind: "button", actions: ["tap"], values: null, platforms: ["ios", "android"] },
|
|
524
|
-
"onboarding.next": { screen: "ONBOARDING", kind: "button", actions: ["submit"], values: ["basics", "photos", "media", "prompts", "details"], platforms: ["web", "ios"] },
|
|
525
|
-
"onboarding.
|
|
534
|
+
"onboarding.next": { screen: "ONBOARDING", kind: "button", actions: ["submit"], values: ["basics", "photos", "media", "prompts", "details", "username", "password", "social", "recovery"], platforms: ["web", "ios", "android"] },
|
|
535
|
+
"onboarding.step_skip": { screen: "ONBOARDING", kind: "button", actions: ["tap"], values: ["password", "social", "recovery"], platforms: ["web", "ios", "android"] },
|
|
536
|
+
"onboarding.social_link": { screen: "ONBOARDING", kind: "button", actions: ["tap", "dismiss"], values: ["apple", "google"], platforms: ["web", "ios", "android"] },
|
|
537
|
+
"onboarding.recovery_setup": { screen: "ONBOARDING", kind: "button", actions: ["tap", "dismiss"], values: null, platforms: ["web", "ios", "android"] },
|
|
538
|
+
"onboarding.back": { screen: "ONBOARDING", kind: "button", actions: ["tap"], values: null, platforms: ["web", "ios", "android"] },
|
|
526
539
|
"onboarding.finish": { screen: "ONBOARDING", kind: "button", actions: ["submit"], values: null, platforms: ["web", "ios", "android"] },
|
|
527
540
|
"onboarding.skip_sign_out": { screen: "ONBOARDING", kind: "button", actions: ["tap"], values: null, platforms: ["web", "ios", "android"] },
|
|
528
541
|
"onboarding.skip_sign_out_confirm": { screen: "ONBOARDING", kind: "dialog_button", actions: ["submit", "dismiss"], values: null, platforms: ["ios", "android"] },
|
|
@@ -534,6 +547,8 @@ export const UI_ELEMENTS = {
|
|
|
534
547
|
"onboarding.voice_add": { screen: "ONBOARDING", kind: "button", actions: ["tap"], values: null, platforms: [] },
|
|
535
548
|
"onboarding.voice_remove": { screen: "ONBOARDING", kind: "button", actions: ["tap"], values: null, platforms: [] },
|
|
536
549
|
"onboarding.choice_select": { screen: "ONBOARDING", kind: "segmented", actions: ["select", "tap"], values: null, platforms: ["web", "ios", "android"] },
|
|
550
|
+
"matching_intro.turn_on": { screen: "MATCHING_INTRO", kind: "button", actions: ["tap"], values: null, platforms: ["web", "ios", "android"] },
|
|
551
|
+
"matching_intro.should_i_join": { screen: "MATCHING_INTRO", kind: "button", actions: ["tap", "dismiss"], values: null, platforms: ["web", "ios", "android"] },
|
|
537
552
|
"discover.pass_button": { screen: "DISCOVER", kind: "button", actions: ["tap"], values: null, platforms: ["web", "ios", "android"] },
|
|
538
553
|
"discover.like_button": { screen: "DISCOVER", kind: "button", actions: ["tap"], values: null, platforms: ["android"] },
|
|
539
554
|
"discover.rose_button": { screen: "DISCOVER", kind: "button", actions: ["tap"], values: null, platforms: ["web", "ios", "android"] },
|
|
@@ -630,7 +645,7 @@ export const UI_ELEMENTS = {
|
|
|
630
645
|
"chat.intro_get_started": { screen: "CHAT", kind: "button", actions: ["tap"], values: null, platforms: ["ios"] },
|
|
631
646
|
"chat.history_recover_method": { screen: "CHAT", kind: "menu_item", actions: ["tap", "dismiss"], values: ["device", "qr_scan", "qr_import", "passkey"], platforms: ["web", "ios", "android"] },
|
|
632
647
|
"chat.history_recover_step": { screen: "CHAT", kind: "menu_item", actions: ["tap"], values: ["retry", "qr_retry", "done", "reset_open", "cancel"], platforms: ["web", "ios", "android"] },
|
|
633
|
-
"chat.history_reset_confirm": { screen: "CHAT", kind: "dialog_button", actions: ["submit", "dismiss"], values: null, platforms: ["
|
|
648
|
+
"chat.history_reset_confirm": { screen: "CHAT", kind: "dialog_button", actions: ["submit", "dismiss"], values: null, platforms: ["ios", "android"] },
|
|
634
649
|
"chat_settings.last_seen_select": { screen: "CHAT_SETTINGS", kind: "segmented", actions: ["select", "tap"], values: null, platforms: ["web", "ios"] },
|
|
635
650
|
"chat_settings.disappearing_select": { screen: "CHAT_SETTINGS", kind: "segmented", actions: ["select", "tap"], values: null, platforms: ["web", "ios"] },
|
|
636
651
|
"chat_settings.notification_toggle": { screen: "CHAT_SETTINGS", kind: "toggle", actions: ["toggle"], values: ["on", "off"], platforms: ["web", "ios", "android"] },
|
|
@@ -649,6 +664,8 @@ export const UI_ELEMENTS = {
|
|
|
649
664
|
"notifications.item_open": { screen: "NOTIFICATIONS", kind: "list_item", actions: ["tap"], values: null, platforms: ["ios"] },
|
|
650
665
|
"notifications.item_dismiss": { screen: "NOTIFICATIONS", kind: "gesture", actions: ["dismiss"], values: null, platforms: ["ios"] },
|
|
651
666
|
"profile.edit_open": { screen: "PROFILE", kind: "button", actions: ["tap", "dismiss"], values: null, platforms: ["ios", "android"] },
|
|
667
|
+
"profile.matching_open": { screen: "PROFILE", kind: "button", actions: ["tap"], values: null, platforms: ["web", "ios", "android"] },
|
|
668
|
+
"profile.recovery_open": { screen: "PROFILE", kind: "button", actions: ["tap", "dismiss"], values: null, platforms: ["web", "ios", "android"] },
|
|
652
669
|
"profile.preview_open": { screen: "PROFILE", kind: "button", actions: ["tap", "dismiss"], values: null, platforms: ["web", "ios"] },
|
|
653
670
|
"profile.preferences_open": { screen: "PROFILE", kind: "button", actions: ["tap"], values: null, platforms: ["ios", "android"] },
|
|
654
671
|
"profile.settings_open": { screen: "PROFILE", kind: "button", actions: ["tap"], values: null, platforms: ["web"] },
|
package/dist-types/OneHook.d.ts
CHANGED
|
@@ -3,6 +3,7 @@ import { AcceptHookRequestCommandInput, AcceptHookRequestCommandOutput } from ".
|
|
|
3
3
|
import { AuthSocialCommandInput, AuthSocialCommandOutput } from "./commands/AuthSocialCommand";
|
|
4
4
|
import { BlockUserCommandInput, BlockUserCommandOutput } from "./commands/BlockUserCommand";
|
|
5
5
|
import { CancelHookRequestCommandInput, CancelHookRequestCommandOutput } from "./commands/CancelHookRequestCommand";
|
|
6
|
+
import { CheckUsernameAvailabilityCommandInput, CheckUsernameAvailabilityCommandOutput } from "./commands/CheckUsernameAvailabilityCommand";
|
|
6
7
|
import { ClearTierOverrideCommandInput, ClearTierOverrideCommandOutput } from "./commands/ClearTierOverrideCommand";
|
|
7
8
|
import { CompleteLivenessSessionCommandInput, CompleteLivenessSessionCommandOutput } from "./commands/CompleteLivenessSessionCommand";
|
|
8
9
|
import { CompleteOnboardingCommandInput, CompleteOnboardingCommandOutput } from "./commands/CompleteOnboardingCommand";
|
|
@@ -93,6 +94,7 @@ import { SearchPlacesCommandInput, SearchPlacesCommandOutput } from "./commands/
|
|
|
93
94
|
import { SendAdminLinkOtpCommandInput, SendAdminLinkOtpCommandOutput } from "./commands/SendAdminLinkOtpCommand";
|
|
94
95
|
import { SendHookRequestCommandInput, SendHookRequestCommandOutput } from "./commands/SendHookRequestCommand";
|
|
95
96
|
import { SetAccountStateCommandInput, SetAccountStateCommandOutput } from "./commands/SetAccountStateCommand";
|
|
97
|
+
import { SetPasswordCommandInput, SetPasswordCommandOutput } from "./commands/SetPasswordCommand";
|
|
96
98
|
import { SetPreservationHoldCommandInput, SetPreservationHoldCommandOutput } from "./commands/SetPreservationHoldCommand";
|
|
97
99
|
import { SetTierOverrideCommandInput, SetTierOverrideCommandOutput } from "./commands/SetTierOverrideCommand";
|
|
98
100
|
import { SimulateScoringPolicyCommandInput, SimulateScoringPolicyCommandOutput } from "./commands/SimulateScoringPolicyCommand";
|
|
@@ -258,6 +260,12 @@ export interface OneHook {
|
|
|
258
260
|
authSocial(args: AuthSocialCommandInput, options?: __HttpHandlerOptions): Promise<AuthSocialCommandOutput>;
|
|
259
261
|
authSocial(args: AuthSocialCommandInput, cb: (err: any, data?: AuthSocialCommandOutput) => void): void;
|
|
260
262
|
authSocial(args: AuthSocialCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AuthSocialCommandOutput) => void): void;
|
|
263
|
+
/**
|
|
264
|
+
* @see {@link CheckUsernameAvailabilityCommand}
|
|
265
|
+
*/
|
|
266
|
+
checkUsernameAvailability(args: CheckUsernameAvailabilityCommandInput, options?: __HttpHandlerOptions): Promise<CheckUsernameAvailabilityCommandOutput>;
|
|
267
|
+
checkUsernameAvailability(args: CheckUsernameAvailabilityCommandInput, cb: (err: any, data?: CheckUsernameAvailabilityCommandOutput) => void): void;
|
|
268
|
+
checkUsernameAvailability(args: CheckUsernameAvailabilityCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CheckUsernameAvailabilityCommandOutput) => void): void;
|
|
261
269
|
/**
|
|
262
270
|
* @see {@link CreateAdminInviteCommand}
|
|
263
271
|
*/
|
|
@@ -372,6 +380,12 @@ export interface OneHook {
|
|
|
372
380
|
setAccountState(args: SetAccountStateCommandInput, options?: __HttpHandlerOptions): Promise<SetAccountStateCommandOutput>;
|
|
373
381
|
setAccountState(args: SetAccountStateCommandInput, cb: (err: any, data?: SetAccountStateCommandOutput) => void): void;
|
|
374
382
|
setAccountState(args: SetAccountStateCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetAccountStateCommandOutput) => void): void;
|
|
383
|
+
/**
|
|
384
|
+
* @see {@link SetPasswordCommand}
|
|
385
|
+
*/
|
|
386
|
+
setPassword(args: SetPasswordCommandInput, options?: __HttpHandlerOptions): Promise<SetPasswordCommandOutput>;
|
|
387
|
+
setPassword(args: SetPasswordCommandInput, cb: (err: any, data?: SetPasswordCommandOutput) => void): void;
|
|
388
|
+
setPassword(args: SetPasswordCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SetPasswordCommandOutput) => void): void;
|
|
375
389
|
/**
|
|
376
390
|
* @see {@link SetPreservationHoldCommand}
|
|
377
391
|
*/
|
|
@@ -3,6 +3,7 @@ import { AcceptHookRequestCommandInput, AcceptHookRequestCommandOutput } from ".
|
|
|
3
3
|
import { AuthSocialCommandInput, AuthSocialCommandOutput } from "./commands/AuthSocialCommand";
|
|
4
4
|
import { BlockUserCommandInput, BlockUserCommandOutput } from "./commands/BlockUserCommand";
|
|
5
5
|
import { CancelHookRequestCommandInput, CancelHookRequestCommandOutput } from "./commands/CancelHookRequestCommand";
|
|
6
|
+
import { CheckUsernameAvailabilityCommandInput, CheckUsernameAvailabilityCommandOutput } from "./commands/CheckUsernameAvailabilityCommand";
|
|
6
7
|
import { ClearTierOverrideCommandInput, ClearTierOverrideCommandOutput } from "./commands/ClearTierOverrideCommand";
|
|
7
8
|
import { CompleteLivenessSessionCommandInput, CompleteLivenessSessionCommandOutput } from "./commands/CompleteLivenessSessionCommand";
|
|
8
9
|
import { CompleteOnboardingCommandInput, CompleteOnboardingCommandOutput } from "./commands/CompleteOnboardingCommand";
|
|
@@ -93,6 +94,7 @@ import { SearchPlacesCommandInput, SearchPlacesCommandOutput } from "./commands/
|
|
|
93
94
|
import { SendAdminLinkOtpCommandInput, SendAdminLinkOtpCommandOutput } from "./commands/SendAdminLinkOtpCommand";
|
|
94
95
|
import { SendHookRequestCommandInput, SendHookRequestCommandOutput } from "./commands/SendHookRequestCommand";
|
|
95
96
|
import { SetAccountStateCommandInput, SetAccountStateCommandOutput } from "./commands/SetAccountStateCommand";
|
|
97
|
+
import { SetPasswordCommandInput, SetPasswordCommandOutput } from "./commands/SetPasswordCommand";
|
|
96
98
|
import { SetPreservationHoldCommandInput, SetPreservationHoldCommandOutput } from "./commands/SetPreservationHoldCommand";
|
|
97
99
|
import { SetTierOverrideCommandInput, SetTierOverrideCommandOutput } from "./commands/SetTierOverrideCommand";
|
|
98
100
|
import { SimulateScoringPolicyCommandInput, SimulateScoringPolicyCommandOutput } from "./commands/SimulateScoringPolicyCommand";
|
|
@@ -124,11 +126,11 @@ export { __Client };
|
|
|
124
126
|
/**
|
|
125
127
|
* @public
|
|
126
128
|
*/
|
|
127
|
-
export type ServiceInputTypes = AcceptHookRequestCommandInput | AuthSocialCommandInput | BlockUserCommandInput | CancelHookRequestCommandInput | ClearTierOverrideCommandInput | CompleteLivenessSessionCommandInput | CompleteOnboardingCommandInput | CorrectBirthDateCommandInput | CreateAdminInviteCommandInput | CreateLivenessSessionCommandInput | CreateMediaDownloadUrlCommandInput | CreateMediaUploadUrlCommandInput | DeclineHookRequestCommandInput | DeleteMatchMessagesCommandInput | DeleteProfileCommandInput | DeletePushTokenCommandInput | DisableMatchingCommandInput | DiscoverCommandInput | EnableMatchingCommandInput | EstablishHistoryEpochCommandInput | GenerateDownloadUrlCommandInput | GenerateInviteCommandInput | GenerateUploadUrlCommandInput | GetAccountStateCommandInput | GetAdminPhoneStatusCommandInput | GetAiContextMatchCommandInput | GetBirthDateStatusCommandInput | GetChatProfileCommandInput | GetChatSettingsCommandInput | GetCredentialReadinessCommandInput | GetDiscoverySnapshotCommandInput | GetGraphInvitesCommandInput | GetGraphMatchCommandInput | GetGraphUserCommandInput | GetHistoryStateCommandInput | GetInternalMatchingStatusCommandInput | GetInternalProfileCommandInput | GetInviteEdgesCommandInput | GetLivenessStatusCommandInput | GetMatchCommandInput | GetMatchingProfileCommandInput | GetMatchingReadinessCommandInput | GetMediaStatsCommandInput | GetModerationReportCommandInput | GetModerationSignalsCommandInput | GetMyProfileCommandInput | GetParticipantRegistryCommandInput | GetPartnerDistanceCommandInput | GetPlaceCommandInput | GetPreferencesCommandInput | GetPreservationHoldCommandInput | GetReceivedLikesCommandInput | GetRosesCommandInput | GetScoringPolicyCommandInput | GetStateCommandInput | GetSuggestionsCommandInput | GetTierOverrideCommandInput | GetTraditionPreferencesCommandInput | GetUserByEmailCommandInput | GetUserCommandInput | GetUserIdByUsernameCommandInput | IndexLocationCommandInput | IngestSignalsCommandInput | InitUserCommandInput | IssueViewPassesCommandInput | KeepHooksCommandInput | LinkEmailCommandInput | LinkSocialCommandInput | ListBlocksCommandInput | ListGraphUserMatchesCommandInput | ListHookRequestsCommandInput | ListMatchingOnMembersCommandInput | ListMyDevicesCommandInput | PutHistoryWrapCommandInput | RecordSuggestionCommandInput | RecordSuggestionInternalCommandInput | RegisterDeviceCommandInput | RegisterPhoneCommandInput | RegisterPushTokenCommandInput | RemoveLocationCommandInput | RemoveOneHookSuggestionCommandInput | RemoveSuggestionCommandInput | ReportMemberCommandInput | RepublishMatchingProfileCommandInput | RequestEmailOtpCommandInput | RequestPhoneOtpCommandInput | RequestPhoneUpdateOtpCommandInput | RevokeDeviceCommandInput | RevokeHistoryWrapCommandInput | RevokeUserAccessCommandInput | SearchPlacesCommandInput | SendAdminLinkOtpCommandInput | SendHookRequestCommandInput | SetAccountStateCommandInput | SetPreservationHoldCommandInput | SetTierOverrideCommandInput | SimulateScoringPolicyCommandInput | SwipeCommandInput | UnblockUserCommandInput | UnhookCommandInput | UnlinkSocialCommandInput | UpdateChatSettingsCommandInput | UpdateEntitlementsCommandInput | UpdatePhoneNumberCommandInput | UpdatePreferencesCommandInput | UpdateScoringPolicyCommandInput | UpdateTraditionPreferencesCommandInput | UpdateUsernameCommandInput | UpgradeUserCommandInput | UpsertChatProfileCommandInput | UpsertMatchingProfileCommandInput | ValidateInviteCommandInput | VerifyAdminLinkOtpCommandInput;
|
|
129
|
+
export type ServiceInputTypes = AcceptHookRequestCommandInput | AuthSocialCommandInput | BlockUserCommandInput | CancelHookRequestCommandInput | CheckUsernameAvailabilityCommandInput | ClearTierOverrideCommandInput | CompleteLivenessSessionCommandInput | CompleteOnboardingCommandInput | CorrectBirthDateCommandInput | CreateAdminInviteCommandInput | CreateLivenessSessionCommandInput | CreateMediaDownloadUrlCommandInput | CreateMediaUploadUrlCommandInput | DeclineHookRequestCommandInput | DeleteMatchMessagesCommandInput | DeleteProfileCommandInput | DeletePushTokenCommandInput | DisableMatchingCommandInput | DiscoverCommandInput | EnableMatchingCommandInput | EstablishHistoryEpochCommandInput | GenerateDownloadUrlCommandInput | GenerateInviteCommandInput | GenerateUploadUrlCommandInput | GetAccountStateCommandInput | GetAdminPhoneStatusCommandInput | GetAiContextMatchCommandInput | GetBirthDateStatusCommandInput | GetChatProfileCommandInput | GetChatSettingsCommandInput | GetCredentialReadinessCommandInput | GetDiscoverySnapshotCommandInput | GetGraphInvitesCommandInput | GetGraphMatchCommandInput | GetGraphUserCommandInput | GetHistoryStateCommandInput | GetInternalMatchingStatusCommandInput | GetInternalProfileCommandInput | GetInviteEdgesCommandInput | GetLivenessStatusCommandInput | GetMatchCommandInput | GetMatchingProfileCommandInput | GetMatchingReadinessCommandInput | GetMediaStatsCommandInput | GetModerationReportCommandInput | GetModerationSignalsCommandInput | GetMyProfileCommandInput | GetParticipantRegistryCommandInput | GetPartnerDistanceCommandInput | GetPlaceCommandInput | GetPreferencesCommandInput | GetPreservationHoldCommandInput | GetReceivedLikesCommandInput | GetRosesCommandInput | GetScoringPolicyCommandInput | GetStateCommandInput | GetSuggestionsCommandInput | GetTierOverrideCommandInput | GetTraditionPreferencesCommandInput | GetUserByEmailCommandInput | GetUserCommandInput | GetUserIdByUsernameCommandInput | IndexLocationCommandInput | IngestSignalsCommandInput | InitUserCommandInput | IssueViewPassesCommandInput | KeepHooksCommandInput | LinkEmailCommandInput | LinkSocialCommandInput | ListBlocksCommandInput | ListGraphUserMatchesCommandInput | ListHookRequestsCommandInput | ListMatchingOnMembersCommandInput | ListMyDevicesCommandInput | PutHistoryWrapCommandInput | RecordSuggestionCommandInput | RecordSuggestionInternalCommandInput | RegisterDeviceCommandInput | RegisterPhoneCommandInput | RegisterPushTokenCommandInput | RemoveLocationCommandInput | RemoveOneHookSuggestionCommandInput | RemoveSuggestionCommandInput | ReportMemberCommandInput | RepublishMatchingProfileCommandInput | RequestEmailOtpCommandInput | RequestPhoneOtpCommandInput | RequestPhoneUpdateOtpCommandInput | RevokeDeviceCommandInput | RevokeHistoryWrapCommandInput | RevokeUserAccessCommandInput | SearchPlacesCommandInput | SendAdminLinkOtpCommandInput | SendHookRequestCommandInput | SetAccountStateCommandInput | SetPasswordCommandInput | SetPreservationHoldCommandInput | SetTierOverrideCommandInput | SimulateScoringPolicyCommandInput | SwipeCommandInput | UnblockUserCommandInput | UnhookCommandInput | UnlinkSocialCommandInput | UpdateChatSettingsCommandInput | UpdateEntitlementsCommandInput | UpdatePhoneNumberCommandInput | UpdatePreferencesCommandInput | UpdateScoringPolicyCommandInput | UpdateTraditionPreferencesCommandInput | UpdateUsernameCommandInput | UpgradeUserCommandInput | UpsertChatProfileCommandInput | UpsertMatchingProfileCommandInput | ValidateInviteCommandInput | VerifyAdminLinkOtpCommandInput;
|
|
128
130
|
/**
|
|
129
131
|
* @public
|
|
130
132
|
*/
|
|
131
|
-
export type ServiceOutputTypes = AcceptHookRequestCommandOutput | AuthSocialCommandOutput | BlockUserCommandOutput | CancelHookRequestCommandOutput | ClearTierOverrideCommandOutput | CompleteLivenessSessionCommandOutput | CompleteOnboardingCommandOutput | CorrectBirthDateCommandOutput | CreateAdminInviteCommandOutput | CreateLivenessSessionCommandOutput | CreateMediaDownloadUrlCommandOutput | CreateMediaUploadUrlCommandOutput | DeclineHookRequestCommandOutput | DeleteMatchMessagesCommandOutput | DeleteProfileCommandOutput | DeletePushTokenCommandOutput | DisableMatchingCommandOutput | DiscoverCommandOutput | EnableMatchingCommandOutput | EstablishHistoryEpochCommandOutput | GenerateDownloadUrlCommandOutput | GenerateInviteCommandOutput | GenerateUploadUrlCommandOutput | GetAccountStateCommandOutput | GetAdminPhoneStatusCommandOutput | GetAiContextMatchCommandOutput | GetBirthDateStatusCommandOutput | GetChatProfileCommandOutput | GetChatSettingsCommandOutput | GetCredentialReadinessCommandOutput | GetDiscoverySnapshotCommandOutput | GetGraphInvitesCommandOutput | GetGraphMatchCommandOutput | GetGraphUserCommandOutput | GetHistoryStateCommandOutput | GetInternalMatchingStatusCommandOutput | GetInternalProfileCommandOutput | GetInviteEdgesCommandOutput | GetLivenessStatusCommandOutput | GetMatchCommandOutput | GetMatchingProfileCommandOutput | GetMatchingReadinessCommandOutput | GetMediaStatsCommandOutput | GetModerationReportCommandOutput | GetModerationSignalsCommandOutput | GetMyProfileCommandOutput | GetParticipantRegistryCommandOutput | GetPartnerDistanceCommandOutput | GetPlaceCommandOutput | GetPreferencesCommandOutput | GetPreservationHoldCommandOutput | GetReceivedLikesCommandOutput | GetRosesCommandOutput | GetScoringPolicyCommandOutput | GetStateCommandOutput | GetSuggestionsCommandOutput | GetTierOverrideCommandOutput | GetTraditionPreferencesCommandOutput | GetUserByEmailCommandOutput | GetUserCommandOutput | GetUserIdByUsernameCommandOutput | IndexLocationCommandOutput | IngestSignalsCommandOutput | InitUserCommandOutput | IssueViewPassesCommandOutput | KeepHooksCommandOutput | LinkEmailCommandOutput | LinkSocialCommandOutput | ListBlocksCommandOutput | ListGraphUserMatchesCommandOutput | ListHookRequestsCommandOutput | ListMatchingOnMembersCommandOutput | ListMyDevicesCommandOutput | PutHistoryWrapCommandOutput | RecordSuggestionCommandOutput | RecordSuggestionInternalCommandOutput | RegisterDeviceCommandOutput | RegisterPhoneCommandOutput | RegisterPushTokenCommandOutput | RemoveLocationCommandOutput | RemoveOneHookSuggestionCommandOutput | RemoveSuggestionCommandOutput | ReportMemberCommandOutput | RepublishMatchingProfileCommandOutput | RequestEmailOtpCommandOutput | RequestPhoneOtpCommandOutput | RequestPhoneUpdateOtpCommandOutput | RevokeDeviceCommandOutput | RevokeHistoryWrapCommandOutput | RevokeUserAccessCommandOutput | SearchPlacesCommandOutput | SendAdminLinkOtpCommandOutput | SendHookRequestCommandOutput | SetAccountStateCommandOutput | SetPreservationHoldCommandOutput | SetTierOverrideCommandOutput | SimulateScoringPolicyCommandOutput | SwipeCommandOutput | UnblockUserCommandOutput | UnhookCommandOutput | UnlinkSocialCommandOutput | UpdateChatSettingsCommandOutput | UpdateEntitlementsCommandOutput | UpdatePhoneNumberCommandOutput | UpdatePreferencesCommandOutput | UpdateScoringPolicyCommandOutput | UpdateTraditionPreferencesCommandOutput | UpdateUsernameCommandOutput | UpgradeUserCommandOutput | UpsertChatProfileCommandOutput | UpsertMatchingProfileCommandOutput | ValidateInviteCommandOutput | VerifyAdminLinkOtpCommandOutput;
|
|
133
|
+
export type ServiceOutputTypes = AcceptHookRequestCommandOutput | AuthSocialCommandOutput | BlockUserCommandOutput | CancelHookRequestCommandOutput | CheckUsernameAvailabilityCommandOutput | ClearTierOverrideCommandOutput | CompleteLivenessSessionCommandOutput | CompleteOnboardingCommandOutput | CorrectBirthDateCommandOutput | CreateAdminInviteCommandOutput | CreateLivenessSessionCommandOutput | CreateMediaDownloadUrlCommandOutput | CreateMediaUploadUrlCommandOutput | DeclineHookRequestCommandOutput | DeleteMatchMessagesCommandOutput | DeleteProfileCommandOutput | DeletePushTokenCommandOutput | DisableMatchingCommandOutput | DiscoverCommandOutput | EnableMatchingCommandOutput | EstablishHistoryEpochCommandOutput | GenerateDownloadUrlCommandOutput | GenerateInviteCommandOutput | GenerateUploadUrlCommandOutput | GetAccountStateCommandOutput | GetAdminPhoneStatusCommandOutput | GetAiContextMatchCommandOutput | GetBirthDateStatusCommandOutput | GetChatProfileCommandOutput | GetChatSettingsCommandOutput | GetCredentialReadinessCommandOutput | GetDiscoverySnapshotCommandOutput | GetGraphInvitesCommandOutput | GetGraphMatchCommandOutput | GetGraphUserCommandOutput | GetHistoryStateCommandOutput | GetInternalMatchingStatusCommandOutput | GetInternalProfileCommandOutput | GetInviteEdgesCommandOutput | GetLivenessStatusCommandOutput | GetMatchCommandOutput | GetMatchingProfileCommandOutput | GetMatchingReadinessCommandOutput | GetMediaStatsCommandOutput | GetModerationReportCommandOutput | GetModerationSignalsCommandOutput | GetMyProfileCommandOutput | GetParticipantRegistryCommandOutput | GetPartnerDistanceCommandOutput | GetPlaceCommandOutput | GetPreferencesCommandOutput | GetPreservationHoldCommandOutput | GetReceivedLikesCommandOutput | GetRosesCommandOutput | GetScoringPolicyCommandOutput | GetStateCommandOutput | GetSuggestionsCommandOutput | GetTierOverrideCommandOutput | GetTraditionPreferencesCommandOutput | GetUserByEmailCommandOutput | GetUserCommandOutput | GetUserIdByUsernameCommandOutput | IndexLocationCommandOutput | IngestSignalsCommandOutput | InitUserCommandOutput | IssueViewPassesCommandOutput | KeepHooksCommandOutput | LinkEmailCommandOutput | LinkSocialCommandOutput | ListBlocksCommandOutput | ListGraphUserMatchesCommandOutput | ListHookRequestsCommandOutput | ListMatchingOnMembersCommandOutput | ListMyDevicesCommandOutput | PutHistoryWrapCommandOutput | RecordSuggestionCommandOutput | RecordSuggestionInternalCommandOutput | RegisterDeviceCommandOutput | RegisterPhoneCommandOutput | RegisterPushTokenCommandOutput | RemoveLocationCommandOutput | RemoveOneHookSuggestionCommandOutput | RemoveSuggestionCommandOutput | ReportMemberCommandOutput | RepublishMatchingProfileCommandOutput | RequestEmailOtpCommandOutput | RequestPhoneOtpCommandOutput | RequestPhoneUpdateOtpCommandOutput | RevokeDeviceCommandOutput | RevokeHistoryWrapCommandOutput | RevokeUserAccessCommandOutput | SearchPlacesCommandOutput | SendAdminLinkOtpCommandOutput | SendHookRequestCommandOutput | SetAccountStateCommandOutput | SetPasswordCommandOutput | SetPreservationHoldCommandOutput | SetTierOverrideCommandOutput | SimulateScoringPolicyCommandOutput | SwipeCommandOutput | UnblockUserCommandOutput | UnhookCommandOutput | UnlinkSocialCommandOutput | UpdateChatSettingsCommandOutput | UpdateEntitlementsCommandOutput | UpdatePhoneNumberCommandOutput | UpdatePreferencesCommandOutput | UpdateScoringPolicyCommandOutput | UpdateTraditionPreferencesCommandOutput | UpdateUsernameCommandOutput | UpgradeUserCommandOutput | UpsertChatProfileCommandOutput | UpsertMatchingProfileCommandOutput | ValidateInviteCommandOutput | VerifyAdminLinkOtpCommandOutput;
|
|
132
134
|
/**
|
|
133
135
|
* @public
|
|
134
136
|
*/
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
|
|
2
|
+
import { CheckUsernameAvailabilityRequest, CheckUsernameAvailabilityResponse } 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 CheckUsernameAvailabilityCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface CheckUsernameAvailabilityCommandInput extends CheckUsernameAvailabilityRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link CheckUsernameAvailabilityCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface CheckUsernameAvailabilityCommandOutput extends CheckUsernameAvailabilityResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const CheckUsernameAvailabilityCommand_base: {
|
|
25
|
+
new (input: CheckUsernameAvailabilityCommandInput): import("@smithy/smithy-client").CommandImpl<CheckUsernameAvailabilityCommandInput, CheckUsernameAvailabilityCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: CheckUsernameAvailabilityCommandInput): import("@smithy/smithy-client").CommandImpl<CheckUsernameAvailabilityCommandInput, CheckUsernameAvailabilityCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Reports whether a username can be claimed by the caller. Usernames are public handles (others send
|
|
31
|
+
* hook requests to them), so saying a handle is taken is expected; the response never says WHO holds
|
|
32
|
+
* it. A malformed or reserved handle answers 200 with `INVALID` and a `reason`, so the form can show it
|
|
33
|
+
* inline. `CURRENT` means it is already the caller's own. Rate limited per member (429).
|
|
34
|
+
* @example
|
|
35
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
36
|
+
* ```javascript
|
|
37
|
+
* import { OneHookClient, CheckUsernameAvailabilityCommand } from "onehook-api-client"; // ES Modules import
|
|
38
|
+
* // const { OneHookClient, CheckUsernameAvailabilityCommand } = require("onehook-api-client"); // CommonJS import
|
|
39
|
+
* const client = new OneHookClient(config);
|
|
40
|
+
* const input = { // CheckUsernameAvailabilityRequest
|
|
41
|
+
* username: "STRING_VALUE", // required
|
|
42
|
+
* };
|
|
43
|
+
* const command = new CheckUsernameAvailabilityCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // CheckUsernameAvailabilityResponse
|
|
46
|
+
* // username: "STRING_VALUE", // required
|
|
47
|
+
* // status: "AVAILABLE" || "TAKEN" || "INVALID" || "CURRENT", // required
|
|
48
|
+
* // reason: "STRING_VALUE",
|
|
49
|
+
* // };
|
|
50
|
+
*
|
|
51
|
+
* ```
|
|
52
|
+
*
|
|
53
|
+
* @param CheckUsernameAvailabilityCommandInput - {@link CheckUsernameAvailabilityCommandInput}
|
|
54
|
+
* @returns {@link CheckUsernameAvailabilityCommandOutput}
|
|
55
|
+
* @see {@link CheckUsernameAvailabilityCommandInput} for command's `input` shape.
|
|
56
|
+
* @see {@link CheckUsernameAvailabilityCommandOutput} for command's `response` shape.
|
|
57
|
+
* @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link BadRequestError} (client fault)
|
|
60
|
+
* 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link TooManyRequestsError} (client fault)
|
|
63
|
+
* 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
|
|
64
|
+
* `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
|
|
65
|
+
* model.
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link InternalServerError} (server fault)
|
|
68
|
+
* 500: an unexpected failure (code `INTERNAL_ERROR`).
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link UnauthorizedError} (client fault)
|
|
71
|
+
* 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link ForbiddenError} (client fault)
|
|
74
|
+
* 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
|
|
75
|
+
* `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link BadGatewayError} (server fault)
|
|
78
|
+
* 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
|
|
79
|
+
* (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
|
|
80
|
+
* (`PROPAGATION_FAILED`, retrying the same request is safe).
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link ServiceUnavailableError} (server fault)
|
|
83
|
+
* 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
|
|
84
|
+
* `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link OneHookServiceException}
|
|
87
|
+
* <p>Base exception class for all service exceptions from OneHook service.</p>
|
|
88
|
+
*
|
|
89
|
+
*
|
|
90
|
+
* @public
|
|
91
|
+
*/
|
|
92
|
+
export declare class CheckUsernameAvailabilityCommand extends CheckUsernameAvailabilityCommand_base {
|
|
93
|
+
/** @internal type navigation helper, not in runtime. */
|
|
94
|
+
protected static __types: {
|
|
95
|
+
api: {
|
|
96
|
+
input: CheckUsernameAvailabilityRequest;
|
|
97
|
+
output: CheckUsernameAvailabilityResponse;
|
|
98
|
+
};
|
|
99
|
+
sdk: {
|
|
100
|
+
input: CheckUsernameAvailabilityCommandInput;
|
|
101
|
+
output: CheckUsernameAvailabilityCommandOutput;
|
|
102
|
+
};
|
|
103
|
+
};
|
|
104
|
+
}
|
|
@@ -31,10 +31,11 @@ declare const CreateAdminInviteCommand_base: {
|
|
|
31
31
|
* module. Internal, IAM-authorized (SigV4) — NOT the Cognito user-pool authorizer — so the only
|
|
32
32
|
* callers are principals granted \{@code execute-api:Invoke\} (the portal's per-module invoke role).
|
|
33
33
|
*
|
|
34
|
-
*
|
|
35
|
-
*
|
|
36
|
-
*
|
|
37
|
-
*
|
|
34
|
+
* Created with \{@code maxUses=1\} and a short TTL (default 14 days, bounded 1..30). With a
|
|
35
|
+
* \{@code phoneNumber\}, the invite is bound to the HMAC hash of that E.164 number: \{@code RegisterPhone\}
|
|
36
|
+
* refuses it for any other phone, with the SAME error as an invalid/unknown invite, so the binding is
|
|
37
|
+
* never revealed. Without one, the invite is unbound and any phone may redeem it. The response never
|
|
38
|
+
* echoes the phone or its hash.
|
|
38
39
|
* @example
|
|
39
40
|
* Use a bare-bones client and the command you need to make an API call.
|
|
40
41
|
* ```javascript
|
|
@@ -42,7 +43,7 @@ declare const CreateAdminInviteCommand_base: {
|
|
|
42
43
|
* // const { OneHookClient, CreateAdminInviteCommand } = require("onehook-api-client"); // CommonJS import
|
|
43
44
|
* const client = new OneHookClient(config);
|
|
44
45
|
* const input = { // CreateAdminInviteRequest
|
|
45
|
-
* phoneNumber: "STRING_VALUE",
|
|
46
|
+
* phoneNumber: "STRING_VALUE",
|
|
46
47
|
* referrerId: "STRING_VALUE", // required
|
|
47
48
|
* ttlDays: Number("int"),
|
|
48
49
|
* };
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
|
|
2
|
+
import { SetPasswordRequest, SetPasswordResponse } 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 SetPasswordCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface SetPasswordCommandInput extends SetPasswordRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link SetPasswordCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface SetPasswordCommandOutput extends SetPasswordResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const SetPasswordCommand_base: {
|
|
25
|
+
new (input: SetPasswordCommandInput): import("@smithy/smithy-client").CommandImpl<SetPasswordCommandInput, SetPasswordCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: SetPasswordCommandInput): import("@smithy/smithy-client").CommandImpl<SetPasswordCommandInput, SetPasswordCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Sets the caller's first password, so they can also sign in with phone, email or username plus
|
|
31
|
+
* password. Sign-up never gives a member a password they know, so no current password exists to ask
|
|
32
|
+
* for. Allowed only while the member has never chosen one: after that it answers 409
|
|
33
|
+
* `PASSWORD_ALREADY_SET` and the client changes it with Cognito ChangePassword, which requires the old
|
|
34
|
+
* one. The password must meet the pool policy (at least 12 characters and a symbol), otherwise 400.
|
|
35
|
+
* @example
|
|
36
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
37
|
+
* ```javascript
|
|
38
|
+
* import { OneHookClient, SetPasswordCommand } from "onehook-api-client"; // ES Modules import
|
|
39
|
+
* // const { OneHookClient, SetPasswordCommand } = require("onehook-api-client"); // CommonJS import
|
|
40
|
+
* const client = new OneHookClient(config);
|
|
41
|
+
* const input = { // SetPasswordRequest
|
|
42
|
+
* password: "STRING_VALUE", // required
|
|
43
|
+
* };
|
|
44
|
+
* const command = new SetPasswordCommand(input);
|
|
45
|
+
* const response = await client.send(command);
|
|
46
|
+
* // { // SetPasswordResponse
|
|
47
|
+
* // status: "STRING_VALUE", // required
|
|
48
|
+
* // };
|
|
49
|
+
*
|
|
50
|
+
* ```
|
|
51
|
+
*
|
|
52
|
+
* @param SetPasswordCommandInput - {@link SetPasswordCommandInput}
|
|
53
|
+
* @returns {@link SetPasswordCommandOutput}
|
|
54
|
+
* @see {@link SetPasswordCommandInput} for command's `input` shape.
|
|
55
|
+
* @see {@link SetPasswordCommandOutput} for command's `response` shape.
|
|
56
|
+
* @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link BadRequestError} (client fault)
|
|
59
|
+
* 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link ConflictError} (client fault)
|
|
62
|
+
* 409: the request conflicts with the current state (code `CONFLICT`, or a more specific one such
|
|
63
|
+
* as `NOT_READY` or `MATCHING_ERASING`).
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link InternalServerError} (server fault)
|
|
66
|
+
* 500: an unexpected failure (code `INTERNAL_ERROR`).
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link UnauthorizedError} (client fault)
|
|
69
|
+
* 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link ForbiddenError} (client fault)
|
|
72
|
+
* 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
|
|
73
|
+
* `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link TooManyRequestsError} (client fault)
|
|
76
|
+
* 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
|
|
77
|
+
* `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
|
|
78
|
+
* model.
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link BadGatewayError} (server fault)
|
|
81
|
+
* 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
|
|
82
|
+
* (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
|
|
83
|
+
* (`PROPAGATION_FAILED`, retrying the same request is safe).
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link ServiceUnavailableError} (server fault)
|
|
86
|
+
* 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
|
|
87
|
+
* `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link OneHookServiceException}
|
|
90
|
+
* <p>Base exception class for all service exceptions from OneHook service.</p>
|
|
91
|
+
*
|
|
92
|
+
*
|
|
93
|
+
* @public
|
|
94
|
+
*/
|
|
95
|
+
export declare class SetPasswordCommand extends SetPasswordCommand_base {
|
|
96
|
+
/** @internal type navigation helper, not in runtime. */
|
|
97
|
+
protected static __types: {
|
|
98
|
+
api: {
|
|
99
|
+
input: SetPasswordRequest;
|
|
100
|
+
output: SetPasswordResponse;
|
|
101
|
+
};
|
|
102
|
+
sdk: {
|
|
103
|
+
input: SetPasswordCommandInput;
|
|
104
|
+
output: SetPasswordCommandOutput;
|
|
105
|
+
};
|
|
106
|
+
};
|
|
107
|
+
}
|
|
@@ -21,6 +21,7 @@ export * from "./RevokeDeviceCommand";
|
|
|
21
21
|
export * from "./RevokeHistoryWrapCommand";
|
|
22
22
|
export * from "./UpdateChatSettingsCommand";
|
|
23
23
|
export * from "./AuthSocialCommand";
|
|
24
|
+
export * from "./CheckUsernameAvailabilityCommand";
|
|
24
25
|
export * from "./CreateAdminInviteCommand";
|
|
25
26
|
export * from "./GenerateInviteCommand";
|
|
26
27
|
export * from "./GetAccountStateCommand";
|
|
@@ -40,6 +41,7 @@ export * from "./RequestPhoneUpdateOtpCommand";
|
|
|
40
41
|
export * from "./RevokeUserAccessCommand";
|
|
41
42
|
export * from "./SendAdminLinkOtpCommand";
|
|
42
43
|
export * from "./SetAccountStateCommand";
|
|
44
|
+
export * from "./SetPasswordCommand";
|
|
43
45
|
export * from "./SetPreservationHoldCommand";
|
|
44
46
|
export * from "./UnlinkSocialCommand";
|
|
45
47
|
export * from "./UpdateEntitlementsCommand";
|
|
@@ -1369,11 +1369,51 @@ export interface AuthSocialResponse {
|
|
|
1369
1369
|
userId?: string | undefined;
|
|
1370
1370
|
isNewUser?: boolean | undefined;
|
|
1371
1371
|
}
|
|
1372
|
+
/**
|
|
1373
|
+
* @public
|
|
1374
|
+
*/
|
|
1375
|
+
export interface CheckUsernameAvailabilityRequest {
|
|
1376
|
+
username: string | undefined;
|
|
1377
|
+
}
|
|
1378
|
+
/**
|
|
1379
|
+
* @public
|
|
1380
|
+
* @enum
|
|
1381
|
+
*/
|
|
1382
|
+
export declare const UsernameAvailability: {
|
|
1383
|
+
readonly AVAILABLE: "AVAILABLE";
|
|
1384
|
+
readonly CURRENT: "CURRENT";
|
|
1385
|
+
readonly INVALID: "INVALID";
|
|
1386
|
+
readonly TAKEN: "TAKEN";
|
|
1387
|
+
};
|
|
1388
|
+
/**
|
|
1389
|
+
* @public
|
|
1390
|
+
*/
|
|
1391
|
+
export type UsernameAvailability = typeof UsernameAvailability[keyof typeof UsernameAvailability];
|
|
1392
|
+
/**
|
|
1393
|
+
* @public
|
|
1394
|
+
*/
|
|
1395
|
+
export interface CheckUsernameAvailabilityResponse {
|
|
1396
|
+
/**
|
|
1397
|
+
* The handle that was checked, as submitted.
|
|
1398
|
+
* @public
|
|
1399
|
+
*/
|
|
1400
|
+
username: string | undefined;
|
|
1401
|
+
status: UsernameAvailability | undefined;
|
|
1402
|
+
/**
|
|
1403
|
+
* Why an `INVALID` handle cannot be used. Absent for every other status.
|
|
1404
|
+
* @public
|
|
1405
|
+
*/
|
|
1406
|
+
reason?: string | undefined;
|
|
1407
|
+
}
|
|
1372
1408
|
/**
|
|
1373
1409
|
* @public
|
|
1374
1410
|
*/
|
|
1375
1411
|
export interface CreateAdminInviteRequest {
|
|
1376
|
-
|
|
1412
|
+
/**
|
|
1413
|
+
* E.164 phone the invite is bound to. Omit for an unbound invite any phone may redeem.
|
|
1414
|
+
* @public
|
|
1415
|
+
*/
|
|
1416
|
+
phoneNumber?: string | undefined;
|
|
1377
1417
|
referrerId: string | undefined;
|
|
1378
1418
|
/**
|
|
1379
1419
|
* Optional invite lifetime in days. Defaults to 14 when omitted; bounded to 1..30.
|
|
@@ -1587,6 +1627,11 @@ export interface UserResponse {
|
|
|
1587
1627
|
googleEmail?: string | undefined;
|
|
1588
1628
|
userState?: string | undefined;
|
|
1589
1629
|
username?: string | undefined;
|
|
1630
|
+
/**
|
|
1631
|
+
* True once the member has chosen a password (SetPassword, or linking an email with one).
|
|
1632
|
+
* @public
|
|
1633
|
+
*/
|
|
1634
|
+
hasPassword?: boolean | undefined;
|
|
1590
1635
|
}
|
|
1591
1636
|
/**
|
|
1592
1637
|
* @public
|
|
@@ -1778,6 +1823,18 @@ export interface SetAccountStateResponse {
|
|
|
1778
1823
|
until?: number | undefined;
|
|
1779
1824
|
version: number | undefined;
|
|
1780
1825
|
}
|
|
1826
|
+
/**
|
|
1827
|
+
* @public
|
|
1828
|
+
*/
|
|
1829
|
+
export interface SetPasswordRequest {
|
|
1830
|
+
password: string | undefined;
|
|
1831
|
+
}
|
|
1832
|
+
/**
|
|
1833
|
+
* @public
|
|
1834
|
+
*/
|
|
1835
|
+
export interface SetPasswordResponse {
|
|
1836
|
+
status: string | undefined;
|
|
1837
|
+
}
|
|
1781
1838
|
/**
|
|
1782
1839
|
* @public
|
|
1783
1840
|
*/
|
|
@@ -2,6 +2,7 @@ import { AcceptHookRequestCommandInput, AcceptHookRequestCommandOutput } from ".
|
|
|
2
2
|
import { AuthSocialCommandInput, AuthSocialCommandOutput } from "../commands/AuthSocialCommand";
|
|
3
3
|
import { BlockUserCommandInput, BlockUserCommandOutput } from "../commands/BlockUserCommand";
|
|
4
4
|
import { CancelHookRequestCommandInput, CancelHookRequestCommandOutput } from "../commands/CancelHookRequestCommand";
|
|
5
|
+
import { CheckUsernameAvailabilityCommandInput, CheckUsernameAvailabilityCommandOutput } from "../commands/CheckUsernameAvailabilityCommand";
|
|
5
6
|
import { ClearTierOverrideCommandInput, ClearTierOverrideCommandOutput } from "../commands/ClearTierOverrideCommand";
|
|
6
7
|
import { CompleteLivenessSessionCommandInput, CompleteLivenessSessionCommandOutput } from "../commands/CompleteLivenessSessionCommand";
|
|
7
8
|
import { CompleteOnboardingCommandInput, CompleteOnboardingCommandOutput } from "../commands/CompleteOnboardingCommand";
|
|
@@ -92,6 +93,7 @@ import { SearchPlacesCommandInput, SearchPlacesCommandOutput } from "../commands
|
|
|
92
93
|
import { SendAdminLinkOtpCommandInput, SendAdminLinkOtpCommandOutput } from "../commands/SendAdminLinkOtpCommand";
|
|
93
94
|
import { SendHookRequestCommandInput, SendHookRequestCommandOutput } from "../commands/SendHookRequestCommand";
|
|
94
95
|
import { SetAccountStateCommandInput, SetAccountStateCommandOutput } from "../commands/SetAccountStateCommand";
|
|
96
|
+
import { SetPasswordCommandInput, SetPasswordCommandOutput } from "../commands/SetPasswordCommand";
|
|
95
97
|
import { SetPreservationHoldCommandInput, SetPreservationHoldCommandOutput } from "../commands/SetPreservationHoldCommand";
|
|
96
98
|
import { SetTierOverrideCommandInput, SetTierOverrideCommandOutput } from "../commands/SetTierOverrideCommand";
|
|
97
99
|
import { SimulateScoringPolicyCommandInput, SimulateScoringPolicyCommandOutput } from "../commands/SimulateScoringPolicyCommand";
|
|
@@ -205,6 +207,10 @@ export declare const se_UpdateChatSettingsCommand: (input: UpdateChatSettingsCom
|
|
|
205
207
|
* serializeAws_restJson1AuthSocialCommand
|
|
206
208
|
*/
|
|
207
209
|
export declare const se_AuthSocialCommand: (input: AuthSocialCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
210
|
+
/**
|
|
211
|
+
* serializeAws_restJson1CheckUsernameAvailabilityCommand
|
|
212
|
+
*/
|
|
213
|
+
export declare const se_CheckUsernameAvailabilityCommand: (input: CheckUsernameAvailabilityCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
208
214
|
/**
|
|
209
215
|
* serializeAws_restJson1CreateAdminInviteCommand
|
|
210
216
|
*/
|
|
@@ -281,6 +287,10 @@ export declare const se_SendAdminLinkOtpCommand: (input: SendAdminLinkOtpCommand
|
|
|
281
287
|
* serializeAws_restJson1SetAccountStateCommand
|
|
282
288
|
*/
|
|
283
289
|
export declare const se_SetAccountStateCommand: (input: SetAccountStateCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
290
|
+
/**
|
|
291
|
+
* serializeAws_restJson1SetPasswordCommand
|
|
292
|
+
*/
|
|
293
|
+
export declare const se_SetPasswordCommand: (input: SetPasswordCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
284
294
|
/**
|
|
285
295
|
* serializeAws_restJson1SetPreservationHoldCommand
|
|
286
296
|
*/
|
|
@@ -657,6 +667,10 @@ export declare const de_UpdateChatSettingsCommand: (output: __HttpResponse, cont
|
|
|
657
667
|
* deserializeAws_restJson1AuthSocialCommand
|
|
658
668
|
*/
|
|
659
669
|
export declare const de_AuthSocialCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<AuthSocialCommandOutput>;
|
|
670
|
+
/**
|
|
671
|
+
* deserializeAws_restJson1CheckUsernameAvailabilityCommand
|
|
672
|
+
*/
|
|
673
|
+
export declare const de_CheckUsernameAvailabilityCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<CheckUsernameAvailabilityCommandOutput>;
|
|
660
674
|
/**
|
|
661
675
|
* deserializeAws_restJson1CreateAdminInviteCommand
|
|
662
676
|
*/
|
|
@@ -733,6 +747,10 @@ export declare const de_SendAdminLinkOtpCommand: (output: __HttpResponse, contex
|
|
|
733
747
|
* deserializeAws_restJson1SetAccountStateCommand
|
|
734
748
|
*/
|
|
735
749
|
export declare const de_SetAccountStateCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<SetAccountStateCommandOutput>;
|
|
750
|
+
/**
|
|
751
|
+
* deserializeAws_restJson1SetPasswordCommand
|
|
752
|
+
*/
|
|
753
|
+
export declare const de_SetPasswordCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<SetPasswordCommandOutput>;
|
|
736
754
|
/**
|
|
737
755
|
* deserializeAws_restJson1SetPreservationHoldCommand
|
|
738
756
|
*/
|