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,1688 @@
1
+ # Zyphr::WebhooksApi
2
+
3
+ All URIs are relative to *https://api.zyphr.dev/v1*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ------ | ------------ | ----------- |
7
+ | [**bulk_retry_webhook_deliveries**](WebhooksApi.md#bulk_retry_webhook_deliveries) | **POST** /v1/webhooks/{id}/deliveries/bulk-retry | Bulk retry failed deliveries |
8
+ | [**close_webhook_circuit**](WebhooksApi.md#close_webhook_circuit) | **POST** /v1/webhooks/{id}/circuit/close | Force close circuit breaker |
9
+ | [**create_webhook**](WebhooksApi.md#create_webhook) | **POST** /v1/webhooks | Create webhook |
10
+ | [**delete_webhook**](WebhooksApi.md#delete_webhook) | **DELETE** /v1/webhooks/{id} | Delete webhook |
11
+ | [**get_webhook**](WebhooksApi.md#get_webhook) | **GET** /v1/webhooks/{id} | Get webhook |
12
+ | [**get_webhook_circuit_state**](WebhooksApi.md#get_webhook_circuit_state) | **GET** /v1/webhooks/{id}/circuit | Get circuit breaker state |
13
+ | [**get_webhook_delivery**](WebhooksApi.md#get_webhook_delivery) | **GET** /v1/webhooks/{id}/deliveries/{deliveryId} | Get webhook delivery details |
14
+ | [**get_webhook_ips**](WebhooksApi.md#get_webhook_ips) | **GET** /v1/webhooks/ips | Get static webhook IPs |
15
+ | [**get_webhook_job**](WebhooksApi.md#get_webhook_job) | **GET** /v1/webhooks/jobs/{jobId} | Get replay/retry job status |
16
+ | [**get_webhook_metrics**](WebhooksApi.md#get_webhook_metrics) | **GET** /v1/webhooks/{id}/metrics | Get webhook health metrics |
17
+ | [**get_webhook_regions**](WebhooksApi.md#get_webhook_regions) | **GET** /v1/webhooks/regions | Get available webhook regions |
18
+ | [**get_webhook_usage**](WebhooksApi.md#get_webhook_usage) | **GET** /v1/webhooks/usage | Get webhook usage metrics |
19
+ | [**get_workspace_webhook_metrics**](WebhooksApi.md#get_workspace_webhook_metrics) | **GET** /v1/webhooks/metrics | Get workspace webhook metrics |
20
+ | [**list_webhook_deliveries**](WebhooksApi.md#list_webhook_deliveries) | **GET** /v1/webhooks/{id}/deliveries | List webhook deliveries |
21
+ | [**list_webhook_event_types**](WebhooksApi.md#list_webhook_event_types) | **GET** /v1/webhooks/events | List webhook event types |
22
+ | [**list_webhook_versions**](WebhooksApi.md#list_webhook_versions) | **GET** /v1/webhooks/versions | List webhook API versions |
23
+ | [**list_webhooks**](WebhooksApi.md#list_webhooks) | **GET** /v1/webhooks | List webhooks |
24
+ | [**replay_webhook_events**](WebhooksApi.md#replay_webhook_events) | **POST** /v1/webhooks/{id}/replay | Replay webhook events |
25
+ | [**retry_webhook_delivery**](WebhooksApi.md#retry_webhook_delivery) | **POST** /v1/webhooks/{id}/deliveries/{deliveryId}/retry | Retry webhook delivery |
26
+ | [**rotate_webhook_secret**](WebhooksApi.md#rotate_webhook_secret) | **POST** /v1/webhooks/{id}/rotate-secret | Rotate webhook secret |
27
+ | [**send_webhook_test_event**](WebhooksApi.md#send_webhook_test_event) | **POST** /v1/webhooks/{id}/test | Send test event |
28
+ | [**test_webhook_transform**](WebhooksApi.md#test_webhook_transform) | **POST** /v1/webhooks/{id}/transform/test | Test payload transformation |
29
+ | [**update_webhook**](WebhooksApi.md#update_webhook) | **PUT** /v1/webhooks/{id} | Update webhook |
30
+
31
+
32
+ ## bulk_retry_webhook_deliveries
33
+
34
+ > <WebhookBulkRetryResponse> bulk_retry_webhook_deliveries(id, opts)
35
+
36
+ Bulk retry failed deliveries
37
+
38
+ Bulk retry failed or exhausted deliveries for a webhook. Creates an asynchronous job.
39
+
40
+ ### Examples
41
+
42
+ ```ruby
43
+ require 'time'
44
+ require 'zyphr'
45
+ # setup authorization
46
+ Zyphr.configure do |config|
47
+ # Configure API key authorization: ApiKeyAuth
48
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
49
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
50
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
51
+ end
52
+
53
+ api_instance = Zyphr::WebhooksApi.new
54
+ id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Webhook ID
55
+ opts = {
56
+ bulk_retry_webhook_deliveries_request: Zyphr::BulkRetryWebhookDeliveriesRequest.new # BulkRetryWebhookDeliveriesRequest |
57
+ }
58
+
59
+ begin
60
+ # Bulk retry failed deliveries
61
+ result = api_instance.bulk_retry_webhook_deliveries(id, opts)
62
+ p result
63
+ rescue Zyphr::ApiError => e
64
+ puts "Error when calling WebhooksApi->bulk_retry_webhook_deliveries: #{e}"
65
+ end
66
+ ```
67
+
68
+ #### Using the bulk_retry_webhook_deliveries_with_http_info variant
69
+
70
+ This returns an Array which contains the response data, status code and headers.
71
+
72
+ > <Array(<WebhookBulkRetryResponse>, Integer, Hash)> bulk_retry_webhook_deliveries_with_http_info(id, opts)
73
+
74
+ ```ruby
75
+ begin
76
+ # Bulk retry failed deliveries
77
+ data, status_code, headers = api_instance.bulk_retry_webhook_deliveries_with_http_info(id, opts)
78
+ p status_code # => 2xx
79
+ p headers # => { ... }
80
+ p data # => <WebhookBulkRetryResponse>
81
+ rescue Zyphr::ApiError => e
82
+ puts "Error when calling WebhooksApi->bulk_retry_webhook_deliveries_with_http_info: #{e}"
83
+ end
84
+ ```
85
+
86
+ ### Parameters
87
+
88
+ | Name | Type | Description | Notes |
89
+ | ---- | ---- | ----------- | ----- |
90
+ | **id** | **String** | Webhook ID | |
91
+ | **bulk_retry_webhook_deliveries_request** | [**BulkRetryWebhookDeliveriesRequest**](BulkRetryWebhookDeliveriesRequest.md) | | [optional] |
92
+
93
+ ### Return type
94
+
95
+ [**WebhookBulkRetryResponse**](WebhookBulkRetryResponse.md)
96
+
97
+ ### Authorization
98
+
99
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
100
+
101
+ ### HTTP request headers
102
+
103
+ - **Content-Type**: application/json
104
+ - **Accept**: application/json
105
+
106
+
107
+ ## close_webhook_circuit
108
+
109
+ > <WebhookCircuitStateResponse> close_webhook_circuit(id)
110
+
111
+ Force close circuit breaker
112
+
113
+ Force-close the circuit breaker for a webhook, allowing deliveries to resume.
114
+
115
+ ### Examples
116
+
117
+ ```ruby
118
+ require 'time'
119
+ require 'zyphr'
120
+ # setup authorization
121
+ Zyphr.configure do |config|
122
+ # Configure API key authorization: ApiKeyAuth
123
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
124
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
125
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
126
+ end
127
+
128
+ api_instance = Zyphr::WebhooksApi.new
129
+ id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Webhook ID
130
+
131
+ begin
132
+ # Force close circuit breaker
133
+ result = api_instance.close_webhook_circuit(id)
134
+ p result
135
+ rescue Zyphr::ApiError => e
136
+ puts "Error when calling WebhooksApi->close_webhook_circuit: #{e}"
137
+ end
138
+ ```
139
+
140
+ #### Using the close_webhook_circuit_with_http_info variant
141
+
142
+ This returns an Array which contains the response data, status code and headers.
143
+
144
+ > <Array(<WebhookCircuitStateResponse>, Integer, Hash)> close_webhook_circuit_with_http_info(id)
145
+
146
+ ```ruby
147
+ begin
148
+ # Force close circuit breaker
149
+ data, status_code, headers = api_instance.close_webhook_circuit_with_http_info(id)
150
+ p status_code # => 2xx
151
+ p headers # => { ... }
152
+ p data # => <WebhookCircuitStateResponse>
153
+ rescue Zyphr::ApiError => e
154
+ puts "Error when calling WebhooksApi->close_webhook_circuit_with_http_info: #{e}"
155
+ end
156
+ ```
157
+
158
+ ### Parameters
159
+
160
+ | Name | Type | Description | Notes |
161
+ | ---- | ---- | ----------- | ----- |
162
+ | **id** | **String** | Webhook ID | |
163
+
164
+ ### Return type
165
+
166
+ [**WebhookCircuitStateResponse**](WebhookCircuitStateResponse.md)
167
+
168
+ ### Authorization
169
+
170
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
171
+
172
+ ### HTTP request headers
173
+
174
+ - **Content-Type**: Not defined
175
+ - **Accept**: application/json
176
+
177
+
178
+ ## create_webhook
179
+
180
+ > <WebhookCreateResponse> create_webhook(create_webhook_request)
181
+
182
+ Create webhook
183
+
184
+ Create a new webhook endpoint. The signing secret is only returned on creation.
185
+
186
+ ### Examples
187
+
188
+ ```ruby
189
+ require 'time'
190
+ require 'zyphr'
191
+ # setup authorization
192
+ Zyphr.configure do |config|
193
+ # Configure API key authorization: ApiKeyAuth
194
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
195
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
196
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
197
+ end
198
+
199
+ api_instance = Zyphr::WebhooksApi.new
200
+ create_webhook_request = Zyphr::CreateWebhookRequest.new({url: 'https://api.example.com/webhooks/zyphr', events: ["email.delivered", "email.bounced", "email.opened"]}) # CreateWebhookRequest |
201
+
202
+ begin
203
+ # Create webhook
204
+ result = api_instance.create_webhook(create_webhook_request)
205
+ p result
206
+ rescue Zyphr::ApiError => e
207
+ puts "Error when calling WebhooksApi->create_webhook: #{e}"
208
+ end
209
+ ```
210
+
211
+ #### Using the create_webhook_with_http_info variant
212
+
213
+ This returns an Array which contains the response data, status code and headers.
214
+
215
+ > <Array(<WebhookCreateResponse>, Integer, Hash)> create_webhook_with_http_info(create_webhook_request)
216
+
217
+ ```ruby
218
+ begin
219
+ # Create webhook
220
+ data, status_code, headers = api_instance.create_webhook_with_http_info(create_webhook_request)
221
+ p status_code # => 2xx
222
+ p headers # => { ... }
223
+ p data # => <WebhookCreateResponse>
224
+ rescue Zyphr::ApiError => e
225
+ puts "Error when calling WebhooksApi->create_webhook_with_http_info: #{e}"
226
+ end
227
+ ```
228
+
229
+ ### Parameters
230
+
231
+ | Name | Type | Description | Notes |
232
+ | ---- | ---- | ----------- | ----- |
233
+ | **create_webhook_request** | [**CreateWebhookRequest**](CreateWebhookRequest.md) | | |
234
+
235
+ ### Return type
236
+
237
+ [**WebhookCreateResponse**](WebhookCreateResponse.md)
238
+
239
+ ### Authorization
240
+
241
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
242
+
243
+ ### HTTP request headers
244
+
245
+ - **Content-Type**: application/json
246
+ - **Accept**: application/json
247
+
248
+
249
+ ## delete_webhook
250
+
251
+ > <WebhookDeleteResponse> delete_webhook(id)
252
+
253
+ Delete webhook
254
+
255
+ Delete a webhook and clean up associated circuit breaker, rate limit, and metrics state.
256
+
257
+ ### Examples
258
+
259
+ ```ruby
260
+ require 'time'
261
+ require 'zyphr'
262
+ # setup authorization
263
+ Zyphr.configure do |config|
264
+ # Configure API key authorization: ApiKeyAuth
265
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
266
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
267
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
268
+ end
269
+
270
+ api_instance = Zyphr::WebhooksApi.new
271
+ id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Webhook ID
272
+
273
+ begin
274
+ # Delete webhook
275
+ result = api_instance.delete_webhook(id)
276
+ p result
277
+ rescue Zyphr::ApiError => e
278
+ puts "Error when calling WebhooksApi->delete_webhook: #{e}"
279
+ end
280
+ ```
281
+
282
+ #### Using the delete_webhook_with_http_info variant
283
+
284
+ This returns an Array which contains the response data, status code and headers.
285
+
286
+ > <Array(<WebhookDeleteResponse>, Integer, Hash)> delete_webhook_with_http_info(id)
287
+
288
+ ```ruby
289
+ begin
290
+ # Delete webhook
291
+ data, status_code, headers = api_instance.delete_webhook_with_http_info(id)
292
+ p status_code # => 2xx
293
+ p headers # => { ... }
294
+ p data # => <WebhookDeleteResponse>
295
+ rescue Zyphr::ApiError => e
296
+ puts "Error when calling WebhooksApi->delete_webhook_with_http_info: #{e}"
297
+ end
298
+ ```
299
+
300
+ ### Parameters
301
+
302
+ | Name | Type | Description | Notes |
303
+ | ---- | ---- | ----------- | ----- |
304
+ | **id** | **String** | Webhook ID | |
305
+
306
+ ### Return type
307
+
308
+ [**WebhookDeleteResponse**](WebhookDeleteResponse.md)
309
+
310
+ ### Authorization
311
+
312
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
313
+
314
+ ### HTTP request headers
315
+
316
+ - **Content-Type**: Not defined
317
+ - **Accept**: application/json
318
+
319
+
320
+ ## get_webhook
321
+
322
+ > <WebhookResponse> get_webhook(id)
323
+
324
+ Get webhook
325
+
326
+ Get a specific webhook by ID.
327
+
328
+ ### Examples
329
+
330
+ ```ruby
331
+ require 'time'
332
+ require 'zyphr'
333
+ # setup authorization
334
+ Zyphr.configure do |config|
335
+ # Configure API key authorization: ApiKeyAuth
336
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
337
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
338
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
339
+ end
340
+
341
+ api_instance = Zyphr::WebhooksApi.new
342
+ id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Webhook ID
343
+
344
+ begin
345
+ # Get webhook
346
+ result = api_instance.get_webhook(id)
347
+ p result
348
+ rescue Zyphr::ApiError => e
349
+ puts "Error when calling WebhooksApi->get_webhook: #{e}"
350
+ end
351
+ ```
352
+
353
+ #### Using the get_webhook_with_http_info variant
354
+
355
+ This returns an Array which contains the response data, status code and headers.
356
+
357
+ > <Array(<WebhookResponse>, Integer, Hash)> get_webhook_with_http_info(id)
358
+
359
+ ```ruby
360
+ begin
361
+ # Get webhook
362
+ data, status_code, headers = api_instance.get_webhook_with_http_info(id)
363
+ p status_code # => 2xx
364
+ p headers # => { ... }
365
+ p data # => <WebhookResponse>
366
+ rescue Zyphr::ApiError => e
367
+ puts "Error when calling WebhooksApi->get_webhook_with_http_info: #{e}"
368
+ end
369
+ ```
370
+
371
+ ### Parameters
372
+
373
+ | Name | Type | Description | Notes |
374
+ | ---- | ---- | ----------- | ----- |
375
+ | **id** | **String** | Webhook ID | |
376
+
377
+ ### Return type
378
+
379
+ [**WebhookResponse**](WebhookResponse.md)
380
+
381
+ ### Authorization
382
+
383
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
384
+
385
+ ### HTTP request headers
386
+
387
+ - **Content-Type**: Not defined
388
+ - **Accept**: application/json
389
+
390
+
391
+ ## get_webhook_circuit_state
392
+
393
+ > <WebhookCircuitStateResponse> get_webhook_circuit_state(id)
394
+
395
+ Get circuit breaker state
396
+
397
+ Get the circuit breaker state for a webhook endpoint.
398
+
399
+ ### Examples
400
+
401
+ ```ruby
402
+ require 'time'
403
+ require 'zyphr'
404
+ # setup authorization
405
+ Zyphr.configure do |config|
406
+ # Configure API key authorization: ApiKeyAuth
407
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
408
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
409
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
410
+ end
411
+
412
+ api_instance = Zyphr::WebhooksApi.new
413
+ id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Webhook ID
414
+
415
+ begin
416
+ # Get circuit breaker state
417
+ result = api_instance.get_webhook_circuit_state(id)
418
+ p result
419
+ rescue Zyphr::ApiError => e
420
+ puts "Error when calling WebhooksApi->get_webhook_circuit_state: #{e}"
421
+ end
422
+ ```
423
+
424
+ #### Using the get_webhook_circuit_state_with_http_info variant
425
+
426
+ This returns an Array which contains the response data, status code and headers.
427
+
428
+ > <Array(<WebhookCircuitStateResponse>, Integer, Hash)> get_webhook_circuit_state_with_http_info(id)
429
+
430
+ ```ruby
431
+ begin
432
+ # Get circuit breaker state
433
+ data, status_code, headers = api_instance.get_webhook_circuit_state_with_http_info(id)
434
+ p status_code # => 2xx
435
+ p headers # => { ... }
436
+ p data # => <WebhookCircuitStateResponse>
437
+ rescue Zyphr::ApiError => e
438
+ puts "Error when calling WebhooksApi->get_webhook_circuit_state_with_http_info: #{e}"
439
+ end
440
+ ```
441
+
442
+ ### Parameters
443
+
444
+ | Name | Type | Description | Notes |
445
+ | ---- | ---- | ----------- | ----- |
446
+ | **id** | **String** | Webhook ID | |
447
+
448
+ ### Return type
449
+
450
+ [**WebhookCircuitStateResponse**](WebhookCircuitStateResponse.md)
451
+
452
+ ### Authorization
453
+
454
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
455
+
456
+ ### HTTP request headers
457
+
458
+ - **Content-Type**: Not defined
459
+ - **Accept**: application/json
460
+
461
+
462
+ ## get_webhook_delivery
463
+
464
+ > <WebhookDeliveryResponse> get_webhook_delivery(id, delivery_id)
465
+
466
+ Get webhook delivery details
467
+
468
+ Get a single delivery with full details including payload, headers, and response for debugging.
469
+
470
+ ### Examples
471
+
472
+ ```ruby
473
+ require 'time'
474
+ require 'zyphr'
475
+ # setup authorization
476
+ Zyphr.configure do |config|
477
+ # Configure API key authorization: ApiKeyAuth
478
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
479
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
480
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
481
+ end
482
+
483
+ api_instance = Zyphr::WebhooksApi.new
484
+ id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Webhook ID
485
+ delivery_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Delivery ID
486
+
487
+ begin
488
+ # Get webhook delivery details
489
+ result = api_instance.get_webhook_delivery(id, delivery_id)
490
+ p result
491
+ rescue Zyphr::ApiError => e
492
+ puts "Error when calling WebhooksApi->get_webhook_delivery: #{e}"
493
+ end
494
+ ```
495
+
496
+ #### Using the get_webhook_delivery_with_http_info variant
497
+
498
+ This returns an Array which contains the response data, status code and headers.
499
+
500
+ > <Array(<WebhookDeliveryResponse>, Integer, Hash)> get_webhook_delivery_with_http_info(id, delivery_id)
501
+
502
+ ```ruby
503
+ begin
504
+ # Get webhook delivery details
505
+ data, status_code, headers = api_instance.get_webhook_delivery_with_http_info(id, delivery_id)
506
+ p status_code # => 2xx
507
+ p headers # => { ... }
508
+ p data # => <WebhookDeliveryResponse>
509
+ rescue Zyphr::ApiError => e
510
+ puts "Error when calling WebhooksApi->get_webhook_delivery_with_http_info: #{e}"
511
+ end
512
+ ```
513
+
514
+ ### Parameters
515
+
516
+ | Name | Type | Description | Notes |
517
+ | ---- | ---- | ----------- | ----- |
518
+ | **id** | **String** | Webhook ID | |
519
+ | **delivery_id** | **String** | Delivery ID | |
520
+
521
+ ### Return type
522
+
523
+ [**WebhookDeliveryResponse**](WebhookDeliveryResponse.md)
524
+
525
+ ### Authorization
526
+
527
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
528
+
529
+ ### HTTP request headers
530
+
531
+ - **Content-Type**: Not defined
532
+ - **Accept**: application/json
533
+
534
+
535
+ ## get_webhook_ips
536
+
537
+ > <WebhookIpsResponse> get_webhook_ips
538
+
539
+ Get static webhook IPs
540
+
541
+ Get static IP addresses used for webhook deliveries. Requires dedicated_ip plan feature (Scale/Enterprise).
542
+
543
+ ### Examples
544
+
545
+ ```ruby
546
+ require 'time'
547
+ require 'zyphr'
548
+ # setup authorization
549
+ Zyphr.configure do |config|
550
+ # Configure API key authorization: ApiKeyAuth
551
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
552
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
553
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
554
+ end
555
+
556
+ api_instance = Zyphr::WebhooksApi.new
557
+
558
+ begin
559
+ # Get static webhook IPs
560
+ result = api_instance.get_webhook_ips
561
+ p result
562
+ rescue Zyphr::ApiError => e
563
+ puts "Error when calling WebhooksApi->get_webhook_ips: #{e}"
564
+ end
565
+ ```
566
+
567
+ #### Using the get_webhook_ips_with_http_info variant
568
+
569
+ This returns an Array which contains the response data, status code and headers.
570
+
571
+ > <Array(<WebhookIpsResponse>, Integer, Hash)> get_webhook_ips_with_http_info
572
+
573
+ ```ruby
574
+ begin
575
+ # Get static webhook IPs
576
+ data, status_code, headers = api_instance.get_webhook_ips_with_http_info
577
+ p status_code # => 2xx
578
+ p headers # => { ... }
579
+ p data # => <WebhookIpsResponse>
580
+ rescue Zyphr::ApiError => e
581
+ puts "Error when calling WebhooksApi->get_webhook_ips_with_http_info: #{e}"
582
+ end
583
+ ```
584
+
585
+ ### Parameters
586
+
587
+ This endpoint does not need any parameter.
588
+
589
+ ### Return type
590
+
591
+ [**WebhookIpsResponse**](WebhookIpsResponse.md)
592
+
593
+ ### Authorization
594
+
595
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
596
+
597
+ ### HTTP request headers
598
+
599
+ - **Content-Type**: Not defined
600
+ - **Accept**: application/json
601
+
602
+
603
+ ## get_webhook_job
604
+
605
+ > <WebhookJobResponse> get_webhook_job(job_id)
606
+
607
+ Get replay/retry job status
608
+
609
+ Get the status of a replay or bulk retry job.
610
+
611
+ ### Examples
612
+
613
+ ```ruby
614
+ require 'time'
615
+ require 'zyphr'
616
+ # setup authorization
617
+ Zyphr.configure do |config|
618
+ # Configure API key authorization: ApiKeyAuth
619
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
620
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
621
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
622
+ end
623
+
624
+ api_instance = Zyphr::WebhooksApi.new
625
+ job_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Job ID
626
+
627
+ begin
628
+ # Get replay/retry job status
629
+ result = api_instance.get_webhook_job(job_id)
630
+ p result
631
+ rescue Zyphr::ApiError => e
632
+ puts "Error when calling WebhooksApi->get_webhook_job: #{e}"
633
+ end
634
+ ```
635
+
636
+ #### Using the get_webhook_job_with_http_info variant
637
+
638
+ This returns an Array which contains the response data, status code and headers.
639
+
640
+ > <Array(<WebhookJobResponse>, Integer, Hash)> get_webhook_job_with_http_info(job_id)
641
+
642
+ ```ruby
643
+ begin
644
+ # Get replay/retry job status
645
+ data, status_code, headers = api_instance.get_webhook_job_with_http_info(job_id)
646
+ p status_code # => 2xx
647
+ p headers # => { ... }
648
+ p data # => <WebhookJobResponse>
649
+ rescue Zyphr::ApiError => e
650
+ puts "Error when calling WebhooksApi->get_webhook_job_with_http_info: #{e}"
651
+ end
652
+ ```
653
+
654
+ ### Parameters
655
+
656
+ | Name | Type | Description | Notes |
657
+ | ---- | ---- | ----------- | ----- |
658
+ | **job_id** | **String** | Job ID | |
659
+
660
+ ### Return type
661
+
662
+ [**WebhookJobResponse**](WebhookJobResponse.md)
663
+
664
+ ### Authorization
665
+
666
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
667
+
668
+ ### HTTP request headers
669
+
670
+ - **Content-Type**: Not defined
671
+ - **Accept**: application/json
672
+
673
+
674
+ ## get_webhook_metrics
675
+
676
+ > <WebhookMetricsResponse> get_webhook_metrics(id)
677
+
678
+ Get webhook health metrics
679
+
680
+ Get health and performance metrics for a specific webhook endpoint.
681
+
682
+ ### Examples
683
+
684
+ ```ruby
685
+ require 'time'
686
+ require 'zyphr'
687
+ # setup authorization
688
+ Zyphr.configure do |config|
689
+ # Configure API key authorization: ApiKeyAuth
690
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
691
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
692
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
693
+ end
694
+
695
+ api_instance = Zyphr::WebhooksApi.new
696
+ id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Webhook ID
697
+
698
+ begin
699
+ # Get webhook health metrics
700
+ result = api_instance.get_webhook_metrics(id)
701
+ p result
702
+ rescue Zyphr::ApiError => e
703
+ puts "Error when calling WebhooksApi->get_webhook_metrics: #{e}"
704
+ end
705
+ ```
706
+
707
+ #### Using the get_webhook_metrics_with_http_info variant
708
+
709
+ This returns an Array which contains the response data, status code and headers.
710
+
711
+ > <Array(<WebhookMetricsResponse>, Integer, Hash)> get_webhook_metrics_with_http_info(id)
712
+
713
+ ```ruby
714
+ begin
715
+ # Get webhook health metrics
716
+ data, status_code, headers = api_instance.get_webhook_metrics_with_http_info(id)
717
+ p status_code # => 2xx
718
+ p headers # => { ... }
719
+ p data # => <WebhookMetricsResponse>
720
+ rescue Zyphr::ApiError => e
721
+ puts "Error when calling WebhooksApi->get_webhook_metrics_with_http_info: #{e}"
722
+ end
723
+ ```
724
+
725
+ ### Parameters
726
+
727
+ | Name | Type | Description | Notes |
728
+ | ---- | ---- | ----------- | ----- |
729
+ | **id** | **String** | Webhook ID | |
730
+
731
+ ### Return type
732
+
733
+ [**WebhookMetricsResponse**](WebhookMetricsResponse.md)
734
+
735
+ ### Authorization
736
+
737
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
738
+
739
+ ### HTTP request headers
740
+
741
+ - **Content-Type**: Not defined
742
+ - **Accept**: application/json
743
+
744
+
745
+ ## get_webhook_regions
746
+
747
+ > <WebhookRegionsResponse> get_webhook_regions
748
+
749
+ Get available webhook regions
750
+
751
+ Get available webhook delivery regions. Requires multi_region plan feature (Enterprise only).
752
+
753
+ ### Examples
754
+
755
+ ```ruby
756
+ require 'time'
757
+ require 'zyphr'
758
+ # setup authorization
759
+ Zyphr.configure do |config|
760
+ # Configure API key authorization: ApiKeyAuth
761
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
762
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
763
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
764
+ end
765
+
766
+ api_instance = Zyphr::WebhooksApi.new
767
+
768
+ begin
769
+ # Get available webhook regions
770
+ result = api_instance.get_webhook_regions
771
+ p result
772
+ rescue Zyphr::ApiError => e
773
+ puts "Error when calling WebhooksApi->get_webhook_regions: #{e}"
774
+ end
775
+ ```
776
+
777
+ #### Using the get_webhook_regions_with_http_info variant
778
+
779
+ This returns an Array which contains the response data, status code and headers.
780
+
781
+ > <Array(<WebhookRegionsResponse>, Integer, Hash)> get_webhook_regions_with_http_info
782
+
783
+ ```ruby
784
+ begin
785
+ # Get available webhook regions
786
+ data, status_code, headers = api_instance.get_webhook_regions_with_http_info
787
+ p status_code # => 2xx
788
+ p headers # => { ... }
789
+ p data # => <WebhookRegionsResponse>
790
+ rescue Zyphr::ApiError => e
791
+ puts "Error when calling WebhooksApi->get_webhook_regions_with_http_info: #{e}"
792
+ end
793
+ ```
794
+
795
+ ### Parameters
796
+
797
+ This endpoint does not need any parameter.
798
+
799
+ ### Return type
800
+
801
+ [**WebhookRegionsResponse**](WebhookRegionsResponse.md)
802
+
803
+ ### Authorization
804
+
805
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
806
+
807
+ ### HTTP request headers
808
+
809
+ - **Content-Type**: Not defined
810
+ - **Accept**: application/json
811
+
812
+
813
+ ## get_webhook_usage
814
+
815
+ > <WebhookUsageResponse> get_webhook_usage
816
+
817
+ Get webhook usage metrics
818
+
819
+ Get webhook delivery usage statistics for the current billing period.
820
+
821
+ ### Examples
822
+
823
+ ```ruby
824
+ require 'time'
825
+ require 'zyphr'
826
+ # setup authorization
827
+ Zyphr.configure do |config|
828
+ # Configure API key authorization: ApiKeyAuth
829
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
830
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
831
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
832
+ end
833
+
834
+ api_instance = Zyphr::WebhooksApi.new
835
+
836
+ begin
837
+ # Get webhook usage metrics
838
+ result = api_instance.get_webhook_usage
839
+ p result
840
+ rescue Zyphr::ApiError => e
841
+ puts "Error when calling WebhooksApi->get_webhook_usage: #{e}"
842
+ end
843
+ ```
844
+
845
+ #### Using the get_webhook_usage_with_http_info variant
846
+
847
+ This returns an Array which contains the response data, status code and headers.
848
+
849
+ > <Array(<WebhookUsageResponse>, Integer, Hash)> get_webhook_usage_with_http_info
850
+
851
+ ```ruby
852
+ begin
853
+ # Get webhook usage metrics
854
+ data, status_code, headers = api_instance.get_webhook_usage_with_http_info
855
+ p status_code # => 2xx
856
+ p headers # => { ... }
857
+ p data # => <WebhookUsageResponse>
858
+ rescue Zyphr::ApiError => e
859
+ puts "Error when calling WebhooksApi->get_webhook_usage_with_http_info: #{e}"
860
+ end
861
+ ```
862
+
863
+ ### Parameters
864
+
865
+ This endpoint does not need any parameter.
866
+
867
+ ### Return type
868
+
869
+ [**WebhookUsageResponse**](WebhookUsageResponse.md)
870
+
871
+ ### Authorization
872
+
873
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
874
+
875
+ ### HTTP request headers
876
+
877
+ - **Content-Type**: Not defined
878
+ - **Accept**: application/json
879
+
880
+
881
+ ## get_workspace_webhook_metrics
882
+
883
+ > <WebhookWorkspaceMetricsResponse> get_workspace_webhook_metrics
884
+
885
+ Get workspace webhook metrics
886
+
887
+ Get aggregate webhook health and performance metrics for the entire workspace.
888
+
889
+ ### Examples
890
+
891
+ ```ruby
892
+ require 'time'
893
+ require 'zyphr'
894
+ # setup authorization
895
+ Zyphr.configure do |config|
896
+ # Configure API key authorization: ApiKeyAuth
897
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
898
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
899
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
900
+ end
901
+
902
+ api_instance = Zyphr::WebhooksApi.new
903
+
904
+ begin
905
+ # Get workspace webhook metrics
906
+ result = api_instance.get_workspace_webhook_metrics
907
+ p result
908
+ rescue Zyphr::ApiError => e
909
+ puts "Error when calling WebhooksApi->get_workspace_webhook_metrics: #{e}"
910
+ end
911
+ ```
912
+
913
+ #### Using the get_workspace_webhook_metrics_with_http_info variant
914
+
915
+ This returns an Array which contains the response data, status code and headers.
916
+
917
+ > <Array(<WebhookWorkspaceMetricsResponse>, Integer, Hash)> get_workspace_webhook_metrics_with_http_info
918
+
919
+ ```ruby
920
+ begin
921
+ # Get workspace webhook metrics
922
+ data, status_code, headers = api_instance.get_workspace_webhook_metrics_with_http_info
923
+ p status_code # => 2xx
924
+ p headers # => { ... }
925
+ p data # => <WebhookWorkspaceMetricsResponse>
926
+ rescue Zyphr::ApiError => e
927
+ puts "Error when calling WebhooksApi->get_workspace_webhook_metrics_with_http_info: #{e}"
928
+ end
929
+ ```
930
+
931
+ ### Parameters
932
+
933
+ This endpoint does not need any parameter.
934
+
935
+ ### Return type
936
+
937
+ [**WebhookWorkspaceMetricsResponse**](WebhookWorkspaceMetricsResponse.md)
938
+
939
+ ### Authorization
940
+
941
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
942
+
943
+ ### HTTP request headers
944
+
945
+ - **Content-Type**: Not defined
946
+ - **Accept**: application/json
947
+
948
+
949
+ ## list_webhook_deliveries
950
+
951
+ > <WebhookDeliveryListResponse> list_webhook_deliveries(id, opts)
952
+
953
+ List webhook deliveries
954
+
955
+ List delivery attempts for a webhook with filtering and pagination.
956
+
957
+ ### Examples
958
+
959
+ ```ruby
960
+ require 'time'
961
+ require 'zyphr'
962
+ # setup authorization
963
+ Zyphr.configure do |config|
964
+ # Configure API key authorization: ApiKeyAuth
965
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
966
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
967
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
968
+ end
969
+
970
+ api_instance = Zyphr::WebhooksApi.new
971
+ id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Webhook ID
972
+ opts = {
973
+ status: 'pending', # String | Filter by delivery status
974
+ event_type: 'event_type_example', # String | Filter by event type
975
+ search: 'search_example', # String | Search deliveries
976
+ start_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter deliveries after this date
977
+ end_date: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter deliveries before this date
978
+ limit: 56, # Integer | Maximum number of deliveries to return
979
+ offset: 56 # Integer | Number of deliveries to skip
980
+ }
981
+
982
+ begin
983
+ # List webhook deliveries
984
+ result = api_instance.list_webhook_deliveries(id, opts)
985
+ p result
986
+ rescue Zyphr::ApiError => e
987
+ puts "Error when calling WebhooksApi->list_webhook_deliveries: #{e}"
988
+ end
989
+ ```
990
+
991
+ #### Using the list_webhook_deliveries_with_http_info variant
992
+
993
+ This returns an Array which contains the response data, status code and headers.
994
+
995
+ > <Array(<WebhookDeliveryListResponse>, Integer, Hash)> list_webhook_deliveries_with_http_info(id, opts)
996
+
997
+ ```ruby
998
+ begin
999
+ # List webhook deliveries
1000
+ data, status_code, headers = api_instance.list_webhook_deliveries_with_http_info(id, opts)
1001
+ p status_code # => 2xx
1002
+ p headers # => { ... }
1003
+ p data # => <WebhookDeliveryListResponse>
1004
+ rescue Zyphr::ApiError => e
1005
+ puts "Error when calling WebhooksApi->list_webhook_deliveries_with_http_info: #{e}"
1006
+ end
1007
+ ```
1008
+
1009
+ ### Parameters
1010
+
1011
+ | Name | Type | Description | Notes |
1012
+ | ---- | ---- | ----------- | ----- |
1013
+ | **id** | **String** | Webhook ID | |
1014
+ | **status** | **String** | Filter by delivery status | [optional] |
1015
+ | **event_type** | **String** | Filter by event type | [optional] |
1016
+ | **search** | **String** | Search deliveries | [optional] |
1017
+ | **start_date** | **Time** | Filter deliveries after this date | [optional] |
1018
+ | **end_date** | **Time** | Filter deliveries before this date | [optional] |
1019
+ | **limit** | **Integer** | Maximum number of deliveries to return | [optional][default to 50] |
1020
+ | **offset** | **Integer** | Number of deliveries to skip | [optional][default to 0] |
1021
+
1022
+ ### Return type
1023
+
1024
+ [**WebhookDeliveryListResponse**](WebhookDeliveryListResponse.md)
1025
+
1026
+ ### Authorization
1027
+
1028
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
1029
+
1030
+ ### HTTP request headers
1031
+
1032
+ - **Content-Type**: Not defined
1033
+ - **Accept**: application/json
1034
+
1035
+
1036
+ ## list_webhook_event_types
1037
+
1038
+ > <WebhookEventTypesResponse> list_webhook_event_types(opts)
1039
+
1040
+ List webhook event types
1041
+
1042
+ List available webhook event types with full registry information. Optionally filter by category.
1043
+
1044
+ ### Examples
1045
+
1046
+ ```ruby
1047
+ require 'time'
1048
+ require 'zyphr'
1049
+ # setup authorization
1050
+ Zyphr.configure do |config|
1051
+ # Configure API key authorization: ApiKeyAuth
1052
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
1053
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1054
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
1055
+ end
1056
+
1057
+ api_instance = Zyphr::WebhooksApi.new
1058
+ opts = {
1059
+ category: 'category_example' # String | Filter event types by category
1060
+ }
1061
+
1062
+ begin
1063
+ # List webhook event types
1064
+ result = api_instance.list_webhook_event_types(opts)
1065
+ p result
1066
+ rescue Zyphr::ApiError => e
1067
+ puts "Error when calling WebhooksApi->list_webhook_event_types: #{e}"
1068
+ end
1069
+ ```
1070
+
1071
+ #### Using the list_webhook_event_types_with_http_info variant
1072
+
1073
+ This returns an Array which contains the response data, status code and headers.
1074
+
1075
+ > <Array(<WebhookEventTypesResponse>, Integer, Hash)> list_webhook_event_types_with_http_info(opts)
1076
+
1077
+ ```ruby
1078
+ begin
1079
+ # List webhook event types
1080
+ data, status_code, headers = api_instance.list_webhook_event_types_with_http_info(opts)
1081
+ p status_code # => 2xx
1082
+ p headers # => { ... }
1083
+ p data # => <WebhookEventTypesResponse>
1084
+ rescue Zyphr::ApiError => e
1085
+ puts "Error when calling WebhooksApi->list_webhook_event_types_with_http_info: #{e}"
1086
+ end
1087
+ ```
1088
+
1089
+ ### Parameters
1090
+
1091
+ | Name | Type | Description | Notes |
1092
+ | ---- | ---- | ----------- | ----- |
1093
+ | **category** | **String** | Filter event types by category | [optional] |
1094
+
1095
+ ### Return type
1096
+
1097
+ [**WebhookEventTypesResponse**](WebhookEventTypesResponse.md)
1098
+
1099
+ ### Authorization
1100
+
1101
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
1102
+
1103
+ ### HTTP request headers
1104
+
1105
+ - **Content-Type**: Not defined
1106
+ - **Accept**: application/json
1107
+
1108
+
1109
+ ## list_webhook_versions
1110
+
1111
+ > <WebhookVersionsResponse> list_webhook_versions
1112
+
1113
+ List webhook API versions
1114
+
1115
+ List available webhook API versions with changelog and deprecation info.
1116
+
1117
+ ### Examples
1118
+
1119
+ ```ruby
1120
+ require 'time'
1121
+ require 'zyphr'
1122
+ # setup authorization
1123
+ Zyphr.configure do |config|
1124
+ # Configure API key authorization: ApiKeyAuth
1125
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
1126
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1127
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
1128
+ end
1129
+
1130
+ api_instance = Zyphr::WebhooksApi.new
1131
+
1132
+ begin
1133
+ # List webhook API versions
1134
+ result = api_instance.list_webhook_versions
1135
+ p result
1136
+ rescue Zyphr::ApiError => e
1137
+ puts "Error when calling WebhooksApi->list_webhook_versions: #{e}"
1138
+ end
1139
+ ```
1140
+
1141
+ #### Using the list_webhook_versions_with_http_info variant
1142
+
1143
+ This returns an Array which contains the response data, status code and headers.
1144
+
1145
+ > <Array(<WebhookVersionsResponse>, Integer, Hash)> list_webhook_versions_with_http_info
1146
+
1147
+ ```ruby
1148
+ begin
1149
+ # List webhook API versions
1150
+ data, status_code, headers = api_instance.list_webhook_versions_with_http_info
1151
+ p status_code # => 2xx
1152
+ p headers # => { ... }
1153
+ p data # => <WebhookVersionsResponse>
1154
+ rescue Zyphr::ApiError => e
1155
+ puts "Error when calling WebhooksApi->list_webhook_versions_with_http_info: #{e}"
1156
+ end
1157
+ ```
1158
+
1159
+ ### Parameters
1160
+
1161
+ This endpoint does not need any parameter.
1162
+
1163
+ ### Return type
1164
+
1165
+ [**WebhookVersionsResponse**](WebhookVersionsResponse.md)
1166
+
1167
+ ### Authorization
1168
+
1169
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
1170
+
1171
+ ### HTTP request headers
1172
+
1173
+ - **Content-Type**: Not defined
1174
+ - **Accept**: application/json
1175
+
1176
+
1177
+ ## list_webhooks
1178
+
1179
+ > <WebhookListResponse> list_webhooks(opts)
1180
+
1181
+ List webhooks
1182
+
1183
+ List all webhooks for the workspace with pagination.
1184
+
1185
+ ### Examples
1186
+
1187
+ ```ruby
1188
+ require 'time'
1189
+ require 'zyphr'
1190
+ # setup authorization
1191
+ Zyphr.configure do |config|
1192
+ # Configure API key authorization: ApiKeyAuth
1193
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
1194
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1195
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
1196
+ end
1197
+
1198
+ api_instance = Zyphr::WebhooksApi.new
1199
+ opts = {
1200
+ limit: 56, # Integer | Maximum number of webhooks to return
1201
+ offset: 56 # Integer | Number of webhooks to skip
1202
+ }
1203
+
1204
+ begin
1205
+ # List webhooks
1206
+ result = api_instance.list_webhooks(opts)
1207
+ p result
1208
+ rescue Zyphr::ApiError => e
1209
+ puts "Error when calling WebhooksApi->list_webhooks: #{e}"
1210
+ end
1211
+ ```
1212
+
1213
+ #### Using the list_webhooks_with_http_info variant
1214
+
1215
+ This returns an Array which contains the response data, status code and headers.
1216
+
1217
+ > <Array(<WebhookListResponse>, Integer, Hash)> list_webhooks_with_http_info(opts)
1218
+
1219
+ ```ruby
1220
+ begin
1221
+ # List webhooks
1222
+ data, status_code, headers = api_instance.list_webhooks_with_http_info(opts)
1223
+ p status_code # => 2xx
1224
+ p headers # => { ... }
1225
+ p data # => <WebhookListResponse>
1226
+ rescue Zyphr::ApiError => e
1227
+ puts "Error when calling WebhooksApi->list_webhooks_with_http_info: #{e}"
1228
+ end
1229
+ ```
1230
+
1231
+ ### Parameters
1232
+
1233
+ | Name | Type | Description | Notes |
1234
+ | ---- | ---- | ----------- | ----- |
1235
+ | **limit** | **Integer** | Maximum number of webhooks to return | [optional][default to 50] |
1236
+ | **offset** | **Integer** | Number of webhooks to skip | [optional][default to 0] |
1237
+
1238
+ ### Return type
1239
+
1240
+ [**WebhookListResponse**](WebhookListResponse.md)
1241
+
1242
+ ### Authorization
1243
+
1244
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
1245
+
1246
+ ### HTTP request headers
1247
+
1248
+ - **Content-Type**: Not defined
1249
+ - **Accept**: application/json
1250
+
1251
+
1252
+ ## replay_webhook_events
1253
+
1254
+ > <WebhookReplayResponse> replay_webhook_events(id, replay_webhook_events_request)
1255
+
1256
+ Replay webhook events
1257
+
1258
+ Replay events for a webhook within a date range. Creates an asynchronous job that re-delivers matching events.
1259
+
1260
+ ### Examples
1261
+
1262
+ ```ruby
1263
+ require 'time'
1264
+ require 'zyphr'
1265
+ # setup authorization
1266
+ Zyphr.configure do |config|
1267
+ # Configure API key authorization: ApiKeyAuth
1268
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
1269
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1270
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
1271
+ end
1272
+
1273
+ api_instance = Zyphr::WebhooksApi.new
1274
+ id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Webhook ID
1275
+ replay_webhook_events_request = Zyphr::ReplayWebhookEventsRequest.new({start_date: Time.now, end_date: Time.now}) # ReplayWebhookEventsRequest |
1276
+
1277
+ begin
1278
+ # Replay webhook events
1279
+ result = api_instance.replay_webhook_events(id, replay_webhook_events_request)
1280
+ p result
1281
+ rescue Zyphr::ApiError => e
1282
+ puts "Error when calling WebhooksApi->replay_webhook_events: #{e}"
1283
+ end
1284
+ ```
1285
+
1286
+ #### Using the replay_webhook_events_with_http_info variant
1287
+
1288
+ This returns an Array which contains the response data, status code and headers.
1289
+
1290
+ > <Array(<WebhookReplayResponse>, Integer, Hash)> replay_webhook_events_with_http_info(id, replay_webhook_events_request)
1291
+
1292
+ ```ruby
1293
+ begin
1294
+ # Replay webhook events
1295
+ data, status_code, headers = api_instance.replay_webhook_events_with_http_info(id, replay_webhook_events_request)
1296
+ p status_code # => 2xx
1297
+ p headers # => { ... }
1298
+ p data # => <WebhookReplayResponse>
1299
+ rescue Zyphr::ApiError => e
1300
+ puts "Error when calling WebhooksApi->replay_webhook_events_with_http_info: #{e}"
1301
+ end
1302
+ ```
1303
+
1304
+ ### Parameters
1305
+
1306
+ | Name | Type | Description | Notes |
1307
+ | ---- | ---- | ----------- | ----- |
1308
+ | **id** | **String** | Webhook ID | |
1309
+ | **replay_webhook_events_request** | [**ReplayWebhookEventsRequest**](ReplayWebhookEventsRequest.md) | | |
1310
+
1311
+ ### Return type
1312
+
1313
+ [**WebhookReplayResponse**](WebhookReplayResponse.md)
1314
+
1315
+ ### Authorization
1316
+
1317
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
1318
+
1319
+ ### HTTP request headers
1320
+
1321
+ - **Content-Type**: application/json
1322
+ - **Accept**: application/json
1323
+
1324
+
1325
+ ## retry_webhook_delivery
1326
+
1327
+ > <WebhookDeliveryRetryResponse> retry_webhook_delivery(id, delivery_id)
1328
+
1329
+ Retry webhook delivery
1330
+
1331
+ Retry a failed or exhausted webhook delivery. Only deliveries with status 'failed' or 'exhausted' can be retried.
1332
+
1333
+ ### Examples
1334
+
1335
+ ```ruby
1336
+ require 'time'
1337
+ require 'zyphr'
1338
+ # setup authorization
1339
+ Zyphr.configure do |config|
1340
+ # Configure API key authorization: ApiKeyAuth
1341
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
1342
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1343
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
1344
+ end
1345
+
1346
+ api_instance = Zyphr::WebhooksApi.new
1347
+ id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Webhook ID
1348
+ delivery_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Delivery ID
1349
+
1350
+ begin
1351
+ # Retry webhook delivery
1352
+ result = api_instance.retry_webhook_delivery(id, delivery_id)
1353
+ p result
1354
+ rescue Zyphr::ApiError => e
1355
+ puts "Error when calling WebhooksApi->retry_webhook_delivery: #{e}"
1356
+ end
1357
+ ```
1358
+
1359
+ #### Using the retry_webhook_delivery_with_http_info variant
1360
+
1361
+ This returns an Array which contains the response data, status code and headers.
1362
+
1363
+ > <Array(<WebhookDeliveryRetryResponse>, Integer, Hash)> retry_webhook_delivery_with_http_info(id, delivery_id)
1364
+
1365
+ ```ruby
1366
+ begin
1367
+ # Retry webhook delivery
1368
+ data, status_code, headers = api_instance.retry_webhook_delivery_with_http_info(id, delivery_id)
1369
+ p status_code # => 2xx
1370
+ p headers # => { ... }
1371
+ p data # => <WebhookDeliveryRetryResponse>
1372
+ rescue Zyphr::ApiError => e
1373
+ puts "Error when calling WebhooksApi->retry_webhook_delivery_with_http_info: #{e}"
1374
+ end
1375
+ ```
1376
+
1377
+ ### Parameters
1378
+
1379
+ | Name | Type | Description | Notes |
1380
+ | ---- | ---- | ----------- | ----- |
1381
+ | **id** | **String** | Webhook ID | |
1382
+ | **delivery_id** | **String** | Delivery ID | |
1383
+
1384
+ ### Return type
1385
+
1386
+ [**WebhookDeliveryRetryResponse**](WebhookDeliveryRetryResponse.md)
1387
+
1388
+ ### Authorization
1389
+
1390
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
1391
+
1392
+ ### HTTP request headers
1393
+
1394
+ - **Content-Type**: Not defined
1395
+ - **Accept**: application/json
1396
+
1397
+
1398
+ ## rotate_webhook_secret
1399
+
1400
+ > <WebhookSecretRotateResponse> rotate_webhook_secret(id)
1401
+
1402
+ Rotate webhook secret
1403
+
1404
+ Rotate the signing secret for a webhook. The new secret is only returned once.
1405
+
1406
+ ### Examples
1407
+
1408
+ ```ruby
1409
+ require 'time'
1410
+ require 'zyphr'
1411
+ # setup authorization
1412
+ Zyphr.configure do |config|
1413
+ # Configure API key authorization: ApiKeyAuth
1414
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
1415
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1416
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
1417
+ end
1418
+
1419
+ api_instance = Zyphr::WebhooksApi.new
1420
+ id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Webhook ID
1421
+
1422
+ begin
1423
+ # Rotate webhook secret
1424
+ result = api_instance.rotate_webhook_secret(id)
1425
+ p result
1426
+ rescue Zyphr::ApiError => e
1427
+ puts "Error when calling WebhooksApi->rotate_webhook_secret: #{e}"
1428
+ end
1429
+ ```
1430
+
1431
+ #### Using the rotate_webhook_secret_with_http_info variant
1432
+
1433
+ This returns an Array which contains the response data, status code and headers.
1434
+
1435
+ > <Array(<WebhookSecretRotateResponse>, Integer, Hash)> rotate_webhook_secret_with_http_info(id)
1436
+
1437
+ ```ruby
1438
+ begin
1439
+ # Rotate webhook secret
1440
+ data, status_code, headers = api_instance.rotate_webhook_secret_with_http_info(id)
1441
+ p status_code # => 2xx
1442
+ p headers # => { ... }
1443
+ p data # => <WebhookSecretRotateResponse>
1444
+ rescue Zyphr::ApiError => e
1445
+ puts "Error when calling WebhooksApi->rotate_webhook_secret_with_http_info: #{e}"
1446
+ end
1447
+ ```
1448
+
1449
+ ### Parameters
1450
+
1451
+ | Name | Type | Description | Notes |
1452
+ | ---- | ---- | ----------- | ----- |
1453
+ | **id** | **String** | Webhook ID | |
1454
+
1455
+ ### Return type
1456
+
1457
+ [**WebhookSecretRotateResponse**](WebhookSecretRotateResponse.md)
1458
+
1459
+ ### Authorization
1460
+
1461
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
1462
+
1463
+ ### HTTP request headers
1464
+
1465
+ - **Content-Type**: Not defined
1466
+ - **Accept**: application/json
1467
+
1468
+
1469
+ ## send_webhook_test_event
1470
+
1471
+ > <WebhookTestEventResponse> send_webhook_test_event(id, opts)
1472
+
1473
+ Send test event
1474
+
1475
+ Send a test event to the webhook endpoint. Accepts optional event_type and custom payload.
1476
+
1477
+ ### Examples
1478
+
1479
+ ```ruby
1480
+ require 'time'
1481
+ require 'zyphr'
1482
+ # setup authorization
1483
+ Zyphr.configure do |config|
1484
+ # Configure API key authorization: ApiKeyAuth
1485
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
1486
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1487
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
1488
+ end
1489
+
1490
+ api_instance = Zyphr::WebhooksApi.new
1491
+ id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Webhook ID
1492
+ opts = {
1493
+ send_webhook_test_event_request: Zyphr::SendWebhookTestEventRequest.new # SendWebhookTestEventRequest |
1494
+ }
1495
+
1496
+ begin
1497
+ # Send test event
1498
+ result = api_instance.send_webhook_test_event(id, opts)
1499
+ p result
1500
+ rescue Zyphr::ApiError => e
1501
+ puts "Error when calling WebhooksApi->send_webhook_test_event: #{e}"
1502
+ end
1503
+ ```
1504
+
1505
+ #### Using the send_webhook_test_event_with_http_info variant
1506
+
1507
+ This returns an Array which contains the response data, status code and headers.
1508
+
1509
+ > <Array(<WebhookTestEventResponse>, Integer, Hash)> send_webhook_test_event_with_http_info(id, opts)
1510
+
1511
+ ```ruby
1512
+ begin
1513
+ # Send test event
1514
+ data, status_code, headers = api_instance.send_webhook_test_event_with_http_info(id, opts)
1515
+ p status_code # => 2xx
1516
+ p headers # => { ... }
1517
+ p data # => <WebhookTestEventResponse>
1518
+ rescue Zyphr::ApiError => e
1519
+ puts "Error when calling WebhooksApi->send_webhook_test_event_with_http_info: #{e}"
1520
+ end
1521
+ ```
1522
+
1523
+ ### Parameters
1524
+
1525
+ | Name | Type | Description | Notes |
1526
+ | ---- | ---- | ----------- | ----- |
1527
+ | **id** | **String** | Webhook ID | |
1528
+ | **send_webhook_test_event_request** | [**SendWebhookTestEventRequest**](SendWebhookTestEventRequest.md) | | [optional] |
1529
+
1530
+ ### Return type
1531
+
1532
+ [**WebhookTestEventResponse**](WebhookTestEventResponse.md)
1533
+
1534
+ ### Authorization
1535
+
1536
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
1537
+
1538
+ ### HTTP request headers
1539
+
1540
+ - **Content-Type**: application/json
1541
+ - **Accept**: application/json
1542
+
1543
+
1544
+ ## test_webhook_transform
1545
+
1546
+ > <WebhookTransformTestResponse> test_webhook_transform(id, test_webhook_transform_request)
1547
+
1548
+ Test payload transformation
1549
+
1550
+ Preview how a payload would be transformed by the webhook's transformation rules without actually delivering.
1551
+
1552
+ ### Examples
1553
+
1554
+ ```ruby
1555
+ require 'time'
1556
+ require 'zyphr'
1557
+ # setup authorization
1558
+ Zyphr.configure do |config|
1559
+ # Configure API key authorization: ApiKeyAuth
1560
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
1561
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1562
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
1563
+ end
1564
+
1565
+ api_instance = Zyphr::WebhooksApi.new
1566
+ id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Webhook ID
1567
+ test_webhook_transform_request = Zyphr::TestWebhookTransformRequest.new({payload: 3.56}) # TestWebhookTransformRequest |
1568
+
1569
+ begin
1570
+ # Test payload transformation
1571
+ result = api_instance.test_webhook_transform(id, test_webhook_transform_request)
1572
+ p result
1573
+ rescue Zyphr::ApiError => e
1574
+ puts "Error when calling WebhooksApi->test_webhook_transform: #{e}"
1575
+ end
1576
+ ```
1577
+
1578
+ #### Using the test_webhook_transform_with_http_info variant
1579
+
1580
+ This returns an Array which contains the response data, status code and headers.
1581
+
1582
+ > <Array(<WebhookTransformTestResponse>, Integer, Hash)> test_webhook_transform_with_http_info(id, test_webhook_transform_request)
1583
+
1584
+ ```ruby
1585
+ begin
1586
+ # Test payload transformation
1587
+ data, status_code, headers = api_instance.test_webhook_transform_with_http_info(id, test_webhook_transform_request)
1588
+ p status_code # => 2xx
1589
+ p headers # => { ... }
1590
+ p data # => <WebhookTransformTestResponse>
1591
+ rescue Zyphr::ApiError => e
1592
+ puts "Error when calling WebhooksApi->test_webhook_transform_with_http_info: #{e}"
1593
+ end
1594
+ ```
1595
+
1596
+ ### Parameters
1597
+
1598
+ | Name | Type | Description | Notes |
1599
+ | ---- | ---- | ----------- | ----- |
1600
+ | **id** | **String** | Webhook ID | |
1601
+ | **test_webhook_transform_request** | [**TestWebhookTransformRequest**](TestWebhookTransformRequest.md) | | |
1602
+
1603
+ ### Return type
1604
+
1605
+ [**WebhookTransformTestResponse**](WebhookTransformTestResponse.md)
1606
+
1607
+ ### Authorization
1608
+
1609
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
1610
+
1611
+ ### HTTP request headers
1612
+
1613
+ - **Content-Type**: application/json
1614
+ - **Accept**: application/json
1615
+
1616
+
1617
+ ## update_webhook
1618
+
1619
+ > <WebhookResponse> update_webhook(id, update_webhook_request)
1620
+
1621
+ Update webhook
1622
+
1623
+ Update an existing webhook configuration.
1624
+
1625
+ ### Examples
1626
+
1627
+ ```ruby
1628
+ require 'time'
1629
+ require 'zyphr'
1630
+ # setup authorization
1631
+ Zyphr.configure do |config|
1632
+ # Configure API key authorization: ApiKeyAuth
1633
+ config.api_key['X-API-Key'] = 'YOUR API KEY'
1634
+ # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1635
+ # config.api_key_prefix['X-API-Key'] = 'Bearer'
1636
+ end
1637
+
1638
+ api_instance = Zyphr::WebhooksApi.new
1639
+ id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Webhook ID
1640
+ update_webhook_request = Zyphr::UpdateWebhookRequest.new # UpdateWebhookRequest |
1641
+
1642
+ begin
1643
+ # Update webhook
1644
+ result = api_instance.update_webhook(id, update_webhook_request)
1645
+ p result
1646
+ rescue Zyphr::ApiError => e
1647
+ puts "Error when calling WebhooksApi->update_webhook: #{e}"
1648
+ end
1649
+ ```
1650
+
1651
+ #### Using the update_webhook_with_http_info variant
1652
+
1653
+ This returns an Array which contains the response data, status code and headers.
1654
+
1655
+ > <Array(<WebhookResponse>, Integer, Hash)> update_webhook_with_http_info(id, update_webhook_request)
1656
+
1657
+ ```ruby
1658
+ begin
1659
+ # Update webhook
1660
+ data, status_code, headers = api_instance.update_webhook_with_http_info(id, update_webhook_request)
1661
+ p status_code # => 2xx
1662
+ p headers # => { ... }
1663
+ p data # => <WebhookResponse>
1664
+ rescue Zyphr::ApiError => e
1665
+ puts "Error when calling WebhooksApi->update_webhook_with_http_info: #{e}"
1666
+ end
1667
+ ```
1668
+
1669
+ ### Parameters
1670
+
1671
+ | Name | Type | Description | Notes |
1672
+ | ---- | ---- | ----------- | ----- |
1673
+ | **id** | **String** | Webhook ID | |
1674
+ | **update_webhook_request** | [**UpdateWebhookRequest**](UpdateWebhookRequest.md) | | |
1675
+
1676
+ ### Return type
1677
+
1678
+ [**WebhookResponse**](WebhookResponse.md)
1679
+
1680
+ ### Authorization
1681
+
1682
+ [ApiKeyAuth](../README.md#ApiKeyAuth)
1683
+
1684
+ ### HTTP request headers
1685
+
1686
+ - **Content-Type**: application/json
1687
+ - **Accept**: application/json
1688
+