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,1340 @@
1
+ =begin
2
+ #Zyphr API
3
+
4
+ #Zyphr is a multi-channel notification platform that enables developers to send emails, push notifications, SMS, and in-app messages through a unified API. ## Authentication All API requests require authentication using an API key. Include your API key in the `X-API-Key` header: ``` X-API-Key: zy_live_xxxxxxxxxxxx ``` API keys can be created in the Zyphr Dashboard. Use `zy_test_*` keys for testing and `zy_live_*` keys for production. ## Rate Limiting The API implements rate limiting to ensure fair usage. Rate limit information is included in response headers: - `X-RateLimit-Limit`: Maximum requests per window - `X-RateLimit-Remaining`: Remaining requests in current window - `X-RateLimit-Reset`: Unix timestamp when the window resets ## Errors All errors follow a consistent format: ```json { \"error\": { \"code\": \"error_code\", \"message\": \"Human readable message\", \"details\": {} }, \"meta\": { \"request_id\": \"req_xxxx\" } } ```
5
+
6
+ The version of the OpenAPI document: 1.0.0
7
+ Contact: support@zyphr.dev
8
+ Generated by: https://openapi-generator.tech
9
+ Generator version: 7.12.0
10
+
11
+ =end
12
+
13
+ require 'cgi'
14
+
15
+ module Zyphr
16
+ class SubscribersApi
17
+ attr_accessor :api_client
18
+
19
+ def initialize(api_client = ApiClient.default)
20
+ @api_client = api_client
21
+ end
22
+ # Create a notification category
23
+ # @param create_category_request [CreateCategoryRequest]
24
+ # @param [Hash] opts the optional parameters
25
+ # @return [CategoryResponse]
26
+ def create_category(create_category_request, opts = {})
27
+ data, _status_code, _headers = create_category_with_http_info(create_category_request, opts)
28
+ data
29
+ end
30
+
31
+ # Create a notification category
32
+ # @param create_category_request [CreateCategoryRequest]
33
+ # @param [Hash] opts the optional parameters
34
+ # @return [Array<(CategoryResponse, Integer, Hash)>] CategoryResponse data, response status code and response headers
35
+ def create_category_with_http_info(create_category_request, opts = {})
36
+ if @api_client.config.debugging
37
+ @api_client.config.logger.debug 'Calling API: SubscribersApi.create_category ...'
38
+ end
39
+ # verify the required parameter 'create_category_request' is set
40
+ if @api_client.config.client_side_validation && create_category_request.nil?
41
+ fail ArgumentError, "Missing the required parameter 'create_category_request' when calling SubscribersApi.create_category"
42
+ end
43
+ # resource path
44
+ local_var_path = '/subscribers/categories'
45
+
46
+ # query parameters
47
+ query_params = opts[:query_params] || {}
48
+
49
+ # header parameters
50
+ header_params = opts[:header_params] || {}
51
+ # HTTP header 'Accept' (if needed)
52
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
53
+ # HTTP header 'Content-Type'
54
+ content_type = @api_client.select_header_content_type(['application/json'])
55
+ if !content_type.nil?
56
+ header_params['Content-Type'] = content_type
57
+ end
58
+
59
+ # form parameters
60
+ form_params = opts[:form_params] || {}
61
+
62
+ # http body (model)
63
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(create_category_request)
64
+
65
+ # return_type
66
+ return_type = opts[:debug_return_type] || 'CategoryResponse'
67
+
68
+ # auth_names
69
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
70
+
71
+ new_options = opts.merge(
72
+ :operation => :"SubscribersApi.create_category",
73
+ :header_params => header_params,
74
+ :query_params => query_params,
75
+ :form_params => form_params,
76
+ :body => post_body,
77
+ :auth_names => auth_names,
78
+ :return_type => return_type
79
+ )
80
+
81
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
82
+ if @api_client.config.debugging
83
+ @api_client.config.logger.debug "API called: SubscribersApi#create_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
84
+ end
85
+ return data, status_code, headers
86
+ end
87
+
88
+ # Create or update a subscriber
89
+ # Upsert a subscriber by external_id. If a subscriber with the given external_id already exists, it will be updated.
90
+ # @param create_subscriber_request [CreateSubscriberRequest]
91
+ # @param [Hash] opts the optional parameters
92
+ # @return [SubscriberResponse]
93
+ def create_subscriber(create_subscriber_request, opts = {})
94
+ data, _status_code, _headers = create_subscriber_with_http_info(create_subscriber_request, opts)
95
+ data
96
+ end
97
+
98
+ # Create or update a subscriber
99
+ # Upsert a subscriber by external_id. If a subscriber with the given external_id already exists, it will be updated.
100
+ # @param create_subscriber_request [CreateSubscriberRequest]
101
+ # @param [Hash] opts the optional parameters
102
+ # @return [Array<(SubscriberResponse, Integer, Hash)>] SubscriberResponse data, response status code and response headers
103
+ def create_subscriber_with_http_info(create_subscriber_request, opts = {})
104
+ if @api_client.config.debugging
105
+ @api_client.config.logger.debug 'Calling API: SubscribersApi.create_subscriber ...'
106
+ end
107
+ # verify the required parameter 'create_subscriber_request' is set
108
+ if @api_client.config.client_side_validation && create_subscriber_request.nil?
109
+ fail ArgumentError, "Missing the required parameter 'create_subscriber_request' when calling SubscribersApi.create_subscriber"
110
+ end
111
+ # resource path
112
+ local_var_path = '/subscribers'
113
+
114
+ # query parameters
115
+ query_params = opts[:query_params] || {}
116
+
117
+ # header parameters
118
+ header_params = opts[:header_params] || {}
119
+ # HTTP header 'Accept' (if needed)
120
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
121
+ # HTTP header 'Content-Type'
122
+ content_type = @api_client.select_header_content_type(['application/json'])
123
+ if !content_type.nil?
124
+ header_params['Content-Type'] = content_type
125
+ end
126
+
127
+ # form parameters
128
+ form_params = opts[:form_params] || {}
129
+
130
+ # http body (model)
131
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(create_subscriber_request)
132
+
133
+ # return_type
134
+ return_type = opts[:debug_return_type] || 'SubscriberResponse'
135
+
136
+ # auth_names
137
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
138
+
139
+ new_options = opts.merge(
140
+ :operation => :"SubscribersApi.create_subscriber",
141
+ :header_params => header_params,
142
+ :query_params => query_params,
143
+ :form_params => form_params,
144
+ :body => post_body,
145
+ :auth_names => auth_names,
146
+ :return_type => return_type
147
+ )
148
+
149
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
150
+ if @api_client.config.debugging
151
+ @api_client.config.logger.debug "API called: SubscribersApi#create_subscriber\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
152
+ end
153
+ return data, status_code, headers
154
+ end
155
+
156
+ # Delete a category
157
+ # @param id [String]
158
+ # @param [Hash] opts the optional parameters
159
+ # @return [nil]
160
+ def delete_category(id, opts = {})
161
+ delete_category_with_http_info(id, opts)
162
+ nil
163
+ end
164
+
165
+ # Delete a category
166
+ # @param id [String]
167
+ # @param [Hash] opts the optional parameters
168
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
169
+ def delete_category_with_http_info(id, opts = {})
170
+ if @api_client.config.debugging
171
+ @api_client.config.logger.debug 'Calling API: SubscribersApi.delete_category ...'
172
+ end
173
+ # verify the required parameter 'id' is set
174
+ if @api_client.config.client_side_validation && id.nil?
175
+ fail ArgumentError, "Missing the required parameter 'id' when calling SubscribersApi.delete_category"
176
+ end
177
+ # resource path
178
+ local_var_path = '/subscribers/categories/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
179
+
180
+ # query parameters
181
+ query_params = opts[:query_params] || {}
182
+
183
+ # header parameters
184
+ header_params = opts[:header_params] || {}
185
+ # HTTP header 'Accept' (if needed)
186
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
187
+
188
+ # form parameters
189
+ form_params = opts[:form_params] || {}
190
+
191
+ # http body (model)
192
+ post_body = opts[:debug_body]
193
+
194
+ # return_type
195
+ return_type = opts[:debug_return_type]
196
+
197
+ # auth_names
198
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
199
+
200
+ new_options = opts.merge(
201
+ :operation => :"SubscribersApi.delete_category",
202
+ :header_params => header_params,
203
+ :query_params => query_params,
204
+ :form_params => form_params,
205
+ :body => post_body,
206
+ :auth_names => auth_names,
207
+ :return_type => return_type
208
+ )
209
+
210
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
211
+ if @api_client.config.debugging
212
+ @api_client.config.logger.debug "API called: SubscribersApi#delete_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
213
+ end
214
+ return data, status_code, headers
215
+ end
216
+
217
+ # Delete a subscriber
218
+ # Soft-deletes a subscriber by setting status to deleted.
219
+ # @param id [String]
220
+ # @param [Hash] opts the optional parameters
221
+ # @return [nil]
222
+ def delete_subscriber(id, opts = {})
223
+ delete_subscriber_with_http_info(id, opts)
224
+ nil
225
+ end
226
+
227
+ # Delete a subscriber
228
+ # Soft-deletes a subscriber by setting status to deleted.
229
+ # @param id [String]
230
+ # @param [Hash] opts the optional parameters
231
+ # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
232
+ def delete_subscriber_with_http_info(id, opts = {})
233
+ if @api_client.config.debugging
234
+ @api_client.config.logger.debug 'Calling API: SubscribersApi.delete_subscriber ...'
235
+ end
236
+ # verify the required parameter 'id' is set
237
+ if @api_client.config.client_side_validation && id.nil?
238
+ fail ArgumentError, "Missing the required parameter 'id' when calling SubscribersApi.delete_subscriber"
239
+ end
240
+ # resource path
241
+ local_var_path = '/subscribers/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
242
+
243
+ # query parameters
244
+ query_params = opts[:query_params] || {}
245
+
246
+ # header parameters
247
+ header_params = opts[:header_params] || {}
248
+ # HTTP header 'Accept' (if needed)
249
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
250
+
251
+ # form parameters
252
+ form_params = opts[:form_params] || {}
253
+
254
+ # http body (model)
255
+ post_body = opts[:debug_body]
256
+
257
+ # return_type
258
+ return_type = opts[:debug_return_type]
259
+
260
+ # auth_names
261
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
262
+
263
+ new_options = opts.merge(
264
+ :operation => :"SubscribersApi.delete_subscriber",
265
+ :header_params => header_params,
266
+ :query_params => query_params,
267
+ :form_params => form_params,
268
+ :body => post_body,
269
+ :auth_names => auth_names,
270
+ :return_type => return_type
271
+ )
272
+
273
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
274
+ if @api_client.config.debugging
275
+ @api_client.config.logger.debug "API called: SubscribersApi#delete_subscriber\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
276
+ end
277
+ return data, status_code, headers
278
+ end
279
+
280
+ # Get a category by ID or slug
281
+ # @param id_or_slug [String]
282
+ # @param [Hash] opts the optional parameters
283
+ # @return [CategoryResponse]
284
+ def get_category(id_or_slug, opts = {})
285
+ data, _status_code, _headers = get_category_with_http_info(id_or_slug, opts)
286
+ data
287
+ end
288
+
289
+ # Get a category by ID or slug
290
+ # @param id_or_slug [String]
291
+ # @param [Hash] opts the optional parameters
292
+ # @return [Array<(CategoryResponse, Integer, Hash)>] CategoryResponse data, response status code and response headers
293
+ def get_category_with_http_info(id_or_slug, opts = {})
294
+ if @api_client.config.debugging
295
+ @api_client.config.logger.debug 'Calling API: SubscribersApi.get_category ...'
296
+ end
297
+ # verify the required parameter 'id_or_slug' is set
298
+ if @api_client.config.client_side_validation && id_or_slug.nil?
299
+ fail ArgumentError, "Missing the required parameter 'id_or_slug' when calling SubscribersApi.get_category"
300
+ end
301
+ # resource path
302
+ local_var_path = '/subscribers/categories/{idOrSlug}'.sub('{' + 'idOrSlug' + '}', CGI.escape(id_or_slug.to_s))
303
+
304
+ # query parameters
305
+ query_params = opts[:query_params] || {}
306
+
307
+ # header parameters
308
+ header_params = opts[:header_params] || {}
309
+ # HTTP header 'Accept' (if needed)
310
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
311
+
312
+ # form parameters
313
+ form_params = opts[:form_params] || {}
314
+
315
+ # http body (model)
316
+ post_body = opts[:debug_body]
317
+
318
+ # return_type
319
+ return_type = opts[:debug_return_type] || 'CategoryResponse'
320
+
321
+ # auth_names
322
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
323
+
324
+ new_options = opts.merge(
325
+ :operation => :"SubscribersApi.get_category",
326
+ :header_params => header_params,
327
+ :query_params => query_params,
328
+ :form_params => form_params,
329
+ :body => post_body,
330
+ :auth_names => auth_names,
331
+ :return_type => return_type
332
+ )
333
+
334
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
335
+ if @api_client.config.debugging
336
+ @api_client.config.logger.debug "API called: SubscribersApi#get_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
337
+ end
338
+ return data, status_code, headers
339
+ end
340
+
341
+ # Get a subscriber by ID
342
+ # @param id [String]
343
+ # @param [Hash] opts the optional parameters
344
+ # @return [SubscriberResponse]
345
+ def get_subscriber(id, opts = {})
346
+ data, _status_code, _headers = get_subscriber_with_http_info(id, opts)
347
+ data
348
+ end
349
+
350
+ # Get a subscriber by ID
351
+ # @param id [String]
352
+ # @param [Hash] opts the optional parameters
353
+ # @return [Array<(SubscriberResponse, Integer, Hash)>] SubscriberResponse data, response status code and response headers
354
+ def get_subscriber_with_http_info(id, opts = {})
355
+ if @api_client.config.debugging
356
+ @api_client.config.logger.debug 'Calling API: SubscribersApi.get_subscriber ...'
357
+ end
358
+ # verify the required parameter 'id' is set
359
+ if @api_client.config.client_side_validation && id.nil?
360
+ fail ArgumentError, "Missing the required parameter 'id' when calling SubscribersApi.get_subscriber"
361
+ end
362
+ # resource path
363
+ local_var_path = '/subscribers/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
364
+
365
+ # query parameters
366
+ query_params = opts[:query_params] || {}
367
+
368
+ # header parameters
369
+ header_params = opts[:header_params] || {}
370
+ # HTTP header 'Accept' (if needed)
371
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
372
+
373
+ # form parameters
374
+ form_params = opts[:form_params] || {}
375
+
376
+ # http body (model)
377
+ post_body = opts[:debug_body]
378
+
379
+ # return_type
380
+ return_type = opts[:debug_return_type] || 'SubscriberResponse'
381
+
382
+ # auth_names
383
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
384
+
385
+ new_options = opts.merge(
386
+ :operation => :"SubscribersApi.get_subscriber",
387
+ :header_params => header_params,
388
+ :query_params => query_params,
389
+ :form_params => form_params,
390
+ :body => post_body,
391
+ :auth_names => auth_names,
392
+ :return_type => return_type
393
+ )
394
+
395
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
396
+ if @api_client.config.debugging
397
+ @api_client.config.logger.debug "API called: SubscribersApi#get_subscriber\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
398
+ end
399
+ return data, status_code, headers
400
+ end
401
+
402
+ # Get subscriber by external ID
403
+ # @param external_id [String]
404
+ # @param [Hash] opts the optional parameters
405
+ # @return [SubscriberResponse]
406
+ def get_subscriber_by_external_id(external_id, opts = {})
407
+ data, _status_code, _headers = get_subscriber_by_external_id_with_http_info(external_id, opts)
408
+ data
409
+ end
410
+
411
+ # Get subscriber by external ID
412
+ # @param external_id [String]
413
+ # @param [Hash] opts the optional parameters
414
+ # @return [Array<(SubscriberResponse, Integer, Hash)>] SubscriberResponse data, response status code and response headers
415
+ def get_subscriber_by_external_id_with_http_info(external_id, opts = {})
416
+ if @api_client.config.debugging
417
+ @api_client.config.logger.debug 'Calling API: SubscribersApi.get_subscriber_by_external_id ...'
418
+ end
419
+ # verify the required parameter 'external_id' is set
420
+ if @api_client.config.client_side_validation && external_id.nil?
421
+ fail ArgumentError, "Missing the required parameter 'external_id' when calling SubscribersApi.get_subscriber_by_external_id"
422
+ end
423
+ # resource path
424
+ local_var_path = '/subscribers/by-external-id/{externalId}'.sub('{' + 'externalId' + '}', CGI.escape(external_id.to_s))
425
+
426
+ # query parameters
427
+ query_params = opts[:query_params] || {}
428
+
429
+ # header parameters
430
+ header_params = opts[:header_params] || {}
431
+ # HTTP header 'Accept' (if needed)
432
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
433
+
434
+ # form parameters
435
+ form_params = opts[:form_params] || {}
436
+
437
+ # http body (model)
438
+ post_body = opts[:debug_body]
439
+
440
+ # return_type
441
+ return_type = opts[:debug_return_type] || 'SubscriberResponse'
442
+
443
+ # auth_names
444
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
445
+
446
+ new_options = opts.merge(
447
+ :operation => :"SubscribersApi.get_subscriber_by_external_id",
448
+ :header_params => header_params,
449
+ :query_params => query_params,
450
+ :form_params => form_params,
451
+ :body => post_body,
452
+ :auth_names => auth_names,
453
+ :return_type => return_type
454
+ )
455
+
456
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
457
+ if @api_client.config.debugging
458
+ @api_client.config.logger.debug "API called: SubscribersApi#get_subscriber_by_external_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
459
+ end
460
+ return data, status_code, headers
461
+ end
462
+
463
+ # Get subscriber consent status
464
+ # @param id [String]
465
+ # @param [Hash] opts the optional parameters
466
+ # @return [ConsentStatusResponse]
467
+ def get_subscriber_consent(id, opts = {})
468
+ data, _status_code, _headers = get_subscriber_consent_with_http_info(id, opts)
469
+ data
470
+ end
471
+
472
+ # Get subscriber consent status
473
+ # @param id [String]
474
+ # @param [Hash] opts the optional parameters
475
+ # @return [Array<(ConsentStatusResponse, Integer, Hash)>] ConsentStatusResponse data, response status code and response headers
476
+ def get_subscriber_consent_with_http_info(id, opts = {})
477
+ if @api_client.config.debugging
478
+ @api_client.config.logger.debug 'Calling API: SubscribersApi.get_subscriber_consent ...'
479
+ end
480
+ # verify the required parameter 'id' is set
481
+ if @api_client.config.client_side_validation && id.nil?
482
+ fail ArgumentError, "Missing the required parameter 'id' when calling SubscribersApi.get_subscriber_consent"
483
+ end
484
+ # resource path
485
+ local_var_path = '/subscribers/{id}/consent'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
486
+
487
+ # query parameters
488
+ query_params = opts[:query_params] || {}
489
+
490
+ # header parameters
491
+ header_params = opts[:header_params] || {}
492
+ # HTTP header 'Accept' (if needed)
493
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
494
+
495
+ # form parameters
496
+ form_params = opts[:form_params] || {}
497
+
498
+ # http body (model)
499
+ post_body = opts[:debug_body]
500
+
501
+ # return_type
502
+ return_type = opts[:debug_return_type] || 'ConsentStatusResponse'
503
+
504
+ # auth_names
505
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
506
+
507
+ new_options = opts.merge(
508
+ :operation => :"SubscribersApi.get_subscriber_consent",
509
+ :header_params => header_params,
510
+ :query_params => query_params,
511
+ :form_params => form_params,
512
+ :body => post_body,
513
+ :auth_names => auth_names,
514
+ :return_type => return_type
515
+ )
516
+
517
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
518
+ if @api_client.config.debugging
519
+ @api_client.config.logger.debug "API called: SubscribersApi#get_subscriber_consent\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
520
+ end
521
+ return data, status_code, headers
522
+ end
523
+
524
+ # Get subscriber consent history
525
+ # Returns paginated consent audit log for a subscriber.
526
+ # @param id [String]
527
+ # @param [Hash] opts the optional parameters
528
+ # @option opts [Integer] :limit (default to 50)
529
+ # @option opts [Integer] :offset (default to 0)
530
+ # @return [ConsentHistoryResponse]
531
+ def get_subscriber_consent_history(id, opts = {})
532
+ data, _status_code, _headers = get_subscriber_consent_history_with_http_info(id, opts)
533
+ data
534
+ end
535
+
536
+ # Get subscriber consent history
537
+ # Returns paginated consent audit log for a subscriber.
538
+ # @param id [String]
539
+ # @param [Hash] opts the optional parameters
540
+ # @option opts [Integer] :limit (default to 50)
541
+ # @option opts [Integer] :offset (default to 0)
542
+ # @return [Array<(ConsentHistoryResponse, Integer, Hash)>] ConsentHistoryResponse data, response status code and response headers
543
+ def get_subscriber_consent_history_with_http_info(id, opts = {})
544
+ if @api_client.config.debugging
545
+ @api_client.config.logger.debug 'Calling API: SubscribersApi.get_subscriber_consent_history ...'
546
+ end
547
+ # verify the required parameter 'id' is set
548
+ if @api_client.config.client_side_validation && id.nil?
549
+ fail ArgumentError, "Missing the required parameter 'id' when calling SubscribersApi.get_subscriber_consent_history"
550
+ end
551
+ # resource path
552
+ local_var_path = '/subscribers/{id}/consent/history'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
553
+
554
+ # query parameters
555
+ query_params = opts[:query_params] || {}
556
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
557
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
558
+
559
+ # header parameters
560
+ header_params = opts[:header_params] || {}
561
+ # HTTP header 'Accept' (if needed)
562
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
563
+
564
+ # form parameters
565
+ form_params = opts[:form_params] || {}
566
+
567
+ # http body (model)
568
+ post_body = opts[:debug_body]
569
+
570
+ # return_type
571
+ return_type = opts[:debug_return_type] || 'ConsentHistoryResponse'
572
+
573
+ # auth_names
574
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
575
+
576
+ new_options = opts.merge(
577
+ :operation => :"SubscribersApi.get_subscriber_consent_history",
578
+ :header_params => header_params,
579
+ :query_params => query_params,
580
+ :form_params => form_params,
581
+ :body => post_body,
582
+ :auth_names => auth_names,
583
+ :return_type => return_type
584
+ )
585
+
586
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
587
+ if @api_client.config.debugging
588
+ @api_client.config.logger.debug "API called: SubscribersApi#get_subscriber_consent_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
589
+ end
590
+ return data, status_code, headers
591
+ end
592
+
593
+ # Get subscriber preferences
594
+ # @param id [String]
595
+ # @param [Hash] opts the optional parameters
596
+ # @option opts [Boolean] :effective Return effective preferences (merged with category defaults)
597
+ # @return [PreferenceListResponse]
598
+ def get_subscriber_preferences(id, opts = {})
599
+ data, _status_code, _headers = get_subscriber_preferences_with_http_info(id, opts)
600
+ data
601
+ end
602
+
603
+ # Get subscriber preferences
604
+ # @param id [String]
605
+ # @param [Hash] opts the optional parameters
606
+ # @option opts [Boolean] :effective Return effective preferences (merged with category defaults)
607
+ # @return [Array<(PreferenceListResponse, Integer, Hash)>] PreferenceListResponse data, response status code and response headers
608
+ def get_subscriber_preferences_with_http_info(id, opts = {})
609
+ if @api_client.config.debugging
610
+ @api_client.config.logger.debug 'Calling API: SubscribersApi.get_subscriber_preferences ...'
611
+ end
612
+ # verify the required parameter 'id' is set
613
+ if @api_client.config.client_side_validation && id.nil?
614
+ fail ArgumentError, "Missing the required parameter 'id' when calling SubscribersApi.get_subscriber_preferences"
615
+ end
616
+ # resource path
617
+ local_var_path = '/subscribers/{id}/preferences'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
618
+
619
+ # query parameters
620
+ query_params = opts[:query_params] || {}
621
+ query_params[:'effective'] = opts[:'effective'] if !opts[:'effective'].nil?
622
+
623
+ # header parameters
624
+ header_params = opts[:header_params] || {}
625
+ # HTTP header 'Accept' (if needed)
626
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
627
+
628
+ # form parameters
629
+ form_params = opts[:form_params] || {}
630
+
631
+ # http body (model)
632
+ post_body = opts[:debug_body]
633
+
634
+ # return_type
635
+ return_type = opts[:debug_return_type] || 'PreferenceListResponse'
636
+
637
+ # auth_names
638
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
639
+
640
+ new_options = opts.merge(
641
+ :operation => :"SubscribersApi.get_subscriber_preferences",
642
+ :header_params => header_params,
643
+ :query_params => query_params,
644
+ :form_params => form_params,
645
+ :body => post_body,
646
+ :auth_names => auth_names,
647
+ :return_type => return_type
648
+ )
649
+
650
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
651
+ if @api_client.config.debugging
652
+ @api_client.config.logger.debug "API called: SubscribersApi#get_subscriber_preferences\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
653
+ end
654
+ return data, status_code, headers
655
+ end
656
+
657
+ # Get subscriber unsubscribes
658
+ # @param id [String]
659
+ # @param [Hash] opts the optional parameters
660
+ # @return [UnsubscribeListResponse]
661
+ def get_subscriber_unsubscribes(id, opts = {})
662
+ data, _status_code, _headers = get_subscriber_unsubscribes_with_http_info(id, opts)
663
+ data
664
+ end
665
+
666
+ # Get subscriber unsubscribes
667
+ # @param id [String]
668
+ # @param [Hash] opts the optional parameters
669
+ # @return [Array<(UnsubscribeListResponse, Integer, Hash)>] UnsubscribeListResponse data, response status code and response headers
670
+ def get_subscriber_unsubscribes_with_http_info(id, opts = {})
671
+ if @api_client.config.debugging
672
+ @api_client.config.logger.debug 'Calling API: SubscribersApi.get_subscriber_unsubscribes ...'
673
+ end
674
+ # verify the required parameter 'id' is set
675
+ if @api_client.config.client_side_validation && id.nil?
676
+ fail ArgumentError, "Missing the required parameter 'id' when calling SubscribersApi.get_subscriber_unsubscribes"
677
+ end
678
+ # resource path
679
+ local_var_path = '/subscribers/{id}/unsubscribes'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
680
+
681
+ # query parameters
682
+ query_params = opts[:query_params] || {}
683
+
684
+ # header parameters
685
+ header_params = opts[:header_params] || {}
686
+ # HTTP header 'Accept' (if needed)
687
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
688
+
689
+ # form parameters
690
+ form_params = opts[:form_params] || {}
691
+
692
+ # http body (model)
693
+ post_body = opts[:debug_body]
694
+
695
+ # return_type
696
+ return_type = opts[:debug_return_type] || 'UnsubscribeListResponse'
697
+
698
+ # auth_names
699
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
700
+
701
+ new_options = opts.merge(
702
+ :operation => :"SubscribersApi.get_subscriber_unsubscribes",
703
+ :header_params => header_params,
704
+ :query_params => query_params,
705
+ :form_params => form_params,
706
+ :body => post_body,
707
+ :auth_names => auth_names,
708
+ :return_type => return_type
709
+ )
710
+
711
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
712
+ if @api_client.config.debugging
713
+ @api_client.config.logger.debug "API called: SubscribersApi#get_subscriber_unsubscribes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
714
+ end
715
+ return data, status_code, headers
716
+ end
717
+
718
+ # List notification categories
719
+ # @param [Hash] opts the optional parameters
720
+ # @return [CategoryListResponse]
721
+ def list_categories(opts = {})
722
+ data, _status_code, _headers = list_categories_with_http_info(opts)
723
+ data
724
+ end
725
+
726
+ # List notification categories
727
+ # @param [Hash] opts the optional parameters
728
+ # @return [Array<(CategoryListResponse, Integer, Hash)>] CategoryListResponse data, response status code and response headers
729
+ def list_categories_with_http_info(opts = {})
730
+ if @api_client.config.debugging
731
+ @api_client.config.logger.debug 'Calling API: SubscribersApi.list_categories ...'
732
+ end
733
+ # resource path
734
+ local_var_path = '/subscribers/categories'
735
+
736
+ # query parameters
737
+ query_params = opts[:query_params] || {}
738
+
739
+ # header parameters
740
+ header_params = opts[:header_params] || {}
741
+ # HTTP header 'Accept' (if needed)
742
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
743
+
744
+ # form parameters
745
+ form_params = opts[:form_params] || {}
746
+
747
+ # http body (model)
748
+ post_body = opts[:debug_body]
749
+
750
+ # return_type
751
+ return_type = opts[:debug_return_type] || 'CategoryListResponse'
752
+
753
+ # auth_names
754
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
755
+
756
+ new_options = opts.merge(
757
+ :operation => :"SubscribersApi.list_categories",
758
+ :header_params => header_params,
759
+ :query_params => query_params,
760
+ :form_params => form_params,
761
+ :body => post_body,
762
+ :auth_names => auth_names,
763
+ :return_type => return_type
764
+ )
765
+
766
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
767
+ if @api_client.config.debugging
768
+ @api_client.config.logger.debug "API called: SubscribersApi#list_categories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
769
+ end
770
+ return data, status_code, headers
771
+ end
772
+
773
+ # List subscribers
774
+ # @param [Hash] opts the optional parameters
775
+ # @option opts [String] :status
776
+ # @option opts [String] :email
777
+ # @option opts [Integer] :limit (default to 50)
778
+ # @option opts [Integer] :offset (default to 0)
779
+ # @return [SubscriberListResponse]
780
+ def list_subscribers(opts = {})
781
+ data, _status_code, _headers = list_subscribers_with_http_info(opts)
782
+ data
783
+ end
784
+
785
+ # List subscribers
786
+ # @param [Hash] opts the optional parameters
787
+ # @option opts [String] :status
788
+ # @option opts [String] :email
789
+ # @option opts [Integer] :limit (default to 50)
790
+ # @option opts [Integer] :offset (default to 0)
791
+ # @return [Array<(SubscriberListResponse, Integer, Hash)>] SubscriberListResponse data, response status code and response headers
792
+ def list_subscribers_with_http_info(opts = {})
793
+ if @api_client.config.debugging
794
+ @api_client.config.logger.debug 'Calling API: SubscribersApi.list_subscribers ...'
795
+ end
796
+ allowable_values = ["active", "inactive", "deleted"]
797
+ if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
798
+ fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
799
+ end
800
+ # resource path
801
+ local_var_path = '/subscribers'
802
+
803
+ # query parameters
804
+ query_params = opts[:query_params] || {}
805
+ query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
806
+ query_params[:'email'] = opts[:'email'] if !opts[:'email'].nil?
807
+ query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
808
+ query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
809
+
810
+ # header parameters
811
+ header_params = opts[:header_params] || {}
812
+ # HTTP header 'Accept' (if needed)
813
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
814
+
815
+ # form parameters
816
+ form_params = opts[:form_params] || {}
817
+
818
+ # http body (model)
819
+ post_body = opts[:debug_body]
820
+
821
+ # return_type
822
+ return_type = opts[:debug_return_type] || 'SubscriberListResponse'
823
+
824
+ # auth_names
825
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
826
+
827
+ new_options = opts.merge(
828
+ :operation => :"SubscribersApi.list_subscribers",
829
+ :header_params => header_params,
830
+ :query_params => query_params,
831
+ :form_params => form_params,
832
+ :body => post_body,
833
+ :auth_names => auth_names,
834
+ :return_type => return_type
835
+ )
836
+
837
+ data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
838
+ if @api_client.config.debugging
839
+ @api_client.config.logger.debug "API called: SubscribersApi#list_subscribers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
840
+ end
841
+ return data, status_code, headers
842
+ end
843
+
844
+ # Record subscriber consent
845
+ # @param id [String]
846
+ # @param body [Object]
847
+ # @param [Hash] opts the optional parameters
848
+ # @return [ConsentRecordResponse]
849
+ def record_subscriber_consent(id, body, opts = {})
850
+ data, _status_code, _headers = record_subscriber_consent_with_http_info(id, body, opts)
851
+ data
852
+ end
853
+
854
+ # Record subscriber consent
855
+ # @param id [String]
856
+ # @param body [Object]
857
+ # @param [Hash] opts the optional parameters
858
+ # @return [Array<(ConsentRecordResponse, Integer, Hash)>] ConsentRecordResponse data, response status code and response headers
859
+ def record_subscriber_consent_with_http_info(id, body, opts = {})
860
+ if @api_client.config.debugging
861
+ @api_client.config.logger.debug 'Calling API: SubscribersApi.record_subscriber_consent ...'
862
+ end
863
+ # verify the required parameter 'id' is set
864
+ if @api_client.config.client_side_validation && id.nil?
865
+ fail ArgumentError, "Missing the required parameter 'id' when calling SubscribersApi.record_subscriber_consent"
866
+ end
867
+ # verify the required parameter 'body' is set
868
+ if @api_client.config.client_side_validation && body.nil?
869
+ fail ArgumentError, "Missing the required parameter 'body' when calling SubscribersApi.record_subscriber_consent"
870
+ end
871
+ # resource path
872
+ local_var_path = '/subscribers/{id}/consent'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
873
+
874
+ # query parameters
875
+ query_params = opts[:query_params] || {}
876
+
877
+ # header parameters
878
+ header_params = opts[:header_params] || {}
879
+ # HTTP header 'Accept' (if needed)
880
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
881
+ # HTTP header 'Content-Type'
882
+ content_type = @api_client.select_header_content_type(['application/json'])
883
+ if !content_type.nil?
884
+ header_params['Content-Type'] = content_type
885
+ end
886
+
887
+ # form parameters
888
+ form_params = opts[:form_params] || {}
889
+
890
+ # http body (model)
891
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(body)
892
+
893
+ # return_type
894
+ return_type = opts[:debug_return_type] || 'ConsentRecordResponse'
895
+
896
+ # auth_names
897
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
898
+
899
+ new_options = opts.merge(
900
+ :operation => :"SubscribersApi.record_subscriber_consent",
901
+ :header_params => header_params,
902
+ :query_params => query_params,
903
+ :form_params => form_params,
904
+ :body => post_body,
905
+ :auth_names => auth_names,
906
+ :return_type => return_type
907
+ )
908
+
909
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
910
+ if @api_client.config.debugging
911
+ @api_client.config.logger.debug "API called: SubscribersApi#record_subscriber_consent\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
912
+ end
913
+ return data, status_code, headers
914
+ end
915
+
916
+ # Resubscribe to a channel
917
+ # @param id [String]
918
+ # @param [Hash] opts the optional parameters
919
+ # @option opts [ResubscribeRequest] :resubscribe_request
920
+ # @return [ResubscribeResponse]
921
+ def resubscribe_subscriber(id, opts = {})
922
+ data, _status_code, _headers = resubscribe_subscriber_with_http_info(id, opts)
923
+ data
924
+ end
925
+
926
+ # Resubscribe to a channel
927
+ # @param id [String]
928
+ # @param [Hash] opts the optional parameters
929
+ # @option opts [ResubscribeRequest] :resubscribe_request
930
+ # @return [Array<(ResubscribeResponse, Integer, Hash)>] ResubscribeResponse data, response status code and response headers
931
+ def resubscribe_subscriber_with_http_info(id, opts = {})
932
+ if @api_client.config.debugging
933
+ @api_client.config.logger.debug 'Calling API: SubscribersApi.resubscribe_subscriber ...'
934
+ end
935
+ # verify the required parameter 'id' is set
936
+ if @api_client.config.client_side_validation && id.nil?
937
+ fail ArgumentError, "Missing the required parameter 'id' when calling SubscribersApi.resubscribe_subscriber"
938
+ end
939
+ # resource path
940
+ local_var_path = '/subscribers/{id}/resubscribe'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
941
+
942
+ # query parameters
943
+ query_params = opts[:query_params] || {}
944
+
945
+ # header parameters
946
+ header_params = opts[:header_params] || {}
947
+ # HTTP header 'Accept' (if needed)
948
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
949
+ # HTTP header 'Content-Type'
950
+ content_type = @api_client.select_header_content_type(['application/json'])
951
+ if !content_type.nil?
952
+ header_params['Content-Type'] = content_type
953
+ end
954
+
955
+ # form parameters
956
+ form_params = opts[:form_params] || {}
957
+
958
+ # http body (model)
959
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'resubscribe_request'])
960
+
961
+ # return_type
962
+ return_type = opts[:debug_return_type] || 'ResubscribeResponse'
963
+
964
+ # auth_names
965
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
966
+
967
+ new_options = opts.merge(
968
+ :operation => :"SubscribersApi.resubscribe_subscriber",
969
+ :header_params => header_params,
970
+ :query_params => query_params,
971
+ :form_params => form_params,
972
+ :body => post_body,
973
+ :auth_names => auth_names,
974
+ :return_type => return_type
975
+ )
976
+
977
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
978
+ if @api_client.config.debugging
979
+ @api_client.config.logger.debug "API called: SubscribersApi#resubscribe_subscriber\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
980
+ end
981
+ return data, status_code, headers
982
+ end
983
+
984
+ # Set subscriber preferences
985
+ # Bulk set notification preferences for a subscriber.
986
+ # @param id [String]
987
+ # @param set_preferences_request [SetPreferencesRequest]
988
+ # @param [Hash] opts the optional parameters
989
+ # @return [PreferenceListResponse]
990
+ def set_subscriber_preferences(id, set_preferences_request, opts = {})
991
+ data, _status_code, _headers = set_subscriber_preferences_with_http_info(id, set_preferences_request, opts)
992
+ data
993
+ end
994
+
995
+ # Set subscriber preferences
996
+ # Bulk set notification preferences for a subscriber.
997
+ # @param id [String]
998
+ # @param set_preferences_request [SetPreferencesRequest]
999
+ # @param [Hash] opts the optional parameters
1000
+ # @return [Array<(PreferenceListResponse, Integer, Hash)>] PreferenceListResponse data, response status code and response headers
1001
+ def set_subscriber_preferences_with_http_info(id, set_preferences_request, opts = {})
1002
+ if @api_client.config.debugging
1003
+ @api_client.config.logger.debug 'Calling API: SubscribersApi.set_subscriber_preferences ...'
1004
+ end
1005
+ # verify the required parameter 'id' is set
1006
+ if @api_client.config.client_side_validation && id.nil?
1007
+ fail ArgumentError, "Missing the required parameter 'id' when calling SubscribersApi.set_subscriber_preferences"
1008
+ end
1009
+ # verify the required parameter 'set_preferences_request' is set
1010
+ if @api_client.config.client_side_validation && set_preferences_request.nil?
1011
+ fail ArgumentError, "Missing the required parameter 'set_preferences_request' when calling SubscribersApi.set_subscriber_preferences"
1012
+ end
1013
+ # resource path
1014
+ local_var_path = '/subscribers/{id}/preferences'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1015
+
1016
+ # query parameters
1017
+ query_params = opts[:query_params] || {}
1018
+
1019
+ # header parameters
1020
+ header_params = opts[:header_params] || {}
1021
+ # HTTP header 'Accept' (if needed)
1022
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1023
+ # HTTP header 'Content-Type'
1024
+ content_type = @api_client.select_header_content_type(['application/json'])
1025
+ if !content_type.nil?
1026
+ header_params['Content-Type'] = content_type
1027
+ end
1028
+
1029
+ # form parameters
1030
+ form_params = opts[:form_params] || {}
1031
+
1032
+ # http body (model)
1033
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(set_preferences_request)
1034
+
1035
+ # return_type
1036
+ return_type = opts[:debug_return_type] || 'PreferenceListResponse'
1037
+
1038
+ # auth_names
1039
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
1040
+
1041
+ new_options = opts.merge(
1042
+ :operation => :"SubscribersApi.set_subscriber_preferences",
1043
+ :header_params => header_params,
1044
+ :query_params => query_params,
1045
+ :form_params => form_params,
1046
+ :body => post_body,
1047
+ :auth_names => auth_names,
1048
+ :return_type => return_type
1049
+ )
1050
+
1051
+ data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
1052
+ if @api_client.config.debugging
1053
+ @api_client.config.logger.debug "API called: SubscribersApi#set_subscriber_preferences\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1054
+ end
1055
+ return data, status_code, headers
1056
+ end
1057
+
1058
+ # Unsubscribe from a channel
1059
+ # @param id [String]
1060
+ # @param [Hash] opts the optional parameters
1061
+ # @option opts [UnsubscribeRequest] :unsubscribe_request
1062
+ # @return [UnsubscribeResponse]
1063
+ def unsubscribe_subscriber(id, opts = {})
1064
+ data, _status_code, _headers = unsubscribe_subscriber_with_http_info(id, opts)
1065
+ data
1066
+ end
1067
+
1068
+ # Unsubscribe from a channel
1069
+ # @param id [String]
1070
+ # @param [Hash] opts the optional parameters
1071
+ # @option opts [UnsubscribeRequest] :unsubscribe_request
1072
+ # @return [Array<(UnsubscribeResponse, Integer, Hash)>] UnsubscribeResponse data, response status code and response headers
1073
+ def unsubscribe_subscriber_with_http_info(id, opts = {})
1074
+ if @api_client.config.debugging
1075
+ @api_client.config.logger.debug 'Calling API: SubscribersApi.unsubscribe_subscriber ...'
1076
+ end
1077
+ # verify the required parameter 'id' is set
1078
+ if @api_client.config.client_side_validation && id.nil?
1079
+ fail ArgumentError, "Missing the required parameter 'id' when calling SubscribersApi.unsubscribe_subscriber"
1080
+ end
1081
+ # resource path
1082
+ local_var_path = '/subscribers/{id}/unsubscribe'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1083
+
1084
+ # query parameters
1085
+ query_params = opts[:query_params] || {}
1086
+
1087
+ # header parameters
1088
+ header_params = opts[:header_params] || {}
1089
+ # HTTP header 'Accept' (if needed)
1090
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1091
+ # HTTP header 'Content-Type'
1092
+ content_type = @api_client.select_header_content_type(['application/json'])
1093
+ if !content_type.nil?
1094
+ header_params['Content-Type'] = content_type
1095
+ end
1096
+
1097
+ # form parameters
1098
+ form_params = opts[:form_params] || {}
1099
+
1100
+ # http body (model)
1101
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'unsubscribe_request'])
1102
+
1103
+ # return_type
1104
+ return_type = opts[:debug_return_type] || 'UnsubscribeResponse'
1105
+
1106
+ # auth_names
1107
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
1108
+
1109
+ new_options = opts.merge(
1110
+ :operation => :"SubscribersApi.unsubscribe_subscriber",
1111
+ :header_params => header_params,
1112
+ :query_params => query_params,
1113
+ :form_params => form_params,
1114
+ :body => post_body,
1115
+ :auth_names => auth_names,
1116
+ :return_type => return_type
1117
+ )
1118
+
1119
+ data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
1120
+ if @api_client.config.debugging
1121
+ @api_client.config.logger.debug "API called: SubscribersApi#unsubscribe_subscriber\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1122
+ end
1123
+ return data, status_code, headers
1124
+ end
1125
+
1126
+ # Update a category
1127
+ # @param id [String]
1128
+ # @param update_category_request [UpdateCategoryRequest]
1129
+ # @param [Hash] opts the optional parameters
1130
+ # @return [CategoryResponse]
1131
+ def update_category(id, update_category_request, opts = {})
1132
+ data, _status_code, _headers = update_category_with_http_info(id, update_category_request, opts)
1133
+ data
1134
+ end
1135
+
1136
+ # Update a category
1137
+ # @param id [String]
1138
+ # @param update_category_request [UpdateCategoryRequest]
1139
+ # @param [Hash] opts the optional parameters
1140
+ # @return [Array<(CategoryResponse, Integer, Hash)>] CategoryResponse data, response status code and response headers
1141
+ def update_category_with_http_info(id, update_category_request, opts = {})
1142
+ if @api_client.config.debugging
1143
+ @api_client.config.logger.debug 'Calling API: SubscribersApi.update_category ...'
1144
+ end
1145
+ # verify the required parameter 'id' is set
1146
+ if @api_client.config.client_side_validation && id.nil?
1147
+ fail ArgumentError, "Missing the required parameter 'id' when calling SubscribersApi.update_category"
1148
+ end
1149
+ # verify the required parameter 'update_category_request' is set
1150
+ if @api_client.config.client_side_validation && update_category_request.nil?
1151
+ fail ArgumentError, "Missing the required parameter 'update_category_request' when calling SubscribersApi.update_category"
1152
+ end
1153
+ # resource path
1154
+ local_var_path = '/subscribers/categories/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1155
+
1156
+ # query parameters
1157
+ query_params = opts[:query_params] || {}
1158
+
1159
+ # header parameters
1160
+ header_params = opts[:header_params] || {}
1161
+ # HTTP header 'Accept' (if needed)
1162
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1163
+ # HTTP header 'Content-Type'
1164
+ content_type = @api_client.select_header_content_type(['application/json'])
1165
+ if !content_type.nil?
1166
+ header_params['Content-Type'] = content_type
1167
+ end
1168
+
1169
+ # form parameters
1170
+ form_params = opts[:form_params] || {}
1171
+
1172
+ # http body (model)
1173
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(update_category_request)
1174
+
1175
+ # return_type
1176
+ return_type = opts[:debug_return_type] || 'CategoryResponse'
1177
+
1178
+ # auth_names
1179
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
1180
+
1181
+ new_options = opts.merge(
1182
+ :operation => :"SubscribersApi.update_category",
1183
+ :header_params => header_params,
1184
+ :query_params => query_params,
1185
+ :form_params => form_params,
1186
+ :body => post_body,
1187
+ :auth_names => auth_names,
1188
+ :return_type => return_type
1189
+ )
1190
+
1191
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
1192
+ if @api_client.config.debugging
1193
+ @api_client.config.logger.debug "API called: SubscribersApi#update_category\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1194
+ end
1195
+ return data, status_code, headers
1196
+ end
1197
+
1198
+ # Update a subscriber
1199
+ # @param id [String]
1200
+ # @param update_subscriber_request [UpdateSubscriberRequest]
1201
+ # @param [Hash] opts the optional parameters
1202
+ # @return [SubscriberResponse]
1203
+ def update_subscriber(id, update_subscriber_request, opts = {})
1204
+ data, _status_code, _headers = update_subscriber_with_http_info(id, update_subscriber_request, opts)
1205
+ data
1206
+ end
1207
+
1208
+ # Update a subscriber
1209
+ # @param id [String]
1210
+ # @param update_subscriber_request [UpdateSubscriberRequest]
1211
+ # @param [Hash] opts the optional parameters
1212
+ # @return [Array<(SubscriberResponse, Integer, Hash)>] SubscriberResponse data, response status code and response headers
1213
+ def update_subscriber_with_http_info(id, update_subscriber_request, opts = {})
1214
+ if @api_client.config.debugging
1215
+ @api_client.config.logger.debug 'Calling API: SubscribersApi.update_subscriber ...'
1216
+ end
1217
+ # verify the required parameter 'id' is set
1218
+ if @api_client.config.client_side_validation && id.nil?
1219
+ fail ArgumentError, "Missing the required parameter 'id' when calling SubscribersApi.update_subscriber"
1220
+ end
1221
+ # verify the required parameter 'update_subscriber_request' is set
1222
+ if @api_client.config.client_side_validation && update_subscriber_request.nil?
1223
+ fail ArgumentError, "Missing the required parameter 'update_subscriber_request' when calling SubscribersApi.update_subscriber"
1224
+ end
1225
+ # resource path
1226
+ local_var_path = '/subscribers/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1227
+
1228
+ # query parameters
1229
+ query_params = opts[:query_params] || {}
1230
+
1231
+ # header parameters
1232
+ header_params = opts[:header_params] || {}
1233
+ # HTTP header 'Accept' (if needed)
1234
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1235
+ # HTTP header 'Content-Type'
1236
+ content_type = @api_client.select_header_content_type(['application/json'])
1237
+ if !content_type.nil?
1238
+ header_params['Content-Type'] = content_type
1239
+ end
1240
+
1241
+ # form parameters
1242
+ form_params = opts[:form_params] || {}
1243
+
1244
+ # http body (model)
1245
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(update_subscriber_request)
1246
+
1247
+ # return_type
1248
+ return_type = opts[:debug_return_type] || 'SubscriberResponse'
1249
+
1250
+ # auth_names
1251
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
1252
+
1253
+ new_options = opts.merge(
1254
+ :operation => :"SubscribersApi.update_subscriber",
1255
+ :header_params => header_params,
1256
+ :query_params => query_params,
1257
+ :form_params => form_params,
1258
+ :body => post_body,
1259
+ :auth_names => auth_names,
1260
+ :return_type => return_type
1261
+ )
1262
+
1263
+ data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
1264
+ if @api_client.config.debugging
1265
+ @api_client.config.logger.debug "API called: SubscribersApi#update_subscriber\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1266
+ end
1267
+ return data, status_code, headers
1268
+ end
1269
+
1270
+ # Withdraw subscriber consent
1271
+ # Withdraw consent for a subscriber (GDPR right to withdraw).
1272
+ # @param id [String]
1273
+ # @param [Hash] opts the optional parameters
1274
+ # @option opts [WithdrawSubscriberConsentRequest] :withdraw_subscriber_consent_request
1275
+ # @return [ConsentWithdrawResponse]
1276
+ def withdraw_subscriber_consent(id, opts = {})
1277
+ data, _status_code, _headers = withdraw_subscriber_consent_with_http_info(id, opts)
1278
+ data
1279
+ end
1280
+
1281
+ # Withdraw subscriber consent
1282
+ # Withdraw consent for a subscriber (GDPR right to withdraw).
1283
+ # @param id [String]
1284
+ # @param [Hash] opts the optional parameters
1285
+ # @option opts [WithdrawSubscriberConsentRequest] :withdraw_subscriber_consent_request
1286
+ # @return [Array<(ConsentWithdrawResponse, Integer, Hash)>] ConsentWithdrawResponse data, response status code and response headers
1287
+ def withdraw_subscriber_consent_with_http_info(id, opts = {})
1288
+ if @api_client.config.debugging
1289
+ @api_client.config.logger.debug 'Calling API: SubscribersApi.withdraw_subscriber_consent ...'
1290
+ end
1291
+ # verify the required parameter 'id' is set
1292
+ if @api_client.config.client_side_validation && id.nil?
1293
+ fail ArgumentError, "Missing the required parameter 'id' when calling SubscribersApi.withdraw_subscriber_consent"
1294
+ end
1295
+ # resource path
1296
+ local_var_path = '/subscribers/{id}/consent'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
1297
+
1298
+ # query parameters
1299
+ query_params = opts[:query_params] || {}
1300
+
1301
+ # header parameters
1302
+ header_params = opts[:header_params] || {}
1303
+ # HTTP header 'Accept' (if needed)
1304
+ header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
1305
+ # HTTP header 'Content-Type'
1306
+ content_type = @api_client.select_header_content_type(['application/json'])
1307
+ if !content_type.nil?
1308
+ header_params['Content-Type'] = content_type
1309
+ end
1310
+
1311
+ # form parameters
1312
+ form_params = opts[:form_params] || {}
1313
+
1314
+ # http body (model)
1315
+ post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'withdraw_subscriber_consent_request'])
1316
+
1317
+ # return_type
1318
+ return_type = opts[:debug_return_type] || 'ConsentWithdrawResponse'
1319
+
1320
+ # auth_names
1321
+ auth_names = opts[:debug_auth_names] || ['ApiKeyAuth']
1322
+
1323
+ new_options = opts.merge(
1324
+ :operation => :"SubscribersApi.withdraw_subscriber_consent",
1325
+ :header_params => header_params,
1326
+ :query_params => query_params,
1327
+ :form_params => form_params,
1328
+ :body => post_body,
1329
+ :auth_names => auth_names,
1330
+ :return_type => return_type
1331
+ )
1332
+
1333
+ data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
1334
+ if @api_client.config.debugging
1335
+ @api_client.config.logger.debug "API called: SubscribersApi#withdraw_subscriber_consent\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1336
+ end
1337
+ return data, status_code, headers
1338
+ end
1339
+ end
1340
+ end