zyphr 0.1.0

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 (967) hide show
  1. checksums.yaml +7 -0
  2. data/Gemfile +9 -0
  3. data/README.md +614 -0
  4. data/Rakefile +10 -0
  5. data/docs/AddTopicSubscribersRequest.md +20 -0
  6. data/docs/ApiError.md +20 -0
  7. data/docs/ApiErrorError.md +22 -0
  8. data/docs/ApiErrorMeta.md +18 -0
  9. data/docs/AuthEmailVerificationApi.md +248 -0
  10. data/docs/AuthLoginApi.md +84 -0
  11. data/docs/AuthLoginResponse.md +20 -0
  12. data/docs/AuthLoginResult.md +24 -0
  13. data/docs/AuthLoginResultMfaChallenge.md +20 -0
  14. data/docs/AuthMFAApi.md +546 -0
  15. data/docs/AuthMagicLinksApi.md +161 -0
  16. data/docs/AuthOAuthApi.md +597 -0
  17. data/docs/AuthPasswordResetApi.md +238 -0
  18. data/docs/AuthPhoneApi.md +384 -0
  19. data/docs/AuthRegistrationApi.md +84 -0
  20. data/docs/AuthResult.md +20 -0
  21. data/docs/AuthResultResponse.md +20 -0
  22. data/docs/AuthSession.md +28 -0
  23. data/docs/AuthSessionsApi.md +310 -0
  24. data/docs/AuthTokens.md +24 -0
  25. data/docs/AuthUser.md +42 -0
  26. data/docs/AuthUserProfileApi.md +226 -0
  27. data/docs/AuthUserResponse.md +20 -0
  28. data/docs/AuthUserResponseData.md +18 -0
  29. data/docs/AuthWebAuthnApi.md +621 -0
  30. data/docs/BulkRetryWebhookDeliveriesRequest.md +24 -0
  31. data/docs/Category.md +34 -0
  32. data/docs/CategoryListResponse.md +20 -0
  33. data/docs/CategoryResponse.md +20 -0
  34. data/docs/ConfirmEmailVerificationRequest.md +18 -0
  35. data/docs/ConfirmEmailVerificationResponse.md +20 -0
  36. data/docs/ConfirmEmailVerificationResponseData.md +20 -0
  37. data/docs/ConsentHistoryEntry.md +32 -0
  38. data/docs/ConsentHistoryResponse.md +20 -0
  39. data/docs/ConsentRecordResponse.md +20 -0
  40. data/docs/ConsentRecordResponseData.md +20 -0
  41. data/docs/ConsentStatus.md +24 -0
  42. data/docs/ConsentStatusResponse.md +20 -0
  43. data/docs/ConsentWithdrawResponse.md +20 -0
  44. data/docs/CreateCategoryRequest.md +26 -0
  45. data/docs/CreateSubscriberRequest.md +32 -0
  46. data/docs/CreateTemplateRequest.md +28 -0
  47. data/docs/CreateTopicRequest.md +22 -0
  48. data/docs/CreateWebhookRequest.md +36 -0
  49. data/docs/DeleteResult.md +20 -0
  50. data/docs/DeleteResultData.md +20 -0
  51. data/docs/Device.md +34 -0
  52. data/docs/DeviceListResponse.md +20 -0
  53. data/docs/DevicePushTopic.md +22 -0
  54. data/docs/DevicePushTopicListResponse.md +20 -0
  55. data/docs/DevicePushTopicListResponseMeta.md +20 -0
  56. data/docs/DeviceResponse.md +20 -0
  57. data/docs/DeviceStats.md +20 -0
  58. data/docs/DeviceStatsResponse.md +20 -0
  59. data/docs/DevicesApi.md +444 -0
  60. data/docs/EmailAddress.md +20 -0
  61. data/docs/EmailAttachment.md +26 -0
  62. data/docs/EmailEvent.md +32 -0
  63. data/docs/EmailEventsResponse.md +20 -0
  64. data/docs/EmailListResponse.md +20 -0
  65. data/docs/EmailMessage.md +42 -0
  66. data/docs/EmailResponse.md +20 -0
  67. data/docs/EmailTrackingClickLink.md +22 -0
  68. data/docs/EmailTrackingClicks.md +22 -0
  69. data/docs/EmailTrackingData.md +20 -0
  70. data/docs/EmailTrackingOpens.md +20 -0
  71. data/docs/EmailTrackingResponse.md +20 -0
  72. data/docs/EmailsApi.md +447 -0
  73. data/docs/EndUserDeleteResponse.md +20 -0
  74. data/docs/EndUserDeleteResponseData.md +20 -0
  75. data/docs/ForgotPasswordRequest.md +20 -0
  76. data/docs/InAppNotification.md +48 -0
  77. data/docs/InboxApi.md +694 -0
  78. data/docs/InboxListMeta.md +28 -0
  79. data/docs/InboxListResponse.md +20 -0
  80. data/docs/InboxNotificationResponse.md +20 -0
  81. data/docs/LoginRequest.md +22 -0
  82. data/docs/MagicLinkSendRequest.md +20 -0
  83. data/docs/MagicLinkVerifyRequest.md +18 -0
  84. data/docs/MagicLinkVerifyResponse.md +20 -0
  85. data/docs/MagicLinkVerifyResponseData.md +22 -0
  86. data/docs/MarkAllInboxReadRequest.md +22 -0
  87. data/docs/MarkAllReadData.md +18 -0
  88. data/docs/MarkAllReadResponse.md +20 -0
  89. data/docs/MarkInboxReadRequest.md +20 -0
  90. data/docs/MfaBackupCodesResponse.md +20 -0
  91. data/docs/MfaBackupCodesResponseData.md +18 -0
  92. data/docs/MfaDisableRequest.md +20 -0
  93. data/docs/MfaDisableResponse.md +20 -0
  94. data/docs/MfaDisableResponseData.md +18 -0
  95. data/docs/MfaEnrollRequest.md +18 -0
  96. data/docs/MfaEnrollmentResponse.md +20 -0
  97. data/docs/MfaEnrollmentResponseData.md +22 -0
  98. data/docs/MfaRegenerateBackupCodesRequest.md +20 -0
  99. data/docs/MfaStatusResponse.md +20 -0
  100. data/docs/MfaStatusResponseData.md +24 -0
  101. data/docs/MfaVerifyBackupRequest.md +20 -0
  102. data/docs/MfaVerifyBackupResponse.md +20 -0
  103. data/docs/MfaVerifyBackupResponseData.md +22 -0
  104. data/docs/MfaVerifyEnrollmentRequest.md +20 -0
  105. data/docs/MfaVerifyEnrollmentResponse.md +20 -0
  106. data/docs/MfaVerifyEnrollmentResponseData.md +18 -0
  107. data/docs/MfaVerifyRequest.md +20 -0
  108. data/docs/OAuthAuthorizationUrlResponse.md +20 -0
  109. data/docs/OAuthAuthorizationUrlResponseData.md +20 -0
  110. data/docs/OAuthCallbackRequest.md +22 -0
  111. data/docs/OAuthCallbackResponse.md +20 -0
  112. data/docs/OAuthCallbackResponseData.md +24 -0
  113. data/docs/OAuthConnection.md +30 -0
  114. data/docs/OAuthConnectionInfoResponse.md +20 -0
  115. data/docs/OAuthConnectionInfoResponseData.md +28 -0
  116. data/docs/OAuthConnectionsResponse.md +20 -0
  117. data/docs/OAuthConnectionsResponseData.md +18 -0
  118. data/docs/OAuthProvider.md +20 -0
  119. data/docs/OAuthProviderInfo.md +30 -0
  120. data/docs/OAuthProvidersResponse.md +20 -0
  121. data/docs/OAuthProvidersResponseData.md +18 -0
  122. data/docs/OAuthTokensRefreshResponse.md +20 -0
  123. data/docs/OAuthTokensRefreshResponseData.md +26 -0
  124. data/docs/OAuthTokensResponse.md +20 -0
  125. data/docs/OAuthTokensResponseData.md +28 -0
  126. data/docs/PaginationMeta.md +24 -0
  127. data/docs/PasswordRequirements.md +28 -0
  128. data/docs/PasswordRequirementsResponse.md +20 -0
  129. data/docs/PasswordRequirementsResponseData.md +18 -0
  130. data/docs/PhoneAuthAvailabilityResponse.md +20 -0
  131. data/docs/PhoneAuthAvailabilityResponseData.md +20 -0
  132. data/docs/PhoneLoginVerifyRequest.md +22 -0
  133. data/docs/PhoneOtpSendRequest.md +18 -0
  134. data/docs/PhoneOtpSentResponse.md +20 -0
  135. data/docs/PhoneOtpSentResponseData.md +20 -0
  136. data/docs/PhoneRegisterVerifyRequest.md +24 -0
  137. data/docs/PreferenceListResponse.md +20 -0
  138. data/docs/PushApi.md +674 -0
  139. data/docs/PushDetailResponse.md +20 -0
  140. data/docs/PushEvent.md +28 -0
  141. data/docs/PushListResponse.md +20 -0
  142. data/docs/PushMessage.md +36 -0
  143. data/docs/PushMessageDetail.md +62 -0
  144. data/docs/PushPayload.md +32 -0
  145. data/docs/PushStatsData.md +28 -0
  146. data/docs/PushStatsResponse.md +20 -0
  147. data/docs/PushTopicDevice.md +26 -0
  148. data/docs/PushTopicDeviceListResponse.md +20 -0
  149. data/docs/PushTopicSubscribeData.md +24 -0
  150. data/docs/PushTopicSubscribeResponse.md +20 -0
  151. data/docs/PushTopicUnsubscribeData.md +24 -0
  152. data/docs/PushTopicUnsubscribeResponse.md +20 -0
  153. data/docs/RefreshOAuthTokensRequest.md +18 -0
  154. data/docs/RefreshSessionRequest.md +20 -0
  155. data/docs/RefreshTokenResponse.md +20 -0
  156. data/docs/RefreshTokenResponseData.md +20 -0
  157. data/docs/RegisterDeviceRequest.md +34 -0
  158. data/docs/RegisterRequest.md +24 -0
  159. data/docs/RemoveTopicSubscribersRequest.md +18 -0
  160. data/docs/RenameWebAuthnCredentialRequest.md +18 -0
  161. data/docs/RenderTemplateRequest.md +18 -0
  162. data/docs/ReplayWebhookEventsRequest.md +22 -0
  163. data/docs/RequestMeta.md +18 -0
  164. data/docs/ResetPasswordRequest.md +20 -0
  165. data/docs/ResetPasswordResponse.md +20 -0
  166. data/docs/ResubscribeRequest.md +18 -0
  167. data/docs/ResubscribeResponse.md +20 -0
  168. data/docs/RevokeAllSessionsResponse.md +20 -0
  169. data/docs/RevokeAllSessionsResponseData.md +20 -0
  170. data/docs/RevokeSessionRequest.md +18 -0
  171. data/docs/SMSApi.md +654 -0
  172. data/docs/SendBatchEmailRequest.md +18 -0
  173. data/docs/SendBatchEmailResponse.md +20 -0
  174. data/docs/SendBatchEmailResult.md +26 -0
  175. data/docs/SendBatchEmailResultItem.md +22 -0
  176. data/docs/SendBatchInAppMeta.md +26 -0
  177. data/docs/SendBatchInAppRequest.md +18 -0
  178. data/docs/SendBatchInAppResponse.md +20 -0
  179. data/docs/SendBatchSmsData.md +24 -0
  180. data/docs/SendBatchSmsRequest.md +20 -0
  181. data/docs/SendBatchSmsResponse.md +20 -0
  182. data/docs/SendEmailRequest.md +50 -0
  183. data/docs/SendEmailResponse.md +20 -0
  184. data/docs/SendEmailResponseData.md +20 -0
  185. data/docs/SendEmailResponseMeta.md +20 -0
  186. data/docs/SendEmailVerificationRequest.md +18 -0
  187. data/docs/SendInAppMeta.md +18 -0
  188. data/docs/SendInAppRequest.md +40 -0
  189. data/docs/SendInAppResponse.md +20 -0
  190. data/docs/SendPushRequest.md +34 -0
  191. data/docs/SendPushResponse.md +20 -0
  192. data/docs/SendPushResponseData.md +24 -0
  193. data/docs/SendPushToTopicData.md +24 -0
  194. data/docs/SendPushToTopicRequest.md +36 -0
  195. data/docs/SendPushToTopicResponse.md +20 -0
  196. data/docs/SendSmsData.md +32 -0
  197. data/docs/SendSmsRequest.md +28 -0
  198. data/docs/SendSmsResponse.md +20 -0
  199. data/docs/SendTestSmsData.md +26 -0
  200. data/docs/SendTestSmsRequest.md +20 -0
  201. data/docs/SendTestSmsResponse.md +20 -0
  202. data/docs/SendWebhookTestEventRequest.md +20 -0
  203. data/docs/SessionListResponse.md +20 -0
  204. data/docs/SessionListResponseData.md +20 -0
  205. data/docs/SessionListResponseDataSessionInfo.md +22 -0
  206. data/docs/SetPreferencesRequest.md +18 -0
  207. data/docs/SetPreferencesRequestPreferencesInner.md +22 -0
  208. data/docs/SmsBatchResultMessage.md +26 -0
  209. data/docs/SmsBatchResultSummary.md +22 -0
  210. data/docs/SmsConfig.md +32 -0
  211. data/docs/SmsConfigDeleteResponse.md +20 -0
  212. data/docs/SmsConfigDeleteResponseData.md +18 -0
  213. data/docs/SmsConfigResponse.md +20 -0
  214. data/docs/SmsDetailResponse.md +20 -0
  215. data/docs/SmsListResponse.md +20 -0
  216. data/docs/SmsListResponseMeta.md +26 -0
  217. data/docs/SmsMessage.md +32 -0
  218. data/docs/SmsMessageDetail.md +52 -0
  219. data/docs/SubscribePushTopicRequest.md +18 -0
  220. data/docs/Subscriber.md +42 -0
  221. data/docs/SubscriberListResponse.md +20 -0
  222. data/docs/SubscriberPreference.md +30 -0
  223. data/docs/SubscriberResponse.md +20 -0
  224. data/docs/SubscribersApi.md +1450 -0
  225. data/docs/SuccessResult.md +20 -0
  226. data/docs/SuccessResultData.md +18 -0
  227. data/docs/Template.md +36 -0
  228. data/docs/TemplateListResponse.md +20 -0
  229. data/docs/TemplateRenderResponse.md +20 -0
  230. data/docs/TemplateRenderedContent.md +22 -0
  231. data/docs/TemplateResponse.md +20 -0
  232. data/docs/TemplatesApi.md +447 -0
  233. data/docs/TestWebhookTransformRequest.md +18 -0
  234. data/docs/Topic.md +30 -0
  235. data/docs/TopicDeleteResponse.md +20 -0
  236. data/docs/TopicDeleteResponseData.md +20 -0
  237. data/docs/TopicListResponse.md +20 -0
  238. data/docs/TopicResponse.md +20 -0
  239. data/docs/TopicStatsData.md +22 -0
  240. data/docs/TopicStatsDataTopicsBySubscriberCountInner.md +22 -0
  241. data/docs/TopicStatsResponse.md +20 -0
  242. data/docs/TopicSubscriber.md +22 -0
  243. data/docs/TopicSubscriberListResponse.md +20 -0
  244. data/docs/TopicSubscribersAddResponse.md +20 -0
  245. data/docs/TopicSubscribersAddResult.md +22 -0
  246. data/docs/TopicSubscribersRemoveResponse.md +20 -0
  247. data/docs/TopicSubscribersRemoveResult.md +22 -0
  248. data/docs/TopicsApi.md +670 -0
  249. data/docs/UnreadCountData.md +18 -0
  250. data/docs/UnreadCountResponse.md +20 -0
  251. data/docs/Unsubscribe.md +26 -0
  252. data/docs/UnsubscribeListResponse.md +20 -0
  253. data/docs/UnsubscribeRequest.md +20 -0
  254. data/docs/UnsubscribeResponse.md +20 -0
  255. data/docs/UpdateCategoryRequest.md +26 -0
  256. data/docs/UpdateEndUserRequest.md +22 -0
  257. data/docs/UpdateSubscriberRequest.md +32 -0
  258. data/docs/UpdateTemplateRequest.md +28 -0
  259. data/docs/UpdateTopicRequest.md +20 -0
  260. data/docs/UpdateWebhookRequest.md +36 -0
  261. data/docs/UpsertSmsConfigRequest.md +24 -0
  262. data/docs/UserDevicesDeleteResponse.md +20 -0
  263. data/docs/UserDevicesDeleteResponseData.md +20 -0
  264. data/docs/UtilityApi.md +76 -0
  265. data/docs/ValidateResetTokenRequest.md +18 -0
  266. data/docs/ValidateResetTokenResponse.md +20 -0
  267. data/docs/ValidateResetTokenResponseData.md +20 -0
  268. data/docs/VerifySmsConfigData.md +20 -0
  269. data/docs/VerifySmsConfigResponse.md +20 -0
  270. data/docs/WebAuthnChallengeOptions.md +20 -0
  271. data/docs/WebAuthnCredential.md +32 -0
  272. data/docs/WebAuthnCredentialListResponse.md +20 -0
  273. data/docs/WebAuthnCredentialListResponseData.md +18 -0
  274. data/docs/WebAuthnCredentialResponse.md +20 -0
  275. data/docs/WebAuthnStartAuthRequest.md +20 -0
  276. data/docs/WebAuthnStartAuthResponse.md +20 -0
  277. data/docs/WebAuthnStartRegistrationRequest.md +18 -0
  278. data/docs/WebAuthnStartRegistrationResponse.md +20 -0
  279. data/docs/WebAuthnStatusResponse.md +20 -0
  280. data/docs/WebAuthnStatusResponseData.md +20 -0
  281. data/docs/WebAuthnVerifyAuthRequest.md +22 -0
  282. data/docs/WebAuthnVerifyRegistrationRequest.md +22 -0
  283. data/docs/WebAuthnVerifyRegistrationResponse.md +20 -0
  284. data/docs/WebAuthnVerifyRegistrationResponseData.md +18 -0
  285. data/docs/Webhook.md +44 -0
  286. data/docs/WebhookBulkRetryResponse.md +20 -0
  287. data/docs/WebhookCircuitState.md +26 -0
  288. data/docs/WebhookCircuitStateResponse.md +20 -0
  289. data/docs/WebhookCreateResponse.md +20 -0
  290. data/docs/WebhookCreateResponseData.md +46 -0
  291. data/docs/WebhookDeleteResponse.md +20 -0
  292. data/docs/WebhookDeleteResponseData.md +20 -0
  293. data/docs/WebhookDelivery.md +48 -0
  294. data/docs/WebhookDeliveryDetail.md +56 -0
  295. data/docs/WebhookDeliveryListResponse.md +20 -0
  296. data/docs/WebhookDeliveryResponse.md +20 -0
  297. data/docs/WebhookDeliveryRetryResponse.md +20 -0
  298. data/docs/WebhookDeliveryRetryResponseData.md +22 -0
  299. data/docs/WebhookEventTypesResponse.md +20 -0
  300. data/docs/WebhookEventTypesResponseData.md +24 -0
  301. data/docs/WebhookIpsResponse.md +20 -0
  302. data/docs/WebhookIpsResponseData.md +22 -0
  303. data/docs/WebhookJobResponse.md +20 -0
  304. data/docs/WebhookListResponse.md +20 -0
  305. data/docs/WebhookMetricsResponse.md +20 -0
  306. data/docs/WebhookRegion.md +22 -0
  307. data/docs/WebhookRegionsResponse.md +20 -0
  308. data/docs/WebhookRegionsResponseData.md +20 -0
  309. data/docs/WebhookReplayResponse.md +20 -0
  310. data/docs/WebhookResponse.md +20 -0
  311. data/docs/WebhookSecretRotateResponse.md +20 -0
  312. data/docs/WebhookSecretRotateResponseData.md +20 -0
  313. data/docs/WebhookTestEventResponse.md +20 -0
  314. data/docs/WebhookTestEventResponseData.md +24 -0
  315. data/docs/WebhookTransformTestResponse.md +20 -0
  316. data/docs/WebhookUsageResponse.md +20 -0
  317. data/docs/WebhookVersion.md +32 -0
  318. data/docs/WebhookVersionsResponse.md +20 -0
  319. data/docs/WebhookVersionsResponseData.md +20 -0
  320. data/docs/WebhookWorkspaceMetricsResponse.md +20 -0
  321. data/docs/WebhooksApi.md +1688 -0
  322. data/docs/WithdrawSubscriberConsentRequest.md +18 -0
  323. data/git_push.sh +57 -0
  324. data/lib/zyphr/api/auth_email_verification_api.rb +218 -0
  325. data/lib/zyphr/api/auth_login_api.rb +90 -0
  326. data/lib/zyphr/api/auth_magic_links_api.rb +158 -0
  327. data/lib/zyphr/api/auth_mfa_api.rb +493 -0
  328. data/lib/zyphr/api/auth_o_auth_api.rb +550 -0
  329. data/lib/zyphr/api/auth_password_reset_api.rb +226 -0
  330. data/lib/zyphr/api/auth_phone_api.rb +351 -0
  331. data/lib/zyphr/api/auth_registration_api.rb +90 -0
  332. data/lib/zyphr/api/auth_sessions_api.rb +272 -0
  333. data/lib/zyphr/api/auth_user_profile_api.rb +204 -0
  334. data/lib/zyphr/api/auth_web_authn_api.rb +537 -0
  335. data/lib/zyphr/api/devices_api.rb +409 -0
  336. data/lib/zyphr/api/emails_api.rb +432 -0
  337. data/lib/zyphr/api/inbox_api.rb +650 -0
  338. data/lib/zyphr/api/push_api.rb +644 -0
  339. data/lib/zyphr/api/sms_api.rb +605 -0
  340. data/lib/zyphr/api/subscribers_api.rb +1340 -0
  341. data/lib/zyphr/api/templates_api.rb +427 -0
  342. data/lib/zyphr/api/topics_api.rb +630 -0
  343. data/lib/zyphr/api/utility_api.rb +79 -0
  344. data/lib/zyphr/api/webhooks_api.rb +1527 -0
  345. data/lib/zyphr/api_client.rb +437 -0
  346. data/lib/zyphr/api_error.rb +58 -0
  347. data/lib/zyphr/configuration.rb +438 -0
  348. data/lib/zyphr/models/add_topic_subscribers_request.rb +259 -0
  349. data/lib/zyphr/models/api_error.rb +246 -0
  350. data/lib/zyphr/models/api_error_error.rb +274 -0
  351. data/lib/zyphr/models/api_error_meta.rb +220 -0
  352. data/lib/zyphr/models/auth_login_response.rb +229 -0
  353. data/lib/zyphr/models/auth_login_result.rb +247 -0
  354. data/lib/zyphr/models/auth_login_result_mfa_challenge.rb +229 -0
  355. data/lib/zyphr/models/auth_result.rb +229 -0
  356. data/lib/zyphr/models/auth_result_response.rb +229 -0
  357. data/lib/zyphr/models/auth_session.rb +265 -0
  358. data/lib/zyphr/models/auth_tokens.rb +248 -0
  359. data/lib/zyphr/models/auth_user.rb +369 -0
  360. data/lib/zyphr/models/auth_user_response.rb +229 -0
  361. data/lib/zyphr/models/auth_user_response_data.rb +220 -0
  362. data/lib/zyphr/models/bulk_retry_webhook_deliveries_request.rb +287 -0
  363. data/lib/zyphr/models/category.rb +295 -0
  364. data/lib/zyphr/models/category_list_response.rb +231 -0
  365. data/lib/zyphr/models/category_response.rb +229 -0
  366. data/lib/zyphr/models/confirm_email_verification_request.rb +237 -0
  367. data/lib/zyphr/models/confirm_email_verification_response.rb +229 -0
  368. data/lib/zyphr/models/confirm_email_verification_response_data.rb +229 -0
  369. data/lib/zyphr/models/consent_history_entry.rb +287 -0
  370. data/lib/zyphr/models/consent_history_response.rb +231 -0
  371. data/lib/zyphr/models/consent_record_response.rb +229 -0
  372. data/lib/zyphr/models/consent_record_response_data.rb +229 -0
  373. data/lib/zyphr/models/consent_status.rb +249 -0
  374. data/lib/zyphr/models/consent_status_response.rb +229 -0
  375. data/lib/zyphr/models/consent_withdraw_response.rb +229 -0
  376. data/lib/zyphr/models/create_category_request.rb +309 -0
  377. data/lib/zyphr/models/create_subscriber_request.rb +303 -0
  378. data/lib/zyphr/models/create_template_request.rb +300 -0
  379. data/lib/zyphr/models/create_topic_request.rb +275 -0
  380. data/lib/zyphr/models/create_webhook_request.rb +350 -0
  381. data/lib/zyphr/models/delete_result.rb +229 -0
  382. data/lib/zyphr/models/delete_result_data.rb +229 -0
  383. data/lib/zyphr/models/device.rb +343 -0
  384. data/lib/zyphr/models/device_list_response.rb +231 -0
  385. data/lib/zyphr/models/device_push_topic.rb +238 -0
  386. data/lib/zyphr/models/device_push_topic_list_response.rb +231 -0
  387. data/lib/zyphr/models/device_push_topic_list_response_meta.rb +229 -0
  388. data/lib/zyphr/models/device_response.rb +229 -0
  389. data/lib/zyphr/models/device_stats.rb +231 -0
  390. data/lib/zyphr/models/device_stats_response.rb +229 -0
  391. data/lib/zyphr/models/email_address.rb +229 -0
  392. data/lib/zyphr/models/email_attachment.rb +328 -0
  393. data/lib/zyphr/models/email_event.rb +286 -0
  394. data/lib/zyphr/models/email_events_response.rb +231 -0
  395. data/lib/zyphr/models/email_list_response.rb +231 -0
  396. data/lib/zyphr/models/email_message.rb +369 -0
  397. data/lib/zyphr/models/email_response.rb +229 -0
  398. data/lib/zyphr/models/email_tracking_click_link.rb +238 -0
  399. data/lib/zyphr/models/email_tracking_clicks.rb +241 -0
  400. data/lib/zyphr/models/email_tracking_data.rb +229 -0
  401. data/lib/zyphr/models/email_tracking_opens.rb +230 -0
  402. data/lib/zyphr/models/email_tracking_response.rb +229 -0
  403. data/lib/zyphr/models/end_user_delete_response.rb +229 -0
  404. data/lib/zyphr/models/end_user_delete_response_data.rb +229 -0
  405. data/lib/zyphr/models/forgot_password_request.rb +246 -0
  406. data/lib/zyphr/models/in_app_notification.rb +400 -0
  407. data/lib/zyphr/models/inbox_list_meta.rb +266 -0
  408. data/lib/zyphr/models/inbox_list_response.rb +231 -0
  409. data/lib/zyphr/models/inbox_notification_response.rb +229 -0
  410. data/lib/zyphr/models/login_request.rb +275 -0
  411. data/lib/zyphr/models/magic_link_send_request.rb +246 -0
  412. data/lib/zyphr/models/magic_link_verify_request.rb +237 -0
  413. data/lib/zyphr/models/magic_link_verify_response.rb +229 -0
  414. data/lib/zyphr/models/magic_link_verify_response_data.rb +245 -0
  415. data/lib/zyphr/models/mark_all_inbox_read_request.rb +238 -0
  416. data/lib/zyphr/models/mark_all_read_data.rb +220 -0
  417. data/lib/zyphr/models/mark_all_read_response.rb +229 -0
  418. data/lib/zyphr/models/mark_inbox_read_request.rb +229 -0
  419. data/lib/zyphr/models/mfa_backup_codes_response.rb +229 -0
  420. data/lib/zyphr/models/mfa_backup_codes_response_data.rb +223 -0
  421. data/lib/zyphr/models/mfa_disable_request.rb +263 -0
  422. data/lib/zyphr/models/mfa_disable_response.rb +229 -0
  423. data/lib/zyphr/models/mfa_disable_response_data.rb +220 -0
  424. data/lib/zyphr/models/mfa_enroll_request.rb +237 -0
  425. data/lib/zyphr/models/mfa_enrollment_response.rb +229 -0
  426. data/lib/zyphr/models/mfa_enrollment_response_data.rb +243 -0
  427. data/lib/zyphr/models/mfa_regenerate_backup_codes_request.rb +281 -0
  428. data/lib/zyphr/models/mfa_status_response.rb +229 -0
  429. data/lib/zyphr/models/mfa_status_response_data.rb +282 -0
  430. data/lib/zyphr/models/mfa_verify_backup_request.rb +263 -0
  431. data/lib/zyphr/models/mfa_verify_backup_response.rb +229 -0
  432. data/lib/zyphr/models/mfa_verify_backup_response_data.rb +239 -0
  433. data/lib/zyphr/models/mfa_verify_enrollment_request.rb +281 -0
  434. data/lib/zyphr/models/mfa_verify_enrollment_response.rb +229 -0
  435. data/lib/zyphr/models/mfa_verify_enrollment_response_data.rb +220 -0
  436. data/lib/zyphr/models/mfa_verify_request.rb +281 -0
  437. data/lib/zyphr/models/o_auth_authorization_url_response.rb +229 -0
  438. data/lib/zyphr/models/o_auth_authorization_url_response_data.rb +229 -0
  439. data/lib/zyphr/models/o_auth_callback_request.rb +274 -0
  440. data/lib/zyphr/models/o_auth_callback_response.rb +229 -0
  441. data/lib/zyphr/models/o_auth_callback_response_data.rb +254 -0
  442. data/lib/zyphr/models/o_auth_connection.rb +276 -0
  443. data/lib/zyphr/models/o_auth_connection_info_response.rb +229 -0
  444. data/lib/zyphr/models/o_auth_connection_info_response_data.rb +267 -0
  445. data/lib/zyphr/models/o_auth_connections_response.rb +229 -0
  446. data/lib/zyphr/models/o_auth_connections_response_data.rb +222 -0
  447. data/lib/zyphr/models/o_auth_provider.rb +231 -0
  448. data/lib/zyphr/models/o_auth_provider_info.rb +276 -0
  449. data/lib/zyphr/models/o_auth_providers_response.rb +229 -0
  450. data/lib/zyphr/models/o_auth_providers_response_data.rb +222 -0
  451. data/lib/zyphr/models/o_auth_tokens_refresh_response.rb +229 -0
  452. data/lib/zyphr/models/o_auth_tokens_refresh_response_data.rb +258 -0
  453. data/lib/zyphr/models/o_auth_tokens_response.rb +229 -0
  454. data/lib/zyphr/models/o_auth_tokens_response_data.rb +267 -0
  455. data/lib/zyphr/models/pagination_meta.rb +247 -0
  456. data/lib/zyphr/models/password_requirements.rb +265 -0
  457. data/lib/zyphr/models/password_requirements_response.rb +229 -0
  458. data/lib/zyphr/models/password_requirements_response_data.rb +220 -0
  459. data/lib/zyphr/models/phone_auth_availability_response.rb +229 -0
  460. data/lib/zyphr/models/phone_auth_availability_response_data.rb +229 -0
  461. data/lib/zyphr/models/phone_login_verify_request.rb +274 -0
  462. data/lib/zyphr/models/phone_otp_send_request.rb +237 -0
  463. data/lib/zyphr/models/phone_otp_sent_response.rb +229 -0
  464. data/lib/zyphr/models/phone_otp_sent_response_data.rb +229 -0
  465. data/lib/zyphr/models/phone_register_verify_request.rb +283 -0
  466. data/lib/zyphr/models/preference_list_response.rb +231 -0
  467. data/lib/zyphr/models/push_detail_response.rb +229 -0
  468. data/lib/zyphr/models/push_event.rb +267 -0
  469. data/lib/zyphr/models/push_list_response.rb +231 -0
  470. data/lib/zyphr/models/push_message.rb +350 -0
  471. data/lib/zyphr/models/push_message_detail.rb +488 -0
  472. data/lib/zyphr/models/push_payload.rb +319 -0
  473. data/lib/zyphr/models/push_stats_data.rb +265 -0
  474. data/lib/zyphr/models/push_stats_response.rb +229 -0
  475. data/lib/zyphr/models/push_topic_device.rb +291 -0
  476. data/lib/zyphr/models/push_topic_device_list_response.rb +231 -0
  477. data/lib/zyphr/models/push_topic_subscribe_data.rb +249 -0
  478. data/lib/zyphr/models/push_topic_subscribe_response.rb +229 -0
  479. data/lib/zyphr/models/push_topic_unsubscribe_data.rb +249 -0
  480. data/lib/zyphr/models/push_topic_unsubscribe_response.rb +229 -0
  481. data/lib/zyphr/models/refresh_o_auth_tokens_request.rb +237 -0
  482. data/lib/zyphr/models/refresh_session_request.rb +248 -0
  483. data/lib/zyphr/models/refresh_token_response.rb +229 -0
  484. data/lib/zyphr/models/refresh_token_response_data.rb +229 -0
  485. data/lib/zyphr/models/register_device_request.rb +352 -0
  486. data/lib/zyphr/models/register_request.rb +283 -0
  487. data/lib/zyphr/models/remove_topic_subscribers_request.rb +249 -0
  488. data/lib/zyphr/models/rename_web_authn_credential_request.rb +246 -0
  489. data/lib/zyphr/models/render_template_request.rb +239 -0
  490. data/lib/zyphr/models/replay_webhook_events_request.rb +277 -0
  491. data/lib/zyphr/models/request_meta.rb +220 -0
  492. data/lib/zyphr/models/reset_password_request.rb +263 -0
  493. data/lib/zyphr/models/reset_password_response.rb +229 -0
  494. data/lib/zyphr/models/resubscribe_request.rb +254 -0
  495. data/lib/zyphr/models/resubscribe_response.rb +229 -0
  496. data/lib/zyphr/models/revoke_all_sessions_response.rb +229 -0
  497. data/lib/zyphr/models/revoke_all_sessions_response_data.rb +229 -0
  498. data/lib/zyphr/models/revoke_session_request.rb +237 -0
  499. data/lib/zyphr/models/send_batch_email_request.rb +248 -0
  500. data/lib/zyphr/models/send_batch_email_response.rb +229 -0
  501. data/lib/zyphr/models/send_batch_email_result.rb +258 -0
  502. data/lib/zyphr/models/send_batch_email_result_item.rb +238 -0
  503. data/lib/zyphr/models/send_batch_in_app_meta.rb +257 -0
  504. data/lib/zyphr/models/send_batch_in_app_request.rb +248 -0
  505. data/lib/zyphr/models/send_batch_in_app_response.rb +231 -0
  506. data/lib/zyphr/models/send_batch_sms_data.rb +251 -0
  507. data/lib/zyphr/models/send_batch_sms_request.rb +284 -0
  508. data/lib/zyphr/models/send_batch_sms_response.rb +229 -0
  509. data/lib/zyphr/models/send_email_request.rb +424 -0
  510. data/lib/zyphr/models/send_email_response.rb +229 -0
  511. data/lib/zyphr/models/send_email_response_data.rb +263 -0
  512. data/lib/zyphr/models/send_email_response_meta.rb +229 -0
  513. data/lib/zyphr/models/send_email_verification_request.rb +221 -0
  514. data/lib/zyphr/models/send_in_app_meta.rb +220 -0
  515. data/lib/zyphr/models/send_in_app_request.rb +393 -0
  516. data/lib/zyphr/models/send_in_app_response.rb +229 -0
  517. data/lib/zyphr/models/send_push_request.rb +353 -0
  518. data/lib/zyphr/models/send_push_response.rb +229 -0
  519. data/lib/zyphr/models/send_push_response_data.rb +247 -0
  520. data/lib/zyphr/models/send_push_to_topic_data.rb +247 -0
  521. data/lib/zyphr/models/send_push_to_topic_request.rb +309 -0
  522. data/lib/zyphr/models/send_push_to_topic_response.rb +229 -0
  523. data/lib/zyphr/models/send_sms_data.rb +284 -0
  524. data/lib/zyphr/models/send_sms_request.rb +312 -0
  525. data/lib/zyphr/models/send_sms_response.rb +229 -0
  526. data/lib/zyphr/models/send_test_sms_data.rb +256 -0
  527. data/lib/zyphr/models/send_test_sms_request.rb +248 -0
  528. data/lib/zyphr/models/send_test_sms_response.rb +229 -0
  529. data/lib/zyphr/models/send_webhook_test_event_request.rb +231 -0
  530. data/lib/zyphr/models/session_list_response.rb +229 -0
  531. data/lib/zyphr/models/session_list_response_data.rb +231 -0
  532. data/lib/zyphr/models/session_list_response_data_session_info.rb +239 -0
  533. data/lib/zyphr/models/set_preferences_request.rb +239 -0
  534. data/lib/zyphr/models/set_preferences_request_preferences_inner.rb +238 -0
  535. data/lib/zyphr/models/sms_batch_result_message.rb +256 -0
  536. data/lib/zyphr/models/sms_batch_result_summary.rb +238 -0
  537. data/lib/zyphr/models/sms_config.rb +285 -0
  538. data/lib/zyphr/models/sms_config_delete_response.rb +229 -0
  539. data/lib/zyphr/models/sms_config_delete_response_data.rb +220 -0
  540. data/lib/zyphr/models/sms_config_response.rb +229 -0
  541. data/lib/zyphr/models/sms_detail_response.rb +229 -0
  542. data/lib/zyphr/models/sms_list_response.rb +231 -0
  543. data/lib/zyphr/models/sms_list_response_meta.rb +256 -0
  544. data/lib/zyphr/models/sms_message.rb +319 -0
  545. data/lib/zyphr/models/sms_message_detail.rb +426 -0
  546. data/lib/zyphr/models/subscribe_push_topic_request.rb +257 -0
  547. data/lib/zyphr/models/subscriber.rb +367 -0
  548. data/lib/zyphr/models/subscriber_list_response.rb +231 -0
  549. data/lib/zyphr/models/subscriber_preference.rb +308 -0
  550. data/lib/zyphr/models/subscriber_response.rb +229 -0
  551. data/lib/zyphr/models/success_result.rb +229 -0
  552. data/lib/zyphr/models/success_result_data.rb +220 -0
  553. data/lib/zyphr/models/template.rb +306 -0
  554. data/lib/zyphr/models/template_list_response.rb +231 -0
  555. data/lib/zyphr/models/template_render_response.rb +229 -0
  556. data/lib/zyphr/models/template_rendered_content.rb +241 -0
  557. data/lib/zyphr/models/template_response.rb +229 -0
  558. data/lib/zyphr/models/test_webhook_transform_request.rb +238 -0
  559. data/lib/zyphr/models/topic.rb +275 -0
  560. data/lib/zyphr/models/topic_delete_response.rb +229 -0
  561. data/lib/zyphr/models/topic_delete_response_data.rb +229 -0
  562. data/lib/zyphr/models/topic_list_response.rb +231 -0
  563. data/lib/zyphr/models/topic_response.rb +229 -0
  564. data/lib/zyphr/models/topic_stats_data.rb +240 -0
  565. data/lib/zyphr/models/topic_stats_data_topics_by_subscriber_count_inner.rb +238 -0
  566. data/lib/zyphr/models/topic_stats_response.rb +229 -0
  567. data/lib/zyphr/models/topic_subscriber.rb +238 -0
  568. data/lib/zyphr/models/topic_subscriber_list_response.rb +231 -0
  569. data/lib/zyphr/models/topic_subscribers_add_response.rb +229 -0
  570. data/lib/zyphr/models/topic_subscribers_add_result.rb +242 -0
  571. data/lib/zyphr/models/topic_subscribers_remove_response.rb +229 -0
  572. data/lib/zyphr/models/topic_subscribers_remove_result.rb +242 -0
  573. data/lib/zyphr/models/unread_count_data.rb +220 -0
  574. data/lib/zyphr/models/unread_count_response.rb +229 -0
  575. data/lib/zyphr/models/unsubscribe.rb +292 -0
  576. data/lib/zyphr/models/unsubscribe_list_response.rb +231 -0
  577. data/lib/zyphr/models/unsubscribe_request.rb +263 -0
  578. data/lib/zyphr/models/unsubscribe_response.rb +229 -0
  579. data/lib/zyphr/models/update_category_request.rb +258 -0
  580. data/lib/zyphr/models/update_end_user_request.rb +238 -0
  581. data/lib/zyphr/models/update_subscriber_request.rb +323 -0
  582. data/lib/zyphr/models/update_template_request.rb +288 -0
  583. data/lib/zyphr/models/update_topic_request.rb +230 -0
  584. data/lib/zyphr/models/update_webhook_request.rb +307 -0
  585. data/lib/zyphr/models/upsert_sms_config_request.rb +302 -0
  586. data/lib/zyphr/models/user_devices_delete_response.rb +229 -0
  587. data/lib/zyphr/models/user_devices_delete_response_data.rb +229 -0
  588. data/lib/zyphr/models/validate_reset_token_request.rb +237 -0
  589. data/lib/zyphr/models/validate_reset_token_response.rb +229 -0
  590. data/lib/zyphr/models/validate_reset_token_response_data.rb +229 -0
  591. data/lib/zyphr/models/verify_sms_config_data.rb +230 -0
  592. data/lib/zyphr/models/verify_sms_config_response.rb +229 -0
  593. data/lib/zyphr/models/web_authn_challenge_options.rb +229 -0
  594. data/lib/zyphr/models/web_authn_credential.rb +286 -0
  595. data/lib/zyphr/models/web_authn_credential_list_response.rb +229 -0
  596. data/lib/zyphr/models/web_authn_credential_list_response_data.rb +222 -0
  597. data/lib/zyphr/models/web_authn_credential_response.rb +229 -0
  598. data/lib/zyphr/models/web_authn_start_auth_request.rb +231 -0
  599. data/lib/zyphr/models/web_authn_start_auth_response.rb +229 -0
  600. data/lib/zyphr/models/web_authn_start_registration_request.rb +220 -0
  601. data/lib/zyphr/models/web_authn_start_registration_response.rb +229 -0
  602. data/lib/zyphr/models/web_authn_status_response.rb +229 -0
  603. data/lib/zyphr/models/web_authn_status_response_data.rb +229 -0
  604. data/lib/zyphr/models/web_authn_verify_auth_request.rb +275 -0
  605. data/lib/zyphr/models/web_authn_verify_registration_request.rb +273 -0
  606. data/lib/zyphr/models/web_authn_verify_registration_response.rb +229 -0
  607. data/lib/zyphr/models/web_authn_verify_registration_response_data.rb +220 -0
  608. data/lib/zyphr/models/webhook.rb +381 -0
  609. data/lib/zyphr/models/webhook_bulk_retry_response.rb +230 -0
  610. data/lib/zyphr/models/webhook_circuit_state.rb +292 -0
  611. data/lib/zyphr/models/webhook_circuit_state_response.rb +229 -0
  612. data/lib/zyphr/models/webhook_create_response.rb +229 -0
  613. data/lib/zyphr/models/webhook_create_response_data.rb +398 -0
  614. data/lib/zyphr/models/webhook_delete_response.rb +229 -0
  615. data/lib/zyphr/models/webhook_delete_response_data.rb +229 -0
  616. data/lib/zyphr/models/webhook_delivery.rb +397 -0
  617. data/lib/zyphr/models/webhook_delivery_detail.rb +444 -0
  618. data/lib/zyphr/models/webhook_delivery_list_response.rb +231 -0
  619. data/lib/zyphr/models/webhook_delivery_response.rb +229 -0
  620. data/lib/zyphr/models/webhook_delivery_retry_response.rb +229 -0
  621. data/lib/zyphr/models/webhook_delivery_retry_response_data.rb +238 -0
  622. data/lib/zyphr/models/webhook_event_types_response.rb +229 -0
  623. data/lib/zyphr/models/webhook_event_types_response_data.rb +253 -0
  624. data/lib/zyphr/models/webhook_ips_response.rb +229 -0
  625. data/lib/zyphr/models/webhook_ips_response_data.rb +243 -0
  626. data/lib/zyphr/models/webhook_job_response.rb +230 -0
  627. data/lib/zyphr/models/webhook_list_response.rb +231 -0
  628. data/lib/zyphr/models/webhook_metrics_response.rb +230 -0
  629. data/lib/zyphr/models/webhook_region.rb +240 -0
  630. data/lib/zyphr/models/webhook_regions_response.rb +229 -0
  631. data/lib/zyphr/models/webhook_regions_response_data.rb +232 -0
  632. data/lib/zyphr/models/webhook_replay_response.rb +230 -0
  633. data/lib/zyphr/models/webhook_response.rb +229 -0
  634. data/lib/zyphr/models/webhook_secret_rotate_response.rb +229 -0
  635. data/lib/zyphr/models/webhook_secret_rotate_response_data.rb +230 -0
  636. data/lib/zyphr/models/webhook_test_event_response.rb +229 -0
  637. data/lib/zyphr/models/webhook_test_event_response_data.rb +247 -0
  638. data/lib/zyphr/models/webhook_transform_test_response.rb +230 -0
  639. data/lib/zyphr/models/webhook_usage_response.rb +230 -0
  640. data/lib/zyphr/models/webhook_version.rb +288 -0
  641. data/lib/zyphr/models/webhook_versions_response.rb +229 -0
  642. data/lib/zyphr/models/webhook_versions_response_data.rb +231 -0
  643. data/lib/zyphr/models/webhook_workspace_metrics_response.rb +230 -0
  644. data/lib/zyphr/models/withdraw_subscriber_consent_request.rb +220 -0
  645. data/lib/zyphr/version.rb +15 -0
  646. data/lib/zyphr.rb +357 -0
  647. data/spec/api/auth_email_verification_api_spec.rb +71 -0
  648. data/spec/api/auth_login_api_spec.rb +47 -0
  649. data/spec/api/auth_magic_links_api_spec.rb +59 -0
  650. data/spec/api/auth_mfa_api_spec.rb +119 -0
  651. data/spec/api/auth_o_auth_api_spec.rb +133 -0
  652. data/spec/api/auth_password_reset_api_spec.rb +71 -0
  653. data/spec/api/auth_phone_api_spec.rb +94 -0
  654. data/spec/api/auth_registration_api_spec.rb +47 -0
  655. data/spec/api/auth_sessions_api_spec.rb +81 -0
  656. data/spec/api/auth_user_profile_api_spec.rb +69 -0
  657. data/spec/api/auth_web_authn_api_spec.rb +130 -0
  658. data/spec/api/devices_api_spec.rb +109 -0
  659. data/spec/api/emails_api_spec.rb +110 -0
  660. data/spec/api/inbox_api_spec.rb +157 -0
  661. data/spec/api/push_api_spec.rb +151 -0
  662. data/spec/api/sms_api_spec.rb +143 -0
  663. data/spec/api/subscribers_api_spec.rb +272 -0
  664. data/spec/api/templates_api_spec.rb +110 -0
  665. data/spec/api/topics_api_spec.rb +149 -0
  666. data/spec/api/utility_api_spec.rb +46 -0
  667. data/spec/api/webhooks_api_spec.rb +321 -0
  668. data/spec/models/add_topic_subscribers_request_spec.rb +42 -0
  669. data/spec/models/api_error_error_spec.rb +48 -0
  670. data/spec/models/api_error_meta_spec.rb +36 -0
  671. data/spec/models/api_error_spec.rb +42 -0
  672. data/spec/models/auth_login_response_spec.rb +42 -0
  673. data/spec/models/auth_login_result_mfa_challenge_spec.rb +42 -0
  674. data/spec/models/auth_login_result_spec.rb +54 -0
  675. data/spec/models/auth_result_response_spec.rb +42 -0
  676. data/spec/models/auth_result_spec.rb +42 -0
  677. data/spec/models/auth_session_spec.rb +66 -0
  678. data/spec/models/auth_tokens_spec.rb +54 -0
  679. data/spec/models/auth_user_response_data_spec.rb +36 -0
  680. data/spec/models/auth_user_response_spec.rb +42 -0
  681. data/spec/models/auth_user_spec.rb +112 -0
  682. data/spec/models/bulk_retry_webhook_deliveries_request_spec.rb +58 -0
  683. data/spec/models/category_list_response_spec.rb +42 -0
  684. data/spec/models/category_response_spec.rb +42 -0
  685. data/spec/models/category_spec.rb +84 -0
  686. data/spec/models/confirm_email_verification_request_spec.rb +36 -0
  687. data/spec/models/confirm_email_verification_response_data_spec.rb +42 -0
  688. data/spec/models/confirm_email_verification_response_spec.rb +42 -0
  689. data/spec/models/consent_history_entry_spec.rb +78 -0
  690. data/spec/models/consent_history_response_spec.rb +42 -0
  691. data/spec/models/consent_record_response_data_spec.rb +42 -0
  692. data/spec/models/consent_record_response_spec.rb +42 -0
  693. data/spec/models/consent_status_response_spec.rb +42 -0
  694. data/spec/models/consent_status_spec.rb +54 -0
  695. data/spec/models/consent_withdraw_response_spec.rb +42 -0
  696. data/spec/models/create_category_request_spec.rb +60 -0
  697. data/spec/models/create_subscriber_request_spec.rb +78 -0
  698. data/spec/models/create_template_request_spec.rb +66 -0
  699. data/spec/models/create_topic_request_spec.rb +48 -0
  700. data/spec/models/create_webhook_request_spec.rb +90 -0
  701. data/spec/models/delete_result_data_spec.rb +42 -0
  702. data/spec/models/delete_result_spec.rb +42 -0
  703. data/spec/models/device_list_response_spec.rb +42 -0
  704. data/spec/models/device_push_topic_list_response_meta_spec.rb +42 -0
  705. data/spec/models/device_push_topic_list_response_spec.rb +42 -0
  706. data/spec/models/device_push_topic_spec.rb +48 -0
  707. data/spec/models/device_response_spec.rb +42 -0
  708. data/spec/models/device_spec.rb +92 -0
  709. data/spec/models/device_stats_response_spec.rb +42 -0
  710. data/spec/models/device_stats_spec.rb +42 -0
  711. data/spec/models/email_address_spec.rb +42 -0
  712. data/spec/models/email_attachment_spec.rb +64 -0
  713. data/spec/models/email_event_spec.rb +78 -0
  714. data/spec/models/email_events_response_spec.rb +42 -0
  715. data/spec/models/email_list_response_spec.rb +42 -0
  716. data/spec/models/email_message_spec.rb +112 -0
  717. data/spec/models/email_response_spec.rb +42 -0
  718. data/spec/models/email_tracking_click_link_spec.rb +48 -0
  719. data/spec/models/email_tracking_clicks_spec.rb +48 -0
  720. data/spec/models/email_tracking_data_spec.rb +42 -0
  721. data/spec/models/email_tracking_opens_spec.rb +42 -0
  722. data/spec/models/email_tracking_response_spec.rb +42 -0
  723. data/spec/models/end_user_delete_response_data_spec.rb +42 -0
  724. data/spec/models/end_user_delete_response_spec.rb +42 -0
  725. data/spec/models/forgot_password_request_spec.rb +42 -0
  726. data/spec/models/in_app_notification_spec.rb +130 -0
  727. data/spec/models/inbox_list_meta_spec.rb +66 -0
  728. data/spec/models/inbox_list_response_spec.rb +42 -0
  729. data/spec/models/inbox_notification_response_spec.rb +42 -0
  730. data/spec/models/login_request_spec.rb +48 -0
  731. data/spec/models/magic_link_send_request_spec.rb +42 -0
  732. data/spec/models/magic_link_verify_request_spec.rb +36 -0
  733. data/spec/models/magic_link_verify_response_data_spec.rb +48 -0
  734. data/spec/models/magic_link_verify_response_spec.rb +42 -0
  735. data/spec/models/mark_all_inbox_read_request_spec.rb +48 -0
  736. data/spec/models/mark_all_read_data_spec.rb +36 -0
  737. data/spec/models/mark_all_read_response_spec.rb +42 -0
  738. data/spec/models/mark_inbox_read_request_spec.rb +42 -0
  739. data/spec/models/mfa_backup_codes_response_data_spec.rb +36 -0
  740. data/spec/models/mfa_backup_codes_response_spec.rb +42 -0
  741. data/spec/models/mfa_disable_request_spec.rb +42 -0
  742. data/spec/models/mfa_disable_response_data_spec.rb +36 -0
  743. data/spec/models/mfa_disable_response_spec.rb +42 -0
  744. data/spec/models/mfa_enroll_request_spec.rb +36 -0
  745. data/spec/models/mfa_enrollment_response_data_spec.rb +48 -0
  746. data/spec/models/mfa_enrollment_response_spec.rb +42 -0
  747. data/spec/models/mfa_regenerate_backup_codes_request_spec.rb +42 -0
  748. data/spec/models/mfa_status_response_data_spec.rb +58 -0
  749. data/spec/models/mfa_status_response_spec.rb +42 -0
  750. data/spec/models/mfa_verify_backup_request_spec.rb +42 -0
  751. data/spec/models/mfa_verify_backup_response_data_spec.rb +48 -0
  752. data/spec/models/mfa_verify_backup_response_spec.rb +42 -0
  753. data/spec/models/mfa_verify_enrollment_request_spec.rb +42 -0
  754. data/spec/models/mfa_verify_enrollment_response_data_spec.rb +36 -0
  755. data/spec/models/mfa_verify_enrollment_response_spec.rb +42 -0
  756. data/spec/models/mfa_verify_request_spec.rb +42 -0
  757. data/spec/models/o_auth_authorization_url_response_data_spec.rb +42 -0
  758. data/spec/models/o_auth_authorization_url_response_spec.rb +42 -0
  759. data/spec/models/o_auth_callback_request_spec.rb +48 -0
  760. data/spec/models/o_auth_callback_response_data_spec.rb +54 -0
  761. data/spec/models/o_auth_callback_response_spec.rb +42 -0
  762. data/spec/models/o_auth_connection_info_response_data_spec.rb +66 -0
  763. data/spec/models/o_auth_connection_info_response_spec.rb +42 -0
  764. data/spec/models/o_auth_connection_spec.rb +72 -0
  765. data/spec/models/o_auth_connections_response_data_spec.rb +36 -0
  766. data/spec/models/o_auth_connections_response_spec.rb +42 -0
  767. data/spec/models/o_auth_provider_info_spec.rb +72 -0
  768. data/spec/models/o_auth_provider_spec.rb +42 -0
  769. data/spec/models/o_auth_providers_response_data_spec.rb +36 -0
  770. data/spec/models/o_auth_providers_response_spec.rb +42 -0
  771. data/spec/models/o_auth_tokens_refresh_response_data_spec.rb +60 -0
  772. data/spec/models/o_auth_tokens_refresh_response_spec.rb +42 -0
  773. data/spec/models/o_auth_tokens_response_data_spec.rb +66 -0
  774. data/spec/models/o_auth_tokens_response_spec.rb +42 -0
  775. data/spec/models/pagination_meta_spec.rb +54 -0
  776. data/spec/models/password_requirements_response_data_spec.rb +36 -0
  777. data/spec/models/password_requirements_response_spec.rb +42 -0
  778. data/spec/models/password_requirements_spec.rb +66 -0
  779. data/spec/models/phone_auth_availability_response_data_spec.rb +42 -0
  780. data/spec/models/phone_auth_availability_response_spec.rb +42 -0
  781. data/spec/models/phone_login_verify_request_spec.rb +48 -0
  782. data/spec/models/phone_otp_send_request_spec.rb +36 -0
  783. data/spec/models/phone_otp_sent_response_data_spec.rb +42 -0
  784. data/spec/models/phone_otp_sent_response_spec.rb +42 -0
  785. data/spec/models/phone_register_verify_request_spec.rb +54 -0
  786. data/spec/models/preference_list_response_spec.rb +42 -0
  787. data/spec/models/push_detail_response_spec.rb +42 -0
  788. data/spec/models/push_event_spec.rb +66 -0
  789. data/spec/models/push_list_response_spec.rb +42 -0
  790. data/spec/models/push_message_detail_spec.rb +176 -0
  791. data/spec/models/push_message_spec.rb +98 -0
  792. data/spec/models/push_payload_spec.rb +78 -0
  793. data/spec/models/push_stats_data_spec.rb +66 -0
  794. data/spec/models/push_stats_response_spec.rb +42 -0
  795. data/spec/models/push_topic_device_list_response_spec.rb +42 -0
  796. data/spec/models/push_topic_device_spec.rb +64 -0
  797. data/spec/models/push_topic_subscribe_data_spec.rb +54 -0
  798. data/spec/models/push_topic_subscribe_response_spec.rb +42 -0
  799. data/spec/models/push_topic_unsubscribe_data_spec.rb +54 -0
  800. data/spec/models/push_topic_unsubscribe_response_spec.rb +42 -0
  801. data/spec/models/refresh_o_auth_tokens_request_spec.rb +36 -0
  802. data/spec/models/refresh_session_request_spec.rb +42 -0
  803. data/spec/models/refresh_token_response_data_spec.rb +42 -0
  804. data/spec/models/refresh_token_response_spec.rb +42 -0
  805. data/spec/models/register_device_request_spec.rb +88 -0
  806. data/spec/models/register_request_spec.rb +54 -0
  807. data/spec/models/remove_topic_subscribers_request_spec.rb +36 -0
  808. data/spec/models/rename_web_authn_credential_request_spec.rb +36 -0
  809. data/spec/models/render_template_request_spec.rb +36 -0
  810. data/spec/models/replay_webhook_events_request_spec.rb +48 -0
  811. data/spec/models/request_meta_spec.rb +36 -0
  812. data/spec/models/reset_password_request_spec.rb +42 -0
  813. data/spec/models/reset_password_response_spec.rb +42 -0
  814. data/spec/models/resubscribe_request_spec.rb +40 -0
  815. data/spec/models/resubscribe_response_spec.rb +42 -0
  816. data/spec/models/revoke_all_sessions_response_data_spec.rb +42 -0
  817. data/spec/models/revoke_all_sessions_response_spec.rb +42 -0
  818. data/spec/models/revoke_session_request_spec.rb +36 -0
  819. data/spec/models/send_batch_email_request_spec.rb +36 -0
  820. data/spec/models/send_batch_email_response_spec.rb +42 -0
  821. data/spec/models/send_batch_email_result_item_spec.rb +48 -0
  822. data/spec/models/send_batch_email_result_spec.rb +60 -0
  823. data/spec/models/send_batch_in_app_meta_spec.rb +60 -0
  824. data/spec/models/send_batch_in_app_request_spec.rb +36 -0
  825. data/spec/models/send_batch_in_app_response_spec.rb +42 -0
  826. data/spec/models/send_batch_sms_data_spec.rb +54 -0
  827. data/spec/models/send_batch_sms_request_spec.rb +42 -0
  828. data/spec/models/send_batch_sms_response_spec.rb +42 -0
  829. data/spec/models/send_email_request_spec.rb +132 -0
  830. data/spec/models/send_email_response_data_spec.rb +46 -0
  831. data/spec/models/send_email_response_meta_spec.rb +42 -0
  832. data/spec/models/send_email_response_spec.rb +42 -0
  833. data/spec/models/send_email_verification_request_spec.rb +36 -0
  834. data/spec/models/send_in_app_meta_spec.rb +36 -0
  835. data/spec/models/send_in_app_request_spec.rb +106 -0
  836. data/spec/models/send_in_app_response_spec.rb +42 -0
  837. data/spec/models/send_push_request_spec.rb +88 -0
  838. data/spec/models/send_push_response_data_spec.rb +54 -0
  839. data/spec/models/send_push_response_spec.rb +42 -0
  840. data/spec/models/send_push_to_topic_data_spec.rb +54 -0
  841. data/spec/models/send_push_to_topic_request_spec.rb +90 -0
  842. data/spec/models/send_push_to_topic_response_spec.rb +42 -0
  843. data/spec/models/send_sms_data_spec.rb +78 -0
  844. data/spec/models/send_sms_request_spec.rb +66 -0
  845. data/spec/models/send_sms_response_spec.rb +42 -0
  846. data/spec/models/send_test_sms_data_spec.rb +60 -0
  847. data/spec/models/send_test_sms_request_spec.rb +42 -0
  848. data/spec/models/send_test_sms_response_spec.rb +42 -0
  849. data/spec/models/send_webhook_test_event_request_spec.rb +42 -0
  850. data/spec/models/session_list_response_data_session_info_spec.rb +48 -0
  851. data/spec/models/session_list_response_data_spec.rb +42 -0
  852. data/spec/models/session_list_response_spec.rb +42 -0
  853. data/spec/models/set_preferences_request_preferences_inner_spec.rb +48 -0
  854. data/spec/models/set_preferences_request_spec.rb +36 -0
  855. data/spec/models/sms_batch_result_message_spec.rb +60 -0
  856. data/spec/models/sms_batch_result_summary_spec.rb +48 -0
  857. data/spec/models/sms_config_delete_response_data_spec.rb +36 -0
  858. data/spec/models/sms_config_delete_response_spec.rb +42 -0
  859. data/spec/models/sms_config_response_spec.rb +42 -0
  860. data/spec/models/sms_config_spec.rb +78 -0
  861. data/spec/models/sms_detail_response_spec.rb +42 -0
  862. data/spec/models/sms_list_response_meta_spec.rb +60 -0
  863. data/spec/models/sms_list_response_spec.rb +42 -0
  864. data/spec/models/sms_message_detail_spec.rb +142 -0
  865. data/spec/models/sms_message_spec.rb +82 -0
  866. data/spec/models/subscribe_push_topic_request_spec.rb +36 -0
  867. data/spec/models/subscriber_list_response_spec.rb +42 -0
  868. data/spec/models/subscriber_preference_spec.rb +76 -0
  869. data/spec/models/subscriber_response_spec.rb +42 -0
  870. data/spec/models/subscriber_spec.rb +112 -0
  871. data/spec/models/success_result_data_spec.rb +36 -0
  872. data/spec/models/success_result_spec.rb +42 -0
  873. data/spec/models/template_list_response_spec.rb +42 -0
  874. data/spec/models/template_render_response_spec.rb +42 -0
  875. data/spec/models/template_rendered_content_spec.rb +48 -0
  876. data/spec/models/template_response_spec.rb +42 -0
  877. data/spec/models/template_spec.rb +90 -0
  878. data/spec/models/test_webhook_transform_request_spec.rb +36 -0
  879. data/spec/models/topic_delete_response_data_spec.rb +42 -0
  880. data/spec/models/topic_delete_response_spec.rb +42 -0
  881. data/spec/models/topic_list_response_spec.rb +42 -0
  882. data/spec/models/topic_response_spec.rb +42 -0
  883. data/spec/models/topic_spec.rb +72 -0
  884. data/spec/models/topic_stats_data_spec.rb +48 -0
  885. data/spec/models/topic_stats_data_topics_by_subscriber_count_inner_spec.rb +48 -0
  886. data/spec/models/topic_stats_response_spec.rb +42 -0
  887. data/spec/models/topic_subscriber_list_response_spec.rb +42 -0
  888. data/spec/models/topic_subscriber_spec.rb +48 -0
  889. data/spec/models/topic_subscribers_add_response_spec.rb +42 -0
  890. data/spec/models/topic_subscribers_add_result_spec.rb +48 -0
  891. data/spec/models/topic_subscribers_remove_response_spec.rb +42 -0
  892. data/spec/models/topic_subscribers_remove_result_spec.rb +48 -0
  893. data/spec/models/unread_count_data_spec.rb +36 -0
  894. data/spec/models/unread_count_response_spec.rb +42 -0
  895. data/spec/models/unsubscribe_list_response_spec.rb +42 -0
  896. data/spec/models/unsubscribe_request_spec.rb +46 -0
  897. data/spec/models/unsubscribe_response_spec.rb +42 -0
  898. data/spec/models/unsubscribe_spec.rb +64 -0
  899. data/spec/models/update_category_request_spec.rb +60 -0
  900. data/spec/models/update_end_user_request_spec.rb +48 -0
  901. data/spec/models/update_subscriber_request_spec.rb +82 -0
  902. data/spec/models/update_template_request_spec.rb +66 -0
  903. data/spec/models/update_topic_request_spec.rb +42 -0
  904. data/spec/models/update_webhook_request_spec.rb +90 -0
  905. data/spec/models/upsert_sms_config_request_spec.rb +54 -0
  906. data/spec/models/user_devices_delete_response_data_spec.rb +42 -0
  907. data/spec/models/user_devices_delete_response_spec.rb +42 -0
  908. data/spec/models/validate_reset_token_request_spec.rb +36 -0
  909. data/spec/models/validate_reset_token_response_data_spec.rb +42 -0
  910. data/spec/models/validate_reset_token_response_spec.rb +42 -0
  911. data/spec/models/verify_sms_config_data_spec.rb +42 -0
  912. data/spec/models/verify_sms_config_response_spec.rb +42 -0
  913. data/spec/models/web_authn_challenge_options_spec.rb +42 -0
  914. data/spec/models/web_authn_credential_list_response_data_spec.rb +36 -0
  915. data/spec/models/web_authn_credential_list_response_spec.rb +42 -0
  916. data/spec/models/web_authn_credential_response_spec.rb +42 -0
  917. data/spec/models/web_authn_credential_spec.rb +78 -0
  918. data/spec/models/web_authn_start_auth_request_spec.rb +42 -0
  919. data/spec/models/web_authn_start_auth_response_spec.rb +42 -0
  920. data/spec/models/web_authn_start_registration_request_spec.rb +36 -0
  921. data/spec/models/web_authn_start_registration_response_spec.rb +42 -0
  922. data/spec/models/web_authn_status_response_data_spec.rb +42 -0
  923. data/spec/models/web_authn_status_response_spec.rb +42 -0
  924. data/spec/models/web_authn_verify_auth_request_spec.rb +48 -0
  925. data/spec/models/web_authn_verify_registration_request_spec.rb +48 -0
  926. data/spec/models/web_authn_verify_registration_response_data_spec.rb +36 -0
  927. data/spec/models/web_authn_verify_registration_response_spec.rb +42 -0
  928. data/spec/models/webhook_bulk_retry_response_spec.rb +42 -0
  929. data/spec/models/webhook_circuit_state_response_spec.rb +42 -0
  930. data/spec/models/webhook_circuit_state_spec.rb +64 -0
  931. data/spec/models/webhook_create_response_data_spec.rb +124 -0
  932. data/spec/models/webhook_create_response_spec.rb +42 -0
  933. data/spec/models/webhook_delete_response_data_spec.rb +42 -0
  934. data/spec/models/webhook_delete_response_spec.rb +42 -0
  935. data/spec/models/webhook_delivery_detail_spec.rb +154 -0
  936. data/spec/models/webhook_delivery_list_response_spec.rb +42 -0
  937. data/spec/models/webhook_delivery_response_spec.rb +42 -0
  938. data/spec/models/webhook_delivery_retry_response_data_spec.rb +48 -0
  939. data/spec/models/webhook_delivery_retry_response_spec.rb +42 -0
  940. data/spec/models/webhook_delivery_spec.rb +130 -0
  941. data/spec/models/webhook_event_types_response_data_spec.rb +54 -0
  942. data/spec/models/webhook_event_types_response_spec.rb +42 -0
  943. data/spec/models/webhook_ips_response_data_spec.rb +48 -0
  944. data/spec/models/webhook_ips_response_spec.rb +42 -0
  945. data/spec/models/webhook_job_response_spec.rb +42 -0
  946. data/spec/models/webhook_list_response_spec.rb +42 -0
  947. data/spec/models/webhook_metrics_response_spec.rb +42 -0
  948. data/spec/models/webhook_region_spec.rb +48 -0
  949. data/spec/models/webhook_regions_response_data_spec.rb +42 -0
  950. data/spec/models/webhook_regions_response_spec.rb +42 -0
  951. data/spec/models/webhook_replay_response_spec.rb +42 -0
  952. data/spec/models/webhook_response_spec.rb +42 -0
  953. data/spec/models/webhook_secret_rotate_response_data_spec.rb +42 -0
  954. data/spec/models/webhook_secret_rotate_response_spec.rb +42 -0
  955. data/spec/models/webhook_spec.rb +118 -0
  956. data/spec/models/webhook_test_event_response_data_spec.rb +54 -0
  957. data/spec/models/webhook_test_event_response_spec.rb +42 -0
  958. data/spec/models/webhook_transform_test_response_spec.rb +42 -0
  959. data/spec/models/webhook_usage_response_spec.rb +42 -0
  960. data/spec/models/webhook_version_spec.rb +78 -0
  961. data/spec/models/webhook_versions_response_data_spec.rb +42 -0
  962. data/spec/models/webhook_versions_response_spec.rb +42 -0
  963. data/spec/models/webhook_workspace_metrics_response_spec.rb +42 -0
  964. data/spec/models/withdraw_subscriber_consent_request_spec.rb +36 -0
  965. data/spec/spec_helper.rb +111 -0
  966. data/zyphr.gemspec +41 -0
  967. metadata +1395 -0
@@ -0,0 +1,1527 @@
1
+ =begin
2
+ #Zyphr API
3
+
4
+ #Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## Authentication All API requests require authentication using an API key. Include your API key in the `X-API-Key` header: ``` X-API-Key: zy_live_xxxxxxxxxxxx ``` API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production. ## Rate Limiting The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets ## Errors All errors follow a consistent format: ```json { \"error\": { \"code\": \"error_code\", \"message\": \"Human readable message\", \"details\": {} }, \"meta\": { \"request_id\": \"req_xxxx\" } } ```
5
+
6
+ The version of the OpenAPI document: 1.0.0
7
+ Contact: support@zyphr.dev
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.12.0
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module Zyphr
16
+ class WebhooksApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Bulk retry failed deliveries
23
+ # Bulk retry failed or exhausted deliveries for a webhook. Creates an asynchronous job.
24
+ # @param id [String] Webhook ID
25
+ # @param [Hash] opts the optional parameters
26
+ # @option opts [BulkRetryWebhookDeliveriesRequest] :bulk_retry_webhook_deliveries_request
27
+ # @return [WebhookBulkRetryResponse]
28
+ def bulk_retry_webhook_deliveries(id, opts = {})
29
+ data, _status_code, _headers = bulk_retry_webhook_deliveries_with_http_info(id, opts)
30
+ data
31
+ end
32
+
33
+ # Bulk retry failed deliveries
34
+ # Bulk retry failed or exhausted deliveries for a webhook. Creates an asynchronous job.
35
+ # @param id [String] Webhook ID
36
+ # @param [Hash] opts the optional parameters
37
+ # @option opts [BulkRetryWebhookDeliveriesRequest] :bulk_retry_webhook_deliveries_request
38
+ # @return [Array<(WebhookBulkRetryResponse, Integer, Hash)>] WebhookBulkRetryResponse data, response status code and response headers
39
+ def bulk_retry_webhook_deliveries_with_http_info(id, opts = {})
40
+ if @api_client.config.debugging
41
+ @api_client.config.logger.debug 'Calling API: WebhooksApi.bulk_retry_webhook_deliveries ...'
42
+ end
43
+ # verify the required parameter 'id' is set
44
+ if @api_client.config.client_side_validation && id.nil?
45
+ fail ArgumentError, "Missing the required parameter 'id' when calling WebhooksApi.bulk_retry_webhook_deliveries"
46
+ end
47
+ # resource path
48
+ local_var_path = '/v1/webhooks/{id}/deliveries/bulk-retry'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
49
+
50
+ # query parameters
51
+ query_params = opts[:query_params] || {}
52
+
53
+ # header parameters
54
+ header_params = opts[:header_params] || {}
55
+ # HTTP header 'Accept' (if needed)
56
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
57
+ # HTTP header 'Content-Type'
58
+ content_type = @api_client.select_header_content_type(['application/json'])
59
+ if !content_type.nil?
60
+ header_params['Content-Type'] = content_type
61
+ end
62
+
63
+ # form parameters
64
+ form_params = opts[:form_params] || {}
65
+
66
+ # http body (model)
67
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'bulk_retry_webhook_deliveries_request'])
68
+
69
+ # return_type
70
+ return_type = opts[:debug_return_type] || 'WebhookBulkRetryResponse'
71
+
72
+ # auth_names
73
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
74
+
75
+ new_options = opts.merge(
76
+ :operation => :"WebhooksApi.bulk_retry_webhook_deliveries",
77
+ :header_params => header_params,
78
+ :query_params => query_params,
79
+ :form_params => form_params,
80
+ :body => post_body,
81
+ :auth_names => auth_names,
82
+ :return_type => return_type
83
+ )
84
+
85
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
86
+ if @api_client.config.debugging
87
+ @api_client.config.logger.debug "API called: WebhooksApi#bulk_retry_webhook_deliveries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
88
+ end
89
+ return data, status_code, headers
90
+ end
91
+
92
+ # Force close circuit breaker
93
+ # Force-close the circuit breaker for a webhook, allowing deliveries to resume.
94
+ # @param id [String] Webhook ID
95
+ # @param [Hash] opts the optional parameters
96
+ # @return [WebhookCircuitStateResponse]
97
+ def close_webhook_circuit(id, opts = {})
98
+ data, _status_code, _headers = close_webhook_circuit_with_http_info(id, opts)
99
+ data
100
+ end
101
+
102
+ # Force close circuit breaker
103
+ # Force-close the circuit breaker for a webhook, allowing deliveries to resume.
104
+ # @param id [String] Webhook ID
105
+ # @param [Hash] opts the optional parameters
106
+ # @return [Array<(WebhookCircuitStateResponse, Integer, Hash)>] WebhookCircuitStateResponse data, response status code and response headers
107
+ def close_webhook_circuit_with_http_info(id, opts = {})
108
+ if @api_client.config.debugging
109
+ @api_client.config.logger.debug 'Calling API: WebhooksApi.close_webhook_circuit ...'
110
+ end
111
+ # verify the required parameter 'id' is set
112
+ if @api_client.config.client_side_validation && id.nil?
113
+ fail ArgumentError, "Missing the required parameter 'id' when calling WebhooksApi.close_webhook_circuit"
114
+ end
115
+ # resource path
116
+ local_var_path = '/v1/webhooks/{id}/circuit/close'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
117
+
118
+ # query parameters
119
+ query_params = opts[:query_params] || {}
120
+
121
+ # header parameters
122
+ header_params = opts[:header_params] || {}
123
+ # HTTP header 'Accept' (if needed)
124
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
125
+
126
+ # form parameters
127
+ form_params = opts[:form_params] || {}
128
+
129
+ # http body (model)
130
+ post_body = opts[:debug_body]
131
+
132
+ # return_type
133
+ return_type = opts[:debug_return_type] || 'WebhookCircuitStateResponse'
134
+
135
+ # auth_names
136
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
137
+
138
+ new_options = opts.merge(
139
+ :operation => :"WebhooksApi.close_webhook_circuit",
140
+ :header_params => header_params,
141
+ :query_params => query_params,
142
+ :form_params => form_params,
143
+ :body => post_body,
144
+ :auth_names => auth_names,
145
+ :return_type => return_type
146
+ )
147
+
148
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
149
+ if @api_client.config.debugging
150
+ @api_client.config.logger.debug "API called: WebhooksApi#close_webhook_circuit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
151
+ end
152
+ return data, status_code, headers
153
+ end
154
+
155
+ # Create webhook
156
+ # Create a new webhook endpoint. The signing secret is only returned on creation.
157
+ # @param create_webhook_request [CreateWebhookRequest]
158
+ # @param [Hash] opts the optional parameters
159
+ # @return [WebhookCreateResponse]
160
+ def create_webhook(create_webhook_request, opts = {})
161
+ data, _status_code, _headers = create_webhook_with_http_info(create_webhook_request, opts)
162
+ data
163
+ end
164
+
165
+ # Create webhook
166
+ # Create a new webhook endpoint. The signing secret is only returned on creation.
167
+ # @param create_webhook_request [CreateWebhookRequest]
168
+ # @param [Hash] opts the optional parameters
169
+ # @return [Array<(WebhookCreateResponse, Integer, Hash)>] WebhookCreateResponse data, response status code and response headers
170
+ def create_webhook_with_http_info(create_webhook_request, opts = {})
171
+ if @api_client.config.debugging
172
+ @api_client.config.logger.debug 'Calling API: WebhooksApi.create_webhook ...'
173
+ end
174
+ # verify the required parameter 'create_webhook_request' is set
175
+ if @api_client.config.client_side_validation && create_webhook_request.nil?
176
+ fail ArgumentError, "Missing the required parameter 'create_webhook_request' when calling WebhooksApi.create_webhook"
177
+ end
178
+ # resource path
179
+ local_var_path = '/v1/webhooks'
180
+
181
+ # query parameters
182
+ query_params = opts[:query_params] || {}
183
+
184
+ # header parameters
185
+ header_params = opts[:header_params] || {}
186
+ # HTTP header 'Accept' (if needed)
187
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
188
+ # HTTP header 'Content-Type'
189
+ content_type = @api_client.select_header_content_type(['application/json'])
190
+ if !content_type.nil?
191
+ header_params['Content-Type'] = content_type
192
+ end
193
+
194
+ # form parameters
195
+ form_params = opts[:form_params] || {}
196
+
197
+ # http body (model)
198
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(create_webhook_request)
199
+
200
+ # return_type
201
+ return_type = opts[:debug_return_type] || 'WebhookCreateResponse'
202
+
203
+ # auth_names
204
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
205
+
206
+ new_options = opts.merge(
207
+ :operation => :"WebhooksApi.create_webhook",
208
+ :header_params => header_params,
209
+ :query_params => query_params,
210
+ :form_params => form_params,
211
+ :body => post_body,
212
+ :auth_names => auth_names,
213
+ :return_type => return_type
214
+ )
215
+
216
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
217
+ if @api_client.config.debugging
218
+ @api_client.config.logger.debug "API called: WebhooksApi#create_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
219
+ end
220
+ return data, status_code, headers
221
+ end
222
+
223
+ # Delete webhook
224
+ # Delete a webhook and clean up associated circuit breaker, rate limit, and metrics state.
225
+ # @param id [String] Webhook ID
226
+ # @param [Hash] opts the optional parameters
227
+ # @return [WebhookDeleteResponse]
228
+ def delete_webhook(id, opts = {})
229
+ data, _status_code, _headers = delete_webhook_with_http_info(id, opts)
230
+ data
231
+ end
232
+
233
+ # Delete webhook
234
+ # Delete a webhook and clean up associated circuit breaker, rate limit, and metrics state.
235
+ # @param id [String] Webhook ID
236
+ # @param [Hash] opts the optional parameters
237
+ # @return [Array<(WebhookDeleteResponse, Integer, Hash)>] WebhookDeleteResponse data, response status code and response headers
238
+ def delete_webhook_with_http_info(id, opts = {})
239
+ if @api_client.config.debugging
240
+ @api_client.config.logger.debug 'Calling API: WebhooksApi.delete_webhook ...'
241
+ end
242
+ # verify the required parameter 'id' is set
243
+ if @api_client.config.client_side_validation && id.nil?
244
+ fail ArgumentError, "Missing the required parameter 'id' when calling WebhooksApi.delete_webhook"
245
+ end
246
+ # resource path
247
+ local_var_path = '/v1/webhooks/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
248
+
249
+ # query parameters
250
+ query_params = opts[:query_params] || {}
251
+
252
+ # header parameters
253
+ header_params = opts[:header_params] || {}
254
+ # HTTP header 'Accept' (if needed)
255
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
256
+
257
+ # form parameters
258
+ form_params = opts[:form_params] || {}
259
+
260
+ # http body (model)
261
+ post_body = opts[:debug_body]
262
+
263
+ # return_type
264
+ return_type = opts[:debug_return_type] || 'WebhookDeleteResponse'
265
+
266
+ # auth_names
267
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
268
+
269
+ new_options = opts.merge(
270
+ :operation => :"WebhooksApi.delete_webhook",
271
+ :header_params => header_params,
272
+ :query_params => query_params,
273
+ :form_params => form_params,
274
+ :body => post_body,
275
+ :auth_names => auth_names,
276
+ :return_type => return_type
277
+ )
278
+
279
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
280
+ if @api_client.config.debugging
281
+ @api_client.config.logger.debug "API called: WebhooksApi#delete_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
282
+ end
283
+ return data, status_code, headers
284
+ end
285
+
286
+ # Get webhook
287
+ # Get a specific webhook by ID.
288
+ # @param id [String] Webhook ID
289
+ # @param [Hash] opts the optional parameters
290
+ # @return [WebhookResponse]
291
+ def get_webhook(id, opts = {})
292
+ data, _status_code, _headers = get_webhook_with_http_info(id, opts)
293
+ data
294
+ end
295
+
296
+ # Get webhook
297
+ # Get a specific webhook by ID.
298
+ # @param id [String] Webhook ID
299
+ # @param [Hash] opts the optional parameters
300
+ # @return [Array<(WebhookResponse, Integer, Hash)>] WebhookResponse data, response status code and response headers
301
+ def get_webhook_with_http_info(id, opts = {})
302
+ if @api_client.config.debugging
303
+ @api_client.config.logger.debug 'Calling API: WebhooksApi.get_webhook ...'
304
+ end
305
+ # verify the required parameter 'id' is set
306
+ if @api_client.config.client_side_validation && id.nil?
307
+ fail ArgumentError, "Missing the required parameter 'id' when calling WebhooksApi.get_webhook"
308
+ end
309
+ # resource path
310
+ local_var_path = '/v1/webhooks/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
311
+
312
+ # query parameters
313
+ query_params = opts[:query_params] || {}
314
+
315
+ # header parameters
316
+ header_params = opts[:header_params] || {}
317
+ # HTTP header 'Accept' (if needed)
318
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
319
+
320
+ # form parameters
321
+ form_params = opts[:form_params] || {}
322
+
323
+ # http body (model)
324
+ post_body = opts[:debug_body]
325
+
326
+ # return_type
327
+ return_type = opts[:debug_return_type] || 'WebhookResponse'
328
+
329
+ # auth_names
330
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
331
+
332
+ new_options = opts.merge(
333
+ :operation => :"WebhooksApi.get_webhook",
334
+ :header_params => header_params,
335
+ :query_params => query_params,
336
+ :form_params => form_params,
337
+ :body => post_body,
338
+ :auth_names => auth_names,
339
+ :return_type => return_type
340
+ )
341
+
342
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
343
+ if @api_client.config.debugging
344
+ @api_client.config.logger.debug "API called: WebhooksApi#get_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
345
+ end
346
+ return data, status_code, headers
347
+ end
348
+
349
+ # Get circuit breaker state
350
+ # Get the circuit breaker state for a webhook endpoint.
351
+ # @param id [String] Webhook ID
352
+ # @param [Hash] opts the optional parameters
353
+ # @return [WebhookCircuitStateResponse]
354
+ def get_webhook_circuit_state(id, opts = {})
355
+ data, _status_code, _headers = get_webhook_circuit_state_with_http_info(id, opts)
356
+ data
357
+ end
358
+
359
+ # Get circuit breaker state
360
+ # Get the circuit breaker state for a webhook endpoint.
361
+ # @param id [String] Webhook ID
362
+ # @param [Hash] opts the optional parameters
363
+ # @return [Array<(WebhookCircuitStateResponse, Integer, Hash)>] WebhookCircuitStateResponse data, response status code and response headers
364
+ def get_webhook_circuit_state_with_http_info(id, opts = {})
365
+ if @api_client.config.debugging
366
+ @api_client.config.logger.debug 'Calling API: WebhooksApi.get_webhook_circuit_state ...'
367
+ end
368
+ # verify the required parameter 'id' is set
369
+ if @api_client.config.client_side_validation && id.nil?
370
+ fail ArgumentError, "Missing the required parameter 'id' when calling WebhooksApi.get_webhook_circuit_state"
371
+ end
372
+ # resource path
373
+ local_var_path = '/v1/webhooks/{id}/circuit'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
374
+
375
+ # query parameters
376
+ query_params = opts[:query_params] || {}
377
+
378
+ # header parameters
379
+ header_params = opts[:header_params] || {}
380
+ # HTTP header 'Accept' (if needed)
381
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
382
+
383
+ # form parameters
384
+ form_params = opts[:form_params] || {}
385
+
386
+ # http body (model)
387
+ post_body = opts[:debug_body]
388
+
389
+ # return_type
390
+ return_type = opts[:debug_return_type] || 'WebhookCircuitStateResponse'
391
+
392
+ # auth_names
393
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
394
+
395
+ new_options = opts.merge(
396
+ :operation => :"WebhooksApi.get_webhook_circuit_state",
397
+ :header_params => header_params,
398
+ :query_params => query_params,
399
+ :form_params => form_params,
400
+ :body => post_body,
401
+ :auth_names => auth_names,
402
+ :return_type => return_type
403
+ )
404
+
405
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
406
+ if @api_client.config.debugging
407
+ @api_client.config.logger.debug "API called: WebhooksApi#get_webhook_circuit_state\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
408
+ end
409
+ return data, status_code, headers
410
+ end
411
+
412
+ # Get webhook delivery details
413
+ # Get a single delivery with full details including payload, headers, and response for debugging.
414
+ # @param id [String] Webhook ID
415
+ # @param delivery_id [String] Delivery ID
416
+ # @param [Hash] opts the optional parameters
417
+ # @return [WebhookDeliveryResponse]
418
+ def get_webhook_delivery(id, delivery_id, opts = {})
419
+ data, _status_code, _headers = get_webhook_delivery_with_http_info(id, delivery_id, opts)
420
+ data
421
+ end
422
+
423
+ # Get webhook delivery details
424
+ # Get a single delivery with full details including payload, headers, and response for debugging.
425
+ # @param id [String] Webhook ID
426
+ # @param delivery_id [String] Delivery ID
427
+ # @param [Hash] opts the optional parameters
428
+ # @return [Array<(WebhookDeliveryResponse, Integer, Hash)>] WebhookDeliveryResponse data, response status code and response headers
429
+ def get_webhook_delivery_with_http_info(id, delivery_id, opts = {})
430
+ if @api_client.config.debugging
431
+ @api_client.config.logger.debug 'Calling API: WebhooksApi.get_webhook_delivery ...'
432
+ end
433
+ # verify the required parameter 'id' is set
434
+ if @api_client.config.client_side_validation && id.nil?
435
+ fail ArgumentError, "Missing the required parameter 'id' when calling WebhooksApi.get_webhook_delivery"
436
+ end
437
+ # verify the required parameter 'delivery_id' is set
438
+ if @api_client.config.client_side_validation && delivery_id.nil?
439
+ fail ArgumentError, "Missing the required parameter 'delivery_id' when calling WebhooksApi.get_webhook_delivery"
440
+ end
441
+ # resource path
442
+ local_var_path = '/v1/webhooks/{id}/deliveries/{deliveryId}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'deliveryId' + '}', CGI.escape(delivery_id.to_s))
443
+
444
+ # query parameters
445
+ query_params = opts[:query_params] || {}
446
+
447
+ # header parameters
448
+ header_params = opts[:header_params] || {}
449
+ # HTTP header 'Accept' (if needed)
450
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
451
+
452
+ # form parameters
453
+ form_params = opts[:form_params] || {}
454
+
455
+ # http body (model)
456
+ post_body = opts[:debug_body]
457
+
458
+ # return_type
459
+ return_type = opts[:debug_return_type] || 'WebhookDeliveryResponse'
460
+
461
+ # auth_names
462
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
463
+
464
+ new_options = opts.merge(
465
+ :operation => :"WebhooksApi.get_webhook_delivery",
466
+ :header_params => header_params,
467
+ :query_params => query_params,
468
+ :form_params => form_params,
469
+ :body => post_body,
470
+ :auth_names => auth_names,
471
+ :return_type => return_type
472
+ )
473
+
474
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
475
+ if @api_client.config.debugging
476
+ @api_client.config.logger.debug "API called: WebhooksApi#get_webhook_delivery\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
477
+ end
478
+ return data, status_code, headers
479
+ end
480
+
481
+ # Get static webhook IPs
482
+ # Get static IP addresses used for webhook deliveries. Requires dedicated_ip plan feature (Scale/Enterprise).
483
+ # @param [Hash] opts the optional parameters
484
+ # @return [WebhookIpsResponse]
485
+ def get_webhook_ips(opts = {})
486
+ data, _status_code, _headers = get_webhook_ips_with_http_info(opts)
487
+ data
488
+ end
489
+
490
+ # Get static webhook IPs
491
+ # Get static IP addresses used for webhook deliveries. Requires dedicated_ip plan feature (Scale/Enterprise).
492
+ # @param [Hash] opts the optional parameters
493
+ # @return [Array<(WebhookIpsResponse, Integer, Hash)>] WebhookIpsResponse data, response status code and response headers
494
+ def get_webhook_ips_with_http_info(opts = {})
495
+ if @api_client.config.debugging
496
+ @api_client.config.logger.debug 'Calling API: WebhooksApi.get_webhook_ips ...'
497
+ end
498
+ # resource path
499
+ local_var_path = '/v1/webhooks/ips'
500
+
501
+ # query parameters
502
+ query_params = opts[:query_params] || {}
503
+
504
+ # header parameters
505
+ header_params = opts[:header_params] || {}
506
+ # HTTP header 'Accept' (if needed)
507
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
508
+
509
+ # form parameters
510
+ form_params = opts[:form_params] || {}
511
+
512
+ # http body (model)
513
+ post_body = opts[:debug_body]
514
+
515
+ # return_type
516
+ return_type = opts[:debug_return_type] || 'WebhookIpsResponse'
517
+
518
+ # auth_names
519
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
520
+
521
+ new_options = opts.merge(
522
+ :operation => :"WebhooksApi.get_webhook_ips",
523
+ :header_params => header_params,
524
+ :query_params => query_params,
525
+ :form_params => form_params,
526
+ :body => post_body,
527
+ :auth_names => auth_names,
528
+ :return_type => return_type
529
+ )
530
+
531
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
532
+ if @api_client.config.debugging
533
+ @api_client.config.logger.debug "API called: WebhooksApi#get_webhook_ips\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
534
+ end
535
+ return data, status_code, headers
536
+ end
537
+
538
+ # Get replay/retry job status
539
+ # Get the status of a replay or bulk retry job.
540
+ # @param job_id [String] Job ID
541
+ # @param [Hash] opts the optional parameters
542
+ # @return [WebhookJobResponse]
543
+ def get_webhook_job(job_id, opts = {})
544
+ data, _status_code, _headers = get_webhook_job_with_http_info(job_id, opts)
545
+ data
546
+ end
547
+
548
+ # Get replay/retry job status
549
+ # Get the status of a replay or bulk retry job.
550
+ # @param job_id [String] Job ID
551
+ # @param [Hash] opts the optional parameters
552
+ # @return [Array<(WebhookJobResponse, Integer, Hash)>] WebhookJobResponse data, response status code and response headers
553
+ def get_webhook_job_with_http_info(job_id, opts = {})
554
+ if @api_client.config.debugging
555
+ @api_client.config.logger.debug 'Calling API: WebhooksApi.get_webhook_job ...'
556
+ end
557
+ # verify the required parameter 'job_id' is set
558
+ if @api_client.config.client_side_validation && job_id.nil?
559
+ fail ArgumentError, "Missing the required parameter 'job_id' when calling WebhooksApi.get_webhook_job"
560
+ end
561
+ # resource path
562
+ local_var_path = '/v1/webhooks/jobs/{jobId}'.sub('{' + 'jobId' + '}', CGI.escape(job_id.to_s))
563
+
564
+ # query parameters
565
+ query_params = opts[:query_params] || {}
566
+
567
+ # header parameters
568
+ header_params = opts[:header_params] || {}
569
+ # HTTP header 'Accept' (if needed)
570
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
571
+
572
+ # form parameters
573
+ form_params = opts[:form_params] || {}
574
+
575
+ # http body (model)
576
+ post_body = opts[:debug_body]
577
+
578
+ # return_type
579
+ return_type = opts[:debug_return_type] || 'WebhookJobResponse'
580
+
581
+ # auth_names
582
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
583
+
584
+ new_options = opts.merge(
585
+ :operation => :"WebhooksApi.get_webhook_job",
586
+ :header_params => header_params,
587
+ :query_params => query_params,
588
+ :form_params => form_params,
589
+ :body => post_body,
590
+ :auth_names => auth_names,
591
+ :return_type => return_type
592
+ )
593
+
594
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
595
+ if @api_client.config.debugging
596
+ @api_client.config.logger.debug "API called: WebhooksApi#get_webhook_job\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
597
+ end
598
+ return data, status_code, headers
599
+ end
600
+
601
+ # Get webhook health metrics
602
+ # Get health and performance metrics for a specific webhook endpoint.
603
+ # @param id [String] Webhook ID
604
+ # @param [Hash] opts the optional parameters
605
+ # @return [WebhookMetricsResponse]
606
+ def get_webhook_metrics(id, opts = {})
607
+ data, _status_code, _headers = get_webhook_metrics_with_http_info(id, opts)
608
+ data
609
+ end
610
+
611
+ # Get webhook health metrics
612
+ # Get health and performance metrics for a specific webhook endpoint.
613
+ # @param id [String] Webhook ID
614
+ # @param [Hash] opts the optional parameters
615
+ # @return [Array<(WebhookMetricsResponse, Integer, Hash)>] WebhookMetricsResponse data, response status code and response headers
616
+ def get_webhook_metrics_with_http_info(id, opts = {})
617
+ if @api_client.config.debugging
618
+ @api_client.config.logger.debug 'Calling API: WebhooksApi.get_webhook_metrics ...'
619
+ end
620
+ # verify the required parameter 'id' is set
621
+ if @api_client.config.client_side_validation && id.nil?
622
+ fail ArgumentError, "Missing the required parameter 'id' when calling WebhooksApi.get_webhook_metrics"
623
+ end
624
+ # resource path
625
+ local_var_path = '/v1/webhooks/{id}/metrics'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
626
+
627
+ # query parameters
628
+ query_params = opts[:query_params] || {}
629
+
630
+ # header parameters
631
+ header_params = opts[:header_params] || {}
632
+ # HTTP header 'Accept' (if needed)
633
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
634
+
635
+ # form parameters
636
+ form_params = opts[:form_params] || {}
637
+
638
+ # http body (model)
639
+ post_body = opts[:debug_body]
640
+
641
+ # return_type
642
+ return_type = opts[:debug_return_type] || 'WebhookMetricsResponse'
643
+
644
+ # auth_names
645
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
646
+
647
+ new_options = opts.merge(
648
+ :operation => :"WebhooksApi.get_webhook_metrics",
649
+ :header_params => header_params,
650
+ :query_params => query_params,
651
+ :form_params => form_params,
652
+ :body => post_body,
653
+ :auth_names => auth_names,
654
+ :return_type => return_type
655
+ )
656
+
657
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
658
+ if @api_client.config.debugging
659
+ @api_client.config.logger.debug "API called: WebhooksApi#get_webhook_metrics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
660
+ end
661
+ return data, status_code, headers
662
+ end
663
+
664
+ # Get available webhook regions
665
+ # Get available webhook delivery regions. Requires multi_region plan feature (Enterprise only).
666
+ # @param [Hash] opts the optional parameters
667
+ # @return [WebhookRegionsResponse]
668
+ def get_webhook_regions(opts = {})
669
+ data, _status_code, _headers = get_webhook_regions_with_http_info(opts)
670
+ data
671
+ end
672
+
673
+ # Get available webhook regions
674
+ # Get available webhook delivery regions. Requires multi_region plan feature (Enterprise only).
675
+ # @param [Hash] opts the optional parameters
676
+ # @return [Array<(WebhookRegionsResponse, Integer, Hash)>] WebhookRegionsResponse data, response status code and response headers
677
+ def get_webhook_regions_with_http_info(opts = {})
678
+ if @api_client.config.debugging
679
+ @api_client.config.logger.debug 'Calling API: WebhooksApi.get_webhook_regions ...'
680
+ end
681
+ # resource path
682
+ local_var_path = '/v1/webhooks/regions'
683
+
684
+ # query parameters
685
+ query_params = opts[:query_params] || {}
686
+
687
+ # header parameters
688
+ header_params = opts[:header_params] || {}
689
+ # HTTP header 'Accept' (if needed)
690
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
691
+
692
+ # form parameters
693
+ form_params = opts[:form_params] || {}
694
+
695
+ # http body (model)
696
+ post_body = opts[:debug_body]
697
+
698
+ # return_type
699
+ return_type = opts[:debug_return_type] || 'WebhookRegionsResponse'
700
+
701
+ # auth_names
702
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
703
+
704
+ new_options = opts.merge(
705
+ :operation => :"WebhooksApi.get_webhook_regions",
706
+ :header_params => header_params,
707
+ :query_params => query_params,
708
+ :form_params => form_params,
709
+ :body => post_body,
710
+ :auth_names => auth_names,
711
+ :return_type => return_type
712
+ )
713
+
714
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
715
+ if @api_client.config.debugging
716
+ @api_client.config.logger.debug "API called: WebhooksApi#get_webhook_regions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
717
+ end
718
+ return data, status_code, headers
719
+ end
720
+
721
+ # Get webhook usage metrics
722
+ # Get webhook delivery usage statistics for the current billing period.
723
+ # @param [Hash] opts the optional parameters
724
+ # @return [WebhookUsageResponse]
725
+ def get_webhook_usage(opts = {})
726
+ data, _status_code, _headers = get_webhook_usage_with_http_info(opts)
727
+ data
728
+ end
729
+
730
+ # Get webhook usage metrics
731
+ # Get webhook delivery usage statistics for the current billing period.
732
+ # @param [Hash] opts the optional parameters
733
+ # @return [Array<(WebhookUsageResponse, Integer, Hash)>] WebhookUsageResponse data, response status code and response headers
734
+ def get_webhook_usage_with_http_info(opts = {})
735
+ if @api_client.config.debugging
736
+ @api_client.config.logger.debug 'Calling API: WebhooksApi.get_webhook_usage ...'
737
+ end
738
+ # resource path
739
+ local_var_path = '/v1/webhooks/usage'
740
+
741
+ # query parameters
742
+ query_params = opts[:query_params] || {}
743
+
744
+ # header parameters
745
+ header_params = opts[:header_params] || {}
746
+ # HTTP header 'Accept' (if needed)
747
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
748
+
749
+ # form parameters
750
+ form_params = opts[:form_params] || {}
751
+
752
+ # http body (model)
753
+ post_body = opts[:debug_body]
754
+
755
+ # return_type
756
+ return_type = opts[:debug_return_type] || 'WebhookUsageResponse'
757
+
758
+ # auth_names
759
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
760
+
761
+ new_options = opts.merge(
762
+ :operation => :"WebhooksApi.get_webhook_usage",
763
+ :header_params => header_params,
764
+ :query_params => query_params,
765
+ :form_params => form_params,
766
+ :body => post_body,
767
+ :auth_names => auth_names,
768
+ :return_type => return_type
769
+ )
770
+
771
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
772
+ if @api_client.config.debugging
773
+ @api_client.config.logger.debug "API called: WebhooksApi#get_webhook_usage\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
774
+ end
775
+ return data, status_code, headers
776
+ end
777
+
778
+ # Get workspace webhook metrics
779
+ # Get aggregate webhook health and performance metrics for the entire workspace.
780
+ # @param [Hash] opts the optional parameters
781
+ # @return [WebhookWorkspaceMetricsResponse]
782
+ def get_workspace_webhook_metrics(opts = {})
783
+ data, _status_code, _headers = get_workspace_webhook_metrics_with_http_info(opts)
784
+ data
785
+ end
786
+
787
+ # Get workspace webhook metrics
788
+ # Get aggregate webhook health and performance metrics for the entire workspace.
789
+ # @param [Hash] opts the optional parameters
790
+ # @return [Array<(WebhookWorkspaceMetricsResponse, Integer, Hash)>] WebhookWorkspaceMetricsResponse data, response status code and response headers
791
+ def get_workspace_webhook_metrics_with_http_info(opts = {})
792
+ if @api_client.config.debugging
793
+ @api_client.config.logger.debug 'Calling API: WebhooksApi.get_workspace_webhook_metrics ...'
794
+ end
795
+ # resource path
796
+ local_var_path = '/v1/webhooks/metrics'
797
+
798
+ # query parameters
799
+ query_params = opts[:query_params] || {}
800
+
801
+ # header parameters
802
+ header_params = opts[:header_params] || {}
803
+ # HTTP header 'Accept' (if needed)
804
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
805
+
806
+ # form parameters
807
+ form_params = opts[:form_params] || {}
808
+
809
+ # http body (model)
810
+ post_body = opts[:debug_body]
811
+
812
+ # return_type
813
+ return_type = opts[:debug_return_type] || 'WebhookWorkspaceMetricsResponse'
814
+
815
+ # auth_names
816
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
817
+
818
+ new_options = opts.merge(
819
+ :operation => :"WebhooksApi.get_workspace_webhook_metrics",
820
+ :header_params => header_params,
821
+ :query_params => query_params,
822
+ :form_params => form_params,
823
+ :body => post_body,
824
+ :auth_names => auth_names,
825
+ :return_type => return_type
826
+ )
827
+
828
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
829
+ if @api_client.config.debugging
830
+ @api_client.config.logger.debug "API called: WebhooksApi#get_workspace_webhook_metrics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
831
+ end
832
+ return data, status_code, headers
833
+ end
834
+
835
+ # List webhook deliveries
836
+ # List delivery attempts for a webhook with filtering and pagination.
837
+ # @param id [String] Webhook ID
838
+ # @param [Hash] opts the optional parameters
839
+ # @option opts [String] :status Filter by delivery status
840
+ # @option opts [String] :event_type Filter by event type
841
+ # @option opts [String] :search Search deliveries
842
+ # @option opts [Time] :start_date Filter deliveries after this date
843
+ # @option opts [Time] :end_date Filter deliveries before this date
844
+ # @option opts [Integer] :limit Maximum number of deliveries to return (default to 50)
845
+ # @option opts [Integer] :offset Number of deliveries to skip (default to 0)
846
+ # @return [WebhookDeliveryListResponse]
847
+ def list_webhook_deliveries(id, opts = {})
848
+ data, _status_code, _headers = list_webhook_deliveries_with_http_info(id, opts)
849
+ data
850
+ end
851
+
852
+ # List webhook deliveries
853
+ # List delivery attempts for a webhook with filtering and pagination.
854
+ # @param id [String] Webhook ID
855
+ # @param [Hash] opts the optional parameters
856
+ # @option opts [String] :status Filter by delivery status
857
+ # @option opts [String] :event_type Filter by event type
858
+ # @option opts [String] :search Search deliveries
859
+ # @option opts [Time] :start_date Filter deliveries after this date
860
+ # @option opts [Time] :end_date Filter deliveries before this date
861
+ # @option opts [Integer] :limit Maximum number of deliveries to return (default to 50)
862
+ # @option opts [Integer] :offset Number of deliveries to skip (default to 0)
863
+ # @return [Array<(WebhookDeliveryListResponse, Integer, Hash)>] WebhookDeliveryListResponse data, response status code and response headers
864
+ def list_webhook_deliveries_with_http_info(id, opts = {})
865
+ if @api_client.config.debugging
866
+ @api_client.config.logger.debug 'Calling API: WebhooksApi.list_webhook_deliveries ...'
867
+ end
868
+ # verify the required parameter 'id' is set
869
+ if @api_client.config.client_side_validation && id.nil?
870
+ fail ArgumentError, "Missing the required parameter 'id' when calling WebhooksApi.list_webhook_deliveries"
871
+ end
872
+ allowable_values = ["pending", "delivering", "delivered", "failed", "exhausted"]
873
+ if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
874
+ fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
875
+ end
876
+ # resource path
877
+ local_var_path = '/v1/webhooks/{id}/deliveries'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
878
+
879
+ # query parameters
880
+ query_params = opts[:query_params] || {}
881
+ query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
882
+ query_params[:'event_type'] = opts[:'event_type'] if !opts[:'event_type'].nil?
883
+ query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
884
+ query_params[:'start_date'] = opts[:'start_date'] if !opts[:'start_date'].nil?
885
+ query_params[:'end_date'] = opts[:'end_date'] if !opts[:'end_date'].nil?
886
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
887
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
888
+
889
+ # header parameters
890
+ header_params = opts[:header_params] || {}
891
+ # HTTP header 'Accept' (if needed)
892
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
893
+
894
+ # form parameters
895
+ form_params = opts[:form_params] || {}
896
+
897
+ # http body (model)
898
+ post_body = opts[:debug_body]
899
+
900
+ # return_type
901
+ return_type = opts[:debug_return_type] || 'WebhookDeliveryListResponse'
902
+
903
+ # auth_names
904
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
905
+
906
+ new_options = opts.merge(
907
+ :operation => :"WebhooksApi.list_webhook_deliveries",
908
+ :header_params => header_params,
909
+ :query_params => query_params,
910
+ :form_params => form_params,
911
+ :body => post_body,
912
+ :auth_names => auth_names,
913
+ :return_type => return_type
914
+ )
915
+
916
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
917
+ if @api_client.config.debugging
918
+ @api_client.config.logger.debug "API called: WebhooksApi#list_webhook_deliveries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
919
+ end
920
+ return data, status_code, headers
921
+ end
922
+
923
+ # List webhook event types
924
+ # List available webhook event types with full registry information. Optionally filter by category.
925
+ # @param [Hash] opts the optional parameters
926
+ # @option opts [String] :category Filter event types by category
927
+ # @return [WebhookEventTypesResponse]
928
+ def list_webhook_event_types(opts = {})
929
+ data, _status_code, _headers = list_webhook_event_types_with_http_info(opts)
930
+ data
931
+ end
932
+
933
+ # List webhook event types
934
+ # List available webhook event types with full registry information. Optionally filter by category.
935
+ # @param [Hash] opts the optional parameters
936
+ # @option opts [String] :category Filter event types by category
937
+ # @return [Array<(WebhookEventTypesResponse, Integer, Hash)>] WebhookEventTypesResponse data, response status code and response headers
938
+ def list_webhook_event_types_with_http_info(opts = {})
939
+ if @api_client.config.debugging
940
+ @api_client.config.logger.debug 'Calling API: WebhooksApi.list_webhook_event_types ...'
941
+ end
942
+ # resource path
943
+ local_var_path = '/v1/webhooks/events'
944
+
945
+ # query parameters
946
+ query_params = opts[:query_params] || {}
947
+ query_params[:'category'] = opts[:'category'] if !opts[:'category'].nil?
948
+
949
+ # header parameters
950
+ header_params = opts[:header_params] || {}
951
+ # HTTP header 'Accept' (if needed)
952
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
953
+
954
+ # form parameters
955
+ form_params = opts[:form_params] || {}
956
+
957
+ # http body (model)
958
+ post_body = opts[:debug_body]
959
+
960
+ # return_type
961
+ return_type = opts[:debug_return_type] || 'WebhookEventTypesResponse'
962
+
963
+ # auth_names
964
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
965
+
966
+ new_options = opts.merge(
967
+ :operation => :"WebhooksApi.list_webhook_event_types",
968
+ :header_params => header_params,
969
+ :query_params => query_params,
970
+ :form_params => form_params,
971
+ :body => post_body,
972
+ :auth_names => auth_names,
973
+ :return_type => return_type
974
+ )
975
+
976
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
977
+ if @api_client.config.debugging
978
+ @api_client.config.logger.debug "API called: WebhooksApi#list_webhook_event_types\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
979
+ end
980
+ return data, status_code, headers
981
+ end
982
+
983
+ # List webhook API versions
984
+ # List available webhook API versions with changelog and deprecation info.
985
+ # @param [Hash] opts the optional parameters
986
+ # @return [WebhookVersionsResponse]
987
+ def list_webhook_versions(opts = {})
988
+ data, _status_code, _headers = list_webhook_versions_with_http_info(opts)
989
+ data
990
+ end
991
+
992
+ # List webhook API versions
993
+ # List available webhook API versions with changelog and deprecation info.
994
+ # @param [Hash] opts the optional parameters
995
+ # @return [Array<(WebhookVersionsResponse, Integer, Hash)>] WebhookVersionsResponse data, response status code and response headers
996
+ def list_webhook_versions_with_http_info(opts = {})
997
+ if @api_client.config.debugging
998
+ @api_client.config.logger.debug 'Calling API: WebhooksApi.list_webhook_versions ...'
999
+ end
1000
+ # resource path
1001
+ local_var_path = '/v1/webhooks/versions'
1002
+
1003
+ # query parameters
1004
+ query_params = opts[:query_params] || {}
1005
+
1006
+ # header parameters
1007
+ header_params = opts[:header_params] || {}
1008
+ # HTTP header 'Accept' (if needed)
1009
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1010
+
1011
+ # form parameters
1012
+ form_params = opts[:form_params] || {}
1013
+
1014
+ # http body (model)
1015
+ post_body = opts[:debug_body]
1016
+
1017
+ # return_type
1018
+ return_type = opts[:debug_return_type] || 'WebhookVersionsResponse'
1019
+
1020
+ # auth_names
1021
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
1022
+
1023
+ new_options = opts.merge(
1024
+ :operation => :"WebhooksApi.list_webhook_versions",
1025
+ :header_params => header_params,
1026
+ :query_params => query_params,
1027
+ :form_params => form_params,
1028
+ :body => post_body,
1029
+ :auth_names => auth_names,
1030
+ :return_type => return_type
1031
+ )
1032
+
1033
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1034
+ if @api_client.config.debugging
1035
+ @api_client.config.logger.debug "API called: WebhooksApi#list_webhook_versions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1036
+ end
1037
+ return data, status_code, headers
1038
+ end
1039
+
1040
+ # List webhooks
1041
+ # List all webhooks for the workspace with pagination.
1042
+ # @param [Hash] opts the optional parameters
1043
+ # @option opts [Integer] :limit Maximum number of webhooks to return (default to 50)
1044
+ # @option opts [Integer] :offset Number of webhooks to skip (default to 0)
1045
+ # @return [WebhookListResponse]
1046
+ def list_webhooks(opts = {})
1047
+ data, _status_code, _headers = list_webhooks_with_http_info(opts)
1048
+ data
1049
+ end
1050
+
1051
+ # List webhooks
1052
+ # List all webhooks for the workspace with pagination.
1053
+ # @param [Hash] opts the optional parameters
1054
+ # @option opts [Integer] :limit Maximum number of webhooks to return (default to 50)
1055
+ # @option opts [Integer] :offset Number of webhooks to skip (default to 0)
1056
+ # @return [Array<(WebhookListResponse, Integer, Hash)>] WebhookListResponse data, response status code and response headers
1057
+ def list_webhooks_with_http_info(opts = {})
1058
+ if @api_client.config.debugging
1059
+ @api_client.config.logger.debug 'Calling API: WebhooksApi.list_webhooks ...'
1060
+ end
1061
+ # resource path
1062
+ local_var_path = '/v1/webhooks'
1063
+
1064
+ # query parameters
1065
+ query_params = opts[:query_params] || {}
1066
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
1067
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
1068
+
1069
+ # header parameters
1070
+ header_params = opts[:header_params] || {}
1071
+ # HTTP header 'Accept' (if needed)
1072
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1073
+
1074
+ # form parameters
1075
+ form_params = opts[:form_params] || {}
1076
+
1077
+ # http body (model)
1078
+ post_body = opts[:debug_body]
1079
+
1080
+ # return_type
1081
+ return_type = opts[:debug_return_type] || 'WebhookListResponse'
1082
+
1083
+ # auth_names
1084
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
1085
+
1086
+ new_options = opts.merge(
1087
+ :operation => :"WebhooksApi.list_webhooks",
1088
+ :header_params => header_params,
1089
+ :query_params => query_params,
1090
+ :form_params => form_params,
1091
+ :body => post_body,
1092
+ :auth_names => auth_names,
1093
+ :return_type => return_type
1094
+ )
1095
+
1096
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
1097
+ if @api_client.config.debugging
1098
+ @api_client.config.logger.debug "API called: WebhooksApi#list_webhooks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1099
+ end
1100
+ return data, status_code, headers
1101
+ end
1102
+
1103
+ # Replay webhook events
1104
+ # Replay events for a webhook within a date range. Creates an asynchronous job that re-delivers matching events.
1105
+ # @param id [String] Webhook ID
1106
+ # @param replay_webhook_events_request [ReplayWebhookEventsRequest]
1107
+ # @param [Hash] opts the optional parameters
1108
+ # @return [WebhookReplayResponse]
1109
+ def replay_webhook_events(id, replay_webhook_events_request, opts = {})
1110
+ data, _status_code, _headers = replay_webhook_events_with_http_info(id, replay_webhook_events_request, opts)
1111
+ data
1112
+ end
1113
+
1114
+ # Replay webhook events
1115
+ # Replay events for a webhook within a date range. Creates an asynchronous job that re-delivers matching events.
1116
+ # @param id [String] Webhook ID
1117
+ # @param replay_webhook_events_request [ReplayWebhookEventsRequest]
1118
+ # @param [Hash] opts the optional parameters
1119
+ # @return [Array<(WebhookReplayResponse, Integer, Hash)>] WebhookReplayResponse data, response status code and response headers
1120
+ def replay_webhook_events_with_http_info(id, replay_webhook_events_request, opts = {})
1121
+ if @api_client.config.debugging
1122
+ @api_client.config.logger.debug 'Calling API: WebhooksApi.replay_webhook_events ...'
1123
+ end
1124
+ # verify the required parameter 'id' is set
1125
+ if @api_client.config.client_side_validation && id.nil?
1126
+ fail ArgumentError, "Missing the required parameter 'id' when calling WebhooksApi.replay_webhook_events"
1127
+ end
1128
+ # verify the required parameter 'replay_webhook_events_request' is set
1129
+ if @api_client.config.client_side_validation && replay_webhook_events_request.nil?
1130
+ fail ArgumentError, "Missing the required parameter 'replay_webhook_events_request' when calling WebhooksApi.replay_webhook_events"
1131
+ end
1132
+ # resource path
1133
+ local_var_path = '/v1/webhooks/{id}/replay'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1134
+
1135
+ # query parameters
1136
+ query_params = opts[:query_params] || {}
1137
+
1138
+ # header parameters
1139
+ header_params = opts[:header_params] || {}
1140
+ # HTTP header 'Accept' (if needed)
1141
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1142
+ # HTTP header 'Content-Type'
1143
+ content_type = @api_client.select_header_content_type(['application/json'])
1144
+ if !content_type.nil?
1145
+ header_params['Content-Type'] = content_type
1146
+ end
1147
+
1148
+ # form parameters
1149
+ form_params = opts[:form_params] || {}
1150
+
1151
+ # http body (model)
1152
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(replay_webhook_events_request)
1153
+
1154
+ # return_type
1155
+ return_type = opts[:debug_return_type] || 'WebhookReplayResponse'
1156
+
1157
+ # auth_names
1158
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
1159
+
1160
+ new_options = opts.merge(
1161
+ :operation => :"WebhooksApi.replay_webhook_events",
1162
+ :header_params => header_params,
1163
+ :query_params => query_params,
1164
+ :form_params => form_params,
1165
+ :body => post_body,
1166
+ :auth_names => auth_names,
1167
+ :return_type => return_type
1168
+ )
1169
+
1170
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1171
+ if @api_client.config.debugging
1172
+ @api_client.config.logger.debug "API called: WebhooksApi#replay_webhook_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1173
+ end
1174
+ return data, status_code, headers
1175
+ end
1176
+
1177
+ # Retry webhook delivery
1178
+ # Retry a failed or exhausted webhook delivery. Only deliveries with status 'failed' or 'exhausted' can be retried.
1179
+ # @param id [String] Webhook ID
1180
+ # @param delivery_id [String] Delivery ID
1181
+ # @param [Hash] opts the optional parameters
1182
+ # @return [WebhookDeliveryRetryResponse]
1183
+ def retry_webhook_delivery(id, delivery_id, opts = {})
1184
+ data, _status_code, _headers = retry_webhook_delivery_with_http_info(id, delivery_id, opts)
1185
+ data
1186
+ end
1187
+
1188
+ # Retry webhook delivery
1189
+ # Retry a failed or exhausted webhook delivery. Only deliveries with status &#39;failed&#39; or &#39;exhausted&#39; can be retried.
1190
+ # @param id [String] Webhook ID
1191
+ # @param delivery_id [String] Delivery ID
1192
+ # @param [Hash] opts the optional parameters
1193
+ # @return [Array<(WebhookDeliveryRetryResponse, Integer, Hash)>] WebhookDeliveryRetryResponse data, response status code and response headers
1194
+ def retry_webhook_delivery_with_http_info(id, delivery_id, opts = {})
1195
+ if @api_client.config.debugging
1196
+ @api_client.config.logger.debug 'Calling API: WebhooksApi.retry_webhook_delivery ...'
1197
+ end
1198
+ # verify the required parameter 'id' is set
1199
+ if @api_client.config.client_side_validation && id.nil?
1200
+ fail ArgumentError, "Missing the required parameter 'id' when calling WebhooksApi.retry_webhook_delivery"
1201
+ end
1202
+ # verify the required parameter 'delivery_id' is set
1203
+ if @api_client.config.client_side_validation && delivery_id.nil?
1204
+ fail ArgumentError, "Missing the required parameter 'delivery_id' when calling WebhooksApi.retry_webhook_delivery"
1205
+ end
1206
+ # resource path
1207
+ local_var_path = '/v1/webhooks/{id}/deliveries/{deliveryId}/retry'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'deliveryId' + '}', CGI.escape(delivery_id.to_s))
1208
+
1209
+ # query parameters
1210
+ query_params = opts[:query_params] || {}
1211
+
1212
+ # header parameters
1213
+ header_params = opts[:header_params] || {}
1214
+ # HTTP header 'Accept' (if needed)
1215
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1216
+
1217
+ # form parameters
1218
+ form_params = opts[:form_params] || {}
1219
+
1220
+ # http body (model)
1221
+ post_body = opts[:debug_body]
1222
+
1223
+ # return_type
1224
+ return_type = opts[:debug_return_type] || 'WebhookDeliveryRetryResponse'
1225
+
1226
+ # auth_names
1227
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
1228
+
1229
+ new_options = opts.merge(
1230
+ :operation => :"WebhooksApi.retry_webhook_delivery",
1231
+ :header_params => header_params,
1232
+ :query_params => query_params,
1233
+ :form_params => form_params,
1234
+ :body => post_body,
1235
+ :auth_names => auth_names,
1236
+ :return_type => return_type
1237
+ )
1238
+
1239
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1240
+ if @api_client.config.debugging
1241
+ @api_client.config.logger.debug "API called: WebhooksApi#retry_webhook_delivery\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1242
+ end
1243
+ return data, status_code, headers
1244
+ end
1245
+
1246
+ # Rotate webhook secret
1247
+ # Rotate the signing secret for a webhook. The new secret is only returned once.
1248
+ # @param id [String] Webhook ID
1249
+ # @param [Hash] opts the optional parameters
1250
+ # @return [WebhookSecretRotateResponse]
1251
+ def rotate_webhook_secret(id, opts = {})
1252
+ data, _status_code, _headers = rotate_webhook_secret_with_http_info(id, opts)
1253
+ data
1254
+ end
1255
+
1256
+ # Rotate webhook secret
1257
+ # Rotate the signing secret for a webhook. The new secret is only returned once.
1258
+ # @param id [String] Webhook ID
1259
+ # @param [Hash] opts the optional parameters
1260
+ # @return [Array<(WebhookSecretRotateResponse, Integer, Hash)>] WebhookSecretRotateResponse data, response status code and response headers
1261
+ def rotate_webhook_secret_with_http_info(id, opts = {})
1262
+ if @api_client.config.debugging
1263
+ @api_client.config.logger.debug 'Calling API: WebhooksApi.rotate_webhook_secret ...'
1264
+ end
1265
+ # verify the required parameter 'id' is set
1266
+ if @api_client.config.client_side_validation && id.nil?
1267
+ fail ArgumentError, "Missing the required parameter 'id' when calling WebhooksApi.rotate_webhook_secret"
1268
+ end
1269
+ # resource path
1270
+ local_var_path = '/v1/webhooks/{id}/rotate-secret'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1271
+
1272
+ # query parameters
1273
+ query_params = opts[:query_params] || {}
1274
+
1275
+ # header parameters
1276
+ header_params = opts[:header_params] || {}
1277
+ # HTTP header 'Accept' (if needed)
1278
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1279
+
1280
+ # form parameters
1281
+ form_params = opts[:form_params] || {}
1282
+
1283
+ # http body (model)
1284
+ post_body = opts[:debug_body]
1285
+
1286
+ # return_type
1287
+ return_type = opts[:debug_return_type] || 'WebhookSecretRotateResponse'
1288
+
1289
+ # auth_names
1290
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
1291
+
1292
+ new_options = opts.merge(
1293
+ :operation => :"WebhooksApi.rotate_webhook_secret",
1294
+ :header_params => header_params,
1295
+ :query_params => query_params,
1296
+ :form_params => form_params,
1297
+ :body => post_body,
1298
+ :auth_names => auth_names,
1299
+ :return_type => return_type
1300
+ )
1301
+
1302
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1303
+ if @api_client.config.debugging
1304
+ @api_client.config.logger.debug "API called: WebhooksApi#rotate_webhook_secret\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1305
+ end
1306
+ return data, status_code, headers
1307
+ end
1308
+
1309
+ # Send test event
1310
+ # Send a test event to the webhook endpoint. Accepts optional event_type and custom payload.
1311
+ # @param id [String] Webhook ID
1312
+ # @param [Hash] opts the optional parameters
1313
+ # @option opts [SendWebhookTestEventRequest] :send_webhook_test_event_request
1314
+ # @return [WebhookTestEventResponse]
1315
+ def send_webhook_test_event(id, opts = {})
1316
+ data, _status_code, _headers = send_webhook_test_event_with_http_info(id, opts)
1317
+ data
1318
+ end
1319
+
1320
+ # Send test event
1321
+ # Send a test event to the webhook endpoint. Accepts optional event_type and custom payload.
1322
+ # @param id [String] Webhook ID
1323
+ # @param [Hash] opts the optional parameters
1324
+ # @option opts [SendWebhookTestEventRequest] :send_webhook_test_event_request
1325
+ # @return [Array<(WebhookTestEventResponse, Integer, Hash)>] WebhookTestEventResponse data, response status code and response headers
1326
+ def send_webhook_test_event_with_http_info(id, opts = {})
1327
+ if @api_client.config.debugging
1328
+ @api_client.config.logger.debug 'Calling API: WebhooksApi.send_webhook_test_event ...'
1329
+ end
1330
+ # verify the required parameter 'id' is set
1331
+ if @api_client.config.client_side_validation && id.nil?
1332
+ fail ArgumentError, "Missing the required parameter 'id' when calling WebhooksApi.send_webhook_test_event"
1333
+ end
1334
+ # resource path
1335
+ local_var_path = '/v1/webhooks/{id}/test'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1336
+
1337
+ # query parameters
1338
+ query_params = opts[:query_params] || {}
1339
+
1340
+ # header parameters
1341
+ header_params = opts[:header_params] || {}
1342
+ # HTTP header 'Accept' (if needed)
1343
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1344
+ # HTTP header 'Content-Type'
1345
+ content_type = @api_client.select_header_content_type(['application/json'])
1346
+ if !content_type.nil?
1347
+ header_params['Content-Type'] = content_type
1348
+ end
1349
+
1350
+ # form parameters
1351
+ form_params = opts[:form_params] || {}
1352
+
1353
+ # http body (model)
1354
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'send_webhook_test_event_request'])
1355
+
1356
+ # return_type
1357
+ return_type = opts[:debug_return_type] || 'WebhookTestEventResponse'
1358
+
1359
+ # auth_names
1360
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
1361
+
1362
+ new_options = opts.merge(
1363
+ :operation => :"WebhooksApi.send_webhook_test_event",
1364
+ :header_params => header_params,
1365
+ :query_params => query_params,
1366
+ :form_params => form_params,
1367
+ :body => post_body,
1368
+ :auth_names => auth_names,
1369
+ :return_type => return_type
1370
+ )
1371
+
1372
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1373
+ if @api_client.config.debugging
1374
+ @api_client.config.logger.debug "API called: WebhooksApi#send_webhook_test_event\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1375
+ end
1376
+ return data, status_code, headers
1377
+ end
1378
+
1379
+ # Test payload transformation
1380
+ # Preview how a payload would be transformed by the webhook's transformation rules without actually delivering.
1381
+ # @param id [String] Webhook ID
1382
+ # @param test_webhook_transform_request [TestWebhookTransformRequest]
1383
+ # @param [Hash] opts the optional parameters
1384
+ # @return [WebhookTransformTestResponse]
1385
+ def test_webhook_transform(id, test_webhook_transform_request, opts = {})
1386
+ data, _status_code, _headers = test_webhook_transform_with_http_info(id, test_webhook_transform_request, opts)
1387
+ data
1388
+ end
1389
+
1390
+ # Test payload transformation
1391
+ # Preview how a payload would be transformed by the webhook&#39;s transformation rules without actually delivering.
1392
+ # @param id [String] Webhook ID
1393
+ # @param test_webhook_transform_request [TestWebhookTransformRequest]
1394
+ # @param [Hash] opts the optional parameters
1395
+ # @return [Array<(WebhookTransformTestResponse, Integer, Hash)>] WebhookTransformTestResponse data, response status code and response headers
1396
+ def test_webhook_transform_with_http_info(id, test_webhook_transform_request, opts = {})
1397
+ if @api_client.config.debugging
1398
+ @api_client.config.logger.debug 'Calling API: WebhooksApi.test_webhook_transform ...'
1399
+ end
1400
+ # verify the required parameter 'id' is set
1401
+ if @api_client.config.client_side_validation && id.nil?
1402
+ fail ArgumentError, "Missing the required parameter 'id' when calling WebhooksApi.test_webhook_transform"
1403
+ end
1404
+ # verify the required parameter 'test_webhook_transform_request' is set
1405
+ if @api_client.config.client_side_validation && test_webhook_transform_request.nil?
1406
+ fail ArgumentError, "Missing the required parameter 'test_webhook_transform_request' when calling WebhooksApi.test_webhook_transform"
1407
+ end
1408
+ # resource path
1409
+ local_var_path = '/v1/webhooks/{id}/transform/test'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1410
+
1411
+ # query parameters
1412
+ query_params = opts[:query_params] || {}
1413
+
1414
+ # header parameters
1415
+ header_params = opts[:header_params] || {}
1416
+ # HTTP header 'Accept' (if needed)
1417
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1418
+ # HTTP header 'Content-Type'
1419
+ content_type = @api_client.select_header_content_type(['application/json'])
1420
+ if !content_type.nil?
1421
+ header_params['Content-Type'] = content_type
1422
+ end
1423
+
1424
+ # form parameters
1425
+ form_params = opts[:form_params] || {}
1426
+
1427
+ # http body (model)
1428
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(test_webhook_transform_request)
1429
+
1430
+ # return_type
1431
+ return_type = opts[:debug_return_type] || 'WebhookTransformTestResponse'
1432
+
1433
+ # auth_names
1434
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
1435
+
1436
+ new_options = opts.merge(
1437
+ :operation => :"WebhooksApi.test_webhook_transform",
1438
+ :header_params => header_params,
1439
+ :query_params => query_params,
1440
+ :form_params => form_params,
1441
+ :body => post_body,
1442
+ :auth_names => auth_names,
1443
+ :return_type => return_type
1444
+ )
1445
+
1446
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1447
+ if @api_client.config.debugging
1448
+ @api_client.config.logger.debug "API called: WebhooksApi#test_webhook_transform\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1449
+ end
1450
+ return data, status_code, headers
1451
+ end
1452
+
1453
+ # Update webhook
1454
+ # Update an existing webhook configuration.
1455
+ # @param id [String] Webhook ID
1456
+ # @param update_webhook_request [UpdateWebhookRequest]
1457
+ # @param [Hash] opts the optional parameters
1458
+ # @return [WebhookResponse]
1459
+ def update_webhook(id, update_webhook_request, opts = {})
1460
+ data, _status_code, _headers = update_webhook_with_http_info(id, update_webhook_request, opts)
1461
+ data
1462
+ end
1463
+
1464
+ # Update webhook
1465
+ # Update an existing webhook configuration.
1466
+ # @param id [String] Webhook ID
1467
+ # @param update_webhook_request [UpdateWebhookRequest]
1468
+ # @param [Hash] opts the optional parameters
1469
+ # @return [Array<(WebhookResponse, Integer, Hash)>] WebhookResponse data, response status code and response headers
1470
+ def update_webhook_with_http_info(id, update_webhook_request, opts = {})
1471
+ if @api_client.config.debugging
1472
+ @api_client.config.logger.debug 'Calling API: WebhooksApi.update_webhook ...'
1473
+ end
1474
+ # verify the required parameter 'id' is set
1475
+ if @api_client.config.client_side_validation && id.nil?
1476
+ fail ArgumentError, "Missing the required parameter 'id' when calling WebhooksApi.update_webhook"
1477
+ end
1478
+ # verify the required parameter 'update_webhook_request' is set
1479
+ if @api_client.config.client_side_validation && update_webhook_request.nil?
1480
+ fail ArgumentError, "Missing the required parameter 'update_webhook_request' when calling WebhooksApi.update_webhook"
1481
+ end
1482
+ # resource path
1483
+ local_var_path = '/v1/webhooks/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1484
+
1485
+ # query parameters
1486
+ query_params = opts[:query_params] || {}
1487
+
1488
+ # header parameters
1489
+ header_params = opts[:header_params] || {}
1490
+ # HTTP header 'Accept' (if needed)
1491
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1492
+ # HTTP header 'Content-Type'
1493
+ content_type = @api_client.select_header_content_type(['application/json'])
1494
+ if !content_type.nil?
1495
+ header_params['Content-Type'] = content_type
1496
+ end
1497
+
1498
+ # form parameters
1499
+ form_params = opts[:form_params] || {}
1500
+
1501
+ # http body (model)
1502
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(update_webhook_request)
1503
+
1504
+ # return_type
1505
+ return_type = opts[:debug_return_type] || 'WebhookResponse'
1506
+
1507
+ # auth_names
1508
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
1509
+
1510
+ new_options = opts.merge(
1511
+ :operation => :"WebhooksApi.update_webhook",
1512
+ :header_params => header_params,
1513
+ :query_params => query_params,
1514
+ :form_params => form_params,
1515
+ :body => post_body,
1516
+ :auth_names => auth_names,
1517
+ :return_type => return_type
1518
+ )
1519
+
1520
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
1521
+ if @api_client.config.debugging
1522
+ @api_client.config.logger.debug "API called: WebhooksApi#update_webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1523
+ end
1524
+ return data, status_code, headers
1525
+ end
1526
+ end
1527
+ end