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
|
@@ -52,6 +52,8 @@ declare const GetMatchCommand_base: {
|
|
|
52
52
|
* // latestMessageTimestamp: Number("long"),
|
|
53
53
|
* // endedBy: "STRING_VALUE",
|
|
54
54
|
* // endReason: "STRING_VALUE",
|
|
55
|
+
* // origin: "DISCOVERY" || "REQUEST",
|
|
56
|
+
* // suspended: true || false,
|
|
55
57
|
* // };
|
|
56
58
|
*
|
|
57
59
|
* ```
|
|
@@ -63,10 +65,35 @@ declare const GetMatchCommand_base: {
|
|
|
63
65
|
* @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
|
|
64
66
|
*
|
|
65
67
|
* @throws {@link BadRequestError} (client fault)
|
|
68
|
+
* 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
|
|
66
69
|
*
|
|
67
70
|
* @throws {@link NotFoundError} (client fault)
|
|
71
|
+
* 404: the resource does not exist or is not visible to the caller (code `NOT_FOUND`, or a more
|
|
72
|
+
* specific one such as `REQUEST_UNAVAILABLE`).
|
|
68
73
|
*
|
|
69
74
|
* @throws {@link InternalServerError} (server fault)
|
|
75
|
+
* 500: an unexpected failure (code `INTERNAL_ERROR`).
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link UnauthorizedError} (client fault)
|
|
78
|
+
* 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link ForbiddenError} (client fault)
|
|
81
|
+
* 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
|
|
82
|
+
* `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link TooManyRequestsError} (client fault)
|
|
85
|
+
* 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
|
|
86
|
+
* `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
|
|
87
|
+
* model.
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link BadGatewayError} (server fault)
|
|
90
|
+
* 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
|
|
91
|
+
* (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
|
|
92
|
+
* (`PROPAGATION_FAILED`, retrying the same request is safe).
|
|
93
|
+
*
|
|
94
|
+
* @throws {@link ServiceUnavailableError} (server fault)
|
|
95
|
+
* 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
|
|
96
|
+
* `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
|
|
70
97
|
*
|
|
71
98
|
* @throws {@link OneHookServiceException}
|
|
72
99
|
* <p>Base exception class for all service exceptions from OneHook service.</p>
|
|
@@ -0,0 +1,175 @@
|
|
|
1
|
+
import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
|
|
2
|
+
import { GetOtherProfileRequest, MatchingProfile } 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 GetMatchingProfileCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetMatchingProfileCommandInput extends GetOtherProfileRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetMatchingProfileCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetMatchingProfileCommandOutput extends MatchingProfile, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetMatchingProfileCommand_base: {
|
|
25
|
+
new (input: GetMatchingProfileCommandInput): import("@smithy/smithy-client").CommandImpl<GetMatchingProfileCommandInput, GetMatchingProfileCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetMatchingProfileCommandInput): import("@smithy/smithy-client").CommandImpl<GetMatchingProfileCommandInput, GetMatchingProfileCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Another member's matching profile. Requires an `X-View-Pass` from Matching (`aud` profile.matching)
|
|
31
|
+
* naming this member, and both members' matching profiles ACTIVE. Otherwise the same 404 as for an
|
|
32
|
+
* 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, GetMatchingProfileCommand } from "onehook-api-client"; // ES Modules import
|
|
37
|
+
* // const { OneHookClient, GetMatchingProfileCommand } = 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 GetMatchingProfileCommand(input);
|
|
44
|
+
* const response = await client.send(command);
|
|
45
|
+
* // { // MatchingProfile
|
|
46
|
+
* // userId: "STRING_VALUE", // required
|
|
47
|
+
* // status: "DRAFT" || "ACTIVE",
|
|
48
|
+
* // generation: Number("long"),
|
|
49
|
+
* // lastEditedAt: Number("long"),
|
|
50
|
+
* // draftExpiresAt: Number("long"),
|
|
51
|
+
* // displayName: "STRING_VALUE",
|
|
52
|
+
* // bio: "STRING_VALUE",
|
|
53
|
+
* // age: Number("int"),
|
|
54
|
+
* // gender: "STRING_VALUE",
|
|
55
|
+
* // interestedIn: [ // StringList
|
|
56
|
+
* // "STRING_VALUE",
|
|
57
|
+
* // ],
|
|
58
|
+
* // relationshipType: "STRING_VALUE",
|
|
59
|
+
* // wantsKids: "STRING_VALUE",
|
|
60
|
+
* // familyPlans: "STRING_VALUE",
|
|
61
|
+
* // smokingStatus: "STRING_VALUE",
|
|
62
|
+
* // drinkingStatus: "STRING_VALUE",
|
|
63
|
+
* // cannabisStatus: "STRING_VALUE",
|
|
64
|
+
* // drugsStatus: "STRING_VALUE",
|
|
65
|
+
* // religion: "STRING_VALUE",
|
|
66
|
+
* // interests: [
|
|
67
|
+
* // "STRING_VALUE",
|
|
68
|
+
* // ],
|
|
69
|
+
* // starSign: "STRING_VALUE",
|
|
70
|
+
* // verified: true || false,
|
|
71
|
+
* // subscriptionTier: "MUST" || "SUPER" || "INFINITY",
|
|
72
|
+
* // pictures: [
|
|
73
|
+
* // "STRING_VALUE",
|
|
74
|
+
* // ],
|
|
75
|
+
* // pictureTransforms: { // StringMap
|
|
76
|
+
* // "<keys>": "STRING_VALUE",
|
|
77
|
+
* // },
|
|
78
|
+
* // videos: [
|
|
79
|
+
* // "STRING_VALUE",
|
|
80
|
+
* // ],
|
|
81
|
+
* // audioPrompt: "STRING_VALUE",
|
|
82
|
+
* // moderationStatus: "STRING_VALUE",
|
|
83
|
+
* // fieldModerationStatus: {
|
|
84
|
+
* // "<keys>": "STRING_VALUE",
|
|
85
|
+
* // },
|
|
86
|
+
* // causes: [
|
|
87
|
+
* // "STRING_VALUE",
|
|
88
|
+
* // ],
|
|
89
|
+
* // communities: "<StringList>",
|
|
90
|
+
* // qualities: "<StringList>",
|
|
91
|
+
* // prompts: [ // ProfilePromptList
|
|
92
|
+
* // { // ProfilePrompt
|
|
93
|
+
* // promptId: "STRING_VALUE", // required
|
|
94
|
+
* // answer: "STRING_VALUE", // required
|
|
95
|
+
* // imageKey: "STRING_VALUE",
|
|
96
|
+
* // },
|
|
97
|
+
* // ],
|
|
98
|
+
* // socialLinks: {
|
|
99
|
+
* // "<keys>": "STRING_VALUE",
|
|
100
|
+
* // },
|
|
101
|
+
* // openers: [ // OpenerList
|
|
102
|
+
* // { // Opener
|
|
103
|
+
* // text: "STRING_VALUE", // required
|
|
104
|
+
* // imageKey: "STRING_VALUE",
|
|
105
|
+
* // },
|
|
106
|
+
* // ],
|
|
107
|
+
* // work: "STRING_VALUE",
|
|
108
|
+
* // education: "STRING_VALUE",
|
|
109
|
+
* // hometown: "STRING_VALUE",
|
|
110
|
+
* // currentLocation: "STRING_VALUE",
|
|
111
|
+
* // height: Number("int"),
|
|
112
|
+
* // exercise: "STRING_VALUE",
|
|
113
|
+
* // educationLevel: "STRING_VALUE",
|
|
114
|
+
* // politicalView: "STRING_VALUE",
|
|
115
|
+
* // languages: "<StringList>",
|
|
116
|
+
* // };
|
|
117
|
+
*
|
|
118
|
+
* ```
|
|
119
|
+
*
|
|
120
|
+
* @param GetMatchingProfileCommandInput - {@link GetMatchingProfileCommandInput}
|
|
121
|
+
* @returns {@link GetMatchingProfileCommandOutput}
|
|
122
|
+
* @see {@link GetMatchingProfileCommandInput} for command's `input` shape.
|
|
123
|
+
* @see {@link GetMatchingProfileCommandOutput} for command's `response` shape.
|
|
124
|
+
* @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
|
|
125
|
+
*
|
|
126
|
+
* @throws {@link BadRequestError} (client fault)
|
|
127
|
+
* 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
|
|
128
|
+
*
|
|
129
|
+
* @throws {@link NotFoundError} (client fault)
|
|
130
|
+
* 404: the resource does not exist or is not visible to the caller (code `NOT_FOUND`, or a more
|
|
131
|
+
* specific one such as `REQUEST_UNAVAILABLE`).
|
|
132
|
+
*
|
|
133
|
+
* @throws {@link InternalServerError} (server fault)
|
|
134
|
+
* 500: an unexpected failure (code `INTERNAL_ERROR`).
|
|
135
|
+
*
|
|
136
|
+
* @throws {@link UnauthorizedError} (client fault)
|
|
137
|
+
* 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
|
|
138
|
+
*
|
|
139
|
+
* @throws {@link ForbiddenError} (client fault)
|
|
140
|
+
* 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
|
|
141
|
+
* `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
|
|
142
|
+
*
|
|
143
|
+
* @throws {@link TooManyRequestsError} (client fault)
|
|
144
|
+
* 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
|
|
145
|
+
* `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
|
|
146
|
+
* model.
|
|
147
|
+
*
|
|
148
|
+
* @throws {@link BadGatewayError} (server fault)
|
|
149
|
+
* 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
|
|
150
|
+
* (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
|
|
151
|
+
* (`PROPAGATION_FAILED`, retrying the same request is safe).
|
|
152
|
+
*
|
|
153
|
+
* @throws {@link ServiceUnavailableError} (server fault)
|
|
154
|
+
* 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
|
|
155
|
+
* `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
|
|
156
|
+
*
|
|
157
|
+
* @throws {@link OneHookServiceException}
|
|
158
|
+
* <p>Base exception class for all service exceptions from OneHook service.</p>
|
|
159
|
+
*
|
|
160
|
+
*
|
|
161
|
+
* @public
|
|
162
|
+
*/
|
|
163
|
+
export declare class GetMatchingProfileCommand extends GetMatchingProfileCommand_base {
|
|
164
|
+
/** @internal type navigation helper, not in runtime. */
|
|
165
|
+
protected static __types: {
|
|
166
|
+
api: {
|
|
167
|
+
input: GetOtherProfileRequest;
|
|
168
|
+
output: MatchingProfile;
|
|
169
|
+
};
|
|
170
|
+
sdk: {
|
|
171
|
+
input: GetMatchingProfileCommandInput;
|
|
172
|
+
output: GetMatchingProfileCommandOutput;
|
|
173
|
+
};
|
|
174
|
+
};
|
|
175
|
+
}
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
|
|
2
|
+
import { GetInternalProfileRequest, MatchingReadiness } 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 GetMatchingReadinessCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetMatchingReadinessCommandInput extends GetInternalProfileRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetMatchingReadinessCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetMatchingReadinessCommandOutput extends MatchingReadiness, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetMatchingReadinessCommand_base: {
|
|
25
|
+
new (input: GetMatchingReadinessCommandInput): import("@smithy/smithy-client").CommandImpl<GetMatchingReadinessCommandInput, GetMatchingReadinessCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetMatchingReadinessCommandInput): import("@smithy/smithy-client").CommandImpl<GetMatchingReadinessCommandInput, GetMatchingReadinessCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Internal, IAM-authorized (SigV4): whether the member's matching profile is complete enough to turn
|
|
31
|
+
* matching on, and what is missing. State calls it before `EnableMatching`. 404 for an unknown member.
|
|
32
|
+
* @example
|
|
33
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
34
|
+
* ```javascript
|
|
35
|
+
* import { OneHookClient, GetMatchingReadinessCommand } from "onehook-api-client"; // ES Modules import
|
|
36
|
+
* // const { OneHookClient, GetMatchingReadinessCommand } = require("onehook-api-client"); // CommonJS import
|
|
37
|
+
* const client = new OneHookClient(config);
|
|
38
|
+
* const input = { // GetInternalProfileRequest
|
|
39
|
+
* userId: "STRING_VALUE", // required
|
|
40
|
+
* };
|
|
41
|
+
* const command = new GetMatchingReadinessCommand(input);
|
|
42
|
+
* const response = await client.send(command);
|
|
43
|
+
* // { // MatchingReadiness
|
|
44
|
+
* // ready: true || false, // required
|
|
45
|
+
* // gaps: [ // StringList // required
|
|
46
|
+
* // "STRING_VALUE",
|
|
47
|
+
* // ],
|
|
48
|
+
* // };
|
|
49
|
+
*
|
|
50
|
+
* ```
|
|
51
|
+
*
|
|
52
|
+
* @param GetMatchingReadinessCommandInput - {@link GetMatchingReadinessCommandInput}
|
|
53
|
+
* @returns {@link GetMatchingReadinessCommandOutput}
|
|
54
|
+
* @see {@link GetMatchingReadinessCommandInput} for command's `input` shape.
|
|
55
|
+
* @see {@link GetMatchingReadinessCommandOutput} for command's `response` shape.
|
|
56
|
+
* @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
|
|
57
|
+
*
|
|
58
|
+
* @throws {@link BadRequestError} (client fault)
|
|
59
|
+
* 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
|
|
60
|
+
*
|
|
61
|
+
* @throws {@link ForbiddenError} (client fault)
|
|
62
|
+
* 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
|
|
63
|
+
* `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link NotFoundError} (client fault)
|
|
66
|
+
* 404: the resource does not exist or is not visible to the caller (code `NOT_FOUND`, or a more
|
|
67
|
+
* specific one such as `REQUEST_UNAVAILABLE`).
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link InternalServerError} (server fault)
|
|
70
|
+
* 500: an unexpected failure (code `INTERNAL_ERROR`).
|
|
71
|
+
*
|
|
72
|
+
* @throws {@link UnauthorizedError} (client fault)
|
|
73
|
+
* 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link TooManyRequestsError} (client fault)
|
|
76
|
+
* 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
|
|
77
|
+
* `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
|
|
78
|
+
* model.
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link BadGatewayError} (server fault)
|
|
81
|
+
* 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
|
|
82
|
+
* (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
|
|
83
|
+
* (`PROPAGATION_FAILED`, retrying the same request is safe).
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link ServiceUnavailableError} (server fault)
|
|
86
|
+
* 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
|
|
87
|
+
* `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
|
|
88
|
+
*
|
|
89
|
+
* @throws {@link OneHookServiceException}
|
|
90
|
+
* <p>Base exception class for all service exceptions from OneHook service.</p>
|
|
91
|
+
*
|
|
92
|
+
*
|
|
93
|
+
* @public
|
|
94
|
+
*/
|
|
95
|
+
export declare class GetMatchingReadinessCommand extends GetMatchingReadinessCommand_base {
|
|
96
|
+
/** @internal type navigation helper, not in runtime. */
|
|
97
|
+
protected static __types: {
|
|
98
|
+
api: {
|
|
99
|
+
input: GetInternalProfileRequest;
|
|
100
|
+
output: MatchingReadiness;
|
|
101
|
+
};
|
|
102
|
+
sdk: {
|
|
103
|
+
input: GetMatchingReadinessCommandInput;
|
|
104
|
+
output: GetMatchingReadinessCommandOutput;
|
|
105
|
+
};
|
|
106
|
+
};
|
|
107
|
+
}
|
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
|
|
2
|
+
import { MediaStatsResponse } 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 GetMediaStatsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetMediaStatsCommandInput {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetMediaStatsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetMediaStatsCommandOutput extends MediaStatsResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetMediaStatsCommand_base: {
|
|
25
|
+
new (input: GetMediaStatsCommandInput): import("@smithy/smithy-client").CommandImpl<GetMediaStatsCommandInput, GetMediaStatsCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (...[input]: [] | [GetMediaStatsCommandInput]): import("@smithy/smithy-client").CommandImpl<GetMediaStatsCommandInput, GetMediaStatsCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Per-photo view statistics for the caller's own photos.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { OneHookClient, GetMediaStatsCommand } from "onehook-api-client"; // ES Modules import
|
|
35
|
+
* // const { OneHookClient, GetMediaStatsCommand } = require("onehook-api-client"); // CommonJS import
|
|
36
|
+
* const client = new OneHookClient(config);
|
|
37
|
+
* const input = {};
|
|
38
|
+
* const command = new GetMediaStatsCommand(input);
|
|
39
|
+
* const response = await client.send(command);
|
|
40
|
+
* // { // MediaStatsResponse
|
|
41
|
+
* // photos: [ // PhotoStatsList // required
|
|
42
|
+
* // { // PhotoStats
|
|
43
|
+
* // mediaId: "STRING_VALUE", // required
|
|
44
|
+
* // uniqueViewers: Number("int"), // required
|
|
45
|
+
* // viewersMoreThanOnce: Number("int"), // required
|
|
46
|
+
* // viewersMoreThan10: Number("int"), // required
|
|
47
|
+
* // viewersMoreThan100: Number("int"), // required
|
|
48
|
+
* // fullscreenViewers: Number("int"), // required
|
|
49
|
+
* // totalViews: Number("int"), // required
|
|
50
|
+
* // totalFullscreenOpens: Number("int"), // required
|
|
51
|
+
* // updatedAt: Number("long"),
|
|
52
|
+
* // },
|
|
53
|
+
* // ],
|
|
54
|
+
* // };
|
|
55
|
+
*
|
|
56
|
+
* ```
|
|
57
|
+
*
|
|
58
|
+
* @param GetMediaStatsCommandInput - {@link GetMediaStatsCommandInput}
|
|
59
|
+
* @returns {@link GetMediaStatsCommandOutput}
|
|
60
|
+
* @see {@link GetMediaStatsCommandInput} for command's `input` shape.
|
|
61
|
+
* @see {@link GetMediaStatsCommandOutput} for command's `response` shape.
|
|
62
|
+
* @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link InternalServerError} (server fault)
|
|
65
|
+
* 500: an unexpected failure (code `INTERNAL_ERROR`).
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link UnauthorizedError} (client fault)
|
|
68
|
+
* 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link ForbiddenError} (client fault)
|
|
71
|
+
* 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
|
|
72
|
+
* `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link TooManyRequestsError} (client fault)
|
|
75
|
+
* 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
|
|
76
|
+
* `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
|
|
77
|
+
* model.
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link BadGatewayError} (server fault)
|
|
80
|
+
* 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
|
|
81
|
+
* (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
|
|
82
|
+
* (`PROPAGATION_FAILED`, retrying the same request is safe).
|
|
83
|
+
*
|
|
84
|
+
* @throws {@link ServiceUnavailableError} (server fault)
|
|
85
|
+
* 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
|
|
86
|
+
* `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link OneHookServiceException}
|
|
89
|
+
* <p>Base exception class for all service exceptions from OneHook service.</p>
|
|
90
|
+
*
|
|
91
|
+
*
|
|
92
|
+
* @public
|
|
93
|
+
*/
|
|
94
|
+
export declare class GetMediaStatsCommand extends GetMediaStatsCommand_base {
|
|
95
|
+
/** @internal type navigation helper, not in runtime. */
|
|
96
|
+
protected static __types: {
|
|
97
|
+
api: {
|
|
98
|
+
input: {};
|
|
99
|
+
output: MediaStatsResponse;
|
|
100
|
+
};
|
|
101
|
+
sdk: {
|
|
102
|
+
input: GetMediaStatsCommandInput;
|
|
103
|
+
output: GetMediaStatsCommandOutput;
|
|
104
|
+
};
|
|
105
|
+
};
|
|
106
|
+
}
|
|
@@ -0,0 +1,113 @@
|
|
|
1
|
+
import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
|
|
2
|
+
import { GetModerationReportRequest, ModerationReport } 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 GetModerationReportCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetModerationReportCommandInput extends GetModerationReportRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetModerationReportCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetModerationReportCommandOutput extends ModerationReport, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetModerationReportCommand_base: {
|
|
25
|
+
new (input: GetModerationReportCommandInput): import("@smithy/smithy-client").CommandImpl<GetModerationReportCommandInput, GetModerationReportCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetModerationReportCommandInput): import("@smithy/smithy-client").CommandImpl<GetModerationReportCommandInput, GetModerationReportCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* One member report, for the moderation case view and the evidence presign check.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { OneHookClient, GetModerationReportCommand } from "onehook-api-client"; // ES Modules import
|
|
35
|
+
* // const { OneHookClient, GetModerationReportCommand } = require("onehook-api-client"); // CommonJS import
|
|
36
|
+
* const client = new OneHookClient(config);
|
|
37
|
+
* const input = { // GetModerationReportRequest
|
|
38
|
+
* reportId: "STRING_VALUE", // required
|
|
39
|
+
* };
|
|
40
|
+
* const command = new GetModerationReportCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // { // ModerationReport
|
|
43
|
+
* // reportId: "STRING_VALUE", // required
|
|
44
|
+
* // reporterUserId: "STRING_VALUE", // required
|
|
45
|
+
* // reportedUserId: "STRING_VALUE", // required
|
|
46
|
+
* // category: "HARASSMENT" || "THREATS_VIOLENCE" || "SEXUAL_CONTENT_NONCONSENT" || "MINOR_SAFETY" || "SCAM_FRAUD" || "FAKE_IMPERSONATION" || "SPAM_PROMOTION" || "HATE" || "SELF_HARM_CONCERN" || "OFF_PLATFORM_HARM" || "OTHER", // required
|
|
47
|
+
* // severity: "STRING_VALUE", // required
|
|
48
|
+
* // details: "STRING_VALUE",
|
|
49
|
+
* // conversationId: "STRING_VALUE",
|
|
50
|
+
* // evidenceOffered: true || false, // required
|
|
51
|
+
* // alsoBlocked: true || false, // required
|
|
52
|
+
* // createdAt: "STRING_VALUE", // required
|
|
53
|
+
* // source: "STRING_VALUE",
|
|
54
|
+
* // };
|
|
55
|
+
*
|
|
56
|
+
* ```
|
|
57
|
+
*
|
|
58
|
+
* @param GetModerationReportCommandInput - {@link GetModerationReportCommandInput}
|
|
59
|
+
* @returns {@link GetModerationReportCommandOutput}
|
|
60
|
+
* @see {@link GetModerationReportCommandInput} for command's `input` shape.
|
|
61
|
+
* @see {@link GetModerationReportCommandOutput} for command's `response` shape.
|
|
62
|
+
* @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
|
|
63
|
+
*
|
|
64
|
+
* @throws {@link BadRequestError} (client fault)
|
|
65
|
+
* 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link ForbiddenError} (client fault)
|
|
68
|
+
* 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
|
|
69
|
+
* `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link NotFoundError} (client fault)
|
|
72
|
+
* 404: the resource does not exist or is not visible to the caller (code `NOT_FOUND`, or a more
|
|
73
|
+
* specific one such as `REQUEST_UNAVAILABLE`).
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link InternalServerError} (server fault)
|
|
76
|
+
* 500: an unexpected failure (code `INTERNAL_ERROR`).
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link UnauthorizedError} (client fault)
|
|
79
|
+
* 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link TooManyRequestsError} (client fault)
|
|
82
|
+
* 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
|
|
83
|
+
* `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
|
|
84
|
+
* model.
|
|
85
|
+
*
|
|
86
|
+
* @throws {@link BadGatewayError} (server fault)
|
|
87
|
+
* 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
|
|
88
|
+
* (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
|
|
89
|
+
* (`PROPAGATION_FAILED`, retrying the same request is safe).
|
|
90
|
+
*
|
|
91
|
+
* @throws {@link ServiceUnavailableError} (server fault)
|
|
92
|
+
* 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
|
|
93
|
+
* `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link OneHookServiceException}
|
|
96
|
+
* <p>Base exception class for all service exceptions from OneHook service.</p>
|
|
97
|
+
*
|
|
98
|
+
*
|
|
99
|
+
* @public
|
|
100
|
+
*/
|
|
101
|
+
export declare class GetModerationReportCommand extends GetModerationReportCommand_base {
|
|
102
|
+
/** @internal type navigation helper, not in runtime. */
|
|
103
|
+
protected static __types: {
|
|
104
|
+
api: {
|
|
105
|
+
input: GetModerationReportRequest;
|
|
106
|
+
output: ModerationReport;
|
|
107
|
+
};
|
|
108
|
+
sdk: {
|
|
109
|
+
input: GetModerationReportCommandInput;
|
|
110
|
+
output: GetModerationReportCommandOutput;
|
|
111
|
+
};
|
|
112
|
+
};
|
|
113
|
+
}
|
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
|
|
2
|
+
import { ModerationSignals, 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 GetModerationSignalsCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface GetModerationSignalsCommandInput extends TargetUserRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link GetModerationSignalsCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface GetModerationSignalsCommandOutput extends ModerationSignals, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const GetModerationSignalsCommand_base: {
|
|
25
|
+
new (input: GetModerationSignalsCommandInput): import("@smithy/smithy-client").CommandImpl<GetModerationSignalsCommandInput, GetModerationSignalsCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: GetModerationSignalsCommandInput): import("@smithy/smithy-client").CommandImpl<GetModerationSignalsCommandInput, GetModerationSignalsCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Counts that help a moderator judge a member: reports received and filed, blocks received, hooks.
|
|
31
|
+
* @example
|
|
32
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
33
|
+
* ```javascript
|
|
34
|
+
* import { OneHookClient, GetModerationSignalsCommand } from "onehook-api-client"; // ES Modules import
|
|
35
|
+
* // const { OneHookClient, GetModerationSignalsCommand } = require("onehook-api-client"); // CommonJS import
|
|
36
|
+
* const client = new OneHookClient(config);
|
|
37
|
+
* const input = { // TargetUserRequest
|
|
38
|
+
* targetUserId: "STRING_VALUE", // required
|
|
39
|
+
* };
|
|
40
|
+
* const command = new GetModerationSignalsCommand(input);
|
|
41
|
+
* const response = await client.send(command);
|
|
42
|
+
* // { // ModerationSignals
|
|
43
|
+
* // reportsReceived: { // ReportsReceivedSignals
|
|
44
|
+
* // total: Number("long"), // required
|
|
45
|
+
* // last24h: Number("long"), // required
|
|
46
|
+
* // last7d: Number("long"), // required
|
|
47
|
+
* // last30d: Number("long"), // required
|
|
48
|
+
* // distinctReporters: Number("long"), // required
|
|
49
|
+
* // byCategory: { // CountByKey // required
|
|
50
|
+
* // "<keys>": Number("long"),
|
|
51
|
+
* // },
|
|
52
|
+
* // },
|
|
53
|
+
* // reportsFiled: { // ReportsFiledSignals
|
|
54
|
+
* // total: Number("long"), // required
|
|
55
|
+
* // last30d: Number("long"), // required
|
|
56
|
+
* // },
|
|
57
|
+
* // blocksReceived: { // BlocksReceivedSignals
|
|
58
|
+
* // total: Number("long"), // required
|
|
59
|
+
* // distinctBlockers: Number("long"), // required
|
|
60
|
+
* // last30d: Number("long"), // required
|
|
61
|
+
* // },
|
|
62
|
+
* // conversations: { // ConversationSignals
|
|
63
|
+
* // matchesTotal: Number("long"), // required
|
|
64
|
+
* // activeConversations30d: Number("long"),
|
|
65
|
+
* // },
|
|
66
|
+
* // accountAgeDays: Number("long"),
|
|
67
|
+
* // reciprocalReports: Number("long"), // required
|
|
68
|
+
* // };
|
|
69
|
+
*
|
|
70
|
+
* ```
|
|
71
|
+
*
|
|
72
|
+
* @param GetModerationSignalsCommandInput - {@link GetModerationSignalsCommandInput}
|
|
73
|
+
* @returns {@link GetModerationSignalsCommandOutput}
|
|
74
|
+
* @see {@link GetModerationSignalsCommandInput} for command's `input` shape.
|
|
75
|
+
* @see {@link GetModerationSignalsCommandOutput} for command's `response` shape.
|
|
76
|
+
* @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link BadRequestError} (client fault)
|
|
79
|
+
* 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
|
|
80
|
+
*
|
|
81
|
+
* @throws {@link ForbiddenError} (client fault)
|
|
82
|
+
* 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
|
|
83
|
+
* `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
|
|
84
|
+
*
|
|
85
|
+
* @throws {@link InternalServerError} (server fault)
|
|
86
|
+
* 500: an unexpected failure (code `INTERNAL_ERROR`).
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link UnauthorizedError} (client fault)
|
|
89
|
+
* 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
|
|
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 GetModerationSignalsCommand extends GetModerationSignalsCommand_base {
|
|
112
|
+
/** @internal type navigation helper, not in runtime. */
|
|
113
|
+
protected static __types: {
|
|
114
|
+
api: {
|
|
115
|
+
input: TargetUserRequest;
|
|
116
|
+
output: ModerationSignals;
|
|
117
|
+
};
|
|
118
|
+
sdk: {
|
|
119
|
+
input: GetModerationSignalsCommandInput;
|
|
120
|
+
output: GetModerationSignalsCommandOutput;
|
|
121
|
+
};
|
|
122
|
+
};
|
|
123
|
+
}
|