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
@@ -54,8 +54,31 @@ declare const RemoveLocationCommand_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>
@@ -48,8 +48,31 @@ declare const RemoveOneHookSuggestionCommand_base: {
48
48
  * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
49
49
  *
50
50
  * @throws {@link BadRequestError} (client fault)
51
+ * 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
51
52
  *
52
53
  * @throws {@link InternalServerError} (server fault)
54
+ * 500: an unexpected failure (code `INTERNAL_ERROR`).
55
+ *
56
+ * @throws {@link UnauthorizedError} (client fault)
57
+ * 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
58
+ *
59
+ * @throws {@link ForbiddenError} (client fault)
60
+ * 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
61
+ * `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
62
+ *
63
+ * @throws {@link TooManyRequestsError} (client fault)
64
+ * 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
65
+ * `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
66
+ * model.
67
+ *
68
+ * @throws {@link BadGatewayError} (server fault)
69
+ * 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
70
+ * (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
71
+ * (`PROPAGATION_FAILED`, retrying the same request is safe).
72
+ *
73
+ * @throws {@link ServiceUnavailableError} (server fault)
74
+ * 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
75
+ * `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
53
76
  *
54
77
  * @throws {@link OneHookServiceException}
55
78
  * <p>Base exception class for all service exceptions from OneHook service.</p>
@@ -48,8 +48,31 @@ declare const RemoveSuggestionCommand_base: {
48
48
  * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
49
49
  *
50
50
  * @throws {@link BadRequestError} (client fault)
51
+ * 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
51
52
  *
52
53
  * @throws {@link InternalServerError} (server fault)
54
+ * 500: an unexpected failure (code `INTERNAL_ERROR`).
55
+ *
56
+ * @throws {@link UnauthorizedError} (client fault)
57
+ * 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
58
+ *
59
+ * @throws {@link ForbiddenError} (client fault)
60
+ * 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
61
+ * `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
62
+ *
63
+ * @throws {@link TooManyRequestsError} (client fault)
64
+ * 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
65
+ * `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
66
+ * model.
67
+ *
68
+ * @throws {@link BadGatewayError} (server fault)
69
+ * 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
70
+ * (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
71
+ * (`PROPAGATION_FAILED`, retrying the same request is safe).
72
+ *
73
+ * @throws {@link ServiceUnavailableError} (server fault)
74
+ * 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
75
+ * `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
53
76
  *
54
77
  * @throws {@link OneHookServiceException}
55
78
  * <p>Base exception class for all service exceptions from OneHook service.</p>
@@ -0,0 +1,107 @@
1
+ import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
2
+ import { ReportMemberRequest, ReportMemberResponse } 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 ReportMemberCommand}.
14
+ */
15
+ export interface ReportMemberCommandInput extends ReportMemberRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link ReportMemberCommand}.
21
+ */
22
+ export interface ReportMemberCommandOutput extends ReportMemberResponse, __MetadataBearer {
23
+ }
24
+ declare const ReportMemberCommand_base: {
25
+ new (input: ReportMemberCommandInput): import("@smithy/smithy-client").CommandImpl<ReportMemberCommandInput, ReportMemberCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: ReportMemberCommandInput): import("@smithy/smithy-client").CommandImpl<ReportMemberCommandInput, ReportMemberCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Reports a member to moderation. Also blocks them unless `alsoBlock` is false (the default
31
+ * depends on the category). 429 after 20 reports in a day.
32
+ * @example
33
+ * Use a bare-bones client and the command you need to make an API call.
34
+ * ```javascript
35
+ * import { OneHookClient, ReportMemberCommand } from "onehook-api-client"; // ES Modules import
36
+ * // const { OneHookClient, ReportMemberCommand } = require("onehook-api-client"); // CommonJS import
37
+ * const client = new OneHookClient(config);
38
+ * const input = { // ReportMemberRequest
39
+ * reportedUserId: "STRING_VALUE", // required
40
+ * category: "HARASSMENT" || "THREATS_VIOLENCE" || "SEXUAL_CONTENT_NONCONSENT" || "MINOR_SAFETY" || "SCAM_FRAUD" || "FAKE_IMPERSONATION" || "SPAM_PROMOTION" || "HATE" || "SELF_HARM_CONCERN" || "OFF_PLATFORM_HARM" || "OTHER", // required
41
+ * details: "STRING_VALUE",
42
+ * alsoBlock: true || false,
43
+ * conversationId: "STRING_VALUE",
44
+ * evidenceOffered: true || false,
45
+ * };
46
+ * const command = new ReportMemberCommand(input);
47
+ * const response = await client.send(command);
48
+ * // { // ReportMemberResponse
49
+ * // reportId: "STRING_VALUE", // required
50
+ * // severity: "STRING_VALUE", // required
51
+ * // evidenceAllowed: true || false, // required
52
+ * // };
53
+ *
54
+ * ```
55
+ *
56
+ * @param ReportMemberCommandInput - {@link ReportMemberCommandInput}
57
+ * @returns {@link ReportMemberCommandOutput}
58
+ * @see {@link ReportMemberCommandInput} for command's `input` shape.
59
+ * @see {@link ReportMemberCommandOutput} for command's `response` shape.
60
+ * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
61
+ *
62
+ * @throws {@link BadRequestError} (client fault)
63
+ * 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
64
+ *
65
+ * @throws {@link TooManyRequestsError} (client fault)
66
+ * 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
67
+ * `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
68
+ * model.
69
+ *
70
+ * @throws {@link InternalServerError} (server fault)
71
+ * 500: an unexpected failure (code `INTERNAL_ERROR`).
72
+ *
73
+ * @throws {@link UnauthorizedError} (client fault)
74
+ * 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
75
+ *
76
+ * @throws {@link ForbiddenError} (client fault)
77
+ * 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
78
+ * `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
79
+ *
80
+ * @throws {@link BadGatewayError} (server fault)
81
+ * 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
82
+ * (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
83
+ * (`PROPAGATION_FAILED`, retrying the same request is safe).
84
+ *
85
+ * @throws {@link ServiceUnavailableError} (server fault)
86
+ * 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
87
+ * `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
88
+ *
89
+ * @throws {@link OneHookServiceException}
90
+ * <p>Base exception class for all service exceptions from OneHook service.</p>
91
+ *
92
+ *
93
+ * @public
94
+ */
95
+ export declare class ReportMemberCommand extends ReportMemberCommand_base {
96
+ /** @internal type navigation helper, not in runtime. */
97
+ protected static __types: {
98
+ api: {
99
+ input: ReportMemberRequest;
100
+ output: ReportMemberResponse;
101
+ };
102
+ sdk: {
103
+ input: ReportMemberCommandInput;
104
+ output: ReportMemberCommandOutput;
105
+ };
106
+ };
107
+ }
@@ -0,0 +1,109 @@
1
+ import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
2
+ import { RepublishMatchingProfileRequest, RepublishMatchingProfileResponse } 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 RepublishMatchingProfileCommand}.
14
+ */
15
+ export interface RepublishMatchingProfileCommandInput extends RepublishMatchingProfileRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link RepublishMatchingProfileCommand}.
21
+ */
22
+ export interface RepublishMatchingProfileCommandOutput extends RepublishMatchingProfileResponse, __MetadataBearer {
23
+ }
24
+ declare const RepublishMatchingProfileCommand_base: {
25
+ new (input: RepublishMatchingProfileCommandInput): import("@smithy/smithy-client").CommandImpl<RepublishMatchingProfileCommandInput, RepublishMatchingProfileCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: RepublishMatchingProfileCommandInput): import("@smithy/smithy-client").CommandImpl<RepublishMatchingProfileCommandInput, RepublishMatchingProfileCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Internal, IAM-authorized (SigV4): publishes `ProfileUpdated` again for the member's matching
31
+ * profile, through Profile's normal stream publisher. Matching's nightly reconciliation calls it for a
32
+ * member who is ON in State but has no Matching row. Only an ACTIVE matching profile is published
33
+ * (404 `NO_ACTIVE_MATCHING_PROFILE` otherwise, including while the account or the matching data is
34
+ * being erased). Idempotent: every call publishes the current profile once more, and Matching applies
35
+ * a repeated `ProfileUpdated` idempotently (an upsert fenced by generation). 403 without an IAM caller.
36
+ * @example
37
+ * Use a bare-bones client and the command you need to make an API call.
38
+ * ```javascript
39
+ * import { OneHookClient, RepublishMatchingProfileCommand } from "onehook-api-client"; // ES Modules import
40
+ * // const { OneHookClient, RepublishMatchingProfileCommand } = require("onehook-api-client"); // CommonJS import
41
+ * const client = new OneHookClient(config);
42
+ * const input = { // RepublishMatchingProfileRequest
43
+ * userId: "STRING_VALUE", // required
44
+ * };
45
+ * const command = new RepublishMatchingProfileCommand(input);
46
+ * const response = await client.send(command);
47
+ * // { // RepublishMatchingProfileResponse
48
+ * // status: "STRING_VALUE", // required
49
+ * // generation: Number("long"), // required
50
+ * // };
51
+ *
52
+ * ```
53
+ *
54
+ * @param RepublishMatchingProfileCommandInput - {@link RepublishMatchingProfileCommandInput}
55
+ * @returns {@link RepublishMatchingProfileCommandOutput}
56
+ * @see {@link RepublishMatchingProfileCommandInput} for command's `input` shape.
57
+ * @see {@link RepublishMatchingProfileCommandOutput} for command's `response` shape.
58
+ * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
59
+ *
60
+ * @throws {@link BadRequestError} (client fault)
61
+ * 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
62
+ *
63
+ * @throws {@link ForbiddenError} (client fault)
64
+ * 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
65
+ * `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
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`).
70
+ *
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 TooManyRequestsError} (client fault)
78
+ * 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
79
+ * `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
80
+ * model.
81
+ *
82
+ * @throws {@link BadGatewayError} (server fault)
83
+ * 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
84
+ * (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
85
+ * (`PROPAGATION_FAILED`, retrying the same request is safe).
86
+ *
87
+ * @throws {@link ServiceUnavailableError} (server fault)
88
+ * 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
89
+ * `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
90
+ *
91
+ * @throws {@link OneHookServiceException}
92
+ * <p>Base exception class for all service exceptions from OneHook service.</p>
93
+ *
94
+ *
95
+ * @public
96
+ */
97
+ export declare class RepublishMatchingProfileCommand extends RepublishMatchingProfileCommand_base {
98
+ /** @internal type navigation helper, not in runtime. */
99
+ protected static __types: {
100
+ api: {
101
+ input: RepublishMatchingProfileRequest;
102
+ output: RepublishMatchingProfileResponse;
103
+ };
104
+ sdk: {
105
+ input: RepublishMatchingProfileCommandInput;
106
+ output: RepublishMatchingProfileCommandOutput;
107
+ };
108
+ };
109
+ }
@@ -54,8 +54,31 @@ declare const RequestEmailOtpCommand_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>
@@ -53,8 +53,31 @@ declare const RequestPhoneOtpCommand_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>
@@ -53,8 +53,31 @@ declare const RequestPhoneUpdateOtpCommand_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>
@@ -53,12 +53,35 @@ declare const RevokeDeviceCommand_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 ForbiddenError} (client fault)
59
+ * 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
60
+ * `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
58
61
  *
59
62
  * @throws {@link NotFoundError} (client fault)
63
+ * 404: the resource does not exist or is not visible to the caller (code `NOT_FOUND`, or a more
64
+ * specific one such as `REQUEST_UNAVAILABLE`).
60
65
  *
61
66
  * @throws {@link InternalServerError} (server fault)
67
+ * 500: an unexpected failure (code `INTERNAL_ERROR`).
68
+ *
69
+ * @throws {@link UnauthorizedError} (client fault)
70
+ * 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
71
+ *
72
+ * @throws {@link TooManyRequestsError} (client fault)
73
+ * 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
74
+ * `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
75
+ * model.
76
+ *
77
+ * @throws {@link BadGatewayError} (server fault)
78
+ * 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
79
+ * (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
80
+ * (`PROPAGATION_FAILED`, retrying the same request is safe).
81
+ *
82
+ * @throws {@link ServiceUnavailableError} (server fault)
83
+ * 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
84
+ * `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
62
85
  *
63
86
  * @throws {@link OneHookServiceException}
64
87
  * <p>Base exception class for all service exceptions from OneHook service.</p>
@@ -0,0 +1,108 @@
1
+ import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
2
+ import { RevokeHistoryWrapRequest, RevokeHistoryWrapResponse } 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 RevokeHistoryWrapCommand}.
14
+ */
15
+ export interface RevokeHistoryWrapCommandInput extends RevokeHistoryWrapRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link RevokeHistoryWrapCommand}.
21
+ */
22
+ export interface RevokeHistoryWrapCommandOutput extends RevokeHistoryWrapResponse, __MetadataBearer {
23
+ }
24
+ declare const RevokeHistoryWrapCommand_base: {
25
+ new (input: RevokeHistoryWrapCommandInput): import("@smithy/smithy-client").CommandImpl<RevokeHistoryWrapCommandInput, RevokeHistoryWrapCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: RevokeHistoryWrapCommandInput): import("@smithy/smithy-client").CommandImpl<RevokeHistoryWrapCommandInput, RevokeHistoryWrapCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Removes one wrap: a retired device, or a passkey the member deleted. 404 when there is no such wrap.
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { OneHookClient, RevokeHistoryWrapCommand } from "onehook-api-client"; // ES Modules import
35
+ * // const { OneHookClient, RevokeHistoryWrapCommand } = require("onehook-api-client"); // CommonJS import
36
+ * const client = new OneHookClient(config);
37
+ * const input = { // RevokeHistoryWrapRequest
38
+ * epoch: Number("int"), // required
39
+ * method: "STRING_VALUE", // required
40
+ * wrapId: "STRING_VALUE", // required
41
+ * };
42
+ * const command = new RevokeHistoryWrapCommand(input);
43
+ * const response = await client.send(command);
44
+ * // { // RevokeHistoryWrapResponse
45
+ * // epoch: Number("int"), // required
46
+ * // method: "STRING_VALUE", // required
47
+ * // wrapId: "STRING_VALUE", // required
48
+ * // revoked: true || false, // required
49
+ * // };
50
+ *
51
+ * ```
52
+ *
53
+ * @param RevokeHistoryWrapCommandInput - {@link RevokeHistoryWrapCommandInput}
54
+ * @returns {@link RevokeHistoryWrapCommandOutput}
55
+ * @see {@link RevokeHistoryWrapCommandInput} for command's `input` shape.
56
+ * @see {@link RevokeHistoryWrapCommandOutput} for command's `response` shape.
57
+ * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
58
+ *
59
+ * @throws {@link BadRequestError} (client fault)
60
+ * 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
61
+ *
62
+ * @throws {@link ForbiddenError} (client fault)
63
+ * 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
64
+ * `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
65
+ *
66
+ * @throws {@link NotFoundError} (client fault)
67
+ * 404: the resource does not exist or is not visible to the caller (code `NOT_FOUND`, or a more
68
+ * specific one such as `REQUEST_UNAVAILABLE`).
69
+ *
70
+ * @throws {@link InternalServerError} (server fault)
71
+ * 500: an unexpected failure (code `INTERNAL_ERROR`).
72
+ *
73
+ * @throws {@link UnauthorizedError} (client fault)
74
+ * 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
75
+ *
76
+ * @throws {@link TooManyRequestsError} (client fault)
77
+ * 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
78
+ * `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
79
+ * model.
80
+ *
81
+ * @throws {@link BadGatewayError} (server fault)
82
+ * 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
83
+ * (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
84
+ * (`PROPAGATION_FAILED`, retrying the same request is safe).
85
+ *
86
+ * @throws {@link ServiceUnavailableError} (server fault)
87
+ * 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
88
+ * `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
89
+ *
90
+ * @throws {@link OneHookServiceException}
91
+ * <p>Base exception class for all service exceptions from OneHook service.</p>
92
+ *
93
+ *
94
+ * @public
95
+ */
96
+ export declare class RevokeHistoryWrapCommand extends RevokeHistoryWrapCommand_base {
97
+ /** @internal type navigation helper, not in runtime. */
98
+ protected static __types: {
99
+ api: {
100
+ input: RevokeHistoryWrapRequest;
101
+ output: RevokeHistoryWrapResponse;
102
+ };
103
+ sdk: {
104
+ input: RevokeHistoryWrapCommandInput;
105
+ output: RevokeHistoryWrapCommandOutput;
106
+ };
107
+ };
108
+ }
@@ -68,10 +68,35 @@ declare const RevokeUserAccessCommand_base: {
68
68
  * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
69
69
  *
70
70
  * @throws {@link BadRequestError} (client fault)
71
+ * 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
71
72
  *
72
73
  * @throws {@link NotFoundError} (client fault)
74
+ * 404: the resource does not exist or is not visible to the caller (code `NOT_FOUND`, or a more
75
+ * specific one such as `REQUEST_UNAVAILABLE`).
73
76
  *
74
77
  * @throws {@link InternalServerError} (server fault)
78
+ * 500: an unexpected failure (code `INTERNAL_ERROR`).
79
+ *
80
+ * @throws {@link UnauthorizedError} (client fault)
81
+ * 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
82
+ *
83
+ * @throws {@link ForbiddenError} (client fault)
84
+ * 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
85
+ * `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
86
+ *
87
+ * @throws {@link TooManyRequestsError} (client fault)
88
+ * 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
89
+ * `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
90
+ * model.
91
+ *
92
+ * @throws {@link BadGatewayError} (server fault)
93
+ * 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
94
+ * (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
95
+ * (`PROPAGATION_FAILED`, retrying the same request is safe).
96
+ *
97
+ * @throws {@link ServiceUnavailableError} (server fault)
98
+ * 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
99
+ * `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
75
100
  *
76
101
  * @throws {@link OneHookServiceException}
77
102
  * <p>Base exception class for all service exceptions from OneHook service.</p>
@@ -59,8 +59,31 @@ declare const SearchPlacesCommand_base: {
59
59
  * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
60
60
  *
61
61
  * @throws {@link BadRequestError} (client fault)
62
+ * 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
62
63
  *
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`.
64
87
  *
65
88
  * @throws {@link OneHookServiceException}
66
89
  * <p>Base exception class for all service exceptions from OneHook service.</p>
@@ -57,10 +57,35 @@ declare const SendAdminLinkOtpCommand_base: {
57
57
  * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
58
58
  *
59
59
  * @throws {@link BadRequestError} (client fault)
60
+ * 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
60
61
  *
61
62
  * @throws {@link NotFoundError} (client fault)
63
+ * 404: the resource does not exist or is not visible to the caller (code `NOT_FOUND`, or a more
64
+ * specific one such as `REQUEST_UNAVAILABLE`).
62
65
  *
63
66
  * @throws {@link InternalServerError} (server fault)
67
+ * 500: an unexpected failure (code `INTERNAL_ERROR`).
68
+ *
69
+ * @throws {@link UnauthorizedError} (client fault)
70
+ * 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
71
+ *
72
+ * @throws {@link ForbiddenError} (client fault)
73
+ * 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
74
+ * `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
75
+ *
76
+ * @throws {@link TooManyRequestsError} (client fault)
77
+ * 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
78
+ * `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
79
+ * model.
80
+ *
81
+ * @throws {@link BadGatewayError} (server fault)
82
+ * 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
83
+ * (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
84
+ * (`PROPAGATION_FAILED`, retrying the same request is safe).
85
+ *
86
+ * @throws {@link ServiceUnavailableError} (server fault)
87
+ * 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
88
+ * `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
64
89
  *
65
90
  * @throws {@link OneHookServiceException}
66
91
  * <p>Base exception class for all service exceptions from OneHook service.</p>