onehook-api-client 1.0.30 → 1.0.32
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 +49 -0
- package/dist-cjs/OneHook.js +14 -0
- package/dist-cjs/commands/CorrectBirthDateCommand.js +21 -0
- package/dist-cjs/commands/GetBirthDateStatusCommand.js +21 -0
- package/dist-cjs/commands/GetPlaceCommand.js +21 -0
- package/dist-cjs/commands/GetPreservationHoldCommand.js +21 -0
- package/dist-cjs/commands/RevokeUserAccessCommand.js +21 -0
- package/dist-cjs/commands/SearchPlacesCommand.js +21 -0
- package/dist-cjs/commands/SetPreservationHoldCommand.js +21 -0
- package/dist-cjs/commands/index.js +7 -0
- package/dist-cjs/protocols/Aws_restJson1.js +274 -4
- package/dist-cjs/telemetry/index.js +5 -3
- package/dist-es/OneHook.js +14 -0
- package/dist-es/commands/CorrectBirthDateCommand.js +17 -0
- package/dist-es/commands/GetBirthDateStatusCommand.js +17 -0
- package/dist-es/commands/GetPlaceCommand.js +17 -0
- package/dist-es/commands/GetPreservationHoldCommand.js +17 -0
- package/dist-es/commands/RevokeUserAccessCommand.js +17 -0
- package/dist-es/commands/SearchPlacesCommand.js +17 -0
- package/dist-es/commands/SetPreservationHoldCommand.js +17 -0
- package/dist-es/commands/index.js +7 -0
- package/dist-es/protocols/Aws_restJson1.js +257 -1
- package/dist-es/telemetry/index.js +5 -3
- package/dist-types/OneHook.d.ts +49 -0
- package/dist-types/OneHookClient.d.ts +9 -2
- package/dist-types/commands/CorrectBirthDateCommand.d.ts +88 -0
- package/dist-types/commands/GetBirthDateStatusCommand.d.ts +89 -0
- package/dist-types/commands/GetMyProfileCommand.d.ts +10 -0
- package/dist-types/commands/GetPlaceCommand.d.ts +84 -0
- package/dist-types/commands/GetPreservationHoldCommand.d.ts +87 -0
- package/dist-types/commands/GetProfileCommand.d.ts +10 -0
- package/dist-types/commands/RevokeUserAccessCommand.d.ts +94 -0
- package/dist-types/commands/SearchPlacesCommand.d.ts +83 -0
- package/dist-types/commands/SetPreservationHoldCommand.d.ts +98 -0
- package/dist-types/commands/UpdateProfileCommand.d.ts +9 -1
- package/dist-types/commands/index.d.ts +7 -0
- package/dist-types/models/models_0.d.ts +301 -1
- package/dist-types/protocols/Aws_restJson1.d.ts +63 -0
- package/dist-types/telemetry/index.d.ts +3 -2
- package/package.json +1 -1
- package/telemetry/TelemetryCatalog.kt +6 -5
- package/telemetry/TelemetryCatalog.swift +7 -5
- package/telemetry/telemetry-catalog.json +25 -4
|
@@ -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 { CorrectBirthDateCommandInput, CorrectBirthDateCommandOutput } from "./commands/CorrectBirthDateCommand";
|
|
5
6
|
import { CreateAdminInviteCommandInput, CreateAdminInviteCommandOutput } from "./commands/CreateAdminInviteCommand";
|
|
6
7
|
import { CreateLivenessSessionCommandInput, CreateLivenessSessionCommandOutput } from "./commands/CreateLivenessSessionCommand";
|
|
7
8
|
import { CreateMediaDownloadUrlCommandInput, CreateMediaDownloadUrlCommandOutput } from "./commands/CreateMediaDownloadUrlCommand";
|
|
@@ -16,6 +17,7 @@ import { GenerateUploadUrlCommandInput, GenerateUploadUrlCommandOutput } from ".
|
|
|
16
17
|
import { GetAccountStateCommandInput, GetAccountStateCommandOutput } from "./commands/GetAccountStateCommand";
|
|
17
18
|
import { GetAdminPhoneStatusCommandInput, GetAdminPhoneStatusCommandOutput } from "./commands/GetAdminPhoneStatusCommand";
|
|
18
19
|
import { GetAiContextMatchCommandInput, GetAiContextMatchCommandOutput } from "./commands/GetAiContextMatchCommand";
|
|
20
|
+
import { GetBirthDateStatusCommandInput, GetBirthDateStatusCommandOutput } from "./commands/GetBirthDateStatusCommand";
|
|
19
21
|
import { GetChatSettingsCommandInput, GetChatSettingsCommandOutput } from "./commands/GetChatSettingsCommand";
|
|
20
22
|
import { GetCredentialReadinessCommandInput, GetCredentialReadinessCommandOutput } from "./commands/GetCredentialReadinessCommand";
|
|
21
23
|
import { GetLivenessStatusCommandInput, GetLivenessStatusCommandOutput } from "./commands/GetLivenessStatusCommand";
|
|
@@ -23,7 +25,9 @@ import { GetMatchCommandInput, GetMatchCommandOutput } from "./commands/GetMatch
|
|
|
23
25
|
import { GetMyProfileCommandInput, GetMyProfileCommandOutput } from "./commands/GetMyProfileCommand";
|
|
24
26
|
import { GetNotificationPreferencesCommandInput, GetNotificationPreferencesCommandOutput } from "./commands/GetNotificationPreferencesCommand";
|
|
25
27
|
import { GetParticipantRegistryCommandInput, GetParticipantRegistryCommandOutput } from "./commands/GetParticipantRegistryCommand";
|
|
28
|
+
import { GetPlaceCommandInput, GetPlaceCommandOutput } from "./commands/GetPlaceCommand";
|
|
26
29
|
import { GetPreferencesCommandInput, GetPreferencesCommandOutput } from "./commands/GetPreferencesCommand";
|
|
30
|
+
import { GetPreservationHoldCommandInput, GetPreservationHoldCommandOutput } from "./commands/GetPreservationHoldCommand";
|
|
27
31
|
import { GetProfileCommandInput, GetProfileCommandOutput } from "./commands/GetProfileCommand";
|
|
28
32
|
import { GetReceivedLikesCommandInput, GetReceivedLikesCommandOutput } from "./commands/GetReceivedLikesCommand";
|
|
29
33
|
import { GetRosesCommandInput, GetRosesCommandOutput } from "./commands/GetRosesCommand";
|
|
@@ -45,8 +49,11 @@ import { RequestEmailOtpCommandInput, RequestEmailOtpCommandOutput } from "./com
|
|
|
45
49
|
import { RequestPhoneOtpCommandInput, RequestPhoneOtpCommandOutput } from "./commands/RequestPhoneOtpCommand";
|
|
46
50
|
import { RequestPhoneUpdateOtpCommandInput, RequestPhoneUpdateOtpCommandOutput } from "./commands/RequestPhoneUpdateOtpCommand";
|
|
47
51
|
import { RevokeDeviceCommandInput, RevokeDeviceCommandOutput } from "./commands/RevokeDeviceCommand";
|
|
52
|
+
import { RevokeUserAccessCommandInput, RevokeUserAccessCommandOutput } from "./commands/RevokeUserAccessCommand";
|
|
53
|
+
import { SearchPlacesCommandInput, SearchPlacesCommandOutput } from "./commands/SearchPlacesCommand";
|
|
48
54
|
import { SendAdminLinkOtpCommandInput, SendAdminLinkOtpCommandOutput } from "./commands/SendAdminLinkOtpCommand";
|
|
49
55
|
import { SetAccountStateCommandInput, SetAccountStateCommandOutput } from "./commands/SetAccountStateCommand";
|
|
56
|
+
import { SetPreservationHoldCommandInput, SetPreservationHoldCommandOutput } from "./commands/SetPreservationHoldCommand";
|
|
50
57
|
import { SwipeByUsernameCommandInput, SwipeByUsernameCommandOutput } from "./commands/SwipeByUsernameCommand";
|
|
51
58
|
import { SwipeCommandInput, SwipeCommandOutput } from "./commands/SwipeCommand";
|
|
52
59
|
import { UnhookCommandInput, UnhookCommandOutput } from "./commands/UnhookCommand";
|
|
@@ -72,11 +79,11 @@ export { __Client };
|
|
|
72
79
|
/**
|
|
73
80
|
* @public
|
|
74
81
|
*/
|
|
75
|
-
export type ServiceInputTypes = AuthSocialCommandInput | CompleteLivenessSessionCommandInput | CompleteOnboardingCommandInput | CreateAdminInviteCommandInput | CreateLivenessSessionCommandInput | CreateMediaDownloadUrlCommandInput | CreateMediaUploadUrlCommandInput | DeleteMatchMessagesCommandInput | DeleteProfileCommandInput | DeletePushTokenCommandInput | DiscoverCommandInput | GenerateDownloadUrlCommandInput | GenerateInviteCommandInput | GenerateUploadUrlCommandInput | GetAccountStateCommandInput | GetAdminPhoneStatusCommandInput | GetAiContextMatchCommandInput | GetChatSettingsCommandInput | GetCredentialReadinessCommandInput | GetLivenessStatusCommandInput | GetMatchCommandInput | GetMyProfileCommandInput | GetNotificationPreferencesCommandInput | GetParticipantRegistryCommandInput | GetPreferencesCommandInput | GetProfileCommandInput | GetReceivedLikesCommandInput | GetRosesCommandInput | GetStateCommandInput | GetUserByEmailCommandInput | GetUserCommandInput | GetUserIdByUsernameCommandInput | IndexLocationCommandInput | InitUserCommandInput | LinkEmailCommandInput | LinkSocialCommandInput | ListMyDevicesCommandInput | RecordSuggestionCommandInput | RegisterDeviceCommandInput | RegisterPhoneCommandInput | RegisterPushTokenCommandInput | RemoveLocationCommandInput | RequestEmailOtpCommandInput | RequestPhoneOtpCommandInput | RequestPhoneUpdateOtpCommandInput | RevokeDeviceCommandInput | SendAdminLinkOtpCommandInput | SetAccountStateCommandInput | SwipeByUsernameCommandInput | SwipeCommandInput | UnhookCommandInput | UnlinkSocialCommandInput | UpdateChatSettingsCommandInput | UpdateEntitlementsCommandInput | UpdatePhoneNumberCommandInput | UpdatePreferencesCommandInput | UpdateProfileCommandInput | UpdateUsernameCommandInput | UpgradeUserCommandInput | ValidateInviteCommandInput | VerifyAdminLinkOtpCommandInput;
|
|
82
|
+
export type ServiceInputTypes = AuthSocialCommandInput | CompleteLivenessSessionCommandInput | CompleteOnboardingCommandInput | CorrectBirthDateCommandInput | CreateAdminInviteCommandInput | CreateLivenessSessionCommandInput | CreateMediaDownloadUrlCommandInput | CreateMediaUploadUrlCommandInput | DeleteMatchMessagesCommandInput | DeleteProfileCommandInput | DeletePushTokenCommandInput | DiscoverCommandInput | GenerateDownloadUrlCommandInput | GenerateInviteCommandInput | GenerateUploadUrlCommandInput | GetAccountStateCommandInput | GetAdminPhoneStatusCommandInput | GetAiContextMatchCommandInput | GetBirthDateStatusCommandInput | GetChatSettingsCommandInput | GetCredentialReadinessCommandInput | GetLivenessStatusCommandInput | GetMatchCommandInput | GetMyProfileCommandInput | GetNotificationPreferencesCommandInput | GetParticipantRegistryCommandInput | GetPlaceCommandInput | GetPreferencesCommandInput | GetPreservationHoldCommandInput | GetProfileCommandInput | GetReceivedLikesCommandInput | GetRosesCommandInput | GetStateCommandInput | GetUserByEmailCommandInput | GetUserCommandInput | GetUserIdByUsernameCommandInput | IndexLocationCommandInput | InitUserCommandInput | LinkEmailCommandInput | LinkSocialCommandInput | ListMyDevicesCommandInput | RecordSuggestionCommandInput | RegisterDeviceCommandInput | RegisterPhoneCommandInput | RegisterPushTokenCommandInput | RemoveLocationCommandInput | RequestEmailOtpCommandInput | RequestPhoneOtpCommandInput | RequestPhoneUpdateOtpCommandInput | RevokeDeviceCommandInput | RevokeUserAccessCommandInput | SearchPlacesCommandInput | SendAdminLinkOtpCommandInput | SetAccountStateCommandInput | SetPreservationHoldCommandInput | SwipeByUsernameCommandInput | SwipeCommandInput | UnhookCommandInput | UnlinkSocialCommandInput | UpdateChatSettingsCommandInput | UpdateEntitlementsCommandInput | UpdatePhoneNumberCommandInput | UpdatePreferencesCommandInput | UpdateProfileCommandInput | UpdateUsernameCommandInput | UpgradeUserCommandInput | ValidateInviteCommandInput | VerifyAdminLinkOtpCommandInput;
|
|
76
83
|
/**
|
|
77
84
|
* @public
|
|
78
85
|
*/
|
|
79
|
-
export type ServiceOutputTypes = AuthSocialCommandOutput | CompleteLivenessSessionCommandOutput | CompleteOnboardingCommandOutput | CreateAdminInviteCommandOutput | CreateLivenessSessionCommandOutput | CreateMediaDownloadUrlCommandOutput | CreateMediaUploadUrlCommandOutput | DeleteMatchMessagesCommandOutput | DeleteProfileCommandOutput | DeletePushTokenCommandOutput | DiscoverCommandOutput | GenerateDownloadUrlCommandOutput | GenerateInviteCommandOutput | GenerateUploadUrlCommandOutput | GetAccountStateCommandOutput | GetAdminPhoneStatusCommandOutput | GetAiContextMatchCommandOutput | GetChatSettingsCommandOutput | GetCredentialReadinessCommandOutput | GetLivenessStatusCommandOutput | GetMatchCommandOutput | GetMyProfileCommandOutput | GetNotificationPreferencesCommandOutput | GetParticipantRegistryCommandOutput | GetPreferencesCommandOutput | GetProfileCommandOutput | GetReceivedLikesCommandOutput | GetRosesCommandOutput | GetStateCommandOutput | GetUserByEmailCommandOutput | GetUserCommandOutput | GetUserIdByUsernameCommandOutput | IndexLocationCommandOutput | InitUserCommandOutput | LinkEmailCommandOutput | LinkSocialCommandOutput | ListMyDevicesCommandOutput | RecordSuggestionCommandOutput | RegisterDeviceCommandOutput | RegisterPhoneCommandOutput | RegisterPushTokenCommandOutput | RemoveLocationCommandOutput | RequestEmailOtpCommandOutput | RequestPhoneOtpCommandOutput | RequestPhoneUpdateOtpCommandOutput | RevokeDeviceCommandOutput | SendAdminLinkOtpCommandOutput | SetAccountStateCommandOutput | SwipeByUsernameCommandOutput | SwipeCommandOutput | UnhookCommandOutput | UnlinkSocialCommandOutput | UpdateChatSettingsCommandOutput | UpdateEntitlementsCommandOutput | UpdatePhoneNumberCommandOutput | UpdatePreferencesCommandOutput | UpdateProfileCommandOutput | UpdateUsernameCommandOutput | UpgradeUserCommandOutput | ValidateInviteCommandOutput | VerifyAdminLinkOtpCommandOutput;
|
|
86
|
+
export type ServiceOutputTypes = AuthSocialCommandOutput | CompleteLivenessSessionCommandOutput | CompleteOnboardingCommandOutput | CorrectBirthDateCommandOutput | CreateAdminInviteCommandOutput | CreateLivenessSessionCommandOutput | CreateMediaDownloadUrlCommandOutput | CreateMediaUploadUrlCommandOutput | DeleteMatchMessagesCommandOutput | DeleteProfileCommandOutput | DeletePushTokenCommandOutput | DiscoverCommandOutput | GenerateDownloadUrlCommandOutput | GenerateInviteCommandOutput | GenerateUploadUrlCommandOutput | GetAccountStateCommandOutput | GetAdminPhoneStatusCommandOutput | GetAiContextMatchCommandOutput | GetBirthDateStatusCommandOutput | GetChatSettingsCommandOutput | GetCredentialReadinessCommandOutput | GetLivenessStatusCommandOutput | GetMatchCommandOutput | GetMyProfileCommandOutput | GetNotificationPreferencesCommandOutput | GetParticipantRegistryCommandOutput | GetPlaceCommandOutput | GetPreferencesCommandOutput | GetPreservationHoldCommandOutput | GetProfileCommandOutput | GetReceivedLikesCommandOutput | GetRosesCommandOutput | GetStateCommandOutput | GetUserByEmailCommandOutput | GetUserCommandOutput | GetUserIdByUsernameCommandOutput | IndexLocationCommandOutput | InitUserCommandOutput | LinkEmailCommandOutput | LinkSocialCommandOutput | ListMyDevicesCommandOutput | RecordSuggestionCommandOutput | RegisterDeviceCommandOutput | RegisterPhoneCommandOutput | RegisterPushTokenCommandOutput | RemoveLocationCommandOutput | RequestEmailOtpCommandOutput | RequestPhoneOtpCommandOutput | RequestPhoneUpdateOtpCommandOutput | RevokeDeviceCommandOutput | RevokeUserAccessCommandOutput | SearchPlacesCommandOutput | SendAdminLinkOtpCommandOutput | SetAccountStateCommandOutput | SetPreservationHoldCommandOutput | SwipeByUsernameCommandOutput | SwipeCommandOutput | UnhookCommandOutput | UnlinkSocialCommandOutput | UpdateChatSettingsCommandOutput | UpdateEntitlementsCommandOutput | UpdatePhoneNumberCommandOutput | UpdatePreferencesCommandOutput | UpdateProfileCommandOutput | UpdateUsernameCommandOutput | UpgradeUserCommandOutput | ValidateInviteCommandOutput | VerifyAdminLinkOtpCommandOutput;
|
|
80
87
|
/**
|
|
81
88
|
* @public
|
|
82
89
|
*/
|
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
|
|
2
|
+
import { CorrectBirthDateRequest, CorrectBirthDateResponse } 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 CorrectBirthDateCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface CorrectBirthDateCommandInput extends CorrectBirthDateRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link CorrectBirthDateCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface CorrectBirthDateCommandOutput extends CorrectBirthDateResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const CorrectBirthDateCommand_base: {
|
|
25
|
+
new (input: CorrectBirthDateCommandInput): import("@smithy/smithy-client").CommandImpl<CorrectBirthDateCommandInput, CorrectBirthDateCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: CorrectBirthDateCommandInput): import("@smithy/smithy-client").CommandImpl<CorrectBirthDateCommandInput, CorrectBirthDateCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Support-only correction of a member's birth date, which members can never change themselves.
|
|
31
|
+
* Internal, IAM-authorized (SigV4): callable only by principals granted execute-api:Invoke on this
|
|
32
|
+
* route (the admin portal's support role). Every correction is audited (who, when, why, from/to)
|
|
33
|
+
* and limited to 2 per member, ever. Age is re-derived; Matching re-syncs automatically.
|
|
34
|
+
* @example
|
|
35
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
36
|
+
* ```javascript
|
|
37
|
+
* import { OneHookClient, CorrectBirthDateCommand } from "onehook-api-client"; // ES Modules import
|
|
38
|
+
* // const { OneHookClient, CorrectBirthDateCommand } = require("onehook-api-client"); // CommonJS import
|
|
39
|
+
* const client = new OneHookClient(config);
|
|
40
|
+
* const input = { // CorrectBirthDateRequest
|
|
41
|
+
* userId: "STRING_VALUE", // required
|
|
42
|
+
* date: "STRING_VALUE", // required
|
|
43
|
+
* reason: "STRING_VALUE", // required
|
|
44
|
+
* reference: "STRING_VALUE",
|
|
45
|
+
* };
|
|
46
|
+
* const command = new CorrectBirthDateCommand(input);
|
|
47
|
+
* const response = await client.send(command);
|
|
48
|
+
* // { // CorrectBirthDateResponse
|
|
49
|
+
* // userId: "STRING_VALUE", // required
|
|
50
|
+
* // date: "STRING_VALUE", // required
|
|
51
|
+
* // age: Number("int"), // required
|
|
52
|
+
* // correctionsUsed: Number("int"), // required
|
|
53
|
+
* // correctionsRemaining: Number("int"), // required
|
|
54
|
+
* // };
|
|
55
|
+
*
|
|
56
|
+
* ```
|
|
57
|
+
*
|
|
58
|
+
* @param CorrectBirthDateCommandInput - {@link CorrectBirthDateCommandInput}
|
|
59
|
+
* @returns {@link CorrectBirthDateCommandOutput}
|
|
60
|
+
* @see {@link CorrectBirthDateCommandInput} for command's `input` shape.
|
|
61
|
+
* @see {@link CorrectBirthDateCommandOutput} 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 NotFoundError} (client fault)
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link InternalServerError} (server fault)
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link OneHookServiceException}
|
|
71
|
+
* <p>Base exception class for all service exceptions from OneHook service.</p>
|
|
72
|
+
*
|
|
73
|
+
*
|
|
74
|
+
* @public
|
|
75
|
+
*/
|
|
76
|
+
export declare class CorrectBirthDateCommand extends CorrectBirthDateCommand_base {
|
|
77
|
+
/** @internal type navigation helper, not in runtime. */
|
|
78
|
+
protected static __types: {
|
|
79
|
+
api: {
|
|
80
|
+
input: CorrectBirthDateRequest;
|
|
81
|
+
output: CorrectBirthDateResponse;
|
|
82
|
+
};
|
|
83
|
+
sdk: {
|
|
84
|
+
input: CorrectBirthDateCommandInput;
|
|
85
|
+
output: CorrectBirthDateCommandOutput;
|
|
86
|
+
};
|
|
87
|
+
};
|
|
88
|
+
}
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
|
|
2
|
+
import { GetBirthDateStatusRequest, GetBirthDateStatusResponse } 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 GetBirthDateStatusCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetBirthDateStatusCommandInput extends GetBirthDateStatusRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetBirthDateStatusCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetBirthDateStatusCommandOutput extends GetBirthDateStatusResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetBirthDateStatusCommand_base: {
|
|
25
|
+
new (input: GetBirthDateStatusCommandInput): import("@smithy/smithy-client").CommandImpl<GetBirthDateStatusCommandInput, GetBirthDateStatusCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetBirthDateStatusCommandInput): import("@smithy/smithy-client").CommandImpl<GetBirthDateStatusCommandInput, GetBirthDateStatusCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Support-only read of a member's birth-date state before correcting it. Internal, IAM-authorized
|
|
31
|
+
* (SigV4). Returns the date, derived age, whether it is provisional, and corrections used/remaining.
|
|
32
|
+
* @example
|
|
33
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
34
|
+
* ```javascript
|
|
35
|
+
* import { OneHookClient, GetBirthDateStatusCommand } from "onehook-api-client"; // ES Modules import
|
|
36
|
+
* // const { OneHookClient, GetBirthDateStatusCommand } = require("onehook-api-client"); // CommonJS import
|
|
37
|
+
* const client = new OneHookClient(config);
|
|
38
|
+
* const input = { // GetBirthDateStatusRequest
|
|
39
|
+
* userId: "STRING_VALUE", // required
|
|
40
|
+
* };
|
|
41
|
+
* const command = new GetBirthDateStatusCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // { // GetBirthDateStatusResponse
|
|
44
|
+
* // userId: "STRING_VALUE", // required
|
|
45
|
+
* // date: "STRING_VALUE",
|
|
46
|
+
* // age: Number("int"),
|
|
47
|
+
* // provisional: true || false, // required
|
|
48
|
+
* // birthDateOnFile: true || false, // required
|
|
49
|
+
* // correctionsUsed: Number("int"), // required
|
|
50
|
+
* // correctionsRemaining: Number("int"), // required
|
|
51
|
+
* // lastCorrectedAt: Number("long"),
|
|
52
|
+
* // lastReason: "STRING_VALUE",
|
|
53
|
+
* // lastReference: "STRING_VALUE",
|
|
54
|
+
* // lastCorrectedBy: "STRING_VALUE",
|
|
55
|
+
* // };
|
|
56
|
+
*
|
|
57
|
+
* ```
|
|
58
|
+
*
|
|
59
|
+
* @param GetBirthDateStatusCommandInput - {@link GetBirthDateStatusCommandInput}
|
|
60
|
+
* @returns {@link GetBirthDateStatusCommandOutput}
|
|
61
|
+
* @see {@link GetBirthDateStatusCommandInput} for command's `input` shape.
|
|
62
|
+
* @see {@link GetBirthDateStatusCommandOutput} 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 NotFoundError} (client fault)
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link InternalServerError} (server fault)
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link OneHookServiceException}
|
|
72
|
+
* <p>Base exception class for all service exceptions from OneHook service.</p>
|
|
73
|
+
*
|
|
74
|
+
*
|
|
75
|
+
* @public
|
|
76
|
+
*/
|
|
77
|
+
export declare class GetBirthDateStatusCommand extends GetBirthDateStatusCommand_base {
|
|
78
|
+
/** @internal type navigation helper, not in runtime. */
|
|
79
|
+
protected static __types: {
|
|
80
|
+
api: {
|
|
81
|
+
input: GetBirthDateStatusRequest;
|
|
82
|
+
output: GetBirthDateStatusResponse;
|
|
83
|
+
};
|
|
84
|
+
sdk: {
|
|
85
|
+
input: GetBirthDateStatusCommandInput;
|
|
86
|
+
output: GetBirthDateStatusCommandOutput;
|
|
87
|
+
};
|
|
88
|
+
};
|
|
89
|
+
}
|
|
@@ -106,6 +106,16 @@ declare const GetMyProfileCommand_base: {
|
|
|
106
106
|
* // educationLevel: "STRING_VALUE",
|
|
107
107
|
* // politicalView: "STRING_VALUE",
|
|
108
108
|
* // languages: "<StringList>",
|
|
109
|
+
* // birthDetails: { // BirthDetails
|
|
110
|
+
* // date: "STRING_VALUE",
|
|
111
|
+
* // time: "STRING_VALUE",
|
|
112
|
+
* // timeZone: "STRING_VALUE",
|
|
113
|
+
* // latitude: Number("double"),
|
|
114
|
+
* // longitude: Number("double"),
|
|
115
|
+
* // placeName: "STRING_VALUE",
|
|
116
|
+
* // provisional: true || false,
|
|
117
|
+
* // },
|
|
118
|
+
* // birthDateOnFile: true || false,
|
|
109
119
|
* // };
|
|
110
120
|
*
|
|
111
121
|
* ```
|
|
@@ -0,0 +1,84 @@
|
|
|
1
|
+
import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
|
|
2
|
+
import { GetPlaceRequest, GetPlaceResponse } 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 GetPlaceCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetPlaceCommandInput extends GetPlaceRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetPlaceCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetPlaceCommandOutput extends GetPlaceResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetPlaceCommand_base: {
|
|
25
|
+
new (input: GetPlaceCommandInput): import("@smithy/smithy-client").CommandImpl<GetPlaceCommandInput, GetPlaceCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetPlaceCommandInput): import("@smithy/smithy-client").CommandImpl<GetPlaceCommandInput, GetPlaceCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Resolves a `placeId` from SearchPlaces to coordinates and the IANA time zone, which the client then
|
|
31
|
+
* sends as `birthDetails.latitude`, `longitude`, `timeZone` and `placeName`.
|
|
32
|
+
* @example
|
|
33
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
34
|
+
* ```javascript
|
|
35
|
+
* import { OneHookClient, GetPlaceCommand } from "onehook-api-client"; // ES Modules import
|
|
36
|
+
* // const { OneHookClient, GetPlaceCommand } = require("onehook-api-client"); // CommonJS import
|
|
37
|
+
* const client = new OneHookClient(config);
|
|
38
|
+
* const input = { // GetPlaceRequest
|
|
39
|
+
* placeId: "STRING_VALUE", // required
|
|
40
|
+
* lang: "STRING_VALUE",
|
|
41
|
+
* };
|
|
42
|
+
* const command = new GetPlaceCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // GetPlaceResponse
|
|
45
|
+
* // placeId: "STRING_VALUE", // required
|
|
46
|
+
* // label: "STRING_VALUE", // required
|
|
47
|
+
* // latitude: Number("double"), // required
|
|
48
|
+
* // longitude: Number("double"), // required
|
|
49
|
+
* // timeZone: "STRING_VALUE",
|
|
50
|
+
* // };
|
|
51
|
+
*
|
|
52
|
+
* ```
|
|
53
|
+
*
|
|
54
|
+
* @param GetPlaceCommandInput - {@link GetPlaceCommandInput}
|
|
55
|
+
* @returns {@link GetPlaceCommandOutput}
|
|
56
|
+
* @see {@link GetPlaceCommandInput} for command's `input` shape.
|
|
57
|
+
* @see {@link GetPlaceCommandOutput} for command's `response` shape.
|
|
58
|
+
* @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link BadRequestError} (client fault)
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link NotFoundError} (client fault)
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link InternalServerError} (server fault)
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link OneHookServiceException}
|
|
67
|
+
* <p>Base exception class for all service exceptions from OneHook service.</p>
|
|
68
|
+
*
|
|
69
|
+
*
|
|
70
|
+
* @public
|
|
71
|
+
*/
|
|
72
|
+
export declare class GetPlaceCommand extends GetPlaceCommand_base {
|
|
73
|
+
/** @internal type navigation helper, not in runtime. */
|
|
74
|
+
protected static __types: {
|
|
75
|
+
api: {
|
|
76
|
+
input: GetPlaceRequest;
|
|
77
|
+
output: GetPlaceResponse;
|
|
78
|
+
};
|
|
79
|
+
sdk: {
|
|
80
|
+
input: GetPlaceCommandInput;
|
|
81
|
+
output: GetPlaceCommandOutput;
|
|
82
|
+
};
|
|
83
|
+
};
|
|
84
|
+
}
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
|
|
2
|
+
import { GetPreservationHoldRequest, GetPreservationHoldResponse } 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 GetPreservationHoldCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetPreservationHoldCommandInput extends GetPreservationHoldRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetPreservationHoldCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetPreservationHoldCommandOutput extends GetPreservationHoldResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetPreservationHoldCommand_base: {
|
|
25
|
+
new (input: GetPreservationHoldCommandInput): import("@smithy/smithy-client").CommandImpl<GetPreservationHoldCommandInput, GetPreservationHoldCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetPreservationHoldCommandInput): import("@smithy/smithy-client").CommandImpl<GetPreservationHoldCommandInput, GetPreservationHoldCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Reads a member's current legal preservation hold. Internal, IAM-authorized (SigV4). An expired
|
|
31
|
+
* hold reads back as inactive. The returned `version` is the optimistic-concurrency token to pass to
|
|
32
|
+
* the next SetPreservationHold. Also the lookup the deletion gate uses before erasing an account.
|
|
33
|
+
* @example
|
|
34
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
+
* ```javascript
|
|
36
|
+
* import { OneHookClient, GetPreservationHoldCommand } from "onehook-api-client"; // ES Modules import
|
|
37
|
+
* // const { OneHookClient, GetPreservationHoldCommand } = require("onehook-api-client"); // CommonJS import
|
|
38
|
+
* const client = new OneHookClient(config);
|
|
39
|
+
* const input = { // GetPreservationHoldRequest
|
|
40
|
+
* userId: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new GetPreservationHoldCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // GetPreservationHoldResponse
|
|
45
|
+
* // active: true || false, // required
|
|
46
|
+
* // until: Number("long"),
|
|
47
|
+
* // version: Number("int"), // required
|
|
48
|
+
* // reasonCode: "STRING_VALUE",
|
|
49
|
+
* // caseRef: "STRING_VALUE",
|
|
50
|
+
* // setBy: "STRING_VALUE",
|
|
51
|
+
* // setAt: Number("long"),
|
|
52
|
+
* // childSafetySince: Number("long"),
|
|
53
|
+
* // };
|
|
54
|
+
*
|
|
55
|
+
* ```
|
|
56
|
+
*
|
|
57
|
+
* @param GetPreservationHoldCommandInput - {@link GetPreservationHoldCommandInput}
|
|
58
|
+
* @returns {@link GetPreservationHoldCommandOutput}
|
|
59
|
+
* @see {@link GetPreservationHoldCommandInput} for command's `input` shape.
|
|
60
|
+
* @see {@link GetPreservationHoldCommandOutput} for command's `response` shape.
|
|
61
|
+
* @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link BadRequestError} (client fault)
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link NotFoundError} (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 GetPreservationHoldCommand extends GetPreservationHoldCommand_base {
|
|
76
|
+
/** @internal type navigation helper, not in runtime. */
|
|
77
|
+
protected static __types: {
|
|
78
|
+
api: {
|
|
79
|
+
input: GetPreservationHoldRequest;
|
|
80
|
+
output: GetPreservationHoldResponse;
|
|
81
|
+
};
|
|
82
|
+
sdk: {
|
|
83
|
+
input: GetPreservationHoldCommandInput;
|
|
84
|
+
output: GetPreservationHoldCommandOutput;
|
|
85
|
+
};
|
|
86
|
+
};
|
|
87
|
+
}
|
|
@@ -107,6 +107,16 @@ declare const GetProfileCommand_base: {
|
|
|
107
107
|
* // educationLevel: "STRING_VALUE",
|
|
108
108
|
* // politicalView: "STRING_VALUE",
|
|
109
109
|
* // languages: "<StringList>",
|
|
110
|
+
* // birthDetails: { // BirthDetails
|
|
111
|
+
* // date: "STRING_VALUE",
|
|
112
|
+
* // time: "STRING_VALUE",
|
|
113
|
+
* // timeZone: "STRING_VALUE",
|
|
114
|
+
* // latitude: Number("double"),
|
|
115
|
+
* // longitude: Number("double"),
|
|
116
|
+
* // placeName: "STRING_VALUE",
|
|
117
|
+
* // provisional: true || false,
|
|
118
|
+
* // },
|
|
119
|
+
* // birthDateOnFile: true || false,
|
|
110
120
|
* // };
|
|
111
121
|
*
|
|
112
122
|
* ```
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
|
|
2
|
+
import { RevokeUserAccessRequest, RevokeUserAccessResponse } 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 RevokeUserAccessCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface RevokeUserAccessCommandInput extends RevokeUserAccessRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link RevokeUserAccessCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface RevokeUserAccessCommandOutput extends RevokeUserAccessResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const RevokeUserAccessCommand_base: {
|
|
25
|
+
new (input: RevokeUserAccessCommandInput): import("@smithy/smithy-client").CommandImpl<RevokeUserAccessCommandInput, RevokeUserAccessCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: RevokeUserAccessCommandInput): import("@smithy/smithy-client").CommandImpl<RevokeUserAccessCommandInput, RevokeUserAccessCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Revokes a member's LIVE Cognito access during self-service account deletion: globally signs the
|
|
31
|
+
* member out and disables the Cognito user, so existing sessions are cut and new sign-ins blocked.
|
|
32
|
+
* Internal, IAM-authorized (SigV4) - NOT the Cognito user-pool authorizer - so the only callers are
|
|
33
|
+
* the Profile deletion/erasure workers (their per-worker invoke role). Identity owns Cognito, so it
|
|
34
|
+
* resolves the immutable Cognito Username from the stored profile (the caller holds only the `sub`),
|
|
35
|
+
* which is why Profile must not call Cognito admin APIs directly.
|
|
36
|
+
*
|
|
37
|
+
* A LEGACY profile row may carry no stored Username. That row still has a LIVE Cognito user (an
|
|
38
|
+
* abandoned registration leaves no row at all), so returning success would leave the member signed
|
|
39
|
+
* in. Identity therefore resolves the Username from Cognito by `sub` (ListUsers, filter `sub = "..."`)
|
|
40
|
+
* and proceeds; if the user cannot be resolved it returns 500 so Profile fails closed rather than
|
|
41
|
+
* reporting a revoke that never happened.
|
|
42
|
+
*
|
|
43
|
+
* Idempotent and fail-safe for retries: an already-disabled user, or a Cognito user that was already
|
|
44
|
+
* deleted, is reported as success. It NEVER deletes the Cognito user (the one real AdminDeleteUser is
|
|
45
|
+
* left to Identity's AccountDeletionWorker on UserDeleted, so the phone alias survives a hold placed
|
|
46
|
+
* during the drain). Returns 404 ONLY when the member's user row does not exist in Identity.
|
|
47
|
+
* @example
|
|
48
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
49
|
+
* ```javascript
|
|
50
|
+
* import { OneHookClient, RevokeUserAccessCommand } from "onehook-api-client"; // ES Modules import
|
|
51
|
+
* // const { OneHookClient, RevokeUserAccessCommand } = require("onehook-api-client"); // CommonJS import
|
|
52
|
+
* const client = new OneHookClient(config);
|
|
53
|
+
* const input = { // RevokeUserAccessRequest
|
|
54
|
+
* userId: "STRING_VALUE", // required
|
|
55
|
+
* };
|
|
56
|
+
* const command = new RevokeUserAccessCommand(input);
|
|
57
|
+
* const response = await client.send(command);
|
|
58
|
+
* // { // RevokeUserAccessResponse
|
|
59
|
+
* // status: "STRING_VALUE", // required
|
|
60
|
+
* // };
|
|
61
|
+
*
|
|
62
|
+
* ```
|
|
63
|
+
*
|
|
64
|
+
* @param RevokeUserAccessCommandInput - {@link RevokeUserAccessCommandInput}
|
|
65
|
+
* @returns {@link RevokeUserAccessCommandOutput}
|
|
66
|
+
* @see {@link RevokeUserAccessCommandInput} for command's `input` shape.
|
|
67
|
+
* @see {@link RevokeUserAccessCommandOutput} for command's `response` shape.
|
|
68
|
+
* @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link BadRequestError} (client fault)
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link NotFoundError} (client fault)
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link InternalServerError} (server fault)
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link OneHookServiceException}
|
|
77
|
+
* <p>Base exception class for all service exceptions from OneHook service.</p>
|
|
78
|
+
*
|
|
79
|
+
*
|
|
80
|
+
* @public
|
|
81
|
+
*/
|
|
82
|
+
export declare class RevokeUserAccessCommand extends RevokeUserAccessCommand_base {
|
|
83
|
+
/** @internal type navigation helper, not in runtime. */
|
|
84
|
+
protected static __types: {
|
|
85
|
+
api: {
|
|
86
|
+
input: RevokeUserAccessRequest;
|
|
87
|
+
output: RevokeUserAccessResponse;
|
|
88
|
+
};
|
|
89
|
+
sdk: {
|
|
90
|
+
input: RevokeUserAccessCommandInput;
|
|
91
|
+
output: RevokeUserAccessCommandOutput;
|
|
92
|
+
};
|
|
93
|
+
};
|
|
94
|
+
}
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
|
|
2
|
+
import { SearchPlacesRequest, SearchPlacesResponse } 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 SearchPlacesCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface SearchPlacesCommandInput extends SearchPlacesRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link SearchPlacesCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface SearchPlacesCommandOutput extends SearchPlacesResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const SearchPlacesCommand_base: {
|
|
25
|
+
new (input: SearchPlacesCommandInput): import("@smithy/smithy-client").CommandImpl<SearchPlacesCommandInput, SearchPlacesCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: SearchPlacesCommandInput): import("@smithy/smithy-client").CommandImpl<SearchPlacesCommandInput, SearchPlacesCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Birthplace search for the date-of-birth form: cities and towns matching `q` (at least 2 characters).
|
|
31
|
+
* Backed by Amazon Location Service; results carry only a display label and an opaque `placeId`.
|
|
32
|
+
* @example
|
|
33
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
34
|
+
* ```javascript
|
|
35
|
+
* import { OneHookClient, SearchPlacesCommand } from "onehook-api-client"; // ES Modules import
|
|
36
|
+
* // const { OneHookClient, SearchPlacesCommand } = require("onehook-api-client"); // CommonJS import
|
|
37
|
+
* const client = new OneHookClient(config);
|
|
38
|
+
* const input = { // SearchPlacesRequest
|
|
39
|
+
* q: "STRING_VALUE", // required
|
|
40
|
+
* lang: "STRING_VALUE",
|
|
41
|
+
* };
|
|
42
|
+
* const command = new SearchPlacesCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // SearchPlacesResponse
|
|
45
|
+
* // places: [ // PlaceSuggestionList // required
|
|
46
|
+
* // { // PlaceSuggestion
|
|
47
|
+
* // placeId: "STRING_VALUE", // required
|
|
48
|
+
* // label: "STRING_VALUE", // required
|
|
49
|
+
* // },
|
|
50
|
+
* // ],
|
|
51
|
+
* // };
|
|
52
|
+
*
|
|
53
|
+
* ```
|
|
54
|
+
*
|
|
55
|
+
* @param SearchPlacesCommandInput - {@link SearchPlacesCommandInput}
|
|
56
|
+
* @returns {@link SearchPlacesCommandOutput}
|
|
57
|
+
* @see {@link SearchPlacesCommandInput} for command's `input` shape.
|
|
58
|
+
* @see {@link SearchPlacesCommandOutput} for command's `response` shape.
|
|
59
|
+
* @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link BadRequestError} (client fault)
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link InternalServerError} (server fault)
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link OneHookServiceException}
|
|
66
|
+
* <p>Base exception class for all service exceptions from OneHook service.</p>
|
|
67
|
+
*
|
|
68
|
+
*
|
|
69
|
+
* @public
|
|
70
|
+
*/
|
|
71
|
+
export declare class SearchPlacesCommand extends SearchPlacesCommand_base {
|
|
72
|
+
/** @internal type navigation helper, not in runtime. */
|
|
73
|
+
protected static __types: {
|
|
74
|
+
api: {
|
|
75
|
+
input: SearchPlacesRequest;
|
|
76
|
+
output: SearchPlacesResponse;
|
|
77
|
+
};
|
|
78
|
+
sdk: {
|
|
79
|
+
input: SearchPlacesCommandInput;
|
|
80
|
+
output: SearchPlacesCommandOutput;
|
|
81
|
+
};
|
|
82
|
+
};
|
|
83
|
+
}
|