onehook-api-client 1.0.5 → 1.0.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (35) hide show
  1. package/README.md +49 -7
  2. package/dist-cjs/OneHook.js +12 -0
  3. package/dist-cjs/commands/GenerateDownloadUrlCommand.js +21 -0
  4. package/dist-cjs/commands/GetLivenessStatusCommand.js +21 -0
  5. package/dist-cjs/commands/GetParticipantRegistryCommand.js +21 -0
  6. package/dist-cjs/commands/ListMyDevicesCommand.js +21 -0
  7. package/dist-cjs/commands/RegisterDeviceCommand.js +21 -0
  8. package/dist-cjs/commands/RevokeDeviceCommand.js +21 -0
  9. package/dist-cjs/commands/index.js +6 -0
  10. package/dist-cjs/models/models_0.js +21 -1
  11. package/dist-cjs/protocols/Aws_restJson1.js +204 -2
  12. package/dist-es/OneHook.js +12 -0
  13. package/dist-es/commands/GenerateDownloadUrlCommand.js +17 -0
  14. package/dist-es/commands/GetLivenessStatusCommand.js +17 -0
  15. package/dist-es/commands/GetParticipantRegistryCommand.js +17 -0
  16. package/dist-es/commands/ListMyDevicesCommand.js +17 -0
  17. package/dist-es/commands/RegisterDeviceCommand.js +17 -0
  18. package/dist-es/commands/RevokeDeviceCommand.js +17 -0
  19. package/dist-es/commands/index.js +6 -0
  20. package/dist-es/models/models_0.js +19 -0
  21. package/dist-es/protocols/Aws_restJson1.js +191 -1
  22. package/dist-types/OneHook.d.ts +44 -0
  23. package/dist-types/OneHookClient.d.ts +8 -2
  24. package/dist-types/commands/GenerateDownloadUrlCommand.d.ts +82 -0
  25. package/dist-types/commands/GetLivenessStatusCommand.d.ts +77 -0
  26. package/dist-types/commands/GetMyProfileCommand.d.ts +4 -1
  27. package/dist-types/commands/GetParticipantRegistryCommand.d.ts +99 -0
  28. package/dist-types/commands/GetProfileCommand.d.ts +4 -1
  29. package/dist-types/commands/ListMyDevicesCommand.d.ts +89 -0
  30. package/dist-types/commands/RegisterDeviceCommand.d.ts +112 -0
  31. package/dist-types/commands/RevokeDeviceCommand.d.ts +81 -0
  32. package/dist-types/commands/index.d.ts +6 -0
  33. package/dist-types/models/models_0.d.ts +235 -0
  34. package/dist-types/protocols/Aws_restJson1.d.ts +54 -0
  35. package/package.json +1 -1
@@ -0,0 +1,82 @@
1
+ import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
2
+ import { MediaDownloadUrlRequest, MediaDownloadUrlResponse } 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 GenerateDownloadUrlCommand}.
14
+ */
15
+ export interface GenerateDownloadUrlCommandInput extends MediaDownloadUrlRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GenerateDownloadUrlCommand}.
21
+ */
22
+ export interface GenerateDownloadUrlCommandOutput extends MediaDownloadUrlResponse, __MetadataBearer {
23
+ }
24
+ declare const GenerateDownloadUrlCommand_base: {
25
+ new (input: GenerateDownloadUrlCommandInput): import("@smithy/smithy-client").CommandImpl<GenerateDownloadUrlCommandInput, GenerateDownloadUrlCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: GenerateDownloadUrlCommandInput): import("@smithy/smithy-client").CommandImpl<GenerateDownloadUrlCommandInput, GenerateDownloadUrlCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Issues a short-lived presigned GET URL for a private media object so authorized clients can
31
+ * display it. The media bucket blocks all public access, so this is the only read path. The
32
+ * caller must be authenticated; a caller may fetch a URL for their own media, or for another
33
+ * user's media only when that object is part of that user's moderation-visible profile.
34
+ * @example
35
+ * Use a bare-bones client and the command you need to make an API call.
36
+ * ```javascript
37
+ * import { OneHookClient, GenerateDownloadUrlCommand } from "onehook-api-client"; // ES Modules import
38
+ * // const { OneHookClient, GenerateDownloadUrlCommand } = require("onehook-api-client"); // CommonJS import
39
+ * const client = new OneHookClient(config);
40
+ * const input = { // MediaDownloadUrlRequest
41
+ * key: "STRING_VALUE", // required
42
+ * };
43
+ * const command = new GenerateDownloadUrlCommand(input);
44
+ * const response = await client.send(command);
45
+ * // { // MediaDownloadUrlResponse
46
+ * // downloadUrl: "STRING_VALUE", // required
47
+ * // expiresInSeconds: Number("int"), // required
48
+ * // };
49
+ *
50
+ * ```
51
+ *
52
+ * @param GenerateDownloadUrlCommandInput - {@link GenerateDownloadUrlCommandInput}
53
+ * @returns {@link GenerateDownloadUrlCommandOutput}
54
+ * @see {@link GenerateDownloadUrlCommandInput} for command's `input` shape.
55
+ * @see {@link GenerateDownloadUrlCommandOutput} for command's `response` shape.
56
+ * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
57
+ *
58
+ * @throws {@link BadRequestError} (client fault)
59
+ *
60
+ * @throws {@link NotFoundError} (client fault)
61
+ *
62
+ * @throws {@link InternalServerError} (server fault)
63
+ *
64
+ * @throws {@link OneHookServiceException}
65
+ * <p>Base exception class for all service exceptions from OneHook service.</p>
66
+ *
67
+ *
68
+ * @public
69
+ */
70
+ export declare class GenerateDownloadUrlCommand extends GenerateDownloadUrlCommand_base {
71
+ /** @internal type navigation helper, not in runtime. */
72
+ protected static __types: {
73
+ api: {
74
+ input: MediaDownloadUrlRequest;
75
+ output: MediaDownloadUrlResponse;
76
+ };
77
+ sdk: {
78
+ input: GenerateDownloadUrlCommandInput;
79
+ output: GenerateDownloadUrlCommandOutput;
80
+ };
81
+ };
82
+ }
@@ -0,0 +1,77 @@
1
+ import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
2
+ import { LivenessStatusResponse } 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 GetLivenessStatusCommand}.
14
+ */
15
+ export interface GetLivenessStatusCommandInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetLivenessStatusCommand}.
21
+ */
22
+ export interface GetLivenessStatusCommandOutput extends LivenessStatusResponse, __MetadataBearer {
23
+ }
24
+ declare const GetLivenessStatusCommand_base: {
25
+ new (input: GetLivenessStatusCommandInput): import("@smithy/smithy-client").CommandImpl<GetLivenessStatusCommandInput, GetLivenessStatusCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (...[input]: [] | [GetLivenessStatusCommandInput]): import("@smithy/smithy-client").CommandImpl<GetLivenessStatusCommandInput, GetLivenessStatusCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Returns the authoritative liveness verification status for the authenticated caller, so clients
31
+ * can render an accurate state (NONE / PENDING / APPROVED / REJECTED) that survives reloads —
32
+ * rather than inferring it from the boolean `verified` flag, which cannot distinguish
33
+ * "under review" from "rejected".
34
+ * @example
35
+ * Use a bare-bones client and the command you need to make an API call.
36
+ * ```javascript
37
+ * import { OneHookClient, GetLivenessStatusCommand } from "onehook-api-client"; // ES Modules import
38
+ * // const { OneHookClient, GetLivenessStatusCommand } = require("onehook-api-client"); // CommonJS import
39
+ * const client = new OneHookClient(config);
40
+ * const input = {};
41
+ * const command = new GetLivenessStatusCommand(input);
42
+ * const response = await client.send(command);
43
+ * // { // LivenessStatusResponse
44
+ * // status: "STRING_VALUE", // required
45
+ * // };
46
+ *
47
+ * ```
48
+ *
49
+ * @param GetLivenessStatusCommandInput - {@link GetLivenessStatusCommandInput}
50
+ * @returns {@link GetLivenessStatusCommandOutput}
51
+ * @see {@link GetLivenessStatusCommandInput} for command's `input` shape.
52
+ * @see {@link GetLivenessStatusCommandOutput} for command's `response` shape.
53
+ * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
54
+ *
55
+ * @throws {@link BadRequestError} (client fault)
56
+ *
57
+ * @throws {@link InternalServerError} (server fault)
58
+ *
59
+ * @throws {@link OneHookServiceException}
60
+ * <p>Base exception class for all service exceptions from OneHook service.</p>
61
+ *
62
+ *
63
+ * @public
64
+ */
65
+ export declare class GetLivenessStatusCommand extends GetLivenessStatusCommand_base {
66
+ /** @internal type navigation helper, not in runtime. */
67
+ protected static __types: {
68
+ api: {
69
+ input: {};
70
+ output: LivenessStatusResponse;
71
+ };
72
+ sdk: {
73
+ input: GetLivenessStatusCommandInput;
74
+ output: GetLivenessStatusCommandOutput;
75
+ };
76
+ };
77
+ }
@@ -70,6 +70,9 @@ declare const GetMyProfileCommand_base: {
70
70
  * // ],
71
71
  * // audioPrompt: "STRING_VALUE",
72
72
  * // moderationStatus: "STRING_VALUE",
73
+ * // fieldModerationStatus: { // StringMap
74
+ * // "<keys>": "STRING_VALUE",
75
+ * // },
73
76
  * // causes: [
74
77
  * // "STRING_VALUE",
75
78
  * // ],
@@ -82,7 +85,7 @@ declare const GetMyProfileCommand_base: {
82
85
  * // imageKey: "STRING_VALUE",
83
86
  * // },
84
87
  * // ],
85
- * // socialLinks: { // StringMap
88
+ * // socialLinks: {
86
89
  * // "<keys>": "STRING_VALUE",
87
90
  * // },
88
91
  * // openers: [ // OpenerList
@@ -0,0 +1,99 @@
1
+ import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
2
+ import { GetParticipantRegistryRequest, GetParticipantRegistryResponse } 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 GetParticipantRegistryCommand}.
14
+ */
15
+ export interface GetParticipantRegistryCommandInput extends GetParticipantRegistryRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetParticipantRegistryCommand}.
21
+ */
22
+ export interface GetParticipantRegistryCommandOutput extends GetParticipantRegistryResponse, __MetadataBearer {
23
+ }
24
+ declare const GetParticipantRegistryCommand_base: {
25
+ new (input: GetParticipantRegistryCommandInput): import("@smithy/smithy-client").CommandImpl<GetParticipantRegistryCommandInput, GetParticipantRegistryCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: GetParticipantRegistryCommandInput): import("@smithy/smithy-client").CommandImpl<GetParticipantRegistryCommandInput, GetParticipantRegistryCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Fetch a match participant's device registry so the caller can encrypt to every one of the
31
+ * participant's devices. Authorized by a shared `matchId` (same gate as ClaimPreKeyBundle);
32
+ * exposes only public key material.
33
+ * @example
34
+ * Use a bare-bones client and the command you need to make an API call.
35
+ * ```javascript
36
+ * import { OneHookClient, GetParticipantRegistryCommand } from "onehook-api-client"; // ES Modules import
37
+ * // const { OneHookClient, GetParticipantRegistryCommand } = require("onehook-api-client"); // CommonJS import
38
+ * const client = new OneHookClient(config);
39
+ * const input = { // GetParticipantRegistryRequest
40
+ * userId: "STRING_VALUE", // required
41
+ * matchId: "STRING_VALUE", // required
42
+ * };
43
+ * const command = new GetParticipantRegistryCommand(input);
44
+ * const response = await client.send(command);
45
+ * // { // GetParticipantRegistryResponse
46
+ * // userId: "STRING_VALUE", // required
47
+ * // devices: [ // DeviceList // required
48
+ * // { // Device
49
+ * // deviceId: "STRING_VALUE", // required
50
+ * // publicKey: "STRING_VALUE", // required
51
+ * // platform: "IOS" || "ANDROID" || "WEB", // required
52
+ * // displayName: "STRING_VALUE",
53
+ * // maxEnvelopeVersion: Number("int"), // required
54
+ * // createdAt: Number("long"), // required
55
+ * // lastSeenAt: Number("long"), // required
56
+ * // current: true || false, // required
57
+ * // },
58
+ * // ],
59
+ * // accountHistoryKey: { // AccountHistoryKey
60
+ * // keyId: "STRING_VALUE", // required
61
+ * // publicKey: "STRING_VALUE", // required
62
+ * // },
63
+ * // };
64
+ *
65
+ * ```
66
+ *
67
+ * @param GetParticipantRegistryCommandInput - {@link GetParticipantRegistryCommandInput}
68
+ * @returns {@link GetParticipantRegistryCommandOutput}
69
+ * @see {@link GetParticipantRegistryCommandInput} for command's `input` shape.
70
+ * @see {@link GetParticipantRegistryCommandOutput} for command's `response` shape.
71
+ * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
72
+ *
73
+ * @throws {@link BadRequestError} (client fault)
74
+ *
75
+ * @throws {@link ForbiddenError} (client fault)
76
+ *
77
+ * @throws {@link NotFoundError} (client fault)
78
+ *
79
+ * @throws {@link InternalServerError} (server fault)
80
+ *
81
+ * @throws {@link OneHookServiceException}
82
+ * <p>Base exception class for all service exceptions from OneHook service.</p>
83
+ *
84
+ *
85
+ * @public
86
+ */
87
+ export declare class GetParticipantRegistryCommand extends GetParticipantRegistryCommand_base {
88
+ /** @internal type navigation helper, not in runtime. */
89
+ protected static __types: {
90
+ api: {
91
+ input: GetParticipantRegistryRequest;
92
+ output: GetParticipantRegistryResponse;
93
+ };
94
+ sdk: {
95
+ input: GetParticipantRegistryCommandInput;
96
+ output: GetParticipantRegistryCommandOutput;
97
+ };
98
+ };
99
+ }
@@ -71,6 +71,9 @@ declare const GetProfileCommand_base: {
71
71
  * // ],
72
72
  * // audioPrompt: "STRING_VALUE",
73
73
  * // moderationStatus: "STRING_VALUE",
74
+ * // fieldModerationStatus: { // StringMap
75
+ * // "<keys>": "STRING_VALUE",
76
+ * // },
74
77
  * // causes: [
75
78
  * // "STRING_VALUE",
76
79
  * // ],
@@ -83,7 +86,7 @@ declare const GetProfileCommand_base: {
83
86
  * // imageKey: "STRING_VALUE",
84
87
  * // },
85
88
  * // ],
86
- * // socialLinks: { // StringMap
89
+ * // socialLinks: {
87
90
  * // "<keys>": "STRING_VALUE",
88
91
  * // },
89
92
  * // openers: [ // OpenerList
@@ -0,0 +1,89 @@
1
+ import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
2
+ import { ListMyDevicesRequest, ListMyDevicesResponse } 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 ListMyDevicesCommand}.
14
+ */
15
+ export interface ListMyDevicesCommandInput extends ListMyDevicesRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ListMyDevicesCommand}.
21
+ */
22
+ export interface ListMyDevicesCommandOutput extends ListMyDevicesResponse, __MetadataBearer {
23
+ }
24
+ declare const ListMyDevicesCommand_base: {
25
+ new (input: ListMyDevicesCommandInput): import("@smithy/smithy-client").CommandImpl<ListMyDevicesCommandInput, ListMyDevicesCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (...[input]: [] | [ListMyDevicesCommandInput]): import("@smithy/smithy-client").CommandImpl<ListMyDevicesCommandInput, ListMyDevicesCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * List the authenticated caller's own registered devices (and account history key, if any).
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { OneHookClient, ListMyDevicesCommand } from "onehook-api-client"; // ES Modules import
35
+ * // const { OneHookClient, ListMyDevicesCommand } = require("onehook-api-client"); // CommonJS import
36
+ * const client = new OneHookClient(config);
37
+ * const input = {};
38
+ * const command = new ListMyDevicesCommand(input);
39
+ * const response = await client.send(command);
40
+ * // { // ListMyDevicesResponse
41
+ * // devices: [ // DeviceList // required
42
+ * // { // Device
43
+ * // deviceId: "STRING_VALUE", // required
44
+ * // publicKey: "STRING_VALUE", // required
45
+ * // platform: "IOS" || "ANDROID" || "WEB", // required
46
+ * // displayName: "STRING_VALUE",
47
+ * // maxEnvelopeVersion: Number("int"), // required
48
+ * // createdAt: Number("long"), // required
49
+ * // lastSeenAt: Number("long"), // required
50
+ * // current: true || false, // required
51
+ * // },
52
+ * // ],
53
+ * // accountHistoryKey: { // AccountHistoryKey
54
+ * // keyId: "STRING_VALUE", // required
55
+ * // publicKey: "STRING_VALUE", // required
56
+ * // },
57
+ * // };
58
+ *
59
+ * ```
60
+ *
61
+ * @param ListMyDevicesCommandInput - {@link ListMyDevicesCommandInput}
62
+ * @returns {@link ListMyDevicesCommandOutput}
63
+ * @see {@link ListMyDevicesCommandInput} for command's `input` shape.
64
+ * @see {@link ListMyDevicesCommandOutput} for command's `response` shape.
65
+ * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
66
+ *
67
+ * @throws {@link ForbiddenError} (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 ListMyDevicesCommand extends ListMyDevicesCommand_base {
78
+ /** @internal type navigation helper, not in runtime. */
79
+ protected static __types: {
80
+ api: {
81
+ input: {};
82
+ output: ListMyDevicesResponse;
83
+ };
84
+ sdk: {
85
+ input: ListMyDevicesCommandInput;
86
+ output: ListMyDevicesCommandOutput;
87
+ };
88
+ };
89
+ }
@@ -0,0 +1,112 @@
1
+ import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
2
+ import { RegisterDeviceRequest, RegisterDeviceResponse } 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 RegisterDeviceCommand}.
14
+ */
15
+ export interface RegisterDeviceCommandInput extends RegisterDeviceRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link RegisterDeviceCommand}.
21
+ */
22
+ export interface RegisterDeviceCommandOutput extends RegisterDeviceResponse, __MetadataBearer {
23
+ }
24
+ declare const RegisterDeviceCommand_base: {
25
+ new (input: RegisterDeviceCommandInput): import("@smithy/smithy-client").CommandImpl<RegisterDeviceCommandInput, RegisterDeviceCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: RegisterDeviceCommandInput): import("@smithy/smithy-client").CommandImpl<RegisterDeviceCommandInput, RegisterDeviceCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Register (or refresh) the calling device in the authenticated user's device registry.
31
+ *
32
+ * Idempotent on `deviceId`: re-registering the same device updates its metadata and
33
+ * `lastSeenAt`. The newly-registered device becomes the `current` device; sibling devices
34
+ * are demoted. A user may have at most \{@code 10\} active devices.
35
+ *
36
+ * Optionally carries the account's immutable history key. The history key is FIRST-WRITE-WINS:
37
+ * the first device to register it owns it, and later/conflicting values are NEVER overwritten.
38
+ * When a conflicting key is submitted, the response echoes the stored key and sets
39
+ * `ownsAccountHistoryKey = false` so the client learns it does not own the account history key.
40
+ * @example
41
+ * Use a bare-bones client and the command you need to make an API call.
42
+ * ```javascript
43
+ * import { OneHookClient, RegisterDeviceCommand } from "onehook-api-client"; // ES Modules import
44
+ * // const { OneHookClient, RegisterDeviceCommand } = require("onehook-api-client"); // CommonJS import
45
+ * const client = new OneHookClient(config);
46
+ * const input = { // RegisterDeviceRequest
47
+ * deviceId: "STRING_VALUE", // required
48
+ * publicKey: "STRING_VALUE", // required
49
+ * platform: "IOS" || "ANDROID" || "WEB", // required
50
+ * displayName: "STRING_VALUE",
51
+ * maxEnvelopeVersion: Number("int"), // required
52
+ * accountHistoryKey: { // AccountHistoryKey
53
+ * keyId: "STRING_VALUE", // required
54
+ * publicKey: "STRING_VALUE", // required
55
+ * },
56
+ * };
57
+ * const command = new RegisterDeviceCommand(input);
58
+ * const response = await client.send(command);
59
+ * // { // RegisterDeviceResponse
60
+ * // device: { // Device
61
+ * // deviceId: "STRING_VALUE", // required
62
+ * // publicKey: "STRING_VALUE", // required
63
+ * // platform: "IOS" || "ANDROID" || "WEB", // required
64
+ * // displayName: "STRING_VALUE",
65
+ * // maxEnvelopeVersion: Number("int"), // required
66
+ * // createdAt: Number("long"), // required
67
+ * // lastSeenAt: Number("long"), // required
68
+ * // current: true || false, // required
69
+ * // },
70
+ * // accountHistoryKey: { // AccountHistoryKey
71
+ * // keyId: "STRING_VALUE", // required
72
+ * // publicKey: "STRING_VALUE", // required
73
+ * // },
74
+ * // ownsAccountHistoryKey: true || false, // required
75
+ * // };
76
+ *
77
+ * ```
78
+ *
79
+ * @param RegisterDeviceCommandInput - {@link RegisterDeviceCommandInput}
80
+ * @returns {@link RegisterDeviceCommandOutput}
81
+ * @see {@link RegisterDeviceCommandInput} for command's `input` shape.
82
+ * @see {@link RegisterDeviceCommandOutput} for command's `response` shape.
83
+ * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
84
+ *
85
+ * @throws {@link BadRequestError} (client fault)
86
+ *
87
+ * @throws {@link ForbiddenError} (client fault)
88
+ *
89
+ * @throws {@link DeviceLimitError} (client fault)
90
+ * Returned when registering a new device would exceed the per-user active-device cap.
91
+ *
92
+ * @throws {@link InternalServerError} (server fault)
93
+ *
94
+ * @throws {@link OneHookServiceException}
95
+ * <p>Base exception class for all service exceptions from OneHook service.</p>
96
+ *
97
+ *
98
+ * @public
99
+ */
100
+ export declare class RegisterDeviceCommand extends RegisterDeviceCommand_base {
101
+ /** @internal type navigation helper, not in runtime. */
102
+ protected static __types: {
103
+ api: {
104
+ input: RegisterDeviceRequest;
105
+ output: RegisterDeviceResponse;
106
+ };
107
+ sdk: {
108
+ input: RegisterDeviceCommandInput;
109
+ output: RegisterDeviceCommandOutput;
110
+ };
111
+ };
112
+ }
@@ -0,0 +1,81 @@
1
+ import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
2
+ import { RevokeDeviceRequest, RevokeDeviceResponse } 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 RevokeDeviceCommand}.
14
+ */
15
+ export interface RevokeDeviceCommandInput extends RevokeDeviceRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link RevokeDeviceCommand}.
21
+ */
22
+ export interface RevokeDeviceCommandOutput extends RevokeDeviceResponse, __MetadataBearer {
23
+ }
24
+ declare const RevokeDeviceCommand_base: {
25
+ new (input: RevokeDeviceCommandInput): import("@smithy/smithy-client").CommandImpl<RevokeDeviceCommandInput, RevokeDeviceCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: RevokeDeviceCommandInput): import("@smithy/smithy-client").CommandImpl<RevokeDeviceCommandInput, RevokeDeviceCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Revoke one of the authenticated caller's own devices, removing it from the registry.
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { OneHookClient, RevokeDeviceCommand } from "onehook-api-client"; // ES Modules import
35
+ * // const { OneHookClient, RevokeDeviceCommand } = require("onehook-api-client"); // CommonJS import
36
+ * const client = new OneHookClient(config);
37
+ * const input = { // RevokeDeviceRequest
38
+ * deviceId: "STRING_VALUE", // required
39
+ * };
40
+ * const command = new RevokeDeviceCommand(input);
41
+ * const response = await client.send(command);
42
+ * // { // RevokeDeviceResponse
43
+ * // deviceId: "STRING_VALUE", // required
44
+ * // revoked: true || false, // required
45
+ * // };
46
+ *
47
+ * ```
48
+ *
49
+ * @param RevokeDeviceCommandInput - {@link RevokeDeviceCommandInput}
50
+ * @returns {@link RevokeDeviceCommandOutput}
51
+ * @see {@link RevokeDeviceCommandInput} for command's `input` shape.
52
+ * @see {@link RevokeDeviceCommandOutput} for command's `response` shape.
53
+ * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
54
+ *
55
+ * @throws {@link BadRequestError} (client fault)
56
+ *
57
+ * @throws {@link ForbiddenError} (client fault)
58
+ *
59
+ * @throws {@link NotFoundError} (client fault)
60
+ *
61
+ * @throws {@link InternalServerError} (server fault)
62
+ *
63
+ * @throws {@link OneHookServiceException}
64
+ * <p>Base exception class for all service exceptions from OneHook service.</p>
65
+ *
66
+ *
67
+ * @public
68
+ */
69
+ export declare class RevokeDeviceCommand extends RevokeDeviceCommand_base {
70
+ /** @internal type navigation helper, not in runtime. */
71
+ protected static __types: {
72
+ api: {
73
+ input: RevokeDeviceRequest;
74
+ output: RevokeDeviceResponse;
75
+ };
76
+ sdk: {
77
+ input: RevokeDeviceCommandInput;
78
+ output: RevokeDeviceCommandOutput;
79
+ };
80
+ };
81
+ }
@@ -1,5 +1,9 @@
1
1
  export * from "./ClaimPreKeyBundleCommand";
2
2
  export * from "./DeleteMatchMessagesCommand";
3
+ export * from "./GetParticipantRegistryCommand";
4
+ export * from "./ListMyDevicesCommand";
5
+ export * from "./RegisterDeviceCommand";
6
+ export * from "./RevokeDeviceCommand";
3
7
  export * from "./UploadPreKeysCommand";
4
8
  export * from "./AuthSocialCommand";
5
9
  export * from "./GenerateInviteCommand";
@@ -24,7 +28,9 @@ export * from "./UpdatePreferencesCommand";
24
28
  export * from "./CompleteLivenessSessionCommand";
25
29
  export * from "./CreateLivenessSessionCommand";
26
30
  export * from "./DeleteProfileCommand";
31
+ export * from "./GenerateDownloadUrlCommand";
27
32
  export * from "./GenerateUploadUrlCommand";
33
+ export * from "./GetLivenessStatusCommand";
28
34
  export * from "./GetMyProfileCommand";
29
35
  export * from "./GetProfileCommand";
30
36
  export * from "./UpdateProfileCommand";