notifo-io 1.1.0 → 1.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (283) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +245 -60
  3. data/docs/AddContributorDto.md +1 -1
  4. data/docs/AdminProfileDto.md +7 -0
  5. data/docs/AppsApi.md +1 -1
  6. data/docs/ChannelSendInfoDto.md +4 -0
  7. data/docs/ConfigsApi.md +1 -1
  8. data/docs/DiagnosticsApi.md +85 -0
  9. data/docs/EmailTemplatesApi.md +26 -26
  10. data/docs/EventDto.md +0 -2
  11. data/docs/EventsApi.md +1 -1
  12. data/docs/InfoDto.md +7 -0
  13. data/docs/IntegrationPropertyDto.md +1 -1
  14. data/docs/LogsApi.md +1 -1
  15. data/docs/MediaApi.md +154 -4
  16. data/docs/MessagingTemplatesApi.md +26 -26
  17. data/docs/MobilePushApi.md +1 -1
  18. data/docs/MobilePushTokenDto.md +1 -0
  19. data/docs/MobilePushTokenDto2.md +1 -0
  20. data/docs/NotificationsApi.md +131 -7
  21. data/docs/PingApi.md +85 -2
  22. data/docs/{IntegrationPropertyType.md → PropertyType.md} +1 -1
  23. data/docs/PublishDto.md +2 -0
  24. data/docs/RegisterMobileTokenDto.md +1 -0
  25. data/docs/SendConfiguration.md +6 -0
  26. data/docs/SmsTemplatesApi.md +26 -26
  27. data/docs/SystemUsersApi.md +5 -4
  28. data/docs/TemplatesApi.md +1 -1
  29. data/docs/TopicsApi.md +6 -6
  30. data/docs/TrackNotificationDto.md +1 -0
  31. data/docs/UserApi.md +41 -1
  32. data/docs/UserDto.md +1 -2
  33. data/docs/UserNotificationBaseDto.md +1 -0
  34. data/docs/UserNotificationDetailsDto.md +1 -0
  35. data/docs/UserNotificationDto.md +1 -0
  36. data/docs/UsersApi.md +101 -6
  37. data/docs/WebPushSubscriptionDto.md +7 -0
  38. data/lib/notifo/api/apps_api.rb +1 -1
  39. data/lib/notifo/api/configs_api.rb +1 -1
  40. data/lib/notifo/api/diagnostics_api.rb +116 -0
  41. data/lib/notifo/api/email_templates_api.rb +46 -46
  42. data/lib/notifo/api/events_api.rb +1 -1
  43. data/lib/notifo/api/logs_api.rb +1 -1
  44. data/lib/notifo/api/media_api.rb +197 -2
  45. data/lib/notifo/api/messaging_templates_api.rb +46 -46
  46. data/lib/notifo/api/mobile_push_api.rb +1 -1
  47. data/lib/notifo/api/notifications_api.rb +150 -3
  48. data/lib/notifo/api/ping_api.rb +102 -2
  49. data/lib/notifo/api/sms_templates_api.rb +46 -46
  50. data/lib/notifo/api/system_users_api.rb +6 -6
  51. data/lib/notifo/api/templates_api.rb +1 -1
  52. data/lib/notifo/api/topics_api.rb +10 -10
  53. data/lib/notifo/api/user_api.rb +49 -1
  54. data/lib/notifo/api/users_api.rb +139 -7
  55. data/lib/notifo/api_client.rb +1 -1
  56. data/lib/notifo/api_error.rb +1 -1
  57. data/lib/notifo/configuration.rb +3 -3
  58. data/lib/notifo/models/add_allowed_topic_dto.rb +1 -1
  59. data/lib/notifo/models/add_contributor_dto.rb +2 -6
  60. data/lib/notifo/models/admin_profile_dto.rb +208 -0
  61. data/lib/notifo/models/app_contributor_dto.rb +1 -1
  62. data/lib/notifo/models/app_details_dto.rb +1 -1
  63. data/lib/notifo/models/app_dto.rb +1 -1
  64. data/lib/notifo/models/app_id_media_body.rb +1 -1
  65. data/lib/notifo/models/channel_condition.rb +1 -1
  66. data/lib/notifo/models/channel_send.rb +1 -1
  67. data/lib/notifo/models/channel_send_info_dto.rb +48 -6
  68. data/lib/notifo/models/channel_setting_dto.rb +1 -1
  69. data/lib/notifo/models/channel_template_details_dto_of_email_template_dto.rb +1 -1
  70. data/lib/notifo/models/channel_template_details_dto_of_messaging_template_dto.rb +1 -1
  71. data/lib/notifo/models/channel_template_details_dto_of_sms_template_dto.rb +1 -1
  72. data/lib/notifo/models/channel_template_dto.rb +1 -1
  73. data/lib/notifo/models/configured_integration_dto.rb +1 -1
  74. data/lib/notifo/models/configured_integrations_dto.rb +1 -1
  75. data/lib/notifo/models/confirm_mode.rb +1 -1
  76. data/lib/notifo/models/create_channel_template_dto.rb +1 -1
  77. data/lib/notifo/models/create_channel_template_language_dto.rb +1 -1
  78. data/lib/notifo/models/create_integration_dto.rb +1 -1
  79. data/lib/notifo/models/create_system_user_dto.rb +1 -1
  80. data/lib/notifo/models/email_formatting_error.rb +1 -1
  81. data/lib/notifo/models/email_preview_dto.rb +1 -1
  82. data/lib/notifo/models/email_preview_request_dto.rb +1 -1
  83. data/lib/notifo/models/email_preview_type.rb +1 -1
  84. data/lib/notifo/models/email_template_dto.rb +1 -1
  85. data/lib/notifo/models/email_template_type.rb +1 -1
  86. data/lib/notifo/models/error_dto.rb +1 -1
  87. data/lib/notifo/models/event_dto.rb +2 -24
  88. data/lib/notifo/models/handled_info_dto.rb +1 -1
  89. data/lib/notifo/models/info_dto.rb +212 -0
  90. data/lib/notifo/models/integration_created_dto.rb +1 -1
  91. data/lib/notifo/models/integration_definition_dto.rb +1 -1
  92. data/lib/notifo/models/integration_property_dto.rb +1 -1
  93. data/lib/notifo/models/integration_status.rb +1 -1
  94. data/lib/notifo/models/iso_day_of_week.rb +1 -1
  95. data/lib/notifo/models/list_response_dto_of_channel_template_dto.rb +1 -1
  96. data/lib/notifo/models/list_response_dto_of_event_dto.rb +1 -1
  97. data/lib/notifo/models/list_response_dto_of_log_entry_dto.rb +1 -1
  98. data/lib/notifo/models/list_response_dto_of_media_dto.rb +1 -1
  99. data/lib/notifo/models/list_response_dto_of_mobile_push_token_dto.rb +1 -1
  100. data/lib/notifo/models/list_response_dto_of_subscription_dto.rb +1 -1
  101. data/lib/notifo/models/list_response_dto_of_system_user_dto.rb +1 -1
  102. data/lib/notifo/models/list_response_dto_of_template_dto.rb +1 -1
  103. data/lib/notifo/models/list_response_dto_of_topic_dto.rb +1 -1
  104. data/lib/notifo/models/list_response_dto_of_user_dto.rb +1 -1
  105. data/lib/notifo/models/list_response_dto_of_user_notification_details_dto.rb +1 -1
  106. data/lib/notifo/models/list_response_dto_of_user_notification_dto.rb +1 -1
  107. data/lib/notifo/models/localized_text.rb +1 -1
  108. data/lib/notifo/models/log_entry_dto.rb +1 -1
  109. data/lib/notifo/models/media_dto.rb +1 -1
  110. data/lib/notifo/models/media_metadata.rb +1 -1
  111. data/lib/notifo/models/media_type.rb +1 -1
  112. data/lib/notifo/models/messaging_template_dto.rb +1 -1
  113. data/lib/notifo/models/mobile_device_type.rb +1 -1
  114. data/lib/notifo/models/mobile_push_token_dto.rb +13 -2
  115. data/lib/notifo/models/mobile_push_token_dto2.rb +16 -5
  116. data/lib/notifo/models/notification_formatting_dto.rb +1 -1
  117. data/lib/notifo/models/notification_properties.rb +1 -1
  118. data/lib/notifo/models/process_status.rb +1 -1
  119. data/lib/notifo/models/profile_dto.rb +1 -1
  120. data/lib/notifo/models/{integration_property_type.rb → property_type.rb} +4 -4
  121. data/lib/notifo/models/publish_dto.rb +26 -2
  122. data/lib/notifo/models/publish_many_dto.rb +1 -1
  123. data/lib/notifo/models/register_mobile_token_dto.rb +16 -5
  124. data/lib/notifo/models/resize_mode.rb +1 -1
  125. data/lib/notifo/models/scheduling_dto.rb +1 -1
  126. data/lib/notifo/models/scheduling_type.rb +1 -1
  127. data/lib/notifo/models/send_configuration.rb +201 -0
  128. data/lib/notifo/models/sms_template_dto.rb +1 -1
  129. data/lib/notifo/models/subscribe_dto.rb +1 -1
  130. data/lib/notifo/models/subscribe_many_dto.rb +1 -1
  131. data/lib/notifo/models/subscription_dto.rb +1 -1
  132. data/lib/notifo/models/system_user_dto.rb +1 -1
  133. data/lib/notifo/models/template_dto.rb +1 -1
  134. data/lib/notifo/models/topic_channel.rb +2 -2
  135. data/lib/notifo/models/topic_dto.rb +1 -1
  136. data/lib/notifo/models/topic_query_scope.rb +1 -1
  137. data/lib/notifo/models/track_notification_dto.rb +12 -2
  138. data/lib/notifo/models/update_channel_template_dto_of_email_template_dto.rb +1 -1
  139. data/lib/notifo/models/update_channel_template_dto_of_messaging_template_dto.rb +1 -1
  140. data/lib/notifo/models/update_channel_template_dto_of_sms_template_dto.rb +1 -1
  141. data/lib/notifo/models/update_integration_dto.rb +1 -1
  142. data/lib/notifo/models/update_profile_dto.rb +1 -1
  143. data/lib/notifo/models/update_system_user_dto.rb +1 -1
  144. data/lib/notifo/models/upsert_app_dto.rb +1 -1
  145. data/lib/notifo/models/upsert_template_dto.rb +1 -1
  146. data/lib/notifo/models/upsert_templates_dto.rb +1 -1
  147. data/lib/notifo/models/upsert_topic_dto.rb +1 -1
  148. data/lib/notifo/models/upsert_topics_dto.rb +1 -1
  149. data/lib/notifo/models/upsert_user_dto.rb +1 -1
  150. data/lib/notifo/models/upsert_users_dto.rb +1 -1
  151. data/lib/notifo/models/user_dto.rb +19 -32
  152. data/lib/notifo/models/user_notification_base_dto.rb +13 -2
  153. data/lib/notifo/models/user_notification_channel_dto.rb +1 -1
  154. data/lib/notifo/models/user_notification_details_dto.rb +13 -2
  155. data/lib/notifo/models/user_notification_dto.rb +13 -2
  156. data/lib/notifo/models/user_property_dto.rb +1 -1
  157. data/lib/notifo/models/user_topic_dto.rb +1 -1
  158. data/lib/notifo/models/web_push_subscription_dto.rb +212 -0
  159. data/lib/notifo/version.rb +1 -1
  160. data/lib/notifo.rb +7 -2
  161. data/notifo.gemspec +2 -3
  162. data/spec/api/apps_api_spec.rb +1 -1
  163. data/spec/api/configs_api_spec.rb +1 -1
  164. data/spec/api/diagnostics_api_spec.rb +54 -0
  165. data/spec/api/email_templates_api_spec.rb +6 -6
  166. data/spec/api/events_api_spec.rb +1 -1
  167. data/spec/api/logs_api_spec.rb +1 -1
  168. data/spec/api/media_api_spec.rb +52 -1
  169. data/spec/api/messaging_templates_api_spec.rb +6 -6
  170. data/spec/api/mobile_push_api_spec.rb +1 -1
  171. data/spec/api/notifications_api_spec.rb +38 -2
  172. data/spec/api/ping_api_spec.rb +23 -1
  173. data/spec/api/sms_templates_api_spec.rb +6 -6
  174. data/spec/api/system_users_api_spec.rb +2 -2
  175. data/spec/api/templates_api_spec.rb +1 -1
  176. data/spec/api/topics_api_spec.rb +2 -2
  177. data/spec/api/user_api_spec.rb +11 -1
  178. data/spec/api/users_api_spec.rb +28 -2
  179. data/spec/api_client_spec.rb +1 -1
  180. data/spec/configuration_spec.rb +4 -4
  181. data/spec/models/add_allowed_topic_dto_spec.rb +1 -1
  182. data/spec/models/add_contributor_dto_spec.rb +1 -1
  183. data/spec/models/admin_profile_dto_spec.rb +40 -0
  184. data/spec/models/app_contributor_dto_spec.rb +1 -1
  185. data/spec/models/app_details_dto_spec.rb +1 -1
  186. data/spec/models/app_dto_spec.rb +1 -1
  187. data/spec/models/app_id_media_body_spec.rb +1 -1
  188. data/spec/models/channel_condition_spec.rb +1 -1
  189. data/spec/models/channel_send_info_dto_spec.rb +25 -1
  190. data/spec/models/channel_send_spec.rb +1 -1
  191. data/spec/models/channel_setting_dto_spec.rb +1 -1
  192. data/spec/models/channel_template_details_dto_of_email_template_dto_spec.rb +1 -1
  193. data/spec/models/channel_template_details_dto_of_messaging_template_dto_spec.rb +1 -1
  194. data/spec/models/channel_template_details_dto_of_sms_template_dto_spec.rb +1 -1
  195. data/spec/models/channel_template_dto_spec.rb +1 -1
  196. data/spec/models/configured_integration_dto_spec.rb +1 -1
  197. data/spec/models/configured_integrations_dto_spec.rb +1 -1
  198. data/spec/models/confirm_mode_spec.rb +1 -1
  199. data/spec/models/create_channel_template_dto_spec.rb +1 -1
  200. data/spec/models/create_channel_template_language_dto_spec.rb +1 -1
  201. data/spec/models/create_integration_dto_spec.rb +1 -1
  202. data/spec/models/create_system_user_dto_spec.rb +1 -1
  203. data/spec/models/email_formatting_error_spec.rb +1 -1
  204. data/spec/models/email_preview_dto_spec.rb +1 -1
  205. data/spec/models/email_preview_request_dto_spec.rb +1 -1
  206. data/spec/models/email_preview_type_spec.rb +1 -1
  207. data/spec/models/email_template_dto_spec.rb +1 -1
  208. data/spec/models/email_template_type_spec.rb +1 -1
  209. data/spec/models/error_dto_spec.rb +1 -1
  210. data/spec/models/event_dto_spec.rb +1 -13
  211. data/spec/models/handled_info_dto_spec.rb +1 -1
  212. data/spec/models/info_dto_spec.rb +40 -0
  213. data/spec/models/integration_created_dto_spec.rb +1 -1
  214. data/spec/models/integration_definition_dto_spec.rb +1 -1
  215. data/spec/models/integration_property_dto_spec.rb +1 -1
  216. data/spec/models/integration_status_spec.rb +1 -1
  217. data/spec/models/iso_day_of_week_spec.rb +1 -1
  218. data/spec/models/list_response_dto_of_channel_template_dto_spec.rb +1 -1
  219. data/spec/models/list_response_dto_of_event_dto_spec.rb +1 -1
  220. data/spec/models/list_response_dto_of_log_entry_dto_spec.rb +1 -1
  221. data/spec/models/list_response_dto_of_media_dto_spec.rb +1 -1
  222. data/spec/models/list_response_dto_of_mobile_push_token_dto_spec.rb +1 -1
  223. data/spec/models/list_response_dto_of_subscription_dto_spec.rb +1 -1
  224. data/spec/models/list_response_dto_of_system_user_dto_spec.rb +1 -1
  225. data/spec/models/list_response_dto_of_template_dto_spec.rb +1 -1
  226. data/spec/models/list_response_dto_of_topic_dto_spec.rb +1 -1
  227. data/spec/models/list_response_dto_of_user_dto_spec.rb +1 -1
  228. data/spec/models/list_response_dto_of_user_notification_details_dto_spec.rb +1 -1
  229. data/spec/models/list_response_dto_of_user_notification_dto_spec.rb +1 -1
  230. data/spec/models/localized_text_spec.rb +1 -1
  231. data/spec/models/log_entry_dto_spec.rb +1 -1
  232. data/spec/models/media_dto_spec.rb +1 -1
  233. data/spec/models/media_metadata_spec.rb +1 -1
  234. data/spec/models/media_type_spec.rb +1 -1
  235. data/spec/models/messaging_template_dto_spec.rb +1 -1
  236. data/spec/models/mobile_device_type_spec.rb +1 -1
  237. data/spec/models/mobile_push_token_dto2_spec.rb +7 -1
  238. data/spec/models/mobile_push_token_dto_spec.rb +7 -1
  239. data/spec/models/notification_formatting_dto_spec.rb +1 -1
  240. data/spec/models/notification_properties_spec.rb +1 -1
  241. data/spec/models/process_status_spec.rb +1 -1
  242. data/spec/models/profile_dto_spec.rb +1 -1
  243. data/spec/models/{integration_property_type_spec.rb → property_type_spec.rb} +7 -7
  244. data/spec/models/publish_dto_spec.rb +13 -1
  245. data/spec/models/publish_many_dto_spec.rb +1 -1
  246. data/spec/models/register_mobile_token_dto_spec.rb +7 -1
  247. data/spec/models/resize_mode_spec.rb +1 -1
  248. data/spec/models/scheduling_dto_spec.rb +1 -1
  249. data/spec/models/scheduling_type_spec.rb +1 -1
  250. data/spec/models/send_configuration_spec.rb +34 -0
  251. data/spec/models/sms_template_dto_spec.rb +1 -1
  252. data/spec/models/subscribe_dto_spec.rb +1 -1
  253. data/spec/models/subscribe_many_dto_spec.rb +1 -1
  254. data/spec/models/subscription_dto_spec.rb +1 -1
  255. data/spec/models/system_user_dto_spec.rb +1 -1
  256. data/spec/models/template_dto_spec.rb +1 -1
  257. data/spec/models/topic_channel_spec.rb +1 -1
  258. data/spec/models/topic_dto_spec.rb +1 -1
  259. data/spec/models/topic_query_scope_spec.rb +1 -1
  260. data/spec/models/track_notification_dto_spec.rb +7 -1
  261. data/spec/models/update_channel_template_dto_of_email_template_dto_spec.rb +1 -1
  262. data/spec/models/update_channel_template_dto_of_messaging_template_dto_spec.rb +1 -1
  263. data/spec/models/update_channel_template_dto_of_sms_template_dto_spec.rb +1 -1
  264. data/spec/models/update_integration_dto_spec.rb +1 -1
  265. data/spec/models/update_profile_dto_spec.rb +1 -1
  266. data/spec/models/update_system_user_dto_spec.rb +1 -1
  267. data/spec/models/upsert_app_dto_spec.rb +1 -1
  268. data/spec/models/upsert_template_dto_spec.rb +1 -1
  269. data/spec/models/upsert_templates_dto_spec.rb +1 -1
  270. data/spec/models/upsert_topic_dto_spec.rb +1 -1
  271. data/spec/models/upsert_topics_dto_spec.rb +1 -1
  272. data/spec/models/upsert_user_dto_spec.rb +1 -1
  273. data/spec/models/upsert_users_dto_spec.rb +1 -1
  274. data/spec/models/user_dto_spec.rb +7 -13
  275. data/spec/models/user_notification_base_dto_spec.rb +7 -1
  276. data/spec/models/user_notification_channel_dto_spec.rb +1 -1
  277. data/spec/models/user_notification_details_dto_spec.rb +7 -1
  278. data/spec/models/user_notification_dto_spec.rb +7 -1
  279. data/spec/models/user_property_dto_spec.rb +1 -1
  280. data/spec/models/user_topic_dto_spec.rb +1 -1
  281. data/spec/models/web_push_subscription_dto_spec.rb +40 -0
  282. data/spec/spec_helper.rb +1 -1
  283. metadata +27 -7
@@ -1,20 +1,20 @@
1
1
  # Notifo::MessagingTemplatesApi
2
2
 
3
- All URIs are relative to *https://notifo.easierlife.com*
3
+ All URIs are relative to *https://notifo-dev.easierlife.com*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
- [**messaging_templates_delete_template**](MessagingTemplatesApi.md#messaging_templates_delete_template) | **DELETE** /api/apps/{appId}/messaging-templates/{id} | Delete a channel template.
8
- [**messaging_templates_delete_template_language**](MessagingTemplatesApi.md#messaging_templates_delete_template_language) | **DELETE** /api/apps/{appId}/messaging-templates/{id}/{language} | Delete a language channel template.
7
+ [**messaging_templates_delete_template**](MessagingTemplatesApi.md#messaging_templates_delete_template) | **DELETE** /api/apps/{appId}/messaging-templates/{code} | Delete a channel template.
8
+ [**messaging_templates_delete_template_language**](MessagingTemplatesApi.md#messaging_templates_delete_template_language) | **DELETE** /api/apps/{appId}/messaging-templates/{code}/{language} | Delete a language channel template.
9
9
  [**messaging_templates_get_template**](MessagingTemplatesApi.md#messaging_templates_get_template) | **GET** /api/apps/{appId}/messaging-templates/{id} | Get the channel template by id.
10
10
  [**messaging_templates_get_templates**](MessagingTemplatesApi.md#messaging_templates_get_templates) | **GET** /api/apps/{appId}/messaging-templates | Get the channel templates.
11
11
  [**messaging_templates_post_template**](MessagingTemplatesApi.md#messaging_templates_post_template) | **POST** /api/apps/{appId}/messaging-templates | Create a channel template.
12
- [**messaging_templates_post_template_language**](MessagingTemplatesApi.md#messaging_templates_post_template_language) | **POST** /api/apps/{appId}/messaging-templates/{id} | Create an app template language.
13
- [**messaging_templates_put_template**](MessagingTemplatesApi.md#messaging_templates_put_template) | **PUT** /api/apps/{appId}/messaging-templates/{id} | Update an app template.
14
- [**messaging_templates_put_template_language**](MessagingTemplatesApi.md#messaging_templates_put_template_language) | **PUT** /api/apps/{appId}/messaging-templates/{id}/{language} | Update a channel template language.
12
+ [**messaging_templates_post_template_language**](MessagingTemplatesApi.md#messaging_templates_post_template_language) | **POST** /api/apps/{appId}/messaging-templates/{code} | Create an app template language.
13
+ [**messaging_templates_put_template**](MessagingTemplatesApi.md#messaging_templates_put_template) | **PUT** /api/apps/{appId}/messaging-templates/{code} | Update an app template.
14
+ [**messaging_templates_put_template_language**](MessagingTemplatesApi.md#messaging_templates_put_template_language) | **PUT** /api/apps/{appId}/messaging-templates/{code}/{language} | Update a channel template language.
15
15
 
16
16
  # **messaging_templates_delete_template**
17
- > messaging_templates_delete_template(app_id, id)
17
+ > messaging_templates_delete_template(app_id, code)
18
18
 
19
19
  Delete a channel template.
20
20
 
@@ -25,12 +25,12 @@ require 'notifo'
25
25
 
26
26
  api_instance = Notifo::MessagingTemplatesApi.new
27
27
  app_id = 'app_id_example' # String | The id of the app where the templates belong to.
28
- id = 'id_example' # String | The template ID.
28
+ code = 'code_example' # String | The template ID.
29
29
 
30
30
 
31
31
  begin
32
32
  #Delete a channel template.
33
- api_instance.messaging_templates_delete_template(app_id, id)
33
+ api_instance.messaging_templates_delete_template(app_id, code)
34
34
  rescue Notifo::ApiError => e
35
35
  puts "Exception when calling MessagingTemplatesApi->messaging_templates_delete_template: #{e}"
36
36
  end
@@ -41,7 +41,7 @@ end
41
41
  Name | Type | Description | Notes
42
42
  ------------- | ------------- | ------------- | -------------
43
43
  **app_id** | **String**| The id of the app where the templates belong to. |
44
- **id** | **String**| The template ID. |
44
+ **code** | **String**| The template ID. |
45
45
 
46
46
  ### Return type
47
47
 
@@ -59,7 +59,7 @@ No authorization required
59
59
 
60
60
 
61
61
  # **messaging_templates_delete_template_language**
62
- > messaging_templates_delete_template_language(app_id, id, language)
62
+ > messaging_templates_delete_template_language(app_id, code, language)
63
63
 
64
64
  Delete a language channel template.
65
65
 
@@ -70,13 +70,13 @@ require 'notifo'
70
70
 
71
71
  api_instance = Notifo::MessagingTemplatesApi.new
72
72
  app_id = 'app_id_example' # String | The id of the app where the templates belong to.
73
- id = 'id_example' # String | The template ID.
73
+ code = 'code_example' # String | The template ID.
74
74
  language = 'language_example' # String | The language.
75
75
 
76
76
 
77
77
  begin
78
78
  #Delete a language channel template.
79
- api_instance.messaging_templates_delete_template_language(app_id, id, language)
79
+ api_instance.messaging_templates_delete_template_language(app_id, code, language)
80
80
  rescue Notifo::ApiError => e
81
81
  puts "Exception when calling MessagingTemplatesApi->messaging_templates_delete_template_language: #{e}"
82
82
  end
@@ -87,7 +87,7 @@ end
87
87
  Name | Type | Description | Notes
88
88
  ------------- | ------------- | ------------- | -------------
89
89
  **app_id** | **String**| The id of the app where the templates belong to. |
90
- **id** | **String**| The template ID. |
90
+ **code** | **String**| The template ID. |
91
91
  **language** | **String**| The language. |
92
92
 
93
93
  ### Return type
@@ -249,7 +249,7 @@ No authorization required
249
249
 
250
250
 
251
251
  # **messaging_templates_post_template_language**
252
- > MessagingTemplateDto messaging_templates_post_template_language(bodyapp_idid)
252
+ > MessagingTemplateDto messaging_templates_post_template_language(bodyapp_idcode)
253
253
 
254
254
  Create an app template language.
255
255
 
@@ -261,12 +261,12 @@ require 'notifo'
261
261
  api_instance = Notifo::MessagingTemplatesApi.new
262
262
  body = Notifo::CreateChannelTemplateLanguageDto.new # CreateChannelTemplateLanguageDto | The request object.
263
263
  app_id = 'app_id_example' # String | The id of the app where the templates belong to.
264
- id = 'id_example' # String | The template ID.
264
+ code = 'code_example' # String | The template code.
265
265
 
266
266
 
267
267
  begin
268
268
  #Create an app template language.
269
- result = api_instance.messaging_templates_post_template_language(bodyapp_idid)
269
+ result = api_instance.messaging_templates_post_template_language(bodyapp_idcode)
270
270
  p result
271
271
  rescue Notifo::ApiError => e
272
272
  puts "Exception when calling MessagingTemplatesApi->messaging_templates_post_template_language: #{e}"
@@ -279,7 +279,7 @@ Name | Type | Description | Notes
279
279
  ------------- | ------------- | ------------- | -------------
280
280
  **body** | [**CreateChannelTemplateLanguageDto**](CreateChannelTemplateLanguageDto.md)| The request object. |
281
281
  **app_id** | **String**| The id of the app where the templates belong to. |
282
- **id** | **String**| The template ID. |
282
+ **code** | **String**| The template code. |
283
283
 
284
284
  ### Return type
285
285
 
@@ -297,7 +297,7 @@ No authorization required
297
297
 
298
298
 
299
299
  # **messaging_templates_put_template**
300
- > messaging_templates_put_template(bodyapp_idid)
300
+ > messaging_templates_put_template(bodyapp_idcode)
301
301
 
302
302
  Update an app template.
303
303
 
@@ -309,12 +309,12 @@ require 'notifo'
309
309
  api_instance = Notifo::MessagingTemplatesApi.new
310
310
  body = Notifo::UpdateChannelTemplateDtoOfMessagingTemplateDto.new # UpdateChannelTemplateDtoOfMessagingTemplateDto | The request object.
311
311
  app_id = 'app_id_example' # String | The id of the app where the templates belong to.
312
- id = 'id_example' # String | The template ID.
312
+ code = 'code_example' # String | The template code.
313
313
 
314
314
 
315
315
  begin
316
316
  #Update an app template.
317
- api_instance.messaging_templates_put_template(bodyapp_idid)
317
+ api_instance.messaging_templates_put_template(bodyapp_idcode)
318
318
  rescue Notifo::ApiError => e
319
319
  puts "Exception when calling MessagingTemplatesApi->messaging_templates_put_template: #{e}"
320
320
  end
@@ -326,7 +326,7 @@ Name | Type | Description | Notes
326
326
  ------------- | ------------- | ------------- | -------------
327
327
  **body** | [**UpdateChannelTemplateDtoOfMessagingTemplateDto**](UpdateChannelTemplateDtoOfMessagingTemplateDto.md)| The request object. |
328
328
  **app_id** | **String**| The id of the app where the templates belong to. |
329
- **id** | **String**| The template ID. |
329
+ **code** | **String**| The template code. |
330
330
 
331
331
  ### Return type
332
332
 
@@ -344,7 +344,7 @@ No authorization required
344
344
 
345
345
 
346
346
  # **messaging_templates_put_template_language**
347
- > messaging_templates_put_template_language(bodyapp_ididlanguage)
347
+ > messaging_templates_put_template_language(bodyapp_idcodelanguage)
348
348
 
349
349
  Update a channel template language.
350
350
 
@@ -356,13 +356,13 @@ require 'notifo'
356
356
  api_instance = Notifo::MessagingTemplatesApi.new
357
357
  body = Notifo::MessagingTemplateDto.new # MessagingTemplateDto | The request object.
358
358
  app_id = 'app_id_example' # String | The id of the app where the templates belong to.
359
- id = 'id_example' # String | The template ID.
359
+ code = 'code_example' # String | The template code.
360
360
  language = 'language_example' # String | The language.
361
361
 
362
362
 
363
363
  begin
364
364
  #Update a channel template language.
365
- api_instance.messaging_templates_put_template_language(bodyapp_ididlanguage)
365
+ api_instance.messaging_templates_put_template_language(bodyapp_idcodelanguage)
366
366
  rescue Notifo::ApiError => e
367
367
  puts "Exception when calling MessagingTemplatesApi->messaging_templates_put_template_language: #{e}"
368
368
  end
@@ -374,7 +374,7 @@ Name | Type | Description | Notes
374
374
  ------------- | ------------- | ------------- | -------------
375
375
  **body** | [**MessagingTemplateDto**](MessagingTemplateDto.md)| The request object. |
376
376
  **app_id** | **String**| The id of the app where the templates belong to. |
377
- **id** | **String**| The template ID. |
377
+ **code** | **String**| The template code. |
378
378
  **language** | **String**| The language. |
379
379
 
380
380
  ### Return type
@@ -1,6 +1,6 @@
1
1
  # Notifo::MobilePushApi
2
2
 
3
- All URIs are relative to *https://notifo.easierlife.com*
3
+ All URIs are relative to *https://notifo-dev.easierlife.com*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
@@ -5,5 +5,6 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **token** | **String** | The token. |
7
7
  **device_type** | [**MobileDeviceType**](MobileDeviceType.md) | |
8
+ **device_identifier** | **String** | A unique identifier for the device. | [optional]
8
9
  **last_wakeup** | **DateTime** | The last time the device was woken up. | [optional]
9
10
 
@@ -5,4 +5,5 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **token** | **String** | The device token. |
7
7
  **device_type** | [**MobileDeviceType**](MobileDeviceType.md) | | [optional]
8
+ **device_identifier** | **String** | A unique identifier for the device. | [optional]
8
9
 
@@ -1,11 +1,13 @@
1
1
  # Notifo::NotificationsApi
2
2
 
3
- All URIs are relative to *https://notifo.easierlife.com*
3
+ All URIs are relative to *https://notifo-dev.easierlife.com*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
7
  [**notifications_confirm_me**](NotificationsApi.md#notifications_confirm_me) | **POST** /api/me/notifications/handled | Confirms the user notifications for the current user.
8
- [**notifications_get_my_archive**](NotificationsApi.md#notifications_get_my_archive) | **GET** /api/me/notifications/archive | Query archhived user notifications of the current user.
8
+ [**notifications_get_all_notifications**](NotificationsApi.md#notifications_get_all_notifications) | **GET** /api/apps/{appId}/notifications | Query notifications.
9
+ [**notifications_get_my_archive**](NotificationsApi.md#notifications_get_my_archive) | **GET** /api/me/notifications/archive | Query archived user notifications of the current user.
10
+ [**notifications_get_my_device_notifications**](NotificationsApi.md#notifications_get_my_device_notifications) | **GET** /api/me/notifications/device | Query user notifications of the current user for a specific device.
9
11
  [**notifications_get_my_notifications**](NotificationsApi.md#notifications_get_my_notifications) | **GET** /api/me/notifications | Query user notifications of the current user.
10
12
  [**notifications_get_notifications**](NotificationsApi.md#notifications_get_notifications) | **GET** /api/apps/{appId}/users/{id}/notifications | Query user notifications.
11
13
 
@@ -52,10 +54,67 @@ No authorization required
52
54
 
53
55
 
54
56
 
57
+ # **notifications_get_all_notifications**
58
+ > ListResponseDtoOfUserNotificationDetailsDto notifications_get_all_notifications(app_id, opts)
59
+
60
+ Query notifications.
61
+
62
+ ### Example
63
+ ```ruby
64
+ # load the gem
65
+ require 'notifo'
66
+
67
+ api_instance = Notifo::NotificationsApi.new
68
+ app_id = 'app_id_example' # String | The app where the user belongs to.
69
+ opts = {
70
+ channels: ['channels_example'], # Array<String> | The active channels.
71
+ channel: 'channel_example', # String | The source channel.
72
+ correlation_id: 'correlation_id_example', # String | The correlation ID, that can be used to query notifications.
73
+ query: 'query_example', # String | The optional query to search for items.
74
+ take: 56, # Integer | The number of items to return.
75
+ skip: 56 # Integer | The number of items to skip.
76
+ }
77
+
78
+ begin
79
+ #Query notifications.
80
+ result = api_instance.notifications_get_all_notifications(app_id, opts)
81
+ p result
82
+ rescue Notifo::ApiError => e
83
+ puts "Exception when calling NotificationsApi->notifications_get_all_notifications: #{e}"
84
+ end
85
+ ```
86
+
87
+ ### Parameters
88
+
89
+ Name | Type | Description | Notes
90
+ ------------- | ------------- | ------------- | -------------
91
+ **app_id** | **String**| The app where the user belongs to. |
92
+ **channels** | [**Array&lt;String&gt;**](String.md)| The active channels. | [optional]
93
+ **channel** | **String**| The source channel. | [optional]
94
+ **correlation_id** | **String**| The correlation ID, that can be used to query notifications. | [optional]
95
+ **query** | **String**| The optional query to search for items. | [optional]
96
+ **take** | **Integer**| The number of items to return. | [optional]
97
+ **skip** | **Integer**| The number of items to skip. | [optional]
98
+
99
+ ### Return type
100
+
101
+ [**ListResponseDtoOfUserNotificationDetailsDto**](ListResponseDtoOfUserNotificationDetailsDto.md)
102
+
103
+ ### Authorization
104
+
105
+ No authorization required
106
+
107
+ ### HTTP request headers
108
+
109
+ - **Content-Type**: Not defined
110
+ - **Accept**: application/json
111
+
112
+
113
+
55
114
  # **notifications_get_my_archive**
56
- > ListResponseDtoOfUserNotificationDto notifications_get_my_archive
115
+ > ListResponseDtoOfUserNotificationDto notifications_get_my_archive(opts)
57
116
 
58
- Query archhived user notifications of the current user.
117
+ Query archived user notifications of the current user.
59
118
 
60
119
  ### Example
61
120
  ```ruby
@@ -63,10 +122,13 @@ Query archhived user notifications of the current user.
63
122
  require 'notifo'
64
123
 
65
124
  api_instance = Notifo::NotificationsApi.new
125
+ opts = {
126
+ channel: 'channel_example' # String | The tracking channel.
127
+ }
66
128
 
67
129
  begin
68
- #Query archhived user notifications of the current user.
69
- result = api_instance.notifications_get_my_archive
130
+ #Query archived user notifications of the current user.
131
+ result = api_instance.notifications_get_my_archive(opts)
70
132
  p result
71
133
  rescue Notifo::ApiError => e
72
134
  puts "Exception when calling NotificationsApi->notifications_get_my_archive: #{e}"
@@ -74,7 +136,61 @@ end
74
136
  ```
75
137
 
76
138
  ### Parameters
77
- This endpoint does not need any parameter.
139
+
140
+ Name | Type | Description | Notes
141
+ ------------- | ------------- | ------------- | -------------
142
+ **channel** | **String**| The tracking channel. | [optional]
143
+
144
+ ### Return type
145
+
146
+ [**ListResponseDtoOfUserNotificationDto**](ListResponseDtoOfUserNotificationDto.md)
147
+
148
+ ### Authorization
149
+
150
+ No authorization required
151
+
152
+ ### HTTP request headers
153
+
154
+ - **Content-Type**: Not defined
155
+ - **Accept**: application/json
156
+
157
+
158
+
159
+ # **notifications_get_my_device_notifications**
160
+ > ListResponseDtoOfUserNotificationDto notifications_get_my_device_notifications(opts)
161
+
162
+ Query user notifications of the current user for a specific device.
163
+
164
+ ### Example
165
+ ```ruby
166
+ # load the gem
167
+ require 'notifo'
168
+
169
+ api_instance = Notifo::NotificationsApi.new
170
+ opts = {
171
+ device_identifier: 'device_identifier_example', # String | The device identifier (aka mobile push token).
172
+ after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | The max age of the notifications.
173
+ include_unseen: true, # BOOLEAN | True to also include unseen notifications.
174
+ take: 56 # Integer | The number of notifications to query.
175
+ }
176
+
177
+ begin
178
+ #Query user notifications of the current user for a specific device.
179
+ result = api_instance.notifications_get_my_device_notifications(opts)
180
+ p result
181
+ rescue Notifo::ApiError => e
182
+ puts "Exception when calling NotificationsApi->notifications_get_my_device_notifications: #{e}"
183
+ end
184
+ ```
185
+
186
+ ### Parameters
187
+
188
+ Name | Type | Description | Notes
189
+ ------------- | ------------- | ------------- | -------------
190
+ **device_identifier** | **String**| The device identifier (aka mobile push token). | [optional]
191
+ **after** | **DateTime**| The max age of the notifications. | [optional]
192
+ **include_unseen** | **BOOLEAN**| True to also include unseen notifications. | [optional]
193
+ **take** | **Integer**| The number of notifications to query. | [optional]
78
194
 
79
195
  ### Return type
80
196
 
@@ -104,6 +220,8 @@ require 'notifo'
104
220
  api_instance = Notifo::NotificationsApi.new
105
221
  opts = {
106
222
  channels: ['channels_example'], # Array<String> | The active channels.
223
+ channel: 'channel_example', # String | The source channel.
224
+ correlation_id: 'correlation_id_example', # String | The correlation ID, that can be used to query notifications.
107
225
  query: 'query_example', # String | The optional query to search for items.
108
226
  take: 56, # Integer | The number of items to return.
109
227
  skip: 56 # Integer | The number of items to skip.
@@ -123,6 +241,8 @@ end
123
241
  Name | Type | Description | Notes
124
242
  ------------- | ------------- | ------------- | -------------
125
243
  **channels** | [**Array&lt;String&gt;**](String.md)| The active channels. | [optional]
244
+ **channel** | **String**| The source channel. | [optional]
245
+ **correlation_id** | **String**| The correlation ID, that can be used to query notifications. | [optional]
126
246
  **query** | **String**| The optional query to search for items. | [optional]
127
247
  **take** | **Integer**| The number of items to return. | [optional]
128
248
  **skip** | **Integer**| The number of items to skip. | [optional]
@@ -157,6 +277,8 @@ app_id = 'app_id_example' # String | The app where the user belongs to.
157
277
  id = 'id_example' # String | The user id.
158
278
  opts = {
159
279
  channels: ['channels_example'], # Array<String> | The active channels.
280
+ channel: 'channel_example', # String | The source channel.
281
+ correlation_id: 'correlation_id_example', # String | The correlation ID, that can be used to query notifications.
160
282
  query: 'query_example', # String | The optional query to search for items.
161
283
  take: 56, # Integer | The number of items to return.
162
284
  skip: 56 # Integer | The number of items to skip.
@@ -178,6 +300,8 @@ Name | Type | Description | Notes
178
300
  **app_id** | **String**| The app where the user belongs to. |
179
301
  **id** | **String**| The user id. |
180
302
  **channels** | [**Array&lt;String&gt;**](String.md)| The active channels. | [optional]
303
+ **channel** | **String**| The source channel. | [optional]
304
+ **correlation_id** | **String**| The correlation ID, that can be used to query notifications. | [optional]
181
305
  **query** | **String**| The optional query to search for items. | [optional]
182
306
  **take** | **Integer**| The number of items to return. | [optional]
183
307
  **skip** | **Integer**| The number of items to skip. | [optional]
data/docs/PingApi.md CHANGED
@@ -1,10 +1,93 @@
1
1
  # Notifo::PingApi
2
2
 
3
- All URIs are relative to *https://notifo.easierlife.com*
3
+ All URIs are relative to *https://notifo-dev.easierlife.com*
4
4
 
5
5
  Method | HTTP request | Description
6
6
  ------------- | ------------- | -------------
7
- [**ping_get_ping**](PingApi.md#ping_get_ping) | **GET** /ping | Get ping status of the API.
7
+ [**ping_get_info**](PingApi.md#ping_get_info) | **GET** /api/info | Get some info about the API.
8
+ [**ping_get_old_ping**](PingApi.md#ping_get_old_ping) | **GET** /ping | Get ping status of the API.
9
+ [**ping_get_ping**](PingApi.md#ping_get_ping) | **GET** /api/ping | Get ping status of the API.
10
+
11
+ # **ping_get_info**
12
+ > InfoDto ping_get_info
13
+
14
+ Get some info about the API.
15
+
16
+ Can be used to test, if the Squidex API is alive and responding.
17
+
18
+ ### Example
19
+ ```ruby
20
+ # load the gem
21
+ require 'notifo'
22
+
23
+ api_instance = Notifo::PingApi.new
24
+
25
+ begin
26
+ #Get some info about the API.
27
+ result = api_instance.ping_get_info
28
+ p result
29
+ rescue Notifo::ApiError => e
30
+ puts "Exception when calling PingApi->ping_get_info: #{e}"
31
+ end
32
+ ```
33
+
34
+ ### Parameters
35
+ This endpoint does not need any parameter.
36
+
37
+ ### Return type
38
+
39
+ [**InfoDto**](InfoDto.md)
40
+
41
+ ### Authorization
42
+
43
+ No authorization required
44
+
45
+ ### HTTP request headers
46
+
47
+ - **Content-Type**: Not defined
48
+ - **Accept**: application/json
49
+
50
+
51
+
52
+ # **ping_get_old_ping**
53
+ > ping_get_old_ping
54
+
55
+ Get ping status of the API.
56
+
57
+ Can be used to test, if the Squidex API is alive and responding.
58
+
59
+ ### Example
60
+ ```ruby
61
+ # load the gem
62
+ require 'notifo'
63
+
64
+ api_instance = Notifo::PingApi.new
65
+
66
+ begin
67
+ #Get ping status of the API.
68
+ api_instance.ping_get_old_ping
69
+ rescue Notifo::ApiError => e
70
+ puts "Exception when calling PingApi->ping_get_old_ping: #{e}"
71
+ end
72
+ ```
73
+
74
+ ### Parameters
75
+ This endpoint does not need any parameter.
76
+
77
+ ### Return type
78
+
79
+ nil (empty response body)
80
+
81
+ ### Authorization
82
+
83
+ No authorization required
84
+
85
+ ### HTTP request headers
86
+
87
+ - **Content-Type**: Not defined
88
+ - **Accept**: application/json
89
+
90
+
8
91
 
9
92
  # **ping_get_ping**
10
93
  > ping_get_ping
@@ -1,4 +1,4 @@
1
- # Notifo::IntegrationPropertyType
1
+ # Notifo::PropertyType
2
2
 
3
3
  ## Properties
4
4
  Name | Type | Description | Notes
data/docs/PublishDto.md CHANGED
@@ -6,6 +6,8 @@ Name | Type | Description | Notes
6
6
  **topic** | **String** | The topic path. |
7
7
  **creator_id** | **String** | A custom id to identity the creator. | [optional]
8
8
  **template_code** | **String** | The template code. | [optional]
9
+ **correlation_id** | **String** | The correlation ID, that can be used to query notifications. | [optional]
10
+ **template_variants** | **Hash&lt;String, Float&gt;** | The template variants with propability. | [optional]
9
11
  **data** | **String** | Additional user defined data. | [optional]
10
12
  **timestamp** | **DateTime** | A custom timestamp. | [optional]
11
13
  **preformatted** | [**NotificationFormattingDto**](NotificationFormattingDto.md) | | [optional]
@@ -5,4 +5,5 @@ Name | Type | Description | Notes
5
5
  ------------ | ------------- | ------------- | -------------
6
6
  **token** | **String** | The device token. |
7
7
  **device_type** | [**MobileDeviceType**](MobileDeviceType.md) | | [optional]
8
+ **device_identifier** | **String** | A unique identifier for the device. | [optional]
8
9
 
@@ -0,0 +1,6 @@
1
+ # Notifo::SendConfiguration
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+