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
|
@@ -45,6 +45,8 @@ declare const UpdateChatSettingsCommand_base: {
|
|
|
45
45
|
* screenshotProtection: true || false,
|
|
46
46
|
* defaultDisappearingSeconds: Number("int"),
|
|
47
47
|
* helpTranslateCaptions: true || false,
|
|
48
|
+
* connectionNotifications: true || false,
|
|
49
|
+
* likeNotifications: true || false,
|
|
48
50
|
* };
|
|
49
51
|
* const command = new UpdateChatSettingsCommand(input);
|
|
50
52
|
* const response = await client.send(command);
|
|
@@ -59,6 +61,8 @@ declare const UpdateChatSettingsCommand_base: {
|
|
|
59
61
|
* // screenshotProtection: true || false,
|
|
60
62
|
* // defaultDisappearingSeconds: Number("int"),
|
|
61
63
|
* // helpTranslateCaptions: true || false,
|
|
64
|
+
* // connectionNotifications: true || false,
|
|
65
|
+
* // likeNotifications: true || false,
|
|
62
66
|
* // },
|
|
63
67
|
* // };
|
|
64
68
|
*
|
|
@@ -71,10 +75,31 @@ declare const UpdateChatSettingsCommand_base: {
|
|
|
71
75
|
* @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
|
|
72
76
|
*
|
|
73
77
|
* @throws {@link BadRequestError} (client fault)
|
|
78
|
+
* 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
|
|
74
79
|
*
|
|
75
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.
|
|
76
83
|
*
|
|
77
84
|
* @throws {@link InternalServerError} (server fault)
|
|
85
|
+
* 500: an unexpected failure (code `INTERNAL_ERROR`).
|
|
86
|
+
*
|
|
87
|
+
* @throws {@link UnauthorizedError} (client fault)
|
|
88
|
+
* 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
|
|
89
|
+
*
|
|
90
|
+
* @throws {@link TooManyRequestsError} (client fault)
|
|
91
|
+
* 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
|
|
92
|
+
* `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
|
|
93
|
+
* model.
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link BadGatewayError} (server fault)
|
|
96
|
+
* 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
|
|
97
|
+
* (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
|
|
98
|
+
* (`PROPAGATION_FAILED`, retrying the same request is safe).
|
|
99
|
+
*
|
|
100
|
+
* @throws {@link ServiceUnavailableError} (server fault)
|
|
101
|
+
* 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
|
|
102
|
+
* `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
|
|
78
103
|
*
|
|
79
104
|
* @throws {@link OneHookServiceException}
|
|
80
105
|
* <p>Base exception class for all service exceptions from OneHook service.</p>
|
|
@@ -62,10 +62,35 @@ declare const UpdateEntitlementsCommand_base: {
|
|
|
62
62
|
* @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
|
|
63
63
|
*
|
|
64
64
|
* @throws {@link BadRequestError} (client fault)
|
|
65
|
+
* 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
|
|
65
66
|
*
|
|
66
67
|
* @throws {@link NotFoundError} (client fault)
|
|
68
|
+
* 404: the resource does not exist or is not visible to the caller (code `NOT_FOUND`, or a more
|
|
69
|
+
* specific one such as `REQUEST_UNAVAILABLE`).
|
|
67
70
|
*
|
|
68
71
|
* @throws {@link InternalServerError} (server fault)
|
|
72
|
+
* 500: an unexpected failure (code `INTERNAL_ERROR`).
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link UnauthorizedError} (client fault)
|
|
75
|
+
* 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
|
|
76
|
+
*
|
|
77
|
+
* @throws {@link ForbiddenError} (client fault)
|
|
78
|
+
* 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
|
|
79
|
+
* `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
|
|
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`.
|
|
69
94
|
*
|
|
70
95
|
* @throws {@link OneHookServiceException}
|
|
71
96
|
* <p>Base exception class for all service exceptions from OneHook service.</p>
|
|
@@ -55,8 +55,31 @@ declare const UpdatePhoneNumberCommand_base: {
|
|
|
55
55
|
* @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
|
|
56
56
|
*
|
|
57
57
|
* @throws {@link BadRequestError} (client fault)
|
|
58
|
+
* 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
|
|
58
59
|
*
|
|
59
60
|
* @throws {@link InternalServerError} (server fault)
|
|
61
|
+
* 500: an unexpected failure (code `INTERNAL_ERROR`).
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link UnauthorizedError} (client fault)
|
|
64
|
+
* 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
|
|
65
|
+
*
|
|
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.
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link TooManyRequestsError} (client fault)
|
|
71
|
+
* 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
|
|
72
|
+
* `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
|
|
73
|
+
* model.
|
|
74
|
+
*
|
|
75
|
+
* @throws {@link BadGatewayError} (server fault)
|
|
76
|
+
* 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
|
|
77
|
+
* (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
|
|
78
|
+
* (`PROPAGATION_FAILED`, retrying the same request is safe).
|
|
79
|
+
*
|
|
80
|
+
* @throws {@link ServiceUnavailableError} (server fault)
|
|
81
|
+
* 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
|
|
82
|
+
* `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
|
|
60
83
|
*
|
|
61
84
|
* @throws {@link OneHookServiceException}
|
|
62
85
|
* <p>Base exception class for all service exceptions from OneHook service.</p>
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
|
|
2
|
-
import {
|
|
2
|
+
import { UpdatePreferencesRequest, UserPreferencesResponse } from "../models/models_0";
|
|
3
3
|
import { Command as $Command } from "@smithy/smithy-client";
|
|
4
4
|
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
5
5
|
/**
|
|
@@ -19,7 +19,7 @@ export interface UpdatePreferencesCommandInput extends UpdatePreferencesRequest
|
|
|
19
19
|
*
|
|
20
20
|
* The output of {@link UpdatePreferencesCommand}.
|
|
21
21
|
*/
|
|
22
|
-
export interface UpdatePreferencesCommandOutput extends
|
|
22
|
+
export interface UpdatePreferencesCommandOutput extends UserPreferencesResponse, __MetadataBearer {
|
|
23
23
|
}
|
|
24
24
|
declare const UpdatePreferencesCommand_base: {
|
|
25
25
|
new (input: UpdatePreferencesCommandInput): import("@smithy/smithy-client").CommandImpl<UpdatePreferencesCommandInput, UpdatePreferencesCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
@@ -67,6 +67,7 @@ declare const UpdatePreferencesCommand_base: {
|
|
|
67
67
|
* interests: [
|
|
68
68
|
* "STRING_VALUE",
|
|
69
69
|
* ],
|
|
70
|
+
* implicitPreferences: "<StringList>",
|
|
70
71
|
* minHeight: Number("int"),
|
|
71
72
|
* maxHeight: Number("int"),
|
|
72
73
|
* dealbreakers: "<StringList>",
|
|
@@ -75,15 +76,59 @@ declare const UpdatePreferencesCommand_base: {
|
|
|
75
76
|
* requireRecentlyActive: true || false,
|
|
76
77
|
* discoverable: true || false,
|
|
77
78
|
* incognito: true || false,
|
|
79
|
+
* hidePastHooks: true || false,
|
|
78
80
|
* distanceUnit: "STRING_VALUE",
|
|
79
|
-
* notifyMatches: true || false,
|
|
80
|
-
* notifyLikes: true || false,
|
|
81
|
-
* notifyDailyPicks: true || false,
|
|
82
81
|
* };
|
|
83
82
|
* const command = new UpdatePreferencesCommand(input);
|
|
84
83
|
* const response = await client.send(command);
|
|
85
|
-
* // { //
|
|
86
|
-
* //
|
|
84
|
+
* // { // UserPreferencesResponse
|
|
85
|
+
* // userId: "STRING_VALUE", // required
|
|
86
|
+
* // currentSuggestion: { // CurrentSuggestion
|
|
87
|
+
* // suggestionId: "STRING_VALUE", // required
|
|
88
|
+
* // reasoning: "STRING_VALUE", // required
|
|
89
|
+
* // createdAt: "STRING_VALUE", // required
|
|
90
|
+
* // },
|
|
91
|
+
* // minAge: Number("int"),
|
|
92
|
+
* // maxAge: Number("int"),
|
|
93
|
+
* // maxDistanceKm: Number("int"),
|
|
94
|
+
* // interestedInGenders: [ // StringList
|
|
95
|
+
* // "STRING_VALUE",
|
|
96
|
+
* // ],
|
|
97
|
+
* // relationshipType: "STRING_VALUE",
|
|
98
|
+
* // wantsKids: "STRING_VALUE",
|
|
99
|
+
* // familyPlans: "STRING_VALUE",
|
|
100
|
+
* // verifiedOnly: true || false,
|
|
101
|
+
* // smoking: "STRING_VALUE",
|
|
102
|
+
* // drinking: "STRING_VALUE",
|
|
103
|
+
* // cannabis: "STRING_VALUE",
|
|
104
|
+
* // drugs: "STRING_VALUE",
|
|
105
|
+
* // exercise: "STRING_VALUE",
|
|
106
|
+
* // religion: "STRING_VALUE",
|
|
107
|
+
* // educationLevel: "STRING_VALUE",
|
|
108
|
+
* // politicalView: "STRING_VALUE",
|
|
109
|
+
* // starSigns: [
|
|
110
|
+
* // "STRING_VALUE",
|
|
111
|
+
* // ],
|
|
112
|
+
* // preferredLanguages: [
|
|
113
|
+
* // "STRING_VALUE",
|
|
114
|
+
* // ],
|
|
115
|
+
* // interests: [
|
|
116
|
+
* // "STRING_VALUE",
|
|
117
|
+
* // ],
|
|
118
|
+
* // minHeight: Number("int"),
|
|
119
|
+
* // maxHeight: Number("int"),
|
|
120
|
+
* // dealbreakers: [
|
|
121
|
+
* // "STRING_VALUE",
|
|
122
|
+
* // ],
|
|
123
|
+
* // requirePhoto: true || false,
|
|
124
|
+
* // requireBio: true || false,
|
|
125
|
+
* // requireRecentlyActive: true || false,
|
|
126
|
+
* // recentlyActiveDays: Number("int"),
|
|
127
|
+
* // implicitPreferences: "<StringList>",
|
|
128
|
+
* // discoverable: true || false,
|
|
129
|
+
* // incognito: true || false,
|
|
130
|
+
* // hidePastHooks: true || false,
|
|
131
|
+
* // distanceUnit: "STRING_VALUE",
|
|
87
132
|
* // };
|
|
88
133
|
*
|
|
89
134
|
* ```
|
|
@@ -95,8 +140,31 @@ declare const UpdatePreferencesCommand_base: {
|
|
|
95
140
|
* @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
|
|
96
141
|
*
|
|
97
142
|
* @throws {@link BadRequestError} (client fault)
|
|
143
|
+
* 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
|
|
144
|
+
*
|
|
145
|
+
* @throws {@link ForbiddenError} (client fault)
|
|
146
|
+
* 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
|
|
147
|
+
* `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
|
|
98
148
|
*
|
|
99
149
|
* @throws {@link InternalServerError} (server fault)
|
|
150
|
+
* 500: an unexpected failure (code `INTERNAL_ERROR`).
|
|
151
|
+
*
|
|
152
|
+
* @throws {@link UnauthorizedError} (client fault)
|
|
153
|
+
* 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
|
|
154
|
+
*
|
|
155
|
+
* @throws {@link TooManyRequestsError} (client fault)
|
|
156
|
+
* 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
|
|
157
|
+
* `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
|
|
158
|
+
* model.
|
|
159
|
+
*
|
|
160
|
+
* @throws {@link BadGatewayError} (server fault)
|
|
161
|
+
* 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
|
|
162
|
+
* (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
|
|
163
|
+
* (`PROPAGATION_FAILED`, retrying the same request is safe).
|
|
164
|
+
*
|
|
165
|
+
* @throws {@link ServiceUnavailableError} (server fault)
|
|
166
|
+
* 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
|
|
167
|
+
* `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
|
|
100
168
|
*
|
|
101
169
|
* @throws {@link OneHookServiceException}
|
|
102
170
|
* <p>Base exception class for all service exceptions from OneHook service.</p>
|
|
@@ -108,7 +176,7 @@ export declare class UpdatePreferencesCommand extends UpdatePreferencesCommand_b
|
|
|
108
176
|
protected static __types: {
|
|
109
177
|
api: {
|
|
110
178
|
input: UpdatePreferencesRequest;
|
|
111
|
-
output:
|
|
179
|
+
output: UserPreferencesResponse;
|
|
112
180
|
};
|
|
113
181
|
sdk: {
|
|
114
182
|
input: UpdatePreferencesCommandInput;
|
|
@@ -0,0 +1,183 @@
|
|
|
1
|
+
import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
|
|
2
|
+
import { UpdateScoringPolicyRequest, UpdateScoringPolicyResponse } 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 UpdateScoringPolicyCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface UpdateScoringPolicyCommandInput extends UpdateScoringPolicyRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link UpdateScoringPolicyCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface UpdateScoringPolicyCommandOutput extends UpdateScoringPolicyResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const UpdateScoringPolicyCommand_base: {
|
|
25
|
+
new (input: UpdateScoringPolicyCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateScoringPolicyCommandInput, UpdateScoringPolicyCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (__0_0: UpdateScoringPolicyCommandInput): import("@smithy/smithy-client").CommandImpl<UpdateScoringPolicyCommandInput, UpdateScoringPolicyCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Replaces the scoring policy. Optimistic lock: the expected version is the `expectedVersion` query
|
|
31
|
+
* parameter, else the body's `expectedVersion`; when it equals the body's `version` the version is bumped
|
|
32
|
+
* (1.0.0 to 1.0.1). 409 when another administrator saved first; 400 for an out-of-range parameter or an
|
|
33
|
+
* experiment whose traffic does not sum to 100.
|
|
34
|
+
* @example
|
|
35
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
36
|
+
* ```javascript
|
|
37
|
+
* import { OneHookClient, UpdateScoringPolicyCommand } from "onehook-api-client"; // ES Modules import
|
|
38
|
+
* // const { OneHookClient, UpdateScoringPolicyCommand } = require("onehook-api-client"); // CommonJS import
|
|
39
|
+
* const client = new OneHookClient(config);
|
|
40
|
+
* const input = { // UpdateScoringPolicyRequest
|
|
41
|
+
* expectedVersionQuery: "STRING_VALUE",
|
|
42
|
+
* policy: { // ScoringPolicyConfig
|
|
43
|
+
* version: "STRING_VALUE",
|
|
44
|
+
* expectedVersion: "STRING_VALUE",
|
|
45
|
+
* updatedAt: Number("long"),
|
|
46
|
+
* updatedBy: "STRING_VALUE",
|
|
47
|
+
* changeReason: "STRING_VALUE",
|
|
48
|
+
* parameters: { // ScoringParameters
|
|
49
|
+
* profileViewTimeWeight: Number("double"),
|
|
50
|
+
* profileViewPhotoWeight: Number("double"),
|
|
51
|
+
* profileViewBioWeight: Number("double"),
|
|
52
|
+
* profileViewPromptsWeight: Number("double"),
|
|
53
|
+
* swipeLikeBaseWeight: Number("double"),
|
|
54
|
+
* swipeLikeDeliberationWeight: Number("double"),
|
|
55
|
+
* swipeDeliberationCapMs: Number("int"),
|
|
56
|
+
* superLikeWeight: Number("double"),
|
|
57
|
+
* passWeight: Number("double"),
|
|
58
|
+
* chatReplyFastWeight: Number("double"),
|
|
59
|
+
* chatInitiativeWeight: Number("double"),
|
|
60
|
+
* exposureDeficitBoost: Number("double"),
|
|
61
|
+
* reciprocalMatchWeight: Number("double"),
|
|
62
|
+
* primeTimeBoostMax: Number("double"),
|
|
63
|
+
* dwellTimeBoostMax: Number("double"),
|
|
64
|
+
* },
|
|
65
|
+
* activeExperiment: { // ABExperiment
|
|
66
|
+
* experimentId: "STRING_VALUE", // required
|
|
67
|
+
* name: "STRING_VALUE", // required
|
|
68
|
+
* description: "STRING_VALUE", // required
|
|
69
|
+
* enabled: true || false,
|
|
70
|
+
* trafficAllocation: { // TrafficAllocation
|
|
71
|
+
* "<keys>": Number("int"),
|
|
72
|
+
* },
|
|
73
|
+
* variants: { // VariantOverrides
|
|
74
|
+
* "<keys>": { // ParameterOverrides
|
|
75
|
+
* "<keys>": Number("double"),
|
|
76
|
+
* },
|
|
77
|
+
* },
|
|
78
|
+
* },
|
|
79
|
+
* },
|
|
80
|
+
* };
|
|
81
|
+
* const command = new UpdateScoringPolicyCommand(input);
|
|
82
|
+
* const response = await client.send(command);
|
|
83
|
+
* // { // UpdateScoringPolicyResponse
|
|
84
|
+
* // status: "STRING_VALUE", // required
|
|
85
|
+
* // version: "STRING_VALUE", // required
|
|
86
|
+
* // policy: { // ScoringPolicyConfig
|
|
87
|
+
* // version: "STRING_VALUE",
|
|
88
|
+
* // expectedVersion: "STRING_VALUE",
|
|
89
|
+
* // updatedAt: Number("long"),
|
|
90
|
+
* // updatedBy: "STRING_VALUE",
|
|
91
|
+
* // changeReason: "STRING_VALUE",
|
|
92
|
+
* // parameters: { // ScoringParameters
|
|
93
|
+
* // profileViewTimeWeight: Number("double"),
|
|
94
|
+
* // profileViewPhotoWeight: Number("double"),
|
|
95
|
+
* // profileViewBioWeight: Number("double"),
|
|
96
|
+
* // profileViewPromptsWeight: Number("double"),
|
|
97
|
+
* // swipeLikeBaseWeight: Number("double"),
|
|
98
|
+
* // swipeLikeDeliberationWeight: Number("double"),
|
|
99
|
+
* // swipeDeliberationCapMs: Number("int"),
|
|
100
|
+
* // superLikeWeight: Number("double"),
|
|
101
|
+
* // passWeight: Number("double"),
|
|
102
|
+
* // chatReplyFastWeight: Number("double"),
|
|
103
|
+
* // chatInitiativeWeight: Number("double"),
|
|
104
|
+
* // exposureDeficitBoost: Number("double"),
|
|
105
|
+
* // reciprocalMatchWeight: Number("double"),
|
|
106
|
+
* // primeTimeBoostMax: Number("double"),
|
|
107
|
+
* // dwellTimeBoostMax: Number("double"),
|
|
108
|
+
* // },
|
|
109
|
+
* // activeExperiment: { // ABExperiment
|
|
110
|
+
* // experimentId: "STRING_VALUE", // required
|
|
111
|
+
* // name: "STRING_VALUE", // required
|
|
112
|
+
* // description: "STRING_VALUE", // required
|
|
113
|
+
* // enabled: true || false,
|
|
114
|
+
* // trafficAllocation: { // TrafficAllocation
|
|
115
|
+
* // "<keys>": Number("int"),
|
|
116
|
+
* // },
|
|
117
|
+
* // variants: { // VariantOverrides
|
|
118
|
+
* // "<keys>": { // ParameterOverrides
|
|
119
|
+
* // "<keys>": Number("double"),
|
|
120
|
+
* // },
|
|
121
|
+
* // },
|
|
122
|
+
* // },
|
|
123
|
+
* // },
|
|
124
|
+
* // };
|
|
125
|
+
*
|
|
126
|
+
* ```
|
|
127
|
+
*
|
|
128
|
+
* @param UpdateScoringPolicyCommandInput - {@link UpdateScoringPolicyCommandInput}
|
|
129
|
+
* @returns {@link UpdateScoringPolicyCommandOutput}
|
|
130
|
+
* @see {@link UpdateScoringPolicyCommandInput} for command's `input` shape.
|
|
131
|
+
* @see {@link UpdateScoringPolicyCommandOutput} for command's `response` shape.
|
|
132
|
+
* @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
|
|
133
|
+
*
|
|
134
|
+
* @throws {@link BadRequestError} (client fault)
|
|
135
|
+
* 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
|
|
136
|
+
*
|
|
137
|
+
* @throws {@link ConflictError} (client fault)
|
|
138
|
+
* 409: the request conflicts with the current state (code `CONFLICT`, or a more specific one such
|
|
139
|
+
* as `NOT_READY` or `MATCHING_ERASING`).
|
|
140
|
+
*
|
|
141
|
+
* @throws {@link InternalServerError} (server fault)
|
|
142
|
+
* 500: an unexpected failure (code `INTERNAL_ERROR`).
|
|
143
|
+
*
|
|
144
|
+
* @throws {@link UnauthorizedError} (client fault)
|
|
145
|
+
* 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
|
|
146
|
+
*
|
|
147
|
+
* @throws {@link ForbiddenError} (client fault)
|
|
148
|
+
* 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
|
|
149
|
+
* `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
|
|
150
|
+
*
|
|
151
|
+
* @throws {@link TooManyRequestsError} (client fault)
|
|
152
|
+
* 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
|
|
153
|
+
* `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
|
|
154
|
+
* model.
|
|
155
|
+
*
|
|
156
|
+
* @throws {@link BadGatewayError} (server fault)
|
|
157
|
+
* 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
|
|
158
|
+
* (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
|
|
159
|
+
* (`PROPAGATION_FAILED`, retrying the same request is safe).
|
|
160
|
+
*
|
|
161
|
+
* @throws {@link ServiceUnavailableError} (server fault)
|
|
162
|
+
* 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
|
|
163
|
+
* `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
|
|
164
|
+
*
|
|
165
|
+
* @throws {@link OneHookServiceException}
|
|
166
|
+
* <p>Base exception class for all service exceptions from OneHook service.</p>
|
|
167
|
+
*
|
|
168
|
+
*
|
|
169
|
+
* @public
|
|
170
|
+
*/
|
|
171
|
+
export declare class UpdateScoringPolicyCommand extends UpdateScoringPolicyCommand_base {
|
|
172
|
+
/** @internal type navigation helper, not in runtime. */
|
|
173
|
+
protected static __types: {
|
|
174
|
+
api: {
|
|
175
|
+
input: UpdateScoringPolicyRequest;
|
|
176
|
+
output: UpdateScoringPolicyResponse;
|
|
177
|
+
};
|
|
178
|
+
sdk: {
|
|
179
|
+
input: UpdateScoringPolicyCommandInput;
|
|
180
|
+
output: UpdateScoringPolicyCommandOutput;
|
|
181
|
+
};
|
|
182
|
+
};
|
|
183
|
+
}
|
|
@@ -63,8 +63,31 @@ declare const UpdateTraditionPreferencesCommand_base: {
|
|
|
63
63
|
* @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
|
|
64
64
|
*
|
|
65
65
|
* @throws {@link BadRequestError} (client fault)
|
|
66
|
+
* 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
|
|
66
67
|
*
|
|
67
68
|
* @throws {@link InternalServerError} (server fault)
|
|
69
|
+
* 500: an unexpected failure (code `INTERNAL_ERROR`).
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link UnauthorizedError} (client fault)
|
|
72
|
+
* 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link ForbiddenError} (client fault)
|
|
75
|
+
* 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
|
|
76
|
+
* `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link TooManyRequestsError} (client fault)
|
|
79
|
+
* 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
|
|
80
|
+
* `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
|
|
81
|
+
* model.
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link BadGatewayError} (server fault)
|
|
84
|
+
* 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
|
|
85
|
+
* (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
|
|
86
|
+
* (`PROPAGATION_FAILED`, retrying the same request is safe).
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link ServiceUnavailableError} (server fault)
|
|
89
|
+
* 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
|
|
90
|
+
* `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
|
|
68
91
|
*
|
|
69
92
|
* @throws {@link OneHookServiceException}
|
|
70
93
|
* <p>Base exception class for all service exceptions from OneHook service.</p>
|
|
@@ -54,8 +54,31 @@ declare const UpdateUsernameCommand_base: {
|
|
|
54
54
|
* @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
|
|
55
55
|
*
|
|
56
56
|
* @throws {@link BadRequestError} (client fault)
|
|
57
|
+
* 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
|
|
57
58
|
*
|
|
58
59
|
* @throws {@link InternalServerError} (server fault)
|
|
60
|
+
* 500: an unexpected failure (code `INTERNAL_ERROR`).
|
|
61
|
+
*
|
|
62
|
+
* @throws {@link UnauthorizedError} (client fault)
|
|
63
|
+
* 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link ForbiddenError} (client fault)
|
|
66
|
+
* 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
|
|
67
|
+
* `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
|
|
68
|
+
*
|
|
69
|
+
* @throws {@link TooManyRequestsError} (client fault)
|
|
70
|
+
* 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
|
|
71
|
+
* `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
|
|
72
|
+
* model.
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link BadGatewayError} (server fault)
|
|
75
|
+
* 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
|
|
76
|
+
* (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
|
|
77
|
+
* (`PROPAGATION_FAILED`, retrying the same request is safe).
|
|
78
|
+
*
|
|
79
|
+
* @throws {@link ServiceUnavailableError} (server fault)
|
|
80
|
+
* 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
|
|
81
|
+
* `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
|
|
59
82
|
*
|
|
60
83
|
* @throws {@link OneHookServiceException}
|
|
61
84
|
* <p>Base exception class for all service exceptions from OneHook service.</p>
|
|
@@ -46,6 +46,25 @@ declare const UpgradeUserCommand_base: {
|
|
|
46
46
|
* // "STRING_VALUE",
|
|
47
47
|
* // ],
|
|
48
48
|
* // subscriptionTier: "MUST" || "SUPER" || "INFINITY", // required
|
|
49
|
+
* // hooks: [ // HookSummaryList
|
|
50
|
+
* // { // HookSummary
|
|
51
|
+
* // matchId: "STRING_VALUE", // required
|
|
52
|
+
* // peerId: "STRING_VALUE", // required
|
|
53
|
+
* // origin: "DISCOVERY" || "REQUEST", // required
|
|
54
|
+
* // hookedAt: Number("long"), // required
|
|
55
|
+
* // suspended: true || false,
|
|
56
|
+
* // },
|
|
57
|
+
* // ],
|
|
58
|
+
* // effectiveCapacity: Number("int"),
|
|
59
|
+
* // discoveryPaused: true || false,
|
|
60
|
+
* // matching: { // MatchingStatus
|
|
61
|
+
* // status: "OFF" || "ON" || "ERASING", // required
|
|
62
|
+
* // generation: Number("long"), // required
|
|
63
|
+
* // },
|
|
64
|
+
* // selectionRequired: true || false,
|
|
65
|
+
* // keepLimit: Number("int"),
|
|
66
|
+
* // selectionDeadline: Number("long"),
|
|
67
|
+
* // chatViewPass: "STRING_VALUE",
|
|
49
68
|
* // };
|
|
50
69
|
*
|
|
51
70
|
* ```
|
|
@@ -57,10 +76,35 @@ declare const UpgradeUserCommand_base: {
|
|
|
57
76
|
* @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
|
|
58
77
|
*
|
|
59
78
|
* @throws {@link BadRequestError} (client fault)
|
|
79
|
+
* 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
|
|
60
80
|
*
|
|
61
81
|
* @throws {@link NotFoundError} (client fault)
|
|
82
|
+
* 404: the resource does not exist or is not visible to the caller (code `NOT_FOUND`, or a more
|
|
83
|
+
* specific one such as `REQUEST_UNAVAILABLE`).
|
|
62
84
|
*
|
|
63
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 ForbiddenError} (client fault)
|
|
92
|
+
* 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
|
|
93
|
+
* `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
|
|
94
|
+
*
|
|
95
|
+
* @throws {@link TooManyRequestsError} (client fault)
|
|
96
|
+
* 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
|
|
97
|
+
* `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
|
|
98
|
+
* model.
|
|
99
|
+
*
|
|
100
|
+
* @throws {@link BadGatewayError} (server fault)
|
|
101
|
+
* 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
|
|
102
|
+
* (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
|
|
103
|
+
* (`PROPAGATION_FAILED`, retrying the same request is safe).
|
|
104
|
+
*
|
|
105
|
+
* @throws {@link ServiceUnavailableError} (server fault)
|
|
106
|
+
* 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
|
|
107
|
+
* `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
|
|
64
108
|
*
|
|
65
109
|
* @throws {@link OneHookServiceException}
|
|
66
110
|
* <p>Base exception class for all service exceptions from OneHook service.</p>
|
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
|
|
2
|
+
import { ChatProfileUpdateRequest, StatusResponse } from "../models/models_0";
|
|
3
|
+
import { Command as $Command } from "@smithy/smithy-client";
|
|
4
|
+
import { MetadataBearer as __MetadataBearer } from "@smithy/types";
|
|
5
|
+
/**
|
|
6
|
+
* @public
|
|
7
|
+
*/
|
|
8
|
+
export type { __MetadataBearer };
|
|
9
|
+
export { $Command };
|
|
10
|
+
/**
|
|
11
|
+
* @public
|
|
12
|
+
*
|
|
13
|
+
* The input for {@link UpsertChatProfileCommand}.
|
|
14
|
+
*/
|
|
15
|
+
export interface UpsertChatProfileCommandInput extends ChatProfileUpdateRequest {
|
|
16
|
+
}
|
|
17
|
+
/**
|
|
18
|
+
* @public
|
|
19
|
+
*
|
|
20
|
+
* The output of {@link UpsertChatProfileCommand}.
|
|
21
|
+
*/
|
|
22
|
+
export interface UpsertChatProfileCommandOutput extends StatusResponse, __MetadataBearer {
|
|
23
|
+
}
|
|
24
|
+
declare const UpsertChatProfileCommand_base: {
|
|
25
|
+
new (input: UpsertChatProfileCommandInput): import("@smithy/smithy-client").CommandImpl<UpsertChatProfileCommandInput, UpsertChatProfileCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
26
|
+
new (...[input]: [] | [UpsertChatProfileCommandInput]): import("@smithy/smithy-client").CommandImpl<UpsertChatProfileCommandInput, UpsertChatProfileCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
|
|
27
|
+
getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
|
|
28
|
+
};
|
|
29
|
+
/**
|
|
30
|
+
* Creates or updates the caller's chat profile: display name, avatar and birth date (required on
|
|
31
|
+
* creation, 18+, immutable afterwards). Every account has one; it is all a chat-only member needs.
|
|
32
|
+
* @example
|
|
33
|
+
* Use a bare-bones client and the command you need to make an API call.
|
|
34
|
+
* ```javascript
|
|
35
|
+
* import { OneHookClient, UpsertChatProfileCommand } from "onehook-api-client"; // ES Modules import
|
|
36
|
+
* // const { OneHookClient, UpsertChatProfileCommand } = require("onehook-api-client"); // CommonJS import
|
|
37
|
+
* const client = new OneHookClient(config);
|
|
38
|
+
* const input = { // ChatProfileUpdateRequest
|
|
39
|
+
* displayName: "STRING_VALUE",
|
|
40
|
+
* avatarKey: "STRING_VALUE",
|
|
41
|
+
* birthDetails: { // BirthDetails
|
|
42
|
+
* date: "STRING_VALUE",
|
|
43
|
+
* time: "STRING_VALUE",
|
|
44
|
+
* timeZone: "STRING_VALUE",
|
|
45
|
+
* latitude: Number("double"),
|
|
46
|
+
* longitude: Number("double"),
|
|
47
|
+
* placeName: "STRING_VALUE",
|
|
48
|
+
* provisional: true || false,
|
|
49
|
+
* },
|
|
50
|
+
* };
|
|
51
|
+
* const command = new UpsertChatProfileCommand(input);
|
|
52
|
+
* const response = await client.send(command);
|
|
53
|
+
* // { // StatusResponse
|
|
54
|
+
* // status: "STRING_VALUE", // required
|
|
55
|
+
* // };
|
|
56
|
+
*
|
|
57
|
+
* ```
|
|
58
|
+
*
|
|
59
|
+
* @param UpsertChatProfileCommandInput - {@link UpsertChatProfileCommandInput}
|
|
60
|
+
* @returns {@link UpsertChatProfileCommandOutput}
|
|
61
|
+
* @see {@link UpsertChatProfileCommandInput} for command's `input` shape.
|
|
62
|
+
* @see {@link UpsertChatProfileCommandOutput} for command's `response` shape.
|
|
63
|
+
* @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
|
|
64
|
+
*
|
|
65
|
+
* @throws {@link BadRequestError} (client fault)
|
|
66
|
+
* 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
|
|
67
|
+
*
|
|
68
|
+
* @throws {@link InternalServerError} (server fault)
|
|
69
|
+
* 500: an unexpected failure (code `INTERNAL_ERROR`).
|
|
70
|
+
*
|
|
71
|
+
* @throws {@link UnauthorizedError} (client fault)
|
|
72
|
+
* 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
|
|
73
|
+
*
|
|
74
|
+
* @throws {@link ForbiddenError} (client fault)
|
|
75
|
+
* 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
|
|
76
|
+
* `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
|
|
77
|
+
*
|
|
78
|
+
* @throws {@link TooManyRequestsError} (client fault)
|
|
79
|
+
* 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
|
|
80
|
+
* `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
|
|
81
|
+
* model.
|
|
82
|
+
*
|
|
83
|
+
* @throws {@link BadGatewayError} (server fault)
|
|
84
|
+
* 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
|
|
85
|
+
* (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
|
|
86
|
+
* (`PROPAGATION_FAILED`, retrying the same request is safe).
|
|
87
|
+
*
|
|
88
|
+
* @throws {@link ServiceUnavailableError} (server fault)
|
|
89
|
+
* 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
|
|
90
|
+
* `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
|
|
91
|
+
*
|
|
92
|
+
* @throws {@link OneHookServiceException}
|
|
93
|
+
* <p>Base exception class for all service exceptions from OneHook service.</p>
|
|
94
|
+
*
|
|
95
|
+
*
|
|
96
|
+
* @public
|
|
97
|
+
*/
|
|
98
|
+
export declare class UpsertChatProfileCommand extends UpsertChatProfileCommand_base {
|
|
99
|
+
/** @internal type navigation helper, not in runtime. */
|
|
100
|
+
protected static __types: {
|
|
101
|
+
api: {
|
|
102
|
+
input: ChatProfileUpdateRequest;
|
|
103
|
+
output: StatusResponse;
|
|
104
|
+
};
|
|
105
|
+
sdk: {
|
|
106
|
+
input: UpsertChatProfileCommandInput;
|
|
107
|
+
output: UpsertChatProfileCommandOutput;
|
|
108
|
+
};
|
|
109
|
+
};
|
|
110
|
+
}
|