onehook-api-client 1.0.37 → 1.0.38

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (230) hide show
  1. package/README.md +446 -19
  2. package/dist-cjs/OneHook.js +88 -8
  3. package/dist-cjs/commands/{GetNotificationPreferencesCommand.js → AcceptHookRequestCommand.js} +7 -7
  4. package/dist-cjs/commands/BlockUserCommand.js +21 -0
  5. package/dist-cjs/commands/CancelHookRequestCommand.js +21 -0
  6. package/dist-cjs/commands/ClearTierOverrideCommand.js +21 -0
  7. package/dist-cjs/commands/DeclineHookRequestCommand.js +21 -0
  8. package/dist-cjs/commands/{SwipeByUsernameCommand.js → DisableMatchingCommand.js} +7 -7
  9. package/dist-cjs/commands/EnableMatchingCommand.js +21 -0
  10. package/dist-cjs/commands/EstablishHistoryEpochCommand.js +21 -0
  11. package/dist-cjs/commands/GetChatProfileCommand.js +21 -0
  12. package/dist-cjs/commands/GetDiscoverySnapshotCommand.js +21 -0
  13. package/dist-cjs/commands/GetGraphInvitesCommand.js +21 -0
  14. package/dist-cjs/commands/{UpdateProfileCommand.js → GetGraphMatchCommand.js} +7 -7
  15. package/dist-cjs/commands/GetGraphUserCommand.js +21 -0
  16. package/dist-cjs/commands/GetHistoryStateCommand.js +21 -0
  17. package/dist-cjs/commands/GetInternalMatchingStatusCommand.js +21 -0
  18. package/dist-cjs/commands/GetInternalProfileCommand.js +21 -0
  19. package/dist-cjs/commands/GetInviteEdgesCommand.js +21 -0
  20. package/dist-cjs/commands/GetMatchingProfileCommand.js +21 -0
  21. package/dist-cjs/commands/GetMatchingReadinessCommand.js +21 -0
  22. package/dist-cjs/commands/GetMediaStatsCommand.js +21 -0
  23. package/dist-cjs/commands/GetModerationReportCommand.js +21 -0
  24. package/dist-cjs/commands/GetModerationSignalsCommand.js +21 -0
  25. package/dist-cjs/commands/GetPartnerDistanceCommand.js +21 -0
  26. package/dist-cjs/commands/GetScoringPolicyCommand.js +21 -0
  27. package/dist-cjs/commands/GetTierOverrideCommand.js +21 -0
  28. package/dist-cjs/commands/IngestSignalsCommand.js +21 -0
  29. package/dist-cjs/commands/IssueViewPassesCommand.js +21 -0
  30. package/dist-cjs/commands/KeepHooksCommand.js +21 -0
  31. package/dist-cjs/commands/{GetProfileCommand.js → ListBlocksCommand.js} +7 -7
  32. package/dist-cjs/commands/ListGraphUserMatchesCommand.js +21 -0
  33. package/dist-cjs/commands/ListHookRequestsCommand.js +21 -0
  34. package/dist-cjs/commands/ListMatchingOnMembersCommand.js +21 -0
  35. package/dist-cjs/commands/PutHistoryWrapCommand.js +21 -0
  36. package/dist-cjs/commands/RecordSuggestionInternalCommand.js +21 -0
  37. package/dist-cjs/commands/ReportMemberCommand.js +21 -0
  38. package/dist-cjs/commands/RepublishMatchingProfileCommand.js +21 -0
  39. package/dist-cjs/commands/RevokeHistoryWrapCommand.js +21 -0
  40. package/dist-cjs/commands/SendHookRequestCommand.js +21 -0
  41. package/dist-cjs/commands/SetTierOverrideCommand.js +21 -0
  42. package/dist-cjs/commands/SimulateScoringPolicyCommand.js +21 -0
  43. package/dist-cjs/commands/UnblockUserCommand.js +21 -0
  44. package/dist-cjs/commands/UpdateScoringPolicyCommand.js +21 -0
  45. package/dist-cjs/commands/UpsertChatProfileCommand.js +21 -0
  46. package/dist-cjs/commands/UpsertMatchingProfileCommand.js +21 -0
  47. package/dist-cjs/commands/index.js +44 -4
  48. package/dist-cjs/graphql/types.js +4 -0
  49. package/dist-cjs/models/models_0.js +216 -21
  50. package/dist-cjs/protocols/Aws_restJson1.js +2198 -514
  51. package/dist-cjs/telemetry/index.js +49 -9
  52. package/dist-es/OneHook.js +88 -8
  53. package/dist-es/commands/AcceptHookRequestCommand.js +17 -0
  54. package/dist-es/commands/BlockUserCommand.js +17 -0
  55. package/dist-es/commands/CancelHookRequestCommand.js +17 -0
  56. package/dist-es/commands/ClearTierOverrideCommand.js +17 -0
  57. package/dist-es/commands/DeclineHookRequestCommand.js +17 -0
  58. package/dist-es/commands/{SwipeByUsernameCommand.js → DisableMatchingCommand.js} +6 -6
  59. package/dist-es/commands/EnableMatchingCommand.js +17 -0
  60. package/dist-es/commands/EstablishHistoryEpochCommand.js +17 -0
  61. package/dist-es/commands/GetChatProfileCommand.js +17 -0
  62. package/dist-es/commands/GetDiscoverySnapshotCommand.js +17 -0
  63. package/dist-es/commands/GetGraphInvitesCommand.js +17 -0
  64. package/dist-es/commands/{UpdateProfileCommand.js → GetGraphMatchCommand.js} +6 -6
  65. package/dist-es/commands/GetGraphUserCommand.js +17 -0
  66. package/dist-es/commands/GetHistoryStateCommand.js +17 -0
  67. package/dist-es/commands/GetInternalMatchingStatusCommand.js +17 -0
  68. package/dist-es/commands/GetInternalProfileCommand.js +17 -0
  69. package/dist-es/commands/GetInviteEdgesCommand.js +17 -0
  70. package/dist-es/commands/GetMatchingProfileCommand.js +17 -0
  71. package/dist-es/commands/GetMatchingReadinessCommand.js +17 -0
  72. package/dist-es/commands/GetMediaStatsCommand.js +17 -0
  73. package/dist-es/commands/GetModerationReportCommand.js +17 -0
  74. package/dist-es/commands/GetModerationSignalsCommand.js +17 -0
  75. package/dist-es/commands/GetPartnerDistanceCommand.js +17 -0
  76. package/dist-es/commands/GetScoringPolicyCommand.js +17 -0
  77. package/dist-es/commands/GetTierOverrideCommand.js +17 -0
  78. package/dist-es/commands/IngestSignalsCommand.js +17 -0
  79. package/dist-es/commands/IssueViewPassesCommand.js +17 -0
  80. package/dist-es/commands/KeepHooksCommand.js +17 -0
  81. package/dist-es/commands/{GetProfileCommand.js → ListBlocksCommand.js} +6 -6
  82. package/dist-es/commands/ListGraphUserMatchesCommand.js +17 -0
  83. package/dist-es/commands/ListHookRequestsCommand.js +17 -0
  84. package/dist-es/commands/ListMatchingOnMembersCommand.js +17 -0
  85. package/dist-es/commands/PutHistoryWrapCommand.js +17 -0
  86. package/dist-es/commands/RecordSuggestionInternalCommand.js +17 -0
  87. package/dist-es/commands/ReportMemberCommand.js +17 -0
  88. package/dist-es/commands/RepublishMatchingProfileCommand.js +17 -0
  89. package/dist-es/commands/RevokeHistoryWrapCommand.js +17 -0
  90. package/dist-es/commands/SendHookRequestCommand.js +17 -0
  91. package/dist-es/commands/SetTierOverrideCommand.js +17 -0
  92. package/dist-es/commands/SimulateScoringPolicyCommand.js +17 -0
  93. package/dist-es/commands/UnblockUserCommand.js +17 -0
  94. package/dist-es/commands/UpdateScoringPolicyCommand.js +17 -0
  95. package/dist-es/commands/UpsertChatProfileCommand.js +17 -0
  96. package/dist-es/commands/UpsertMatchingProfileCommand.js +17 -0
  97. package/dist-es/commands/index.js +44 -4
  98. package/dist-es/graphql/types.js +4 -0
  99. package/dist-es/models/models_0.js +208 -18
  100. package/dist-es/protocols/Aws_restJson1.js +2003 -401
  101. package/dist-es/telemetry/index.js +49 -9
  102. package/dist-types/OneHook.d.ts +311 -23
  103. package/dist-types/OneHookClient.d.ts +46 -6
  104. package/dist-types/commands/AcceptHookRequestCommand.d.ts +109 -0
  105. package/dist-types/commands/AuthSocialCommand.d.ts +23 -0
  106. package/dist-types/commands/BlockUserCommand.d.ts +106 -0
  107. package/dist-types/commands/CancelHookRequestCommand.d.ts +103 -0
  108. package/dist-types/commands/ClearTierOverrideCommand.d.ts +123 -0
  109. package/dist-types/commands/CompleteLivenessSessionCommand.d.ts +26 -1
  110. package/dist-types/commands/CompleteOnboardingCommand.d.ts +31 -2
  111. package/dist-types/commands/CorrectBirthDateCommand.d.ts +25 -0
  112. package/dist-types/commands/CreateAdminInviteCommand.d.ts +23 -0
  113. package/dist-types/commands/CreateLivenessSessionCommand.d.ts +23 -0
  114. package/dist-types/commands/CreateMediaDownloadUrlCommand.d.ts +23 -0
  115. package/dist-types/commands/CreateMediaUploadUrlCommand.d.ts +24 -1
  116. package/dist-types/commands/DeclineHookRequestCommand.d.ts +103 -0
  117. package/dist-types/commands/DeleteMatchMessagesCommand.d.ts +21 -0
  118. package/dist-types/commands/DeleteProfileCommand.d.ts +28 -2
  119. package/dist-types/commands/DeletePushTokenCommand.d.ts +23 -0
  120. package/dist-types/commands/DisableMatchingCommand.d.ts +106 -0
  121. package/dist-types/commands/DiscoverCommand.d.ts +22 -0
  122. package/dist-types/commands/EnableMatchingCommand.d.ts +105 -0
  123. package/dist-types/commands/EstablishHistoryEpochCommand.d.ts +125 -0
  124. package/dist-types/commands/GenerateDownloadUrlCommand.d.ts +26 -0
  125. package/dist-types/commands/GenerateInviteCommand.d.ts +23 -0
  126. package/dist-types/commands/GenerateUploadUrlCommand.d.ts +31 -2
  127. package/dist-types/commands/GetAccountStateCommand.d.ts +25 -0
  128. package/dist-types/commands/GetAdminPhoneStatusCommand.d.ts +23 -0
  129. package/dist-types/commands/GetAiContextMatchCommand.d.ts +25 -0
  130. package/dist-types/commands/GetBirthDateStatusCommand.d.ts +25 -0
  131. package/dist-types/commands/GetChatProfileCommand.d.ts +123 -0
  132. package/dist-types/commands/GetChatSettingsCommand.d.ts +22 -0
  133. package/dist-types/commands/GetCredentialReadinessCommand.d.ts +25 -0
  134. package/dist-types/commands/GetDiscoverySnapshotCommand.d.ts +138 -0
  135. package/dist-types/commands/GetGraphInvitesCommand.d.ts +119 -0
  136. package/dist-types/commands/GetGraphMatchCommand.d.ts +136 -0
  137. package/dist-types/commands/GetGraphUserCommand.d.ts +117 -0
  138. package/dist-types/commands/GetHistoryStateCommand.d.ts +113 -0
  139. package/dist-types/commands/GetInternalMatchingStatusCommand.d.ts +102 -0
  140. package/dist-types/commands/GetInternalProfileCommand.d.ts +174 -0
  141. package/dist-types/commands/GetInviteEdgesCommand.d.ts +106 -0
  142. package/dist-types/commands/GetLivenessStatusCommand.d.ts +23 -0
  143. package/dist-types/commands/GetMatchCommand.d.ts +27 -0
  144. package/dist-types/commands/GetMatchingProfileCommand.d.ts +175 -0
  145. package/dist-types/commands/GetMatchingReadinessCommand.d.ts +107 -0
  146. package/dist-types/commands/GetMediaStatsCommand.d.ts +106 -0
  147. package/dist-types/commands/GetModerationReportCommand.d.ts +113 -0
  148. package/dist-types/commands/GetModerationSignalsCommand.d.ts +123 -0
  149. package/dist-types/commands/GetMyProfileCommand.d.ts +119 -79
  150. package/dist-types/commands/GetParticipantRegistryCommand.d.ts +23 -0
  151. package/dist-types/commands/GetPartnerDistanceCommand.d.ts +102 -0
  152. package/dist-types/commands/GetPlaceCommand.d.ts +25 -0
  153. package/dist-types/commands/GetPreferencesCommand.d.ts +27 -3
  154. package/dist-types/commands/GetPreservationHoldCommand.d.ts +25 -0
  155. package/dist-types/commands/GetReceivedLikesCommand.d.ts +24 -0
  156. package/dist-types/commands/GetRosesCommand.d.ts +25 -0
  157. package/dist-types/commands/GetScoringPolicyCommand.d.ts +143 -0
  158. package/dist-types/commands/GetStateCommand.d.ts +44 -0
  159. package/dist-types/commands/GetSuggestionsCommand.d.ts +23 -0
  160. package/dist-types/commands/GetTierOverrideCommand.d.ts +123 -0
  161. package/dist-types/commands/GetTraditionPreferencesCommand.d.ts +23 -0
  162. package/dist-types/commands/GetUserByEmailCommand.d.ts +27 -0
  163. package/dist-types/commands/GetUserCommand.d.ts +27 -0
  164. package/dist-types/commands/GetUserIdByUsernameCommand.d.ts +28 -3
  165. package/dist-types/commands/IndexLocationCommand.d.ts +23 -0
  166. package/dist-types/commands/IngestSignalsCommand.d.ts +114 -0
  167. package/dist-types/commands/InitUserCommand.d.ts +29 -2
  168. package/dist-types/commands/IssueViewPassesCommand.d.ts +107 -0
  169. package/dist-types/commands/KeepHooksCommand.d.ts +136 -0
  170. package/dist-types/commands/LinkEmailCommand.d.ts +23 -0
  171. package/dist-types/commands/LinkSocialCommand.d.ts +23 -0
  172. package/dist-types/commands/ListBlocksCommand.d.ts +102 -0
  173. package/dist-types/commands/ListGraphUserMatchesCommand.d.ts +117 -0
  174. package/dist-types/commands/ListHookRequestsCommand.d.ts +110 -0
  175. package/dist-types/commands/ListMatchingOnMembersCommand.d.ts +108 -0
  176. package/dist-types/commands/ListMyDevicesCommand.d.ts +20 -0
  177. package/dist-types/commands/PutHistoryWrapCommand.d.ts +112 -0
  178. package/dist-types/commands/RecordSuggestionCommand.d.ts +21 -0
  179. package/dist-types/commands/RecordSuggestionInternalCommand.d.ts +105 -0
  180. package/dist-types/commands/RegisterDeviceCommand.d.ts +25 -10
  181. package/dist-types/commands/RegisterPhoneCommand.d.ts +23 -0
  182. package/dist-types/commands/RegisterPushTokenCommand.d.ts +23 -0
  183. package/dist-types/commands/RemoveLocationCommand.d.ts +23 -0
  184. package/dist-types/commands/RemoveOneHookSuggestionCommand.d.ts +23 -0
  185. package/dist-types/commands/RemoveSuggestionCommand.d.ts +23 -0
  186. package/dist-types/commands/ReportMemberCommand.d.ts +107 -0
  187. package/dist-types/commands/RepublishMatchingProfileCommand.d.ts +109 -0
  188. package/dist-types/commands/RequestEmailOtpCommand.d.ts +23 -0
  189. package/dist-types/commands/RequestPhoneOtpCommand.d.ts +23 -0
  190. package/dist-types/commands/RequestPhoneUpdateOtpCommand.d.ts +23 -0
  191. package/dist-types/commands/RevokeDeviceCommand.d.ts +23 -0
  192. package/dist-types/commands/RevokeHistoryWrapCommand.d.ts +108 -0
  193. package/dist-types/commands/RevokeUserAccessCommand.d.ts +25 -0
  194. package/dist-types/commands/SearchPlacesCommand.d.ts +23 -0
  195. package/dist-types/commands/SendAdminLinkOtpCommand.d.ts +25 -0
  196. package/dist-types/commands/SendHookRequestCommand.d.ts +105 -0
  197. package/dist-types/commands/SetAccountStateCommand.d.ts +27 -0
  198. package/dist-types/commands/SetPreservationHoldCommand.d.ts +27 -0
  199. package/dist-types/commands/SetTierOverrideCommand.d.ts +128 -0
  200. package/dist-types/commands/SimulateScoringPolicyCommand.d.ts +129 -0
  201. package/dist-types/commands/SwipeCommand.d.ts +27 -0
  202. package/dist-types/commands/UnblockUserCommand.d.ts +99 -0
  203. package/dist-types/commands/UnhookCommand.d.ts +29 -0
  204. package/dist-types/commands/UnlinkSocialCommand.d.ts +23 -0
  205. package/dist-types/commands/UpdateChatSettingsCommand.d.ts +25 -0
  206. package/dist-types/commands/UpdateEntitlementsCommand.d.ts +25 -0
  207. package/dist-types/commands/UpdatePhoneNumberCommand.d.ts +23 -0
  208. package/dist-types/commands/UpdatePreferencesCommand.d.ts +76 -8
  209. package/dist-types/commands/UpdateScoringPolicyCommand.d.ts +183 -0
  210. package/dist-types/commands/UpdateTraditionPreferencesCommand.d.ts +23 -0
  211. package/dist-types/commands/UpdateUsernameCommand.d.ts +23 -0
  212. package/dist-types/commands/UpgradeUserCommand.d.ts +44 -0
  213. package/dist-types/commands/UpsertChatProfileCommand.d.ts +110 -0
  214. package/dist-types/commands/UpsertMatchingProfileCommand.d.ts +163 -0
  215. package/dist-types/commands/ValidateInviteCommand.d.ts +23 -0
  216. package/dist-types/commands/VerifyAdminLinkOtpCommand.d.ts +25 -0
  217. package/dist-types/commands/index.d.ts +44 -4
  218. package/dist-types/graphql/types.d.ts +8 -0
  219. package/dist-types/models/models_0.d.ts +3400 -1266
  220. package/dist-types/protocols/Aws_restJson1.d.ts +384 -24
  221. package/dist-types/telemetry/index.d.ts +25 -2
  222. package/package.json +1 -1
  223. package/telemetry/TelemetryCatalog.kt +33 -11
  224. package/telemetry/TelemetryCatalog.swift +50 -11
  225. package/telemetry/telemetry-catalog.json +309 -34
  226. package/dist-es/commands/GetNotificationPreferencesCommand.js +0 -17
  227. package/dist-types/commands/GetNotificationPreferencesCommand.d.ts +0 -91
  228. package/dist-types/commands/GetProfileCommand.d.ts +0 -153
  229. package/dist-types/commands/SwipeByUsernameCommand.d.ts +0 -93
  230. package/dist-types/commands/UpdateProfileCommand.d.ts +0 -142
@@ -0,0 +1,105 @@
1
+ import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
2
+ import { EnableMatchingRequest, 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 EnableMatchingCommand}.
14
+ */
15
+ export interface EnableMatchingCommandInput extends EnableMatchingRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link EnableMatchingCommand}.
21
+ */
22
+ export interface EnableMatchingCommandOutput extends MatchingStatusResponse, __MetadataBearer {
23
+ }
24
+ declare const EnableMatchingCommand_base: {
25
+ new (input: EnableMatchingCommandInput): import("@smithy/smithy-client").CommandImpl<EnableMatchingCommandInput, EnableMatchingCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (...[input]: [] | [EnableMatchingCommandInput]): import("@smithy/smithy-client").CommandImpl<EnableMatchingCommandInput, EnableMatchingCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Turns matching on. Requires a complete matching profile (409 `MATCHING_PROFILE_INCOMPLETE` with the
31
+ * gaps), answers 409 `NOT_READY` while onboarding, and refuses while a previous opt-out is still
32
+ * erasing (409 `MATCHING_ERASING`). Every 409 is `EnableMatchingConflictError`. Idempotent.
33
+ * @example
34
+ * Use a bare-bones client and the command you need to make an API call.
35
+ * ```javascript
36
+ * import { OneHookClient, EnableMatchingCommand } from "onehook-api-client"; // ES Modules import
37
+ * // const { OneHookClient, EnableMatchingCommand } = require("onehook-api-client"); // CommonJS import
38
+ * const client = new OneHookClient(config);
39
+ * const input = {};
40
+ * const command = new EnableMatchingCommand(input);
41
+ * const response = await client.send(command);
42
+ * // { // MatchingStatusResponse
43
+ * // status: "OFF" || "ON" || "ERASING", // required
44
+ * // generation: Number("long"), // required
45
+ * // };
46
+ *
47
+ * ```
48
+ *
49
+ * @param EnableMatchingCommandInput - {@link EnableMatchingCommandInput}
50
+ * @returns {@link EnableMatchingCommandOutput}
51
+ * @see {@link EnableMatchingCommandInput} for command's `input` shape.
52
+ * @see {@link EnableMatchingCommandOutput} for command's `response` shape.
53
+ * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
54
+ *
55
+ * @throws {@link BadRequestError} (client fault)
56
+ * 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
57
+ *
58
+ * @throws {@link EnableMatchingConflictError} (client fault)
59
+ * 409 from `EnableMatching`. Codes: `MATCHING_PROFILE_INCOMPLETE` (with `gaps`), `NOT_READY` (still
60
+ * onboarding), `MATCHING_ERASING` (a previous opt-out is still erasing) and `CONFLICT` (the account
61
+ * changed while the request ran; retry).
62
+ *
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`.
86
+ *
87
+ * @throws {@link OneHookServiceException}
88
+ * <p>Base exception class for all service exceptions from OneHook service.</p>
89
+ *
90
+ *
91
+ * @public
92
+ */
93
+ export declare class EnableMatchingCommand extends EnableMatchingCommand_base {
94
+ /** @internal type navigation helper, not in runtime. */
95
+ protected static __types: {
96
+ api: {
97
+ input: {};
98
+ output: MatchingStatusResponse;
99
+ };
100
+ sdk: {
101
+ input: EnableMatchingCommandInput;
102
+ output: EnableMatchingCommandOutput;
103
+ };
104
+ };
105
+ }
@@ -0,0 +1,125 @@
1
+ import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
2
+ import { EstablishHistoryEpochRequest, EstablishHistoryEpochResponse } 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 EstablishHistoryEpochCommand}.
14
+ */
15
+ export interface EstablishHistoryEpochCommandInput extends EstablishHistoryEpochRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link EstablishHistoryEpochCommand}.
21
+ */
22
+ export interface EstablishHistoryEpochCommandOutput extends EstablishHistoryEpochResponse, __MetadataBearer {
23
+ }
24
+ declare const EstablishHistoryEpochCommand_base: {
25
+ new (input: EstablishHistoryEpochCommandInput): import("@smithy/smithy-client").CommandImpl<EstablishHistoryEpochCommandInput, EstablishHistoryEpochCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: EstablishHistoryEpochCommandInput): import("@smithy/smithy-client").CommandImpl<EstablishHistoryEpochCommandInput, EstablishHistoryEpochCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Records a new epoch with at least one wrap. `epoch` must be `expectedEpoch + 1`. 409 when another
31
+ * device established that epoch first (re-read `GET /chat/history`).
32
+ * @example
33
+ * Use a bare-bones client and the command you need to make an API call.
34
+ * ```javascript
35
+ * import { OneHookClient, EstablishHistoryEpochCommand } from "onehook-api-client"; // ES Modules import
36
+ * // const { OneHookClient, EstablishHistoryEpochCommand } = require("onehook-api-client"); // CommonJS import
37
+ * const client = new OneHookClient(config);
38
+ * const input = { // EstablishHistoryEpochRequest
39
+ * epoch: Number("int"), // required
40
+ * expectedEpoch: Number("int"),
41
+ * keyId: "STRING_VALUE", // required
42
+ * publicKey: "STRING_VALUE", // required
43
+ * horizonAt: Number("long"),
44
+ * wraps: [ // AhkWrapInputList // required
45
+ * { // AhkWrapInput
46
+ * epoch: Number("int"),
47
+ * method: "STRING_VALUE", // required
48
+ * wrapId: "STRING_VALUE", // required
49
+ * wrappedKey: "STRING_VALUE",
50
+ * },
51
+ * ],
52
+ * };
53
+ * const command = new EstablishHistoryEpochCommand(input);
54
+ * const response = await client.send(command);
55
+ * // { // EstablishHistoryEpochResponse
56
+ * // established: true || false, // required
57
+ * // epochs: [ // HistoryEpochList // required
58
+ * // { // HistoryEpoch
59
+ * // epoch: Number("int"), // required
60
+ * // keyId: "STRING_VALUE", // required
61
+ * // publicKey: "STRING_VALUE", // required
62
+ * // createdAt: Number("long"), // required
63
+ * // horizonAt: Number("long"),
64
+ * // },
65
+ * // ],
66
+ * // };
67
+ *
68
+ * ```
69
+ *
70
+ * @param EstablishHistoryEpochCommandInput - {@link EstablishHistoryEpochCommandInput}
71
+ * @returns {@link EstablishHistoryEpochCommandOutput}
72
+ * @see {@link EstablishHistoryEpochCommandInput} for command's `input` shape.
73
+ * @see {@link EstablishHistoryEpochCommandOutput} for command's `response` shape.
74
+ * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
75
+ *
76
+ * @throws {@link BadRequestError} (client fault)
77
+ * 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
78
+ *
79
+ * @throws {@link ForbiddenError} (client fault)
80
+ * 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
81
+ * `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
82
+ *
83
+ * @throws {@link ConflictError} (client fault)
84
+ * 409: the request conflicts with the current state (code `CONFLICT`, or a more specific one such
85
+ * as `NOT_READY` or `MATCHING_ERASING`).
86
+ *
87
+ * @throws {@link InternalServerError} (server fault)
88
+ * 500: an unexpected failure (code `INTERNAL_ERROR`).
89
+ *
90
+ * @throws {@link UnauthorizedError} (client fault)
91
+ * 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
92
+ *
93
+ * @throws {@link TooManyRequestsError} (client fault)
94
+ * 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
95
+ * `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
96
+ * model.
97
+ *
98
+ * @throws {@link BadGatewayError} (server fault)
99
+ * 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
100
+ * (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
101
+ * (`PROPAGATION_FAILED`, retrying the same request is safe).
102
+ *
103
+ * @throws {@link ServiceUnavailableError} (server fault)
104
+ * 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
105
+ * `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
106
+ *
107
+ * @throws {@link OneHookServiceException}
108
+ * <p>Base exception class for all service exceptions from OneHook service.</p>
109
+ *
110
+ *
111
+ * @public
112
+ */
113
+ export declare class EstablishHistoryEpochCommand extends EstablishHistoryEpochCommand_base {
114
+ /** @internal type navigation helper, not in runtime. */
115
+ protected static __types: {
116
+ api: {
117
+ input: EstablishHistoryEpochRequest;
118
+ output: EstablishHistoryEpochResponse;
119
+ };
120
+ sdk: {
121
+ input: EstablishHistoryEpochCommandInput;
122
+ output: EstablishHistoryEpochCommandOutput;
123
+ };
124
+ };
125
+ }
@@ -39,6 +39,7 @@ declare const GenerateDownloadUrlCommand_base: {
39
39
  * const client = new OneHookClient(config);
40
40
  * const input = { // MediaDownloadUrlRequest
41
41
  * key: "STRING_VALUE", // required
42
+ * viewPass: "STRING_VALUE",
42
43
  * };
43
44
  * const command = new GenerateDownloadUrlCommand(input);
44
45
  * const response = await client.send(command);
@@ -56,10 +57,35 @@ declare const GenerateDownloadUrlCommand_base: {
56
57
  * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
57
58
  *
58
59
  * @throws {@link BadRequestError} (client fault)
60
+ * 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
59
61
  *
60
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`).
61
65
  *
62
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`.
63
89
  *
64
90
  * @throws {@link OneHookServiceException}
65
91
  * <p>Base exception class for all service exceptions from OneHook service.</p>
@@ -56,8 +56,31 @@ declare const GenerateInviteCommand_base: {
56
56
  * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
57
57
  *
58
58
  * @throws {@link BadRequestError} (client fault)
59
+ * 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
59
60
  *
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`.
61
84
  *
62
85
  * @throws {@link OneHookServiceException}
63
86
  * <p>Base exception class for all service exceptions from OneHook service.</p>
@@ -27,8 +27,8 @@ declare const GenerateUploadUrlCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * @public
31
- *
30
+ * Presigned S3 POST for one profile photo or video. 409 `MATCHING_ERASING` for purpose MATCHING while an
31
+ * opt-out erases the matching profile.
32
32
  * @example
33
33
  * Use a bare-bones client and the command you need to make an API call.
34
34
  * ```javascript
@@ -38,6 +38,7 @@ declare const GenerateUploadUrlCommand_base: {
38
38
  * const input = { // MediaUploadUrlRequest
39
39
  * contentType: "STRING_VALUE", // required
40
40
  * contentLength: Number("long"), // required
41
+ * purpose: "CHAT" || "MATCHING", // required
41
42
  * };
42
43
  * const command = new GenerateUploadUrlCommand(input);
43
44
  * const response = await client.send(command);
@@ -58,13 +59,41 @@ declare const GenerateUploadUrlCommand_base: {
58
59
  * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
59
60
  *
60
61
  * @throws {@link BadRequestError} (client fault)
62
+ * 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
63
+ *
64
+ * @throws {@link ConflictError} (client fault)
65
+ * 409: the request conflicts with the current state (code `CONFLICT`, or a more specific one such
66
+ * as `NOT_READY` or `MATCHING_ERASING`).
61
67
  *
62
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`.
63
91
  *
64
92
  * @throws {@link OneHookServiceException}
65
93
  * <p>Base exception class for all service exceptions from OneHook service.</p>
66
94
  *
67
95
  *
96
+ * @public
68
97
  */
69
98
  export declare class GenerateUploadUrlCommand extends GenerateUploadUrlCommand_base {
70
99
  /** @internal type navigation helper, not in runtime. */
@@ -57,10 +57,35 @@ declare const GetAccountStateCommand_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>
@@ -62,8 +62,31 @@ declare const GetAdminPhoneStatusCommand_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 InternalServerError} (server fault)
68
+ * 500: an unexpected failure (code `INTERNAL_ERROR`).
69
+ *
70
+ * @throws {@link UnauthorizedError} (client fault)
71
+ * 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
72
+ *
73
+ * @throws {@link ForbiddenError} (client fault)
74
+ * 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
75
+ * `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
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`.
67
90
  *
68
91
  * @throws {@link OneHookServiceException}
69
92
  * <p>Base exception class for all service exceptions from OneHook service.</p>
@@ -92,10 +92,35 @@ declare const GetAiContextMatchCommand_base: {
92
92
  * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
93
93
  *
94
94
  * @throws {@link BadRequestError} (client fault)
95
+ * 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
95
96
  *
96
97
  * @throws {@link NotFoundError} (client fault)
98
+ * 404: the resource does not exist or is not visible to the caller (code `NOT_FOUND`, or a more
99
+ * specific one such as `REQUEST_UNAVAILABLE`).
97
100
  *
98
101
  * @throws {@link InternalServerError} (server fault)
102
+ * 500: an unexpected failure (code `INTERNAL_ERROR`).
103
+ *
104
+ * @throws {@link UnauthorizedError} (client fault)
105
+ * 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
106
+ *
107
+ * @throws {@link ForbiddenError} (client fault)
108
+ * 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
109
+ * `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
110
+ *
111
+ * @throws {@link TooManyRequestsError} (client fault)
112
+ * 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
113
+ * `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
114
+ * model.
115
+ *
116
+ * @throws {@link BadGatewayError} (server fault)
117
+ * 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
118
+ * (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
119
+ * (`PROPAGATION_FAILED`, retrying the same request is safe).
120
+ *
121
+ * @throws {@link ServiceUnavailableError} (server fault)
122
+ * 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
123
+ * `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
99
124
  *
100
125
  * @throws {@link OneHookServiceException}
101
126
  * <p>Base exception class for all service exceptions from OneHook service.</p>
@@ -63,10 +63,35 @@ declare const GetBirthDateStatusCommand_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 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`).
68
71
  *
69
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 ForbiddenError} (client fault)
79
+ * 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
80
+ * `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
81
+ *
82
+ * @throws {@link TooManyRequestsError} (client fault)
83
+ * 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
84
+ * `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
85
+ * model.
86
+ *
87
+ * @throws {@link BadGatewayError} (server fault)
88
+ * 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
89
+ * (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
90
+ * (`PROPAGATION_FAILED`, retrying the same request is safe).
91
+ *
92
+ * @throws {@link ServiceUnavailableError} (server fault)
93
+ * 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
94
+ * `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
70
95
  *
71
96
  * @throws {@link OneHookServiceException}
72
97
  * <p>Base exception class for all service exceptions from OneHook service.</p>
@@ -0,0 +1,123 @@
1
+ import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
2
+ import { ChatProfile, GetOtherProfileRequest } 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 GetChatProfileCommand}.
14
+ */
15
+ export interface GetChatProfileCommandInput extends GetOtherProfileRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetChatProfileCommand}.
21
+ */
22
+ export interface GetChatProfileCommandOutput extends ChatProfile, __MetadataBearer {
23
+ }
24
+ declare const GetChatProfileCommand_base: {
25
+ new (input: GetChatProfileCommandInput): import("@smithy/smithy-client").CommandImpl<GetChatProfileCommandInput, GetChatProfileCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: GetChatProfileCommandInput): import("@smithy/smithy-client").CommandImpl<GetChatProfileCommandInput, GetChatProfileCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Another member's chat profile. Requires an `X-View-Pass` from State (`aud` profile.chat) naming
31
+ * this member; it covers hook partners and the senders of unlocked incoming requests. Without a
32
+ * valid pass the answer is the same 404 as for an unknown member.
33
+ * @example
34
+ * Use a bare-bones client and the command you need to make an API call.
35
+ * ```javascript
36
+ * import { OneHookClient, GetChatProfileCommand } from "onehook-api-client"; // ES Modules import
37
+ * // const { OneHookClient, GetChatProfileCommand } = require("onehook-api-client"); // CommonJS import
38
+ * const client = new OneHookClient(config);
39
+ * const input = { // GetOtherProfileRequest
40
+ * userId: "STRING_VALUE", // required
41
+ * viewPass: "STRING_VALUE",
42
+ * };
43
+ * const command = new GetChatProfileCommand(input);
44
+ * const response = await client.send(command);
45
+ * // { // ChatProfile
46
+ * // userId: "STRING_VALUE", // required
47
+ * // displayName: "STRING_VALUE",
48
+ * // avatarKey: "STRING_VALUE",
49
+ * // age: Number("int"),
50
+ * // birthDetails: { // BirthDetails
51
+ * // date: "STRING_VALUE",
52
+ * // time: "STRING_VALUE",
53
+ * // timeZone: "STRING_VALUE",
54
+ * // latitude: Number("double"),
55
+ * // longitude: Number("double"),
56
+ * // placeName: "STRING_VALUE",
57
+ * // provisional: true || false,
58
+ * // },
59
+ * // birthDateOnFile: true || false,
60
+ * // moderationStatus: "STRING_VALUE",
61
+ * // fieldModerationStatus: { // StringMap
62
+ * // "<keys>": "STRING_VALUE",
63
+ * // },
64
+ * // };
65
+ *
66
+ * ```
67
+ *
68
+ * @param GetChatProfileCommandInput - {@link GetChatProfileCommandInput}
69
+ * @returns {@link GetChatProfileCommandOutput}
70
+ * @see {@link GetChatProfileCommandInput} for command's `input` shape.
71
+ * @see {@link GetChatProfileCommandOutput} for command's `response` shape.
72
+ * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
73
+ *
74
+ * @throws {@link BadRequestError} (client fault)
75
+ * 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
76
+ *
77
+ * @throws {@link NotFoundError} (client fault)
78
+ * 404: the resource does not exist or is not visible to the caller (code `NOT_FOUND`, or a more
79
+ * specific one such as `REQUEST_UNAVAILABLE`).
80
+ *
81
+ * @throws {@link InternalServerError} (server fault)
82
+ * 500: an unexpected failure (code `INTERNAL_ERROR`).
83
+ *
84
+ * @throws {@link UnauthorizedError} (client fault)
85
+ * 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
86
+ *
87
+ * @throws {@link ForbiddenError} (client fault)
88
+ * 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
89
+ * `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
90
+ *
91
+ * @throws {@link TooManyRequestsError} (client fault)
92
+ * 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
93
+ * `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
94
+ * model.
95
+ *
96
+ * @throws {@link BadGatewayError} (server fault)
97
+ * 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
98
+ * (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
99
+ * (`PROPAGATION_FAILED`, retrying the same request is safe).
100
+ *
101
+ * @throws {@link ServiceUnavailableError} (server fault)
102
+ * 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
103
+ * `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
104
+ *
105
+ * @throws {@link OneHookServiceException}
106
+ * <p>Base exception class for all service exceptions from OneHook service.</p>
107
+ *
108
+ *
109
+ * @public
110
+ */
111
+ export declare class GetChatProfileCommand extends GetChatProfileCommand_base {
112
+ /** @internal type navigation helper, not in runtime. */
113
+ protected static __types: {
114
+ api: {
115
+ input: GetOtherProfileRequest;
116
+ output: ChatProfile;
117
+ };
118
+ sdk: {
119
+ input: GetChatProfileCommandInput;
120
+ output: GetChatProfileCommandOutput;
121
+ };
122
+ };
123
+ }