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,229 @@
1
+ =begin
2
+ #Zyphr API
3
+
4
+ #Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## Authentication All API requests require authentication using an API key. Include your API key in the `X-API-Key` header: ``` X-API-Key: zy_live_xxxxxxxxxxxx ``` API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production. ## Rate Limiting The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets ## Errors All errors follow a consistent format: ```json { \"error\": { \"code\": \"error_code\", \"message\": \"Human readable message\", \"details\": {} }, \"meta\": { \"request_id\": \"req_xxxx\" } } ```
5
+
6
+ The version of the OpenAPI document: 1.0.0
7
+ Contact: support@zyphr.dev
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.12.0
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module Zyphr
17
+ class TopicResponse
18
+ attr_accessor :data
19
+
20
+ attr_accessor :meta
21
+
22
+ # Attribute mapping from ruby-style variable name to JSON key.
23
+ def self.attribute_map
24
+ {
25
+ :'data' => :'data',
26
+ :'meta' => :'meta'
27
+ }
28
+ end
29
+
30
+ # Returns attribute mapping this model knows about
31
+ def self.acceptable_attribute_map
32
+ attribute_map
33
+ end
34
+
35
+ # Returns all the JSON keys this model knows about
36
+ def self.acceptable_attributes
37
+ acceptable_attribute_map.values
38
+ end
39
+
40
+ # Attribute type mapping.
41
+ def self.openapi_types
42
+ {
43
+ :'data' => :'Topic',
44
+ :'meta' => :'RequestMeta'
45
+ }
46
+ end
47
+
48
+ # List of attributes with nullable: true
49
+ def self.openapi_nullable
50
+ Set.new([
51
+ ])
52
+ end
53
+
54
+ # Initializes the object
55
+ # @param [Hash] attributes Model attributes in the form of hash
56
+ def initialize(attributes = {})
57
+ if (!attributes.is_a?(Hash))
58
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Zyphr::TopicResponse` initialize method"
59
+ end
60
+
61
+ # check to see if the attribute exists and convert string to symbol for hash key
62
+ acceptable_attribute_map = self.class.acceptable_attribute_map
63
+ attributes = attributes.each_with_object({}) { |(k, v), h|
64
+ if (!acceptable_attribute_map.key?(k.to_sym))
65
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Zyphr::TopicResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
66
+ end
67
+ h[k.to_sym] = v
68
+ }
69
+
70
+ if attributes.key?(:'data')
71
+ self.data = attributes[:'data']
72
+ end
73
+
74
+ if attributes.key?(:'meta')
75
+ self.meta = attributes[:'meta']
76
+ end
77
+ end
78
+
79
+ # Show invalid properties with the reasons. Usually used together with valid?
80
+ # @return Array for valid properties with the reasons
81
+ def list_invalid_properties
82
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
83
+ invalid_properties = Array.new
84
+ invalid_properties
85
+ end
86
+
87
+ # Check to see if the all the properties in the model are valid
88
+ # @return true if the model is valid
89
+ def valid?
90
+ warn '[DEPRECATED] the `valid?` method is obsolete'
91
+ true
92
+ end
93
+
94
+ # Checks equality by comparing each attribute.
95
+ # @param [Object] Object to be compared
96
+ def ==(o)
97
+ return true if self.equal?(o)
98
+ self.class == o.class &&
99
+ data == o.data &&
100
+ meta == o.meta
101
+ end
102
+
103
+ # @see the `==` method
104
+ # @param [Object] Object to be compared
105
+ def eql?(o)
106
+ self == o
107
+ end
108
+
109
+ # Calculates hash code according to all attributes.
110
+ # @return [Integer] Hash code
111
+ def hash
112
+ [data, meta].hash
113
+ end
114
+
115
+ # Builds the object from hash
116
+ # @param [Hash] attributes Model attributes in the form of hash
117
+ # @return [Object] Returns the model itself
118
+ def self.build_from_hash(attributes)
119
+ return nil unless attributes.is_a?(Hash)
120
+ attributes = attributes.transform_keys(&:to_sym)
121
+ transformed_hash = {}
122
+ openapi_types.each_pair do |key, type|
123
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
124
+ transformed_hash["#{key}"] = nil
125
+ elsif type =~ /\AArray<(.*)>/i
126
+ # check to ensure the input is an array given that the attribute
127
+ # is documented as an array but the input is not
128
+ if attributes[attribute_map[key]].is_a?(Array)
129
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
130
+ end
131
+ elsif !attributes[attribute_map[key]].nil?
132
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
133
+ end
134
+ end
135
+ new(transformed_hash)
136
+ end
137
+
138
+ # Deserializes the data based on type
139
+ # @param string type Data type
140
+ # @param string value Value to be deserialized
141
+ # @return [Object] Deserialized data
142
+ def self._deserialize(type, value)
143
+ case type.to_sym
144
+ when :Time
145
+ Time.parse(value)
146
+ when :Date
147
+ Date.parse(value)
148
+ when :String
149
+ value.to_s
150
+ when :Integer
151
+ value.to_i
152
+ when :Float
153
+ value.to_f
154
+ when :Boolean
155
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
156
+ true
157
+ else
158
+ false
159
+ end
160
+ when :Object
161
+ # generic object (usually a Hash), return directly
162
+ value
163
+ when /\AArray<(?<inner_type>.+)>\z/
164
+ inner_type = Regexp.last_match[:inner_type]
165
+ value.map { |v| _deserialize(inner_type, v) }
166
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
167
+ k_type = Regexp.last_match[:k_type]
168
+ v_type = Regexp.last_match[:v_type]
169
+ {}.tap do |hash|
170
+ value.each do |k, v|
171
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
172
+ end
173
+ end
174
+ else # model
175
+ # models (e.g. Pet) or oneOf
176
+ klass = Zyphr.const_get(type)
177
+ klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
178
+ end
179
+ end
180
+
181
+ # Returns the string representation of the object
182
+ # @return [String] String presentation of the object
183
+ def to_s
184
+ to_hash.to_s
185
+ end
186
+
187
+ # to_body is an alias to to_hash (backward compatibility)
188
+ # @return [Hash] Returns the object in the form of hash
189
+ def to_body
190
+ to_hash
191
+ end
192
+
193
+ # Returns the object in the form of hash
194
+ # @return [Hash] Returns the object in the form of hash
195
+ def to_hash
196
+ hash = {}
197
+ self.class.attribute_map.each_pair do |attr, param|
198
+ value = self.send(attr)
199
+ if value.nil?
200
+ is_nullable = self.class.openapi_nullable.include?(attr)
201
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
202
+ end
203
+
204
+ hash[param] = _to_hash(value)
205
+ end
206
+ hash
207
+ end
208
+
209
+ # Outputs non-array value in the form of hash
210
+ # For object, use to_hash. Otherwise, just return the value
211
+ # @param [Object] value Any valid value
212
+ # @return [Hash] Returns the value in the form of hash
213
+ def _to_hash(value)
214
+ if value.is_a?(Array)
215
+ value.compact.map { |v| _to_hash(v) }
216
+ elsif value.is_a?(Hash)
217
+ {}.tap do |hash|
218
+ value.each { |k, v| hash[k] = _to_hash(v) }
219
+ end
220
+ elsif value.respond_to? :to_hash
221
+ value.to_hash
222
+ else
223
+ value
224
+ end
225
+ end
226
+
227
+ end
228
+
229
+ end
@@ -0,0 +1,240 @@
1
+ =begin
2
+ #Zyphr API
3
+
4
+ #Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## Authentication All API requests require authentication using an API key. Include your API key in the `X-API-Key` header: ``` X-API-Key: zy_live_xxxxxxxxxxxx ``` API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production. ## Rate Limiting The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets ## Errors All errors follow a consistent format: ```json { \"error\": { \"code\": \"error_code\", \"message\": \"Human readable message\", \"details\": {} }, \"meta\": { \"request_id\": \"req_xxxx\" } } ```
5
+
6
+ The version of the OpenAPI document: 1.0.0
7
+ Contact: support@zyphr.dev
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.12.0
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module Zyphr
17
+ class TopicStatsData
18
+ attr_accessor :total_topics
19
+
20
+ attr_accessor :total_subscribers
21
+
22
+ attr_accessor :topics_by_subscriber_count
23
+
24
+ # Attribute mapping from ruby-style variable name to JSON key.
25
+ def self.attribute_map
26
+ {
27
+ :'total_topics' => :'total_topics',
28
+ :'total_subscribers' => :'total_subscribers',
29
+ :'topics_by_subscriber_count' => :'topics_by_subscriber_count'
30
+ }
31
+ end
32
+
33
+ # Returns attribute mapping this model knows about
34
+ def self.acceptable_attribute_map
35
+ attribute_map
36
+ end
37
+
38
+ # Returns all the JSON keys this model knows about
39
+ def self.acceptable_attributes
40
+ acceptable_attribute_map.values
41
+ end
42
+
43
+ # Attribute type mapping.
44
+ def self.openapi_types
45
+ {
46
+ :'total_topics' => :'Integer',
47
+ :'total_subscribers' => :'Integer',
48
+ :'topics_by_subscriber_count' => :'Array<TopicStatsDataTopicsBySubscriberCountInner>'
49
+ }
50
+ end
51
+
52
+ # List of attributes with nullable: true
53
+ def self.openapi_nullable
54
+ Set.new([
55
+ ])
56
+ end
57
+
58
+ # Initializes the object
59
+ # @param [Hash] attributes Model attributes in the form of hash
60
+ def initialize(attributes = {})
61
+ if (!attributes.is_a?(Hash))
62
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Zyphr::TopicStatsData` initialize method"
63
+ end
64
+
65
+ # check to see if the attribute exists and convert string to symbol for hash key
66
+ acceptable_attribute_map = self.class.acceptable_attribute_map
67
+ attributes = attributes.each_with_object({}) { |(k, v), h|
68
+ if (!acceptable_attribute_map.key?(k.to_sym))
69
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Zyphr::TopicStatsData`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
70
+ end
71
+ h[k.to_sym] = v
72
+ }
73
+
74
+ if attributes.key?(:'total_topics')
75
+ self.total_topics = attributes[:'total_topics']
76
+ end
77
+
78
+ if attributes.key?(:'total_subscribers')
79
+ self.total_subscribers = attributes[:'total_subscribers']
80
+ end
81
+
82
+ if attributes.key?(:'topics_by_subscriber_count')
83
+ if (value = attributes[:'topics_by_subscriber_count']).is_a?(Array)
84
+ self.topics_by_subscriber_count = value
85
+ end
86
+ end
87
+ end
88
+
89
+ # Show invalid properties with the reasons. Usually used together with valid?
90
+ # @return Array for valid properties with the reasons
91
+ def list_invalid_properties
92
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
93
+ invalid_properties = Array.new
94
+ invalid_properties
95
+ end
96
+
97
+ # Check to see if the all the properties in the model are valid
98
+ # @return true if the model is valid
99
+ def valid?
100
+ warn '[DEPRECATED] the `valid?` method is obsolete'
101
+ true
102
+ end
103
+
104
+ # Checks equality by comparing each attribute.
105
+ # @param [Object] Object to be compared
106
+ def ==(o)
107
+ return true if self.equal?(o)
108
+ self.class == o.class &&
109
+ total_topics == o.total_topics &&
110
+ total_subscribers == o.total_subscribers &&
111
+ topics_by_subscriber_count == o.topics_by_subscriber_count
112
+ end
113
+
114
+ # @see the `==` method
115
+ # @param [Object] Object to be compared
116
+ def eql?(o)
117
+ self == o
118
+ end
119
+
120
+ # Calculates hash code according to all attributes.
121
+ # @return [Integer] Hash code
122
+ def hash
123
+ [total_topics, total_subscribers, topics_by_subscriber_count].hash
124
+ end
125
+
126
+ # Builds the object from hash
127
+ # @param [Hash] attributes Model attributes in the form of hash
128
+ # @return [Object] Returns the model itself
129
+ def self.build_from_hash(attributes)
130
+ return nil unless attributes.is_a?(Hash)
131
+ attributes = attributes.transform_keys(&:to_sym)
132
+ transformed_hash = {}
133
+ openapi_types.each_pair do |key, type|
134
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
135
+ transformed_hash["#{key}"] = nil
136
+ elsif type =~ /\AArray<(.*)>/i
137
+ # check to ensure the input is an array given that the attribute
138
+ # is documented as an array but the input is not
139
+ if attributes[attribute_map[key]].is_a?(Array)
140
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
141
+ end
142
+ elsif !attributes[attribute_map[key]].nil?
143
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
144
+ end
145
+ end
146
+ new(transformed_hash)
147
+ end
148
+
149
+ # Deserializes the data based on type
150
+ # @param string type Data type
151
+ # @param string value Value to be deserialized
152
+ # @return [Object] Deserialized data
153
+ def self._deserialize(type, value)
154
+ case type.to_sym
155
+ when :Time
156
+ Time.parse(value)
157
+ when :Date
158
+ Date.parse(value)
159
+ when :String
160
+ value.to_s
161
+ when :Integer
162
+ value.to_i
163
+ when :Float
164
+ value.to_f
165
+ when :Boolean
166
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
167
+ true
168
+ else
169
+ false
170
+ end
171
+ when :Object
172
+ # generic object (usually a Hash), return directly
173
+ value
174
+ when /\AArray<(?<inner_type>.+)>\z/
175
+ inner_type = Regexp.last_match[:inner_type]
176
+ value.map { |v| _deserialize(inner_type, v) }
177
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
178
+ k_type = Regexp.last_match[:k_type]
179
+ v_type = Regexp.last_match[:v_type]
180
+ {}.tap do |hash|
181
+ value.each do |k, v|
182
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
183
+ end
184
+ end
185
+ else # model
186
+ # models (e.g. Pet) or oneOf
187
+ klass = Zyphr.const_get(type)
188
+ klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
189
+ end
190
+ end
191
+
192
+ # Returns the string representation of the object
193
+ # @return [String] String presentation of the object
194
+ def to_s
195
+ to_hash.to_s
196
+ end
197
+
198
+ # to_body is an alias to to_hash (backward compatibility)
199
+ # @return [Hash] Returns the object in the form of hash
200
+ def to_body
201
+ to_hash
202
+ end
203
+
204
+ # Returns the object in the form of hash
205
+ # @return [Hash] Returns the object in the form of hash
206
+ def to_hash
207
+ hash = {}
208
+ self.class.attribute_map.each_pair do |attr, param|
209
+ value = self.send(attr)
210
+ if value.nil?
211
+ is_nullable = self.class.openapi_nullable.include?(attr)
212
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
213
+ end
214
+
215
+ hash[param] = _to_hash(value)
216
+ end
217
+ hash
218
+ end
219
+
220
+ # Outputs non-array value in the form of hash
221
+ # For object, use to_hash. Otherwise, just return the value
222
+ # @param [Object] value Any valid value
223
+ # @return [Hash] Returns the value in the form of hash
224
+ def _to_hash(value)
225
+ if value.is_a?(Array)
226
+ value.compact.map { |v| _to_hash(v) }
227
+ elsif value.is_a?(Hash)
228
+ {}.tap do |hash|
229
+ value.each { |k, v| hash[k] = _to_hash(v) }
230
+ end
231
+ elsif value.respond_to? :to_hash
232
+ value.to_hash
233
+ else
234
+ value
235
+ end
236
+ end
237
+
238
+ end
239
+
240
+ end
@@ -0,0 +1,238 @@
1
+ =begin
2
+ #Zyphr API
3
+
4
+ #Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## Authentication All API requests require authentication using an API key. Include your API key in the `X-API-Key` header: ``` X-API-Key: zy_live_xxxxxxxxxxxx ``` API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production. ## Rate Limiting The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets ## Errors All errors follow a consistent format: ```json { \"error\": { \"code\": \"error_code\", \"message\": \"Human readable message\", \"details\": {} }, \"meta\": { \"request_id\": \"req_xxxx\" } } ```
5
+
6
+ The version of the OpenAPI document: 1.0.0
7
+ Contact: support@zyphr.dev
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.12.0
10
+
11
+ =end
12
+
13
+ require 'date'
14
+ require 'time'
15
+
16
+ module Zyphr
17
+ class TopicStatsDataTopicsBySubscriberCountInner
18
+ attr_accessor :key
19
+
20
+ attr_accessor :name
21
+
22
+ attr_accessor :subscriber_count
23
+
24
+ # Attribute mapping from ruby-style variable name to JSON key.
25
+ def self.attribute_map
26
+ {
27
+ :'key' => :'key',
28
+ :'name' => :'name',
29
+ :'subscriber_count' => :'subscriber_count'
30
+ }
31
+ end
32
+
33
+ # Returns attribute mapping this model knows about
34
+ def self.acceptable_attribute_map
35
+ attribute_map
36
+ end
37
+
38
+ # Returns all the JSON keys this model knows about
39
+ def self.acceptable_attributes
40
+ acceptable_attribute_map.values
41
+ end
42
+
43
+ # Attribute type mapping.
44
+ def self.openapi_types
45
+ {
46
+ :'key' => :'String',
47
+ :'name' => :'String',
48
+ :'subscriber_count' => :'Integer'
49
+ }
50
+ end
51
+
52
+ # List of attributes with nullable: true
53
+ def self.openapi_nullable
54
+ Set.new([
55
+ ])
56
+ end
57
+
58
+ # Initializes the object
59
+ # @param [Hash] attributes Model attributes in the form of hash
60
+ def initialize(attributes = {})
61
+ if (!attributes.is_a?(Hash))
62
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Zyphr::TopicStatsDataTopicsBySubscriberCountInner` initialize method"
63
+ end
64
+
65
+ # check to see if the attribute exists and convert string to symbol for hash key
66
+ acceptable_attribute_map = self.class.acceptable_attribute_map
67
+ attributes = attributes.each_with_object({}) { |(k, v), h|
68
+ if (!acceptable_attribute_map.key?(k.to_sym))
69
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Zyphr::TopicStatsDataTopicsBySubscriberCountInner`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
70
+ end
71
+ h[k.to_sym] = v
72
+ }
73
+
74
+ if attributes.key?(:'key')
75
+ self.key = attributes[:'key']
76
+ end
77
+
78
+ if attributes.key?(:'name')
79
+ self.name = attributes[:'name']
80
+ end
81
+
82
+ if attributes.key?(:'subscriber_count')
83
+ self.subscriber_count = attributes[:'subscriber_count']
84
+ end
85
+ end
86
+
87
+ # Show invalid properties with the reasons. Usually used together with valid?
88
+ # @return Array for valid properties with the reasons
89
+ def list_invalid_properties
90
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
91
+ invalid_properties = Array.new
92
+ invalid_properties
93
+ end
94
+
95
+ # Check to see if the all the properties in the model are valid
96
+ # @return true if the model is valid
97
+ def valid?
98
+ warn '[DEPRECATED] the `valid?` method is obsolete'
99
+ true
100
+ end
101
+
102
+ # Checks equality by comparing each attribute.
103
+ # @param [Object] Object to be compared
104
+ def ==(o)
105
+ return true if self.equal?(o)
106
+ self.class == o.class &&
107
+ key == o.key &&
108
+ name == o.name &&
109
+ subscriber_count == o.subscriber_count
110
+ end
111
+
112
+ # @see the `==` method
113
+ # @param [Object] Object to be compared
114
+ def eql?(o)
115
+ self == o
116
+ end
117
+
118
+ # Calculates hash code according to all attributes.
119
+ # @return [Integer] Hash code
120
+ def hash
121
+ [key, name, subscriber_count].hash
122
+ end
123
+
124
+ # Builds the object from hash
125
+ # @param [Hash] attributes Model attributes in the form of hash
126
+ # @return [Object] Returns the model itself
127
+ def self.build_from_hash(attributes)
128
+ return nil unless attributes.is_a?(Hash)
129
+ attributes = attributes.transform_keys(&:to_sym)
130
+ transformed_hash = {}
131
+ openapi_types.each_pair do |key, type|
132
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
133
+ transformed_hash["#{key}"] = nil
134
+ elsif type =~ /\AArray<(.*)>/i
135
+ # check to ensure the input is an array given that the attribute
136
+ # is documented as an array but the input is not
137
+ if attributes[attribute_map[key]].is_a?(Array)
138
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
139
+ end
140
+ elsif !attributes[attribute_map[key]].nil?
141
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
142
+ end
143
+ end
144
+ new(transformed_hash)
145
+ end
146
+
147
+ # Deserializes the data based on type
148
+ # @param string type Data type
149
+ # @param string value Value to be deserialized
150
+ # @return [Object] Deserialized data
151
+ def self._deserialize(type, value)
152
+ case type.to_sym
153
+ when :Time
154
+ Time.parse(value)
155
+ when :Date
156
+ Date.parse(value)
157
+ when :String
158
+ value.to_s
159
+ when :Integer
160
+ value.to_i
161
+ when :Float
162
+ value.to_f
163
+ when :Boolean
164
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
165
+ true
166
+ else
167
+ false
168
+ end
169
+ when :Object
170
+ # generic object (usually a Hash), return directly
171
+ value
172
+ when /\AArray<(?<inner_type>.+)>\z/
173
+ inner_type = Regexp.last_match[:inner_type]
174
+ value.map { |v| _deserialize(inner_type, v) }
175
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
176
+ k_type = Regexp.last_match[:k_type]
177
+ v_type = Regexp.last_match[:v_type]
178
+ {}.tap do |hash|
179
+ value.each do |k, v|
180
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
181
+ end
182
+ end
183
+ else # model
184
+ # models (e.g. Pet) or oneOf
185
+ klass = Zyphr.const_get(type)
186
+ klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
187
+ end
188
+ end
189
+
190
+ # Returns the string representation of the object
191
+ # @return [String] String presentation of the object
192
+ def to_s
193
+ to_hash.to_s
194
+ end
195
+
196
+ # to_body is an alias to to_hash (backward compatibility)
197
+ # @return [Hash] Returns the object in the form of hash
198
+ def to_body
199
+ to_hash
200
+ end
201
+
202
+ # Returns the object in the form of hash
203
+ # @return [Hash] Returns the object in the form of hash
204
+ def to_hash
205
+ hash = {}
206
+ self.class.attribute_map.each_pair do |attr, param|
207
+ value = self.send(attr)
208
+ if value.nil?
209
+ is_nullable = self.class.openapi_nullable.include?(attr)
210
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
211
+ end
212
+
213
+ hash[param] = _to_hash(value)
214
+ end
215
+ hash
216
+ end
217
+
218
+ # Outputs non-array value in the form of hash
219
+ # For object, use to_hash. Otherwise, just return the value
220
+ # @param [Object] value Any valid value
221
+ # @return [Hash] Returns the value in the form of hash
222
+ def _to_hash(value)
223
+ if value.is_a?(Array)
224
+ value.compact.map { |v| _to_hash(v) }
225
+ elsif value.is_a?(Hash)
226
+ {}.tap do |hash|
227
+ value.each { |k, v| hash[k] = _to_hash(v) }
228
+ end
229
+ elsif value.respond_to? :to_hash
230
+ value.to_hash
231
+ else
232
+ value
233
+ end
234
+ end
235
+
236
+ end
237
+
238
+ end