notifo-io 1.0.0.pre → 1.0.1.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (258) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +726 -19
  3. data/Rakefile +0 -2
  4. data/docs/AddAllowedTopicDto.md +7 -0
  5. data/docs/AddContributorDto.md +4 -16
  6. data/docs/AppContributorDto.md +5 -18
  7. data/docs/AppDetailsDto.md +10 -44
  8. data/docs/AppDto.md +8 -24
  9. data/docs/AppIdMediaBody.md +7 -0
  10. data/docs/AppsApi.md +301 -297
  11. data/docs/AuthorizationApi.md +121 -0
  12. data/docs/Body.md +7 -0
  13. data/docs/ConfigsApi.md +21 -61
  14. data/docs/ConfiguredIntegrationDto.md +12 -0
  15. data/docs/ConfiguredIntegrationsDto.md +8 -0
  16. data/docs/ConfirmMode.md +2 -11
  17. data/docs/CreateEmailTemplateDto.md +3 -14
  18. data/docs/CreateIntegrationDto.md +11 -0
  19. data/docs/EmailTemplateDto.md +5 -18
  20. data/docs/EmailTemplatesDto.md +6 -0
  21. data/docs/EmailVerificationStatus.md +2 -11
  22. data/docs/ErrorDto.md +7 -22
  23. data/docs/EventDto.md +15 -36
  24. data/docs/EventProperties.md +6 -0
  25. data/docs/EventsApi.md +72 -65
  26. data/docs/IntegrationCreatedDto.md +8 -0
  27. data/docs/IntegrationDefinitionDto.md +11 -0
  28. data/docs/IntegrationProperties.md +6 -0
  29. data/docs/IntegrationPropertyDto.md +17 -0
  30. data/docs/IntegrationPropertyType.md +6 -0
  31. data/docs/IntegrationStatus.md +6 -0
  32. data/docs/IsoDayOfWeek.md +2 -11
  33. data/docs/ListResponseDtoOfEventDto.md +4 -16
  34. data/docs/ListResponseDtoOfLogEntryDto.md +4 -16
  35. data/docs/ListResponseDtoOfMediaDto.md +4 -16
  36. data/docs/ListResponseDtoOfMobilePushTokenDto.md +8 -0
  37. data/docs/ListResponseDtoOfNotificationDto.md +8 -0
  38. data/docs/ListResponseDtoOfSubscriptionDto.md +4 -16
  39. data/docs/ListResponseDtoOfTemplateDto.md +4 -16
  40. data/docs/ListResponseDtoOfTopicDto.md +4 -16
  41. data/docs/ListResponseDtoOfUserDto.md +4 -16
  42. data/docs/LocalizedText.md +6 -0
  43. data/docs/LogEntryDto.md +6 -20
  44. data/docs/LogsApi.md +21 -40
  45. data/docs/MediaApi.md +134 -141
  46. data/docs/MediaDto.md +9 -24
  47. data/docs/MediaMetadata.md +6 -0
  48. data/docs/MediaType.md +2 -11
  49. data/docs/MobileDeviceType.md +6 -0
  50. data/docs/MobilePushApi.md +135 -0
  51. data/docs/MobilePushTokenDto.md +8 -0
  52. data/docs/NotificationDto.md +21 -0
  53. data/docs/NotificationFormattingDto.md +10 -28
  54. data/docs/NotificationSend.md +6 -0
  55. data/docs/NotificationSettingDto.md +4 -16
  56. data/docs/NotificationsApi.md +141 -0
  57. data/docs/ProfileDto.md +14 -0
  58. data/docs/PublishDto.md +18 -0
  59. data/docs/PublishManyDto.md +7 -0
  60. data/docs/RegisterMobileTokenDto.md +8 -0
  61. data/docs/ResizeMode.md +2 -11
  62. data/docs/SchedulingDto.md +6 -20
  63. data/docs/SchedulingType.md +2 -11
  64. data/docs/SubscriptionDto.md +4 -16
  65. data/docs/TemplateDto.md +5 -18
  66. data/docs/TemplatesApi.md +51 -106
  67. data/docs/TopicDto.md +5 -18
  68. data/docs/TopicsApi.md +19 -230
  69. data/docs/TrackNotificationDto.md +10 -0
  70. data/docs/UpdateIntegrationDto.md +10 -0
  71. data/docs/UpdateProfileDto.md +12 -0
  72. data/docs/UpsertAppDto.md +12 -32
  73. data/docs/UpsertTemplateDto.md +5 -18
  74. data/docs/UpsertTemplatesDto.md +3 -14
  75. data/docs/UpsertUserDto.md +11 -28
  76. data/docs/UpsertUsersDto.md +3 -14
  77. data/docs/UserApi.md +231 -0
  78. data/docs/UserDto.md +15 -32
  79. data/docs/UserInfoApi.md +83 -0
  80. data/docs/UsersApi.md +144 -308
  81. data/git_push.sh +7 -10
  82. data/lib/notifo.rb +37 -11
  83. data/lib/notifo/api/apps_api.rb +373 -201
  84. data/lib/notifo/api/authorization_api.rb +158 -0
  85. data/lib/notifo/api/configs_api.rb +14 -30
  86. data/lib/notifo/api/events_api.rb +85 -45
  87. data/lib/notifo/api/logs_api.rb +12 -21
  88. data/lib/notifo/api/media_api.rb +137 -77
  89. data/lib/notifo/api/mobile_push_api.rb +178 -0
  90. data/lib/notifo/api/notifications_api.rb +181 -0
  91. data/lib/notifo/api/templates_api.rb +39 -62
  92. data/lib/notifo/api/topics_api.rb +12 -210
  93. data/lib/notifo/api/user_api.rb +294 -0
  94. data/lib/notifo/api/user_info_api.rb +112 -0
  95. data/lib/notifo/api/users_api.rb +121 -186
  96. data/lib/notifo/api_client.rb +53 -55
  97. data/lib/notifo/api_error.rb +5 -5
  98. data/lib/notifo/configuration.rb +8 -78
  99. data/lib/notifo/models/{add_allowed_topic_request.rb → add_allowed_topic_dto.rb} +21 -28
  100. data/lib/notifo/models/add_contributor_dto.rb +24 -26
  101. data/lib/notifo/models/app_contributor_dto.rb +30 -27
  102. data/lib/notifo/models/app_details_dto.rb +59 -119
  103. data/lib/notifo/models/app_dto.rb +51 -31
  104. data/lib/notifo/models/{inline_object.rb → app_id_media_body.rb} +16 -28
  105. data/lib/notifo/models/body.rb +206 -0
  106. data/lib/notifo/models/configured_integration_dto.rb +271 -0
  107. data/lib/notifo/models/configured_integrations_dto.rb +231 -0
  108. data/lib/notifo/models/confirm_mode.rb +7 -16
  109. data/lib/notifo/models/create_email_template_dto.rb +18 -25
  110. data/lib/notifo/models/create_integration_dto.rb +257 -0
  111. data/lib/notifo/models/email_template_dto.rb +25 -27
  112. data/lib/notifo/models/email_templates_dto.rb +201 -0
  113. data/lib/notifo/models/email_verification_status.rb +8 -17
  114. data/lib/notifo/models/error_dto.rb +17 -29
  115. data/lib/notifo/models/event_dto.rb +92 -46
  116. data/lib/notifo/models/event_properties.rb +201 -0
  117. data/lib/notifo/models/{subscribe_dto.rb → integration_created_dto.rb} +39 -42
  118. data/lib/notifo/models/integration_definition_dto.rb +272 -0
  119. data/lib/notifo/models/integration_properties.rb +201 -0
  120. data/lib/notifo/models/integration_property_dto.rb +319 -0
  121. data/lib/notifo/models/integration_property_type.rb +31 -0
  122. data/lib/notifo/models/integration_status.rb +29 -0
  123. data/lib/notifo/models/iso_day_of_week.rb +12 -21
  124. data/lib/notifo/models/list_response_dto_of_event_dto.rb +24 -26
  125. data/lib/notifo/models/list_response_dto_of_log_entry_dto.rb +24 -26
  126. data/lib/notifo/models/list_response_dto_of_media_dto.rb +24 -26
  127. data/lib/notifo/models/list_response_dto_of_mobile_push_token_dto.rb +229 -0
  128. data/lib/notifo/models/list_response_dto_of_notification_dto.rb +229 -0
  129. data/lib/notifo/models/list_response_dto_of_subscription_dto.rb +24 -26
  130. data/lib/notifo/models/list_response_dto_of_template_dto.rb +24 -26
  131. data/lib/notifo/models/list_response_dto_of_topic_dto.rb +24 -26
  132. data/lib/notifo/models/list_response_dto_of_user_dto.rb +24 -26
  133. data/lib/notifo/models/localized_text.rb +201 -0
  134. data/lib/notifo/models/log_entry_dto.rb +36 -28
  135. data/lib/notifo/models/media_dto.rb +64 -33
  136. data/lib/notifo/models/media_metadata.rb +201 -0
  137. data/lib/notifo/models/media_type.rb +8 -17
  138. data/lib/notifo/models/mobile_device_type.rb +29 -0
  139. data/lib/notifo/models/mobile_push_token_dto.rb +221 -0
  140. data/lib/notifo/models/notification_dto.rb +386 -0
  141. data/lib/notifo/models/notification_formatting_dto.rb +30 -46
  142. data/lib/notifo/models/notification_send.rb +30 -0
  143. data/lib/notifo/models/notification_setting_dto.rb +25 -34
  144. data/lib/notifo/models/profile_dto.rb +311 -0
  145. data/lib/notifo/models/{publish_request_dto.rb → publish_dto.rb} +55 -44
  146. data/lib/notifo/models/{publish_many_request_dto.rb → publish_many_dto.rb} +21 -28
  147. data/lib/notifo/models/register_mobile_token_dto.rb +221 -0
  148. data/lib/notifo/models/resize_mode.rb +11 -20
  149. data/lib/notifo/models/scheduling_dto.rb +16 -31
  150. data/lib/notifo/models/scheduling_type.rb +6 -15
  151. data/lib/notifo/models/subscription_dto.rb +23 -27
  152. data/lib/notifo/models/template_dto.rb +33 -29
  153. data/lib/notifo/models/topic_dto.rb +33 -28
  154. data/lib/notifo/models/track_notification_dto.rb +243 -0
  155. data/lib/notifo/models/update_integration_dto.rb +242 -0
  156. data/lib/notifo/models/update_profile_dto.rb +265 -0
  157. data/lib/notifo/models/upsert_app_dto.rb +22 -34
  158. data/lib/notifo/models/upsert_template_dto.rb +28 -29
  159. data/lib/notifo/models/upsert_templates_dto.rb +18 -25
  160. data/lib/notifo/models/upsert_user_dto.rb +35 -34
  161. data/lib/notifo/models/upsert_users_dto.rb +18 -25
  162. data/lib/notifo/models/user_dto.rb +100 -37
  163. data/lib/notifo/version.rb +4 -5
  164. data/notifo-io-1.0.1.1.gem +0 -0
  165. data/notifo.gemspec +10 -10
  166. data/spec/api/apps_api_spec.rb +14 -15
  167. data/spec/api/authorization_api_spec.rb +61 -0
  168. data/spec/api/configs_api_spec.rb +7 -8
  169. data/spec/api/events_api_spec.rb +8 -9
  170. data/spec/api/logs_api_spec.rb +7 -8
  171. data/spec/api/media_api_spec.rb +33 -12
  172. data/spec/api/mobile_push_api_spec.rb +66 -0
  173. data/spec/api/notifications_api_spec.rb +68 -0
  174. data/spec/api/templates_api_spec.rb +8 -9
  175. data/spec/api/topics_api_spec.rb +7 -44
  176. data/spec/api/user_api_spec.rb +91 -0
  177. data/spec/api/user_info_api_spec.rb +52 -0
  178. data/spec/api/users_api_spec.rb +10 -11
  179. data/spec/api_client_spec.rb +5 -6
  180. data/spec/base_object_spec.rb +109 -0
  181. data/spec/configuration_spec.rb +4 -5
  182. data/spec/models/add_allowed_topic_dto_spec.rb +40 -0
  183. data/spec/models/add_contributor_dto_spec.rb +15 -9
  184. data/spec/models/app_contributor_dto_spec.rb +15 -9
  185. data/spec/models/app_details_dto_spec.rb +15 -9
  186. data/spec/models/app_dto_spec.rb +15 -9
  187. data/spec/models/app_id_media_body_spec.rb +40 -0
  188. data/spec/models/body_spec.rb +40 -0
  189. data/spec/models/configured_integration_dto_spec.rb +70 -0
  190. data/spec/models/configured_integrations_dto_spec.rb +46 -0
  191. data/spec/models/confirm_mode_spec.rb +15 -9
  192. data/spec/models/create_email_template_dto_spec.rb +15 -9
  193. data/spec/models/create_integration_dto_spec.rb +64 -0
  194. data/spec/models/email_template_dto_spec.rb +15 -9
  195. data/spec/models/email_templates_dto_spec.rb +34 -0
  196. data/spec/models/email_verification_status_spec.rb +15 -9
  197. data/spec/models/error_dto_spec.rb +15 -9
  198. data/spec/models/event_dto_spec.rb +15 -9
  199. data/spec/models/event_properties_spec.rb +34 -0
  200. data/spec/models/integration_created_dto_spec.rb +46 -0
  201. data/spec/models/integration_definition_dto_spec.rb +64 -0
  202. data/spec/models/integration_properties_spec.rb +34 -0
  203. data/spec/models/integration_property_dto_spec.rb +100 -0
  204. data/spec/models/integration_property_type_spec.rb +34 -0
  205. data/spec/models/integration_status_spec.rb +34 -0
  206. data/spec/models/iso_day_of_week_spec.rb +15 -9
  207. data/spec/models/list_response_dto_of_event_dto_spec.rb +15 -9
  208. data/spec/models/list_response_dto_of_log_entry_dto_spec.rb +15 -9
  209. data/spec/models/list_response_dto_of_media_dto_spec.rb +15 -9
  210. data/spec/models/list_response_dto_of_mobile_push_token_dto_spec.rb +46 -0
  211. data/spec/models/list_response_dto_of_notification_dto_spec.rb +46 -0
  212. data/spec/models/list_response_dto_of_subscription_dto_spec.rb +15 -9
  213. data/spec/models/list_response_dto_of_template_dto_spec.rb +15 -9
  214. data/spec/models/list_response_dto_of_topic_dto_spec.rb +15 -9
  215. data/spec/models/list_response_dto_of_user_dto_spec.rb +15 -9
  216. data/spec/models/localized_text_spec.rb +34 -0
  217. data/spec/models/log_entry_dto_spec.rb +15 -9
  218. data/spec/models/media_dto_spec.rb +21 -9
  219. data/spec/models/media_metadata_spec.rb +34 -0
  220. data/spec/models/media_type_spec.rb +15 -9
  221. data/spec/models/mobile_device_type_spec.rb +34 -0
  222. data/spec/models/mobile_push_token_dto_spec.rb +46 -0
  223. data/spec/models/notification_dto_spec.rb +124 -0
  224. data/spec/models/notification_formatting_dto_spec.rb +15 -9
  225. data/spec/models/notification_send_spec.rb +34 -0
  226. data/spec/models/notification_setting_dto_spec.rb +16 -10
  227. data/spec/models/profile_dto_spec.rb +82 -0
  228. data/spec/models/{publish_request_dto_spec.rb → publish_dto_spec.rb} +18 -12
  229. data/spec/models/publish_many_dto_spec.rb +40 -0
  230. data/spec/models/register_mobile_token_dto_spec.rb +46 -0
  231. data/spec/models/resize_mode_spec.rb +15 -9
  232. data/spec/models/scheduling_dto_spec.rb +15 -9
  233. data/spec/models/scheduling_type_spec.rb +15 -9
  234. data/spec/models/subscription_dto_spec.rb +15 -9
  235. data/spec/models/template_dto_spec.rb +15 -9
  236. data/spec/models/topic_dto_spec.rb +15 -9
  237. data/spec/models/track_notification_dto_spec.rb +58 -0
  238. data/spec/models/update_integration_dto_spec.rb +58 -0
  239. data/spec/models/update_profile_dto_spec.rb +70 -0
  240. data/spec/models/upsert_app_dto_spec.rb +15 -9
  241. data/spec/models/upsert_template_dto_spec.rb +15 -9
  242. data/spec/models/upsert_templates_dto_spec.rb +15 -9
  243. data/spec/models/upsert_user_dto_spec.rb +15 -9
  244. data/spec/models/upsert_users_dto_spec.rb +15 -9
  245. data/spec/models/user_dto_spec.rb +15 -9
  246. data/spec/spec_helper.rb +4 -5
  247. metadata +167 -30
  248. data/docs/AddAllowedTopicRequest.md +0 -18
  249. data/docs/InlineObject.md +0 -18
  250. data/docs/PublishManyRequestDto.md +0 -18
  251. data/docs/PublishRequestDto.md +0 -36
  252. data/docs/SubscribeDto.md +0 -20
  253. data/notifo-io-1.0.0.gem +0 -0
  254. data/notifo-io-1.0.0.pre.beta.gem +0 -0
  255. data/spec/models/add_allowed_topic_request_spec.rb +0 -34
  256. data/spec/models/inline_object_spec.rb +0 -34
  257. data/spec/models/publish_many_request_dto_spec.rb +0 -34
  258. data/spec/models/subscribe_dto_spec.rb +0 -40
@@ -0,0 +1,14 @@
1
+ # Notifo::ProfileDto
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **full_name** | **String** | The full name of the user. |
7
+ **email_address** | **String** | The email of the user. |
8
+ **phone_number** | **String** | The phone number. | [optional]
9
+ **preferred_language** | **String** | The preferred language of the user. | [optional]
10
+ **preferred_timezone** | **String** | The timezone of the user. | [optional]
11
+ **supported_languages** | **Array<String>** | The supported languages. |
12
+ **supported_timezones** | **Array<String>** | The supported timezones. |
13
+ **settings** | [**Hash<String, NotificationSettingDto>**](NotificationSettingDto.md) | Notification settings per channel. |
14
+
@@ -0,0 +1,18 @@
1
+ # Notifo::PublishDto
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **topic** | **String** | The topic path. |
7
+ **creator_id** | **String** | A custom id to identity the creator. | [optional]
8
+ **template_code** | **String** | The template code. | [optional]
9
+ **data** | **String** | Additional user defined data. | [optional]
10
+ **timestamp** | **DateTime** | A custom timestamp. | [optional]
11
+ **preformatted** | [**NotificationFormattingDto**](NotificationFormattingDto.md) | | [optional]
12
+ **settings** | [**Hash<String, NotificationSettingDto>**](NotificationSettingDto.md) | The notification settings. | [optional]
13
+ **properties** | [**EventProperties**](EventProperties.md) | | [optional]
14
+ **scheduling** | [**SchedulingDto**](SchedulingDto.md) | | [optional]
15
+ **silent** | **BOOLEAN** | True when silent. | [optional]
16
+ **test** | **BOOLEAN** | True when using test integrations. | [optional]
17
+ **time_to_live_in_seconds** | **Integer** | The time to live in seconds. | [optional]
18
+
@@ -0,0 +1,7 @@
1
+ # Notifo::PublishManyDto
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **requests** | [**Array<PublishDto>**](PublishDto.md) | The publish requests. |
7
+
@@ -0,0 +1,8 @@
1
+ # Notifo::RegisterMobileTokenDto
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **token** | **String** | The device token. |
7
+ **device_type** | [**MobileDeviceType**](MobileDeviceType.md) | | [optional]
8
+
data/docs/ResizeMode.md CHANGED
@@ -1,15 +1,6 @@
1
1
  # Notifo::ResizeMode
2
2
 
3
3
  ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
-
8
- ## Example
9
-
10
- ```ruby
11
- require 'notifo'
12
-
13
- instance = Notifo::ResizeMode.new()
14
- ```
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
15
6
 
@@ -1,24 +1,10 @@
1
1
  # Notifo::SchedulingDto
2
2
 
3
3
  ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **type** | [**OneOfSchedulingType**](OneOfSchedulingType.md) | The scheduling type. | [optional] |
8
- | **next_week_day** | [**OneOfIsoDayOfWeek**](OneOfIsoDayOfWeek.md) | To schedule the event at the next day of the week. | [optional] |
9
- | **date** | **Date** | The scheduling date. | [optional] |
10
- | **time** | **String** | The scheduling time. | [optional] |
11
-
12
- ## Example
13
-
14
- ```ruby
15
- require 'notifo'
16
-
17
- instance = Notifo::SchedulingDto.new(
18
- type: null,
19
- next_week_day: null,
20
- date: null,
21
- time: null
22
- )
23
- ```
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **type** | [**SchedulingType**](SchedulingType.md) | | [optional]
7
+ **next_week_day** | [**IsoDayOfWeek**](IsoDayOfWeek.md) | | [optional]
8
+ **date** | **Date** | The scheduling date. | [optional]
9
+ **time** | **String** | The scheduling time. | [optional]
24
10
 
@@ -1,15 +1,6 @@
1
1
  # Notifo::SchedulingType
2
2
 
3
3
  ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
-
8
- ## Example
9
-
10
- ```ruby
11
- require 'notifo'
12
-
13
- instance = Notifo::SchedulingType.new()
14
- ```
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
15
6
 
@@ -1,20 +1,8 @@
1
1
  # Notifo::SubscriptionDto
2
2
 
3
3
  ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **topic_prefix** | **String** | The topic to add. | [optional] |
8
- | **topic_settings** | [**OneOfmap**](OneOfmap.md) | Notification settings per channel. | [optional] |
9
-
10
- ## Example
11
-
12
- ```ruby
13
- require 'notifo'
14
-
15
- instance = Notifo::SubscriptionDto.new(
16
- topic_prefix: null,
17
- topic_settings: null
18
- )
19
- ```
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **topic_prefix** | **String** | The topic to add. |
7
+ **topic_settings** | [**Hash<String, NotificationSettingDto>**](NotificationSettingDto.md) | Notification settings per channel. | [optional]
20
8
 
data/docs/TemplateDto.md CHANGED
@@ -1,22 +1,9 @@
1
1
  # Notifo::TemplateDto
2
2
 
3
3
  ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **code** | **String** | The code of the template. | [optional] |
8
- | **formatting** | [**OneOfNotificationFormattingDto**](OneOfNotificationFormattingDto.md) | The formatting. | [optional] |
9
- | **settings** | [**OneOfmap**](OneOfmap.md) | Notification settings per channel. | [optional] |
10
-
11
- ## Example
12
-
13
- ```ruby
14
- require 'notifo'
15
-
16
- instance = Notifo::TemplateDto.new(
17
- code: null,
18
- formatting: null,
19
- settings: null
20
- )
21
- ```
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **code** | **String** | The code of the template. |
7
+ **formatting** | [**NotificationFormattingDto**](NotificationFormattingDto.md) | |
8
+ **settings** | [**Hash<String, NotificationSettingDto>**](NotificationSettingDto.md) | Notification settings per channel. |
22
9
 
data/docs/TemplatesApi.md CHANGED
@@ -1,63 +1,43 @@
1
1
  # Notifo::TemplatesApi
2
2
 
3
- All URIs are relative to *https://app.notifo.io*
3
+ All URIs are relative to *https://notifo.easierlife.com*
4
4
 
5
- | Method | HTTP request | Description |
6
- | ------ | ------------ | ----------- |
7
- | [**templates_delete_template**](TemplatesApi.md#templates_delete_template) | **DELETE** /api/apps/{appId}/templates/{code} | Delete a template. |
8
- | [**templates_get_templates**](TemplatesApi.md#templates_get_templates) | **GET** /api/apps/{appId}/templates | Query templates. |
9
- | [**templates_post_templates**](TemplatesApi.md#templates_post_templates) | **POST** /api/apps/{appId}/templates | Upsert templates. |
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**templates_delete_template**](TemplatesApi.md#templates_delete_template) | **DELETE** /api/apps/{appId}/templates/{code} | Delete a template.
8
+ [**templates_get_templates**](TemplatesApi.md#templates_get_templates) | **GET** /api/apps/{appId}/templates | Query templates.
9
+ [**templates_post_templates**](TemplatesApi.md#templates_post_templates) | **POST** /api/apps/{appId}/templates | Upsert templates.
10
10
 
11
-
12
- ## templates_delete_template
13
-
14
- > <ListResponseDtoOfTemplateDto> templates_delete_template(app_id, code)
11
+ # **templates_delete_template**
12
+ > ListResponseDtoOfTemplateDto templates_delete_template(app_id, code)
15
13
 
16
14
  Delete a template.
17
15
 
18
- ### Examples
19
-
16
+ ### Example
20
17
  ```ruby
21
- require 'time'
18
+ # load the gem
22
19
  require 'notifo'
23
20
 
24
21
  api_instance = Notifo::TemplatesApi.new
25
22
  app_id = 'app_id_example' # String | The app where the templates belong to.
26
23
  code = 'code_example' # String | The template code to delete.
27
24
 
25
+
28
26
  begin
29
- # Delete a template.
27
+ #Delete a template.
30
28
  result = api_instance.templates_delete_template(app_id, code)
31
29
  p result
32
30
  rescue Notifo::ApiError => e
33
- puts "Error when calling TemplatesApi->templates_delete_template: #{e}"
34
- end
35
- ```
36
-
37
- #### Using the templates_delete_template_with_http_info variant
38
-
39
- This returns an Array which contains the response data, status code and headers.
40
-
41
- > <Array(<ListResponseDtoOfTemplateDto>, Integer, Hash)> templates_delete_template_with_http_info(app_id, code)
42
-
43
- ```ruby
44
- begin
45
- # Delete a template.
46
- data, status_code, headers = api_instance.templates_delete_template_with_http_info(app_id, code)
47
- p status_code # => 2xx
48
- p headers # => { ... }
49
- p data # => <ListResponseDtoOfTemplateDto>
50
- rescue Notifo::ApiError => e
51
- puts "Error when calling TemplatesApi->templates_delete_template_with_http_info: #{e}"
31
+ puts "Exception when calling TemplatesApi->templates_delete_template: #{e}"
52
32
  end
53
33
  ```
54
34
 
55
35
  ### Parameters
56
36
 
57
- | Name | Type | Description | Notes |
58
- | ---- | ---- | ----------- | ----- |
59
- | **app_id** | **String** | The app where the templates belong to. | |
60
- | **code** | **String** | The template code to delete. | |
37
+ Name | Type | Description | Notes
38
+ ------------- | ------------- | ------------- | -------------
39
+ **app_id** | **String**| The app where the templates belong to. |
40
+ **code** | **String**| The template code to delete. |
61
41
 
62
42
  ### Return type
63
43
 
@@ -69,65 +49,46 @@ No authorization required
69
49
 
70
50
  ### HTTP request headers
71
51
 
72
- - **Content-Type**: Not defined
73
- - **Accept**: application/json
52
+ - **Content-Type**: Not defined
53
+ - **Accept**: application/json
74
54
 
75
55
 
76
- ## templates_get_templates
77
56
 
78
- > <ListResponseDtoOfTemplateDto> templates_get_templates(app_id, opts)
57
+ # **templates_get_templates**
58
+ > ListResponseDtoOfTemplateDto templates_get_templates(app_id, opts)
79
59
 
80
60
  Query templates.
81
61
 
82
- ### Examples
83
-
62
+ ### Example
84
63
  ```ruby
85
- require 'time'
64
+ # load the gem
86
65
  require 'notifo'
87
66
 
88
67
  api_instance = Notifo::TemplatesApi.new
89
68
  app_id = 'app_id_example' # String | The app where the templates belongs to.
90
- opts = {
69
+ opts = {
91
70
  query: 'query_example', # String | The optional query to search for items.
92
71
  take: 56, # Integer | The number of items to return.
93
72
  skip: 56 # Integer | The number of items to skip.
94
73
  }
95
74
 
96
75
  begin
97
- # Query templates.
76
+ #Query templates.
98
77
  result = api_instance.templates_get_templates(app_id, opts)
99
78
  p result
100
79
  rescue Notifo::ApiError => e
101
- puts "Error when calling TemplatesApi->templates_get_templates: #{e}"
102
- end
103
- ```
104
-
105
- #### Using the templates_get_templates_with_http_info variant
106
-
107
- This returns an Array which contains the response data, status code and headers.
108
-
109
- > <Array(<ListResponseDtoOfTemplateDto>, Integer, Hash)> templates_get_templates_with_http_info(app_id, opts)
110
-
111
- ```ruby
112
- begin
113
- # Query templates.
114
- data, status_code, headers = api_instance.templates_get_templates_with_http_info(app_id, opts)
115
- p status_code # => 2xx
116
- p headers # => { ... }
117
- p data # => <ListResponseDtoOfTemplateDto>
118
- rescue Notifo::ApiError => e
119
- puts "Error when calling TemplatesApi->templates_get_templates_with_http_info: #{e}"
80
+ puts "Exception when calling TemplatesApi->templates_get_templates: #{e}"
120
81
  end
121
82
  ```
122
83
 
123
84
  ### Parameters
124
85
 
125
- | Name | Type | Description | Notes |
126
- | ---- | ---- | ----------- | ----- |
127
- | **app_id** | **String** | The app where the templates belongs to. | |
128
- | **query** | **String** | The optional query to search for items. | [optional] |
129
- | **take** | **Integer** | The number of items to return. | [optional] |
130
- | **skip** | **Integer** | The number of items to skip. | [optional] |
86
+ Name | Type | Description | Notes
87
+ ------------- | ------------- | ------------- | -------------
88
+ **app_id** | **String**| The app where the templates belongs to. |
89
+ **query** | **String**| The optional query to search for items. | [optional]
90
+ **take** | **Integer**| The number of items to return. | [optional]
91
+ **skip** | **Integer**| The number of items to skip. | [optional]
131
92
 
132
93
  ### Return type
133
94
 
@@ -139,59 +100,41 @@ No authorization required
139
100
 
140
101
  ### HTTP request headers
141
102
 
142
- - **Content-Type**: Not defined
143
- - **Accept**: application/json
103
+ - **Content-Type**: Not defined
104
+ - **Accept**: application/json
144
105
 
145
106
 
146
- ## templates_post_templates
147
107
 
148
- > <Array<TemplateDto>> templates_post_templates(app_id, upsert_templates_dto)
108
+ # **templates_post_templates**
109
+ > Array&lt;TemplateDto&gt; templates_post_templates(bodyapp_id)
149
110
 
150
111
  Upsert templates.
151
112
 
152
- ### Examples
153
-
113
+ ### Example
154
114
  ```ruby
155
- require 'time'
115
+ # load the gem
156
116
  require 'notifo'
157
117
 
158
118
  api_instance = Notifo::TemplatesApi.new
119
+ body = Notifo::UpsertTemplatesDto.new # UpsertTemplatesDto | The upsert request.
159
120
  app_id = 'app_id_example' # String | The app where the templates belong to.
160
- upsert_templates_dto = Notifo::UpsertTemplatesDto.new # UpsertTemplatesDto | The upsert request.
161
-
162
- begin
163
- # Upsert templates.
164
- result = api_instance.templates_post_templates(app_id, upsert_templates_dto)
165
- p result
166
- rescue Notifo::ApiError => e
167
- puts "Error when calling TemplatesApi->templates_post_templates: #{e}"
168
- end
169
- ```
170
-
171
- #### Using the templates_post_templates_with_http_info variant
172
-
173
- This returns an Array which contains the response data, status code and headers.
174
121
 
175
- > <Array(<Array<TemplateDto>>, Integer, Hash)> templates_post_templates_with_http_info(app_id, upsert_templates_dto)
176
122
 
177
- ```ruby
178
123
  begin
179
- # Upsert templates.
180
- data, status_code, headers = api_instance.templates_post_templates_with_http_info(app_id, upsert_templates_dto)
181
- p status_code # => 2xx
182
- p headers # => { ... }
183
- p data # => <Array<TemplateDto>>
124
+ #Upsert templates.
125
+ result = api_instance.templates_post_templates(bodyapp_id)
126
+ p result
184
127
  rescue Notifo::ApiError => e
185
- puts "Error when calling TemplatesApi->templates_post_templates_with_http_info: #{e}"
128
+ puts "Exception when calling TemplatesApi->templates_post_templates: #{e}"
186
129
  end
187
130
  ```
188
131
 
189
132
  ### Parameters
190
133
 
191
- | Name | Type | Description | Notes |
192
- | ---- | ---- | ----------- | ----- |
193
- | **app_id** | **String** | The app where the templates belong to. | |
194
- | **upsert_templates_dto** | [**UpsertTemplatesDto**](UpsertTemplatesDto.md) | The upsert request. | |
134
+ Name | Type | Description | Notes
135
+ ------------- | ------------- | ------------- | -------------
136
+ **body** | [**UpsertTemplatesDto**](UpsertTemplatesDto.md)| The upsert request. |
137
+ **app_id** | **String**| The app where the templates belong to. |
195
138
 
196
139
  ### Return type
197
140
 
@@ -203,6 +146,8 @@ No authorization required
203
146
 
204
147
  ### HTTP request headers
205
148
 
206
- - **Content-Type**: application/json
207
- - **Accept**: application/json
149
+ - **Content-Type**: application/json
150
+ - **Accept**: application/json
151
+
152
+
208
153
 
data/docs/TopicDto.md CHANGED
@@ -1,22 +1,9 @@
1
1
  # Notifo::TopicDto
2
2
 
3
3
  ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **path** | **String** | The topic path. | [optional] |
8
- | **last_update** | **Time** | THe last update to the topic. | [optional] |
9
- | **counters** | [**OneOfmap**](OneOfmap.md) | The statistics counters. | [optional] |
10
-
11
- ## Example
12
-
13
- ```ruby
14
- require 'notifo'
15
-
16
- instance = Notifo::TopicDto.new(
17
- path: null,
18
- last_update: null,
19
- counters: null
20
- )
21
- ```
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **path** | **String** | The topic path. |
7
+ **last_update** | **DateTime** | THe last update to the topic. |
8
+ **counters** | **Hash&lt;String, Integer&gt;** | The statistics counters. |
22
9