notifo-io 1.0.1 → 1.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (369) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1242 -42
  3. data/Rakefile +0 -2
  4. data/docs/AddAllowedTopicDto.md +3 -14
  5. data/docs/AddContributorDto.md +4 -16
  6. data/docs/AppContributorDto.md +5 -18
  7. data/docs/AppDetailsDto.md +12 -44
  8. data/docs/AppDto.md +10 -24
  9. data/docs/AppIdMediaBody.md +7 -0
  10. data/docs/AppsApi.md +161 -343
  11. data/docs/ChannelCondition.md +6 -0
  12. data/docs/ChannelSend.md +6 -0
  13. data/docs/ChannelSendInfoDto.md +9 -0
  14. data/docs/ChannelSettingDto.md +11 -0
  15. data/docs/ChannelTemplateDetailsDtoOfEmailTemplateDto.md +12 -0
  16. data/docs/ChannelTemplateDetailsDtoOfMessagingTemplateDto.md +12 -0
  17. data/docs/ChannelTemplateDetailsDtoOfSmsTemplateDto.md +12 -0
  18. data/docs/ChannelTemplateDto.md +11 -0
  19. data/docs/ConfigsApi.md +21 -61
  20. data/docs/ConfiguredIntegrationDto.md +13 -0
  21. data/docs/ConfiguredIntegrationsDto.md +8 -0
  22. data/docs/ConfirmMode.md +2 -11
  23. data/docs/CreateChannelTemplateDto.md +7 -0
  24. data/docs/CreateChannelTemplateLanguageDto.md +7 -0
  25. data/docs/CreateIntegrationDto.md +11 -0
  26. data/docs/CreateSystemUserDto.md +9 -0
  27. data/docs/EmailFormattingError.md +10 -0
  28. data/docs/EmailPreviewDto.md +8 -0
  29. data/docs/EmailPreviewRequestDto.md +9 -0
  30. data/docs/EmailPreviewType.md +6 -0
  31. data/docs/EmailTemplateDto.md +8 -18
  32. data/docs/EmailTemplateType.md +6 -0
  33. data/docs/EmailTemplatesApi.md +488 -0
  34. data/docs/ErrorDto.md +8 -22
  35. data/docs/EventDto.md +17 -36
  36. data/docs/EventsApi.md +74 -65
  37. data/docs/HandledInfoDto.md +8 -0
  38. data/docs/IntegrationCreatedDto.md +8 -0
  39. data/docs/IntegrationDefinitionDto.md +11 -0
  40. data/docs/IntegrationPropertyDto.md +19 -0
  41. data/docs/IntegrationPropertyType.md +6 -0
  42. data/docs/IntegrationStatus.md +6 -0
  43. data/docs/IsoDayOfWeek.md +2 -11
  44. data/docs/ListResponseDtoOfChannelTemplateDto.md +8 -0
  45. data/docs/ListResponseDtoOfEventDto.md +4 -16
  46. data/docs/ListResponseDtoOfLogEntryDto.md +4 -16
  47. data/docs/ListResponseDtoOfMediaDto.md +4 -16
  48. data/docs/ListResponseDtoOfMobilePushTokenDto.md +8 -0
  49. data/docs/ListResponseDtoOfSubscriptionDto.md +4 -16
  50. data/docs/ListResponseDtoOfSystemUserDto.md +8 -0
  51. data/docs/ListResponseDtoOfTemplateDto.md +4 -16
  52. data/docs/ListResponseDtoOfTopicDto.md +4 -16
  53. data/docs/ListResponseDtoOfUserDto.md +4 -16
  54. data/docs/ListResponseDtoOfUserNotificationDetailsDto.md +8 -0
  55. data/docs/ListResponseDtoOfUserNotificationDto.md +8 -0
  56. data/docs/LocalizedText.md +6 -0
  57. data/docs/LogEntryDto.md +6 -20
  58. data/docs/LogsApi.md +21 -40
  59. data/docs/MediaApi.md +102 -196
  60. data/docs/MediaDto.md +11 -26
  61. data/docs/MediaMetadata.md +6 -0
  62. data/docs/MediaType.md +2 -11
  63. data/docs/MessagingTemplateDto.md +7 -0
  64. data/docs/MessagingTemplatesApi.md +394 -0
  65. data/docs/MobileDeviceType.md +6 -0
  66. data/docs/MobilePushApi.md +135 -0
  67. data/docs/MobilePushTokenDto.md +9 -0
  68. data/docs/MobilePushTokenDto2.md +8 -0
  69. data/docs/NotificationFormattingDto.md +10 -28
  70. data/docs/NotificationProperties.md +6 -0
  71. data/docs/NotificationsApi.md +199 -0
  72. data/docs/PingApi.md +48 -0
  73. data/docs/ProcessStatus.md +6 -0
  74. data/docs/ProfileDto.md +11 -28
  75. data/docs/PublishDto.md +14 -32
  76. data/docs/PublishManyDto.md +3 -14
  77. data/docs/RegisterMobileTokenDto.md +8 -0
  78. data/docs/ResizeMode.md +2 -11
  79. data/docs/SchedulingDto.md +6 -20
  80. data/docs/SchedulingType.md +2 -11
  81. data/docs/SmsTemplateDto.md +7 -0
  82. data/docs/SmsTemplatesApi.md +394 -0
  83. data/docs/SubscribeDto.md +8 -0
  84. data/docs/SubscribeManyDto.md +8 -0
  85. data/docs/SubscriptionDto.md +4 -16
  86. data/docs/SystemUserDto.md +11 -0
  87. data/docs/SystemUsersApi.md +327 -0
  88. data/docs/TemplateDto.md +7 -18
  89. data/docs/TemplatesApi.md +52 -108
  90. data/docs/TopicChannel.md +6 -0
  91. data/docs/TopicDto.md +11 -18
  92. data/docs/TopicQueryScope.md +6 -0
  93. data/docs/TopicsApi.md +106 -30
  94. data/docs/TrackNotificationDto.md +10 -0
  95. data/docs/UpdateChannelTemplateDtoOfEmailTemplateDto.md +9 -0
  96. data/docs/UpdateChannelTemplateDtoOfMessagingTemplateDto.md +9 -0
  97. data/docs/UpdateChannelTemplateDtoOfSmsTemplateDto.md +9 -0
  98. data/docs/UpdateIntegrationDto.md +11 -0
  99. data/docs/UpdateProfileDto.md +8 -24
  100. data/docs/UpdateSystemUserDto.md +9 -0
  101. data/docs/UpsertAppDto.md +12 -32
  102. data/docs/UpsertTemplateDto.md +5 -18
  103. data/docs/UpsertTemplatesDto.md +3 -14
  104. data/docs/UpsertTopicDto.md +11 -0
  105. data/docs/UpsertTopicsDto.md +7 -0
  106. data/docs/UpsertUserDto.md +11 -28
  107. data/docs/UpsertUsersDto.md +3 -14
  108. data/docs/UserApi.md +156 -150
  109. data/docs/UserDto.md +20 -32
  110. data/docs/UserNotificationBaseDto.md +23 -0
  111. data/docs/UserNotificationChannelDto.md +11 -0
  112. data/docs/UserNotificationDetailsDto.md +27 -0
  113. data/docs/UserNotificationDto.md +25 -0
  114. data/docs/UserPropertyDto.md +9 -0
  115. data/docs/UserTopicDto.md +11 -0
  116. data/docs/UsersApi.md +161 -320
  117. data/git_push.sh +7 -10
  118. data/lib/notifo/api/apps_api.rb +164 -236
  119. data/lib/notifo/api/configs_api.rb +14 -30
  120. data/lib/notifo/api/email_templates_api.rb +663 -0
  121. data/lib/notifo/api/events_api.rb +88 -45
  122. data/lib/notifo/api/logs_api.rb +12 -21
  123. data/lib/notifo/api/media_api.rb +60 -97
  124. data/lib/notifo/api/messaging_templates_api.rb +541 -0
  125. data/lib/notifo/api/mobile_push_api.rb +178 -0
  126. data/lib/notifo/api/notifications_api.rb +256 -0
  127. data/lib/notifo/api/ping_api.rb +70 -0
  128. data/lib/notifo/api/sms_templates_api.rb +541 -0
  129. data/lib/notifo/api/system_users_api.rb +411 -0
  130. data/lib/notifo/api/templates_api.rb +43 -66
  131. data/lib/notifo/api/topics_api.rb +137 -21
  132. data/lib/notifo/api/user_api.rb +178 -104
  133. data/lib/notifo/api/users_api.rb +140 -199
  134. data/lib/notifo/api_client.rb +54 -56
  135. data/lib/notifo/api_error.rb +5 -5
  136. data/lib/notifo/configuration.rb +12 -84
  137. data/lib/notifo/models/add_allowed_topic_dto.rb +13 -44
  138. data/lib/notifo/models/add_contributor_dto.rb +14 -64
  139. data/lib/notifo/models/app_contributor_dto.rb +15 -84
  140. data/lib/notifo/models/app_details_dto.rb +51 -189
  141. data/lib/notifo/models/app_dto.rb +47 -86
  142. data/lib/notifo/models/{inline_object.rb → app_id_media_body.rb} +16 -28
  143. data/lib/notifo/models/channel_condition.rb +30 -0
  144. data/lib/notifo/models/channel_send.rb +30 -0
  145. data/lib/notifo/models/channel_send_info_dto.rb +227 -0
  146. data/lib/notifo/models/channel_setting_dto.rb +256 -0
  147. data/lib/notifo/models/channel_template_details_dto_of_email_template_dto.rb +285 -0
  148. data/lib/notifo/models/channel_template_details_dto_of_messaging_template_dto.rb +285 -0
  149. data/lib/notifo/models/channel_template_details_dto_of_sms_template_dto.rb +285 -0
  150. data/lib/notifo/models/channel_template_dto.rb +264 -0
  151. data/lib/notifo/models/configured_integration_dto.rb +285 -0
  152. data/lib/notifo/models/configured_integrations_dto.rb +231 -0
  153. data/lib/notifo/models/confirm_mode.rb +6 -16
  154. data/lib/notifo/models/create_channel_template_dto.rb +208 -0
  155. data/lib/notifo/models/{create_email_template_dto.rb → create_channel_template_language_dto.rb} +16 -47
  156. data/lib/notifo/models/create_integration_dto.rb +262 -0
  157. data/lib/notifo/models/create_system_user_dto.rb +240 -0
  158. data/lib/notifo/models/email_formatting_error.rb +233 -0
  159. data/lib/notifo/models/email_preview_dto.rb +221 -0
  160. data/lib/notifo/models/{notification_setting_dto.rb → email_preview_request_dto.rb} +43 -45
  161. data/lib/notifo/models/email_preview_type.rb +28 -0
  162. data/lib/notifo/models/email_template_dto.rb +52 -69
  163. data/lib/notifo/models/email_template_type.rb +30 -0
  164. data/lib/notifo/models/error_dto.rb +29 -30
  165. data/lib/notifo/models/event_dto.rb +60 -115
  166. data/lib/notifo/models/handled_info_dto.rb +218 -0
  167. data/lib/notifo/models/integration_created_dto.rb +226 -0
  168. data/lib/notifo/models/integration_definition_dto.rb +272 -0
  169. data/lib/notifo/models/integration_property_dto.rb +347 -0
  170. data/lib/notifo/models/integration_property_type.rb +31 -0
  171. data/lib/notifo/models/integration_status.rb +29 -0
  172. data/lib/notifo/models/iso_day_of_week.rb +12 -21
  173. data/lib/notifo/models/list_response_dto_of_channel_template_dto.rb +229 -0
  174. data/lib/notifo/models/list_response_dto_of_event_dto.rb +14 -26
  175. data/lib/notifo/models/list_response_dto_of_log_entry_dto.rb +14 -26
  176. data/lib/notifo/models/list_response_dto_of_media_dto.rb +14 -26
  177. data/lib/notifo/models/list_response_dto_of_mobile_push_token_dto.rb +229 -0
  178. data/lib/notifo/models/list_response_dto_of_subscription_dto.rb +14 -26
  179. data/lib/notifo/models/list_response_dto_of_system_user_dto.rb +229 -0
  180. data/lib/notifo/models/list_response_dto_of_template_dto.rb +14 -26
  181. data/lib/notifo/models/list_response_dto_of_topic_dto.rb +14 -26
  182. data/lib/notifo/models/list_response_dto_of_user_dto.rb +14 -26
  183. data/lib/notifo/models/list_response_dto_of_user_notification_details_dto.rb +229 -0
  184. data/lib/notifo/models/list_response_dto_of_user_notification_dto.rb +229 -0
  185. data/lib/notifo/models/localized_text.rb +201 -0
  186. data/lib/notifo/models/log_entry_dto.rb +16 -85
  187. data/lib/notifo/models/media_dto.rb +56 -116
  188. data/lib/notifo/models/media_metadata.rb +201 -0
  189. data/lib/notifo/models/media_type.rb +8 -17
  190. data/lib/notifo/models/messaging_template_dto.rb +212 -0
  191. data/lib/notifo/models/mobile_device_type.rb +29 -0
  192. data/lib/notifo/models/mobile_push_token_dto.rb +237 -0
  193. data/lib/notifo/models/mobile_push_token_dto2.rb +221 -0
  194. data/lib/notifo/models/notification_formatting_dto.rb +27 -58
  195. data/lib/notifo/models/notification_properties.rb +201 -0
  196. data/lib/notifo/models/process_status.rb +31 -0
  197. data/lib/notifo/models/profile_dto.rb +33 -71
  198. data/lib/notifo/models/publish_dto.rb +47 -59
  199. data/lib/notifo/models/publish_many_dto.rb +13 -25
  200. data/lib/notifo/models/register_mobile_token_dto.rb +221 -0
  201. data/lib/notifo/models/resize_mode.rb +11 -20
  202. data/lib/notifo/models/scheduling_dto.rb +16 -28
  203. data/lib/notifo/models/scheduling_type.rb +6 -15
  204. data/lib/notifo/models/sms_template_dto.rb +212 -0
  205. data/lib/notifo/models/subscribe_dto.rb +225 -0
  206. data/lib/notifo/models/subscribe_many_dto.rb +223 -0
  207. data/lib/notifo/models/subscription_dto.rb +17 -44
  208. data/lib/notifo/models/system_user_dto.rb +269 -0
  209. data/lib/notifo/models/template_dto.rb +44 -45
  210. data/lib/notifo/models/topic_channel.rb +28 -0
  211. data/lib/notifo/models/topic_dto.rb +81 -65
  212. data/lib/notifo/models/topic_query_scope.rb +29 -0
  213. data/lib/notifo/models/track_notification_dto.rb +243 -0
  214. data/lib/notifo/models/update_channel_template_dto_of_email_template_dto.rb +232 -0
  215. data/lib/notifo/models/update_channel_template_dto_of_messaging_template_dto.rb +232 -0
  216. data/lib/notifo/models/update_channel_template_dto_of_sms_template_dto.rb +232 -0
  217. data/lib/notifo/models/update_integration_dto.rb +258 -0
  218. data/lib/notifo/models/update_profile_dto.rb +18 -30
  219. data/lib/notifo/models/update_system_user_dto.rb +240 -0
  220. data/lib/notifo/models/upsert_app_dto.rb +22 -34
  221. data/lib/notifo/models/upsert_template_dto.rb +15 -46
  222. data/lib/notifo/models/upsert_templates_dto.rb +13 -25
  223. data/lib/notifo/models/upsert_topic_dto.rb +249 -0
  224. data/lib/notifo/models/upsert_topics_dto.rb +214 -0
  225. data/lib/notifo/models/upsert_user_dto.rb +34 -33
  226. data/lib/notifo/models/upsert_users_dto.rb +13 -25
  227. data/lib/notifo/models/user_dto.rb +137 -73
  228. data/lib/notifo/models/user_notification_base_dto.rb +402 -0
  229. data/lib/notifo/models/user_notification_channel_dto.rb +261 -0
  230. data/lib/notifo/models/user_notification_details_dto.rb +450 -0
  231. data/lib/notifo/models/user_notification_dto.rb +436 -0
  232. data/lib/notifo/models/user_property_dto.rb +234 -0
  233. data/lib/notifo/models/user_topic_dto.rb +265 -0
  234. data/lib/notifo/version.rb +4 -5
  235. data/lib/notifo.rb +71 -9
  236. data/notifo.gemspec +8 -8
  237. data/spec/api/apps_api_spec.rb +31 -32
  238. data/spec/api/configs_api_spec.rb +7 -8
  239. data/spec/api/email_templates_api_spec.rb +161 -0
  240. data/spec/api/events_api_spec.rb +20 -9
  241. data/spec/api/logs_api_spec.rb +7 -8
  242. data/spec/api/media_api_spec.rb +32 -11
  243. data/spec/api/messaging_templates_api_spec.rb +137 -0
  244. data/spec/api/mobile_push_api_spec.rb +66 -0
  245. data/spec/api/notifications_api_spec.rb +85 -0
  246. data/spec/api/ping_api_spec.rb +45 -0
  247. data/spec/api/sms_templates_api_spec.rb +137 -0
  248. data/spec/api/system_users_api_spec.rb +114 -0
  249. data/spec/api/templates_api_spec.rb +9 -10
  250. data/spec/api/topics_api_spec.rb +32 -8
  251. data/spec/api/user_api_spec.rb +41 -17
  252. data/spec/api/users_api_spec.rb +24 -23
  253. data/spec/api_client_spec.rb +5 -6
  254. data/spec/base_object_spec.rb +109 -0
  255. data/spec/configuration_spec.rb +7 -8
  256. data/spec/models/add_allowed_topic_dto_spec.rb +15 -9
  257. data/spec/models/add_contributor_dto_spec.rb +15 -9
  258. data/spec/models/app_contributor_dto_spec.rb +15 -9
  259. data/spec/models/app_details_dto_spec.rb +18 -48
  260. data/spec/models/app_dto_spec.rb +27 -9
  261. data/spec/models/app_id_media_body_spec.rb +40 -0
  262. data/spec/models/channel_condition_spec.rb +34 -0
  263. data/spec/models/channel_send_info_dto_spec.rb +52 -0
  264. data/spec/models/channel_send_spec.rb +34 -0
  265. data/spec/models/channel_setting_dto_spec.rb +64 -0
  266. data/spec/models/channel_template_details_dto_of_email_template_dto_spec.rb +70 -0
  267. data/spec/models/channel_template_details_dto_of_messaging_template_dto_spec.rb +70 -0
  268. data/spec/models/channel_template_details_dto_of_sms_template_dto_spec.rb +70 -0
  269. data/spec/models/channel_template_dto_spec.rb +64 -0
  270. data/spec/models/configured_integration_dto_spec.rb +76 -0
  271. data/spec/models/configured_integrations_dto_spec.rb +46 -0
  272. data/spec/models/confirm_mode_spec.rb +15 -9
  273. data/spec/models/create_channel_template_dto_spec.rb +40 -0
  274. data/spec/models/create_channel_template_language_dto_spec.rb +40 -0
  275. data/spec/models/create_integration_dto_spec.rb +64 -0
  276. data/spec/models/create_system_user_dto_spec.rb +52 -0
  277. data/spec/models/email_formatting_error_spec.rb +58 -0
  278. data/spec/models/email_preview_dto_spec.rb +46 -0
  279. data/spec/models/email_preview_request_dto_spec.rb +52 -0
  280. data/spec/models/email_preview_type_spec.rb +34 -0
  281. data/spec/models/email_template_dto_spec.rb +33 -9
  282. data/spec/models/email_template_type_spec.rb +34 -0
  283. data/spec/models/error_dto_spec.rb +21 -9
  284. data/spec/models/event_dto_spec.rb +33 -9
  285. data/spec/models/handled_info_dto_spec.rb +46 -0
  286. data/spec/models/integration_created_dto_spec.rb +46 -0
  287. data/spec/models/integration_definition_dto_spec.rb +64 -0
  288. data/spec/models/integration_property_dto_spec.rb +112 -0
  289. data/spec/models/integration_property_type_spec.rb +34 -0
  290. data/spec/models/integration_status_spec.rb +34 -0
  291. data/spec/models/iso_day_of_week_spec.rb +15 -9
  292. data/spec/models/list_response_dto_of_channel_template_dto_spec.rb +46 -0
  293. data/spec/models/list_response_dto_of_event_dto_spec.rb +15 -9
  294. data/spec/models/list_response_dto_of_log_entry_dto_spec.rb +15 -9
  295. data/spec/models/list_response_dto_of_media_dto_spec.rb +15 -9
  296. data/spec/models/list_response_dto_of_mobile_push_token_dto_spec.rb +46 -0
  297. data/spec/models/list_response_dto_of_subscription_dto_spec.rb +15 -9
  298. data/spec/models/list_response_dto_of_system_user_dto_spec.rb +46 -0
  299. data/spec/models/list_response_dto_of_template_dto_spec.rb +15 -9
  300. data/spec/models/list_response_dto_of_topic_dto_spec.rb +15 -9
  301. data/spec/models/list_response_dto_of_user_dto_spec.rb +15 -9
  302. data/spec/models/list_response_dto_of_user_notification_details_dto_spec.rb +46 -0
  303. data/spec/models/list_response_dto_of_user_notification_dto_spec.rb +46 -0
  304. data/spec/models/localized_text_spec.rb +34 -0
  305. data/spec/models/log_entry_dto_spec.rb +15 -9
  306. data/spec/models/media_dto_spec.rb +33 -9
  307. data/spec/models/media_metadata_spec.rb +34 -0
  308. data/spec/models/media_type_spec.rb +15 -9
  309. data/spec/models/messaging_template_dto_spec.rb +40 -0
  310. data/spec/models/mobile_device_type_spec.rb +34 -0
  311. data/spec/models/mobile_push_token_dto2_spec.rb +46 -0
  312. data/spec/models/mobile_push_token_dto_spec.rb +52 -0
  313. data/spec/models/notification_formatting_dto_spec.rb +15 -9
  314. data/spec/models/notification_properties_spec.rb +34 -0
  315. data/spec/models/process_status_spec.rb +34 -0
  316. data/spec/models/profile_dto_spec.rb +21 -9
  317. data/spec/models/publish_dto_spec.rb +27 -9
  318. data/spec/models/publish_many_dto_spec.rb +15 -9
  319. data/spec/models/register_mobile_token_dto_spec.rb +46 -0
  320. data/spec/models/resize_mode_spec.rb +15 -9
  321. data/spec/models/scheduling_dto_spec.rb +15 -9
  322. data/spec/models/scheduling_type_spec.rb +15 -9
  323. data/spec/models/sms_template_dto_spec.rb +40 -0
  324. data/spec/models/subscribe_dto_spec.rb +46 -0
  325. data/spec/models/subscribe_many_dto_spec.rb +46 -0
  326. data/spec/models/subscription_dto_spec.rb +15 -9
  327. data/spec/models/system_user_dto_spec.rb +64 -0
  328. data/spec/models/template_dto_spec.rb +27 -9
  329. data/spec/models/topic_channel_spec.rb +34 -0
  330. data/spec/models/topic_dto_spec.rb +51 -9
  331. data/spec/models/topic_query_scope_spec.rb +34 -0
  332. data/spec/models/track_notification_dto_spec.rb +58 -0
  333. data/spec/models/update_channel_template_dto_of_email_template_dto_spec.rb +52 -0
  334. data/spec/models/update_channel_template_dto_of_messaging_template_dto_spec.rb +52 -0
  335. data/spec/models/update_channel_template_dto_of_sms_template_dto_spec.rb +52 -0
  336. data/spec/models/update_integration_dto_spec.rb +64 -0
  337. data/spec/models/update_profile_dto_spec.rb +15 -9
  338. data/spec/models/update_system_user_dto_spec.rb +52 -0
  339. data/spec/models/upsert_app_dto_spec.rb +15 -9
  340. data/spec/models/upsert_template_dto_spec.rb +15 -9
  341. data/spec/models/upsert_templates_dto_spec.rb +15 -9
  342. data/spec/models/upsert_topic_dto_spec.rb +64 -0
  343. data/spec/models/upsert_topics_dto_spec.rb +40 -0
  344. data/spec/models/upsert_user_dto_spec.rb +21 -9
  345. data/spec/models/upsert_users_dto_spec.rb +15 -9
  346. data/spec/models/user_dto_spec.rb +63 -9
  347. data/spec/models/user_notification_base_dto_spec.rb +136 -0
  348. data/spec/models/user_notification_channel_dto_spec.rb +64 -0
  349. data/spec/models/user_notification_details_dto_spec.rb +160 -0
  350. data/spec/models/user_notification_dto_spec.rb +148 -0
  351. data/spec/models/user_property_dto_spec.rb +52 -0
  352. data/spec/models/user_topic_dto_spec.rb +64 -0
  353. data/spec/spec_helper.rb +4 -5
  354. metadata +299 -32
  355. data/docs/CreateEmailTemplateDto.md +0 -18
  356. data/docs/EmailVerificationStatus.md +0 -15
  357. data/docs/InlineObject.md +0 -18
  358. data/docs/NotificationSend.md +0 -15
  359. data/docs/NotificationSettingDto.md +0 -20
  360. data/lib/notifo/models/email_verification_status.rb +0 -39
  361. data/lib/notifo/models/notification_send.rb +0 -39
  362. data/notifo-1.0.0.gem +0 -0
  363. data/notifo-io-1.0.0.2.gem +0 -0
  364. data/notifo-io-1.0.0.gem +0 -0
  365. data/spec/models/create_email_template_dto_spec.rb +0 -34
  366. data/spec/models/email_verification_status_spec.rb +0 -28
  367. data/spec/models/inline_object_spec.rb +0 -34
  368. data/spec/models/notification_send_spec.rb +0 -28
  369. data/spec/models/notification_setting_dto_spec.rb +0 -40
data/docs/UsersApi.md CHANGED
@@ -1,70 +1,50 @@
1
1
  # Notifo::UsersApi
2
2
 
3
- All URIs are relative to *http://localhost*
4
-
5
- | Method | HTTP request | Description |
6
- | ------ | ------------ | ----------- |
7
- | [**users_delete_allowed_topic**](UsersApi.md#users_delete_allowed_topic) | **DELETE** /api/apps/{appId}/users/{id}/allowed-topics/{prefix} | Remove an allowed topic. |
8
- | [**users_delete_subscription**](UsersApi.md#users_delete_subscription) | **DELETE** /api/apps/{appId}/users/{id}/subscriptions/{prefix} | Remove a user subscriptions. |
9
- | [**users_delete_user**](UsersApi.md#users_delete_user) | **DELETE** /api/apps/{appId}/users/{id} | Delete a user. |
10
- | [**users_get_subscriptions**](UsersApi.md#users_get_subscriptions) | **GET** /api/apps/{appId}/users/{id}/subscriptions | Query user subscriptions. |
11
- | [**users_get_user**](UsersApi.md#users_get_user) | **GET** /api/apps/{appId}/users/{id} | Get a user. |
12
- | [**users_get_users**](UsersApi.md#users_get_users) | **GET** /api/apps/{appId}/users | Query users. |
13
- | [**users_post_allowed_topic**](UsersApi.md#users_post_allowed_topic) | **POST** /api/apps/{appId}/users/{id}/allowed-topics | Add an allowed topic. |
14
- | [**users_post_subscription**](UsersApi.md#users_post_subscription) | **POST** /api/apps/{appId}/users/{id}/subscriptions | Upsert a user subscriptions. |
15
- | [**users_post_users**](UsersApi.md#users_post_users) | **POST** /api/apps/{appId}/users | Upsert users. |
16
-
17
-
18
- ## users_delete_allowed_topic
19
-
3
+ All URIs are relative to *https://notifo.easierlife.com*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**users_delete_allowed_topic**](UsersApi.md#users_delete_allowed_topic) | **DELETE** /api/apps/{appId}/users/{id}/allowed-topics/{prefix} | Remove an allowed topic.
8
+ [**users_delete_subscription**](UsersApi.md#users_delete_subscription) | **DELETE** /api/apps/{appId}/users/{id}/subscriptions/{prefix} | Unsubscribes a user from a subscription.
9
+ [**users_delete_user**](UsersApi.md#users_delete_user) | **DELETE** /api/apps/{appId}/users/{id} | Delete a user.
10
+ [**users_get_subscriptions**](UsersApi.md#users_get_subscriptions) | **GET** /api/apps/{appId}/users/{id}/subscriptions | Query user subscriptions.
11
+ [**users_get_user**](UsersApi.md#users_get_user) | **GET** /api/apps/{appId}/users/{id} | Get a user.
12
+ [**users_get_users**](UsersApi.md#users_get_users) | **GET** /api/apps/{appId}/users | Query users.
13
+ [**users_post_allowed_topic**](UsersApi.md#users_post_allowed_topic) | **POST** /api/apps/{appId}/users/{id}/allowed-topics | Add an allowed topic.
14
+ [**users_post_subscriptions**](UsersApi.md#users_post_subscriptions) | **POST** /api/apps/{appId}/users/{id}/subscriptions | Upserts or deletes multiple user subscriptions.
15
+ [**users_post_users**](UsersApi.md#users_post_users) | **POST** /api/apps/{appId}/users | Upsert users.
16
+
17
+ # **users_delete_allowed_topic**
20
18
  > users_delete_allowed_topic(app_id, id, prefix)
21
19
 
22
20
  Remove an allowed topic.
23
21
 
24
- ### Examples
25
-
22
+ ### Example
26
23
  ```ruby
27
- require 'time'
24
+ # load the gem
28
25
  require 'notifo'
29
26
 
30
27
  api_instance = Notifo::UsersApi.new
31
28
  app_id = 'app_id_example' # String | The app where the users belong to.
32
- id = 'id_example' # String | The user id.
29
+ id = 'id_example' # String | The user ID.
33
30
  prefix = 'prefix_example' # String | The topic prefix.
34
31
 
35
- begin
36
- # Remove an allowed topic.
37
- api_instance.users_delete_allowed_topic(app_id, id, prefix)
38
- rescue Notifo::ApiError => e
39
- puts "Error when calling UsersApi->users_delete_allowed_topic: #{e}"
40
- end
41
- ```
42
-
43
- #### Using the users_delete_allowed_topic_with_http_info variant
44
-
45
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
46
-
47
- > <Array(nil, Integer, Hash)> users_delete_allowed_topic_with_http_info(app_id, id, prefix)
48
32
 
49
- ```ruby
50
33
  begin
51
- # Remove an allowed topic.
52
- data, status_code, headers = api_instance.users_delete_allowed_topic_with_http_info(app_id, id, prefix)
53
- p status_code # => 2xx
54
- p headers # => { ... }
55
- p data # => nil
34
+ #Remove an allowed topic.
35
+ api_instance.users_delete_allowed_topic(app_id, id, prefix)
56
36
  rescue Notifo::ApiError => e
57
- puts "Error when calling UsersApi->users_delete_allowed_topic_with_http_info: #{e}"
37
+ puts "Exception when calling UsersApi->users_delete_allowed_topic: #{e}"
58
38
  end
59
39
  ```
60
40
 
61
41
  ### Parameters
62
42
 
63
- | Name | Type | Description | Notes |
64
- | ---- | ---- | ----------- | ----- |
65
- | **app_id** | **String** | The app where the users belong to. | |
66
- | **id** | **String** | The user id. | |
67
- | **prefix** | **String** | The topic prefix. | |
43
+ Name | Type | Description | Notes
44
+ ------------- | ------------- | ------------- | -------------
45
+ **app_id** | **String**| The app where the users belong to. |
46
+ **id** | **String**| The user ID. |
47
+ **prefix** | **String**| The topic prefix. |
68
48
 
69
49
  ### Return type
70
50
 
@@ -76,60 +56,42 @@ No authorization required
76
56
 
77
57
  ### HTTP request headers
78
58
 
79
- - **Content-Type**: Not defined
80
- - **Accept**: application/json
59
+ - **Content-Type**: Not defined
60
+ - **Accept**: application/json
81
61
 
82
62
 
83
- ## users_delete_subscription
84
63
 
64
+ # **users_delete_subscription**
85
65
  > users_delete_subscription(app_id, id, prefix)
86
66
 
87
- Remove a user subscriptions.
88
-
89
- ### Examples
67
+ Unsubscribes a user from a subscription.
90
68
 
69
+ ### Example
91
70
  ```ruby
92
- require 'time'
71
+ # load the gem
93
72
  require 'notifo'
94
73
 
95
74
  api_instance = Notifo::UsersApi.new
96
75
  app_id = 'app_id_example' # String | The app where the user belongs to.
97
- id = 'id_example' # String | The user id.
76
+ id = 'id_example' # String | The user ID.
98
77
  prefix = 'prefix_example' # String | The topic prefix.
99
78
 
100
- begin
101
- # Remove a user subscriptions.
102
- api_instance.users_delete_subscription(app_id, id, prefix)
103
- rescue Notifo::ApiError => e
104
- puts "Error when calling UsersApi->users_delete_subscription: #{e}"
105
- end
106
- ```
107
-
108
- #### Using the users_delete_subscription_with_http_info variant
109
-
110
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
111
79
 
112
- > <Array(nil, Integer, Hash)> users_delete_subscription_with_http_info(app_id, id, prefix)
113
-
114
- ```ruby
115
80
  begin
116
- # Remove a user subscriptions.
117
- data, status_code, headers = api_instance.users_delete_subscription_with_http_info(app_id, id, prefix)
118
- p status_code # => 2xx
119
- p headers # => { ... }
120
- p data # => nil
81
+ #Unsubscribes a user from a subscription.
82
+ api_instance.users_delete_subscription(app_id, id, prefix)
121
83
  rescue Notifo::ApiError => e
122
- puts "Error when calling UsersApi->users_delete_subscription_with_http_info: #{e}"
84
+ puts "Exception when calling UsersApi->users_delete_subscription: #{e}"
123
85
  end
124
86
  ```
125
87
 
126
88
  ### Parameters
127
89
 
128
- | Name | Type | Description | Notes |
129
- | ---- | ---- | ----------- | ----- |
130
- | **app_id** | **String** | The app where the user belongs to. | |
131
- | **id** | **String** | The user id. | |
132
- | **prefix** | **String** | The topic prefix. | |
90
+ Name | Type | Description | Notes
91
+ ------------- | ------------- | ------------- | -------------
92
+ **app_id** | **String**| The app where the user belongs to. |
93
+ **id** | **String**| The user ID. |
94
+ **prefix** | **String**| The topic prefix. |
133
95
 
134
96
  ### Return type
135
97
 
@@ -141,63 +103,45 @@ No authorization required
141
103
 
142
104
  ### HTTP request headers
143
105
 
144
- - **Content-Type**: Not defined
145
- - **Accept**: application/json
106
+ - **Content-Type**: Not defined
107
+ - **Accept**: application/json
146
108
 
147
109
 
148
- ## users_delete_user
149
110
 
150
- > <ListResponseDtoOfUserDto> users_delete_user(app_id, id)
111
+ # **users_delete_user**
112
+ > String users_delete_user(app_id, id)
151
113
 
152
114
  Delete a user.
153
115
 
154
- ### Examples
155
-
116
+ ### Example
156
117
  ```ruby
157
- require 'time'
118
+ # load the gem
158
119
  require 'notifo'
159
120
 
160
121
  api_instance = Notifo::UsersApi.new
161
122
  app_id = 'app_id_example' # String | The app where the users belongs to.
162
123
  id = 'id_example' # String | The user id to delete.
163
124
 
125
+
164
126
  begin
165
- # Delete a user.
127
+ #Delete a user.
166
128
  result = api_instance.users_delete_user(app_id, id)
167
129
  p result
168
130
  rescue Notifo::ApiError => e
169
- puts "Error when calling UsersApi->users_delete_user: #{e}"
170
- end
171
- ```
172
-
173
- #### Using the users_delete_user_with_http_info variant
174
-
175
- This returns an Array which contains the response data, status code and headers.
176
-
177
- > <Array(<ListResponseDtoOfUserDto>, Integer, Hash)> users_delete_user_with_http_info(app_id, id)
178
-
179
- ```ruby
180
- begin
181
- # Delete a user.
182
- data, status_code, headers = api_instance.users_delete_user_with_http_info(app_id, id)
183
- p status_code # => 2xx
184
- p headers # => { ... }
185
- p data # => <ListResponseDtoOfUserDto>
186
- rescue Notifo::ApiError => e
187
- puts "Error when calling UsersApi->users_delete_user_with_http_info: #{e}"
131
+ puts "Exception when calling UsersApi->users_delete_user: #{e}"
188
132
  end
189
133
  ```
190
134
 
191
135
  ### Parameters
192
136
 
193
- | Name | Type | Description | Notes |
194
- | ---- | ---- | ----------- | ----- |
195
- | **app_id** | **String** | The app where the users belongs to. | |
196
- | **id** | **String** | The user id to delete. | |
137
+ Name | Type | Description | Notes
138
+ ------------- | ------------- | ------------- | -------------
139
+ **app_id** | **String**| The app where the users belongs to. |
140
+ **id** | **String**| The user id to delete. |
197
141
 
198
142
  ### Return type
199
143
 
200
- [**ListResponseDtoOfUserDto**](ListResponseDtoOfUserDto.md)
144
+ **String**
201
145
 
202
146
  ### Authorization
203
147
 
@@ -205,67 +149,48 @@ No authorization required
205
149
 
206
150
  ### HTTP request headers
207
151
 
208
- - **Content-Type**: Not defined
209
- - **Accept**: application/json
152
+ - **Content-Type**: Not defined
153
+ - **Accept**: application/octet-stream, application/json
210
154
 
211
155
 
212
- ## users_get_subscriptions
213
156
 
214
- > <ListResponseDtoOfSubscriptionDto> users_get_subscriptions(app_id, id, opts)
157
+ # **users_get_subscriptions**
158
+ > ListResponseDtoOfSubscriptionDto users_get_subscriptions(app_id, id, opts)
215
159
 
216
160
  Query user subscriptions.
217
161
 
218
- ### Examples
219
-
162
+ ### Example
220
163
  ```ruby
221
- require 'time'
164
+ # load the gem
222
165
  require 'notifo'
223
166
 
224
167
  api_instance = Notifo::UsersApi.new
225
168
  app_id = 'app_id_example' # String | The app where the user belongs to.
226
- id = 'id_example' # String | The user id.
227
- opts = {
169
+ id = 'id_example' # String | The user ID.
170
+ opts = {
228
171
  query: 'query_example', # String | The optional query to search for items.
229
172
  take: 56, # Integer | The number of items to return.
230
173
  skip: 56 # Integer | The number of items to skip.
231
174
  }
232
175
 
233
176
  begin
234
- # Query user subscriptions.
177
+ #Query user subscriptions.
235
178
  result = api_instance.users_get_subscriptions(app_id, id, opts)
236
179
  p result
237
180
  rescue Notifo::ApiError => e
238
- puts "Error when calling UsersApi->users_get_subscriptions: #{e}"
239
- end
240
- ```
241
-
242
- #### Using the users_get_subscriptions_with_http_info variant
243
-
244
- This returns an Array which contains the response data, status code and headers.
245
-
246
- > <Array(<ListResponseDtoOfSubscriptionDto>, Integer, Hash)> users_get_subscriptions_with_http_info(app_id, id, opts)
247
-
248
- ```ruby
249
- begin
250
- # Query user subscriptions.
251
- data, status_code, headers = api_instance.users_get_subscriptions_with_http_info(app_id, id, opts)
252
- p status_code # => 2xx
253
- p headers # => { ... }
254
- p data # => <ListResponseDtoOfSubscriptionDto>
255
- rescue Notifo::ApiError => e
256
- puts "Error when calling UsersApi->users_get_subscriptions_with_http_info: #{e}"
181
+ puts "Exception when calling UsersApi->users_get_subscriptions: #{e}"
257
182
  end
258
183
  ```
259
184
 
260
185
  ### Parameters
261
186
 
262
- | Name | Type | Description | Notes |
263
- | ---- | ---- | ----------- | ----- |
264
- | **app_id** | **String** | The app where the user belongs to. | |
265
- | **id** | **String** | The user id. | |
266
- | **query** | **String** | The optional query to search for items. | [optional] |
267
- | **take** | **Integer** | The number of items to return. | [optional] |
268
- | **skip** | **Integer** | The number of items to skip. | [optional] |
187
+ Name | Type | Description | Notes
188
+ ------------- | ------------- | ------------- | -------------
189
+ **app_id** | **String**| The app where the user belongs to. |
190
+ **id** | **String**| The user ID. |
191
+ **query** | **String**| The optional query to search for items. | [optional]
192
+ **take** | **Integer**| The number of items to return. | [optional]
193
+ **skip** | **Integer**| The number of items to skip. | [optional]
269
194
 
270
195
  ### Return type
271
196
 
@@ -277,63 +202,48 @@ No authorization required
277
202
 
278
203
  ### HTTP request headers
279
204
 
280
- - **Content-Type**: Not defined
281
- - **Accept**: application/json
205
+ - **Content-Type**: Not defined
206
+ - **Accept**: application/json
282
207
 
283
208
 
284
- ## users_get_user
285
209
 
286
- > <ListResponseDtoOfUserDto> users_get_user(app_id, id)
210
+ # **users_get_user**
211
+ > UserDto users_get_user(app_id, id, opts)
287
212
 
288
213
  Get a user.
289
214
 
290
- ### Examples
291
-
215
+ ### Example
292
216
  ```ruby
293
- require 'time'
217
+ # load the gem
294
218
  require 'notifo'
295
219
 
296
220
  api_instance = Notifo::UsersApi.new
297
221
  app_id = 'app_id_example' # String | The app where the user belongs to.
298
- id = 'id_example' # String | The user id.
222
+ id = 'id_example' # String | The user ID.
223
+ opts = {
224
+ with_details: false # BOOLEAN | Provide extra details, might be expensive.
225
+ }
299
226
 
300
227
  begin
301
- # Get a user.
302
- result = api_instance.users_get_user(app_id, id)
228
+ #Get a user.
229
+ result = api_instance.users_get_user(app_id, id, opts)
303
230
  p result
304
231
  rescue Notifo::ApiError => e
305
- puts "Error when calling UsersApi->users_get_user: #{e}"
306
- end
307
- ```
308
-
309
- #### Using the users_get_user_with_http_info variant
310
-
311
- This returns an Array which contains the response data, status code and headers.
312
-
313
- > <Array(<ListResponseDtoOfUserDto>, Integer, Hash)> users_get_user_with_http_info(app_id, id)
314
-
315
- ```ruby
316
- begin
317
- # Get a user.
318
- data, status_code, headers = api_instance.users_get_user_with_http_info(app_id, id)
319
- p status_code # => 2xx
320
- p headers # => { ... }
321
- p data # => <ListResponseDtoOfUserDto>
322
- rescue Notifo::ApiError => e
323
- puts "Error when calling UsersApi->users_get_user_with_http_info: #{e}"
232
+ puts "Exception when calling UsersApi->users_get_user: #{e}"
324
233
  end
325
234
  ```
326
235
 
327
236
  ### Parameters
328
237
 
329
- | Name | Type | Description | Notes |
330
- | ---- | ---- | ----------- | ----- |
331
- | **app_id** | **String** | The app where the user belongs to. | |
332
- | **id** | **String** | The user id. | |
238
+ Name | Type | Description | Notes
239
+ ------------- | ------------- | ------------- | -------------
240
+ **app_id** | **String**| The app where the user belongs to. |
241
+ **id** | **String**| The user ID. |
242
+ **with_details** | **BOOLEAN**| Provide extra details, might be expensive. | [optional] [default to false]
333
243
 
334
244
  ### Return type
335
245
 
336
- [**ListResponseDtoOfUserDto**](ListResponseDtoOfUserDto.md)
246
+ [**UserDto**](UserDto.md)
337
247
 
338
248
  ### Authorization
339
249
 
@@ -341,65 +251,48 @@ No authorization required
341
251
 
342
252
  ### HTTP request headers
343
253
 
344
- - **Content-Type**: Not defined
345
- - **Accept**: application/json
254
+ - **Content-Type**: Not defined
255
+ - **Accept**: application/json
346
256
 
347
257
 
348
- ## users_get_users
349
258
 
350
- > <ListResponseDtoOfUserDto> users_get_users(app_id, opts)
259
+ # **users_get_users**
260
+ > ListResponseDtoOfUserDto users_get_users(app_id, opts)
351
261
 
352
262
  Query users.
353
263
 
354
- ### Examples
355
-
264
+ ### Example
356
265
  ```ruby
357
- require 'time'
266
+ # load the gem
358
267
  require 'notifo'
359
268
 
360
269
  api_instance = Notifo::UsersApi.new
361
270
  app_id = 'app_id_example' # String | The app where the users belongs to.
362
- opts = {
271
+ opts = {
363
272
  query: 'query_example', # String | The optional query to search for items.
364
273
  take: 56, # Integer | The number of items to return.
365
- skip: 56 # Integer | The number of items to skip.
274
+ skip: 56, # Integer | The number of items to skip.
275
+ with_details: false # BOOLEAN | Provide extra details, might be expensive.
366
276
  }
367
277
 
368
278
  begin
369
- # Query users.
279
+ #Query users.
370
280
  result = api_instance.users_get_users(app_id, opts)
371
281
  p result
372
282
  rescue Notifo::ApiError => e
373
- puts "Error when calling UsersApi->users_get_users: #{e}"
374
- end
375
- ```
376
-
377
- #### Using the users_get_users_with_http_info variant
378
-
379
- This returns an Array which contains the response data, status code and headers.
380
-
381
- > <Array(<ListResponseDtoOfUserDto>, Integer, Hash)> users_get_users_with_http_info(app_id, opts)
382
-
383
- ```ruby
384
- begin
385
- # Query users.
386
- data, status_code, headers = api_instance.users_get_users_with_http_info(app_id, opts)
387
- p status_code # => 2xx
388
- p headers # => { ... }
389
- p data # => <ListResponseDtoOfUserDto>
390
- rescue Notifo::ApiError => e
391
- puts "Error when calling UsersApi->users_get_users_with_http_info: #{e}"
283
+ puts "Exception when calling UsersApi->users_get_users: #{e}"
392
284
  end
393
285
  ```
394
286
 
395
287
  ### Parameters
396
288
 
397
- | Name | Type | Description | Notes |
398
- | ---- | ---- | ----------- | ----- |
399
- | **app_id** | **String** | The app where the users belongs to. | |
400
- | **query** | **String** | The optional query to search for items. | [optional] |
401
- | **take** | **Integer** | The number of items to return. | [optional] |
402
- | **skip** | **Integer** | The number of items to skip. | [optional] |
289
+ Name | Type | Description | Notes
290
+ ------------- | ------------- | ------------- | -------------
291
+ **app_id** | **String**| The app where the users belongs to. |
292
+ **query** | **String**| The optional query to search for items. | [optional]
293
+ **take** | **Integer**| The number of items to return. | [optional]
294
+ **skip** | **Integer**| The number of items to skip. | [optional]
295
+ **with_details** | **BOOLEAN**| Provide extra details, might be expensive. | [optional] [default to false]
403
296
 
404
297
  ### Return type
405
298
 
@@ -411,60 +304,42 @@ No authorization required
411
304
 
412
305
  ### HTTP request headers
413
306
 
414
- - **Content-Type**: Not defined
415
- - **Accept**: application/json
307
+ - **Content-Type**: Not defined
308
+ - **Accept**: application/json
416
309
 
417
310
 
418
- ## users_post_allowed_topic
419
311
 
420
- > users_post_allowed_topic(app_id, id, add_allowed_topic_dto)
312
+ # **users_post_allowed_topic**
313
+ > users_post_allowed_topic(bodyapp_idid)
421
314
 
422
315
  Add an allowed topic.
423
316
 
424
- ### Examples
425
-
317
+ ### Example
426
318
  ```ruby
427
- require 'time'
319
+ # load the gem
428
320
  require 'notifo'
429
321
 
430
322
  api_instance = Notifo::UsersApi.new
323
+ body = Notifo::AddAllowedTopicDto.new # AddAllowedTopicDto | The upsert request.
431
324
  app_id = 'app_id_example' # String | The app where the users belong to.
432
- id = 'id_example' # String | The user id.
433
- add_allowed_topic_dto = Notifo::AddAllowedTopicDto.new({prefix: 'prefix_example'}) # AddAllowedTopicDto | The upsert request.
434
-
435
- begin
436
- # Add an allowed topic.
437
- api_instance.users_post_allowed_topic(app_id, id, add_allowed_topic_dto)
438
- rescue Notifo::ApiError => e
439
- puts "Error when calling UsersApi->users_post_allowed_topic: #{e}"
440
- end
441
- ```
325
+ id = 'id_example' # String | The user ID.
442
326
 
443
- #### Using the users_post_allowed_topic_with_http_info variant
444
327
 
445
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
446
-
447
- > <Array(nil, Integer, Hash)> users_post_allowed_topic_with_http_info(app_id, id, add_allowed_topic_dto)
448
-
449
- ```ruby
450
328
  begin
451
- # Add an allowed topic.
452
- data, status_code, headers = api_instance.users_post_allowed_topic_with_http_info(app_id, id, add_allowed_topic_dto)
453
- p status_code # => 2xx
454
- p headers # => { ... }
455
- p data # => nil
329
+ #Add an allowed topic.
330
+ api_instance.users_post_allowed_topic(bodyapp_idid)
456
331
  rescue Notifo::ApiError => e
457
- puts "Error when calling UsersApi->users_post_allowed_topic_with_http_info: #{e}"
332
+ puts "Exception when calling UsersApi->users_post_allowed_topic: #{e}"
458
333
  end
459
334
  ```
460
335
 
461
336
  ### Parameters
462
337
 
463
- | Name | Type | Description | Notes |
464
- | ---- | ---- | ----------- | ----- |
465
- | **app_id** | **String** | The app where the users belong to. | |
466
- | **id** | **String** | The user id. | |
467
- | **add_allowed_topic_dto** | [**AddAllowedTopicDto**](AddAllowedTopicDto.md) | The upsert request. | |
338
+ Name | Type | Description | Notes
339
+ ------------- | ------------- | ------------- | -------------
340
+ **body** | [**AddAllowedTopicDto**](AddAllowedTopicDto.md)| The upsert request. |
341
+ **app_id** | **String**| The app where the users belong to. |
342
+ **id** | **String**| The user ID. |
468
343
 
469
344
  ### Return type
470
345
 
@@ -476,60 +351,42 @@ No authorization required
476
351
 
477
352
  ### HTTP request headers
478
353
 
479
- - **Content-Type**: application/json
480
- - **Accept**: application/json
481
-
354
+ - **Content-Type**: application/json
355
+ - **Accept**: application/json
482
356
 
483
- ## users_post_subscription
484
357
 
485
- > users_post_subscription(app_id, id, subscription_dto)
486
358
 
487
- Upsert a user subscriptions.
359
+ # **users_post_subscriptions**
360
+ > users_post_subscriptions(bodyapp_idid)
488
361
 
489
- ### Examples
362
+ Upserts or deletes multiple user subscriptions.
490
363
 
364
+ ### Example
491
365
  ```ruby
492
- require 'time'
366
+ # load the gem
493
367
  require 'notifo'
494
368
 
495
369
  api_instance = Notifo::UsersApi.new
370
+ body = Notifo::SubscribeManyDto.new # SubscribeManyDto | The subscription object.
496
371
  app_id = 'app_id_example' # String | The app where the user belongs to.
497
- id = 'id_example' # String | The user id.
498
- subscription_dto = Notifo::SubscriptionDto.new({topic_prefix: 'topic_prefix_example'}) # SubscriptionDto | The subscription object.
372
+ id = 'id_example' # String | The user ID.
499
373
 
500
- begin
501
- # Upsert a user subscriptions.
502
- api_instance.users_post_subscription(app_id, id, subscription_dto)
503
- rescue Notifo::ApiError => e
504
- puts "Error when calling UsersApi->users_post_subscription: #{e}"
505
- end
506
- ```
507
-
508
- #### Using the users_post_subscription_with_http_info variant
509
-
510
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
511
374
 
512
- > <Array(nil, Integer, Hash)> users_post_subscription_with_http_info(app_id, id, subscription_dto)
513
-
514
- ```ruby
515
375
  begin
516
- # Upsert a user subscriptions.
517
- data, status_code, headers = api_instance.users_post_subscription_with_http_info(app_id, id, subscription_dto)
518
- p status_code # => 2xx
519
- p headers # => { ... }
520
- p data # => nil
376
+ #Upserts or deletes multiple user subscriptions.
377
+ api_instance.users_post_subscriptions(bodyapp_idid)
521
378
  rescue Notifo::ApiError => e
522
- puts "Error when calling UsersApi->users_post_subscription_with_http_info: #{e}"
379
+ puts "Exception when calling UsersApi->users_post_subscriptions: #{e}"
523
380
  end
524
381
  ```
525
382
 
526
383
  ### Parameters
527
384
 
528
- | Name | Type | Description | Notes |
529
- | ---- | ---- | ----------- | ----- |
530
- | **app_id** | **String** | The app where the user belongs to. | |
531
- | **id** | **String** | The user id. | |
532
- | **subscription_dto** | [**SubscriptionDto**](SubscriptionDto.md) | The subscription object. | |
385
+ Name | Type | Description | Notes
386
+ ------------- | ------------- | ------------- | -------------
387
+ **body** | [**SubscribeManyDto**](SubscribeManyDto.md)| The subscription object. |
388
+ **app_id** | **String**| The app where the user belongs to. |
389
+ **id** | **String**| The user ID. |
533
390
 
534
391
  ### Return type
535
392
 
@@ -541,59 +398,41 @@ No authorization required
541
398
 
542
399
  ### HTTP request headers
543
400
 
544
- - **Content-Type**: application/json
545
- - **Accept**: application/json
401
+ - **Content-Type**: application/json
402
+ - **Accept**: application/json
546
403
 
547
404
 
548
- ## users_post_users
549
405
 
550
- > <Array<UserDto>> users_post_users(app_id, upsert_users_dto)
406
+ # **users_post_users**
407
+ > Array&lt;UserDto&gt; users_post_users(bodyapp_id)
551
408
 
552
409
  Upsert users.
553
410
 
554
- ### Examples
555
-
411
+ ### Example
556
412
  ```ruby
557
- require 'time'
413
+ # load the gem
558
414
  require 'notifo'
559
415
 
560
416
  api_instance = Notifo::UsersApi.new
417
+ body = Notifo::UpsertUsersDto.new # UpsertUsersDto | The upsert request.
561
418
  app_id = 'app_id_example' # String | The app where the users belong to.
562
- upsert_users_dto = Notifo::UpsertUsersDto.new({requests: [Notifo::UpsertUserDto.new]}) # UpsertUsersDto | The upsert request.
563
419
 
564
- begin
565
- # Upsert users.
566
- result = api_instance.users_post_users(app_id, upsert_users_dto)
567
- p result
568
- rescue Notifo::ApiError => e
569
- puts "Error when calling UsersApi->users_post_users: #{e}"
570
- end
571
- ```
572
-
573
- #### Using the users_post_users_with_http_info variant
574
420
 
575
- This returns an Array which contains the response data, status code and headers.
576
-
577
- > <Array(<Array<UserDto>>, Integer, Hash)> users_post_users_with_http_info(app_id, upsert_users_dto)
578
-
579
- ```ruby
580
421
  begin
581
- # Upsert users.
582
- data, status_code, headers = api_instance.users_post_users_with_http_info(app_id, upsert_users_dto)
583
- p status_code # => 2xx
584
- p headers # => { ... }
585
- p data # => <Array<UserDto>>
422
+ #Upsert users.
423
+ result = api_instance.users_post_users(bodyapp_id)
424
+ p result
586
425
  rescue Notifo::ApiError => e
587
- puts "Error when calling UsersApi->users_post_users_with_http_info: #{e}"
426
+ puts "Exception when calling UsersApi->users_post_users: #{e}"
588
427
  end
589
428
  ```
590
429
 
591
430
  ### Parameters
592
431
 
593
- | Name | Type | Description | Notes |
594
- | ---- | ---- | ----------- | ----- |
595
- | **app_id** | **String** | The app where the users belong to. | |
596
- | **upsert_users_dto** | [**UpsertUsersDto**](UpsertUsersDto.md) | The upsert request. | |
432
+ Name | Type | Description | Notes
433
+ ------------- | ------------- | ------------- | -------------
434
+ **body** | [**UpsertUsersDto**](UpsertUsersDto.md)| The upsert request. |
435
+ **app_id** | **String**| The app where the users belong to. |
597
436
 
598
437
  ### Return type
599
438
 
@@ -605,6 +444,8 @@ No authorization required
605
444
 
606
445
  ### HTTP request headers
607
446
 
608
- - **Content-Type**: application/json
609
- - **Accept**: application/json
447
+ - **Content-Type**: application/json
448
+ - **Accept**: application/json
449
+
450
+
610
451