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
@@ -1,5 +1,5 @@
1
1
  import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
2
- import { ProfileResponse } from "../models/models_0";
2
+ import { MyProfileResponse } from "../models/models_0";
3
3
  import { Command as $Command } from "@smithy/smithy-client";
4
4
  import { MetadataBearer as __MetadataBearer } from "@smithy/types";
5
5
  /**
@@ -19,7 +19,7 @@ export interface GetMyProfileCommandInput {
19
19
  *
20
20
  * The output of {@link GetMyProfileCommand}.
21
21
  */
22
- export interface GetMyProfileCommandOutput extends ProfileResponse, __MetadataBearer {
22
+ export interface GetMyProfileCommandOutput extends MyProfileResponse, __MetadataBearer {
23
23
  }
24
24
  declare const GetMyProfileCommand_base: {
25
25
  new (input: GetMyProfileCommandInput): import("@smithy/smithy-client").CommandImpl<GetMyProfileCommandInput, GetMyProfileCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
@@ -27,9 +27,8 @@ declare const GetMyProfileCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * Fetches the authenticated caller's own profile. The userId is taken from the verified Cognito
31
- * token, so no path parameter is required. Unlike GetProfile, the owner always sees their own
32
- * content (media and text are never withheld from the owner while moderation is pending).
30
+ * The caller's own profile: the chat profile every account has, and the matching profile when one
31
+ * exists (DRAFT or ACTIVE). The owner always sees their own content, even while moderation is pending.
33
32
  * @example
34
33
  * Use a bare-bones client and the command you need to make an API call.
35
34
  * ```javascript
@@ -39,83 +38,99 @@ declare const GetMyProfileCommand_base: {
39
38
  * const input = {};
40
39
  * const command = new GetMyProfileCommand(input);
41
40
  * const response = await client.send(command);
42
- * // { // ProfileResponse
43
- * // userId: "STRING_VALUE", // required
44
- * // displayName: "STRING_VALUE",
45
- * // bio: "STRING_VALUE",
46
- * // age: Number("int"),
47
- * // gender: "STRING_VALUE",
48
- * // interestedIn: [ // StringList
49
- * // "STRING_VALUE",
50
- * // ],
51
- * // relationshipType: "STRING_VALUE",
52
- * // wantsKids: "STRING_VALUE",
53
- * // familyPlans: "STRING_VALUE",
54
- * // smokingStatus: "STRING_VALUE",
55
- * // drinkingStatus: "STRING_VALUE",
56
- * // cannabisStatus: "STRING_VALUE",
57
- * // drugsStatus: "STRING_VALUE",
58
- * // religion: "STRING_VALUE",
59
- * // interests: [
60
- * // "STRING_VALUE",
61
- * // ],
62
- * // starSign: "STRING_VALUE",
63
- * // verified: true || false,
64
- * // subscriptionTier: "MUST" || "SUPER" || "INFINITY",
65
- * // pictures: [
66
- * // "STRING_VALUE",
67
- * // ],
68
- * // pictureTransforms: { // StringMap
69
- * // "<keys>": "STRING_VALUE",
70
- * // },
71
- * // videos: [
72
- * // "STRING_VALUE",
73
- * // ],
74
- * // audioPrompt: "STRING_VALUE",
75
- * // moderationStatus: "STRING_VALUE",
76
- * // fieldModerationStatus: {
77
- * // "<keys>": "STRING_VALUE",
78
- * // },
79
- * // causes: [
80
- * // "STRING_VALUE",
81
- * // ],
82
- * // communities: "<StringList>",
83
- * // qualities: "<StringList>",
84
- * // prompts: [ // ProfilePromptList
85
- * // { // ProfilePrompt
86
- * // promptId: "STRING_VALUE", // required
87
- * // answer: "STRING_VALUE", // required
88
- * // imageKey: "STRING_VALUE",
41
+ * // { // MyProfileResponse
42
+ * // chat: { // ChatProfile
43
+ * // userId: "STRING_VALUE", // required
44
+ * // displayName: "STRING_VALUE",
45
+ * // avatarKey: "STRING_VALUE",
46
+ * // age: Number("int"),
47
+ * // birthDetails: { // BirthDetails
48
+ * // date: "STRING_VALUE",
49
+ * // time: "STRING_VALUE",
50
+ * // timeZone: "STRING_VALUE",
51
+ * // latitude: Number("double"),
52
+ * // longitude: Number("double"),
53
+ * // placeName: "STRING_VALUE",
54
+ * // provisional: true || false,
55
+ * // },
56
+ * // birthDateOnFile: true || false,
57
+ * // moderationStatus: "STRING_VALUE",
58
+ * // fieldModerationStatus: { // StringMap
59
+ * // "<keys>": "STRING_VALUE",
89
60
  * // },
90
- * // ],
91
- * // socialLinks: {
92
- * // "<keys>": "STRING_VALUE",
93
61
  * // },
94
- * // openers: [ // OpenerList
95
- * // { // Opener
96
- * // text: "STRING_VALUE", // required
97
- * // imageKey: "STRING_VALUE",
62
+ * // matching: { // MatchingProfile
63
+ * // userId: "STRING_VALUE", // required
64
+ * // status: "DRAFT" || "ACTIVE",
65
+ * // generation: Number("long"),
66
+ * // lastEditedAt: Number("long"),
67
+ * // draftExpiresAt: Number("long"),
68
+ * // displayName: "STRING_VALUE",
69
+ * // bio: "STRING_VALUE",
70
+ * // age: Number("int"),
71
+ * // gender: "STRING_VALUE",
72
+ * // interestedIn: [ // StringList
73
+ * // "STRING_VALUE",
74
+ * // ],
75
+ * // relationshipType: "STRING_VALUE",
76
+ * // wantsKids: "STRING_VALUE",
77
+ * // familyPlans: "STRING_VALUE",
78
+ * // smokingStatus: "STRING_VALUE",
79
+ * // drinkingStatus: "STRING_VALUE",
80
+ * // cannabisStatus: "STRING_VALUE",
81
+ * // drugsStatus: "STRING_VALUE",
82
+ * // religion: "STRING_VALUE",
83
+ * // interests: [
84
+ * // "STRING_VALUE",
85
+ * // ],
86
+ * // starSign: "STRING_VALUE",
87
+ * // verified: true || false,
88
+ * // subscriptionTier: "MUST" || "SUPER" || "INFINITY",
89
+ * // pictures: [
90
+ * // "STRING_VALUE",
91
+ * // ],
92
+ * // pictureTransforms: {
93
+ * // "<keys>": "STRING_VALUE",
94
+ * // },
95
+ * // videos: [
96
+ * // "STRING_VALUE",
97
+ * // ],
98
+ * // audioPrompt: "STRING_VALUE",
99
+ * // moderationStatus: "STRING_VALUE",
100
+ * // fieldModerationStatus: {
101
+ * // "<keys>": "STRING_VALUE",
102
+ * // },
103
+ * // causes: [
104
+ * // "STRING_VALUE",
105
+ * // ],
106
+ * // communities: "<StringList>",
107
+ * // qualities: "<StringList>",
108
+ * // prompts: [ // ProfilePromptList
109
+ * // { // ProfilePrompt
110
+ * // promptId: "STRING_VALUE", // required
111
+ * // answer: "STRING_VALUE", // required
112
+ * // imageKey: "STRING_VALUE",
113
+ * // },
114
+ * // ],
115
+ * // socialLinks: {
116
+ * // "<keys>": "STRING_VALUE",
98
117
  * // },
99
- * // ],
100
- * // work: "STRING_VALUE",
101
- * // education: "STRING_VALUE",
102
- * // hometown: "STRING_VALUE",
103
- * // currentLocation: "STRING_VALUE",
104
- * // height: Number("int"),
105
- * // exercise: "STRING_VALUE",
106
- * // educationLevel: "STRING_VALUE",
107
- * // politicalView: "STRING_VALUE",
108
- * // languages: "<StringList>",
109
- * // birthDetails: { // BirthDetails
110
- * // date: "STRING_VALUE",
111
- * // time: "STRING_VALUE",
112
- * // timeZone: "STRING_VALUE",
113
- * // latitude: Number("double"),
114
- * // longitude: Number("double"),
115
- * // placeName: "STRING_VALUE",
116
- * // provisional: true || false,
118
+ * // openers: [ // OpenerList
119
+ * // { // Opener
120
+ * // text: "STRING_VALUE", // required
121
+ * // imageKey: "STRING_VALUE",
122
+ * // },
123
+ * // ],
124
+ * // work: "STRING_VALUE",
125
+ * // education: "STRING_VALUE",
126
+ * // hometown: "STRING_VALUE",
127
+ * // currentLocation: "STRING_VALUE",
128
+ * // height: Number("int"),
129
+ * // exercise: "STRING_VALUE",
130
+ * // educationLevel: "STRING_VALUE",
131
+ * // politicalView: "STRING_VALUE",
132
+ * // languages: "<StringList>",
117
133
  * // },
118
- * // birthDateOnFile: true || false,
119
134
  * // };
120
135
  *
121
136
  * ```
@@ -127,10 +142,35 @@ declare const GetMyProfileCommand_base: {
127
142
  * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
128
143
  *
129
144
  * @throws {@link BadRequestError} (client fault)
145
+ * 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
130
146
  *
131
147
  * @throws {@link NotFoundError} (client fault)
148
+ * 404: the resource does not exist or is not visible to the caller (code `NOT_FOUND`, or a more
149
+ * specific one such as `REQUEST_UNAVAILABLE`).
132
150
  *
133
151
  * @throws {@link InternalServerError} (server fault)
152
+ * 500: an unexpected failure (code `INTERNAL_ERROR`).
153
+ *
154
+ * @throws {@link UnauthorizedError} (client fault)
155
+ * 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
156
+ *
157
+ * @throws {@link ForbiddenError} (client fault)
158
+ * 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
159
+ * `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
160
+ *
161
+ * @throws {@link TooManyRequestsError} (client fault)
162
+ * 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
163
+ * `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
164
+ * model.
165
+ *
166
+ * @throws {@link BadGatewayError} (server fault)
167
+ * 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
168
+ * (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
169
+ * (`PROPAGATION_FAILED`, retrying the same request is safe).
170
+ *
171
+ * @throws {@link ServiceUnavailableError} (server fault)
172
+ * 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
173
+ * `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
134
174
  *
135
175
  * @throws {@link OneHookServiceException}
136
176
  * <p>Base exception class for all service exceptions from OneHook service.</p>
@@ -143,7 +183,7 @@ export declare class GetMyProfileCommand extends GetMyProfileCommand_base {
143
183
  protected static __types: {
144
184
  api: {
145
185
  input: {};
146
- output: ProfileResponse;
186
+ output: MyProfileResponse;
147
187
  };
148
188
  sdk: {
149
189
  input: GetMyProfileCommandInput;
@@ -70,12 +70,35 @@ declare const GetParticipantRegistryCommand_base: {
70
70
  * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
71
71
  *
72
72
  * @throws {@link BadRequestError} (client fault)
73
+ * 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
73
74
  *
74
75
  * @throws {@link ForbiddenError} (client fault)
76
+ * 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
77
+ * `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
75
78
  *
76
79
  * @throws {@link NotFoundError} (client fault)
80
+ * 404: the resource does not exist or is not visible to the caller (code `NOT_FOUND`, or a more
81
+ * specific one such as `REQUEST_UNAVAILABLE`).
77
82
  *
78
83
  * @throws {@link InternalServerError} (server fault)
84
+ * 500: an unexpected failure (code `INTERNAL_ERROR`).
85
+ *
86
+ * @throws {@link UnauthorizedError} (client fault)
87
+ * 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
88
+ *
89
+ * @throws {@link TooManyRequestsError} (client fault)
90
+ * 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
91
+ * `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
92
+ * model.
93
+ *
94
+ * @throws {@link BadGatewayError} (server fault)
95
+ * 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
96
+ * (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
97
+ * (`PROPAGATION_FAILED`, retrying the same request is safe).
98
+ *
99
+ * @throws {@link ServiceUnavailableError} (server fault)
100
+ * 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
101
+ * `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
79
102
  *
80
103
  * @throws {@link OneHookServiceException}
81
104
  * <p>Base exception class for all service exceptions from OneHook service.</p>
@@ -0,0 +1,102 @@
1
+ import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
2
+ import { GetPartnerDistanceRequest, PartnerDistance } 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 GetPartnerDistanceCommand}.
14
+ */
15
+ export interface GetPartnerDistanceCommandInput extends GetPartnerDistanceRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetPartnerDistanceCommand}.
21
+ */
22
+ export interface GetPartnerDistanceCommandOutput extends PartnerDistance, __MetadataBearer {
23
+ }
24
+ declare const GetPartnerDistanceCommand_base: {
25
+ new (input: GetPartnerDistanceCommandInput): import("@smithy/smithy-client").CommandImpl<GetPartnerDistanceCommandInput, GetPartnerDistanceCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: GetPartnerDistanceCommandInput): import("@smithy/smithy-client").CommandImpl<GetPartnerDistanceCommandInput, GetPartnerDistanceCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * How far away a conversation partner is right now, privacy-coarsened: rounded to the nearest km and
31
+ * floored at 1 km, never coordinates. `available` is false (and `distanceKm` absent) whenever either
32
+ * member has no indexed location or the pair is blocked either way. Never fails on a missing location.
33
+ * @example
34
+ * Use a bare-bones client and the command you need to make an API call.
35
+ * ```javascript
36
+ * import { OneHookClient, GetPartnerDistanceCommand } from "onehook-api-client"; // ES Modules import
37
+ * // const { OneHookClient, GetPartnerDistanceCommand } = require("onehook-api-client"); // CommonJS import
38
+ * const client = new OneHookClient(config);
39
+ * const input = { // GetPartnerDistanceRequest
40
+ * userId: "STRING_VALUE", // required
41
+ * };
42
+ * const command = new GetPartnerDistanceCommand(input);
43
+ * const response = await client.send(command);
44
+ * // { // PartnerDistance
45
+ * // distanceKm: Number("double"),
46
+ * // available: true || false, // required
47
+ * // };
48
+ *
49
+ * ```
50
+ *
51
+ * @param GetPartnerDistanceCommandInput - {@link GetPartnerDistanceCommandInput}
52
+ * @returns {@link GetPartnerDistanceCommandOutput}
53
+ * @see {@link GetPartnerDistanceCommandInput} for command's `input` shape.
54
+ * @see {@link GetPartnerDistanceCommandOutput} 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 InternalServerError} (server fault)
61
+ * 500: an unexpected failure (code `INTERNAL_ERROR`).
62
+ *
63
+ * @throws {@link UnauthorizedError} (client fault)
64
+ * 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
65
+ *
66
+ * @throws {@link ForbiddenError} (client fault)
67
+ * 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
68
+ * `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
69
+ *
70
+ * @throws {@link TooManyRequestsError} (client fault)
71
+ * 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
72
+ * `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
73
+ * model.
74
+ *
75
+ * @throws {@link BadGatewayError} (server fault)
76
+ * 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
77
+ * (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
78
+ * (`PROPAGATION_FAILED`, retrying the same request is safe).
79
+ *
80
+ * @throws {@link ServiceUnavailableError} (server fault)
81
+ * 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
82
+ * `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
83
+ *
84
+ * @throws {@link OneHookServiceException}
85
+ * <p>Base exception class for all service exceptions from OneHook service.</p>
86
+ *
87
+ *
88
+ * @public
89
+ */
90
+ export declare class GetPartnerDistanceCommand extends GetPartnerDistanceCommand_base {
91
+ /** @internal type navigation helper, not in runtime. */
92
+ protected static __types: {
93
+ api: {
94
+ input: GetPartnerDistanceRequest;
95
+ output: PartnerDistance;
96
+ };
97
+ sdk: {
98
+ input: GetPartnerDistanceCommandInput;
99
+ output: GetPartnerDistanceCommandOutput;
100
+ };
101
+ };
102
+ }
@@ -58,10 +58,35 @@ declare const GetPlaceCommand_base: {
58
58
  * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
59
59
  *
60
60
  * @throws {@link BadRequestError} (client fault)
61
+ * 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
61
62
  *
62
63
  * @throws {@link NotFoundError} (client fault)
64
+ * 404: the resource does not exist or is not visible to the caller (code `NOT_FOUND`, or a more
65
+ * specific one such as `REQUEST_UNAVAILABLE`).
63
66
  *
64
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`.
65
90
  *
66
91
  * @throws {@link OneHookServiceException}
67
92
  * <p>Base exception class for all service exceptions from OneHook service.</p>
@@ -83,12 +83,11 @@ declare const GetPreferencesCommand_base: {
83
83
  * // requireBio: true || false,
84
84
  * // requireRecentlyActive: true || false,
85
85
  * // recentlyActiveDays: Number("int"),
86
+ * // implicitPreferences: "<StringList>",
86
87
  * // discoverable: true || false,
87
88
  * // incognito: true || false,
89
+ * // hidePastHooks: true || false,
88
90
  * // distanceUnit: "STRING_VALUE",
89
- * // notifyMatches: true || false,
90
- * // notifyLikes: true || false,
91
- * // notifyDailyPicks: true || false,
92
91
  * // };
93
92
  *
94
93
  * ```
@@ -100,10 +99,35 @@ declare const GetPreferencesCommand_base: {
100
99
  * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
101
100
  *
102
101
  * @throws {@link BadRequestError} (client fault)
102
+ * 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
103
103
  *
104
104
  * @throws {@link NotFoundError} (client fault)
105
+ * 404: the resource does not exist or is not visible to the caller (code `NOT_FOUND`, or a more
106
+ * specific one such as `REQUEST_UNAVAILABLE`).
105
107
  *
106
108
  * @throws {@link InternalServerError} (server fault)
109
+ * 500: an unexpected failure (code `INTERNAL_ERROR`).
110
+ *
111
+ * @throws {@link UnauthorizedError} (client fault)
112
+ * 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
113
+ *
114
+ * @throws {@link ForbiddenError} (client fault)
115
+ * 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
116
+ * `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
117
+ *
118
+ * @throws {@link TooManyRequestsError} (client fault)
119
+ * 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
120
+ * `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
121
+ * model.
122
+ *
123
+ * @throws {@link BadGatewayError} (server fault)
124
+ * 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
125
+ * (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
126
+ * (`PROPAGATION_FAILED`, retrying the same request is safe).
127
+ *
128
+ * @throws {@link ServiceUnavailableError} (server fault)
129
+ * 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
130
+ * `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
107
131
  *
108
132
  * @throws {@link OneHookServiceException}
109
133
  * <p>Base exception class for all service exceptions from OneHook service.</p>
@@ -61,10 +61,35 @@ declare const GetPreservationHoldCommand_base: {
61
61
  * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
62
62
  *
63
63
  * @throws {@link BadRequestError} (client fault)
64
+ * 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
64
65
  *
65
66
  * @throws {@link NotFoundError} (client fault)
67
+ * 404: the resource does not exist or is not visible to the caller (code `NOT_FOUND`, or a more
68
+ * specific one such as `REQUEST_UNAVAILABLE`).
66
69
  *
67
70
  * @throws {@link InternalServerError} (server fault)
71
+ * 500: an unexpected failure (code `INTERNAL_ERROR`).
72
+ *
73
+ * @throws {@link UnauthorizedError} (client fault)
74
+ * 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
75
+ *
76
+ * @throws {@link ForbiddenError} (client fault)
77
+ * 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
78
+ * `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
79
+ *
80
+ * @throws {@link TooManyRequestsError} (client fault)
81
+ * 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
82
+ * `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
83
+ * model.
84
+ *
85
+ * @throws {@link BadGatewayError} (server fault)
86
+ * 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
87
+ * (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
88
+ * (`PROPAGATION_FAILED`, retrying the same request is safe).
89
+ *
90
+ * @throws {@link ServiceUnavailableError} (server fault)
91
+ * 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
92
+ * `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
68
93
  *
69
94
  * @throws {@link OneHookServiceException}
70
95
  * <p>Base exception class for all service exceptions from OneHook service.</p>
@@ -53,6 +53,7 @@ declare const GetReceivedLikesCommand_base: {
53
53
  * // createdAt: "STRING_VALUE", // required
54
54
  * // },
55
55
  * // ],
56
+ * // viewPass: "STRING_VALUE",
56
57
  * // count: Number("int"), // required
57
58
  * // };
58
59
  *
@@ -65,8 +66,31 @@ declare const GetReceivedLikesCommand_base: {
65
66
  * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
66
67
  *
67
68
  * @throws {@link BadRequestError} (client fault)
69
+ * 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
68
70
  *
69
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`.
70
94
  *
71
95
  * @throws {@link OneHookServiceException}
72
96
  * <p>Base exception class for all service exceptions from OneHook service.</p>
@@ -59,10 +59,35 @@ declare const GetRosesCommand_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 NotFoundError} (client fault)
65
+ * 404: the resource does not exist or is not visible to the caller (code `NOT_FOUND`, or a more
66
+ * specific one such as `REQUEST_UNAVAILABLE`).
64
67
  *
65
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`.
66
91
  *
67
92
  * @throws {@link OneHookServiceException}
68
93
  * <p>Base exception class for all service exceptions from OneHook service.</p>