onehook-api-client 1.0.37 → 1.0.38

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (230) hide show
  1. package/README.md +446 -19
  2. package/dist-cjs/OneHook.js +88 -8
  3. package/dist-cjs/commands/{GetNotificationPreferencesCommand.js → AcceptHookRequestCommand.js} +7 -7
  4. package/dist-cjs/commands/BlockUserCommand.js +21 -0
  5. package/dist-cjs/commands/CancelHookRequestCommand.js +21 -0
  6. package/dist-cjs/commands/ClearTierOverrideCommand.js +21 -0
  7. package/dist-cjs/commands/DeclineHookRequestCommand.js +21 -0
  8. package/dist-cjs/commands/{SwipeByUsernameCommand.js → DisableMatchingCommand.js} +7 -7
  9. package/dist-cjs/commands/EnableMatchingCommand.js +21 -0
  10. package/dist-cjs/commands/EstablishHistoryEpochCommand.js +21 -0
  11. package/dist-cjs/commands/GetChatProfileCommand.js +21 -0
  12. package/dist-cjs/commands/GetDiscoverySnapshotCommand.js +21 -0
  13. package/dist-cjs/commands/GetGraphInvitesCommand.js +21 -0
  14. package/dist-cjs/commands/{UpdateProfileCommand.js → GetGraphMatchCommand.js} +7 -7
  15. package/dist-cjs/commands/GetGraphUserCommand.js +21 -0
  16. package/dist-cjs/commands/GetHistoryStateCommand.js +21 -0
  17. package/dist-cjs/commands/GetInternalMatchingStatusCommand.js +21 -0
  18. package/dist-cjs/commands/GetInternalProfileCommand.js +21 -0
  19. package/dist-cjs/commands/GetInviteEdgesCommand.js +21 -0
  20. package/dist-cjs/commands/GetMatchingProfileCommand.js +21 -0
  21. package/dist-cjs/commands/GetMatchingReadinessCommand.js +21 -0
  22. package/dist-cjs/commands/GetMediaStatsCommand.js +21 -0
  23. package/dist-cjs/commands/GetModerationReportCommand.js +21 -0
  24. package/dist-cjs/commands/GetModerationSignalsCommand.js +21 -0
  25. package/dist-cjs/commands/GetPartnerDistanceCommand.js +21 -0
  26. package/dist-cjs/commands/GetScoringPolicyCommand.js +21 -0
  27. package/dist-cjs/commands/GetTierOverrideCommand.js +21 -0
  28. package/dist-cjs/commands/IngestSignalsCommand.js +21 -0
  29. package/dist-cjs/commands/IssueViewPassesCommand.js +21 -0
  30. package/dist-cjs/commands/KeepHooksCommand.js +21 -0
  31. package/dist-cjs/commands/{GetProfileCommand.js → ListBlocksCommand.js} +7 -7
  32. package/dist-cjs/commands/ListGraphUserMatchesCommand.js +21 -0
  33. package/dist-cjs/commands/ListHookRequestsCommand.js +21 -0
  34. package/dist-cjs/commands/ListMatchingOnMembersCommand.js +21 -0
  35. package/dist-cjs/commands/PutHistoryWrapCommand.js +21 -0
  36. package/dist-cjs/commands/RecordSuggestionInternalCommand.js +21 -0
  37. package/dist-cjs/commands/ReportMemberCommand.js +21 -0
  38. package/dist-cjs/commands/RepublishMatchingProfileCommand.js +21 -0
  39. package/dist-cjs/commands/RevokeHistoryWrapCommand.js +21 -0
  40. package/dist-cjs/commands/SendHookRequestCommand.js +21 -0
  41. package/dist-cjs/commands/SetTierOverrideCommand.js +21 -0
  42. package/dist-cjs/commands/SimulateScoringPolicyCommand.js +21 -0
  43. package/dist-cjs/commands/UnblockUserCommand.js +21 -0
  44. package/dist-cjs/commands/UpdateScoringPolicyCommand.js +21 -0
  45. package/dist-cjs/commands/UpsertChatProfileCommand.js +21 -0
  46. package/dist-cjs/commands/UpsertMatchingProfileCommand.js +21 -0
  47. package/dist-cjs/commands/index.js +44 -4
  48. package/dist-cjs/graphql/types.js +4 -0
  49. package/dist-cjs/models/models_0.js +216 -21
  50. package/dist-cjs/protocols/Aws_restJson1.js +2198 -514
  51. package/dist-cjs/telemetry/index.js +49 -9
  52. package/dist-es/OneHook.js +88 -8
  53. package/dist-es/commands/AcceptHookRequestCommand.js +17 -0
  54. package/dist-es/commands/BlockUserCommand.js +17 -0
  55. package/dist-es/commands/CancelHookRequestCommand.js +17 -0
  56. package/dist-es/commands/ClearTierOverrideCommand.js +17 -0
  57. package/dist-es/commands/DeclineHookRequestCommand.js +17 -0
  58. package/dist-es/commands/{SwipeByUsernameCommand.js → DisableMatchingCommand.js} +6 -6
  59. package/dist-es/commands/EnableMatchingCommand.js +17 -0
  60. package/dist-es/commands/EstablishHistoryEpochCommand.js +17 -0
  61. package/dist-es/commands/GetChatProfileCommand.js +17 -0
  62. package/dist-es/commands/GetDiscoverySnapshotCommand.js +17 -0
  63. package/dist-es/commands/GetGraphInvitesCommand.js +17 -0
  64. package/dist-es/commands/{UpdateProfileCommand.js → GetGraphMatchCommand.js} +6 -6
  65. package/dist-es/commands/GetGraphUserCommand.js +17 -0
  66. package/dist-es/commands/GetHistoryStateCommand.js +17 -0
  67. package/dist-es/commands/GetInternalMatchingStatusCommand.js +17 -0
  68. package/dist-es/commands/GetInternalProfileCommand.js +17 -0
  69. package/dist-es/commands/GetInviteEdgesCommand.js +17 -0
  70. package/dist-es/commands/GetMatchingProfileCommand.js +17 -0
  71. package/dist-es/commands/GetMatchingReadinessCommand.js +17 -0
  72. package/dist-es/commands/GetMediaStatsCommand.js +17 -0
  73. package/dist-es/commands/GetModerationReportCommand.js +17 -0
  74. package/dist-es/commands/GetModerationSignalsCommand.js +17 -0
  75. package/dist-es/commands/GetPartnerDistanceCommand.js +17 -0
  76. package/dist-es/commands/GetScoringPolicyCommand.js +17 -0
  77. package/dist-es/commands/GetTierOverrideCommand.js +17 -0
  78. package/dist-es/commands/IngestSignalsCommand.js +17 -0
  79. package/dist-es/commands/IssueViewPassesCommand.js +17 -0
  80. package/dist-es/commands/KeepHooksCommand.js +17 -0
  81. package/dist-es/commands/{GetProfileCommand.js → ListBlocksCommand.js} +6 -6
  82. package/dist-es/commands/ListGraphUserMatchesCommand.js +17 -0
  83. package/dist-es/commands/ListHookRequestsCommand.js +17 -0
  84. package/dist-es/commands/ListMatchingOnMembersCommand.js +17 -0
  85. package/dist-es/commands/PutHistoryWrapCommand.js +17 -0
  86. package/dist-es/commands/RecordSuggestionInternalCommand.js +17 -0
  87. package/dist-es/commands/ReportMemberCommand.js +17 -0
  88. package/dist-es/commands/RepublishMatchingProfileCommand.js +17 -0
  89. package/dist-es/commands/RevokeHistoryWrapCommand.js +17 -0
  90. package/dist-es/commands/SendHookRequestCommand.js +17 -0
  91. package/dist-es/commands/SetTierOverrideCommand.js +17 -0
  92. package/dist-es/commands/SimulateScoringPolicyCommand.js +17 -0
  93. package/dist-es/commands/UnblockUserCommand.js +17 -0
  94. package/dist-es/commands/UpdateScoringPolicyCommand.js +17 -0
  95. package/dist-es/commands/UpsertChatProfileCommand.js +17 -0
  96. package/dist-es/commands/UpsertMatchingProfileCommand.js +17 -0
  97. package/dist-es/commands/index.js +44 -4
  98. package/dist-es/graphql/types.js +4 -0
  99. package/dist-es/models/models_0.js +208 -18
  100. package/dist-es/protocols/Aws_restJson1.js +2003 -401
  101. package/dist-es/telemetry/index.js +49 -9
  102. package/dist-types/OneHook.d.ts +311 -23
  103. package/dist-types/OneHookClient.d.ts +46 -6
  104. package/dist-types/commands/AcceptHookRequestCommand.d.ts +109 -0
  105. package/dist-types/commands/AuthSocialCommand.d.ts +23 -0
  106. package/dist-types/commands/BlockUserCommand.d.ts +106 -0
  107. package/dist-types/commands/CancelHookRequestCommand.d.ts +103 -0
  108. package/dist-types/commands/ClearTierOverrideCommand.d.ts +123 -0
  109. package/dist-types/commands/CompleteLivenessSessionCommand.d.ts +26 -1
  110. package/dist-types/commands/CompleteOnboardingCommand.d.ts +31 -2
  111. package/dist-types/commands/CorrectBirthDateCommand.d.ts +25 -0
  112. package/dist-types/commands/CreateAdminInviteCommand.d.ts +23 -0
  113. package/dist-types/commands/CreateLivenessSessionCommand.d.ts +23 -0
  114. package/dist-types/commands/CreateMediaDownloadUrlCommand.d.ts +23 -0
  115. package/dist-types/commands/CreateMediaUploadUrlCommand.d.ts +24 -1
  116. package/dist-types/commands/DeclineHookRequestCommand.d.ts +103 -0
  117. package/dist-types/commands/DeleteMatchMessagesCommand.d.ts +21 -0
  118. package/dist-types/commands/DeleteProfileCommand.d.ts +28 -2
  119. package/dist-types/commands/DeletePushTokenCommand.d.ts +23 -0
  120. package/dist-types/commands/DisableMatchingCommand.d.ts +106 -0
  121. package/dist-types/commands/DiscoverCommand.d.ts +22 -0
  122. package/dist-types/commands/EnableMatchingCommand.d.ts +105 -0
  123. package/dist-types/commands/EstablishHistoryEpochCommand.d.ts +125 -0
  124. package/dist-types/commands/GenerateDownloadUrlCommand.d.ts +26 -0
  125. package/dist-types/commands/GenerateInviteCommand.d.ts +23 -0
  126. package/dist-types/commands/GenerateUploadUrlCommand.d.ts +31 -2
  127. package/dist-types/commands/GetAccountStateCommand.d.ts +25 -0
  128. package/dist-types/commands/GetAdminPhoneStatusCommand.d.ts +23 -0
  129. package/dist-types/commands/GetAiContextMatchCommand.d.ts +25 -0
  130. package/dist-types/commands/GetBirthDateStatusCommand.d.ts +25 -0
  131. package/dist-types/commands/GetChatProfileCommand.d.ts +123 -0
  132. package/dist-types/commands/GetChatSettingsCommand.d.ts +22 -0
  133. package/dist-types/commands/GetCredentialReadinessCommand.d.ts +25 -0
  134. package/dist-types/commands/GetDiscoverySnapshotCommand.d.ts +138 -0
  135. package/dist-types/commands/GetGraphInvitesCommand.d.ts +119 -0
  136. package/dist-types/commands/GetGraphMatchCommand.d.ts +136 -0
  137. package/dist-types/commands/GetGraphUserCommand.d.ts +117 -0
  138. package/dist-types/commands/GetHistoryStateCommand.d.ts +113 -0
  139. package/dist-types/commands/GetInternalMatchingStatusCommand.d.ts +102 -0
  140. package/dist-types/commands/GetInternalProfileCommand.d.ts +174 -0
  141. package/dist-types/commands/GetInviteEdgesCommand.d.ts +106 -0
  142. package/dist-types/commands/GetLivenessStatusCommand.d.ts +23 -0
  143. package/dist-types/commands/GetMatchCommand.d.ts +27 -0
  144. package/dist-types/commands/GetMatchingProfileCommand.d.ts +175 -0
  145. package/dist-types/commands/GetMatchingReadinessCommand.d.ts +107 -0
  146. package/dist-types/commands/GetMediaStatsCommand.d.ts +106 -0
  147. package/dist-types/commands/GetModerationReportCommand.d.ts +113 -0
  148. package/dist-types/commands/GetModerationSignalsCommand.d.ts +123 -0
  149. package/dist-types/commands/GetMyProfileCommand.d.ts +119 -79
  150. package/dist-types/commands/GetParticipantRegistryCommand.d.ts +23 -0
  151. package/dist-types/commands/GetPartnerDistanceCommand.d.ts +102 -0
  152. package/dist-types/commands/GetPlaceCommand.d.ts +25 -0
  153. package/dist-types/commands/GetPreferencesCommand.d.ts +27 -3
  154. package/dist-types/commands/GetPreservationHoldCommand.d.ts +25 -0
  155. package/dist-types/commands/GetReceivedLikesCommand.d.ts +24 -0
  156. package/dist-types/commands/GetRosesCommand.d.ts +25 -0
  157. package/dist-types/commands/GetScoringPolicyCommand.d.ts +143 -0
  158. package/dist-types/commands/GetStateCommand.d.ts +44 -0
  159. package/dist-types/commands/GetSuggestionsCommand.d.ts +23 -0
  160. package/dist-types/commands/GetTierOverrideCommand.d.ts +123 -0
  161. package/dist-types/commands/GetTraditionPreferencesCommand.d.ts +23 -0
  162. package/dist-types/commands/GetUserByEmailCommand.d.ts +27 -0
  163. package/dist-types/commands/GetUserCommand.d.ts +27 -0
  164. package/dist-types/commands/GetUserIdByUsernameCommand.d.ts +28 -3
  165. package/dist-types/commands/IndexLocationCommand.d.ts +23 -0
  166. package/dist-types/commands/IngestSignalsCommand.d.ts +114 -0
  167. package/dist-types/commands/InitUserCommand.d.ts +29 -2
  168. package/dist-types/commands/IssueViewPassesCommand.d.ts +107 -0
  169. package/dist-types/commands/KeepHooksCommand.d.ts +136 -0
  170. package/dist-types/commands/LinkEmailCommand.d.ts +23 -0
  171. package/dist-types/commands/LinkSocialCommand.d.ts +23 -0
  172. package/dist-types/commands/ListBlocksCommand.d.ts +102 -0
  173. package/dist-types/commands/ListGraphUserMatchesCommand.d.ts +117 -0
  174. package/dist-types/commands/ListHookRequestsCommand.d.ts +110 -0
  175. package/dist-types/commands/ListMatchingOnMembersCommand.d.ts +108 -0
  176. package/dist-types/commands/ListMyDevicesCommand.d.ts +20 -0
  177. package/dist-types/commands/PutHistoryWrapCommand.d.ts +112 -0
  178. package/dist-types/commands/RecordSuggestionCommand.d.ts +21 -0
  179. package/dist-types/commands/RecordSuggestionInternalCommand.d.ts +105 -0
  180. package/dist-types/commands/RegisterDeviceCommand.d.ts +25 -10
  181. package/dist-types/commands/RegisterPhoneCommand.d.ts +23 -0
  182. package/dist-types/commands/RegisterPushTokenCommand.d.ts +23 -0
  183. package/dist-types/commands/RemoveLocationCommand.d.ts +23 -0
  184. package/dist-types/commands/RemoveOneHookSuggestionCommand.d.ts +23 -0
  185. package/dist-types/commands/RemoveSuggestionCommand.d.ts +23 -0
  186. package/dist-types/commands/ReportMemberCommand.d.ts +107 -0
  187. package/dist-types/commands/RepublishMatchingProfileCommand.d.ts +109 -0
  188. package/dist-types/commands/RequestEmailOtpCommand.d.ts +23 -0
  189. package/dist-types/commands/RequestPhoneOtpCommand.d.ts +23 -0
  190. package/dist-types/commands/RequestPhoneUpdateOtpCommand.d.ts +23 -0
  191. package/dist-types/commands/RevokeDeviceCommand.d.ts +23 -0
  192. package/dist-types/commands/RevokeHistoryWrapCommand.d.ts +108 -0
  193. package/dist-types/commands/RevokeUserAccessCommand.d.ts +25 -0
  194. package/dist-types/commands/SearchPlacesCommand.d.ts +23 -0
  195. package/dist-types/commands/SendAdminLinkOtpCommand.d.ts +25 -0
  196. package/dist-types/commands/SendHookRequestCommand.d.ts +105 -0
  197. package/dist-types/commands/SetAccountStateCommand.d.ts +27 -0
  198. package/dist-types/commands/SetPreservationHoldCommand.d.ts +27 -0
  199. package/dist-types/commands/SetTierOverrideCommand.d.ts +128 -0
  200. package/dist-types/commands/SimulateScoringPolicyCommand.d.ts +129 -0
  201. package/dist-types/commands/SwipeCommand.d.ts +27 -0
  202. package/dist-types/commands/UnblockUserCommand.d.ts +99 -0
  203. package/dist-types/commands/UnhookCommand.d.ts +29 -0
  204. package/dist-types/commands/UnlinkSocialCommand.d.ts +23 -0
  205. package/dist-types/commands/UpdateChatSettingsCommand.d.ts +25 -0
  206. package/dist-types/commands/UpdateEntitlementsCommand.d.ts +25 -0
  207. package/dist-types/commands/UpdatePhoneNumberCommand.d.ts +23 -0
  208. package/dist-types/commands/UpdatePreferencesCommand.d.ts +76 -8
  209. package/dist-types/commands/UpdateScoringPolicyCommand.d.ts +183 -0
  210. package/dist-types/commands/UpdateTraditionPreferencesCommand.d.ts +23 -0
  211. package/dist-types/commands/UpdateUsernameCommand.d.ts +23 -0
  212. package/dist-types/commands/UpgradeUserCommand.d.ts +44 -0
  213. package/dist-types/commands/UpsertChatProfileCommand.d.ts +110 -0
  214. package/dist-types/commands/UpsertMatchingProfileCommand.d.ts +163 -0
  215. package/dist-types/commands/ValidateInviteCommand.d.ts +23 -0
  216. package/dist-types/commands/VerifyAdminLinkOtpCommand.d.ts +25 -0
  217. package/dist-types/commands/index.d.ts +44 -4
  218. package/dist-types/graphql/types.d.ts +8 -0
  219. package/dist-types/models/models_0.d.ts +3400 -1266
  220. package/dist-types/protocols/Aws_restJson1.d.ts +384 -24
  221. package/dist-types/telemetry/index.d.ts +25 -2
  222. package/package.json +1 -1
  223. package/telemetry/TelemetryCatalog.kt +33 -11
  224. package/telemetry/TelemetryCatalog.swift +50 -11
  225. package/telemetry/telemetry-catalog.json +309 -34
  226. package/dist-es/commands/GetNotificationPreferencesCommand.js +0 -17
  227. package/dist-types/commands/GetNotificationPreferencesCommand.d.ts +0 -91
  228. package/dist-types/commands/GetProfileCommand.d.ts +0 -153
  229. package/dist-types/commands/SwipeByUsernameCommand.d.ts +0 -93
  230. package/dist-types/commands/UpdateProfileCommand.d.ts +0 -142
@@ -0,0 +1,113 @@
1
+ import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
2
+ import { HistoryState } 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 GetHistoryStateCommand}.
14
+ */
15
+ export interface GetHistoryStateCommandInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetHistoryStateCommand}.
21
+ */
22
+ export interface GetHistoryStateCommandOutput extends HistoryState, __MetadataBearer {
23
+ }
24
+ declare const GetHistoryStateCommand_base: {
25
+ new (input: GetHistoryStateCommandInput): import("@smithy/smithy-client").CommandImpl<GetHistoryStateCommandInput, GetHistoryStateCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (...[input]: [] | [GetHistoryStateCommandInput]): import("@smithy/smithy-client").CommandImpl<GetHistoryStateCommandInput, GetHistoryStateCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * The caller's epochs, the active (highest) one, and the active epoch's wraps. `activeEpoch` and
31
+ * `wraps` are absent while the account has no epoch.
32
+ * @example
33
+ * Use a bare-bones client and the command you need to make an API call.
34
+ * ```javascript
35
+ * import { OneHookClient, GetHistoryStateCommand } from "onehook-api-client"; // ES Modules import
36
+ * // const { OneHookClient, GetHistoryStateCommand } = require("onehook-api-client"); // CommonJS import
37
+ * const client = new OneHookClient(config);
38
+ * const input = {};
39
+ * const command = new GetHistoryStateCommand(input);
40
+ * const response = await client.send(command);
41
+ * // { // HistoryState
42
+ * // epochs: [ // HistoryEpochList // required
43
+ * // { // HistoryEpoch
44
+ * // epoch: Number("int"), // required
45
+ * // keyId: "STRING_VALUE", // required
46
+ * // publicKey: "STRING_VALUE", // required
47
+ * // createdAt: Number("long"), // required
48
+ * // horizonAt: Number("long"),
49
+ * // },
50
+ * // ],
51
+ * // activeEpoch: Number("int"),
52
+ * // wraps: [ // AhkWrapList
53
+ * // { // AhkWrap
54
+ * // epoch: Number("int"), // required
55
+ * // method: "STRING_VALUE", // required
56
+ * // wrapId: "STRING_VALUE", // required
57
+ * // wrappedKey: "STRING_VALUE",
58
+ * // createdAt: Number("long"), // required
59
+ * // },
60
+ * // ],
61
+ * // };
62
+ *
63
+ * ```
64
+ *
65
+ * @param GetHistoryStateCommandInput - {@link GetHistoryStateCommandInput}
66
+ * @returns {@link GetHistoryStateCommandOutput}
67
+ * @see {@link GetHistoryStateCommandInput} for command's `input` shape.
68
+ * @see {@link GetHistoryStateCommandOutput} for command's `response` shape.
69
+ * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
70
+ *
71
+ * @throws {@link ForbiddenError} (client fault)
72
+ * 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
73
+ * `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
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 GetHistoryStateCommand extends GetHistoryStateCommand_base {
102
+ /** @internal type navigation helper, not in runtime. */
103
+ protected static __types: {
104
+ api: {
105
+ input: {};
106
+ output: HistoryState;
107
+ };
108
+ sdk: {
109
+ input: GetHistoryStateCommandInput;
110
+ output: GetHistoryStateCommandOutput;
111
+ };
112
+ };
113
+ }
@@ -0,0 +1,102 @@
1
+ import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
2
+ import { InternalMatchingStatus, 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 GetInternalMatchingStatusCommand}.
14
+ */
15
+ export interface GetInternalMatchingStatusCommandInput extends TargetUserRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetInternalMatchingStatusCommand}.
21
+ */
22
+ export interface GetInternalMatchingStatusCommandOutput extends InternalMatchingStatus, __MetadataBearer {
23
+ }
24
+ declare const GetInternalMatchingStatusCommand_base: {
25
+ new (input: GetInternalMatchingStatusCommandInput): import("@smithy/smithy-client").CommandImpl<GetInternalMatchingStatusCommandInput, GetInternalMatchingStatusCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: GetInternalMatchingStatusCommandInput): import("@smithy/smithy-client").CommandImpl<GetInternalMatchingStatusCommandInput, GetInternalMatchingStatusCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * The member's matching mode, for services that must not use matching data of a member who has it off
31
+ * (Mr OneHook). An unknown member reads as OFF with generation 0. 403 without an IAM caller.
32
+ * @example
33
+ * Use a bare-bones client and the command you need to make an API call.
34
+ * ```javascript
35
+ * import { OneHookClient, GetInternalMatchingStatusCommand } from "onehook-api-client"; // ES Modules import
36
+ * // const { OneHookClient, GetInternalMatchingStatusCommand } = require("onehook-api-client"); // CommonJS import
37
+ * const client = new OneHookClient(config);
38
+ * const input = { // TargetUserRequest
39
+ * targetUserId: "STRING_VALUE", // required
40
+ * };
41
+ * const command = new GetInternalMatchingStatusCommand(input);
42
+ * const response = await client.send(command);
43
+ * // { // InternalMatchingStatus
44
+ * // userId: "STRING_VALUE", // required
45
+ * // status: "OFF" || "ON" || "ERASING", // required
46
+ * // generation: Number("long"), // required
47
+ * // };
48
+ *
49
+ * ```
50
+ *
51
+ * @param GetInternalMatchingStatusCommandInput - {@link GetInternalMatchingStatusCommandInput}
52
+ * @returns {@link GetInternalMatchingStatusCommandOutput}
53
+ * @see {@link GetInternalMatchingStatusCommandInput} for command's `input` shape.
54
+ * @see {@link GetInternalMatchingStatusCommandOutput} for command's `response` shape.
55
+ * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
56
+ *
57
+ * @throws {@link BadRequestError} (client fault)
58
+ * 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
59
+ *
60
+ * @throws {@link ForbiddenError} (client fault)
61
+ * 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
62
+ * `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
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 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`.
83
+ *
84
+ * @throws {@link OneHookServiceException}
85
+ * <p>Base exception class for all service exceptions from OneHook service.</p>
86
+ *
87
+ *
88
+ * @public
89
+ */
90
+ export declare class GetInternalMatchingStatusCommand extends GetInternalMatchingStatusCommand_base {
91
+ /** @internal type navigation helper, not in runtime. */
92
+ protected static __types: {
93
+ api: {
94
+ input: TargetUserRequest;
95
+ output: InternalMatchingStatus;
96
+ };
97
+ sdk: {
98
+ input: GetInternalMatchingStatusCommandInput;
99
+ output: GetInternalMatchingStatusCommandOutput;
100
+ };
101
+ };
102
+ }
@@ -0,0 +1,174 @@
1
+ import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
2
+ import { GetInternalProfileRequest, InternalProfile } 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 GetInternalProfileCommand}.
14
+ */
15
+ export interface GetInternalProfileCommandInput extends GetInternalProfileRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetInternalProfileCommand}.
21
+ */
22
+ export interface GetInternalProfileCommandOutput extends InternalProfile, __MetadataBearer {
23
+ }
24
+ declare const GetInternalProfileCommand_base: {
25
+ new (input: GetInternalProfileCommandInput): import("@smithy/smithy-client").CommandImpl<GetInternalProfileCommandInput, GetInternalProfileCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: GetInternalProfileCommandInput): import("@smithy/smithy-client").CommandImpl<GetInternalProfileCommandInput, GetInternalProfileCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Internal, IAM-authorized (SigV4): the member's profile as other services see it (Matching hydration,
31
+ * State's AI-context projection). The matching fields and `matchingStatus: ACTIVE` are present only
32
+ * while the matching profile is ACTIVE; `userId`, the chat `displayName`, `age` and `birthDateOnFile`
33
+ * are always there. Owner-only fields (`status`, `generation`, `lastEditedAt`, `draftExpiresAt`,
34
+ * `birthDetails`) are never included. 404 without a saved chat profile, or while it is being deleted.
35
+ * @example
36
+ * Use a bare-bones client and the command you need to make an API call.
37
+ * ```javascript
38
+ * import { OneHookClient, GetInternalProfileCommand } from "onehook-api-client"; // ES Modules import
39
+ * // const { OneHookClient, GetInternalProfileCommand } = require("onehook-api-client"); // CommonJS import
40
+ * const client = new OneHookClient(config);
41
+ * const input = { // GetInternalProfileRequest
42
+ * userId: "STRING_VALUE", // required
43
+ * };
44
+ * const command = new GetInternalProfileCommand(input);
45
+ * const response = await client.send(command);
46
+ * // { // InternalProfile
47
+ * // userId: "STRING_VALUE", // required
48
+ * // matchingStatus: "DRAFT" || "ACTIVE",
49
+ * // displayName: "STRING_VALUE",
50
+ * // age: Number("int"),
51
+ * // birthDateOnFile: true || false, // required
52
+ * // bio: "STRING_VALUE",
53
+ * // gender: "STRING_VALUE",
54
+ * // interestedIn: [ // StringList
55
+ * // "STRING_VALUE",
56
+ * // ],
57
+ * // relationshipType: "STRING_VALUE",
58
+ * // wantsKids: "STRING_VALUE",
59
+ * // familyPlans: "STRING_VALUE",
60
+ * // smokingStatus: "STRING_VALUE",
61
+ * // drinkingStatus: "STRING_VALUE",
62
+ * // cannabisStatus: "STRING_VALUE",
63
+ * // drugsStatus: "STRING_VALUE",
64
+ * // religion: "STRING_VALUE",
65
+ * // interests: [
66
+ * // "STRING_VALUE",
67
+ * // ],
68
+ * // starSign: "STRING_VALUE",
69
+ * // verified: true || false,
70
+ * // subscriptionTier: "MUST" || "SUPER" || "INFINITY",
71
+ * // pictures: [
72
+ * // "STRING_VALUE",
73
+ * // ],
74
+ * // pictureTransforms: { // StringMap
75
+ * // "<keys>": "STRING_VALUE",
76
+ * // },
77
+ * // videos: [
78
+ * // "STRING_VALUE",
79
+ * // ],
80
+ * // audioPrompt: "STRING_VALUE",
81
+ * // moderationStatus: "STRING_VALUE",
82
+ * // fieldModerationStatus: {
83
+ * // "<keys>": "STRING_VALUE",
84
+ * // },
85
+ * // causes: [
86
+ * // "STRING_VALUE",
87
+ * // ],
88
+ * // communities: "<StringList>",
89
+ * // qualities: "<StringList>",
90
+ * // prompts: [ // ProfilePromptList
91
+ * // { // ProfilePrompt
92
+ * // promptId: "STRING_VALUE", // required
93
+ * // answer: "STRING_VALUE", // required
94
+ * // imageKey: "STRING_VALUE",
95
+ * // },
96
+ * // ],
97
+ * // socialLinks: {
98
+ * // "<keys>": "STRING_VALUE",
99
+ * // },
100
+ * // openers: [ // OpenerList
101
+ * // { // Opener
102
+ * // text: "STRING_VALUE", // required
103
+ * // imageKey: "STRING_VALUE",
104
+ * // },
105
+ * // ],
106
+ * // work: "STRING_VALUE",
107
+ * // education: "STRING_VALUE",
108
+ * // hometown: "STRING_VALUE",
109
+ * // currentLocation: "STRING_VALUE",
110
+ * // height: Number("int"),
111
+ * // exercise: "STRING_VALUE",
112
+ * // educationLevel: "STRING_VALUE",
113
+ * // politicalView: "STRING_VALUE",
114
+ * // languages: "<StringList>",
115
+ * // };
116
+ *
117
+ * ```
118
+ *
119
+ * @param GetInternalProfileCommandInput - {@link GetInternalProfileCommandInput}
120
+ * @returns {@link GetInternalProfileCommandOutput}
121
+ * @see {@link GetInternalProfileCommandInput} for command's `input` shape.
122
+ * @see {@link GetInternalProfileCommandOutput} for command's `response` shape.
123
+ * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
124
+ *
125
+ * @throws {@link BadRequestError} (client fault)
126
+ * 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
127
+ *
128
+ * @throws {@link ForbiddenError} (client fault)
129
+ * 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
130
+ * `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
131
+ *
132
+ * @throws {@link NotFoundError} (client fault)
133
+ * 404: the resource does not exist or is not visible to the caller (code `NOT_FOUND`, or a more
134
+ * specific one such as `REQUEST_UNAVAILABLE`).
135
+ *
136
+ * @throws {@link InternalServerError} (server fault)
137
+ * 500: an unexpected failure (code `INTERNAL_ERROR`).
138
+ *
139
+ * @throws {@link UnauthorizedError} (client fault)
140
+ * 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
141
+ *
142
+ * @throws {@link TooManyRequestsError} (client fault)
143
+ * 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
144
+ * `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
145
+ * model.
146
+ *
147
+ * @throws {@link BadGatewayError} (server fault)
148
+ * 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
149
+ * (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
150
+ * (`PROPAGATION_FAILED`, retrying the same request is safe).
151
+ *
152
+ * @throws {@link ServiceUnavailableError} (server fault)
153
+ * 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
154
+ * `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
155
+ *
156
+ * @throws {@link OneHookServiceException}
157
+ * <p>Base exception class for all service exceptions from OneHook service.</p>
158
+ *
159
+ *
160
+ * @public
161
+ */
162
+ export declare class GetInternalProfileCommand extends GetInternalProfileCommand_base {
163
+ /** @internal type navigation helper, not in runtime. */
164
+ protected static __types: {
165
+ api: {
166
+ input: GetInternalProfileRequest;
167
+ output: InternalProfile;
168
+ };
169
+ sdk: {
170
+ input: GetInternalProfileCommandInput;
171
+ output: GetInternalProfileCommandOutput;
172
+ };
173
+ };
174
+ }
@@ -0,0 +1,106 @@
1
+ import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
2
+ import { GetInviteEdgesRequest, GetInviteEdgesResponse } 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 GetInviteEdgesCommand}.
14
+ */
15
+ export interface GetInviteEdgesCommandInput extends GetInviteEdgesRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetInviteEdgesCommand}.
21
+ */
22
+ export interface GetInviteEdgesCommandOutput extends GetInviteEdgesResponse, __MetadataBearer {
23
+ }
24
+ declare const GetInviteEdgesCommand_base: {
25
+ new (input: GetInviteEdgesCommandInput): import("@smithy/smithy-client").CommandImpl<GetInviteEdgesCommandInput, GetInviteEdgesCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: GetInviteEdgesCommandInput): import("@smithy/smithy-client").CommandImpl<GetInviteEdgesCommandInput, GetInviteEdgesCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * IAM-only (Matching hydration): who invited the member and whom they invited, so Matching can rebuild
31
+ * its invite-proximity copy when the member turns matching on. Paged with `nextToken`.
32
+ * @example
33
+ * Use a bare-bones client and the command you need to make an API call.
34
+ * ```javascript
35
+ * import { OneHookClient, GetInviteEdgesCommand } from "onehook-api-client"; // ES Modules import
36
+ * // const { OneHookClient, GetInviteEdgesCommand } = require("onehook-api-client"); // CommonJS import
37
+ * const client = new OneHookClient(config);
38
+ * const input = { // GetInviteEdgesRequest
39
+ * userId: "STRING_VALUE", // required
40
+ * nextToken: "STRING_VALUE",
41
+ * };
42
+ * const command = new GetInviteEdgesCommand(input);
43
+ * const response = await client.send(command);
44
+ * // { // GetInviteEdgesResponse
45
+ * // userId: "STRING_VALUE", // required
46
+ * // invitedBy: "STRING_VALUE",
47
+ * // invitees: [ // InviteeList // required
48
+ * // "STRING_VALUE",
49
+ * // ],
50
+ * // nextToken: "STRING_VALUE",
51
+ * // };
52
+ *
53
+ * ```
54
+ *
55
+ * @param GetInviteEdgesCommandInput - {@link GetInviteEdgesCommandInput}
56
+ * @returns {@link GetInviteEdgesCommandOutput}
57
+ * @see {@link GetInviteEdgesCommandInput} for command's `input` shape.
58
+ * @see {@link GetInviteEdgesCommandOutput} for command's `response` shape.
59
+ * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
60
+ *
61
+ * @throws {@link BadRequestError} (client fault)
62
+ * 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
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 GetInviteEdgesCommand extends GetInviteEdgesCommand_base {
95
+ /** @internal type navigation helper, not in runtime. */
96
+ protected static __types: {
97
+ api: {
98
+ input: GetInviteEdgesRequest;
99
+ output: GetInviteEdgesResponse;
100
+ };
101
+ sdk: {
102
+ input: GetInviteEdgesCommandInput;
103
+ output: GetInviteEdgesCommandOutput;
104
+ };
105
+ };
106
+ }
@@ -53,8 +53,31 @@ declare const GetLivenessStatusCommand_base: {
53
53
  * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
54
54
  *
55
55
  * @throws {@link BadRequestError} (client fault)
56
+ * 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
56
57
  *
57
58
  * @throws {@link InternalServerError} (server fault)
59
+ * 500: an unexpected failure (code `INTERNAL_ERROR`).
60
+ *
61
+ * @throws {@link UnauthorizedError} (client fault)
62
+ * 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
63
+ *
64
+ * @throws {@link ForbiddenError} (client fault)
65
+ * 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
66
+ * `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
67
+ *
68
+ * @throws {@link TooManyRequestsError} (client fault)
69
+ * 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
70
+ * `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
71
+ * model.
72
+ *
73
+ * @throws {@link BadGatewayError} (server fault)
74
+ * 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
75
+ * (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
76
+ * (`PROPAGATION_FAILED`, retrying the same request is safe).
77
+ *
78
+ * @throws {@link ServiceUnavailableError} (server fault)
79
+ * 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
80
+ * `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
58
81
  *
59
82
  * @throws {@link OneHookServiceException}
60
83
  * <p>Base exception class for all service exceptions from OneHook service.</p>
@@ -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>