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.
- package/README.md +28 -0
- package/dist-cjs/OneHook.js +8 -0
- package/dist-cjs/commands/CreateAdminInviteCommand.js +21 -0
- package/dist-cjs/commands/GetAdminPhoneStatusCommand.js +21 -0
- package/dist-cjs/commands/SendAdminLinkOtpCommand.js +21 -0
- package/dist-cjs/commands/VerifyAdminLinkOtpCommand.js +21 -0
- package/dist-cjs/commands/index.js +4 -0
- package/dist-cjs/protocols/Aws_restJson1.js +131 -3
- package/dist-cjs/telemetry/index.js +36 -2
- package/dist-es/OneHook.js +8 -0
- package/dist-es/commands/CreateAdminInviteCommand.js +17 -0
- package/dist-es/commands/GetAdminPhoneStatusCommand.js +17 -0
- package/dist-es/commands/SendAdminLinkOtpCommand.js +17 -0
- package/dist-es/commands/VerifyAdminLinkOtpCommand.js +17 -0
- package/dist-es/commands/index.js +4 -0
- package/dist-es/protocols/Aws_restJson1.js +120 -0
- package/dist-es/telemetry/index.js +36 -2
- package/dist-types/OneHook.d.ts +28 -0
- package/dist-types/OneHookClient.d.ts +6 -2
- package/dist-types/commands/CreateAdminInviteCommand.d.ts +87 -0
- package/dist-types/commands/GetAdminPhoneStatusCommand.d.ts +86 -0
- package/dist-types/commands/SendAdminLinkOtpCommand.d.ts +83 -0
- package/dist-types/commands/VerifyAdminLinkOtpCommand.d.ts +84 -0
- package/dist-types/commands/index.d.ts +4 -0
- package/dist-types/models/models_0.d.ts +69 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +36 -0
- package/dist-types/telemetry/index.d.ts +21 -2
- package/package.json +1 -1
- package/telemetry/TelemetryCatalog.kt +21 -4
- package/telemetry/TelemetryCatalog.swift +36 -4
- package/telemetry/telemetry-catalog.json +250 -3
|
@@ -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";
|
|
@@ -194,6 +194,23 @@ export const se_AuthSocialCommand = async (input, context) => {
|
|
|
194
194
|
.b(body);
|
|
195
195
|
return b.build();
|
|
196
196
|
};
|
|
197
|
+
export const se_CreateAdminInviteCommand = async (input, context) => {
|
|
198
|
+
const b = rb(input, context);
|
|
199
|
+
const headers = {
|
|
200
|
+
'content-type': 'application/json',
|
|
201
|
+
};
|
|
202
|
+
b.bp("/identity/admin/invites");
|
|
203
|
+
let body;
|
|
204
|
+
body = JSON.stringify(take(input, {
|
|
205
|
+
'phoneNumber': [],
|
|
206
|
+
'referrerId': [],
|
|
207
|
+
'ttlDays': [],
|
|
208
|
+
}));
|
|
209
|
+
b.m("POST")
|
|
210
|
+
.h(headers)
|
|
211
|
+
.b(body);
|
|
212
|
+
return b.build();
|
|
213
|
+
};
|
|
197
214
|
export const se_GenerateInviteCommand = async (input, context) => {
|
|
198
215
|
const b = rb(input, context);
|
|
199
216
|
const headers = {
|
|
@@ -210,6 +227,21 @@ export const se_GenerateInviteCommand = async (input, context) => {
|
|
|
210
227
|
.b(body);
|
|
211
228
|
return b.build();
|
|
212
229
|
};
|
|
230
|
+
export const se_GetAdminPhoneStatusCommand = async (input, context) => {
|
|
231
|
+
const b = rb(input, context);
|
|
232
|
+
const headers = {
|
|
233
|
+
'content-type': 'application/json',
|
|
234
|
+
};
|
|
235
|
+
b.bp("/identity/admin/phone-status");
|
|
236
|
+
let body;
|
|
237
|
+
body = JSON.stringify(take(input, {
|
|
238
|
+
'phoneNumber': [],
|
|
239
|
+
}));
|
|
240
|
+
b.m("POST")
|
|
241
|
+
.h(headers)
|
|
242
|
+
.b(body);
|
|
243
|
+
return b.build();
|
|
244
|
+
};
|
|
213
245
|
export const se_GetCredentialReadinessCommand = async (input, context) => {
|
|
214
246
|
const b = rb(input, context);
|
|
215
247
|
const headers = {};
|
|
@@ -351,6 +383,17 @@ export const se_RequestPhoneUpdateOtpCommand = async (input, context) => {
|
|
|
351
383
|
.b(body);
|
|
352
384
|
return b.build();
|
|
353
385
|
};
|
|
386
|
+
export const se_SendAdminLinkOtpCommand = async (input, context) => {
|
|
387
|
+
const b = rb(input, context);
|
|
388
|
+
const headers = {};
|
|
389
|
+
b.bp("/identity/users/{userId}/admin-link-otp");
|
|
390
|
+
b.p('userId', () => input.userId, '{userId}', false);
|
|
391
|
+
let body;
|
|
392
|
+
b.m("POST")
|
|
393
|
+
.h(headers)
|
|
394
|
+
.b(body);
|
|
395
|
+
return b.build();
|
|
396
|
+
};
|
|
354
397
|
export const se_UnlinkSocialCommand = async (input, context) => {
|
|
355
398
|
const b = rb(input, context);
|
|
356
399
|
const headers = {};
|
|
@@ -423,6 +466,22 @@ export const se_ValidateInviteCommand = async (input, context) => {
|
|
|
423
466
|
.b(body);
|
|
424
467
|
return b.build();
|
|
425
468
|
};
|
|
469
|
+
export const se_VerifyAdminLinkOtpCommand = async (input, context) => {
|
|
470
|
+
const b = rb(input, context);
|
|
471
|
+
const headers = {
|
|
472
|
+
'content-type': 'application/json',
|
|
473
|
+
};
|
|
474
|
+
b.bp("/identity/users/{userId}/admin-link-otp/verify");
|
|
475
|
+
b.p('userId', () => input.userId, '{userId}', false);
|
|
476
|
+
let body;
|
|
477
|
+
body = JSON.stringify(take(input, {
|
|
478
|
+
'code': [],
|
|
479
|
+
}));
|
|
480
|
+
b.m("POST")
|
|
481
|
+
.h(headers)
|
|
482
|
+
.b(body);
|
|
483
|
+
return b.build();
|
|
484
|
+
};
|
|
426
485
|
export const se_DiscoverCommand = async (input, context) => {
|
|
427
486
|
const b = rb(input, context);
|
|
428
487
|
const headers = {};
|
|
@@ -1007,6 +1066,22 @@ export const de_AuthSocialCommand = async (output, context) => {
|
|
|
1007
1066
|
Object.assign(contents, doc);
|
|
1008
1067
|
return contents;
|
|
1009
1068
|
};
|
|
1069
|
+
export const de_CreateAdminInviteCommand = async (output, context) => {
|
|
1070
|
+
if (output.statusCode !== 200 && output.statusCode >= 300) {
|
|
1071
|
+
return de_CommandError(output, context);
|
|
1072
|
+
}
|
|
1073
|
+
const contents = map({
|
|
1074
|
+
$metadata: deserializeMetadata(output),
|
|
1075
|
+
});
|
|
1076
|
+
const data = __expectNonNull((__expectObject(await parseBody(output.body, context))), "body");
|
|
1077
|
+
const doc = take(data, {
|
|
1078
|
+
'expiresAt': __expectLong,
|
|
1079
|
+
'inviteCode': __expectString,
|
|
1080
|
+
'maxUses': __expectInt32,
|
|
1081
|
+
});
|
|
1082
|
+
Object.assign(contents, doc);
|
|
1083
|
+
return contents;
|
|
1084
|
+
};
|
|
1010
1085
|
export const de_GenerateInviteCommand = async (output, context) => {
|
|
1011
1086
|
if (output.statusCode !== 200 && output.statusCode >= 300) {
|
|
1012
1087
|
return de_CommandError(output, context);
|
|
@@ -1023,6 +1098,20 @@ export const de_GenerateInviteCommand = async (output, context) => {
|
|
|
1023
1098
|
Object.assign(contents, doc);
|
|
1024
1099
|
return contents;
|
|
1025
1100
|
};
|
|
1101
|
+
export const de_GetAdminPhoneStatusCommand = async (output, context) => {
|
|
1102
|
+
if (output.statusCode !== 200 && output.statusCode >= 300) {
|
|
1103
|
+
return de_CommandError(output, context);
|
|
1104
|
+
}
|
|
1105
|
+
const contents = map({
|
|
1106
|
+
$metadata: deserializeMetadata(output),
|
|
1107
|
+
});
|
|
1108
|
+
const data = __expectNonNull((__expectObject(await parseBody(output.body, context))), "body");
|
|
1109
|
+
const doc = take(data, {
|
|
1110
|
+
'registered': __expectBoolean,
|
|
1111
|
+
});
|
|
1112
|
+
Object.assign(contents, doc);
|
|
1113
|
+
return contents;
|
|
1114
|
+
};
|
|
1026
1115
|
export const de_GetCredentialReadinessCommand = async (output, context) => {
|
|
1027
1116
|
if (output.statusCode !== 200 && output.statusCode >= 300) {
|
|
1028
1117
|
return de_CommandError(output, context);
|
|
@@ -1183,6 +1272,21 @@ export const de_RequestPhoneUpdateOtpCommand = async (output, context) => {
|
|
|
1183
1272
|
Object.assign(contents, doc);
|
|
1184
1273
|
return contents;
|
|
1185
1274
|
};
|
|
1275
|
+
export const de_SendAdminLinkOtpCommand = async (output, context) => {
|
|
1276
|
+
if (output.statusCode !== 200 && output.statusCode >= 300) {
|
|
1277
|
+
return de_CommandError(output, context);
|
|
1278
|
+
}
|
|
1279
|
+
const contents = map({
|
|
1280
|
+
$metadata: deserializeMetadata(output),
|
|
1281
|
+
});
|
|
1282
|
+
const data = __expectNonNull((__expectObject(await parseBody(output.body, context))), "body");
|
|
1283
|
+
const doc = take(data, {
|
|
1284
|
+
'maskedPhone': __expectString,
|
|
1285
|
+
'status': __expectString,
|
|
1286
|
+
});
|
|
1287
|
+
Object.assign(contents, doc);
|
|
1288
|
+
return contents;
|
|
1289
|
+
};
|
|
1186
1290
|
export const de_UnlinkSocialCommand = async (output, context) => {
|
|
1187
1291
|
if (output.statusCode !== 200 && output.statusCode >= 300) {
|
|
1188
1292
|
return de_CommandError(output, context);
|
|
@@ -1259,6 +1363,22 @@ export const de_ValidateInviteCommand = async (output, context) => {
|
|
|
1259
1363
|
Object.assign(contents, doc);
|
|
1260
1364
|
return contents;
|
|
1261
1365
|
};
|
|
1366
|
+
export const de_VerifyAdminLinkOtpCommand = async (output, context) => {
|
|
1367
|
+
if (output.statusCode !== 200 && output.statusCode >= 300) {
|
|
1368
|
+
return de_CommandError(output, context);
|
|
1369
|
+
}
|
|
1370
|
+
const contents = map({
|
|
1371
|
+
$metadata: deserializeMetadata(output),
|
|
1372
|
+
});
|
|
1373
|
+
const data = __expectNonNull((__expectObject(await parseBody(output.body, context))), "body");
|
|
1374
|
+
const doc = take(data, {
|
|
1375
|
+
'userId': __expectString,
|
|
1376
|
+
'username': __expectString,
|
|
1377
|
+
'verified': __expectBoolean,
|
|
1378
|
+
});
|
|
1379
|
+
Object.assign(contents, doc);
|
|
1380
|
+
return contents;
|
|
1381
|
+
};
|
|
1262
1382
|
export const de_DiscoverCommand = async (output, context) => {
|
|
1263
1383
|
if (output.statusCode !== 200 && output.statusCode >= 300) {
|
|
1264
1384
|
return de_CommandError(output, context);
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
export const TELEMETRY_CATALOG_VERSION = "1.
|
|
2
|
-
export const TELEMETRY_CATALOG_HASH = "
|
|
1
|
+
export const TELEMETRY_CATALOG_VERSION = "1.4.0";
|
|
2
|
+
export const TELEMETRY_CATALOG_HASH = "5cf9f7740c92eebe";
|
|
3
3
|
export const SignalType = {
|
|
4
4
|
SCREEN_VIEW: "screen_view",
|
|
5
5
|
UI_INTERACTION: "ui_interaction",
|
|
@@ -30,6 +30,8 @@ export const Screen = {
|
|
|
30
30
|
LANDING: "LANDING",
|
|
31
31
|
LOGIN: "LOGIN",
|
|
32
32
|
REDEEM_INVITE: "REDEEM_INVITE",
|
|
33
|
+
ADMISSIONS: "ADMISSIONS",
|
|
34
|
+
ADMISSIONS_STATUS: "ADMISSIONS_STATUS",
|
|
33
35
|
ONBOARDING: "ONBOARDING",
|
|
34
36
|
DISCOVER: "DISCOVER",
|
|
35
37
|
LIKE_COMPOSER: "LIKE_COMPOSER",
|
|
@@ -54,6 +56,8 @@ export const ViewableScreen = {
|
|
|
54
56
|
LANDING: "LANDING",
|
|
55
57
|
LOGIN: "LOGIN",
|
|
56
58
|
REDEEM_INVITE: "REDEEM_INVITE",
|
|
59
|
+
ADMISSIONS: "ADMISSIONS",
|
|
60
|
+
ADMISSIONS_STATUS: "ADMISSIONS_STATUS",
|
|
57
61
|
ONBOARDING: "ONBOARDING",
|
|
58
62
|
DISCOVER: "DISCOVER",
|
|
59
63
|
LIKE_COMPOSER: "LIKE_COMPOSER",
|
|
@@ -188,6 +192,21 @@ export const UiElement = {
|
|
|
188
192
|
REDEEM_INVITE_LOGIN: "redeem_invite.login",
|
|
189
193
|
REDEEM_INVITE_CLOSE: "redeem_invite.close",
|
|
190
194
|
REDEEM_INVITE_RESEND_CODE: "redeem_invite.resend_code",
|
|
195
|
+
REDEEM_INVITE_GET_INVITE_VIDEO: "redeem_invite.get_invite_video",
|
|
196
|
+
ADMISSIONS_SUBMIT: "admissions.submit",
|
|
197
|
+
ADMISSIONS_RESEND_CODE: "admissions.resend_code",
|
|
198
|
+
ADMISSIONS_CONSENT_TOGGLE: "admissions.consent_toggle",
|
|
199
|
+
ADMISSIONS_PRIVACY_POLICY: "admissions.privacy_policy",
|
|
200
|
+
ADMISSIONS_RECORD_START: "admissions.record_start",
|
|
201
|
+
ADMISSIONS_RECORD_STOP: "admissions.record_stop",
|
|
202
|
+
ADMISSIONS_RETAKE: "admissions.retake",
|
|
203
|
+
ADMISSIONS_PREVIEW_PLAY: "admissions.preview_play",
|
|
204
|
+
ADMISSIONS_UPLOAD_RETRY: "admissions.upload_retry",
|
|
205
|
+
ADMISSIONS_CLOSE: "admissions.close",
|
|
206
|
+
ADMISSIONS_OPEN_SETTINGS: "admissions.open_settings",
|
|
207
|
+
ADMISSIONS_STATUS_REFRESH: "admissions_status.refresh",
|
|
208
|
+
ADMISSIONS_STATUS_CONTINUE_INVITE: "admissions_status.continue_invite",
|
|
209
|
+
ADMISSIONS_STATUS_WITHDRAW: "admissions_status.withdraw",
|
|
191
210
|
ONBOARDING_NEXT: "onboarding.next",
|
|
192
211
|
ONBOARDING_BACK: "onboarding.back",
|
|
193
212
|
ONBOARDING_FINISH: "onboarding.finish",
|
|
@@ -413,6 +432,21 @@ export const UI_ELEMENTS = {
|
|
|
413
432
|
"redeem_invite.login": { screen: "REDEEM_INVITE", kind: "link", actions: ["tap"], values: null, platforms: ["web", "ios", "android"] },
|
|
414
433
|
"redeem_invite.close": { screen: "REDEEM_INVITE", kind: "button", actions: ["tap"], values: null, platforms: ["ios", "android"] },
|
|
415
434
|
"redeem_invite.resend_code": { screen: "REDEEM_INVITE", kind: "link", actions: ["tap"], values: null, platforms: ["web", "ios"] },
|
|
435
|
+
"redeem_invite.get_invite_video": { screen: "REDEEM_INVITE", kind: "button", actions: ["tap"], values: null, platforms: ["ios", "android"] },
|
|
436
|
+
"admissions.submit": { screen: "ADMISSIONS", kind: "button", actions: ["submit"], values: ["send_code", "verify_code", "submit_application"], platforms: ["ios", "android"] },
|
|
437
|
+
"admissions.resend_code": { screen: "ADMISSIONS", kind: "link", actions: ["tap"], values: null, platforms: ["ios", "android"] },
|
|
438
|
+
"admissions.consent_toggle": { screen: "ADMISSIONS", kind: "toggle", actions: ["toggle"], values: ["checked", "unchecked"], platforms: ["ios", "android"] },
|
|
439
|
+
"admissions.privacy_policy": { screen: "ADMISSIONS", kind: "link", actions: ["tap"], values: null, platforms: ["ios", "android"] },
|
|
440
|
+
"admissions.record_start": { screen: "ADMISSIONS", kind: "button", actions: ["tap"], values: null, platforms: ["ios", "android"] },
|
|
441
|
+
"admissions.record_stop": { screen: "ADMISSIONS", kind: "button", actions: ["tap"], values: null, platforms: ["ios", "android"] },
|
|
442
|
+
"admissions.retake": { screen: "ADMISSIONS", kind: "button", actions: ["tap"], values: null, platforms: ["ios", "android"] },
|
|
443
|
+
"admissions.preview_play": { screen: "ADMISSIONS", kind: "toggle", actions: ["toggle"], values: ["play", "pause"], platforms: ["ios", "android"] },
|
|
444
|
+
"admissions.upload_retry": { screen: "ADMISSIONS", kind: "button", actions: ["tap"], values: null, platforms: ["ios", "android"] },
|
|
445
|
+
"admissions.close": { screen: "ADMISSIONS", kind: "button", actions: ["tap"], values: null, platforms: ["ios", "android"] },
|
|
446
|
+
"admissions.open_settings": { screen: "ADMISSIONS", kind: "button", actions: ["tap"], values: null, platforms: ["ios", "android"] },
|
|
447
|
+
"admissions_status.refresh": { screen: "ADMISSIONS_STATUS", kind: "button", actions: ["tap"], values: null, platforms: ["ios", "android"] },
|
|
448
|
+
"admissions_status.continue_invite": { screen: "ADMISSIONS_STATUS", kind: "button", actions: ["tap"], values: null, platforms: ["ios", "android"] },
|
|
449
|
+
"admissions_status.withdraw": { screen: "ADMISSIONS_STATUS", kind: "button", actions: ["tap"], values: null, platforms: ["ios", "android"] },
|
|
416
450
|
"onboarding.next": { screen: "ONBOARDING", kind: "button", actions: ["submit"], values: ["basics", "photos", "media", "prompts", "details"], platforms: ["web", "ios"] },
|
|
417
451
|
"onboarding.back": { screen: "ONBOARDING", kind: "button", actions: ["tap"], values: null, platforms: ["web", "ios"] },
|
|
418
452
|
"onboarding.finish": { screen: "ONBOARDING", kind: "button", actions: ["submit"], values: null, platforms: ["web", "ios", "android"] },
|
package/dist-types/OneHook.d.ts
CHANGED
|
@@ -2,6 +2,7 @@ import { OneHookClient } from "./OneHookClient";
|
|
|
2
2
|
import { AuthSocialCommandInput, AuthSocialCommandOutput } from "./commands/AuthSocialCommand";
|
|
3
3
|
import { CompleteLivenessSessionCommandInput, CompleteLivenessSessionCommandOutput } from "./commands/CompleteLivenessSessionCommand";
|
|
4
4
|
import { CompleteOnboardingCommandInput, CompleteOnboardingCommandOutput } from "./commands/CompleteOnboardingCommand";
|
|
5
|
+
import { CreateAdminInviteCommandInput, CreateAdminInviteCommandOutput } from "./commands/CreateAdminInviteCommand";
|
|
5
6
|
import { CreateLivenessSessionCommandInput, CreateLivenessSessionCommandOutput } from "./commands/CreateLivenessSessionCommand";
|
|
6
7
|
import { CreateMediaDownloadUrlCommandInput, CreateMediaDownloadUrlCommandOutput } from "./commands/CreateMediaDownloadUrlCommand";
|
|
7
8
|
import { CreateMediaUploadUrlCommandInput, CreateMediaUploadUrlCommandOutput } from "./commands/CreateMediaUploadUrlCommand";
|
|
@@ -12,6 +13,7 @@ import { DiscoverCommandInput, DiscoverCommandOutput } from "./commands/Discover
|
|
|
12
13
|
import { GenerateDownloadUrlCommandInput, GenerateDownloadUrlCommandOutput } from "./commands/GenerateDownloadUrlCommand";
|
|
13
14
|
import { GenerateInviteCommandInput, GenerateInviteCommandOutput } from "./commands/GenerateInviteCommand";
|
|
14
15
|
import { GenerateUploadUrlCommandInput, GenerateUploadUrlCommandOutput } from "./commands/GenerateUploadUrlCommand";
|
|
16
|
+
import { GetAdminPhoneStatusCommandInput, GetAdminPhoneStatusCommandOutput } from "./commands/GetAdminPhoneStatusCommand";
|
|
15
17
|
import { GetAiContextMatchCommandInput, GetAiContextMatchCommandOutput } from "./commands/GetAiContextMatchCommand";
|
|
16
18
|
import { GetChatSettingsCommandInput, GetChatSettingsCommandOutput } from "./commands/GetChatSettingsCommand";
|
|
17
19
|
import { GetCredentialReadinessCommandInput, GetCredentialReadinessCommandOutput } from "./commands/GetCredentialReadinessCommand";
|
|
@@ -41,6 +43,7 @@ import { RequestEmailOtpCommandInput, RequestEmailOtpCommandOutput } from "./com
|
|
|
41
43
|
import { RequestPhoneOtpCommandInput, RequestPhoneOtpCommandOutput } from "./commands/RequestPhoneOtpCommand";
|
|
42
44
|
import { RequestPhoneUpdateOtpCommandInput, RequestPhoneUpdateOtpCommandOutput } from "./commands/RequestPhoneUpdateOtpCommand";
|
|
43
45
|
import { RevokeDeviceCommandInput, RevokeDeviceCommandOutput } from "./commands/RevokeDeviceCommand";
|
|
46
|
+
import { SendAdminLinkOtpCommandInput, SendAdminLinkOtpCommandOutput } from "./commands/SendAdminLinkOtpCommand";
|
|
44
47
|
import { SwipeByUsernameCommandInput, SwipeByUsernameCommandOutput } from "./commands/SwipeByUsernameCommand";
|
|
45
48
|
import { SwipeCommandInput, SwipeCommandOutput } from "./commands/SwipeCommand";
|
|
46
49
|
import { UnhookCommandInput, UnhookCommandOutput } from "./commands/UnhookCommand";
|
|
@@ -53,6 +56,7 @@ import { UpdateProfileCommandInput, UpdateProfileCommandOutput } from "./command
|
|
|
53
56
|
import { UpdateUsernameCommandInput, UpdateUsernameCommandOutput } from "./commands/UpdateUsernameCommand";
|
|
54
57
|
import { UpgradeUserCommandInput, UpgradeUserCommandOutput } from "./commands/UpgradeUserCommand";
|
|
55
58
|
import { ValidateInviteCommandInput, ValidateInviteCommandOutput } from "./commands/ValidateInviteCommand";
|
|
59
|
+
import { VerifyAdminLinkOtpCommandInput, VerifyAdminLinkOtpCommandOutput } from "./commands/VerifyAdminLinkOtpCommand";
|
|
56
60
|
import { HttpHandlerOptions as __HttpHandlerOptions } from "@smithy/types";
|
|
57
61
|
export interface OneHook {
|
|
58
62
|
/**
|
|
@@ -136,12 +140,24 @@ export interface OneHook {
|
|
|
136
140
|
authSocial(args: AuthSocialCommandInput, options?: __HttpHandlerOptions): Promise<AuthSocialCommandOutput>;
|
|
137
141
|
authSocial(args: AuthSocialCommandInput, cb: (err: any, data?: AuthSocialCommandOutput) => void): void;
|
|
138
142
|
authSocial(args: AuthSocialCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: AuthSocialCommandOutput) => void): void;
|
|
143
|
+
/**
|
|
144
|
+
* @see {@link CreateAdminInviteCommand}
|
|
145
|
+
*/
|
|
146
|
+
createAdminInvite(args: CreateAdminInviteCommandInput, options?: __HttpHandlerOptions): Promise<CreateAdminInviteCommandOutput>;
|
|
147
|
+
createAdminInvite(args: CreateAdminInviteCommandInput, cb: (err: any, data?: CreateAdminInviteCommandOutput) => void): void;
|
|
148
|
+
createAdminInvite(args: CreateAdminInviteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateAdminInviteCommandOutput) => void): void;
|
|
139
149
|
/**
|
|
140
150
|
* @see {@link GenerateInviteCommand}
|
|
141
151
|
*/
|
|
142
152
|
generateInvite(args: GenerateInviteCommandInput, options?: __HttpHandlerOptions): Promise<GenerateInviteCommandOutput>;
|
|
143
153
|
generateInvite(args: GenerateInviteCommandInput, cb: (err: any, data?: GenerateInviteCommandOutput) => void): void;
|
|
144
154
|
generateInvite(args: GenerateInviteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GenerateInviteCommandOutput) => void): void;
|
|
155
|
+
/**
|
|
156
|
+
* @see {@link GetAdminPhoneStatusCommand}
|
|
157
|
+
*/
|
|
158
|
+
getAdminPhoneStatus(args: GetAdminPhoneStatusCommandInput, options?: __HttpHandlerOptions): Promise<GetAdminPhoneStatusCommandOutput>;
|
|
159
|
+
getAdminPhoneStatus(args: GetAdminPhoneStatusCommandInput, cb: (err: any, data?: GetAdminPhoneStatusCommandOutput) => void): void;
|
|
160
|
+
getAdminPhoneStatus(args: GetAdminPhoneStatusCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetAdminPhoneStatusCommandOutput) => void): void;
|
|
145
161
|
/**
|
|
146
162
|
* @see {@link GetCredentialReadinessCommand}
|
|
147
163
|
*/
|
|
@@ -202,6 +218,12 @@ export interface OneHook {
|
|
|
202
218
|
requestPhoneUpdateOtp(args: RequestPhoneUpdateOtpCommandInput, options?: __HttpHandlerOptions): Promise<RequestPhoneUpdateOtpCommandOutput>;
|
|
203
219
|
requestPhoneUpdateOtp(args: RequestPhoneUpdateOtpCommandInput, cb: (err: any, data?: RequestPhoneUpdateOtpCommandOutput) => void): void;
|
|
204
220
|
requestPhoneUpdateOtp(args: RequestPhoneUpdateOtpCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: RequestPhoneUpdateOtpCommandOutput) => void): void;
|
|
221
|
+
/**
|
|
222
|
+
* @see {@link SendAdminLinkOtpCommand}
|
|
223
|
+
*/
|
|
224
|
+
sendAdminLinkOtp(args: SendAdminLinkOtpCommandInput, options?: __HttpHandlerOptions): Promise<SendAdminLinkOtpCommandOutput>;
|
|
225
|
+
sendAdminLinkOtp(args: SendAdminLinkOtpCommandInput, cb: (err: any, data?: SendAdminLinkOtpCommandOutput) => void): void;
|
|
226
|
+
sendAdminLinkOtp(args: SendAdminLinkOtpCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: SendAdminLinkOtpCommandOutput) => void): void;
|
|
205
227
|
/**
|
|
206
228
|
* @see {@link UnlinkSocialCommand}
|
|
207
229
|
*/
|
|
@@ -232,6 +254,12 @@ export interface OneHook {
|
|
|
232
254
|
validateInvite(args: ValidateInviteCommandInput, options?: __HttpHandlerOptions): Promise<ValidateInviteCommandOutput>;
|
|
233
255
|
validateInvite(args: ValidateInviteCommandInput, cb: (err: any, data?: ValidateInviteCommandOutput) => void): void;
|
|
234
256
|
validateInvite(args: ValidateInviteCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ValidateInviteCommandOutput) => void): void;
|
|
257
|
+
/**
|
|
258
|
+
* @see {@link VerifyAdminLinkOtpCommand}
|
|
259
|
+
*/
|
|
260
|
+
verifyAdminLinkOtp(args: VerifyAdminLinkOtpCommandInput, options?: __HttpHandlerOptions): Promise<VerifyAdminLinkOtpCommandOutput>;
|
|
261
|
+
verifyAdminLinkOtp(args: VerifyAdminLinkOtpCommandInput, cb: (err: any, data?: VerifyAdminLinkOtpCommandOutput) => void): void;
|
|
262
|
+
verifyAdminLinkOtp(args: VerifyAdminLinkOtpCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: VerifyAdminLinkOtpCommandOutput) => void): void;
|
|
235
263
|
/**
|
|
236
264
|
* @see {@link DiscoverCommand}
|
|
237
265
|
*/
|
|
@@ -2,6 +2,7 @@ import { HttpAuthSchemeInputConfig, HttpAuthSchemeResolvedConfig } from "./auth/
|
|
|
2
2
|
import { AuthSocialCommandInput, AuthSocialCommandOutput } from "./commands/AuthSocialCommand";
|
|
3
3
|
import { CompleteLivenessSessionCommandInput, CompleteLivenessSessionCommandOutput } from "./commands/CompleteLivenessSessionCommand";
|
|
4
4
|
import { CompleteOnboardingCommandInput, CompleteOnboardingCommandOutput } from "./commands/CompleteOnboardingCommand";
|
|
5
|
+
import { CreateAdminInviteCommandInput, CreateAdminInviteCommandOutput } from "./commands/CreateAdminInviteCommand";
|
|
5
6
|
import { CreateLivenessSessionCommandInput, CreateLivenessSessionCommandOutput } from "./commands/CreateLivenessSessionCommand";
|
|
6
7
|
import { CreateMediaDownloadUrlCommandInput, CreateMediaDownloadUrlCommandOutput } from "./commands/CreateMediaDownloadUrlCommand";
|
|
7
8
|
import { CreateMediaUploadUrlCommandInput, CreateMediaUploadUrlCommandOutput } from "./commands/CreateMediaUploadUrlCommand";
|
|
@@ -12,6 +13,7 @@ import { DiscoverCommandInput, DiscoverCommandOutput } from "./commands/Discover
|
|
|
12
13
|
import { GenerateDownloadUrlCommandInput, GenerateDownloadUrlCommandOutput } from "./commands/GenerateDownloadUrlCommand";
|
|
13
14
|
import { GenerateInviteCommandInput, GenerateInviteCommandOutput } from "./commands/GenerateInviteCommand";
|
|
14
15
|
import { GenerateUploadUrlCommandInput, GenerateUploadUrlCommandOutput } from "./commands/GenerateUploadUrlCommand";
|
|
16
|
+
import { GetAdminPhoneStatusCommandInput, GetAdminPhoneStatusCommandOutput } from "./commands/GetAdminPhoneStatusCommand";
|
|
15
17
|
import { GetAiContextMatchCommandInput, GetAiContextMatchCommandOutput } from "./commands/GetAiContextMatchCommand";
|
|
16
18
|
import { GetChatSettingsCommandInput, GetChatSettingsCommandOutput } from "./commands/GetChatSettingsCommand";
|
|
17
19
|
import { GetCredentialReadinessCommandInput, GetCredentialReadinessCommandOutput } from "./commands/GetCredentialReadinessCommand";
|
|
@@ -41,6 +43,7 @@ import { RequestEmailOtpCommandInput, RequestEmailOtpCommandOutput } from "./com
|
|
|
41
43
|
import { RequestPhoneOtpCommandInput, RequestPhoneOtpCommandOutput } from "./commands/RequestPhoneOtpCommand";
|
|
42
44
|
import { RequestPhoneUpdateOtpCommandInput, RequestPhoneUpdateOtpCommandOutput } from "./commands/RequestPhoneUpdateOtpCommand";
|
|
43
45
|
import { RevokeDeviceCommandInput, RevokeDeviceCommandOutput } from "./commands/RevokeDeviceCommand";
|
|
46
|
+
import { SendAdminLinkOtpCommandInput, SendAdminLinkOtpCommandOutput } from "./commands/SendAdminLinkOtpCommand";
|
|
44
47
|
import { SwipeByUsernameCommandInput, SwipeByUsernameCommandOutput } from "./commands/SwipeByUsernameCommand";
|
|
45
48
|
import { SwipeCommandInput, SwipeCommandOutput } from "./commands/SwipeCommand";
|
|
46
49
|
import { UnhookCommandInput, UnhookCommandOutput } from "./commands/UnhookCommand";
|
|
@@ -53,6 +56,7 @@ import { UpdateProfileCommandInput, UpdateProfileCommandOutput } from "./command
|
|
|
53
56
|
import { UpdateUsernameCommandInput, UpdateUsernameCommandOutput } from "./commands/UpdateUsernameCommand";
|
|
54
57
|
import { UpgradeUserCommandInput, UpgradeUserCommandOutput } from "./commands/UpgradeUserCommand";
|
|
55
58
|
import { ValidateInviteCommandInput, ValidateInviteCommandOutput } from "./commands/ValidateInviteCommand";
|
|
59
|
+
import { VerifyAdminLinkOtpCommandInput, VerifyAdminLinkOtpCommandOutput } from "./commands/VerifyAdminLinkOtpCommand";
|
|
56
60
|
import { RuntimeExtension, RuntimeExtensionsConfig } from "./runtimeExtensions";
|
|
57
61
|
import { HostHeaderInputConfig, HostHeaderResolvedConfig } from "@aws-sdk/middleware-host-header";
|
|
58
62
|
import { UserAgentInputConfig, UserAgentResolvedConfig } from "@aws-sdk/middleware-user-agent";
|
|
@@ -65,11 +69,11 @@ export { __Client };
|
|
|
65
69
|
/**
|
|
66
70
|
* @public
|
|
67
71
|
*/
|
|
68
|
-
export type ServiceInputTypes = AuthSocialCommandInput | CompleteLivenessSessionCommandInput | CompleteOnboardingCommandInput | CreateLivenessSessionCommandInput | CreateMediaDownloadUrlCommandInput | CreateMediaUploadUrlCommandInput | DeleteMatchMessagesCommandInput | DeleteProfileCommandInput | DeletePushTokenCommandInput | DiscoverCommandInput | GenerateDownloadUrlCommandInput | GenerateInviteCommandInput | GenerateUploadUrlCommandInput | GetAiContextMatchCommandInput | GetChatSettingsCommandInput | GetCredentialReadinessCommandInput | GetLivenessStatusCommandInput | GetMatchCommandInput | GetMyProfileCommandInput | GetNotificationPreferencesCommandInput | GetParticipantRegistryCommandInput | GetPreferencesCommandInput | GetProfileCommandInput | GetReceivedLikesCommandInput | GetRosesCommandInput | GetStateCommandInput | GetUserByEmailCommandInput | GetUserCommandInput | GetUserIdByUsernameCommandInput | IndexLocationCommandInput | InitUserCommandInput | LinkEmailCommandInput | LinkSocialCommandInput | ListMyDevicesCommandInput | RegisterDeviceCommandInput | RegisterPhoneCommandInput | RegisterPushTokenCommandInput | RemoveLocationCommandInput | RequestEmailOtpCommandInput | RequestPhoneOtpCommandInput | RequestPhoneUpdateOtpCommandInput | RevokeDeviceCommandInput | SwipeByUsernameCommandInput | SwipeCommandInput | UnhookCommandInput | UnlinkSocialCommandInput | UpdateChatSettingsCommandInput | UpdateEntitlementsCommandInput | UpdatePhoneNumberCommandInput | UpdatePreferencesCommandInput | UpdateProfileCommandInput | UpdateUsernameCommandInput | UpgradeUserCommandInput | ValidateInviteCommandInput;
|
|
72
|
+
export type ServiceInputTypes = AuthSocialCommandInput | CompleteLivenessSessionCommandInput | CompleteOnboardingCommandInput | CreateAdminInviteCommandInput | CreateLivenessSessionCommandInput | CreateMediaDownloadUrlCommandInput | CreateMediaUploadUrlCommandInput | DeleteMatchMessagesCommandInput | DeleteProfileCommandInput | DeletePushTokenCommandInput | DiscoverCommandInput | GenerateDownloadUrlCommandInput | GenerateInviteCommandInput | GenerateUploadUrlCommandInput | GetAdminPhoneStatusCommandInput | GetAiContextMatchCommandInput | GetChatSettingsCommandInput | GetCredentialReadinessCommandInput | GetLivenessStatusCommandInput | GetMatchCommandInput | GetMyProfileCommandInput | GetNotificationPreferencesCommandInput | GetParticipantRegistryCommandInput | GetPreferencesCommandInput | GetProfileCommandInput | GetReceivedLikesCommandInput | GetRosesCommandInput | GetStateCommandInput | GetUserByEmailCommandInput | GetUserCommandInput | GetUserIdByUsernameCommandInput | IndexLocationCommandInput | InitUserCommandInput | LinkEmailCommandInput | LinkSocialCommandInput | ListMyDevicesCommandInput | RegisterDeviceCommandInput | RegisterPhoneCommandInput | RegisterPushTokenCommandInput | RemoveLocationCommandInput | RequestEmailOtpCommandInput | RequestPhoneOtpCommandInput | RequestPhoneUpdateOtpCommandInput | RevokeDeviceCommandInput | SendAdminLinkOtpCommandInput | SwipeByUsernameCommandInput | SwipeCommandInput | UnhookCommandInput | UnlinkSocialCommandInput | UpdateChatSettingsCommandInput | UpdateEntitlementsCommandInput | UpdatePhoneNumberCommandInput | UpdatePreferencesCommandInput | UpdateProfileCommandInput | UpdateUsernameCommandInput | UpgradeUserCommandInput | ValidateInviteCommandInput | VerifyAdminLinkOtpCommandInput;
|
|
69
73
|
/**
|
|
70
74
|
* @public
|
|
71
75
|
*/
|
|
72
|
-
export type ServiceOutputTypes = AuthSocialCommandOutput | CompleteLivenessSessionCommandOutput | CompleteOnboardingCommandOutput | CreateLivenessSessionCommandOutput | CreateMediaDownloadUrlCommandOutput | CreateMediaUploadUrlCommandOutput | DeleteMatchMessagesCommandOutput | DeleteProfileCommandOutput | DeletePushTokenCommandOutput | DiscoverCommandOutput | GenerateDownloadUrlCommandOutput | GenerateInviteCommandOutput | GenerateUploadUrlCommandOutput | GetAiContextMatchCommandOutput | GetChatSettingsCommandOutput | GetCredentialReadinessCommandOutput | GetLivenessStatusCommandOutput | GetMatchCommandOutput | GetMyProfileCommandOutput | GetNotificationPreferencesCommandOutput | GetParticipantRegistryCommandOutput | GetPreferencesCommandOutput | GetProfileCommandOutput | GetReceivedLikesCommandOutput | GetRosesCommandOutput | GetStateCommandOutput | GetUserByEmailCommandOutput | GetUserCommandOutput | GetUserIdByUsernameCommandOutput | IndexLocationCommandOutput | InitUserCommandOutput | LinkEmailCommandOutput | LinkSocialCommandOutput | ListMyDevicesCommandOutput | RegisterDeviceCommandOutput | RegisterPhoneCommandOutput | RegisterPushTokenCommandOutput | RemoveLocationCommandOutput | RequestEmailOtpCommandOutput | RequestPhoneOtpCommandOutput | RequestPhoneUpdateOtpCommandOutput | RevokeDeviceCommandOutput | SwipeByUsernameCommandOutput | SwipeCommandOutput | UnhookCommandOutput | UnlinkSocialCommandOutput | UpdateChatSettingsCommandOutput | UpdateEntitlementsCommandOutput | UpdatePhoneNumberCommandOutput | UpdatePreferencesCommandOutput | UpdateProfileCommandOutput | UpdateUsernameCommandOutput | UpgradeUserCommandOutput | ValidateInviteCommandOutput;
|
|
76
|
+
export type ServiceOutputTypes = AuthSocialCommandOutput | CompleteLivenessSessionCommandOutput | CompleteOnboardingCommandOutput | CreateAdminInviteCommandOutput | CreateLivenessSessionCommandOutput | CreateMediaDownloadUrlCommandOutput | CreateMediaUploadUrlCommandOutput | DeleteMatchMessagesCommandOutput | DeleteProfileCommandOutput | DeletePushTokenCommandOutput | DiscoverCommandOutput | GenerateDownloadUrlCommandOutput | GenerateInviteCommandOutput | GenerateUploadUrlCommandOutput | GetAdminPhoneStatusCommandOutput | GetAiContextMatchCommandOutput | GetChatSettingsCommandOutput | GetCredentialReadinessCommandOutput | GetLivenessStatusCommandOutput | GetMatchCommandOutput | GetMyProfileCommandOutput | GetNotificationPreferencesCommandOutput | GetParticipantRegistryCommandOutput | GetPreferencesCommandOutput | GetProfileCommandOutput | GetReceivedLikesCommandOutput | GetRosesCommandOutput | GetStateCommandOutput | GetUserByEmailCommandOutput | GetUserCommandOutput | GetUserIdByUsernameCommandOutput | IndexLocationCommandOutput | InitUserCommandOutput | LinkEmailCommandOutput | LinkSocialCommandOutput | ListMyDevicesCommandOutput | RegisterDeviceCommandOutput | RegisterPhoneCommandOutput | RegisterPushTokenCommandOutput | RemoveLocationCommandOutput | RequestEmailOtpCommandOutput | RequestPhoneOtpCommandOutput | RequestPhoneUpdateOtpCommandOutput | RevokeDeviceCommandOutput | SendAdminLinkOtpCommandOutput | SwipeByUsernameCommandOutput | SwipeCommandOutput | UnhookCommandOutput | UnlinkSocialCommandOutput | UpdateChatSettingsCommandOutput | UpdateEntitlementsCommandOutput | UpdatePhoneNumberCommandOutput | UpdatePreferencesCommandOutput | UpdateProfileCommandOutput | UpdateUsernameCommandOutput | UpgradeUserCommandOutput | ValidateInviteCommandOutput | VerifyAdminLinkOtpCommandOutput;
|
|
73
77
|
/**
|
|
74
78
|
* @public
|
|
75
79
|
*/
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
|
|
2
|
+
import { CreateAdminInviteRequest, CreateAdminInviteResponse } 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 CreateAdminInviteCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface CreateAdminInviteCommandInput extends CreateAdminInviteRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link CreateAdminInviteCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface CreateAdminInviteCommandOutput extends CreateAdminInviteResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const CreateAdminInviteCommand_base: {
|
|
25
|
+
new (input: CreateAdminInviteCommandInput): import("@smithy/smithy-client").CommandImpl<CreateAdminInviteCommandInput, CreateAdminInviteCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: CreateAdminInviteCommandInput): import("@smithy/smithy-client").CommandImpl<CreateAdminInviteCommandInput, CreateAdminInviteCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Mints a single-use invite bound to a specific phone number, for the admin portal's Admissions
|
|
31
|
+
* module. Internal, IAM-authorized (SigV4) — NOT the Cognito user-pool authorizer — so the only
|
|
32
|
+
* callers are principals granted \{@code execute-api:Invoke\} (the portal's per-module invoke role).
|
|
33
|
+
*
|
|
34
|
+
* The invite is bound to the HMAC hash of the E.164 phone number, created with \{@code maxUses=1\} and
|
|
35
|
+
* a short TTL (default 14 days, bounded 1..30). \{@code RegisterPhone\} refuses a bound invite when the
|
|
36
|
+
* registering phone's hash differs, with the SAME error as an invalid/unknown invite, so the binding
|
|
37
|
+
* is never revealed. The response never echoes the phone or its hash.
|
|
38
|
+
* @example
|
|
39
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
40
|
+
* ```javascript
|
|
41
|
+
* import { OneHookClient, CreateAdminInviteCommand } from "onehook-api-client"; // ES Modules import
|
|
42
|
+
* // const { OneHookClient, CreateAdminInviteCommand } = require("onehook-api-client"); // CommonJS import
|
|
43
|
+
* const client = new OneHookClient(config);
|
|
44
|
+
* const input = { // CreateAdminInviteRequest
|
|
45
|
+
* phoneNumber: "STRING_VALUE", // required
|
|
46
|
+
* referrerId: "STRING_VALUE", // required
|
|
47
|
+
* ttlDays: Number("int"),
|
|
48
|
+
* };
|
|
49
|
+
* const command = new CreateAdminInviteCommand(input);
|
|
50
|
+
* const response = await client.send(command);
|
|
51
|
+
* // { // CreateAdminInviteResponse
|
|
52
|
+
* // inviteCode: "STRING_VALUE", // required
|
|
53
|
+
* // expiresAt: Number("long"), // required
|
|
54
|
+
* // maxUses: Number("int"), // required
|
|
55
|
+
* // };
|
|
56
|
+
*
|
|
57
|
+
* ```
|
|
58
|
+
*
|
|
59
|
+
* @param CreateAdminInviteCommandInput - {@link CreateAdminInviteCommandInput}
|
|
60
|
+
* @returns {@link CreateAdminInviteCommandOutput}
|
|
61
|
+
* @see {@link CreateAdminInviteCommandInput} for command's `input` shape.
|
|
62
|
+
* @see {@link CreateAdminInviteCommandOutput} for command's `response` shape.
|
|
63
|
+
* @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link BadRequestError} (client fault)
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link InternalServerError} (server fault)
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link OneHookServiceException}
|
|
70
|
+
* <p>Base exception class for all service exceptions from OneHook service.</p>
|
|
71
|
+
*
|
|
72
|
+
*
|
|
73
|
+
* @public
|
|
74
|
+
*/
|
|
75
|
+
export declare class CreateAdminInviteCommand extends CreateAdminInviteCommand_base {
|
|
76
|
+
/** @internal type navigation helper, not in runtime. */
|
|
77
|
+
protected static __types: {
|
|
78
|
+
api: {
|
|
79
|
+
input: CreateAdminInviteRequest;
|
|
80
|
+
output: CreateAdminInviteResponse;
|
|
81
|
+
};
|
|
82
|
+
sdk: {
|
|
83
|
+
input: CreateAdminInviteCommandInput;
|
|
84
|
+
output: CreateAdminInviteCommandOutput;
|
|
85
|
+
};
|
|
86
|
+
};
|
|
87
|
+
}
|
|
@@ -0,0 +1,86 @@
|
|
|
1
|
+
import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
|
|
2
|
+
import { GetAdminPhoneStatusRequest, GetAdminPhoneStatusResponse } 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 GetAdminPhoneStatusCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetAdminPhoneStatusCommandInput extends GetAdminPhoneStatusRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetAdminPhoneStatusCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetAdminPhoneStatusCommandOutput extends GetAdminPhoneStatusResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetAdminPhoneStatusCommand_base: {
|
|
25
|
+
new (input: GetAdminPhoneStatusCommandInput): import("@smithy/smithy-client").CommandImpl<GetAdminPhoneStatusCommandInput, GetAdminPhoneStatusCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetAdminPhoneStatusCommandInput): import("@smithy/smithy-client").CommandImpl<GetAdminPhoneStatusCommandInput, GetAdminPhoneStatusCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Reports whether a phone number is already bound to an existing OneHook account, so the admin
|
|
31
|
+
* portal's Admissions module can decide — BEFORE sending an applicant a registration OTP — whether
|
|
32
|
+
* the number is free to onboard. Internal, IAM-authorized (SigV4) — NOT the Cognito user-pool
|
|
33
|
+
* authorizer — so the only callers are principals granted \{@code execute-api:Invoke\} (the portal's
|
|
34
|
+
* per-module invoke role).
|
|
35
|
+
*
|
|
36
|
+
* \{@code registered\} is true when the number holds the SAME phone-uniqueness claim sign-up enforces
|
|
37
|
+
* (the \{@code PHONECLAIM#<e164>\} item in UserTable), which also covers a phone currently claimed by
|
|
38
|
+
* an in-progress registration — exactly what the sign-up uniqueness check rejects as a duplicate.
|
|
39
|
+
* Backed by a single strongly-consistent \{@code GetItem\}; the result is never cached. The phone is
|
|
40
|
+
* validated as E.164 (400 on invalid) and is NEVER echoed back nor logged in clear.
|
|
41
|
+
* @example
|
|
42
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
43
|
+
* ```javascript
|
|
44
|
+
* import { OneHookClient, GetAdminPhoneStatusCommand } from "onehook-api-client"; // ES Modules import
|
|
45
|
+
* // const { OneHookClient, GetAdminPhoneStatusCommand } = require("onehook-api-client"); // CommonJS import
|
|
46
|
+
* const client = new OneHookClient(config);
|
|
47
|
+
* const input = { // GetAdminPhoneStatusRequest
|
|
48
|
+
* phoneNumber: "STRING_VALUE", // required
|
|
49
|
+
* };
|
|
50
|
+
* const command = new GetAdminPhoneStatusCommand(input);
|
|
51
|
+
* const response = await client.send(command);
|
|
52
|
+
* // { // GetAdminPhoneStatusResponse
|
|
53
|
+
* // registered: true || false, // required
|
|
54
|
+
* // };
|
|
55
|
+
*
|
|
56
|
+
* ```
|
|
57
|
+
*
|
|
58
|
+
* @param GetAdminPhoneStatusCommandInput - {@link GetAdminPhoneStatusCommandInput}
|
|
59
|
+
* @returns {@link GetAdminPhoneStatusCommandOutput}
|
|
60
|
+
* @see {@link GetAdminPhoneStatusCommandInput} for command's `input` shape.
|
|
61
|
+
* @see {@link GetAdminPhoneStatusCommandOutput} for command's `response` shape.
|
|
62
|
+
* @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link BadRequestError} (client fault)
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link InternalServerError} (server fault)
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link OneHookServiceException}
|
|
69
|
+
* <p>Base exception class for all service exceptions from OneHook service.</p>
|
|
70
|
+
*
|
|
71
|
+
*
|
|
72
|
+
* @public
|
|
73
|
+
*/
|
|
74
|
+
export declare class GetAdminPhoneStatusCommand extends GetAdminPhoneStatusCommand_base {
|
|
75
|
+
/** @internal type navigation helper, not in runtime. */
|
|
76
|
+
protected static __types: {
|
|
77
|
+
api: {
|
|
78
|
+
input: GetAdminPhoneStatusRequest;
|
|
79
|
+
output: GetAdminPhoneStatusResponse;
|
|
80
|
+
};
|
|
81
|
+
sdk: {
|
|
82
|
+
input: GetAdminPhoneStatusCommandInput;
|
|
83
|
+
output: GetAdminPhoneStatusCommandOutput;
|
|
84
|
+
};
|
|
85
|
+
};
|
|
86
|
+
}
|