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,231 @@
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 SendBatchInAppResponse
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' => :'Array<InAppNotification>',
44
+ :'meta' => :'SendBatchInAppMeta'
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::SendBatchInAppResponse` 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::SendBatchInAppResponse`. 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
+ if (value = attributes[:'data']).is_a?(Array)
72
+ self.data = value
73
+ end
74
+ end
75
+
76
+ if attributes.key?(:'meta')
77
+ self.meta = attributes[:'meta']
78
+ end
79
+ end
80
+
81
+ # Show invalid properties with the reasons. Usually used together with valid?
82
+ # @return Array for valid properties with the reasons
83
+ def list_invalid_properties
84
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
85
+ invalid_properties = Array.new
86
+ invalid_properties
87
+ end
88
+
89
+ # Check to see if the all the properties in the model are valid
90
+ # @return true if the model is valid
91
+ def valid?
92
+ warn '[DEPRECATED] the `valid?` method is obsolete'
93
+ true
94
+ end
95
+
96
+ # Checks equality by comparing each attribute.
97
+ # @param [Object] Object to be compared
98
+ def ==(o)
99
+ return true if self.equal?(o)
100
+ self.class == o.class &&
101
+ data == o.data &&
102
+ meta == o.meta
103
+ end
104
+
105
+ # @see the `==` method
106
+ # @param [Object] Object to be compared
107
+ def eql?(o)
108
+ self == o
109
+ end
110
+
111
+ # Calculates hash code according to all attributes.
112
+ # @return [Integer] Hash code
113
+ def hash
114
+ [data, meta].hash
115
+ end
116
+
117
+ # Builds the object from hash
118
+ # @param [Hash] attributes Model attributes in the form of hash
119
+ # @return [Object] Returns the model itself
120
+ def self.build_from_hash(attributes)
121
+ return nil unless attributes.is_a?(Hash)
122
+ attributes = attributes.transform_keys(&:to_sym)
123
+ transformed_hash = {}
124
+ openapi_types.each_pair do |key, type|
125
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
126
+ transformed_hash["#{key}"] = nil
127
+ elsif type =~ /\AArray<(.*)>/i
128
+ # check to ensure the input is an array given that the attribute
129
+ # is documented as an array but the input is not
130
+ if attributes[attribute_map[key]].is_a?(Array)
131
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
132
+ end
133
+ elsif !attributes[attribute_map[key]].nil?
134
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
135
+ end
136
+ end
137
+ new(transformed_hash)
138
+ end
139
+
140
+ # Deserializes the data based on type
141
+ # @param string type Data type
142
+ # @param string value Value to be deserialized
143
+ # @return [Object] Deserialized data
144
+ def self._deserialize(type, value)
145
+ case type.to_sym
146
+ when :Time
147
+ Time.parse(value)
148
+ when :Date
149
+ Date.parse(value)
150
+ when :String
151
+ value.to_s
152
+ when :Integer
153
+ value.to_i
154
+ when :Float
155
+ value.to_f
156
+ when :Boolean
157
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
158
+ true
159
+ else
160
+ false
161
+ end
162
+ when :Object
163
+ # generic object (usually a Hash), return directly
164
+ value
165
+ when /\AArray<(?<inner_type>.+)>\z/
166
+ inner_type = Regexp.last_match[:inner_type]
167
+ value.map { |v| _deserialize(inner_type, v) }
168
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
169
+ k_type = Regexp.last_match[:k_type]
170
+ v_type = Regexp.last_match[:v_type]
171
+ {}.tap do |hash|
172
+ value.each do |k, v|
173
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
174
+ end
175
+ end
176
+ else # model
177
+ # models (e.g. Pet) or oneOf
178
+ klass = Zyphr.const_get(type)
179
+ klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
180
+ end
181
+ end
182
+
183
+ # Returns the string representation of the object
184
+ # @return [String] String presentation of the object
185
+ def to_s
186
+ to_hash.to_s
187
+ end
188
+
189
+ # to_body is an alias to to_hash (backward compatibility)
190
+ # @return [Hash] Returns the object in the form of hash
191
+ def to_body
192
+ to_hash
193
+ end
194
+
195
+ # Returns the object in the form of hash
196
+ # @return [Hash] Returns the object in the form of hash
197
+ def to_hash
198
+ hash = {}
199
+ self.class.attribute_map.each_pair do |attr, param|
200
+ value = self.send(attr)
201
+ if value.nil?
202
+ is_nullable = self.class.openapi_nullable.include?(attr)
203
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
204
+ end
205
+
206
+ hash[param] = _to_hash(value)
207
+ end
208
+ hash
209
+ end
210
+
211
+ # Outputs non-array value in the form of hash
212
+ # For object, use to_hash. Otherwise, just return the value
213
+ # @param [Object] value Any valid value
214
+ # @return [Hash] Returns the value in the form of hash
215
+ def _to_hash(value)
216
+ if value.is_a?(Array)
217
+ value.compact.map { |v| _to_hash(v) }
218
+ elsif value.is_a?(Hash)
219
+ {}.tap do |hash|
220
+ value.each { |k, v| hash[k] = _to_hash(v) }
221
+ end
222
+ elsif value.respond_to? :to_hash
223
+ value.to_hash
224
+ else
225
+ value
226
+ end
227
+ end
228
+
229
+ end
230
+
231
+ end
@@ -0,0 +1,251 @@
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 SendBatchSmsData
18
+ attr_accessor :messages
19
+
20
+ attr_accessor :failed
21
+
22
+ attr_accessor :summary
23
+
24
+ attr_accessor :is_test
25
+
26
+ # Attribute mapping from ruby-style variable name to JSON key.
27
+ def self.attribute_map
28
+ {
29
+ :'messages' => :'messages',
30
+ :'failed' => :'failed',
31
+ :'summary' => :'summary',
32
+ :'is_test' => :'is_test'
33
+ }
34
+ end
35
+
36
+ # Returns attribute mapping this model knows about
37
+ def self.acceptable_attribute_map
38
+ attribute_map
39
+ end
40
+
41
+ # Returns all the JSON keys this model knows about
42
+ def self.acceptable_attributes
43
+ acceptable_attribute_map.values
44
+ end
45
+
46
+ # Attribute type mapping.
47
+ def self.openapi_types
48
+ {
49
+ :'messages' => :'Array<SmsBatchResultMessage>',
50
+ :'failed' => :'Array<Object>',
51
+ :'summary' => :'SmsBatchResultSummary',
52
+ :'is_test' => :'Boolean'
53
+ }
54
+ end
55
+
56
+ # List of attributes with nullable: true
57
+ def self.openapi_nullable
58
+ Set.new([
59
+ ])
60
+ end
61
+
62
+ # Initializes the object
63
+ # @param [Hash] attributes Model attributes in the form of hash
64
+ def initialize(attributes = {})
65
+ if (!attributes.is_a?(Hash))
66
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Zyphr::SendBatchSmsData` initialize method"
67
+ end
68
+
69
+ # check to see if the attribute exists and convert string to symbol for hash key
70
+ acceptable_attribute_map = self.class.acceptable_attribute_map
71
+ attributes = attributes.each_with_object({}) { |(k, v), h|
72
+ if (!acceptable_attribute_map.key?(k.to_sym))
73
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Zyphr::SendBatchSmsData`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
74
+ end
75
+ h[k.to_sym] = v
76
+ }
77
+
78
+ if attributes.key?(:'messages')
79
+ if (value = attributes[:'messages']).is_a?(Array)
80
+ self.messages = value
81
+ end
82
+ end
83
+
84
+ if attributes.key?(:'failed')
85
+ if (value = attributes[:'failed']).is_a?(Array)
86
+ self.failed = value
87
+ end
88
+ end
89
+
90
+ if attributes.key?(:'summary')
91
+ self.summary = attributes[:'summary']
92
+ end
93
+
94
+ if attributes.key?(:'is_test')
95
+ self.is_test = attributes[:'is_test']
96
+ end
97
+ end
98
+
99
+ # Show invalid properties with the reasons. Usually used together with valid?
100
+ # @return Array for valid properties with the reasons
101
+ def list_invalid_properties
102
+ warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
103
+ invalid_properties = Array.new
104
+ invalid_properties
105
+ end
106
+
107
+ # Check to see if the all the properties in the model are valid
108
+ # @return true if the model is valid
109
+ def valid?
110
+ warn '[DEPRECATED] the `valid?` method is obsolete'
111
+ true
112
+ end
113
+
114
+ # Checks equality by comparing each attribute.
115
+ # @param [Object] Object to be compared
116
+ def ==(o)
117
+ return true if self.equal?(o)
118
+ self.class == o.class &&
119
+ messages == o.messages &&
120
+ failed == o.failed &&
121
+ summary == o.summary &&
122
+ is_test == o.is_test
123
+ end
124
+
125
+ # @see the `==` method
126
+ # @param [Object] Object to be compared
127
+ def eql?(o)
128
+ self == o
129
+ end
130
+
131
+ # Calculates hash code according to all attributes.
132
+ # @return [Integer] Hash code
133
+ def hash
134
+ [messages, failed, summary, is_test].hash
135
+ end
136
+
137
+ # Builds the object from hash
138
+ # @param [Hash] attributes Model attributes in the form of hash
139
+ # @return [Object] Returns the model itself
140
+ def self.build_from_hash(attributes)
141
+ return nil unless attributes.is_a?(Hash)
142
+ attributes = attributes.transform_keys(&:to_sym)
143
+ transformed_hash = {}
144
+ openapi_types.each_pair do |key, type|
145
+ if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
146
+ transformed_hash["#{key}"] = nil
147
+ elsif type =~ /\AArray<(.*)>/i
148
+ # check to ensure the input is an array given that the attribute
149
+ # is documented as an array but the input is not
150
+ if attributes[attribute_map[key]].is_a?(Array)
151
+ transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
152
+ end
153
+ elsif !attributes[attribute_map[key]].nil?
154
+ transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
155
+ end
156
+ end
157
+ new(transformed_hash)
158
+ end
159
+
160
+ # Deserializes the data based on type
161
+ # @param string type Data type
162
+ # @param string value Value to be deserialized
163
+ # @return [Object] Deserialized data
164
+ def self._deserialize(type, value)
165
+ case type.to_sym
166
+ when :Time
167
+ Time.parse(value)
168
+ when :Date
169
+ Date.parse(value)
170
+ when :String
171
+ value.to_s
172
+ when :Integer
173
+ value.to_i
174
+ when :Float
175
+ value.to_f
176
+ when :Boolean
177
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
178
+ true
179
+ else
180
+ false
181
+ end
182
+ when :Object
183
+ # generic object (usually a Hash), return directly
184
+ value
185
+ when /\AArray<(?<inner_type>.+)>\z/
186
+ inner_type = Regexp.last_match[:inner_type]
187
+ value.map { |v| _deserialize(inner_type, v) }
188
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
189
+ k_type = Regexp.last_match[:k_type]
190
+ v_type = Regexp.last_match[:v_type]
191
+ {}.tap do |hash|
192
+ value.each do |k, v|
193
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
194
+ end
195
+ end
196
+ else # model
197
+ # models (e.g. Pet) or oneOf
198
+ klass = Zyphr.const_get(type)
199
+ klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
200
+ end
201
+ end
202
+
203
+ # Returns the string representation of the object
204
+ # @return [String] String presentation of the object
205
+ def to_s
206
+ to_hash.to_s
207
+ end
208
+
209
+ # to_body is an alias to to_hash (backward compatibility)
210
+ # @return [Hash] Returns the object in the form of hash
211
+ def to_body
212
+ to_hash
213
+ end
214
+
215
+ # Returns the object in the form of hash
216
+ # @return [Hash] Returns the object in the form of hash
217
+ def to_hash
218
+ hash = {}
219
+ self.class.attribute_map.each_pair do |attr, param|
220
+ value = self.send(attr)
221
+ if value.nil?
222
+ is_nullable = self.class.openapi_nullable.include?(attr)
223
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
224
+ end
225
+
226
+ hash[param] = _to_hash(value)
227
+ end
228
+ hash
229
+ end
230
+
231
+ # Outputs non-array value in the form of hash
232
+ # For object, use to_hash. Otherwise, just return the value
233
+ # @param [Object] value Any valid value
234
+ # @return [Hash] Returns the value in the form of hash
235
+ def _to_hash(value)
236
+ if value.is_a?(Array)
237
+ value.compact.map { |v| _to_hash(v) }
238
+ elsif value.is_a?(Hash)
239
+ {}.tap do |hash|
240
+ value.each { |k, v| hash[k] = _to_hash(v) }
241
+ end
242
+ elsif value.respond_to? :to_hash
243
+ value.to_hash
244
+ else
245
+ value
246
+ end
247
+ end
248
+
249
+ end
250
+
251
+ end