notifo-io 1.0.1.2 → 1.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (324) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +646 -149
  3. data/docs/AppDetailsDto.md +3 -1
  4. data/docs/AppDto.md +2 -0
  5. data/docs/AppsApi.md +0 -186
  6. data/docs/{NotificationSend.md → ChannelCondition.md} +1 -1
  7. data/docs/{EventProperties.md → ChannelSend.md} +1 -1
  8. data/docs/ChannelSendInfoDto.md +9 -0
  9. data/docs/ChannelSettingDto.md +11 -0
  10. data/docs/ChannelTemplateDetailsDtoOfEmailTemplateDto.md +12 -0
  11. data/docs/ChannelTemplateDetailsDtoOfMessagingTemplateDto.md +12 -0
  12. data/docs/ChannelTemplateDetailsDtoOfSmsTemplateDto.md +12 -0
  13. data/docs/ChannelTemplateDto.md +11 -0
  14. data/docs/ConfiguredIntegrationDto.md +2 -1
  15. data/docs/CreateChannelTemplateDto.md +7 -0
  16. data/docs/{CreateEmailTemplateDto.md → CreateChannelTemplateLanguageDto.md} +1 -1
  17. data/docs/CreateIntegrationDto.md +1 -1
  18. data/docs/CreateSystemUserDto.md +9 -0
  19. data/docs/EmailFormattingError.md +10 -0
  20. data/docs/EmailPreviewDto.md +8 -0
  21. data/docs/EmailPreviewRequestDto.md +9 -0
  22. data/docs/{EmailTemplatesDto.md → EmailPreviewType.md} +1 -1
  23. data/docs/EmailTemplateDto.md +3 -0
  24. data/docs/{IntegrationProperties.md → EmailTemplateType.md} +1 -1
  25. data/docs/EmailTemplatesApi.md +488 -0
  26. data/docs/ErrorDto.md +1 -0
  27. data/docs/EventDto.md +3 -1
  28. data/docs/EventsApi.md +7 -5
  29. data/docs/HandledInfoDto.md +8 -0
  30. data/docs/IntegrationPropertyDto.md +2 -0
  31. data/docs/ListResponseDtoOfChannelTemplateDto.md +8 -0
  32. data/docs/ListResponseDtoOfMobilePushTokenDto.md +1 -1
  33. data/docs/{ListResponseDtoOfNotificationDto.md → ListResponseDtoOfSystemUserDto.md} +2 -2
  34. data/docs/ListResponseDtoOfUserNotificationDetailsDto.md +8 -0
  35. data/docs/ListResponseDtoOfUserNotificationDto.md +8 -0
  36. data/docs/MediaDto.md +3 -1
  37. data/docs/{Body.md → MessagingTemplateDto.md} +2 -2
  38. data/docs/MessagingTemplatesApi.md +394 -0
  39. data/docs/MobilePushApi.md +15 -15
  40. data/docs/MobilePushTokenDto.md +3 -2
  41. data/docs/MobilePushTokenDto2.md +8 -0
  42. data/docs/NotificationFormattingDto.md +1 -1
  43. data/docs/NotificationProperties.md +6 -0
  44. data/docs/NotificationsApi.md +74 -16
  45. data/docs/PingApi.md +48 -0
  46. data/docs/ProcessStatus.md +6 -0
  47. data/docs/ProfileDto.md +2 -1
  48. data/docs/PublishDto.md +2 -2
  49. data/docs/{EmailVerificationStatus.md → SmsTemplateDto.md} +2 -1
  50. data/docs/SmsTemplatesApi.md +394 -0
  51. data/docs/SubscribeDto.md +8 -0
  52. data/docs/SubscribeManyDto.md +8 -0
  53. data/docs/SubscriptionDto.md +1 -1
  54. data/docs/SystemUserDto.md +11 -0
  55. data/docs/SystemUsersApi.md +327 -0
  56. data/docs/TemplateDto.md +3 -1
  57. data/docs/TemplatesApi.md +3 -4
  58. data/docs/TopicChannel.md +6 -0
  59. data/docs/TopicDto.md +7 -1
  60. data/docs/TopicQueryScope.md +6 -0
  61. data/docs/TopicsApi.md +95 -0
  62. data/docs/UpdateChannelTemplateDtoOfEmailTemplateDto.md +9 -0
  63. data/docs/UpdateChannelTemplateDtoOfMessagingTemplateDto.md +9 -0
  64. data/docs/UpdateChannelTemplateDtoOfSmsTemplateDto.md +9 -0
  65. data/docs/UpdateIntegrationDto.md +2 -1
  66. data/docs/UpdateProfileDto.md +1 -1
  67. data/docs/UpdateSystemUserDto.md +9 -0
  68. data/docs/UpsertTemplateDto.md +1 -1
  69. data/docs/UpsertTopicDto.md +11 -0
  70. data/docs/UpsertTopicsDto.md +7 -0
  71. data/docs/UpsertUserDto.md +2 -2
  72. data/docs/UserApi.md +119 -21
  73. data/docs/UserDto.md +7 -2
  74. data/docs/UserNotificationBaseDto.md +23 -0
  75. data/docs/UserNotificationChannelDto.md +11 -0
  76. data/docs/UserNotificationDetailsDto.md +27 -0
  77. data/docs/{NotificationDto.md → UserNotificationDto.md} +9 -5
  78. data/docs/UserPropertyDto.md +9 -0
  79. data/docs/UserTopicDto.md +11 -0
  80. data/docs/UsersApi.md +37 -32
  81. data/lib/notifo/api/apps_api.rb +1 -245
  82. data/lib/notifo/api/configs_api.rb +1 -1
  83. data/lib/notifo/api/email_templates_api.rb +663 -0
  84. data/lib/notifo/api/events_api.rb +10 -7
  85. data/lib/notifo/api/logs_api.rb +1 -1
  86. data/lib/notifo/api/media_api.rb +1 -1
  87. data/lib/notifo/api/messaging_templates_api.rb +541 -0
  88. data/lib/notifo/api/mobile_push_api.rb +18 -18
  89. data/lib/notifo/api/notifications_api.rb +97 -22
  90. data/lib/notifo/api/ping_api.rb +70 -0
  91. data/lib/notifo/api/sms_templates_api.rb +541 -0
  92. data/lib/notifo/api/system_users_api.rb +411 -0
  93. data/lib/notifo/api/templates_api.rb +6 -6
  94. data/lib/notifo/api/topics_api.rb +126 -1
  95. data/lib/notifo/api/user_api.rb +138 -27
  96. data/lib/notifo/api/users_api.rb +38 -32
  97. data/lib/notifo/api_client.rb +1 -1
  98. data/lib/notifo/api_error.rb +1 -1
  99. data/lib/notifo/configuration.rb +1 -1
  100. data/lib/notifo/models/add_allowed_topic_dto.rb +1 -1
  101. data/lib/notifo/models/add_contributor_dto.rb +1 -1
  102. data/lib/notifo/models/app_contributor_dto.rb +1 -1
  103. data/lib/notifo/models/app_details_dto.rb +41 -11
  104. data/lib/notifo/models/app_dto.rb +32 -2
  105. data/lib/notifo/models/app_id_media_body.rb +1 -1
  106. data/lib/notifo/models/channel_condition.rb +30 -0
  107. data/lib/notifo/models/{notification_send.rb → channel_send.rb} +4 -4
  108. data/lib/notifo/models/channel_send_info_dto.rb +227 -0
  109. data/lib/notifo/models/channel_setting_dto.rb +256 -0
  110. data/lib/notifo/models/channel_template_details_dto_of_email_template_dto.rb +285 -0
  111. data/lib/notifo/models/channel_template_details_dto_of_messaging_template_dto.rb +285 -0
  112. data/lib/notifo/models/channel_template_details_dto_of_sms_template_dto.rb +285 -0
  113. data/lib/notifo/models/channel_template_dto.rb +264 -0
  114. data/lib/notifo/models/configured_integration_dto.rb +17 -3
  115. data/lib/notifo/models/configured_integrations_dto.rb +1 -1
  116. data/lib/notifo/models/confirm_mode.rb +2 -3
  117. data/lib/notifo/models/{body.rb → create_channel_template_dto.rb} +13 -11
  118. data/lib/notifo/models/{create_email_template_dto.rb → create_channel_template_language_dto.rb} +4 -4
  119. data/lib/notifo/models/create_integration_dto.rb +7 -2
  120. data/lib/notifo/models/create_system_user_dto.rb +240 -0
  121. data/lib/notifo/models/email_formatting_error.rb +233 -0
  122. data/lib/notifo/models/email_preview_dto.rb +221 -0
  123. data/lib/notifo/models/email_preview_request_dto.rb +232 -0
  124. data/lib/notifo/models/email_preview_type.rb +28 -0
  125. data/lib/notifo/models/email_template_dto.rb +39 -6
  126. data/lib/notifo/models/email_template_type.rb +30 -0
  127. data/lib/notifo/models/error_dto.rb +13 -2
  128. data/lib/notifo/models/event_dto.rb +24 -2
  129. data/lib/notifo/models/handled_info_dto.rb +218 -0
  130. data/lib/notifo/models/integration_created_dto.rb +1 -1
  131. data/lib/notifo/models/integration_definition_dto.rb +1 -1
  132. data/lib/notifo/models/integration_property_dto.rb +30 -2
  133. data/lib/notifo/models/integration_property_type.rb +1 -1
  134. data/lib/notifo/models/integration_status.rb +1 -1
  135. data/lib/notifo/models/iso_day_of_week.rb +1 -1
  136. data/lib/notifo/models/list_response_dto_of_channel_template_dto.rb +229 -0
  137. data/lib/notifo/models/list_response_dto_of_event_dto.rb +1 -1
  138. data/lib/notifo/models/list_response_dto_of_log_entry_dto.rb +1 -1
  139. data/lib/notifo/models/list_response_dto_of_media_dto.rb +1 -1
  140. data/lib/notifo/models/list_response_dto_of_mobile_push_token_dto.rb +1 -1
  141. data/lib/notifo/models/list_response_dto_of_subscription_dto.rb +1 -1
  142. data/lib/notifo/models/{list_response_dto_of_notification_dto.rb → list_response_dto_of_system_user_dto.rb} +4 -4
  143. data/lib/notifo/models/list_response_dto_of_template_dto.rb +1 -1
  144. data/lib/notifo/models/list_response_dto_of_topic_dto.rb +1 -1
  145. data/lib/notifo/models/list_response_dto_of_user_dto.rb +1 -1
  146. data/lib/notifo/models/list_response_dto_of_user_notification_details_dto.rb +229 -0
  147. data/lib/notifo/models/list_response_dto_of_user_notification_dto.rb +229 -0
  148. data/lib/notifo/models/localized_text.rb +1 -1
  149. data/lib/notifo/models/log_entry_dto.rb +1 -1
  150. data/lib/notifo/models/media_dto.rb +42 -12
  151. data/lib/notifo/models/media_metadata.rb +1 -1
  152. data/lib/notifo/models/media_type.rb +1 -1
  153. data/lib/notifo/models/messaging_template_dto.rb +212 -0
  154. data/lib/notifo/models/mobile_device_type.rb +1 -1
  155. data/lib/notifo/models/mobile_push_token_dto.rb +22 -6
  156. data/lib/notifo/models/{notification_setting_dto.rb → mobile_push_token_dto2.rb} +21 -22
  157. data/lib/notifo/models/notification_formatting_dto.rb +1 -6
  158. data/lib/notifo/models/{event_properties.rb → notification_properties.rb} +4 -4
  159. data/lib/notifo/models/{email_verification_status.rb → process_status.rb} +8 -7
  160. data/lib/notifo/models/profile_dto.rb +14 -2
  161. data/lib/notifo/models/publish_dto.rb +1 -1
  162. data/lib/notifo/models/publish_many_dto.rb +1 -1
  163. data/lib/notifo/models/register_mobile_token_dto.rb +1 -1
  164. data/lib/notifo/models/resize_mode.rb +1 -1
  165. data/lib/notifo/models/scheduling_dto.rb +1 -1
  166. data/lib/notifo/models/scheduling_type.rb +1 -1
  167. data/lib/notifo/models/{email_templates_dto.rb → sms_template_dto.rb} +22 -11
  168. data/lib/notifo/models/subscribe_dto.rb +225 -0
  169. data/lib/notifo/models/subscribe_many_dto.rb +223 -0
  170. data/lib/notifo/models/subscription_dto.rb +6 -2
  171. data/lib/notifo/models/system_user_dto.rb +269 -0
  172. data/lib/notifo/models/template_dto.rb +32 -2
  173. data/lib/notifo/models/topic_channel.rb +28 -0
  174. data/lib/notifo/models/topic_dto.rb +69 -3
  175. data/lib/notifo/models/topic_query_scope.rb +29 -0
  176. data/lib/notifo/models/track_notification_dto.rb +1 -1
  177. data/lib/notifo/models/update_channel_template_dto_of_email_template_dto.rb +232 -0
  178. data/lib/notifo/models/update_channel_template_dto_of_messaging_template_dto.rb +232 -0
  179. data/lib/notifo/models/update_channel_template_dto_of_sms_template_dto.rb +232 -0
  180. data/lib/notifo/models/update_integration_dto.rb +19 -3
  181. data/lib/notifo/models/update_profile_dto.rb +1 -1
  182. data/lib/notifo/models/update_system_user_dto.rb +240 -0
  183. data/lib/notifo/models/upsert_app_dto.rb +1 -1
  184. data/lib/notifo/models/upsert_template_dto.rb +1 -1
  185. data/lib/notifo/models/upsert_templates_dto.rb +1 -1
  186. data/lib/notifo/models/upsert_topic_dto.rb +249 -0
  187. data/lib/notifo/models/upsert_topics_dto.rb +214 -0
  188. data/lib/notifo/models/upsert_user_dto.rb +15 -13
  189. data/lib/notifo/models/upsert_users_dto.rb +1 -1
  190. data/lib/notifo/models/user_dto.rb +89 -16
  191. data/lib/notifo/models/{notification_dto.rb → user_notification_base_dto.rb} +62 -46
  192. data/lib/notifo/models/user_notification_channel_dto.rb +261 -0
  193. data/lib/notifo/models/user_notification_details_dto.rb +450 -0
  194. data/lib/notifo/models/user_notification_dto.rb +436 -0
  195. data/lib/notifo/models/user_property_dto.rb +234 -0
  196. data/lib/notifo/models/user_topic_dto.rb +265 -0
  197. data/lib/notifo/version.rb +1 -1
  198. data/lib/notifo.rb +49 -11
  199. data/notifo.gemspec +3 -3
  200. data/spec/api/apps_api_spec.rb +20 -20
  201. data/spec/api/configs_api_spec.rb +1 -1
  202. data/spec/api/email_templates_api_spec.rb +161 -0
  203. data/spec/api/events_api_spec.rb +13 -1
  204. data/spec/api/logs_api_spec.rb +1 -1
  205. data/spec/api/media_api_spec.rb +1 -1
  206. data/spec/api/messaging_templates_api_spec.rb +137 -0
  207. data/spec/api/mobile_push_api_spec.rb +7 -7
  208. data/spec/api/notifications_api_spec.rb +25 -8
  209. data/spec/api/ping_api_spec.rb +45 -0
  210. data/spec/api/sms_templates_api_spec.rb +137 -0
  211. data/spec/api/system_users_api_spec.rb +114 -0
  212. data/spec/api/templates_api_spec.rb +2 -2
  213. data/spec/api/topics_api_spec.rb +26 -1
  214. data/spec/api/user_api_spec.rb +33 -8
  215. data/spec/api/users_api_spec.rb +15 -13
  216. data/spec/api_client_spec.rb +1 -1
  217. data/spec/configuration_spec.rb +4 -4
  218. data/spec/models/add_allowed_topic_dto_spec.rb +1 -1
  219. data/spec/models/add_contributor_dto_spec.rb +1 -1
  220. data/spec/models/app_contributor_dto_spec.rb +1 -1
  221. data/spec/models/app_details_dto_spec.rb +4 -40
  222. data/spec/models/app_dto_spec.rb +13 -1
  223. data/spec/models/app_id_media_body_spec.rb +1 -1
  224. data/spec/models/{notification_send_spec.rb → channel_condition_spec.rb} +7 -7
  225. data/spec/models/channel_send_info_dto_spec.rb +52 -0
  226. data/spec/models/{event_properties_spec.rb → channel_send_spec.rb} +7 -7
  227. data/spec/models/channel_setting_dto_spec.rb +64 -0
  228. data/spec/models/channel_template_details_dto_of_email_template_dto_spec.rb +70 -0
  229. data/spec/models/channel_template_details_dto_of_messaging_template_dto_spec.rb +70 -0
  230. data/spec/models/channel_template_details_dto_of_sms_template_dto_spec.rb +70 -0
  231. data/spec/models/channel_template_dto_spec.rb +64 -0
  232. data/spec/models/configured_integration_dto_spec.rb +7 -1
  233. data/spec/models/configured_integrations_dto_spec.rb +1 -1
  234. data/spec/models/confirm_mode_spec.rb +1 -1
  235. data/spec/models/create_channel_template_dto_spec.rb +40 -0
  236. data/spec/models/{create_email_template_dto_spec.rb → create_channel_template_language_dto_spec.rb} +7 -7
  237. data/spec/models/create_integration_dto_spec.rb +1 -1
  238. data/spec/models/create_system_user_dto_spec.rb +52 -0
  239. data/spec/{api/authorization_api_spec.rb → models/email_formatting_error_spec.rb} +16 -19
  240. data/spec/models/{notification_setting_dto_spec.rb → email_preview_dto_spec.rb} +9 -9
  241. data/spec/models/email_preview_request_dto_spec.rb +52 -0
  242. data/spec/models/{email_templates_dto_spec.rb → email_preview_type_spec.rb} +7 -7
  243. data/spec/models/email_template_dto_spec.rb +19 -1
  244. data/spec/models/{integration_properties_spec.rb → email_template_type_spec.rb} +7 -7
  245. data/spec/models/error_dto_spec.rb +7 -1
  246. data/spec/models/event_dto_spec.rb +19 -1
  247. data/spec/models/handled_info_dto_spec.rb +46 -0
  248. data/spec/models/integration_created_dto_spec.rb +1 -1
  249. data/spec/models/integration_definition_dto_spec.rb +1 -1
  250. data/spec/models/integration_property_dto_spec.rb +13 -1
  251. data/spec/models/integration_property_type_spec.rb +1 -1
  252. data/spec/models/integration_status_spec.rb +1 -1
  253. data/spec/models/iso_day_of_week_spec.rb +1 -1
  254. data/spec/models/list_response_dto_of_channel_template_dto_spec.rb +46 -0
  255. data/spec/models/list_response_dto_of_event_dto_spec.rb +1 -1
  256. data/spec/models/list_response_dto_of_log_entry_dto_spec.rb +1 -1
  257. data/spec/models/list_response_dto_of_media_dto_spec.rb +1 -1
  258. data/spec/models/list_response_dto_of_mobile_push_token_dto_spec.rb +1 -1
  259. data/spec/models/list_response_dto_of_subscription_dto_spec.rb +1 -1
  260. data/spec/models/{list_response_dto_of_notification_dto_spec.rb → list_response_dto_of_system_user_dto_spec.rb} +7 -7
  261. data/spec/models/list_response_dto_of_template_dto_spec.rb +1 -1
  262. data/spec/models/list_response_dto_of_topic_dto_spec.rb +1 -1
  263. data/spec/models/list_response_dto_of_user_dto_spec.rb +1 -1
  264. data/spec/models/list_response_dto_of_user_notification_details_dto_spec.rb +46 -0
  265. data/spec/{api/user_info_api_spec.rb → models/list_response_dto_of_user_notification_dto_spec.rb} +10 -16
  266. data/spec/models/localized_text_spec.rb +1 -1
  267. data/spec/models/log_entry_dto_spec.rb +1 -1
  268. data/spec/models/media_dto_spec.rb +14 -2
  269. data/spec/models/media_metadata_spec.rb +1 -1
  270. data/spec/models/media_type_spec.rb +1 -1
  271. data/spec/models/messaging_template_dto_spec.rb +40 -0
  272. data/spec/models/mobile_device_type_spec.rb +1 -1
  273. data/spec/models/mobile_push_token_dto2_spec.rb +46 -0
  274. data/spec/models/mobile_push_token_dto_spec.rb +7 -1
  275. data/spec/models/notification_formatting_dto_spec.rb +1 -1
  276. data/spec/models/notification_properties_spec.rb +34 -0
  277. data/spec/models/process_status_spec.rb +34 -0
  278. data/spec/models/profile_dto_spec.rb +7 -1
  279. data/spec/models/publish_dto_spec.rb +13 -1
  280. data/spec/models/publish_many_dto_spec.rb +1 -1
  281. data/spec/models/register_mobile_token_dto_spec.rb +1 -1
  282. data/spec/models/resize_mode_spec.rb +1 -1
  283. data/spec/models/scheduling_dto_spec.rb +1 -1
  284. data/spec/models/scheduling_type_spec.rb +1 -1
  285. data/spec/models/{body_spec.rb → sms_template_dto_spec.rb} +8 -8
  286. data/spec/models/subscribe_dto_spec.rb +46 -0
  287. data/spec/models/subscribe_many_dto_spec.rb +46 -0
  288. data/spec/models/subscription_dto_spec.rb +1 -1
  289. data/spec/models/system_user_dto_spec.rb +64 -0
  290. data/spec/models/template_dto_spec.rb +13 -1
  291. data/spec/models/topic_channel_spec.rb +34 -0
  292. data/spec/models/topic_dto_spec.rb +37 -1
  293. data/spec/models/topic_query_scope_spec.rb +34 -0
  294. data/spec/models/track_notification_dto_spec.rb +1 -1
  295. data/spec/models/update_channel_template_dto_of_email_template_dto_spec.rb +52 -0
  296. data/spec/models/update_channel_template_dto_of_messaging_template_dto_spec.rb +52 -0
  297. data/spec/models/update_channel_template_dto_of_sms_template_dto_spec.rb +52 -0
  298. data/spec/models/update_integration_dto_spec.rb +7 -1
  299. data/spec/models/update_profile_dto_spec.rb +1 -1
  300. data/spec/models/update_system_user_dto_spec.rb +52 -0
  301. data/spec/models/upsert_app_dto_spec.rb +1 -1
  302. data/spec/models/upsert_template_dto_spec.rb +1 -1
  303. data/spec/models/upsert_templates_dto_spec.rb +1 -1
  304. data/spec/models/upsert_topic_dto_spec.rb +64 -0
  305. data/spec/models/upsert_topics_dto_spec.rb +40 -0
  306. data/spec/models/upsert_user_dto_spec.rb +7 -1
  307. data/spec/models/upsert_users_dto_spec.rb +1 -1
  308. data/spec/models/user_dto_spec.rb +49 -1
  309. data/spec/models/{notification_dto_spec.rb → user_notification_base_dto_spec.rb} +23 -11
  310. data/spec/models/user_notification_channel_dto_spec.rb +64 -0
  311. data/spec/models/user_notification_details_dto_spec.rb +160 -0
  312. data/spec/models/user_notification_dto_spec.rb +148 -0
  313. data/spec/models/user_property_dto_spec.rb +52 -0
  314. data/spec/models/user_topic_dto_spec.rb +64 -0
  315. data/spec/spec_helper.rb +1 -1
  316. metadata +207 -64
  317. data/docs/AuthorizationApi.md +0 -121
  318. data/docs/NotificationSettingDto.md +0 -8
  319. data/docs/UserInfoApi.md +0 -83
  320. data/lib/notifo/api/authorization_api.rb +0 -158
  321. data/lib/notifo/api/user_info_api.rb +0 -112
  322. data/lib/notifo/models/integration_properties.rb +0 -201
  323. data/notifo-io-1.0.1.1.gem +0 -0
  324. data/spec/models/email_verification_status_spec.rb +0 -34
data/docs/UserApi.md CHANGED
@@ -4,16 +4,18 @@ All URIs are relative to *https://notifo.easierlife.com*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
- [**user_delete_subscription**](UserApi.md#user_delete_subscription) | **DELETE** /api/me/subscriptions/{topic} | Deletes a user subscription.
8
- [**user_get_subscription**](UserApi.md#user_get_subscription) | **GET** /api/me/subscriptions/{topic} | Gets a user subscription.
7
+ [**user_delete_subscription**](UserApi.md#user_delete_subscription) | **POST** /api/me/subscriptions/{prefix} | Remove my subscription.
8
+ [**user_get_my_subscription**](UserApi.md#user_get_my_subscription) | **GET** /api/me/subscriptions/{topic} | Gets a user subscription.
9
+ [**user_get_my_subscriptions**](UserApi.md#user_get_my_subscriptions) | **GET** /api/me/subscriptions | Query the user subscriptions.
10
+ [**user_get_topics**](UserApi.md#user_get_topics) | **GET** /api/me/topics | Query the user topics.
9
11
  [**user_get_user**](UserApi.md#user_get_user) | **GET** /api/me | Get the current user.
10
- [**user_post_subscription**](UserApi.md#user_post_subscription) | **POST** /api/me/subscriptions | Creates a user subscription.
12
+ [**user_post_my_subscriptions**](UserApi.md#user_post_my_subscriptions) | **POST** /api/me/subscriptions | Upserts or deletes my subscriptions.
11
13
  [**user_post_user**](UserApi.md#user_post_user) | **POST** /api/me | Update the user.
12
14
 
13
15
  # **user_delete_subscription**
14
- > user_delete_subscription(topic)
16
+ > user_delete_subscription(prefix)
15
17
 
16
- Deletes a user subscription.
18
+ Remove my subscription.
17
19
 
18
20
  User Id and App Id are resolved using the API token.
19
21
 
@@ -23,12 +25,12 @@ User Id and App Id are resolved using the API token.
23
25
  require 'notifo'
24
26
 
25
27
  api_instance = Notifo::UserApi.new
26
- topic = 'topic_example' # String | The topic path.
28
+ prefix = 'prefix_example' # String | The topic prefix.
27
29
 
28
30
 
29
31
  begin
30
- #Deletes a user subscription.
31
- api_instance.user_delete_subscription(topic)
32
+ #Remove my subscription.
33
+ api_instance.user_delete_subscription(prefix)
32
34
  rescue Notifo::ApiError => e
33
35
  puts "Exception when calling UserApi->user_delete_subscription: #{e}"
34
36
  end
@@ -38,7 +40,7 @@ end
38
40
 
39
41
  Name | Type | Description | Notes
40
42
  ------------- | ------------- | ------------- | -------------
41
- **topic** | **String**| The topic path. |
43
+ **prefix** | **String**| The topic prefix. |
42
44
 
43
45
  ### Return type
44
46
 
@@ -55,8 +57,8 @@ No authorization required
55
57
 
56
58
 
57
59
 
58
- # **user_get_subscription**
59
- > SubscriptionDto user_get_subscription(topic)
60
+ # **user_get_my_subscription**
61
+ > SubscriptionDto user_get_my_subscription(topic)
60
62
 
61
63
  Gets a user subscription.
62
64
 
@@ -73,10 +75,10 @@ topic = 'topic_example' # String | The topic path.
73
75
 
74
76
  begin
75
77
  #Gets a user subscription.
76
- result = api_instance.user_get_subscription(topic)
78
+ result = api_instance.user_get_my_subscription(topic)
77
79
  p result
78
80
  rescue Notifo::ApiError => e
79
- puts "Exception when calling UserApi->user_get_subscription: #{e}"
81
+ puts "Exception when calling UserApi->user_get_my_subscription: #{e}"
80
82
  end
81
83
  ```
82
84
 
@@ -101,6 +103,102 @@ No authorization required
101
103
 
102
104
 
103
105
 
106
+ # **user_get_my_subscriptions**
107
+ > ListResponseDtoOfSubscriptionDto user_get_my_subscriptions(opts)
108
+
109
+ Query the user subscriptions.
110
+
111
+ ### Example
112
+ ```ruby
113
+ # load the gem
114
+ require 'notifo'
115
+
116
+ api_instance = Notifo::UserApi.new
117
+ opts = {
118
+ topics: 'topics_example', # String | The topics we are interested in.
119
+ query: 'query_example', # String | The optional query to search for items.
120
+ take: 56, # Integer | The number of items to return.
121
+ skip: 56 # Integer | The number of items to skip.
122
+ }
123
+
124
+ begin
125
+ #Query the user subscriptions.
126
+ result = api_instance.user_get_my_subscriptions(opts)
127
+ p result
128
+ rescue Notifo::ApiError => e
129
+ puts "Exception when calling UserApi->user_get_my_subscriptions: #{e}"
130
+ end
131
+ ```
132
+
133
+ ### Parameters
134
+
135
+ Name | Type | Description | Notes
136
+ ------------- | ------------- | ------------- | -------------
137
+ **topics** | **String**| The topics we are interested in. | [optional]
138
+ **query** | **String**| The optional query to search for items. | [optional]
139
+ **take** | **Integer**| The number of items to return. | [optional]
140
+ **skip** | **Integer**| The number of items to skip. | [optional]
141
+
142
+ ### Return type
143
+
144
+ [**ListResponseDtoOfSubscriptionDto**](ListResponseDtoOfSubscriptionDto.md)
145
+
146
+ ### Authorization
147
+
148
+ No authorization required
149
+
150
+ ### HTTP request headers
151
+
152
+ - **Content-Type**: Not defined
153
+ - **Accept**: application/json
154
+
155
+
156
+
157
+ # **user_get_topics**
158
+ > Array<UserTopicDto> user_get_topics(opts)
159
+
160
+ Query the user topics.
161
+
162
+ ### Example
163
+ ```ruby
164
+ # load the gem
165
+ require 'notifo'
166
+
167
+ api_instance = Notifo::UserApi.new
168
+ opts = {
169
+ language: 'language_example' # String | The optional language.
170
+ }
171
+
172
+ begin
173
+ #Query the user topics.
174
+ result = api_instance.user_get_topics(opts)
175
+ p result
176
+ rescue Notifo::ApiError => e
177
+ puts "Exception when calling UserApi->user_get_topics: #{e}"
178
+ end
179
+ ```
180
+
181
+ ### Parameters
182
+
183
+ Name | Type | Description | Notes
184
+ ------------- | ------------- | ------------- | -------------
185
+ **language** | **String**| The optional language. | [optional]
186
+
187
+ ### Return type
188
+
189
+ [**Array<UserTopicDto>**](UserTopicDto.md)
190
+
191
+ ### Authorization
192
+
193
+ No authorization required
194
+
195
+ ### HTTP request headers
196
+
197
+ - **Content-Type**: Not defined
198
+ - **Accept**: application/json
199
+
200
+
201
+
104
202
  # **user_get_user**
105
203
  > ProfileDto user_get_user
106
204
 
@@ -140,10 +238,10 @@ No authorization required
140
238
 
141
239
 
142
240
 
143
- # **user_post_subscription**
144
- > user_post_subscription(body)
241
+ # **user_post_my_subscriptions**
242
+ > user_post_my_subscriptions(body)
145
243
 
146
- Creates a user subscription.
244
+ Upserts or deletes my subscriptions.
147
245
 
148
246
  User Id and App Id are resolved using the API token.
149
247
 
@@ -153,14 +251,14 @@ User Id and App Id are resolved using the API token.
153
251
  require 'notifo'
154
252
 
155
253
  api_instance = Notifo::UserApi.new
156
- body = Notifo::SubscriptionDto.new # SubscriptionDto | The subscription settings.
254
+ body = Notifo::SubscribeManyDto.new # SubscribeManyDto | The subscription settings.
157
255
 
158
256
 
159
257
  begin
160
- #Creates a user subscription.
161
- api_instance.user_post_subscription(body)
258
+ #Upserts or deletes my subscriptions.
259
+ api_instance.user_post_my_subscriptions(body)
162
260
  rescue Notifo::ApiError => e
163
- puts "Exception when calling UserApi->user_post_subscription: #{e}"
261
+ puts "Exception when calling UserApi->user_post_my_subscriptions: #{e}"
164
262
  end
165
263
  ```
166
264
 
@@ -168,7 +266,7 @@ end
168
266
 
169
267
  Name | Type | Description | Notes
170
268
  ------------- | ------------- | ------------- | -------------
171
- **body** | [**SubscriptionDto**](SubscriptionDto.md)| The subscription settings. |
269
+ **body** | [**SubscribeManyDto**](SubscribeManyDto.md)| The subscription settings. |
172
270
 
173
271
  ### Return type
174
272
 
data/docs/UserDto.md CHANGED
@@ -8,12 +8,17 @@ Name | Type | Description | Notes
8
8
  **full_name** | **String** | The full name of the user. | [optional]
9
9
  **email_address** | **String** | The email of the user. | [optional]
10
10
  **phone_number** | **String** | The phone number. | [optional]
11
- **threema_id** | **String** | The threema id. | [optional]
12
11
  **preferred_language** | **String** | The preferred language of the user. | [optional]
13
12
  **preferred_timezone** | **String** | The timezone of the user. | [optional]
13
+ **created** | **DateTime** | The date time (ISO 8601) when the user has been created. |
14
+ **last_update** | **DateTime** | The date time (ISO 8601) when the user has been updated. |
15
+ **last_notification** | **DateTime** | The date time (ISO 8601) when the user has been received the last notification. | [optional]
14
16
  **number_of_web_push_tokens** | **Integer** | The number of web hook tokens. |
15
17
  **number_of_mobile_push_tokens** | **Integer** | The number of web hook tokens. |
16
18
  **requires_whitelisted_topics** | **BOOLEAN** | True when only whitelisted topic are allowed. |
17
- **settings** | [**Hash<String, NotificationSettingDto>**](NotificationSettingDto.md) | Notification settings per channel. |
19
+ **properties** | **Hash<String, String>** | The user properties. | [optional]
20
+ **settings** | [**Hash<String, ChannelSettingDto>**](ChannelSettingDto.md) | Notification settings per channel. |
18
21
  **counters** | **Hash<String, Integer>** | The statistics counters. |
22
+ **mobile_push_tokens** | [**Array<MobilePushTokenDto>**](MobilePushTokenDto.md) | The mobile push tokens. |
23
+ **user_properties** | [**Array<UserPropertyDto>**](UserPropertyDto.md) | The supported user properties. | [optional]
19
24
 
@@ -0,0 +1,23 @@
1
+ # Notifo::UserNotificationBaseDto
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **String** | The id of the notification. |
7
+ **subject** | **String** | The subject of the notification in the language of the user. |
8
+ **silent** | **BOOLEAN** | True when the notification is silent. |
9
+ **created** | **DateTime** | The timestamp when the notification has been created. |
10
+ **updated** | **DateTime** | The timestamp when the notification has been updated. |
11
+ **tracking_token** | **String** | The tracking token. | [optional]
12
+ **body** | **String** | The optional body text. | [optional]
13
+ **image_small** | **String** | The optional link to the small image. | [optional]
14
+ **image_large** | **String** | The optional link to the large image. | [optional]
15
+ **track_seen_url** | **String** | The tracking url that needs to be invoked to mark the notification as seen. | [optional]
16
+ **track_delivered_url** | **String** | The tracking url that needs to be invoked to mark the notification as delivered. | [optional]
17
+ **link_url** | **String** | An optional link. | [optional]
18
+ **link_text** | **String** | The link text. | [optional]
19
+ **confirm_text** | **String** | The text for the confirm button. | [optional]
20
+ **confirm_url** | **String** | The tracking url that needs to be invoked to mark the notification as confirmed. | [optional]
21
+ **data** | **String** | Optional data, usually a json object. | [optional]
22
+ **properties** | [**NotificationProperties**](NotificationProperties.md) | | [optional]
23
+
@@ -0,0 +1,11 @@
1
+ # Notifo::UserNotificationChannelDto
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **setting** | [**ChannelSettingDto**](ChannelSettingDto.md) | |
7
+ **status** | [**Hash<String, ChannelSendInfoDto>**](ChannelSendInfoDto.md) | The status per token or configuration. |
8
+ **first_delivered** | **DateTime** | The first time the notification has been marked as delivered for this channel. | [optional]
9
+ **first_seen** | **DateTime** | The first time the notification has been marked as seen for this channel. | [optional]
10
+ **first_confirmed** | **DateTime** | The first time the notification has been marked as confirmed for this channel. | [optional]
11
+
@@ -0,0 +1,27 @@
1
+ # Notifo::UserNotificationDetailsDto
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **String** | The id of the notification. |
7
+ **subject** | **String** | The subject of the notification in the language of the user. |
8
+ **silent** | **BOOLEAN** | True when the notification is silent. |
9
+ **created** | **DateTime** | The timestamp when the notification has been created. |
10
+ **updated** | **DateTime** | The timestamp when the notification has been updated. |
11
+ **tracking_token** | **String** | The tracking token. | [optional]
12
+ **body** | **String** | The optional body text. | [optional]
13
+ **image_small** | **String** | The optional link to the small image. | [optional]
14
+ **image_large** | **String** | The optional link to the large image. | [optional]
15
+ **track_seen_url** | **String** | The tracking url that needs to be invoked to mark the notification as seen. | [optional]
16
+ **track_delivered_url** | **String** | The tracking url that needs to be invoked to mark the notification as delivered. | [optional]
17
+ **link_url** | **String** | An optional link. | [optional]
18
+ **link_text** | **String** | The link text. | [optional]
19
+ **confirm_text** | **String** | The text for the confirm button. | [optional]
20
+ **confirm_url** | **String** | The tracking url that needs to be invoked to mark the notification as confirmed. | [optional]
21
+ **data** | **String** | Optional data, usually a json object. | [optional]
22
+ **properties** | [**NotificationProperties**](NotificationProperties.md) | | [optional]
23
+ **channels** | [**Hash<String, UserNotificationChannelDto>**](UserNotificationChannelDto.md) | The channel details. |
24
+ **first_delivered** | [**HandledInfoDto**](HandledInfoDto.md) | | [optional]
25
+ **first_seen** | [**HandledInfoDto**](HandledInfoDto.md) | | [optional]
26
+ **first_confirmed** | [**HandledInfoDto**](HandledInfoDto.md) | | [optional]
27
+
@@ -1,4 +1,4 @@
1
- # Notifo::NotificationDto
1
+ # Notifo::UserNotificationDto
2
2
 
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
@@ -6,16 +6,20 @@ Name | Type | Description | Notes
6
6
  **id** | **String** | The id of the notification. |
7
7
  **subject** | **String** | The subject of the notification in the language of the user. |
8
8
  **silent** | **BOOLEAN** | True when the notification is silent. |
9
- **is_confirmed** | **BOOLEAN** | True when the notification has been confirmed. |
10
- **is_seen** | **BOOLEAN** | True when the notification has been seen. |
11
9
  **created** | **DateTime** | The timestamp when the notification has been created. |
10
+ **updated** | **DateTime** | The timestamp when the notification has been updated. |
11
+ **tracking_token** | **String** | The tracking token. | [optional]
12
12
  **body** | **String** | The optional body text. | [optional]
13
13
  **image_small** | **String** | The optional link to the small image. | [optional]
14
14
  **image_large** | **String** | The optional link to the large image. | [optional]
15
- **tracking_url** | **String** | The tracking url that needs to be invoked to mark the notifiation as seen. | [optional]
15
+ **track_seen_url** | **String** | The tracking url that needs to be invoked to mark the notification as seen. | [optional]
16
+ **track_delivered_url** | **String** | The tracking url that needs to be invoked to mark the notification as delivered. | [optional]
16
17
  **link_url** | **String** | An optional link. | [optional]
17
18
  **link_text** | **String** | The link text. | [optional]
18
19
  **confirm_text** | **String** | The text for the confirm button. | [optional]
19
- **confirm_url** | **String** | The tracking url that needs to be invoked to mark the notifiation as confirmed. | [optional]
20
+ **confirm_url** | **String** | The tracking url that needs to be invoked to mark the notification as confirmed. | [optional]
20
21
  **data** | **String** | Optional data, usually a json object. | [optional]
22
+ **properties** | [**NotificationProperties**](NotificationProperties.md) | | [optional]
23
+ **is_seen** | **BOOLEAN** | True when the notification has been seen at least once. |
24
+ **is_confirmed** | **BOOLEAN** | True when the notification has been confirmed at least once. |
21
25
 
@@ -0,0 +1,9 @@
1
+ # Notifo::UserPropertyDto
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **name** | **String** | The field name for the property. |
7
+ **editor_description** | **String** | The optional description. | [optional]
8
+ **editor_label** | **String** | The optional label. | [optional]
9
+
@@ -0,0 +1,11 @@
1
+ # Notifo::UserTopicDto
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **path** | **String** | The path. |
7
+ **name** | **String** | The name. |
8
+ **description** | **String** | The optional description. | [optional]
9
+ **show_automatically** | **BOOLEAN** | True to show the topic automatically to new users, e.g. when he accepts push notifications. | [optional]
10
+ **channels** | [**Hash<String, TopicChannel>**](TopicChannel.md) | The channel options. |
11
+
data/docs/UsersApi.md CHANGED
@@ -5,13 +5,13 @@ All URIs are relative to *https://notifo.easierlife.com*
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
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.
8
+ [**users_delete_subscription**](UsersApi.md#users_delete_subscription) | **DELETE** /api/apps/{appId}/users/{id}/subscriptions/{prefix} | Unsubscribes a user from a subscription.
9
9
  [**users_delete_user**](UsersApi.md#users_delete_user) | **DELETE** /api/apps/{appId}/users/{id} | Delete a user.
10
10
  [**users_get_subscriptions**](UsersApi.md#users_get_subscriptions) | **GET** /api/apps/{appId}/users/{id}/subscriptions | Query user subscriptions.
11
11
  [**users_get_user**](UsersApi.md#users_get_user) | **GET** /api/apps/{appId}/users/{id} | Get a user.
12
12
  [**users_get_users**](UsersApi.md#users_get_users) | **GET** /api/apps/{appId}/users | Query users.
13
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.
14
+ [**users_post_subscriptions**](UsersApi.md#users_post_subscriptions) | **POST** /api/apps/{appId}/users/{id}/subscriptions | Upserts or deletes multiple user subscriptions.
15
15
  [**users_post_users**](UsersApi.md#users_post_users) | **POST** /api/apps/{appId}/users | Upsert users.
16
16
 
17
17
  # **users_delete_allowed_topic**
@@ -26,7 +26,7 @@ require 'notifo'
26
26
 
27
27
  api_instance = Notifo::UsersApi.new
28
28
  app_id = 'app_id_example' # String | The app where the users belong to.
29
- id = 'id_example' # String | The user id.
29
+ id = 'id_example' # String | The user ID.
30
30
  prefix = 'prefix_example' # String | The topic prefix.
31
31
 
32
32
 
@@ -43,7 +43,7 @@ end
43
43
  Name | Type | Description | Notes
44
44
  ------------- | ------------- | ------------- | -------------
45
45
  **app_id** | **String**| The app where the users belong to. |
46
- **id** | **String**| The user id. |
46
+ **id** | **String**| The user ID. |
47
47
  **prefix** | **String**| The topic prefix. |
48
48
 
49
49
  ### Return type
@@ -64,7 +64,7 @@ No authorization required
64
64
  # **users_delete_subscription**
65
65
  > users_delete_subscription(app_id, id, prefix)
66
66
 
67
- Remove a user subscriptions.
67
+ Unsubscribes a user from a subscription.
68
68
 
69
69
  ### Example
70
70
  ```ruby
@@ -73,12 +73,12 @@ require 'notifo'
73
73
 
74
74
  api_instance = Notifo::UsersApi.new
75
75
  app_id = 'app_id_example' # String | The app where the user belongs to.
76
- id = 'id_example' # String | The user id.
76
+ id = 'id_example' # String | The user ID.
77
77
  prefix = 'prefix_example' # String | The topic prefix.
78
78
 
79
79
 
80
80
  begin
81
- #Remove a user subscriptions.
81
+ #Unsubscribes a user from a subscription.
82
82
  api_instance.users_delete_subscription(app_id, id, prefix)
83
83
  rescue Notifo::ApiError => e
84
84
  puts "Exception when calling UsersApi->users_delete_subscription: #{e}"
@@ -90,7 +90,7 @@ end
90
90
  Name | Type | Description | Notes
91
91
  ------------- | ------------- | ------------- | -------------
92
92
  **app_id** | **String**| The app where the user belongs to. |
93
- **id** | **String**| The user id. |
93
+ **id** | **String**| The user ID. |
94
94
  **prefix** | **String**| The topic prefix. |
95
95
 
96
96
  ### Return type
@@ -109,7 +109,7 @@ No authorization required
109
109
 
110
110
 
111
111
  # **users_delete_user**
112
- > ListResponseDtoOfUserDto users_delete_user(app_id, id)
112
+ > String users_delete_user(app_id, id)
113
113
 
114
114
  Delete a user.
115
115
 
@@ -141,7 +141,7 @@ Name | Type | Description | Notes
141
141
 
142
142
  ### Return type
143
143
 
144
- [**ListResponseDtoOfUserDto**](ListResponseDtoOfUserDto.md)
144
+ **String**
145
145
 
146
146
  ### Authorization
147
147
 
@@ -150,7 +150,7 @@ No authorization required
150
150
  ### HTTP request headers
151
151
 
152
152
  - **Content-Type**: Not defined
153
- - **Accept**: application/json
153
+ - **Accept**: application/octet-stream, application/json
154
154
 
155
155
 
156
156
 
@@ -166,7 +166,7 @@ require 'notifo'
166
166
 
167
167
  api_instance = Notifo::UsersApi.new
168
168
  app_id = 'app_id_example' # String | The app where the user belongs to.
169
- id = 'id_example' # String | The user id.
169
+ id = 'id_example' # String | The user ID.
170
170
  opts = {
171
171
  query: 'query_example', # String | The optional query to search for items.
172
172
  take: 56, # Integer | The number of items to return.
@@ -187,7 +187,7 @@ end
187
187
  Name | Type | Description | Notes
188
188
  ------------- | ------------- | ------------- | -------------
189
189
  **app_id** | **String**| The app where the user belongs to. |
190
- **id** | **String**| The user id. |
190
+ **id** | **String**| The user ID. |
191
191
  **query** | **String**| The optional query to search for items. | [optional]
192
192
  **take** | **Integer**| The number of items to return. | [optional]
193
193
  **skip** | **Integer**| The number of items to skip. | [optional]
@@ -208,7 +208,7 @@ No authorization required
208
208
 
209
209
 
210
210
  # **users_get_user**
211
- > ListResponseDtoOfUserDto users_get_user(app_id, id)
211
+ > UserDto users_get_user(app_id, id, opts)
212
212
 
213
213
  Get a user.
214
214
 
@@ -219,12 +219,14 @@ require 'notifo'
219
219
 
220
220
  api_instance = Notifo::UsersApi.new
221
221
  app_id = 'app_id_example' # String | The app where the user belongs to.
222
- id = 'id_example' # String | The user id.
223
-
222
+ id = 'id_example' # String | The user ID.
223
+ opts = {
224
+ with_details: false # BOOLEAN | Provide extra details, might be expensive.
225
+ }
224
226
 
225
227
  begin
226
228
  #Get a user.
227
- result = api_instance.users_get_user(app_id, id)
229
+ result = api_instance.users_get_user(app_id, id, opts)
228
230
  p result
229
231
  rescue Notifo::ApiError => e
230
232
  puts "Exception when calling UsersApi->users_get_user: #{e}"
@@ -236,11 +238,12 @@ end
236
238
  Name | Type | Description | Notes
237
239
  ------------- | ------------- | ------------- | -------------
238
240
  **app_id** | **String**| The app where the user belongs to. |
239
- **id** | **String**| The user id. |
241
+ **id** | **String**| The user ID. |
242
+ **with_details** | **BOOLEAN**| Provide extra details, might be expensive. | [optional] [default to false]
240
243
 
241
244
  ### Return type
242
245
 
243
- [**ListResponseDtoOfUserDto**](ListResponseDtoOfUserDto.md)
246
+ [**UserDto**](UserDto.md)
244
247
 
245
248
  ### Authorization
246
249
 
@@ -268,7 +271,8 @@ app_id = 'app_id_example' # String | The app where the users belongs to.
268
271
  opts = {
269
272
  query: 'query_example', # String | The optional query to search for items.
270
273
  take: 56, # Integer | The number of items to return.
271
- 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.
272
276
  }
273
277
 
274
278
  begin
@@ -288,6 +292,7 @@ Name | Type | Description | Notes
288
292
  **query** | **String**| The optional query to search for items. | [optional]
289
293
  **take** | **Integer**| The number of items to return. | [optional]
290
294
  **skip** | **Integer**| The number of items to skip. | [optional]
295
+ **with_details** | **BOOLEAN**| Provide extra details, might be expensive. | [optional] [default to false]
291
296
 
292
297
  ### Return type
293
298
 
@@ -317,7 +322,7 @@ require 'notifo'
317
322
  api_instance = Notifo::UsersApi.new
318
323
  body = Notifo::AddAllowedTopicDto.new # AddAllowedTopicDto | The upsert request.
319
324
  app_id = 'app_id_example' # String | The app where the users belong to.
320
- id = 'id_example' # String | The user id.
325
+ id = 'id_example' # String | The user ID.
321
326
 
322
327
 
323
328
  begin
@@ -334,7 +339,7 @@ Name | Type | Description | Notes
334
339
  ------------- | ------------- | ------------- | -------------
335
340
  **body** | [**AddAllowedTopicDto**](AddAllowedTopicDto.md)| The upsert request. |
336
341
  **app_id** | **String**| The app where the users belong to. |
337
- **id** | **String**| The user id. |
342
+ **id** | **String**| The user ID. |
338
343
 
339
344
  ### Return type
340
345
 
@@ -351,10 +356,10 @@ No authorization required
351
356
 
352
357
 
353
358
 
354
- # **users_post_subscription**
355
- > users_post_subscription(bodyapp_idid)
359
+ # **users_post_subscriptions**
360
+ > users_post_subscriptions(bodyapp_idid)
356
361
 
357
- Upsert a user subscriptions.
362
+ Upserts or deletes multiple user subscriptions.
358
363
 
359
364
  ### Example
360
365
  ```ruby
@@ -362,16 +367,16 @@ Upsert a user subscriptions.
362
367
  require 'notifo'
363
368
 
364
369
  api_instance = Notifo::UsersApi.new
365
- body = Notifo::SubscriptionDto.new # SubscriptionDto | The subscription object.
370
+ body = Notifo::SubscribeManyDto.new # SubscribeManyDto | The subscription object.
366
371
  app_id = 'app_id_example' # String | The app where the user belongs to.
367
- id = 'id_example' # String | The user id.
372
+ id = 'id_example' # String | The user ID.
368
373
 
369
374
 
370
375
  begin
371
- #Upsert a user subscriptions.
372
- api_instance.users_post_subscription(bodyapp_idid)
376
+ #Upserts or deletes multiple user subscriptions.
377
+ api_instance.users_post_subscriptions(bodyapp_idid)
373
378
  rescue Notifo::ApiError => e
374
- puts "Exception when calling UsersApi->users_post_subscription: #{e}"
379
+ puts "Exception when calling UsersApi->users_post_subscriptions: #{e}"
375
380
  end
376
381
  ```
377
382
 
@@ -379,9 +384,9 @@ end
379
384
 
380
385
  Name | Type | Description | Notes
381
386
  ------------- | ------------- | ------------- | -------------
382
- **body** | [**SubscriptionDto**](SubscriptionDto.md)| The subscription object. |
387
+ **body** | [**SubscribeManyDto**](SubscribeManyDto.md)| The subscription object. |
383
388
  **app_id** | **String**| The app where the user belongs to. |
384
- **id** | **String**| The user id. |
389
+ **id** | **String**| The user ID. |
385
390
 
386
391
  ### Return type
387
392