onehook-api-client 1.0.31 → 1.0.33
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/GetBirthDateStatusCommand.js +21 -0
- package/dist-cjs/commands/GetPlaceCommand.js +21 -0
- package/dist-cjs/commands/GetPreservationHoldCommand.js +21 -0
- package/dist-cjs/commands/RemoveSuggestionCommand.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 +234 -4
- package/dist-cjs/telemetry/index.js +5 -3
- package/dist-es/OneHook.js +14 -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/RemoveSuggestionCommand.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 +217 -1
- package/dist-es/telemetry/index.js +5 -3
- package/dist-types/OneHook.d.ts +50 -0
- package/dist-types/OneHookClient.d.ts +9 -2
- package/dist-types/commands/CorrectBirthDateCommand.d.ts +1 -1
- package/dist-types/commands/GetBirthDateStatusCommand.d.ts +89 -0
- package/dist-types/commands/GetMyProfileCommand.d.ts +1 -0
- package/dist-types/commands/GetPlaceCommand.d.ts +84 -0
- package/dist-types/commands/GetPreferencesCommand.d.ts +5 -0
- package/dist-types/commands/GetPreservationHoldCommand.d.ts +87 -0
- package/dist-types/commands/GetProfileCommand.d.ts +1 -0
- package/dist-types/commands/RecordSuggestionCommand.d.ts +6 -5
- package/dist-types/commands/RemoveSuggestionCommand.d.ts +72 -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 +1 -1
- package/dist-types/commands/index.d.ts +7 -0
- package/dist-types/models/models_0.d.ts +237 -11
- 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 +20 -4
|
@@ -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
|
+
}
|
|
@@ -112,6 +112,7 @@ declare const GetMyProfileCommand_base: {
|
|
|
112
112
|
* // timeZone: "STRING_VALUE",
|
|
113
113
|
* // latitude: Number("double"),
|
|
114
114
|
* // longitude: Number("double"),
|
|
115
|
+
* // placeName: "STRING_VALUE",
|
|
115
116
|
* // provisional: true || false,
|
|
116
117
|
* // },
|
|
117
118
|
* // birthDateOnFile: true || false,
|
|
@@ -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
|
+
}
|
|
@@ -42,6 +42,11 @@ declare const GetPreferencesCommand_base: {
|
|
|
42
42
|
* const response = await client.send(command);
|
|
43
43
|
* // { // UserPreferencesResponse
|
|
44
44
|
* // userId: "STRING_VALUE", // required
|
|
45
|
+
* // currentSuggestion: { // CurrentSuggestion
|
|
46
|
+
* // suggestionId: "STRING_VALUE", // required
|
|
47
|
+
* // reasoning: "STRING_VALUE", // required
|
|
48
|
+
* // createdAt: "STRING_VALUE", // required
|
|
49
|
+
* // },
|
|
45
50
|
* // minAge: Number("int"),
|
|
46
51
|
* // maxAge: Number("int"),
|
|
47
52
|
* // maxDistanceKm: Number("int"),
|
|
@@ -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
|
+
}
|
|
@@ -113,6 +113,7 @@ declare const GetProfileCommand_base: {
|
|
|
113
113
|
* // timeZone: "STRING_VALUE",
|
|
114
114
|
* // latitude: Number("double"),
|
|
115
115
|
* // longitude: Number("double"),
|
|
116
|
+
* // placeName: "STRING_VALUE",
|
|
116
117
|
* // provisional: true || false,
|
|
117
118
|
* // },
|
|
118
119
|
* // birthDateOnFile: true || false,
|
|
@@ -27,11 +27,12 @@ declare const RecordSuggestionCommand_base: {
|
|
|
27
27
|
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
28
28
|
};
|
|
29
29
|
/**
|
|
30
|
-
* Records
|
|
31
|
-
*
|
|
32
|
-
*
|
|
33
|
-
* `
|
|
34
|
-
*
|
|
30
|
+
* Records the caller's OneHook suggestion: OneHook AI's analysis of who they are looking for, after they
|
|
31
|
+
* explicitly asked. A member has ONE such suggestion; a new one replaces the current one. It is never
|
|
32
|
+
* removed otherwise, except by `RemoveSuggestion` or account deletion. Matching candidates appear in
|
|
33
|
+
* `Discover` as `MR_ONEHOOK` cards carrying `reasoning`; the current one is in `GetPreferences`
|
|
34
|
+
* (`currentSuggestion`). Super and above, from the session's tier (403 `PREMIUM_REQUIRED` otherwise);
|
|
35
|
+
* 503 when the embedding model is unavailable. The prompt is never logged or returned.
|
|
35
36
|
* @example
|
|
36
37
|
* Use a bare-bones client and the command you need to make an API call.
|
|
37
38
|
* ```javascript
|
|
@@ -0,0 +1,72 @@
|
|
|
1
|
+
import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
|
|
2
|
+
import { RemoveSuggestionRequest, RemoveSuggestionResponse } 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 RemoveSuggestionCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface RemoveSuggestionCommandInput extends RemoveSuggestionRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link RemoveSuggestionCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface RemoveSuggestionCommandOutput extends RemoveSuggestionResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const RemoveSuggestionCommand_base: {
|
|
25
|
+
new (input: RemoveSuggestionCommandInput): import("@smithy/smithy-client").CommandImpl<RemoveSuggestionCommandInput, RemoveSuggestionCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (...[input]: [] | [RemoveSuggestionCommandInput]): import("@smithy/smithy-client").CommandImpl<RemoveSuggestionCommandInput, RemoveSuggestionCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Removes the caller's OneHook suggestion. Idempotent: 204 whether or not one existed.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { OneHookClient, RemoveSuggestionCommand } from "onehook-api-client"; // ES Modules import
|
|
35
|
+
* // const { OneHookClient, RemoveSuggestionCommand } = require("onehook-api-client"); // CommonJS import
|
|
36
|
+
* const client = new OneHookClient(config);
|
|
37
|
+
* const input = {};
|
|
38
|
+
* const command = new RemoveSuggestionCommand(input);
|
|
39
|
+
* const response = await client.send(command);
|
|
40
|
+
* // {};
|
|
41
|
+
*
|
|
42
|
+
* ```
|
|
43
|
+
*
|
|
44
|
+
* @param RemoveSuggestionCommandInput - {@link RemoveSuggestionCommandInput}
|
|
45
|
+
* @returns {@link RemoveSuggestionCommandOutput}
|
|
46
|
+
* @see {@link RemoveSuggestionCommandInput} for command's `input` shape.
|
|
47
|
+
* @see {@link RemoveSuggestionCommandOutput} for command's `response` shape.
|
|
48
|
+
* @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
|
|
49
|
+
*
|
|
50
|
+
* @throws {@link BadRequestError} (client fault)
|
|
51
|
+
*
|
|
52
|
+
* @throws {@link InternalServerError} (server fault)
|
|
53
|
+
*
|
|
54
|
+
* @throws {@link OneHookServiceException}
|
|
55
|
+
* <p>Base exception class for all service exceptions from OneHook service.</p>
|
|
56
|
+
*
|
|
57
|
+
*
|
|
58
|
+
* @public
|
|
59
|
+
*/
|
|
60
|
+
export declare class RemoveSuggestionCommand extends RemoveSuggestionCommand_base {
|
|
61
|
+
/** @internal type navigation helper, not in runtime. */
|
|
62
|
+
protected static __types: {
|
|
63
|
+
api: {
|
|
64
|
+
input: {};
|
|
65
|
+
output: {};
|
|
66
|
+
};
|
|
67
|
+
sdk: {
|
|
68
|
+
input: RemoveSuggestionCommandInput;
|
|
69
|
+
output: RemoveSuggestionCommandOutput;
|
|
70
|
+
};
|
|
71
|
+
};
|
|
72
|
+
}
|
|
@@ -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
|
+
}
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
|
|
2
|
+
import { SetPreservationHoldRequest, SetPreservationHoldResponse } 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 SetPreservationHoldCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface SetPreservationHoldCommandInput extends SetPreservationHoldRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link SetPreservationHoldCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface SetPreservationHoldCommandOutput extends SetPreservationHoldResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const SetPreservationHoldCommand_base: {
|
|
25
|
+
new (input: SetPreservationHoldCommandInput): import("@smithy/smithy-client").CommandImpl<SetPreservationHoldCommandInput, SetPreservationHoldCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: SetPreservationHoldCommandInput): import("@smithy/smithy-client").CommandImpl<SetPreservationHoldCommandInput, SetPreservationHoldCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Sets or releases a legal preservation hold on a member, for suspected child sexual abuse or
|
|
31
|
+
* exploitation and other legal-hold cases (IT Rules 2021 r.3(1)(g)). Internal, IAM-authorized
|
|
32
|
+
* (SigV4) - NOT the Cognito user-pool authorizer - so the only caller is the admin portal's
|
|
33
|
+
* moderation module (its per-module invoke role). The write is optimistic-concurrency guarded: pass
|
|
34
|
+
* the `expectedVersion` read from GetPreservationHold and a concurrent change returns 409. Emits a
|
|
35
|
+
* `PreservationHoldChanged` domain event through the Identity transactional outbox. No free text is
|
|
36
|
+
* accepted - the reason is a CODE (one of CHILD_SAFETY, LEGAL_REQUEST, OTHER_LEGAL).
|
|
37
|
+
*
|
|
38
|
+
* When activating, `until` defaults to now + 180 days and can only be extended FORWARD. Releasing
|
|
39
|
+
* (`active=false`) clears the hold so the deferred deletion can complete.
|
|
40
|
+
* @example
|
|
41
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
42
|
+
* ```javascript
|
|
43
|
+
* import { OneHookClient, SetPreservationHoldCommand } from "onehook-api-client"; // ES Modules import
|
|
44
|
+
* // const { OneHookClient, SetPreservationHoldCommand } = require("onehook-api-client"); // CommonJS import
|
|
45
|
+
* const client = new OneHookClient(config);
|
|
46
|
+
* const input = { // SetPreservationHoldRequest
|
|
47
|
+
* userId: "STRING_VALUE", // required
|
|
48
|
+
* active: true || false, // required
|
|
49
|
+
* reasonCode: "STRING_VALUE", // required
|
|
50
|
+
* until: Number("long"),
|
|
51
|
+
* actor: "STRING_VALUE", // required
|
|
52
|
+
* caseRef: "STRING_VALUE",
|
|
53
|
+
* expectedVersion: Number("int"),
|
|
54
|
+
* };
|
|
55
|
+
* const command = new SetPreservationHoldCommand(input);
|
|
56
|
+
* const response = await client.send(command);
|
|
57
|
+
* // { // SetPreservationHoldResponse
|
|
58
|
+
* // active: true || false, // required
|
|
59
|
+
* // until: Number("long"),
|
|
60
|
+
* // version: Number("int"), // required
|
|
61
|
+
* // reasonCode: "STRING_VALUE",
|
|
62
|
+
* // };
|
|
63
|
+
*
|
|
64
|
+
* ```
|
|
65
|
+
*
|
|
66
|
+
* @param SetPreservationHoldCommandInput - {@link SetPreservationHoldCommandInput}
|
|
67
|
+
* @returns {@link SetPreservationHoldCommandOutput}
|
|
68
|
+
* @see {@link SetPreservationHoldCommandInput} for command's `input` shape.
|
|
69
|
+
* @see {@link SetPreservationHoldCommandOutput} for command's `response` shape.
|
|
70
|
+
* @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link BadRequestError} (client fault)
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link NotFoundError} (client fault)
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link ConflictError} (client fault)
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link InternalServerError} (server fault)
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link OneHookServiceException}
|
|
81
|
+
* <p>Base exception class for all service exceptions from OneHook service.</p>
|
|
82
|
+
*
|
|
83
|
+
*
|
|
84
|
+
* @public
|
|
85
|
+
*/
|
|
86
|
+
export declare class SetPreservationHoldCommand extends SetPreservationHoldCommand_base {
|
|
87
|
+
/** @internal type navigation helper, not in runtime. */
|
|
88
|
+
protected static __types: {
|
|
89
|
+
api: {
|
|
90
|
+
input: SetPreservationHoldRequest;
|
|
91
|
+
output: SetPreservationHoldResponse;
|
|
92
|
+
};
|
|
93
|
+
sdk: {
|
|
94
|
+
input: SetPreservationHoldCommandInput;
|
|
95
|
+
output: SetPreservationHoldCommandOutput;
|
|
96
|
+
};
|
|
97
|
+
};
|
|
98
|
+
}
|