onehook-api-client 1.0.37 → 1.0.39
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 +446 -19
- package/dist-cjs/OneHook.js +88 -8
- package/dist-cjs/commands/{GetNotificationPreferencesCommand.js → AcceptHookRequestCommand.js} +7 -7
- package/dist-cjs/commands/BlockUserCommand.js +21 -0
- package/dist-cjs/commands/CancelHookRequestCommand.js +21 -0
- package/dist-cjs/commands/ClearTierOverrideCommand.js +21 -0
- package/dist-cjs/commands/DeclineHookRequestCommand.js +21 -0
- package/dist-cjs/commands/{SwipeByUsernameCommand.js → DisableMatchingCommand.js} +7 -7
- package/dist-cjs/commands/EnableMatchingCommand.js +21 -0
- package/dist-cjs/commands/EstablishHistoryEpochCommand.js +21 -0
- package/dist-cjs/commands/GetChatProfileCommand.js +21 -0
- package/dist-cjs/commands/GetDiscoverySnapshotCommand.js +21 -0
- package/dist-cjs/commands/GetGraphInvitesCommand.js +21 -0
- package/dist-cjs/commands/{UpdateProfileCommand.js → GetGraphMatchCommand.js} +7 -7
- package/dist-cjs/commands/GetGraphUserCommand.js +21 -0
- package/dist-cjs/commands/GetHistoryStateCommand.js +21 -0
- package/dist-cjs/commands/GetInternalMatchingStatusCommand.js +21 -0
- package/dist-cjs/commands/GetInternalProfileCommand.js +21 -0
- package/dist-cjs/commands/GetInviteEdgesCommand.js +21 -0
- package/dist-cjs/commands/GetMatchingProfileCommand.js +21 -0
- package/dist-cjs/commands/GetMatchingReadinessCommand.js +21 -0
- package/dist-cjs/commands/GetMediaStatsCommand.js +21 -0
- package/dist-cjs/commands/GetModerationReportCommand.js +21 -0
- package/dist-cjs/commands/GetModerationSignalsCommand.js +21 -0
- package/dist-cjs/commands/GetPartnerDistanceCommand.js +21 -0
- package/dist-cjs/commands/GetScoringPolicyCommand.js +21 -0
- package/dist-cjs/commands/GetTierOverrideCommand.js +21 -0
- package/dist-cjs/commands/IngestSignalsCommand.js +21 -0
- package/dist-cjs/commands/IssueViewPassesCommand.js +21 -0
- package/dist-cjs/commands/KeepHooksCommand.js +21 -0
- package/dist-cjs/commands/{GetProfileCommand.js → ListBlocksCommand.js} +7 -7
- package/dist-cjs/commands/ListGraphUserMatchesCommand.js +21 -0
- package/dist-cjs/commands/ListHookRequestsCommand.js +21 -0
- package/dist-cjs/commands/ListMatchingOnMembersCommand.js +21 -0
- package/dist-cjs/commands/PutHistoryWrapCommand.js +21 -0
- package/dist-cjs/commands/RecordSuggestionInternalCommand.js +21 -0
- package/dist-cjs/commands/ReportMemberCommand.js +21 -0
- package/dist-cjs/commands/RepublishMatchingProfileCommand.js +21 -0
- package/dist-cjs/commands/RevokeHistoryWrapCommand.js +21 -0
- package/dist-cjs/commands/SendHookRequestCommand.js +21 -0
- package/dist-cjs/commands/SetTierOverrideCommand.js +21 -0
- package/dist-cjs/commands/SimulateScoringPolicyCommand.js +21 -0
- package/dist-cjs/commands/UnblockUserCommand.js +21 -0
- package/dist-cjs/commands/UpdateScoringPolicyCommand.js +21 -0
- package/dist-cjs/commands/UpsertChatProfileCommand.js +21 -0
- package/dist-cjs/commands/UpsertMatchingProfileCommand.js +21 -0
- package/dist-cjs/commands/index.js +44 -4
- package/dist-cjs/graphql/types.js +4 -0
- package/dist-cjs/models/models_0.js +216 -21
- package/dist-cjs/protocols/Aws_restJson1.js +2198 -514
- package/dist-cjs/telemetry/index.js +49 -9
- package/dist-es/OneHook.js +88 -8
- package/dist-es/commands/AcceptHookRequestCommand.js +17 -0
- package/dist-es/commands/BlockUserCommand.js +17 -0
- package/dist-es/commands/CancelHookRequestCommand.js +17 -0
- package/dist-es/commands/ClearTierOverrideCommand.js +17 -0
- package/dist-es/commands/DeclineHookRequestCommand.js +17 -0
- package/dist-es/commands/{SwipeByUsernameCommand.js → DisableMatchingCommand.js} +6 -6
- package/dist-es/commands/EnableMatchingCommand.js +17 -0
- package/dist-es/commands/EstablishHistoryEpochCommand.js +17 -0
- package/dist-es/commands/GetChatProfileCommand.js +17 -0
- package/dist-es/commands/GetDiscoverySnapshotCommand.js +17 -0
- package/dist-es/commands/GetGraphInvitesCommand.js +17 -0
- package/dist-es/commands/{UpdateProfileCommand.js → GetGraphMatchCommand.js} +6 -6
- package/dist-es/commands/GetGraphUserCommand.js +17 -0
- package/dist-es/commands/GetHistoryStateCommand.js +17 -0
- package/dist-es/commands/GetInternalMatchingStatusCommand.js +17 -0
- package/dist-es/commands/GetInternalProfileCommand.js +17 -0
- package/dist-es/commands/GetInviteEdgesCommand.js +17 -0
- package/dist-es/commands/GetMatchingProfileCommand.js +17 -0
- package/dist-es/commands/GetMatchingReadinessCommand.js +17 -0
- package/dist-es/commands/GetMediaStatsCommand.js +17 -0
- package/dist-es/commands/GetModerationReportCommand.js +17 -0
- package/dist-es/commands/GetModerationSignalsCommand.js +17 -0
- package/dist-es/commands/GetPartnerDistanceCommand.js +17 -0
- package/dist-es/commands/GetScoringPolicyCommand.js +17 -0
- package/dist-es/commands/GetTierOverrideCommand.js +17 -0
- package/dist-es/commands/IngestSignalsCommand.js +17 -0
- package/dist-es/commands/IssueViewPassesCommand.js +17 -0
- package/dist-es/commands/KeepHooksCommand.js +17 -0
- package/dist-es/commands/{GetProfileCommand.js → ListBlocksCommand.js} +6 -6
- package/dist-es/commands/ListGraphUserMatchesCommand.js +17 -0
- package/dist-es/commands/ListHookRequestsCommand.js +17 -0
- package/dist-es/commands/ListMatchingOnMembersCommand.js +17 -0
- package/dist-es/commands/PutHistoryWrapCommand.js +17 -0
- package/dist-es/commands/RecordSuggestionInternalCommand.js +17 -0
- package/dist-es/commands/ReportMemberCommand.js +17 -0
- package/dist-es/commands/RepublishMatchingProfileCommand.js +17 -0
- package/dist-es/commands/RevokeHistoryWrapCommand.js +17 -0
- package/dist-es/commands/SendHookRequestCommand.js +17 -0
- package/dist-es/commands/SetTierOverrideCommand.js +17 -0
- package/dist-es/commands/SimulateScoringPolicyCommand.js +17 -0
- package/dist-es/commands/UnblockUserCommand.js +17 -0
- package/dist-es/commands/UpdateScoringPolicyCommand.js +17 -0
- package/dist-es/commands/UpsertChatProfileCommand.js +17 -0
- package/dist-es/commands/UpsertMatchingProfileCommand.js +17 -0
- package/dist-es/commands/index.js +44 -4
- package/dist-es/graphql/types.js +4 -0
- package/dist-es/models/models_0.js +208 -18
- package/dist-es/protocols/Aws_restJson1.js +2003 -401
- package/dist-es/telemetry/index.js +49 -9
- package/dist-types/OneHook.d.ts +311 -23
- package/dist-types/OneHookClient.d.ts +46 -6
- package/dist-types/commands/AcceptHookRequestCommand.d.ts +109 -0
- package/dist-types/commands/AuthSocialCommand.d.ts +23 -0
- package/dist-types/commands/BlockUserCommand.d.ts +106 -0
- package/dist-types/commands/CancelHookRequestCommand.d.ts +103 -0
- package/dist-types/commands/ClearTierOverrideCommand.d.ts +123 -0
- package/dist-types/commands/CompleteLivenessSessionCommand.d.ts +26 -1
- package/dist-types/commands/CompleteOnboardingCommand.d.ts +31 -2
- package/dist-types/commands/CorrectBirthDateCommand.d.ts +25 -0
- package/dist-types/commands/CreateAdminInviteCommand.d.ts +29 -5
- package/dist-types/commands/CreateLivenessSessionCommand.d.ts +23 -0
- package/dist-types/commands/CreateMediaDownloadUrlCommand.d.ts +23 -0
- package/dist-types/commands/CreateMediaUploadUrlCommand.d.ts +24 -1
- package/dist-types/commands/DeclineHookRequestCommand.d.ts +103 -0
- package/dist-types/commands/DeleteMatchMessagesCommand.d.ts +21 -0
- package/dist-types/commands/DeleteProfileCommand.d.ts +28 -2
- package/dist-types/commands/DeletePushTokenCommand.d.ts +23 -0
- package/dist-types/commands/DisableMatchingCommand.d.ts +106 -0
- package/dist-types/commands/DiscoverCommand.d.ts +22 -0
- package/dist-types/commands/EnableMatchingCommand.d.ts +105 -0
- package/dist-types/commands/EstablishHistoryEpochCommand.d.ts +125 -0
- package/dist-types/commands/GenerateDownloadUrlCommand.d.ts +26 -0
- package/dist-types/commands/GenerateInviteCommand.d.ts +23 -0
- package/dist-types/commands/GenerateUploadUrlCommand.d.ts +31 -2
- package/dist-types/commands/GetAccountStateCommand.d.ts +25 -0
- package/dist-types/commands/GetAdminPhoneStatusCommand.d.ts +23 -0
- package/dist-types/commands/GetAiContextMatchCommand.d.ts +25 -0
- package/dist-types/commands/GetBirthDateStatusCommand.d.ts +25 -0
- package/dist-types/commands/GetChatProfileCommand.d.ts +123 -0
- package/dist-types/commands/GetChatSettingsCommand.d.ts +22 -0
- package/dist-types/commands/GetCredentialReadinessCommand.d.ts +25 -0
- package/dist-types/commands/GetDiscoverySnapshotCommand.d.ts +138 -0
- package/dist-types/commands/GetGraphInvitesCommand.d.ts +119 -0
- package/dist-types/commands/GetGraphMatchCommand.d.ts +136 -0
- package/dist-types/commands/GetGraphUserCommand.d.ts +117 -0
- package/dist-types/commands/GetHistoryStateCommand.d.ts +113 -0
- package/dist-types/commands/GetInternalMatchingStatusCommand.d.ts +102 -0
- package/dist-types/commands/GetInternalProfileCommand.d.ts +174 -0
- package/dist-types/commands/GetInviteEdgesCommand.d.ts +106 -0
- package/dist-types/commands/GetLivenessStatusCommand.d.ts +23 -0
- package/dist-types/commands/GetMatchCommand.d.ts +27 -0
- package/dist-types/commands/GetMatchingProfileCommand.d.ts +175 -0
- package/dist-types/commands/GetMatchingReadinessCommand.d.ts +107 -0
- package/dist-types/commands/GetMediaStatsCommand.d.ts +106 -0
- package/dist-types/commands/GetModerationReportCommand.d.ts +113 -0
- package/dist-types/commands/GetModerationSignalsCommand.d.ts +123 -0
- package/dist-types/commands/GetMyProfileCommand.d.ts +119 -79
- package/dist-types/commands/GetParticipantRegistryCommand.d.ts +23 -0
- package/dist-types/commands/GetPartnerDistanceCommand.d.ts +102 -0
- package/dist-types/commands/GetPlaceCommand.d.ts +25 -0
- package/dist-types/commands/GetPreferencesCommand.d.ts +27 -3
- package/dist-types/commands/GetPreservationHoldCommand.d.ts +25 -0
- package/dist-types/commands/GetReceivedLikesCommand.d.ts +24 -0
- package/dist-types/commands/GetRosesCommand.d.ts +25 -0
- package/dist-types/commands/GetScoringPolicyCommand.d.ts +143 -0
- package/dist-types/commands/GetStateCommand.d.ts +44 -0
- package/dist-types/commands/GetSuggestionsCommand.d.ts +23 -0
- package/dist-types/commands/GetTierOverrideCommand.d.ts +123 -0
- package/dist-types/commands/GetTraditionPreferencesCommand.d.ts +23 -0
- package/dist-types/commands/GetUserByEmailCommand.d.ts +27 -0
- package/dist-types/commands/GetUserCommand.d.ts +27 -0
- package/dist-types/commands/GetUserIdByUsernameCommand.d.ts +28 -3
- package/dist-types/commands/IndexLocationCommand.d.ts +23 -0
- package/dist-types/commands/IngestSignalsCommand.d.ts +114 -0
- package/dist-types/commands/InitUserCommand.d.ts +29 -2
- package/dist-types/commands/IssueViewPassesCommand.d.ts +107 -0
- package/dist-types/commands/KeepHooksCommand.d.ts +136 -0
- package/dist-types/commands/LinkEmailCommand.d.ts +23 -0
- package/dist-types/commands/LinkSocialCommand.d.ts +23 -0
- package/dist-types/commands/ListBlocksCommand.d.ts +102 -0
- package/dist-types/commands/ListGraphUserMatchesCommand.d.ts +117 -0
- package/dist-types/commands/ListHookRequestsCommand.d.ts +110 -0
- package/dist-types/commands/ListMatchingOnMembersCommand.d.ts +108 -0
- package/dist-types/commands/ListMyDevicesCommand.d.ts +20 -0
- package/dist-types/commands/PutHistoryWrapCommand.d.ts +112 -0
- package/dist-types/commands/RecordSuggestionCommand.d.ts +21 -0
- package/dist-types/commands/RecordSuggestionInternalCommand.d.ts +105 -0
- package/dist-types/commands/RegisterDeviceCommand.d.ts +25 -10
- package/dist-types/commands/RegisterPhoneCommand.d.ts +23 -0
- package/dist-types/commands/RegisterPushTokenCommand.d.ts +23 -0
- package/dist-types/commands/RemoveLocationCommand.d.ts +23 -0
- package/dist-types/commands/RemoveOneHookSuggestionCommand.d.ts +23 -0
- package/dist-types/commands/RemoveSuggestionCommand.d.ts +23 -0
- package/dist-types/commands/ReportMemberCommand.d.ts +107 -0
- package/dist-types/commands/RepublishMatchingProfileCommand.d.ts +109 -0
- package/dist-types/commands/RequestEmailOtpCommand.d.ts +23 -0
- package/dist-types/commands/RequestPhoneOtpCommand.d.ts +23 -0
- package/dist-types/commands/RequestPhoneUpdateOtpCommand.d.ts +23 -0
- package/dist-types/commands/RevokeDeviceCommand.d.ts +23 -0
- package/dist-types/commands/RevokeHistoryWrapCommand.d.ts +108 -0
- package/dist-types/commands/RevokeUserAccessCommand.d.ts +25 -0
- package/dist-types/commands/SearchPlacesCommand.d.ts +23 -0
- package/dist-types/commands/SendAdminLinkOtpCommand.d.ts +25 -0
- package/dist-types/commands/SendHookRequestCommand.d.ts +105 -0
- package/dist-types/commands/SetAccountStateCommand.d.ts +27 -0
- package/dist-types/commands/SetPreservationHoldCommand.d.ts +27 -0
- package/dist-types/commands/SetTierOverrideCommand.d.ts +128 -0
- package/dist-types/commands/SimulateScoringPolicyCommand.d.ts +129 -0
- package/dist-types/commands/SwipeCommand.d.ts +27 -0
- package/dist-types/commands/UnblockUserCommand.d.ts +99 -0
- package/dist-types/commands/UnhookCommand.d.ts +29 -0
- package/dist-types/commands/UnlinkSocialCommand.d.ts +23 -0
- package/dist-types/commands/UpdateChatSettingsCommand.d.ts +25 -0
- package/dist-types/commands/UpdateEntitlementsCommand.d.ts +25 -0
- package/dist-types/commands/UpdatePhoneNumberCommand.d.ts +23 -0
- package/dist-types/commands/UpdatePreferencesCommand.d.ts +76 -8
- package/dist-types/commands/UpdateScoringPolicyCommand.d.ts +183 -0
- package/dist-types/commands/UpdateTraditionPreferencesCommand.d.ts +23 -0
- package/dist-types/commands/UpdateUsernameCommand.d.ts +23 -0
- package/dist-types/commands/UpgradeUserCommand.d.ts +44 -0
- package/dist-types/commands/UpsertChatProfileCommand.d.ts +110 -0
- package/dist-types/commands/UpsertMatchingProfileCommand.d.ts +163 -0
- package/dist-types/commands/ValidateInviteCommand.d.ts +23 -0
- package/dist-types/commands/VerifyAdminLinkOtpCommand.d.ts +25 -0
- package/dist-types/commands/index.d.ts +44 -4
- package/dist-types/graphql/types.d.ts +8 -0
- package/dist-types/models/models_0.d.ts +3406 -1268
- package/dist-types/protocols/Aws_restJson1.d.ts +384 -24
- package/dist-types/telemetry/index.d.ts +25 -2
- package/package.json +1 -1
- package/telemetry/TelemetryCatalog.kt +33 -11
- package/telemetry/TelemetryCatalog.swift +50 -11
- package/telemetry/telemetry-catalog.json +309 -34
- package/dist-es/commands/GetNotificationPreferencesCommand.js +0 -17
- package/dist-types/commands/GetNotificationPreferencesCommand.d.ts +0 -91
- package/dist-types/commands/GetProfileCommand.d.ts +0 -153
- package/dist-types/commands/SwipeByUsernameCommand.d.ts +0 -93
- package/dist-types/commands/UpdateProfileCommand.d.ts +0 -142
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
|
|
2
|
+
import { ChatProfile, GetOtherProfileRequest } 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 GetChatProfileCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetChatProfileCommandInput extends GetOtherProfileRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetChatProfileCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetChatProfileCommandOutput extends ChatProfile, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetChatProfileCommand_base: {
|
|
25
|
+
new (input: GetChatProfileCommandInput): import("@smithy/smithy-client").CommandImpl<GetChatProfileCommandInput, GetChatProfileCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetChatProfileCommandInput): import("@smithy/smithy-client").CommandImpl<GetChatProfileCommandInput, GetChatProfileCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Another member's chat profile. Requires an `X-View-Pass` from State (`aud` profile.chat) naming
|
|
31
|
+
* this member; it covers hook partners and the senders of unlocked incoming requests. Without a
|
|
32
|
+
* valid pass the answer is the same 404 as for an unknown member.
|
|
33
|
+
* @example
|
|
34
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
+
* ```javascript
|
|
36
|
+
* import { OneHookClient, GetChatProfileCommand } from "onehook-api-client"; // ES Modules import
|
|
37
|
+
* // const { OneHookClient, GetChatProfileCommand } = require("onehook-api-client"); // CommonJS import
|
|
38
|
+
* const client = new OneHookClient(config);
|
|
39
|
+
* const input = { // GetOtherProfileRequest
|
|
40
|
+
* userId: "STRING_VALUE", // required
|
|
41
|
+
* viewPass: "STRING_VALUE",
|
|
42
|
+
* };
|
|
43
|
+
* const command = new GetChatProfileCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // ChatProfile
|
|
46
|
+
* // userId: "STRING_VALUE", // required
|
|
47
|
+
* // displayName: "STRING_VALUE",
|
|
48
|
+
* // avatarKey: "STRING_VALUE",
|
|
49
|
+
* // age: Number("int"),
|
|
50
|
+
* // birthDetails: { // BirthDetails
|
|
51
|
+
* // date: "STRING_VALUE",
|
|
52
|
+
* // time: "STRING_VALUE",
|
|
53
|
+
* // timeZone: "STRING_VALUE",
|
|
54
|
+
* // latitude: Number("double"),
|
|
55
|
+
* // longitude: Number("double"),
|
|
56
|
+
* // placeName: "STRING_VALUE",
|
|
57
|
+
* // provisional: true || false,
|
|
58
|
+
* // },
|
|
59
|
+
* // birthDateOnFile: true || false,
|
|
60
|
+
* // moderationStatus: "STRING_VALUE",
|
|
61
|
+
* // fieldModerationStatus: { // StringMap
|
|
62
|
+
* // "<keys>": "STRING_VALUE",
|
|
63
|
+
* // },
|
|
64
|
+
* // };
|
|
65
|
+
*
|
|
66
|
+
* ```
|
|
67
|
+
*
|
|
68
|
+
* @param GetChatProfileCommandInput - {@link GetChatProfileCommandInput}
|
|
69
|
+
* @returns {@link GetChatProfileCommandOutput}
|
|
70
|
+
* @see {@link GetChatProfileCommandInput} for command's `input` shape.
|
|
71
|
+
* @see {@link GetChatProfileCommandOutput} for command's `response` shape.
|
|
72
|
+
* @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link BadRequestError} (client fault)
|
|
75
|
+
* 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link NotFoundError} (client fault)
|
|
78
|
+
* 404: the resource does not exist or is not visible to the caller (code `NOT_FOUND`, or a more
|
|
79
|
+
* specific one such as `REQUEST_UNAVAILABLE`).
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link InternalServerError} (server fault)
|
|
82
|
+
* 500: an unexpected failure (code `INTERNAL_ERROR`).
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link UnauthorizedError} (client fault)
|
|
85
|
+
* 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link ForbiddenError} (client fault)
|
|
88
|
+
* 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
|
|
89
|
+
* `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link TooManyRequestsError} (client fault)
|
|
92
|
+
* 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
|
|
93
|
+
* `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
|
|
94
|
+
* model.
|
|
95
|
+
*
|
|
96
|
+
* @throws {@link BadGatewayError} (server fault)
|
|
97
|
+
* 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
|
|
98
|
+
* (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
|
|
99
|
+
* (`PROPAGATION_FAILED`, retrying the same request is safe).
|
|
100
|
+
*
|
|
101
|
+
* @throws {@link ServiceUnavailableError} (server fault)
|
|
102
|
+
* 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
|
|
103
|
+
* `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
|
|
104
|
+
*
|
|
105
|
+
* @throws {@link OneHookServiceException}
|
|
106
|
+
* <p>Base exception class for all service exceptions from OneHook service.</p>
|
|
107
|
+
*
|
|
108
|
+
*
|
|
109
|
+
* @public
|
|
110
|
+
*/
|
|
111
|
+
export declare class GetChatProfileCommand extends GetChatProfileCommand_base {
|
|
112
|
+
/** @internal type navigation helper, not in runtime. */
|
|
113
|
+
protected static __types: {
|
|
114
|
+
api: {
|
|
115
|
+
input: GetOtherProfileRequest;
|
|
116
|
+
output: ChatProfile;
|
|
117
|
+
};
|
|
118
|
+
sdk: {
|
|
119
|
+
input: GetChatProfileCommandInput;
|
|
120
|
+
output: GetChatProfileCommandOutput;
|
|
121
|
+
};
|
|
122
|
+
};
|
|
123
|
+
}
|
|
@@ -50,6 +50,8 @@ declare const GetChatSettingsCommand_base: {
|
|
|
50
50
|
* // screenshotProtection: true || false,
|
|
51
51
|
* // defaultDisappearingSeconds: Number("int"),
|
|
52
52
|
* // helpTranslateCaptions: true || false,
|
|
53
|
+
* // connectionNotifications: true || false,
|
|
54
|
+
* // likeNotifications: true || false,
|
|
53
55
|
* // },
|
|
54
56
|
* // };
|
|
55
57
|
*
|
|
@@ -62,8 +64,28 @@ declare const GetChatSettingsCommand_base: {
|
|
|
62
64
|
* @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
|
|
63
65
|
*
|
|
64
66
|
* @throws {@link ForbiddenError} (client fault)
|
|
67
|
+
* 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
|
|
68
|
+
* `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
|
|
65
69
|
*
|
|
66
70
|
* @throws {@link InternalServerError} (server fault)
|
|
71
|
+
* 500: an unexpected failure (code `INTERNAL_ERROR`).
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link UnauthorizedError} (client fault)
|
|
74
|
+
* 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
|
|
75
|
+
*
|
|
76
|
+
* @throws {@link TooManyRequestsError} (client fault)
|
|
77
|
+
* 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
|
|
78
|
+
* `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
|
|
79
|
+
* model.
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link BadGatewayError} (server fault)
|
|
82
|
+
* 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
|
|
83
|
+
* (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
|
|
84
|
+
* (`PROPAGATION_FAILED`, retrying the same request is safe).
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link ServiceUnavailableError} (server fault)
|
|
87
|
+
* 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
|
|
88
|
+
* `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
|
|
67
89
|
*
|
|
68
90
|
* @throws {@link OneHookServiceException}
|
|
69
91
|
* <p>Base exception class for all service exceptions from OneHook service.</p>
|
|
@@ -67,10 +67,35 @@ declare const GetCredentialReadinessCommand_base: {
|
|
|
67
67
|
* @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
|
|
68
68
|
*
|
|
69
69
|
* @throws {@link BadRequestError} (client fault)
|
|
70
|
+
* 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
|
|
70
71
|
*
|
|
71
72
|
* @throws {@link NotFoundError} (client fault)
|
|
73
|
+
* 404: the resource does not exist or is not visible to the caller (code `NOT_FOUND`, or a more
|
|
74
|
+
* specific one such as `REQUEST_UNAVAILABLE`).
|
|
72
75
|
*
|
|
73
76
|
* @throws {@link InternalServerError} (server fault)
|
|
77
|
+
* 500: an unexpected failure (code `INTERNAL_ERROR`).
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link UnauthorizedError} (client fault)
|
|
80
|
+
* 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
|
|
81
|
+
*
|
|
82
|
+
* @throws {@link ForbiddenError} (client fault)
|
|
83
|
+
* 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
|
|
84
|
+
* `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link TooManyRequestsError} (client fault)
|
|
87
|
+
* 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
|
|
88
|
+
* `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
|
|
89
|
+
* model.
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link BadGatewayError} (server fault)
|
|
92
|
+
* 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
|
|
93
|
+
* (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
|
|
94
|
+
* (`PROPAGATION_FAILED`, retrying the same request is safe).
|
|
95
|
+
*
|
|
96
|
+
* @throws {@link ServiceUnavailableError} (server fault)
|
|
97
|
+
* 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
|
|
98
|
+
* `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
|
|
74
99
|
*
|
|
75
100
|
* @throws {@link OneHookServiceException}
|
|
76
101
|
* <p>Base exception class for all service exceptions from OneHook service.</p>
|
|
@@ -0,0 +1,138 @@
|
|
|
1
|
+
import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
|
|
2
|
+
import { DiscoverySnapshot, TargetUserRequest } 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 GetDiscoverySnapshotCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetDiscoverySnapshotCommandInput extends TargetUserRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetDiscoverySnapshotCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetDiscoverySnapshotCommandOutput extends DiscoverySnapshot, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetDiscoverySnapshotCommand_base: {
|
|
25
|
+
new (input: GetDiscoverySnapshotCommandInput): import("@smithy/smithy-client").CommandImpl<GetDiscoverySnapshotCommandInput, GetDiscoverySnapshotCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetDiscoverySnapshotCommandInput): import("@smithy/smithy-client").CommandImpl<GetDiscoverySnapshotCommandInput, GetDiscoverySnapshotCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* What Matching reads once when a member turns matching on, to build their discovery rows. Full lists,
|
|
31
|
+
* no paging. The state item, hooks, history and outgoing blocks are strongly consistent reads; incoming
|
|
32
|
+
* blocks come from a GSI. 404 when State has no record; 403 without an IAM caller.
|
|
33
|
+
* @example
|
|
34
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
35
|
+
* ```javascript
|
|
36
|
+
* import { OneHookClient, GetDiscoverySnapshotCommand } from "onehook-api-client"; // ES Modules import
|
|
37
|
+
* // const { OneHookClient, GetDiscoverySnapshotCommand } = require("onehook-api-client"); // CommonJS import
|
|
38
|
+
* const client = new OneHookClient(config);
|
|
39
|
+
* const input = { // TargetUserRequest
|
|
40
|
+
* targetUserId: "STRING_VALUE", // required
|
|
41
|
+
* };
|
|
42
|
+
* const command = new GetDiscoverySnapshotCommand(input);
|
|
43
|
+
* const response = await client.send(command);
|
|
44
|
+
* // { // DiscoverySnapshot
|
|
45
|
+
* // userId: "STRING_VALUE", // required
|
|
46
|
+
* // stateVersion: Number("long"), // required
|
|
47
|
+
* // discoveryPaused: true || false, // required
|
|
48
|
+
* // matching: { // MatchingStatus
|
|
49
|
+
* // status: "OFF" || "ON" || "ERASING", // required
|
|
50
|
+
* // generation: Number("long"), // required
|
|
51
|
+
* // },
|
|
52
|
+
* // currentHooks: [ // SnapshotCurrentHookList // required
|
|
53
|
+
* // { // SnapshotCurrentHook
|
|
54
|
+
* // matchId: "STRING_VALUE", // required
|
|
55
|
+
* // peerId: "STRING_VALUE", // required
|
|
56
|
+
* // origin: "DISCOVERY" || "REQUEST", // required
|
|
57
|
+
* // hookedAt: Number("long"), // required
|
|
58
|
+
* // },
|
|
59
|
+
* // ],
|
|
60
|
+
* // pastHooks: [ // SnapshotPastHookList // required
|
|
61
|
+
* // { // SnapshotPastHook
|
|
62
|
+
* // matchId: "STRING_VALUE", // required
|
|
63
|
+
* // peerId: "STRING_VALUE", // required
|
|
64
|
+
* // origin: "DISCOVERY" || "REQUEST", // required
|
|
65
|
+
* // hookedAt: Number("long"), // required
|
|
66
|
+
* // releasedAt: Number("long"), // required
|
|
67
|
+
* // endReason: "UNHOOK" || "BLOCKED" || "ACCOUNT_DELETED" || "TIER_DOWNGRADE", // required
|
|
68
|
+
* // endedBy: "STRING_VALUE",
|
|
69
|
+
* // },
|
|
70
|
+
* // ],
|
|
71
|
+
* // blocks: [ // SnapshotBlockList // required
|
|
72
|
+
* // { // SnapshotBlock
|
|
73
|
+
* // counterpartId: "STRING_VALUE", // required
|
|
74
|
+
* // direction: "OUTGOING" || "INCOMING", // required
|
|
75
|
+
* // version: Number("long"), // required
|
|
76
|
+
* // blockedAt: Number("long"), // required
|
|
77
|
+
* // },
|
|
78
|
+
* // ],
|
|
79
|
+
* // };
|
|
80
|
+
*
|
|
81
|
+
* ```
|
|
82
|
+
*
|
|
83
|
+
* @param GetDiscoverySnapshotCommandInput - {@link GetDiscoverySnapshotCommandInput}
|
|
84
|
+
* @returns {@link GetDiscoverySnapshotCommandOutput}
|
|
85
|
+
* @see {@link GetDiscoverySnapshotCommandInput} for command's `input` shape.
|
|
86
|
+
* @see {@link GetDiscoverySnapshotCommandOutput} for command's `response` shape.
|
|
87
|
+
* @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link BadRequestError} (client fault)
|
|
90
|
+
* 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link ForbiddenError} (client fault)
|
|
93
|
+
* 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
|
|
94
|
+
* `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
|
|
95
|
+
*
|
|
96
|
+
* @throws {@link NotFoundError} (client fault)
|
|
97
|
+
* 404: the resource does not exist or is not visible to the caller (code `NOT_FOUND`, or a more
|
|
98
|
+
* specific one such as `REQUEST_UNAVAILABLE`).
|
|
99
|
+
*
|
|
100
|
+
* @throws {@link InternalServerError} (server fault)
|
|
101
|
+
* 500: an unexpected failure (code `INTERNAL_ERROR`).
|
|
102
|
+
*
|
|
103
|
+
* @throws {@link UnauthorizedError} (client fault)
|
|
104
|
+
* 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
|
|
105
|
+
*
|
|
106
|
+
* @throws {@link TooManyRequestsError} (client fault)
|
|
107
|
+
* 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
|
|
108
|
+
* `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
|
|
109
|
+
* model.
|
|
110
|
+
*
|
|
111
|
+
* @throws {@link BadGatewayError} (server fault)
|
|
112
|
+
* 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
|
|
113
|
+
* (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
|
|
114
|
+
* (`PROPAGATION_FAILED`, retrying the same request is safe).
|
|
115
|
+
*
|
|
116
|
+
* @throws {@link ServiceUnavailableError} (server fault)
|
|
117
|
+
* 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
|
|
118
|
+
* `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
|
|
119
|
+
*
|
|
120
|
+
* @throws {@link OneHookServiceException}
|
|
121
|
+
* <p>Base exception class for all service exceptions from OneHook service.</p>
|
|
122
|
+
*
|
|
123
|
+
*
|
|
124
|
+
* @public
|
|
125
|
+
*/
|
|
126
|
+
export declare class GetDiscoverySnapshotCommand extends GetDiscoverySnapshotCommand_base {
|
|
127
|
+
/** @internal type navigation helper, not in runtime. */
|
|
128
|
+
protected static __types: {
|
|
129
|
+
api: {
|
|
130
|
+
input: TargetUserRequest;
|
|
131
|
+
output: DiscoverySnapshot;
|
|
132
|
+
};
|
|
133
|
+
sdk: {
|
|
134
|
+
input: GetDiscoverySnapshotCommandInput;
|
|
135
|
+
output: GetDiscoverySnapshotCommandOutput;
|
|
136
|
+
};
|
|
137
|
+
};
|
|
138
|
+
}
|
|
@@ -0,0 +1,119 @@
|
|
|
1
|
+
import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
|
|
2
|
+
import { GraphInviteTree, GraphInvitesRequest } 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 GetGraphInvitesCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetGraphInvitesCommandInput extends GraphInvitesRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetGraphInvitesCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetGraphInvitesCommandOutput extends GraphInviteTree, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetGraphInvitesCommand_base: {
|
|
25
|
+
new (input: GetGraphInvitesCommandInput): import("@smithy/smithy-client").CommandImpl<GetGraphInvitesCommandInput, GetGraphInvitesCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetGraphInvitesCommandInput): import("@smithy/smithy-client").CommandImpl<GetGraphInvitesCommandInput, GetGraphInvitesCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* The member's invite subtree, breadth first, up to `depth` levels (default 4, at most 8) and 1000 nodes.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { OneHookClient, GetGraphInvitesCommand } from "onehook-api-client"; // ES Modules import
|
|
35
|
+
* // const { OneHookClient, GetGraphInvitesCommand } = require("onehook-api-client"); // CommonJS import
|
|
36
|
+
* const client = new OneHookClient(config);
|
|
37
|
+
* const input = { // GraphInvitesRequest
|
|
38
|
+
* userId: "STRING_VALUE", // required
|
|
39
|
+
* depth: Number("double"),
|
|
40
|
+
* };
|
|
41
|
+
* const command = new GetGraphInvitesCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // { // GraphInviteTree
|
|
44
|
+
* // root: { // InviteNode
|
|
45
|
+
* // userId: "STRING_VALUE", // required
|
|
46
|
+
* // depth: Number("int"), // required
|
|
47
|
+
* // invitedAt: Number("long"),
|
|
48
|
+
* // children: [ // InviteNodeList // required
|
|
49
|
+
* // {
|
|
50
|
+
* // userId: "STRING_VALUE", // required
|
|
51
|
+
* // depth: Number("int"), // required
|
|
52
|
+
* // invitedAt: Number("long"),
|
|
53
|
+
* // children: [ // required
|
|
54
|
+
* // "<InviteNode>",
|
|
55
|
+
* // ],
|
|
56
|
+
* // truncated: true || false,
|
|
57
|
+
* // },
|
|
58
|
+
* // ],
|
|
59
|
+
* // truncated: true || false,
|
|
60
|
+
* // },
|
|
61
|
+
* // totalInvitees: Number("int"), // required
|
|
62
|
+
* // truncated: true || false, // required
|
|
63
|
+
* // };
|
|
64
|
+
*
|
|
65
|
+
* ```
|
|
66
|
+
*
|
|
67
|
+
* @param GetGraphInvitesCommandInput - {@link GetGraphInvitesCommandInput}
|
|
68
|
+
* @returns {@link GetGraphInvitesCommandOutput}
|
|
69
|
+
* @see {@link GetGraphInvitesCommandInput} for command's `input` shape.
|
|
70
|
+
* @see {@link GetGraphInvitesCommandOutput} for command's `response` shape.
|
|
71
|
+
* @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link NotFoundError} (client fault)
|
|
74
|
+
* 404: the resource does not exist or is not visible to the caller (code `NOT_FOUND`, or a more
|
|
75
|
+
* specific one such as `REQUEST_UNAVAILABLE`).
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link InternalServerError} (server fault)
|
|
78
|
+
* 500: an unexpected failure (code `INTERNAL_ERROR`).
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link UnauthorizedError} (client fault)
|
|
81
|
+
* 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link ForbiddenError} (client fault)
|
|
84
|
+
* 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
|
|
85
|
+
* `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link TooManyRequestsError} (client fault)
|
|
88
|
+
* 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
|
|
89
|
+
* `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
|
|
90
|
+
* model.
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link BadGatewayError} (server fault)
|
|
93
|
+
* 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
|
|
94
|
+
* (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
|
|
95
|
+
* (`PROPAGATION_FAILED`, retrying the same request is safe).
|
|
96
|
+
*
|
|
97
|
+
* @throws {@link ServiceUnavailableError} (server fault)
|
|
98
|
+
* 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
|
|
99
|
+
* `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
|
|
100
|
+
*
|
|
101
|
+
* @throws {@link OneHookServiceException}
|
|
102
|
+
* <p>Base exception class for all service exceptions from OneHook service.</p>
|
|
103
|
+
*
|
|
104
|
+
*
|
|
105
|
+
* @public
|
|
106
|
+
*/
|
|
107
|
+
export declare class GetGraphInvitesCommand extends GetGraphInvitesCommand_base {
|
|
108
|
+
/** @internal type navigation helper, not in runtime. */
|
|
109
|
+
protected static __types: {
|
|
110
|
+
api: {
|
|
111
|
+
input: GraphInvitesRequest;
|
|
112
|
+
output: GraphInviteTree;
|
|
113
|
+
};
|
|
114
|
+
sdk: {
|
|
115
|
+
input: GetGraphInvitesCommandInput;
|
|
116
|
+
output: GetGraphInvitesCommandOutput;
|
|
117
|
+
};
|
|
118
|
+
};
|
|
119
|
+
}
|
|
@@ -0,0 +1,136 @@
|
|
|
1
|
+
import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
|
|
2
|
+
import { GraphMatch, GraphMatchRequest } 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 GetGraphMatchCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetGraphMatchCommandInput extends GraphMatchRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetGraphMatchCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetGraphMatchCommandOutput extends GraphMatch, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetGraphMatchCommand_base: {
|
|
25
|
+
new (input: GetGraphMatchCommandInput): import("@smithy/smithy-client").CommandImpl<GetGraphMatchCommandInput, GetGraphMatchCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetGraphMatchCommandInput): import("@smithy/smithy-client").CommandImpl<GetGraphMatchCommandInput, GetGraphMatchCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* One match with its full conversation metrics. 404 when unknown or erased.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { OneHookClient, GetGraphMatchCommand } from "onehook-api-client"; // ES Modules import
|
|
35
|
+
* // const { OneHookClient, GetGraphMatchCommand } = require("onehook-api-client"); // CommonJS import
|
|
36
|
+
* const client = new OneHookClient(config);
|
|
37
|
+
* const input = { // GraphMatchRequest
|
|
38
|
+
* matchId: "STRING_VALUE", // required
|
|
39
|
+
* };
|
|
40
|
+
* const command = new GetGraphMatchCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // { // GraphMatch
|
|
43
|
+
* // matchId: "STRING_VALUE", // required
|
|
44
|
+
* // userA: "STRING_VALUE",
|
|
45
|
+
* // userB: "STRING_VALUE",
|
|
46
|
+
* // matchedAt: Number("long"),
|
|
47
|
+
* // origin: "STRING_VALUE",
|
|
48
|
+
* // metrics: { // ConversationMetrics
|
|
49
|
+
* // messageCount: Number("int"), // required
|
|
50
|
+
* // messagesByUser: { // UserCounts // required
|
|
51
|
+
* // "<keys>": Number("int"),
|
|
52
|
+
* // },
|
|
53
|
+
* // participantCount: Number("int"), // required
|
|
54
|
+
* // oneSided: true || false, // required
|
|
55
|
+
* // responded: true || false, // required
|
|
56
|
+
* // ghosted: true || false, // required
|
|
57
|
+
* // whoMessagedFirst: "STRING_VALUE",
|
|
58
|
+
* // initiatedBy: "STRING_VALUE",
|
|
59
|
+
* // firstMessageAt: Number("long"),
|
|
60
|
+
* // lastMessageAt: Number("long"),
|
|
61
|
+
* // conversationSpanMs: Number("long"),
|
|
62
|
+
* // firstResponseLatencyMs: Number("long"),
|
|
63
|
+
* // replyCount: Number("int"), // required
|
|
64
|
+
* // avgReplyMs: Number("long"),
|
|
65
|
+
* // minReplyMs: Number("long"),
|
|
66
|
+
* // maxReplyMs: Number("long"),
|
|
67
|
+
* // replyLatencyByUser: { // ReplyLatencyByUser // required
|
|
68
|
+
* // "<keys>": { // ReplyLatency
|
|
69
|
+
* // count: Number("int"), // required
|
|
70
|
+
* // avgMs: Number("long"), // required
|
|
71
|
+
* // minMs: Number("long"),
|
|
72
|
+
* // maxMs: Number("long"),
|
|
73
|
+
* // },
|
|
74
|
+
* // },
|
|
75
|
+
* // sessionCount: Number("int"), // required
|
|
76
|
+
* // totalActiveMs: Number("long"), // required
|
|
77
|
+
* // longestSessionMs: Number("long"), // required
|
|
78
|
+
* // avgSessionMs: Number("long"),
|
|
79
|
+
* // },
|
|
80
|
+
* // };
|
|
81
|
+
*
|
|
82
|
+
* ```
|
|
83
|
+
*
|
|
84
|
+
* @param GetGraphMatchCommandInput - {@link GetGraphMatchCommandInput}
|
|
85
|
+
* @returns {@link GetGraphMatchCommandOutput}
|
|
86
|
+
* @see {@link GetGraphMatchCommandInput} for command's `input` shape.
|
|
87
|
+
* @see {@link GetGraphMatchCommandOutput} for command's `response` shape.
|
|
88
|
+
* @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link NotFoundError} (client fault)
|
|
91
|
+
* 404: the resource does not exist or is not visible to the caller (code `NOT_FOUND`, or a more
|
|
92
|
+
* specific one such as `REQUEST_UNAVAILABLE`).
|
|
93
|
+
*
|
|
94
|
+
* @throws {@link InternalServerError} (server fault)
|
|
95
|
+
* 500: an unexpected failure (code `INTERNAL_ERROR`).
|
|
96
|
+
*
|
|
97
|
+
* @throws {@link UnauthorizedError} (client fault)
|
|
98
|
+
* 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
|
|
99
|
+
*
|
|
100
|
+
* @throws {@link ForbiddenError} (client fault)
|
|
101
|
+
* 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
|
|
102
|
+
* `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
|
|
103
|
+
*
|
|
104
|
+
* @throws {@link TooManyRequestsError} (client fault)
|
|
105
|
+
* 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
|
|
106
|
+
* `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
|
|
107
|
+
* model.
|
|
108
|
+
*
|
|
109
|
+
* @throws {@link BadGatewayError} (server fault)
|
|
110
|
+
* 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
|
|
111
|
+
* (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
|
|
112
|
+
* (`PROPAGATION_FAILED`, retrying the same request is safe).
|
|
113
|
+
*
|
|
114
|
+
* @throws {@link ServiceUnavailableError} (server fault)
|
|
115
|
+
* 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
|
|
116
|
+
* `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
|
|
117
|
+
*
|
|
118
|
+
* @throws {@link OneHookServiceException}
|
|
119
|
+
* <p>Base exception class for all service exceptions from OneHook service.</p>
|
|
120
|
+
*
|
|
121
|
+
*
|
|
122
|
+
* @public
|
|
123
|
+
*/
|
|
124
|
+
export declare class GetGraphMatchCommand extends GetGraphMatchCommand_base {
|
|
125
|
+
/** @internal type navigation helper, not in runtime. */
|
|
126
|
+
protected static __types: {
|
|
127
|
+
api: {
|
|
128
|
+
input: GraphMatchRequest;
|
|
129
|
+
output: GraphMatch;
|
|
130
|
+
};
|
|
131
|
+
sdk: {
|
|
132
|
+
input: GetGraphMatchCommandInput;
|
|
133
|
+
output: GetGraphMatchCommandOutput;
|
|
134
|
+
};
|
|
135
|
+
};
|
|
136
|
+
}
|