onehook-api-client 1.0.36 → 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 +62 -14
  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 +62 -14
  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 +29 -2
  222. package/package.json +1 -1
  223. package/telemetry/TelemetryCatalog.kt +42 -16
  224. package/telemetry/TelemetryCatalog.swift +63 -16
  225. package/telemetry/telemetry-catalog.json +420 -49
  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
@@ -30,7 +30,7 @@ declare const CompleteLivenessSessionCommand_base: {
30
30
  * Submits a completed Face Liveness session for asynchronous analysis. The backend evaluates the
31
31
  * result in the background (Rekognition results + face match) and, on success, sets the profile's
32
32
  * internal `verified` flag. Clients receive an immediate acknowledgement and learn the outcome
33
- * later via GetProfile (the `verified` field).
33
+ * later via `GetLivenessStatus` (or the matching profile's `verified` field in `GetMyProfile`).
34
34
  * @example
35
35
  * Use a bare-bones client and the command you need to make an API call.
36
36
  * ```javascript
@@ -55,10 +55,35 @@ declare const CompleteLivenessSessionCommand_base: {
55
55
  * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
56
56
  *
57
57
  * @throws {@link BadRequestError} (client fault)
58
+ * 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
58
59
  *
59
60
  * @throws {@link NotFoundError} (client fault)
61
+ * 404: the resource does not exist or is not visible to the caller (code `NOT_FOUND`, or a more
62
+ * specific one such as `REQUEST_UNAVAILABLE`).
60
63
  *
61
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`.
62
87
  *
63
88
  * @throws {@link OneHookServiceException}
64
89
  * <p>Base exception class for all service exceptions from OneHook service.</p>
@@ -27,8 +27,7 @@ declare const CompleteOnboardingCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * @public
31
- *
30
+ * 409 while the chat profile or the sign-in credentials are not ready.
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -51,15 +50,45 @@ declare const CompleteOnboardingCommand_base: {
51
50
  * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
52
51
  *
53
52
  * @throws {@link BadRequestError} (client fault)
53
+ * 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
54
54
  *
55
55
  * @throws {@link NotFoundError} (client fault)
56
+ * 404: the resource does not exist or is not visible to the caller (code `NOT_FOUND`, or a more
57
+ * specific one such as `REQUEST_UNAVAILABLE`).
58
+ *
59
+ * @throws {@link ConflictError} (client fault)
60
+ * 409: the request conflicts with the current state (code `CONFLICT`, or a more specific one such
61
+ * as `NOT_READY` or `MATCHING_ERASING`).
56
62
  *
57
63
  * @throws {@link InternalServerError} (server fault)
64
+ * 500: an unexpected failure (code `INTERNAL_ERROR`).
65
+ *
66
+ * @throws {@link UnauthorizedError} (client fault)
67
+ * 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
68
+ *
69
+ * @throws {@link ForbiddenError} (client fault)
70
+ * 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
71
+ * `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
72
+ *
73
+ * @throws {@link TooManyRequestsError} (client fault)
74
+ * 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
75
+ * `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
76
+ * model.
77
+ *
78
+ * @throws {@link BadGatewayError} (server fault)
79
+ * 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
80
+ * (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
81
+ * (`PROPAGATION_FAILED`, retrying the same request is safe).
82
+ *
83
+ * @throws {@link ServiceUnavailableError} (server fault)
84
+ * 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
85
+ * `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
58
86
  *
59
87
  * @throws {@link OneHookServiceException}
60
88
  * <p>Base exception class for all service exceptions from OneHook service.</p>
61
89
  *
62
90
  *
91
+ * @public
63
92
  */
64
93
  export declare class CompleteOnboardingCommand extends CompleteOnboardingCommand_base {
65
94
  /** @internal type navigation helper, not in runtime. */
@@ -62,10 +62,35 @@ declare const CorrectBirthDateCommand_base: {
62
62
  * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
63
63
  *
64
64
  * @throws {@link BadRequestError} (client fault)
65
+ * 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
65
66
  *
66
67
  * @throws {@link NotFoundError} (client fault)
68
+ * 404: the resource does not exist or is not visible to the caller (code `NOT_FOUND`, or a more
69
+ * specific one such as `REQUEST_UNAVAILABLE`).
67
70
  *
68
71
  * @throws {@link InternalServerError} (server fault)
72
+ * 500: an unexpected failure (code `INTERNAL_ERROR`).
73
+ *
74
+ * @throws {@link UnauthorizedError} (client fault)
75
+ * 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
76
+ *
77
+ * @throws {@link ForbiddenError} (client fault)
78
+ * 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
79
+ * `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
80
+ *
81
+ * @throws {@link TooManyRequestsError} (client fault)
82
+ * 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
83
+ * `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
84
+ * model.
85
+ *
86
+ * @throws {@link BadGatewayError} (server fault)
87
+ * 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
88
+ * (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
89
+ * (`PROPAGATION_FAILED`, retrying the same request is safe).
90
+ *
91
+ * @throws {@link ServiceUnavailableError} (server fault)
92
+ * 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
93
+ * `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
69
94
  *
70
95
  * @throws {@link OneHookServiceException}
71
96
  * <p>Base exception class for all service exceptions from OneHook service.</p>
@@ -63,8 +63,31 @@ declare const CreateAdminInviteCommand_base: {
63
63
  * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
64
64
  *
65
65
  * @throws {@link BadRequestError} (client fault)
66
+ * 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
66
67
  *
67
68
  * @throws {@link InternalServerError} (server fault)
69
+ * 500: an unexpected failure (code `INTERNAL_ERROR`).
70
+ *
71
+ * @throws {@link UnauthorizedError} (client fault)
72
+ * 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
73
+ *
74
+ * @throws {@link ForbiddenError} (client fault)
75
+ * 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
76
+ * `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
77
+ *
78
+ * @throws {@link TooManyRequestsError} (client fault)
79
+ * 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
80
+ * `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
81
+ * model.
82
+ *
83
+ * @throws {@link BadGatewayError} (server fault)
84
+ * 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
85
+ * (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
86
+ * (`PROPAGATION_FAILED`, retrying the same request is safe).
87
+ *
88
+ * @throws {@link ServiceUnavailableError} (server fault)
89
+ * 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
90
+ * `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
68
91
  *
69
92
  * @throws {@link OneHookServiceException}
70
93
  * <p>Base exception class for all service exceptions from OneHook service.</p>
@@ -52,8 +52,31 @@ declare const CreateLivenessSessionCommand_base: {
52
52
  * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
53
53
  *
54
54
  * @throws {@link BadRequestError} (client fault)
55
+ * 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
55
56
  *
56
57
  * @throws {@link InternalServerError} (server fault)
58
+ * 500: an unexpected failure (code `INTERNAL_ERROR`).
59
+ *
60
+ * @throws {@link UnauthorizedError} (client fault)
61
+ * 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
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 TooManyRequestsError} (client fault)
68
+ * 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
69
+ * `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
70
+ * model.
71
+ *
72
+ * @throws {@link BadGatewayError} (server fault)
73
+ * 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
74
+ * (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
75
+ * (`PROPAGATION_FAILED`, retrying the same request is safe).
76
+ *
77
+ * @throws {@link ServiceUnavailableError} (server fault)
78
+ * 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
79
+ * `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
57
80
  *
58
81
  * @throws {@link OneHookServiceException}
59
82
  * <p>Base exception class for all service exceptions from OneHook service.</p>
@@ -59,12 +59,35 @@ declare const CreateMediaDownloadUrlCommand_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 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.
64
67
  *
65
68
  * @throws {@link NotFoundError} (client fault)
69
+ * 404: the resource does not exist or is not visible to the caller (code `NOT_FOUND`, or a more
70
+ * specific one such as `REQUEST_UNAVAILABLE`).
66
71
  *
67
72
  * @throws {@link InternalServerError} (server fault)
73
+ * 500: an unexpected failure (code `INTERNAL_ERROR`).
74
+ *
75
+ * @throws {@link UnauthorizedError} (client fault)
76
+ * 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
77
+ *
78
+ * @throws {@link TooManyRequestsError} (client fault)
79
+ * 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
80
+ * `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
81
+ * model.
82
+ *
83
+ * @throws {@link BadGatewayError} (server fault)
84
+ * 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
85
+ * (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
86
+ * (`PROPAGATION_FAILED`, retrying the same request is safe).
87
+ *
88
+ * @throws {@link ServiceUnavailableError} (server fault)
89
+ * 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
90
+ * `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
68
91
  *
69
92
  * @throws {@link OneHookServiceException}
70
93
  * <p>Base exception class for all service exceptions from OneHook service.</p>
@@ -45,7 +45,7 @@ declare const CreateMediaUploadUrlCommand_base: {
45
45
  * const input = { // CreateMediaUploadUrlRequest
46
46
  * matchId: "STRING_VALUE", // required
47
47
  * contentLength: Number("long"), // required
48
- * kind: "IMAGE" || "VIDEO" || "AUDIO" || "FILE", // required
48
+ * kind: "IMAGE" || "VIDEO" || "AUDIO" || "FILE",
49
49
  * };
50
50
  * const command = new CreateMediaUploadUrlCommand(input);
51
51
  * const response = await client.send(command);
@@ -64,12 +64,35 @@ declare const CreateMediaUploadUrlCommand_base: {
64
64
  * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
65
65
  *
66
66
  * @throws {@link BadRequestError} (client fault)
67
+ * 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
67
68
  *
68
69
  * @throws {@link ForbiddenError} (client fault)
70
+ * 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
71
+ * `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
69
72
  *
70
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`).
71
76
  *
72
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 TooManyRequestsError} (client fault)
84
+ * 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
85
+ * `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
86
+ * model.
87
+ *
88
+ * @throws {@link BadGatewayError} (server fault)
89
+ * 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
90
+ * (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
91
+ * (`PROPAGATION_FAILED`, retrying the same request is safe).
92
+ *
93
+ * @throws {@link ServiceUnavailableError} (server fault)
94
+ * 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
95
+ * `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
73
96
  *
74
97
  * @throws {@link OneHookServiceException}
75
98
  * <p>Base exception class for all service exceptions from OneHook service.</p>
@@ -0,0 +1,103 @@
1
+ import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
2
+ import { HookRequestIdRequest, StatusResponse } from "../models/models_0";
3
+ import { Command as $Command } from "@smithy/smithy-client";
4
+ import { MetadataBearer as __MetadataBearer } from "@smithy/types";
5
+ /**
6
+ * @public
7
+ */
8
+ export type { __MetadataBearer };
9
+ export { $Command };
10
+ /**
11
+ * @public
12
+ *
13
+ * The input for {@link DeclineHookRequestCommand}.
14
+ */
15
+ export interface DeclineHookRequestCommandInput extends HookRequestIdRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link DeclineHookRequestCommand}.
21
+ */
22
+ export interface DeclineHookRequestCommandOutput extends StatusResponse, __MetadataBearer {
23
+ }
24
+ declare const DeclineHookRequestCommand_base: {
25
+ new (input: DeclineHookRequestCommandInput): import("@smithy/smithy-client").CommandImpl<DeclineHookRequestCommandInput, DeclineHookRequestCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: DeclineHookRequestCommandInput): import("@smithy/smithy-client").CommandImpl<DeclineHookRequestCommandInput, DeclineHookRequestCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Declines an incoming request. The sender keeps seeing it as pending until it expires.
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { OneHookClient, DeclineHookRequestCommand } from "onehook-api-client"; // ES Modules import
35
+ * // const { OneHookClient, DeclineHookRequestCommand } = require("onehook-api-client"); // CommonJS import
36
+ * const client = new OneHookClient(config);
37
+ * const input = { // HookRequestIdRequest
38
+ * requestId: "STRING_VALUE", // required
39
+ * };
40
+ * const command = new DeclineHookRequestCommand(input);
41
+ * const response = await client.send(command);
42
+ * // { // StatusResponse
43
+ * // status: "STRING_VALUE", // required
44
+ * // };
45
+ *
46
+ * ```
47
+ *
48
+ * @param DeclineHookRequestCommandInput - {@link DeclineHookRequestCommandInput}
49
+ * @returns {@link DeclineHookRequestCommandOutput}
50
+ * @see {@link DeclineHookRequestCommandInput} for command's `input` shape.
51
+ * @see {@link DeclineHookRequestCommandOutput} for command's `response` shape.
52
+ * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
53
+ *
54
+ * @throws {@link BadRequestError} (client fault)
55
+ * 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
56
+ *
57
+ * @throws {@link NotFoundError} (client fault)
58
+ * 404: the resource does not exist or is not visible to the caller (code `NOT_FOUND`, or a more
59
+ * specific one such as `REQUEST_UNAVAILABLE`).
60
+ *
61
+ * @throws {@link InternalServerError} (server fault)
62
+ * 500: an unexpected failure (code `INTERNAL_ERROR`).
63
+ *
64
+ * @throws {@link UnauthorizedError} (client fault)
65
+ * 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
66
+ *
67
+ * @throws {@link ForbiddenError} (client fault)
68
+ * 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
69
+ * `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
70
+ *
71
+ * @throws {@link TooManyRequestsError} (client fault)
72
+ * 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
73
+ * `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
74
+ * model.
75
+ *
76
+ * @throws {@link BadGatewayError} (server fault)
77
+ * 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
78
+ * (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
79
+ * (`PROPAGATION_FAILED`, retrying the same request is safe).
80
+ *
81
+ * @throws {@link ServiceUnavailableError} (server fault)
82
+ * 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
83
+ * `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
84
+ *
85
+ * @throws {@link OneHookServiceException}
86
+ * <p>Base exception class for all service exceptions from OneHook service.</p>
87
+ *
88
+ *
89
+ * @public
90
+ */
91
+ export declare class DeclineHookRequestCommand extends DeclineHookRequestCommand_base {
92
+ /** @internal type navigation helper, not in runtime. */
93
+ protected static __types: {
94
+ api: {
95
+ input: HookRequestIdRequest;
96
+ output: StatusResponse;
97
+ };
98
+ sdk: {
99
+ input: DeclineHookRequestCommandInput;
100
+ output: DeclineHookRequestCommandOutput;
101
+ };
102
+ };
103
+ }
@@ -52,10 +52,31 @@ declare const DeleteMatchMessagesCommand_base: {
52
52
  * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
53
53
  *
54
54
  * @throws {@link BadRequestError} (client fault)
55
+ * 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
55
56
  *
56
57
  * @throws {@link ForbiddenError} (client fault)
58
+ * 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
59
+ * `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
57
60
  *
58
61
  * @throws {@link InternalServerError} (server fault)
62
+ * 500: an unexpected failure (code `INTERNAL_ERROR`).
63
+ *
64
+ * @throws {@link UnauthorizedError} (client fault)
65
+ * 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
66
+ *
67
+ * @throws {@link TooManyRequestsError} (client fault)
68
+ * 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
69
+ * `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
70
+ * model.
71
+ *
72
+ * @throws {@link BadGatewayError} (server fault)
73
+ * 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
74
+ * (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
75
+ * (`PROPAGATION_FAILED`, retrying the same request is safe).
76
+ *
77
+ * @throws {@link ServiceUnavailableError} (server fault)
78
+ * 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
79
+ * `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
59
80
  *
60
81
  * @throws {@link OneHookServiceException}
61
82
  * <p>Base exception class for all service exceptions from OneHook service.</p>
@@ -27,8 +27,8 @@ declare const DeleteProfileCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * @public
31
- *
30
+ * Deletes the caller's account. 202: the deletion is recorded and runs in the background (status
31
+ * `PROFILE_DELETION_SCHEDULED`); 404 when there is no profile.
32
32
  * @example
33
33
  * Use a bare-bones client and the command you need to make an API call.
34
34
  * ```javascript
@@ -53,15 +53,41 @@ declare const DeleteProfileCommand_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 NotFoundError} (client fault)
59
+ * 404: the resource does not exist or is not visible to the caller (code `NOT_FOUND`, or a more
60
+ * specific one such as `REQUEST_UNAVAILABLE`).
58
61
  *
59
62
  * @throws {@link InternalServerError} (server fault)
63
+ * 500: an unexpected failure (code `INTERNAL_ERROR`).
64
+ *
65
+ * @throws {@link UnauthorizedError} (client fault)
66
+ * 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
67
+ *
68
+ * @throws {@link ForbiddenError} (client fault)
69
+ * 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
70
+ * `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
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`.
60
85
  *
61
86
  * @throws {@link OneHookServiceException}
62
87
  * <p>Base exception class for all service exceptions from OneHook service.</p>
63
88
  *
64
89
  *
90
+ * @public
65
91
  */
66
92
  export declare class DeleteProfileCommand extends DeleteProfileCommand_base {
67
93
  /** @internal type navigation helper, not in runtime. */
@@ -57,12 +57,35 @@ declare const DeletePushTokenCommand_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 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.
62
65
  *
63
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`).
64
69
  *
65
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`.
66
89
  *
67
90
  * @throws {@link OneHookServiceException}
68
91
  * <p>Base exception class for all service exceptions from OneHook service.</p>
@@ -0,0 +1,106 @@
1
+ import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
2
+ import { DisableMatchingRequest, MatchingStatusResponse } 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 DisableMatchingCommand}.
14
+ */
15
+ export interface DisableMatchingCommandInput extends DisableMatchingRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link DisableMatchingCommand}.
21
+ */
22
+ export interface DisableMatchingCommandOutput extends MatchingStatusResponse, __MetadataBearer {
23
+ }
24
+ declare const DisableMatchingCommand_base: {
25
+ new (input: DisableMatchingCommandInput): import("@smithy/smithy-client").CommandImpl<DisableMatchingCommandInput, DisableMatchingCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: DisableMatchingCommandInput): import("@smithy/smithy-client").CommandImpl<DisableMatchingCommandInput, DisableMatchingCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Turns matching off: erases every piece of matching data about the caller (profile, photos,
31
+ * swipes, likes, scores, history copies). Hooks, chats, blocks and requests are kept. 202 while
32
+ * erasing; idempotent.
33
+ * @example
34
+ * Use a bare-bones client and the command you need to make an API call.
35
+ * ```javascript
36
+ * import { OneHookClient, DisableMatchingCommand } from "onehook-api-client"; // ES Modules import
37
+ * // const { OneHookClient, DisableMatchingCommand } = require("onehook-api-client"); // CommonJS import
38
+ * const client = new OneHookClient(config);
39
+ * const input = { // DisableMatchingRequest
40
+ * confirm: "STRING_VALUE", // required
41
+ * };
42
+ * const command = new DisableMatchingCommand(input);
43
+ * const response = await client.send(command);
44
+ * // { // MatchingStatusResponse
45
+ * // status: "OFF" || "ON" || "ERASING", // required
46
+ * // generation: Number("long"), // required
47
+ * // };
48
+ *
49
+ * ```
50
+ *
51
+ * @param DisableMatchingCommandInput - {@link DisableMatchingCommandInput}
52
+ * @returns {@link DisableMatchingCommandOutput}
53
+ * @see {@link DisableMatchingCommandInput} for command's `input` shape.
54
+ * @see {@link DisableMatchingCommandOutput} 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 ConflictError} (client fault)
61
+ * 409: the request conflicts with the current state (code `CONFLICT`, or a more specific one such
62
+ * as `NOT_READY` or `MATCHING_ERASING`).
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 DisableMatchingCommand extends DisableMatchingCommand_base {
95
+ /** @internal type navigation helper, not in runtime. */
96
+ protected static __types: {
97
+ api: {
98
+ input: DisableMatchingRequest;
99
+ output: MatchingStatusResponse;
100
+ };
101
+ sdk: {
102
+ input: DisableMatchingCommandInput;
103
+ output: DisableMatchingCommandOutput;
104
+ };
105
+ };
106
+ }
@@ -66,6 +66,7 @@ declare const DiscoverCommand_base: {
66
66
  * // ],
67
67
  * // },
68
68
  * // ],
69
+ * // viewPass: "STRING_VALUE",
69
70
  * // count: Number("int"), // required
70
71
  * // algorithm: "STRING_VALUE", // required
71
72
  * // category: "ALL" || "PROFILE_MATCH" || "SIMILAR" || "ONEHOOK_SUGGESTED", // required
@@ -83,10 +84,31 @@ declare const DiscoverCommand_base: {
83
84
  * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
84
85
  *
85
86
  * @throws {@link BadRequestError} (client fault)
87
+ * 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
86
88
  *
87
89
  * @throws {@link ForbiddenError} (client fault)
90
+ * 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
91
+ * `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
88
92
  *
89
93
  * @throws {@link InternalServerError} (server fault)
94
+ * 500: an unexpected failure (code `INTERNAL_ERROR`).
95
+ *
96
+ * @throws {@link UnauthorizedError} (client fault)
97
+ * 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
98
+ *
99
+ * @throws {@link TooManyRequestsError} (client fault)
100
+ * 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
101
+ * `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
102
+ * model.
103
+ *
104
+ * @throws {@link BadGatewayError} (server fault)
105
+ * 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
106
+ * (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
107
+ * (`PROPAGATION_FAILED`, retrying the same request is safe).
108
+ *
109
+ * @throws {@link ServiceUnavailableError} (server fault)
110
+ * 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
111
+ * `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
90
112
  *
91
113
  * @throws {@link OneHookServiceException}
92
114
  * <p>Base exception class for all service exceptions from OneHook service.</p>