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
@@ -0,0 +1,143 @@
1
+ import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
2
+ import { GetScoringPolicyResponse } 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 GetScoringPolicyCommand}.
14
+ */
15
+ export interface GetScoringPolicyCommandInput {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetScoringPolicyCommand}.
21
+ */
22
+ export interface GetScoringPolicyCommandOutput extends GetScoringPolicyResponse, __MetadataBearer {
23
+ }
24
+ declare const GetScoringPolicyCommand_base: {
25
+ new (input: GetScoringPolicyCommandInput): import("@smithy/smithy-client").CommandImpl<GetScoringPolicyCommandInput, GetScoringPolicyCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (...[input]: [] | [GetScoringPolicyCommandInput]): import("@smithy/smithy-client").CommandImpl<GetScoringPolicyCommandInput, GetScoringPolicyCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * The scoring policy in force, and what each documented parameter means.
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { OneHookClient, GetScoringPolicyCommand } from "onehook-api-client"; // ES Modules import
35
+ * // const { OneHookClient, GetScoringPolicyCommand } = require("onehook-api-client"); // CommonJS import
36
+ * const client = new OneHookClient(config);
37
+ * const input = {};
38
+ * const command = new GetScoringPolicyCommand(input);
39
+ * const response = await client.send(command);
40
+ * // { // GetScoringPolicyResponse
41
+ * // policy: { // ScoringPolicyConfig
42
+ * // version: "STRING_VALUE",
43
+ * // expectedVersion: "STRING_VALUE",
44
+ * // updatedAt: Number("long"),
45
+ * // updatedBy: "STRING_VALUE",
46
+ * // changeReason: "STRING_VALUE",
47
+ * // parameters: { // ScoringParameters
48
+ * // profileViewTimeWeight: Number("double"),
49
+ * // profileViewPhotoWeight: Number("double"),
50
+ * // profileViewBioWeight: Number("double"),
51
+ * // profileViewPromptsWeight: Number("double"),
52
+ * // swipeLikeBaseWeight: Number("double"),
53
+ * // swipeLikeDeliberationWeight: Number("double"),
54
+ * // swipeDeliberationCapMs: Number("int"),
55
+ * // superLikeWeight: Number("double"),
56
+ * // passWeight: Number("double"),
57
+ * // chatReplyFastWeight: Number("double"),
58
+ * // chatInitiativeWeight: Number("double"),
59
+ * // exposureDeficitBoost: Number("double"),
60
+ * // reciprocalMatchWeight: Number("double"),
61
+ * // primeTimeBoostMax: Number("double"),
62
+ * // dwellTimeBoostMax: Number("double"),
63
+ * // },
64
+ * // activeExperiment: { // ABExperiment
65
+ * // experimentId: "STRING_VALUE", // required
66
+ * // name: "STRING_VALUE", // required
67
+ * // description: "STRING_VALUE", // required
68
+ * // enabled: true || false,
69
+ * // trafficAllocation: { // TrafficAllocation
70
+ * // "<keys>": Number("int"),
71
+ * // },
72
+ * // variants: { // VariantOverrides
73
+ * // "<keys>": { // ParameterOverrides
74
+ * // "<keys>": Number("double"),
75
+ * // },
76
+ * // },
77
+ * // },
78
+ * // },
79
+ * // metadata: { // ParameterMetadataMap // required
80
+ * // "<keys>": { // ParameterMetadata
81
+ * // name: "STRING_VALUE", // required
82
+ * // description: "STRING_VALUE", // required
83
+ * // hypothesis: "STRING_VALUE", // required
84
+ * // tuningGuidance: "STRING_VALUE", // required
85
+ * // unit: "STRING_VALUE", // required
86
+ * // minValue: Number("double"), // required
87
+ * // maxValue: Number("double"), // required
88
+ * // defaultValue: Number("double"), // required
89
+ * // },
90
+ * // },
91
+ * // };
92
+ *
93
+ * ```
94
+ *
95
+ * @param GetScoringPolicyCommandInput - {@link GetScoringPolicyCommandInput}
96
+ * @returns {@link GetScoringPolicyCommandOutput}
97
+ * @see {@link GetScoringPolicyCommandInput} for command's `input` shape.
98
+ * @see {@link GetScoringPolicyCommandOutput} for command's `response` shape.
99
+ * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
100
+ *
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`.
124
+ *
125
+ * @throws {@link OneHookServiceException}
126
+ * <p>Base exception class for all service exceptions from OneHook service.</p>
127
+ *
128
+ *
129
+ * @public
130
+ */
131
+ export declare class GetScoringPolicyCommand extends GetScoringPolicyCommand_base {
132
+ /** @internal type navigation helper, not in runtime. */
133
+ protected static __types: {
134
+ api: {
135
+ input: {};
136
+ output: GetScoringPolicyResponse;
137
+ };
138
+ sdk: {
139
+ input: GetScoringPolicyCommandInput;
140
+ output: GetScoringPolicyCommandOutput;
141
+ };
142
+ };
143
+ }
@@ -48,6 +48,25 @@ declare const GetStateCommand_base: {
48
48
  * // "STRING_VALUE",
49
49
  * // ],
50
50
  * // subscriptionTier: "MUST" || "SUPER" || "INFINITY", // required
51
+ * // hooks: [ // HookSummaryList
52
+ * // { // HookSummary
53
+ * // matchId: "STRING_VALUE", // required
54
+ * // peerId: "STRING_VALUE", // required
55
+ * // origin: "DISCOVERY" || "REQUEST", // required
56
+ * // hookedAt: Number("long"), // required
57
+ * // suspended: true || false,
58
+ * // },
59
+ * // ],
60
+ * // effectiveCapacity: Number("int"),
61
+ * // discoveryPaused: true || false,
62
+ * // matching: { // MatchingStatus
63
+ * // status: "OFF" || "ON" || "ERASING", // required
64
+ * // generation: Number("long"), // required
65
+ * // },
66
+ * // selectionRequired: true || false,
67
+ * // keepLimit: Number("int"),
68
+ * // selectionDeadline: Number("long"),
69
+ * // chatViewPass: "STRING_VALUE",
51
70
  * // };
52
71
  *
53
72
  * ```
@@ -59,10 +78,35 @@ declare const GetStateCommand_base: {
59
78
  * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
60
79
  *
61
80
  * @throws {@link BadRequestError} (client fault)
81
+ * 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
62
82
  *
63
83
  * @throws {@link NotFoundError} (client fault)
84
+ * 404: the resource does not exist or is not visible to the caller (code `NOT_FOUND`, or a more
85
+ * specific one such as `REQUEST_UNAVAILABLE`).
64
86
  *
65
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 ForbiddenError} (client fault)
94
+ * 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
95
+ * `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
96
+ *
97
+ * @throws {@link TooManyRequestsError} (client fault)
98
+ * 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
99
+ * `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
100
+ * model.
101
+ *
102
+ * @throws {@link BadGatewayError} (server fault)
103
+ * 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
104
+ * (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
105
+ * (`PROPAGATION_FAILED`, retrying the same request is safe).
106
+ *
107
+ * @throws {@link ServiceUnavailableError} (server fault)
108
+ * 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
109
+ * `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
66
110
  *
67
111
  * @throws {@link OneHookServiceException}
68
112
  * <p>Base exception class for all service exceptions from OneHook service.</p>
@@ -60,8 +60,31 @@ declare const GetSuggestionsCommand_base: {
60
60
  * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
61
61
  *
62
62
  * @throws {@link BadRequestError} (client fault)
63
+ * 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
63
64
  *
64
65
  * @throws {@link InternalServerError} (server fault)
66
+ * 500: an unexpected failure (code `INTERNAL_ERROR`).
67
+ *
68
+ * @throws {@link UnauthorizedError} (client fault)
69
+ * 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
70
+ *
71
+ * @throws {@link ForbiddenError} (client fault)
72
+ * 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
73
+ * `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
74
+ *
75
+ * @throws {@link TooManyRequestsError} (client fault)
76
+ * 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
77
+ * `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
78
+ * model.
79
+ *
80
+ * @throws {@link BadGatewayError} (server fault)
81
+ * 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
82
+ * (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
83
+ * (`PROPAGATION_FAILED`, retrying the same request is safe).
84
+ *
85
+ * @throws {@link ServiceUnavailableError} (server fault)
86
+ * 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
87
+ * `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
65
88
  *
66
89
  * @throws {@link OneHookServiceException}
67
90
  * <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 { TargetUserRequest, TierOverride } 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 GetTierOverrideCommand}.
14
+ */
15
+ export interface GetTierOverrideCommandInput extends TargetUserRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link GetTierOverrideCommand}.
21
+ */
22
+ export interface GetTierOverrideCommandOutput extends TierOverride, __MetadataBearer {
23
+ }
24
+ declare const GetTierOverrideCommand_base: {
25
+ new (input: GetTierOverrideCommandInput): import("@smithy/smithy-client").CommandImpl<GetTierOverrideCommandInput, GetTierOverrideCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (__0_0: GetTierOverrideCommandInput): import("@smithy/smithy-client").CommandImpl<GetTierOverrideCommandInput, GetTierOverrideCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * The member's billing tier, any free tier override and its history. 404 when State has no record.
31
+ * @example
32
+ * Use a bare-bones client and the command you need to make an API call.
33
+ * ```javascript
34
+ * import { OneHookClient, GetTierOverrideCommand } from "onehook-api-client"; // ES Modules import
35
+ * // const { OneHookClient, GetTierOverrideCommand } = require("onehook-api-client"); // CommonJS import
36
+ * const client = new OneHookClient(config);
37
+ * const input = { // TargetUserRequest
38
+ * targetUserId: "STRING_VALUE", // required
39
+ * };
40
+ * const command = new GetTierOverrideCommand(input);
41
+ * const response = await client.send(command);
42
+ * // { // TierOverride
43
+ * // userId: "STRING_VALUE", // required
44
+ * // billingTier: "MUST" || "SUPER" || "INFINITY", // required
45
+ * // effectiveTier: "MUST" || "SUPER" || "INFINITY", // required
46
+ * // overrideActive: true || false, // required
47
+ * // overrideTier: "MUST" || "SUPER" || "INFINITY",
48
+ * // overrideExpiresAt: Number("long"),
49
+ * // overrideReason: "STRING_VALUE",
50
+ * // overrideSetBy: "STRING_VALUE",
51
+ * // overrideSetAt: Number("long"),
52
+ * // maxConnections: Number("int"), // required
53
+ * // overrideHistory: [ // OverrideHistoryList // required
54
+ * // { // OverrideHistoryEntry
55
+ * // action: "STRING_VALUE",
56
+ * // tier: "MUST" || "SUPER" || "INFINITY",
57
+ * // expiresAt: Number("long"),
58
+ * // reason: "STRING_VALUE",
59
+ * // by: "STRING_VALUE",
60
+ * // source: "STRING_VALUE",
61
+ * // at: Number("long"),
62
+ * // },
63
+ * // ],
64
+ * // };
65
+ *
66
+ * ```
67
+ *
68
+ * @param GetTierOverrideCommandInput - {@link GetTierOverrideCommandInput}
69
+ * @returns {@link GetTierOverrideCommandOutput}
70
+ * @see {@link GetTierOverrideCommandInput} for command's `input` shape.
71
+ * @see {@link GetTierOverrideCommandOutput} 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 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 NotFoundError} (client fault)
82
+ * 404: the resource does not exist or is not visible to the caller (code `NOT_FOUND`, or a more
83
+ * specific one such as `REQUEST_UNAVAILABLE`).
84
+ *
85
+ * @throws {@link InternalServerError} (server fault)
86
+ * 500: an unexpected failure (code `INTERNAL_ERROR`).
87
+ *
88
+ * @throws {@link UnauthorizedError} (client fault)
89
+ * 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
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 GetTierOverrideCommand extends GetTierOverrideCommand_base {
112
+ /** @internal type navigation helper, not in runtime. */
113
+ protected static __types: {
114
+ api: {
115
+ input: TargetUserRequest;
116
+ output: TierOverride;
117
+ };
118
+ sdk: {
119
+ input: GetTierOverrideCommandInput;
120
+ output: GetTierOverrideCommandOutput;
121
+ };
122
+ };
123
+ }
@@ -59,8 +59,31 @@ declare const GetTraditionPreferencesCommand_base: {
59
59
  * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
60
60
  *
61
61
  * @throws {@link BadRequestError} (client fault)
62
+ * 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
62
63
  *
63
64
  * @throws {@link InternalServerError} (server fault)
65
+ * 500: an unexpected failure (code `INTERNAL_ERROR`).
66
+ *
67
+ * @throws {@link UnauthorizedError} (client fault)
68
+ * 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
69
+ *
70
+ * @throws {@link ForbiddenError} (client fault)
71
+ * 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
72
+ * `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
73
+ *
74
+ * @throws {@link TooManyRequestsError} (client fault)
75
+ * 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
76
+ * `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
77
+ * model.
78
+ *
79
+ * @throws {@link BadGatewayError} (server fault)
80
+ * 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
81
+ * (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
82
+ * (`PROPAGATION_FAILED`, retrying the same request is safe).
83
+ *
84
+ * @throws {@link ServiceUnavailableError} (server fault)
85
+ * 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
86
+ * `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
64
87
  *
65
88
  * @throws {@link OneHookServiceException}
66
89
  * <p>Base exception class for all service exceptions from OneHook service.</p>
@@ -61,9 +61,36 @@ declare const GetUserByEmailCommand_base: {
61
61
  * @see {@link GetUserByEmailCommandOutput} for command's `response` shape.
62
62
  * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
63
63
  *
64
+ * @throws {@link BadRequestError} (client fault)
65
+ * 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
66
+ *
64
67
  * @throws {@link NotFoundError} (client fault)
68
+ * 404: the resource does not exist or is not visible to the caller (code `NOT_FOUND`, or a more
69
+ * specific one such as `REQUEST_UNAVAILABLE`).
65
70
  *
66
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`.
67
94
  *
68
95
  * @throws {@link OneHookServiceException}
69
96
  * <p>Base exception class for all service exceptions from OneHook service.</p>
@@ -61,9 +61,36 @@ declare const GetUserCommand_base: {
61
61
  * @see {@link GetUserCommandOutput} for command's `response` shape.
62
62
  * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
63
63
  *
64
+ * @throws {@link BadRequestError} (client fault)
65
+ * 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
66
+ *
64
67
  * @throws {@link NotFoundError} (client fault)
68
+ * 404: the resource does not exist or is not visible to the caller (code `NOT_FOUND`, or a more
69
+ * specific one such as `REQUEST_UNAVAILABLE`).
65
70
  *
66
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`.
67
94
  *
68
95
  * @throws {@link OneHookServiceException}
69
96
  * <p>Base exception class for all service exceptions from OneHook service.</p>
@@ -27,12 +27,12 @@ declare const GetUserIdByUsernameCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * Resolves a public handle to the internal userId. Internal, IAM-authorized (SigV4) — Matching calls
31
- * it to turn an "add by username" request into a swipe target.
30
+ * Resolves a public handle to the internal userId. Internal, IAM-authorized (SigV4) — State calls
31
+ * it to deliver a hook request sent by username (`SendHookRequest`).
32
32
  *
33
33
  * DELIBERATELY NOT EXPOSED TO CLIENTS. A handle→userId lookup any signed-in user could call is a
34
34
  * username enumeration oracle: it confirms which handles exist and hands out a stable identifier for
35
- * them. Keeping resolution server-side is what lets the caller-facing swipe-by-username response stay
35
+ * them. Keeping resolution server-side is what lets the caller-facing `SendHookRequest` response stay
36
36
  * identical whether the handle exists or not.
37
37
  * @example
38
38
  * Use a bare-bones client and the command you need to make an API call.
@@ -58,10 +58,35 @@ declare const GetUserIdByUsernameCommand_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>
@@ -54,8 +54,31 @@ declare const IndexLocationCommand_base: {
54
54
  * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
55
55
  *
56
56
  * @throws {@link BadRequestError} (client fault)
57
+ * 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
57
58
  *
58
59
  * @throws {@link InternalServerError} (server fault)
60
+ * 500: an unexpected failure (code `INTERNAL_ERROR`).
61
+ *
62
+ * @throws {@link UnauthorizedError} (client fault)
63
+ * 401: no valid session for the route (code `UNAUTHORIZED`, or `INVALID_SESSION` from Matching).
64
+ *
65
+ * @throws {@link ForbiddenError} (client fault)
66
+ * 403: the caller may not do this (code `FORBIDDEN`, or a more specific one such as Matching's
67
+ * `MATCHING_OFF`, `DISCOVERY_PAUSED` or `PREMIUM_REQUIRED`). Shared by every service model.
68
+ *
69
+ * @throws {@link TooManyRequestsError} (client fault)
70
+ * 429: a rate limit or daily quota is spent (for example `REPORT_LIMIT`, `RATE_LIMIT_EXCEEDED`,
71
+ * `ROSE_LIMIT_REACHED`, or `TOO_MANY_REQUESTS` from API Gateway throttling). Shared by every service
72
+ * model.
73
+ *
74
+ * @throws {@link BadGatewayError} (server fault)
75
+ * 502: an upstream failed: API Gateway could not use the Lambda's answer, the identity provider
76
+ * (Cognito) failed (`BAD_GATEWAY`), or a downstream write failed after this service saved its own change
77
+ * (`PROPAGATION_FAILED`, retrying the same request is safe).
78
+ *
79
+ * @throws {@link ServiceUnavailableError} (server fault)
80
+ * 503: a dependency is unavailable; retry later (`retryable` is true). Codes include
81
+ * `SERVICE_UNAVAILABLE`, `DATABASE_UNAVAILABLE` and `VIEW_PASS_UNAVAILABLE`.
59
82
  *
60
83
  * @throws {@link OneHookServiceException}
61
84
  * <p>Base exception class for all service exceptions from OneHook service.</p>
@@ -0,0 +1,114 @@
1
+ import { OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../OneHookClient";
2
+ import { IngestSignalsRequest, IngestSignalsResponse } 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 IngestSignalsCommand}.
14
+ */
15
+ export interface IngestSignalsCommandInput extends IngestSignalsRequest {
16
+ }
17
+ /**
18
+ * @public
19
+ *
20
+ * The output of {@link IngestSignalsCommand}.
21
+ */
22
+ export interface IngestSignalsCommandOutput extends IngestSignalsResponse, __MetadataBearer {
23
+ }
24
+ declare const IngestSignalsCommand_base: {
25
+ new (input: IngestSignalsCommandInput): import("@smithy/smithy-client").CommandImpl<IngestSignalsCommandInput, IngestSignalsCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
26
+ new (...[input]: [] | [IngestSignalsCommandInput]): import("@smithy/smithy-client").CommandImpl<IngestSignalsCommandInput, IngestSignalsCommandOutput, OneHookClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes>;
27
+ getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
28
+ };
29
+ /**
30
+ * Accepts a batch of client telemetry signals. Invalid signals never fail the request: each is
31
+ * counted under a reason in `reasons` (for example `unknown_type`, `duplicate`, `rate_limited`,
32
+ * `batch_too_large`, `ingest_failed`, or a catalog attribute reason). The member is the token's `sub`.
33
+ * 400 only for a body that is not JSON.
34
+ * @example
35
+ * Use a bare-bones client and the command you need to make an API call.
36
+ * ```javascript
37
+ * import { OneHookClient, IngestSignalsCommand } from "onehook-api-client"; // ES Modules import
38
+ * // const { OneHookClient, IngestSignalsCommand } = require("onehook-api-client"); // CommonJS import
39
+ * const client = new OneHookClient(config);
40
+ * const input = { // IngestSignalsRequest
41
+ * platform: "STRING_VALUE",
42
+ * signals: [ // RawSignalList
43
+ * { // RawSignal
44
+ * clientEventId: "STRING_VALUE", // required
45
+ * type: "STRING_VALUE", // required
46
+ * timestamp: Number("long"),
47
+ * attributes: "DOCUMENT_VALUE",
48
+ * },
49
+ * ],
50
+ * };
51
+ * const command = new IngestSignalsCommand(input);
52
+ * const response = await client.send(command);
53
+ * // { // IngestSignalsResponse
54
+ * // accepted: Number("int"), // required
55
+ * // rejected: Number("int"), // required
56
+ * // reasons: { // ReasonCounts // required
57
+ * // "<keys>": Number("int"),
58
+ * // },
59
+ * // };
60
+ *
61
+ * ```
62
+ *
63
+ * @param IngestSignalsCommandInput - {@link IngestSignalsCommandInput}
64
+ * @returns {@link IngestSignalsCommandOutput}
65
+ * @see {@link IngestSignalsCommandInput} for command's `input` shape.
66
+ * @see {@link IngestSignalsCommandOutput} for command's `response` shape.
67
+ * @see {@link OneHookClientResolvedConfig | config} for OneHookClient's `config` shape.
68
+ *
69
+ * @throws {@link BadRequestError} (client fault)
70
+ * 400: the request is malformed or fails validation (code `BAD_REQUEST`, or a more specific one).
71
+ *
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`.
95
+ *
96
+ * @throws {@link OneHookServiceException}
97
+ * <p>Base exception class for all service exceptions from OneHook service.</p>
98
+ *
99
+ *
100
+ * @public
101
+ */
102
+ export declare class IngestSignalsCommand extends IngestSignalsCommand_base {
103
+ /** @internal type navigation helper, not in runtime. */
104
+ protected static __types: {
105
+ api: {
106
+ input: IngestSignalsRequest;
107
+ output: IngestSignalsResponse;
108
+ };
109
+ sdk: {
110
+ input: IngestSignalsCommandInput;
111
+ output: IngestSignalsCommandOutput;
112
+ };
113
+ };
114
+ }