onehook-api-client 1.0.0
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/LICENSE +201 -0
- package/dist-cjs/OneHookService.js +83 -0
- package/dist-cjs/OneHookServiceClient.js +43 -0
- package/dist-cjs/auth/httpAuthExtensionConfiguration.js +35 -0
- package/dist-cjs/auth/httpAuthSchemeProvider.js +35 -0
- package/dist-cjs/commands/AuthSocialCommand.js +21 -0
- package/dist-cjs/commands/ClaimPreKeyBundleCommand.js +21 -0
- package/dist-cjs/commands/CompleteLivenessSessionCommand.js +21 -0
- package/dist-cjs/commands/CompleteOnboardingCommand.js +21 -0
- package/dist-cjs/commands/CreateLivenessSessionCommand.js +21 -0
- package/dist-cjs/commands/DeleteMatchMessagesCommand.js +21 -0
- package/dist-cjs/commands/DeleteProfileCommand.js +21 -0
- package/dist-cjs/commands/DiscoverCommand.js +21 -0
- package/dist-cjs/commands/GenerateInviteCommand.js +21 -0
- package/dist-cjs/commands/GenerateUploadUrlCommand.js +21 -0
- package/dist-cjs/commands/GetMatchCommand.js +21 -0
- package/dist-cjs/commands/GetMyProfileCommand.js +21 -0
- package/dist-cjs/commands/GetPreferencesCommand.js +21 -0
- package/dist-cjs/commands/GetProfileCommand.js +21 -0
- package/dist-cjs/commands/GetStateCommand.js +21 -0
- package/dist-cjs/commands/GetUserByEmailCommand.js +21 -0
- package/dist-cjs/commands/GetUserCommand.js +21 -0
- package/dist-cjs/commands/IndexLocationCommand.js +21 -0
- package/dist-cjs/commands/InitUserCommand.js +21 -0
- package/dist-cjs/commands/LinkEmailCommand.js +21 -0
- package/dist-cjs/commands/LinkSocialCommand.js +21 -0
- package/dist-cjs/commands/RegisterPhoneCommand.js +21 -0
- package/dist-cjs/commands/RemoveLocationCommand.js +21 -0
- package/dist-cjs/commands/RequestEmailOtpCommand.js +21 -0
- package/dist-cjs/commands/RequestPhoneOtpCommand.js +21 -0
- package/dist-cjs/commands/RequestPhoneUpdateOtpCommand.js +21 -0
- package/dist-cjs/commands/SwipeCommand.js +21 -0
- package/dist-cjs/commands/UnhookCommand.js +21 -0
- package/dist-cjs/commands/UnlinkSocialCommand.js +21 -0
- package/dist-cjs/commands/UpdateEntitlementsCommand.js +21 -0
- package/dist-cjs/commands/UpdatePhoneNumberCommand.js +21 -0
- package/dist-cjs/commands/UpdatePreferencesCommand.js +21 -0
- package/dist-cjs/commands/UpdateProfileCommand.js +21 -0
- package/dist-cjs/commands/UpgradeUserCommand.js +21 -0
- package/dist-cjs/commands/UploadPreKeysCommand.js +21 -0
- package/dist-cjs/commands/ValidateInviteCommand.js +21 -0
- package/dist-cjs/commands/index.js +39 -0
- package/dist-cjs/extensionConfiguration.js +2 -0
- package/dist-cjs/graphql/types.js +11 -0
- package/dist-cjs/index.js +10 -0
- package/dist-cjs/models/OneHookServiceServiceException.js +12 -0
- package/dist-cjs/models/index.js +4 -0
- package/dist-cjs/models/models_0.js +60 -0
- package/dist-cjs/protocols/Aws_restJson1.js +1349 -0
- package/dist-cjs/runtimeConfig.browser.js +32 -0
- package/dist-cjs/runtimeConfig.js +37 -0
- package/dist-cjs/runtimeConfig.native.js +15 -0
- package/dist-cjs/runtimeConfig.shared.js +29 -0
- package/dist-cjs/runtimeExtensions.js +22 -0
- package/dist-es/OneHookService.js +79 -0
- package/dist-es/OneHookServiceClient.js +39 -0
- package/dist-es/auth/httpAuthExtensionConfiguration.js +30 -0
- package/dist-es/auth/httpAuthSchemeProvider.js +29 -0
- package/dist-es/commands/AuthSocialCommand.js +17 -0
- package/dist-es/commands/ClaimPreKeyBundleCommand.js +17 -0
- package/dist-es/commands/CompleteLivenessSessionCommand.js +17 -0
- package/dist-es/commands/CompleteOnboardingCommand.js +17 -0
- package/dist-es/commands/CreateLivenessSessionCommand.js +17 -0
- package/dist-es/commands/DeleteMatchMessagesCommand.js +17 -0
- package/dist-es/commands/DeleteProfileCommand.js +17 -0
- package/dist-es/commands/DiscoverCommand.js +17 -0
- package/dist-es/commands/GenerateInviteCommand.js +17 -0
- package/dist-es/commands/GenerateUploadUrlCommand.js +17 -0
- package/dist-es/commands/GetMatchCommand.js +17 -0
- package/dist-es/commands/GetMyProfileCommand.js +17 -0
- package/dist-es/commands/GetPreferencesCommand.js +17 -0
- package/dist-es/commands/GetProfileCommand.js +17 -0
- package/dist-es/commands/GetStateCommand.js +17 -0
- package/dist-es/commands/GetUserByEmailCommand.js +17 -0
- package/dist-es/commands/GetUserCommand.js +17 -0
- package/dist-es/commands/IndexLocationCommand.js +17 -0
- package/dist-es/commands/InitUserCommand.js +17 -0
- package/dist-es/commands/LinkEmailCommand.js +17 -0
- package/dist-es/commands/LinkSocialCommand.js +17 -0
- package/dist-es/commands/RegisterPhoneCommand.js +17 -0
- package/dist-es/commands/RemoveLocationCommand.js +17 -0
- package/dist-es/commands/RequestEmailOtpCommand.js +17 -0
- package/dist-es/commands/RequestPhoneOtpCommand.js +17 -0
- package/dist-es/commands/RequestPhoneUpdateOtpCommand.js +17 -0
- package/dist-es/commands/SwipeCommand.js +17 -0
- package/dist-es/commands/UnhookCommand.js +17 -0
- package/dist-es/commands/UnlinkSocialCommand.js +17 -0
- package/dist-es/commands/UpdateEntitlementsCommand.js +17 -0
- package/dist-es/commands/UpdatePhoneNumberCommand.js +17 -0
- package/dist-es/commands/UpdatePreferencesCommand.js +17 -0
- package/dist-es/commands/UpdateProfileCommand.js +17 -0
- package/dist-es/commands/UpgradeUserCommand.js +17 -0
- package/dist-es/commands/UploadPreKeysCommand.js +17 -0
- package/dist-es/commands/ValidateInviteCommand.js +17 -0
- package/dist-es/commands/index.js +36 -0
- package/dist-es/extensionConfiguration.js +1 -0
- package/dist-es/graphql/types.js +8 -0
- package/dist-es/index.js +5 -0
- package/dist-es/models/OneHookServiceServiceException.js +8 -0
- package/dist-es/models/index.js +1 -0
- package/dist-es/models/models_0.js +53 -0
- package/dist-es/protocols/Aws_restJson1.js +1273 -0
- package/dist-es/runtimeConfig.browser.js +27 -0
- package/dist-es/runtimeConfig.js +32 -0
- package/dist-es/runtimeConfig.native.js +11 -0
- package/dist-es/runtimeConfig.shared.js +25 -0
- package/dist-es/runtimeExtensions.js +18 -0
- package/dist-types/OneHookService.d.ts +267 -0
- package/dist-types/OneHookServiceClient.d.ts +179 -0
- package/dist-types/auth/httpAuthExtensionConfiguration.d.ts +26 -0
- package/dist-types/auth/httpAuthSchemeProvider.d.ts +59 -0
- package/dist-types/commands/AuthSocialCommand.d.ts +78 -0
- package/dist-types/commands/ClaimPreKeyBundleCommand.d.ts +87 -0
- package/dist-types/commands/CompleteLivenessSessionCommand.d.ts +80 -0
- package/dist-types/commands/CompleteOnboardingCommand.d.ts +75 -0
- package/dist-types/commands/CreateLivenessSessionCommand.d.ts +75 -0
- package/dist-types/commands/DeleteMatchMessagesCommand.d.ts +77 -0
- package/dist-types/commands/DeleteProfileCommand.d.ts +77 -0
- package/dist-types/commands/DiscoverCommand.d.ts +84 -0
- package/dist-types/commands/GenerateInviteCommand.d.ts +78 -0
- package/dist-types/commands/GenerateUploadUrlCommand.d.ts +80 -0
- package/dist-types/commands/GetMatchCommand.d.ts +87 -0
- package/dist-types/commands/GetMyProfileCommand.d.ts +136 -0
- package/dist-types/commands/GetPreferencesCommand.d.ts +83 -0
- package/dist-types/commands/GetProfileCommand.d.ts +136 -0
- package/dist-types/commands/GetStateCommand.d.ts +83 -0
- package/dist-types/commands/GetUserByEmailCommand.d.ts +83 -0
- package/dist-types/commands/GetUserCommand.d.ts +83 -0
- package/dist-types/commands/IndexLocationCommand.d.ts +76 -0
- package/dist-types/commands/InitUserCommand.d.ts +73 -0
- package/dist-types/commands/LinkEmailCommand.d.ts +76 -0
- package/dist-types/commands/LinkSocialCommand.d.ts +76 -0
- package/dist-types/commands/RegisterPhoneCommand.d.ts +79 -0
- package/dist-types/commands/RemoveLocationCommand.d.ts +76 -0
- package/dist-types/commands/RequestEmailOtpCommand.d.ts +76 -0
- package/dist-types/commands/RequestPhoneOtpCommand.d.ts +75 -0
- package/dist-types/commands/RequestPhoneUpdateOtpCommand.d.ts +75 -0
- package/dist-types/commands/SwipeCommand.d.ts +79 -0
- package/dist-types/commands/UnhookCommand.d.ts +78 -0
- package/dist-types/commands/UnlinkSocialCommand.d.ts +75 -0
- package/dist-types/commands/UpdateEntitlementsCommand.d.ts +87 -0
- package/dist-types/commands/UpdatePhoneNumberCommand.d.ts +77 -0
- package/dist-types/commands/UpdatePreferencesCommand.d.ts +81 -0
- package/dist-types/commands/UpdateProfileCommand.d.ts +130 -0
- package/dist-types/commands/UpgradeUserCommand.d.ts +81 -0
- package/dist-types/commands/UploadPreKeysCommand.d.ts +81 -0
- package/dist-types/commands/ValidateInviteCommand.d.ts +78 -0
- package/dist-types/commands/index.d.ts +36 -0
- package/dist-types/extensionConfiguration.d.ts +8 -0
- package/dist-types/graphql/types.d.ts +110 -0
- package/dist-types/index.d.ts +7 -0
- package/dist-types/models/OneHookServiceServiceException.d.ts +14 -0
- package/dist-types/models/index.d.ts +1 -0
- package/dist-types/models/models_0.d.ts +614 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +326 -0
- package/dist-types/runtimeConfig.browser.d.ts +38 -0
- package/dist-types/runtimeConfig.d.ts +38 -0
- package/dist-types/runtimeConfig.native.d.ts +37 -0
- package/dist-types/runtimeConfig.shared.d.ts +23 -0
- package/dist-types/runtimeExtensions.d.ts +17 -0
- package/package.json +95 -0
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
import { OneHookServiceClientResolvedConfig } from "../OneHookServiceClient";
|
|
2
|
+
import { HandlerExecutionContext, HttpAuthScheme, HttpAuthSchemeParameters, HttpAuthSchemeParametersProvider, HttpAuthSchemeProvider } from "@smithy/types";
|
|
3
|
+
/**
|
|
4
|
+
* @internal
|
|
5
|
+
*/
|
|
6
|
+
export interface OneHookServiceHttpAuthSchemeParameters extends HttpAuthSchemeParameters {
|
|
7
|
+
}
|
|
8
|
+
/**
|
|
9
|
+
* @internal
|
|
10
|
+
*/
|
|
11
|
+
export interface OneHookServiceHttpAuthSchemeParametersProvider extends HttpAuthSchemeParametersProvider<OneHookServiceClientResolvedConfig, HandlerExecutionContext, OneHookServiceHttpAuthSchemeParameters, object> {
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* @internal
|
|
15
|
+
*/
|
|
16
|
+
export declare const defaultOneHookServiceHttpAuthSchemeParametersProvider: (config: OneHookServiceClientResolvedConfig, context: HandlerExecutionContext, input: object) => Promise<OneHookServiceHttpAuthSchemeParameters>;
|
|
17
|
+
/**
|
|
18
|
+
* @internal
|
|
19
|
+
*/
|
|
20
|
+
export interface OneHookServiceHttpAuthSchemeProvider extends HttpAuthSchemeProvider<OneHookServiceHttpAuthSchemeParameters> {
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* @internal
|
|
24
|
+
*/
|
|
25
|
+
export declare const defaultOneHookServiceHttpAuthSchemeProvider: OneHookServiceHttpAuthSchemeProvider;
|
|
26
|
+
/**
|
|
27
|
+
* @internal
|
|
28
|
+
*/
|
|
29
|
+
export interface HttpAuthSchemeInputConfig {
|
|
30
|
+
/**
|
|
31
|
+
* Configuration of HttpAuthSchemes for a client which provides default identity providers and signers per auth scheme.
|
|
32
|
+
* @internal
|
|
33
|
+
*/
|
|
34
|
+
httpAuthSchemes?: HttpAuthScheme[];
|
|
35
|
+
/**
|
|
36
|
+
* Configuration of an HttpAuthSchemeProvider for a client which resolves which HttpAuthScheme to use.
|
|
37
|
+
* @internal
|
|
38
|
+
*/
|
|
39
|
+
httpAuthSchemeProvider?: OneHookServiceHttpAuthSchemeProvider;
|
|
40
|
+
}
|
|
41
|
+
/**
|
|
42
|
+
* @internal
|
|
43
|
+
*/
|
|
44
|
+
export interface HttpAuthSchemeResolvedConfig {
|
|
45
|
+
/**
|
|
46
|
+
* Configuration of HttpAuthSchemes for a client which provides default identity providers and signers per auth scheme.
|
|
47
|
+
* @internal
|
|
48
|
+
*/
|
|
49
|
+
readonly httpAuthSchemes: HttpAuthScheme[];
|
|
50
|
+
/**
|
|
51
|
+
* Configuration of an HttpAuthSchemeProvider for a client which resolves which HttpAuthScheme to use.
|
|
52
|
+
* @internal
|
|
53
|
+
*/
|
|
54
|
+
readonly httpAuthSchemeProvider: OneHookServiceHttpAuthSchemeProvider;
|
|
55
|
+
}
|
|
56
|
+
/**
|
|
57
|
+
* @internal
|
|
58
|
+
*/
|
|
59
|
+
export declare const resolveHttpAuthSchemeConfig: <T>(config: T & HttpAuthSchemeInputConfig) => T & HttpAuthSchemeResolvedConfig;
|
|
@@ -0,0 +1,78 @@
|
|
|
1
|
+
import { OneHookServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookServiceClient";
|
|
2
|
+
import { AuthSocialRequest, AuthSocialResponse } 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 AuthSocialCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface AuthSocialCommandInput extends AuthSocialRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link AuthSocialCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface AuthSocialCommandOutput extends AuthSocialResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const AuthSocialCommand_base: {
|
|
25
|
+
new (input: AuthSocialCommandInput): import("@smithy/smithy-client").CommandImpl<AuthSocialCommandInput, AuthSocialCommandOutput, OneHookServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: AuthSocialCommandInput): import("@smithy/smithy-client").CommandImpl<AuthSocialCommandInput, AuthSocialCommandOutput, OneHookServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* @public
|
|
31
|
+
*
|
|
32
|
+
* @example
|
|
33
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
34
|
+
* ```javascript
|
|
35
|
+
* import { OneHookServiceClient, AuthSocialCommand } from "onehook-api-client"; // ES Modules import
|
|
36
|
+
* // const { OneHookServiceClient, AuthSocialCommand } = require("onehook-api-client"); // CommonJS import
|
|
37
|
+
* const client = new OneHookServiceClient(config);
|
|
38
|
+
* const input = { // AuthSocialRequest
|
|
39
|
+
* provider: "STRING_VALUE", // required
|
|
40
|
+
* token: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new AuthSocialCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // AuthSocialResponse
|
|
45
|
+
* // status: "STRING_VALUE", // required
|
|
46
|
+
* // userId: "STRING_VALUE",
|
|
47
|
+
* // isNewUser: true || false,
|
|
48
|
+
* // };
|
|
49
|
+
*
|
|
50
|
+
* ```
|
|
51
|
+
*
|
|
52
|
+
* @param AuthSocialCommandInput - {@link AuthSocialCommandInput}
|
|
53
|
+
* @returns {@link AuthSocialCommandOutput}
|
|
54
|
+
* @see {@link AuthSocialCommandInput} for command's `input` shape.
|
|
55
|
+
* @see {@link AuthSocialCommandOutput} for command's `response` shape.
|
|
56
|
+
* @see {@link OneHookServiceClientResolvedConfig | config} for OneHookServiceClient's `config` shape.
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link BadRequestError} (client fault)
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link InternalServerError} (server fault)
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link OneHookServiceServiceException}
|
|
63
|
+
* <p>Base exception class for all service exceptions from OneHookService service.</p>
|
|
64
|
+
*
|
|
65
|
+
*/
|
|
66
|
+
export declare class AuthSocialCommand extends AuthSocialCommand_base {
|
|
67
|
+
/** @internal type navigation helper, not in runtime. */
|
|
68
|
+
protected static __types: {
|
|
69
|
+
api: {
|
|
70
|
+
input: AuthSocialRequest;
|
|
71
|
+
output: AuthSocialResponse;
|
|
72
|
+
};
|
|
73
|
+
sdk: {
|
|
74
|
+
input: AuthSocialCommandInput;
|
|
75
|
+
output: AuthSocialCommandOutput;
|
|
76
|
+
};
|
|
77
|
+
};
|
|
78
|
+
}
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
import { OneHookServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookServiceClient";
|
|
2
|
+
import { ClaimPreKeyBundleRequest, ClaimPreKeyBundleResponse } 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 ClaimPreKeyBundleCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface ClaimPreKeyBundleCommandInput extends ClaimPreKeyBundleRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link ClaimPreKeyBundleCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface ClaimPreKeyBundleCommandOutput extends ClaimPreKeyBundleResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const ClaimPreKeyBundleCommand_base: {
|
|
25
|
+
new (input: ClaimPreKeyBundleCommandInput): import("@smithy/smithy-client").CommandImpl<ClaimPreKeyBundleCommandInput, ClaimPreKeyBundleCommandOutput, OneHookServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: ClaimPreKeyBundleCommandInput): import("@smithy/smithy-client").CommandImpl<ClaimPreKeyBundleCommandInput, ClaimPreKeyBundleCommandOutput, OneHookServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Claim a pre-key bundle for a target user to initiate an E2EE (X3DH) session.
|
|
31
|
+
*
|
|
32
|
+
* This is intentionally a NON-idempotent POST — fulfilling the request consumes
|
|
33
|
+
* (deletes) one of the target user's one-time pre-keys. It must not be modeled as a
|
|
34
|
+
* GET: doing so would make it eligible for prefetch, caching, and automatic retries,
|
|
35
|
+
* which could burn through a user's one-time pre-keys and break session starts.
|
|
36
|
+
* @example
|
|
37
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
38
|
+
* ```javascript
|
|
39
|
+
* import { OneHookServiceClient, ClaimPreKeyBundleCommand } from "onehook-api-client"; // ES Modules import
|
|
40
|
+
* // const { OneHookServiceClient, ClaimPreKeyBundleCommand } = require("onehook-api-client"); // CommonJS import
|
|
41
|
+
* const client = new OneHookServiceClient(config);
|
|
42
|
+
* const input = { // ClaimPreKeyBundleRequest
|
|
43
|
+
* userId: "STRING_VALUE", // required
|
|
44
|
+
* matchId: "STRING_VALUE", // required
|
|
45
|
+
* };
|
|
46
|
+
* const command = new ClaimPreKeyBundleCommand(input);
|
|
47
|
+
* const response = await client.send(command);
|
|
48
|
+
* // { // ClaimPreKeyBundleResponse
|
|
49
|
+
* // identityKey: "STRING_VALUE", // required
|
|
50
|
+
* // signedPreKey: "STRING_VALUE", // required
|
|
51
|
+
* // oneTimePreKey: "STRING_VALUE",
|
|
52
|
+
* // };
|
|
53
|
+
*
|
|
54
|
+
* ```
|
|
55
|
+
*
|
|
56
|
+
* @param ClaimPreKeyBundleCommandInput - {@link ClaimPreKeyBundleCommandInput}
|
|
57
|
+
* @returns {@link ClaimPreKeyBundleCommandOutput}
|
|
58
|
+
* @see {@link ClaimPreKeyBundleCommandInput} for command's `input` shape.
|
|
59
|
+
* @see {@link ClaimPreKeyBundleCommandOutput} for command's `response` shape.
|
|
60
|
+
* @see {@link OneHookServiceClientResolvedConfig | config} for OneHookServiceClient's `config` shape.
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link BadRequestError} (client fault)
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link ForbiddenError} (client fault)
|
|
65
|
+
*
|
|
66
|
+
* @throws {@link NotFoundError} (client fault)
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link InternalServerError} (server fault)
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link OneHookServiceServiceException}
|
|
71
|
+
* <p>Base exception class for all service exceptions from OneHookService service.</p>
|
|
72
|
+
*
|
|
73
|
+
* @public
|
|
74
|
+
*/
|
|
75
|
+
export declare class ClaimPreKeyBundleCommand extends ClaimPreKeyBundleCommand_base {
|
|
76
|
+
/** @internal type navigation helper, not in runtime. */
|
|
77
|
+
protected static __types: {
|
|
78
|
+
api: {
|
|
79
|
+
input: ClaimPreKeyBundleRequest;
|
|
80
|
+
output: ClaimPreKeyBundleResponse;
|
|
81
|
+
};
|
|
82
|
+
sdk: {
|
|
83
|
+
input: ClaimPreKeyBundleCommandInput;
|
|
84
|
+
output: ClaimPreKeyBundleCommandOutput;
|
|
85
|
+
};
|
|
86
|
+
};
|
|
87
|
+
}
|
|
@@ -0,0 +1,80 @@
|
|
|
1
|
+
import { OneHookServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookServiceClient";
|
|
2
|
+
import { CompleteLivenessSessionRequest, CompleteLivenessSessionResponse } 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 CompleteLivenessSessionCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface CompleteLivenessSessionCommandInput extends CompleteLivenessSessionRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link CompleteLivenessSessionCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface CompleteLivenessSessionCommandOutput extends CompleteLivenessSessionResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const CompleteLivenessSessionCommand_base: {
|
|
25
|
+
new (input: CompleteLivenessSessionCommandInput): import("@smithy/smithy-client").CommandImpl<CompleteLivenessSessionCommandInput, CompleteLivenessSessionCommandOutput, OneHookServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: CompleteLivenessSessionCommandInput): import("@smithy/smithy-client").CommandImpl<CompleteLivenessSessionCommandInput, CompleteLivenessSessionCommandOutput, OneHookServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Submits a completed Face Liveness session for asynchronous analysis. The backend evaluates the
|
|
31
|
+
* result in the background (Rekognition results + face match) and, on success, sets the profile's
|
|
32
|
+
* internal `verified` flag. Clients receive an immediate acknowledgement and learn the outcome
|
|
33
|
+
* later via GetProfile (the `verified` field).
|
|
34
|
+
* @example
|
|
35
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
36
|
+
* ```javascript
|
|
37
|
+
* import { OneHookServiceClient, CompleteLivenessSessionCommand } from "onehook-api-client"; // ES Modules import
|
|
38
|
+
* // const { OneHookServiceClient, CompleteLivenessSessionCommand } = require("onehook-api-client"); // CommonJS import
|
|
39
|
+
* const client = new OneHookServiceClient(config);
|
|
40
|
+
* const input = { // CompleteLivenessSessionRequest
|
|
41
|
+
* sessionId: "STRING_VALUE", // required
|
|
42
|
+
* };
|
|
43
|
+
* const command = new CompleteLivenessSessionCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // CompleteLivenessSessionResponse
|
|
46
|
+
* // status: "STRING_VALUE", // required
|
|
47
|
+
* // };
|
|
48
|
+
*
|
|
49
|
+
* ```
|
|
50
|
+
*
|
|
51
|
+
* @param CompleteLivenessSessionCommandInput - {@link CompleteLivenessSessionCommandInput}
|
|
52
|
+
* @returns {@link CompleteLivenessSessionCommandOutput}
|
|
53
|
+
* @see {@link CompleteLivenessSessionCommandInput} for command's `input` shape.
|
|
54
|
+
* @see {@link CompleteLivenessSessionCommandOutput} for command's `response` shape.
|
|
55
|
+
* @see {@link OneHookServiceClientResolvedConfig | config} for OneHookServiceClient's `config` shape.
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link BadRequestError} (client fault)
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link NotFoundError} (client fault)
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link InternalServerError} (server fault)
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link OneHookServiceServiceException}
|
|
64
|
+
* <p>Base exception class for all service exceptions from OneHookService service.</p>
|
|
65
|
+
*
|
|
66
|
+
* @public
|
|
67
|
+
*/
|
|
68
|
+
export declare class CompleteLivenessSessionCommand extends CompleteLivenessSessionCommand_base {
|
|
69
|
+
/** @internal type navigation helper, not in runtime. */
|
|
70
|
+
protected static __types: {
|
|
71
|
+
api: {
|
|
72
|
+
input: CompleteLivenessSessionRequest;
|
|
73
|
+
output: CompleteLivenessSessionResponse;
|
|
74
|
+
};
|
|
75
|
+
sdk: {
|
|
76
|
+
input: CompleteLivenessSessionCommandInput;
|
|
77
|
+
output: CompleteLivenessSessionCommandOutput;
|
|
78
|
+
};
|
|
79
|
+
};
|
|
80
|
+
}
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
import { OneHookServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookServiceClient";
|
|
2
|
+
import { CompleteOnboardingRequest, StatusResponse } 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 CompleteOnboardingCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface CompleteOnboardingCommandInput extends CompleteOnboardingRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link CompleteOnboardingCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface CompleteOnboardingCommandOutput extends StatusResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const CompleteOnboardingCommand_base: {
|
|
25
|
+
new (input: CompleteOnboardingCommandInput): import("@smithy/smithy-client").CommandImpl<CompleteOnboardingCommandInput, CompleteOnboardingCommandOutput, OneHookServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (...[input]: [] | [CompleteOnboardingCommandInput]): import("@smithy/smithy-client").CommandImpl<CompleteOnboardingCommandInput, CompleteOnboardingCommandOutput, OneHookServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* @public
|
|
31
|
+
*
|
|
32
|
+
* @example
|
|
33
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
34
|
+
* ```javascript
|
|
35
|
+
* import { OneHookServiceClient, CompleteOnboardingCommand } from "onehook-api-client"; // ES Modules import
|
|
36
|
+
* // const { OneHookServiceClient, CompleteOnboardingCommand } = require("onehook-api-client"); // CommonJS import
|
|
37
|
+
* const client = new OneHookServiceClient(config);
|
|
38
|
+
* const input = {};
|
|
39
|
+
* const command = new CompleteOnboardingCommand(input);
|
|
40
|
+
* const response = await client.send(command);
|
|
41
|
+
* // { // StatusResponse
|
|
42
|
+
* // status: "STRING_VALUE", // required
|
|
43
|
+
* // };
|
|
44
|
+
*
|
|
45
|
+
* ```
|
|
46
|
+
*
|
|
47
|
+
* @param CompleteOnboardingCommandInput - {@link CompleteOnboardingCommandInput}
|
|
48
|
+
* @returns {@link CompleteOnboardingCommandOutput}
|
|
49
|
+
* @see {@link CompleteOnboardingCommandInput} for command's `input` shape.
|
|
50
|
+
* @see {@link CompleteOnboardingCommandOutput} for command's `response` shape.
|
|
51
|
+
* @see {@link OneHookServiceClientResolvedConfig | config} for OneHookServiceClient's `config` shape.
|
|
52
|
+
*
|
|
53
|
+
* @throws {@link BadRequestError} (client fault)
|
|
54
|
+
*
|
|
55
|
+
* @throws {@link NotFoundError} (client fault)
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link InternalServerError} (server fault)
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link OneHookServiceServiceException}
|
|
60
|
+
* <p>Base exception class for all service exceptions from OneHookService service.</p>
|
|
61
|
+
*
|
|
62
|
+
*/
|
|
63
|
+
export declare class CompleteOnboardingCommand extends CompleteOnboardingCommand_base {
|
|
64
|
+
/** @internal type navigation helper, not in runtime. */
|
|
65
|
+
protected static __types: {
|
|
66
|
+
api: {
|
|
67
|
+
input: {};
|
|
68
|
+
output: StatusResponse;
|
|
69
|
+
};
|
|
70
|
+
sdk: {
|
|
71
|
+
input: CompleteOnboardingCommandInput;
|
|
72
|
+
output: CompleteOnboardingCommandOutput;
|
|
73
|
+
};
|
|
74
|
+
};
|
|
75
|
+
}
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
import { OneHookServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookServiceClient";
|
|
2
|
+
import { CreateLivenessSessionRequest, CreateLivenessSessionResponse } 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 CreateLivenessSessionCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface CreateLivenessSessionCommandInput extends CreateLivenessSessionRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link CreateLivenessSessionCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface CreateLivenessSessionCommandOutput extends CreateLivenessSessionResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const CreateLivenessSessionCommand_base: {
|
|
25
|
+
new (input: CreateLivenessSessionCommandInput): import("@smithy/smithy-client").CommandImpl<CreateLivenessSessionCommandInput, CreateLivenessSessionCommandOutput, OneHookServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (...[input]: [] | [CreateLivenessSessionCommandInput]): import("@smithy/smithy-client").CommandImpl<CreateLivenessSessionCommandInput, CreateLivenessSessionCommandOutput, OneHookServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Creates an Amazon Rekognition Face Liveness session for the authenticated user.
|
|
31
|
+
* The client runs the liveness check with the returned sessionId, then calls
|
|
32
|
+
* CompleteLivenessSession to have the backend evaluate the result.
|
|
33
|
+
* @example
|
|
34
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
+
* ```javascript
|
|
36
|
+
* import { OneHookServiceClient, CreateLivenessSessionCommand } from "onehook-api-client"; // ES Modules import
|
|
37
|
+
* // const { OneHookServiceClient, CreateLivenessSessionCommand } = require("onehook-api-client"); // CommonJS import
|
|
38
|
+
* const client = new OneHookServiceClient(config);
|
|
39
|
+
* const input = {};
|
|
40
|
+
* const command = new CreateLivenessSessionCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // { // CreateLivenessSessionResponse
|
|
43
|
+
* // sessionId: "STRING_VALUE", // required
|
|
44
|
+
* // };
|
|
45
|
+
*
|
|
46
|
+
* ```
|
|
47
|
+
*
|
|
48
|
+
* @param CreateLivenessSessionCommandInput - {@link CreateLivenessSessionCommandInput}
|
|
49
|
+
* @returns {@link CreateLivenessSessionCommandOutput}
|
|
50
|
+
* @see {@link CreateLivenessSessionCommandInput} for command's `input` shape.
|
|
51
|
+
* @see {@link CreateLivenessSessionCommandOutput} for command's `response` shape.
|
|
52
|
+
* @see {@link OneHookServiceClientResolvedConfig | config} for OneHookServiceClient's `config` shape.
|
|
53
|
+
*
|
|
54
|
+
* @throws {@link BadRequestError} (client fault)
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link InternalServerError} (server fault)
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link OneHookServiceServiceException}
|
|
59
|
+
* <p>Base exception class for all service exceptions from OneHookService service.</p>
|
|
60
|
+
*
|
|
61
|
+
* @public
|
|
62
|
+
*/
|
|
63
|
+
export declare class CreateLivenessSessionCommand extends CreateLivenessSessionCommand_base {
|
|
64
|
+
/** @internal type navigation helper, not in runtime. */
|
|
65
|
+
protected static __types: {
|
|
66
|
+
api: {
|
|
67
|
+
input: {};
|
|
68
|
+
output: CreateLivenessSessionResponse;
|
|
69
|
+
};
|
|
70
|
+
sdk: {
|
|
71
|
+
input: CreateLivenessSessionCommandInput;
|
|
72
|
+
output: CreateLivenessSessionCommandOutput;
|
|
73
|
+
};
|
|
74
|
+
};
|
|
75
|
+
}
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
import { OneHookServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookServiceClient";
|
|
2
|
+
import { DeleteMatchMessagesRequest, DeleteMatchMessagesResponse } 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 DeleteMatchMessagesCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeleteMatchMessagesCommandInput extends DeleteMatchMessagesRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DeleteMatchMessagesCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DeleteMatchMessagesCommandOutput extends DeleteMatchMessagesResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DeleteMatchMessagesCommand_base: {
|
|
25
|
+
new (input: DeleteMatchMessagesCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteMatchMessagesCommandInput, DeleteMatchMessagesCommandOutput, OneHookServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: DeleteMatchMessagesCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteMatchMessagesCommandInput, DeleteMatchMessagesCommandOutput, OneHookServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Hard-delete all messages for a match (e.g. on unmatch).
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { OneHookServiceClient, DeleteMatchMessagesCommand } from "onehook-api-client"; // ES Modules import
|
|
35
|
+
* // const { OneHookServiceClient, DeleteMatchMessagesCommand } = require("onehook-api-client"); // CommonJS import
|
|
36
|
+
* const client = new OneHookServiceClient(config);
|
|
37
|
+
* const input = { // DeleteMatchMessagesRequest
|
|
38
|
+
* matchId: "STRING_VALUE", // required
|
|
39
|
+
* };
|
|
40
|
+
* const command = new DeleteMatchMessagesCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // { // DeleteMatchMessagesResponse
|
|
43
|
+
* // deleted: Number("int"), // required
|
|
44
|
+
* // };
|
|
45
|
+
*
|
|
46
|
+
* ```
|
|
47
|
+
*
|
|
48
|
+
* @param DeleteMatchMessagesCommandInput - {@link DeleteMatchMessagesCommandInput}
|
|
49
|
+
* @returns {@link DeleteMatchMessagesCommandOutput}
|
|
50
|
+
* @see {@link DeleteMatchMessagesCommandInput} for command's `input` shape.
|
|
51
|
+
* @see {@link DeleteMatchMessagesCommandOutput} for command's `response` shape.
|
|
52
|
+
* @see {@link OneHookServiceClientResolvedConfig | config} for OneHookServiceClient's `config` shape.
|
|
53
|
+
*
|
|
54
|
+
* @throws {@link BadRequestError} (client fault)
|
|
55
|
+
*
|
|
56
|
+
* @throws {@link ForbiddenError} (client fault)
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link InternalServerError} (server fault)
|
|
59
|
+
*
|
|
60
|
+
* @throws {@link OneHookServiceServiceException}
|
|
61
|
+
* <p>Base exception class for all service exceptions from OneHookService service.</p>
|
|
62
|
+
*
|
|
63
|
+
* @public
|
|
64
|
+
*/
|
|
65
|
+
export declare class DeleteMatchMessagesCommand extends DeleteMatchMessagesCommand_base {
|
|
66
|
+
/** @internal type navigation helper, not in runtime. */
|
|
67
|
+
protected static __types: {
|
|
68
|
+
api: {
|
|
69
|
+
input: DeleteMatchMessagesRequest;
|
|
70
|
+
output: DeleteMatchMessagesResponse;
|
|
71
|
+
};
|
|
72
|
+
sdk: {
|
|
73
|
+
input: DeleteMatchMessagesCommandInput;
|
|
74
|
+
output: DeleteMatchMessagesCommandOutput;
|
|
75
|
+
};
|
|
76
|
+
};
|
|
77
|
+
}
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
import { OneHookServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookServiceClient";
|
|
2
|
+
import { DeleteProfileRequest, StatusResponse } 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 DeleteProfileCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface DeleteProfileCommandInput extends DeleteProfileRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link DeleteProfileCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface DeleteProfileCommandOutput extends StatusResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const DeleteProfileCommand_base: {
|
|
25
|
+
new (input: DeleteProfileCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteProfileCommandInput, DeleteProfileCommandOutput, OneHookServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: DeleteProfileCommandInput): import("@smithy/smithy-client").CommandImpl<DeleteProfileCommandInput, DeleteProfileCommandOutput, OneHookServiceClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* @public
|
|
31
|
+
*
|
|
32
|
+
* @example
|
|
33
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
34
|
+
* ```javascript
|
|
35
|
+
* import { OneHookServiceClient, DeleteProfileCommand } from "onehook-api-client"; // ES Modules import
|
|
36
|
+
* // const { OneHookServiceClient, DeleteProfileCommand } = require("onehook-api-client"); // CommonJS import
|
|
37
|
+
* const client = new OneHookServiceClient(config);
|
|
38
|
+
* const input = { // DeleteProfileRequest
|
|
39
|
+
* userId: "STRING_VALUE", // required
|
|
40
|
+
* };
|
|
41
|
+
* const command = new DeleteProfileCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // { // StatusResponse
|
|
44
|
+
* // status: "STRING_VALUE", // required
|
|
45
|
+
* // };
|
|
46
|
+
*
|
|
47
|
+
* ```
|
|
48
|
+
*
|
|
49
|
+
* @param DeleteProfileCommandInput - {@link DeleteProfileCommandInput}
|
|
50
|
+
* @returns {@link DeleteProfileCommandOutput}
|
|
51
|
+
* @see {@link DeleteProfileCommandInput} for command's `input` shape.
|
|
52
|
+
* @see {@link DeleteProfileCommandOutput} for command's `response` shape.
|
|
53
|
+
* @see {@link OneHookServiceClientResolvedConfig | config} for OneHookServiceClient's `config` shape.
|
|
54
|
+
*
|
|
55
|
+
* @throws {@link BadRequestError} (client fault)
|
|
56
|
+
*
|
|
57
|
+
* @throws {@link NotFoundError} (client fault)
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link InternalServerError} (server fault)
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link OneHookServiceServiceException}
|
|
62
|
+
* <p>Base exception class for all service exceptions from OneHookService service.</p>
|
|
63
|
+
*
|
|
64
|
+
*/
|
|
65
|
+
export declare class DeleteProfileCommand extends DeleteProfileCommand_base {
|
|
66
|
+
/** @internal type navigation helper, not in runtime. */
|
|
67
|
+
protected static __types: {
|
|
68
|
+
api: {
|
|
69
|
+
input: DeleteProfileRequest;
|
|
70
|
+
output: StatusResponse;
|
|
71
|
+
};
|
|
72
|
+
sdk: {
|
|
73
|
+
input: DeleteProfileCommandInput;
|
|
74
|
+
output: DeleteProfileCommandOutput;
|
|
75
|
+
};
|
|
76
|
+
};
|
|
77
|
+
}
|