notifo-io-easierlife 1.0.0 → 1.0.1.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (193) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +599 -97
  3. data/Rakefile +0 -2
  4. data/docs/AddAllowedTopicDto.md +4 -15
  5. data/docs/AddContributorDto.md +5 -17
  6. data/docs/AppContributorDto.md +6 -19
  7. data/docs/AppDetailsDto.md +19 -45
  8. data/docs/AppDto.md +9 -25
  9. data/docs/AppsApi.md +181 -363
  10. data/docs/Body.md +7 -0
  11. data/docs/ConfigsApi.md +28 -68
  12. data/docs/ConfirmMode.md +3 -12
  13. data/docs/CreateEmailTemplateDto.md +4 -15
  14. data/docs/EmailTemplateDto.md +6 -19
  15. data/docs/EmailTemplatesDto.md +6 -0
  16. data/docs/EmailVerificationStatus.md +3 -12
  17. data/docs/ErrorDto.md +8 -23
  18. data/docs/EventDto.md +15 -37
  19. data/docs/EventProperties.md +6 -0
  20. data/docs/EventsApi.md +43 -80
  21. data/docs/IsoDayOfWeek.md +3 -12
  22. data/docs/ListResponseDtoOfEventDto.md +5 -17
  23. data/docs/ListResponseDtoOfLogEntryDto.md +5 -17
  24. data/docs/ListResponseDtoOfMediaDto.md +5 -17
  25. data/docs/ListResponseDtoOfSubscriptionDto.md +5 -17
  26. data/docs/ListResponseDtoOfTemplateDto.md +5 -17
  27. data/docs/ListResponseDtoOfTopicDto.md +5 -17
  28. data/docs/ListResponseDtoOfUserDto.md +5 -17
  29. data/docs/LocalizedText.md +6 -0
  30. data/docs/LogEntryDto.md +7 -21
  31. data/docs/LogsApi.md +25 -44
  32. data/docs/MediaApi.md +118 -212
  33. data/docs/MediaDto.md +10 -27
  34. data/docs/MediaMetadata.md +6 -0
  35. data/docs/MediaType.md +3 -12
  36. data/docs/NotificationFormattingDto.md +11 -29
  37. data/docs/NotificationSend.md +3 -12
  38. data/docs/NotificationSettingDto.md +5 -17
  39. data/docs/ProfileDto.md +11 -29
  40. data/docs/PublishDto.md +13 -33
  41. data/docs/PublishManyDto.md +4 -15
  42. data/docs/ResizeMode.md +3 -12
  43. data/docs/SchedulingDto.md +7 -21
  44. data/docs/SchedulingType.md +3 -12
  45. data/docs/SubscriptionDto.md +5 -17
  46. data/docs/TemplateDto.md +6 -19
  47. data/docs/TemplatesApi.md +61 -116
  48. data/docs/TopicDto.md +6 -19
  49. data/docs/TopicsApi.md +25 -44
  50. data/docs/UpdateProfileDto.md +9 -25
  51. data/docs/UpsertAppDto.md +13 -33
  52. data/docs/UpsertTemplateDto.md +6 -19
  53. data/docs/UpsertTemplatesDto.md +4 -15
  54. data/docs/UpsertUserDto.md +11 -29
  55. data/docs/UpsertUsersDto.md +4 -15
  56. data/docs/UserApi.md +84 -176
  57. data/docs/UserDto.md +13 -33
  58. data/docs/UsersApi.md +173 -337
  59. data/git_push.sh +7 -10
  60. data/lib/swagger_client.rb +93 -0
  61. data/lib/{notifo → swagger_client}/api/apps_api.rb +131 -203
  62. data/lib/{notifo → swagger_client}/api/configs_api.rb +15 -31
  63. data/lib/{notifo → swagger_client}/api/events_api.rb +30 -46
  64. data/lib/{notifo → swagger_client}/api/logs_api.rb +13 -22
  65. data/lib/{notifo → swagger_client}/api/media_api.rb +61 -98
  66. data/lib/{notifo → swagger_client}/api/templates_api.rb +40 -63
  67. data/lib/{notifo → swagger_client}/api/topics_api.rb +13 -22
  68. data/lib/{notifo → swagger_client}/api/user_api.rb +52 -89
  69. data/lib/{notifo → swagger_client}/api/users_api.rb +122 -187
  70. data/lib/{notifo → swagger_client}/api_client.rb +55 -57
  71. data/lib/{notifo → swagger_client}/api_error.rb +6 -6
  72. data/lib/{notifo → swagger_client}/configuration.rb +12 -84
  73. data/lib/{notifo → swagger_client}/models/add_allowed_topic_dto.rb +16 -47
  74. data/lib/swagger_client/models/add_contributor_dto.rb +227 -0
  75. data/lib/swagger_client/models/app_contributor_dto.rb +242 -0
  76. data/lib/{notifo → swagger_client}/models/app_details_dto.rb +31 -106
  77. data/lib/{notifo → swagger_client}/models/app_dto.rb +21 -90
  78. data/lib/swagger_client/models/body.rb +206 -0
  79. data/lib/swagger_client/models/confirm_mode.rb +29 -0
  80. data/lib/{notifo → swagger_client}/models/create_email_template_dto.rb +16 -47
  81. data/lib/swagger_client/models/email_template_dto.rb +237 -0
  82. data/lib/swagger_client/models/email_templates_dto.rb +201 -0
  83. data/lib/swagger_client/models/email_verification_status.rb +30 -0
  84. data/lib/{notifo → swagger_client}/models/error_dto.rb +20 -36
  85. data/lib/{notifo → swagger_client}/models/event_dto.rb +27 -117
  86. data/lib/swagger_client/models/event_properties.rb +201 -0
  87. data/lib/swagger_client/models/iso_day_of_week.rb +34 -0
  88. data/lib/{notifo/models/list_response_dto_of_subscription_dto.rb → swagger_client/models/list_response_dto_of_event_dto.rb} +18 -30
  89. data/lib/{notifo → swagger_client}/models/list_response_dto_of_log_entry_dto.rb +17 -29
  90. data/lib/{notifo → swagger_client}/models/list_response_dto_of_media_dto.rb +17 -29
  91. data/lib/{notifo/models/list_response_dto_of_event_dto.rb → swagger_client/models/list_response_dto_of_subscription_dto.rb} +18 -30
  92. data/lib/{notifo → swagger_client}/models/list_response_dto_of_template_dto.rb +17 -29
  93. data/lib/{notifo → swagger_client}/models/list_response_dto_of_topic_dto.rb +17 -29
  94. data/lib/{notifo → swagger_client}/models/list_response_dto_of_user_dto.rb +17 -29
  95. data/lib/swagger_client/models/localized_text.rb +201 -0
  96. data/lib/{notifo → swagger_client}/models/log_entry_dto.rb +19 -88
  97. data/lib/{notifo → swagger_client}/models/media_dto.rb +23 -113
  98. data/lib/swagger_client/models/media_metadata.rb +201 -0
  99. data/lib/swagger_client/models/media_type.rb +30 -0
  100. data/lib/{notifo → swagger_client}/models/notification_formatting_dto.rb +30 -56
  101. data/lib/swagger_client/models/notification_send.rb +30 -0
  102. data/lib/{notifo → swagger_client}/models/notification_setting_dto.rb +26 -39
  103. data/lib/{notifo → swagger_client}/models/profile_dto.rb +23 -76
  104. data/lib/{notifo → swagger_client}/models/publish_dto.rb +26 -63
  105. data/lib/{notifo → swagger_client}/models/publish_many_dto.rb +16 -28
  106. data/lib/swagger_client/models/resize_mode.rb +33 -0
  107. data/lib/{notifo → swagger_client}/models/scheduling_dto.rb +19 -32
  108. data/lib/swagger_client/models/scheduling_type.rb +28 -0
  109. data/lib/{notifo → swagger_client}/models/subscription_dto.rb +17 -49
  110. data/lib/{notifo → swagger_client}/models/template_dto.rb +18 -49
  111. data/lib/{notifo → swagger_client}/models/topic_dto.rb +18 -68
  112. data/lib/{notifo → swagger_client}/models/update_profile_dto.rb +21 -39
  113. data/lib/{notifo → swagger_client}/models/upsert_app_dto.rb +25 -47
  114. data/lib/{notifo → swagger_client}/models/upsert_template_dto.rb +18 -50
  115. data/lib/{notifo → swagger_client}/models/upsert_templates_dto.rb +16 -28
  116. data/lib/{notifo → swagger_client}/models/upsert_user_dto.rb +23 -43
  117. data/lib/{notifo → swagger_client}/models/upsert_users_dto.rb +16 -28
  118. data/lib/{notifo → swagger_client}/models/user_dto.rb +25 -80
  119. data/lib/swagger_client/version.rb +14 -0
  120. data/spec/api/apps_api_spec.rb +14 -15
  121. data/spec/api/configs_api_spec.rb +8 -9
  122. data/spec/api/events_api_spec.rb +9 -10
  123. data/spec/api/logs_api_spec.rb +8 -9
  124. data/spec/api/media_api_spec.rb +13 -14
  125. data/spec/api/templates_api_spec.rb +9 -10
  126. data/spec/api/topics_api_spec.rb +8 -9
  127. data/spec/api/user_api_spec.rb +10 -11
  128. data/spec/api/users_api_spec.rb +11 -12
  129. data/spec/api_client_spec.rb +34 -35
  130. data/spec/base_object_spec.rb +109 -0
  131. data/spec/configuration_spec.rb +7 -8
  132. data/spec/models/add_allowed_topic_dto_spec.rb +16 -10
  133. data/spec/models/add_contributor_dto_spec.rb +16 -10
  134. data/spec/models/app_contributor_dto_spec.rb +16 -10
  135. data/spec/models/app_details_dto_spec.rb +16 -10
  136. data/spec/models/app_dto_spec.rb +16 -10
  137. data/spec/models/body_spec.rb +40 -0
  138. data/spec/models/confirm_mode_spec.rb +16 -10
  139. data/spec/models/create_email_template_dto_spec.rb +16 -10
  140. data/spec/models/email_template_dto_spec.rb +16 -10
  141. data/spec/models/email_templates_dto_spec.rb +34 -0
  142. data/spec/models/email_verification_status_spec.rb +16 -10
  143. data/spec/models/error_dto_spec.rb +16 -10
  144. data/spec/models/event_dto_spec.rb +16 -10
  145. data/spec/models/event_properties_spec.rb +34 -0
  146. data/spec/models/iso_day_of_week_spec.rb +16 -10
  147. data/spec/models/list_response_dto_of_event_dto_spec.rb +16 -10
  148. data/spec/models/list_response_dto_of_log_entry_dto_spec.rb +16 -10
  149. data/spec/models/list_response_dto_of_media_dto_spec.rb +16 -10
  150. data/spec/models/list_response_dto_of_subscription_dto_spec.rb +16 -10
  151. data/spec/models/list_response_dto_of_template_dto_spec.rb +16 -10
  152. data/spec/models/list_response_dto_of_topic_dto_spec.rb +16 -10
  153. data/spec/models/list_response_dto_of_user_dto_spec.rb +16 -10
  154. data/spec/models/localized_text_spec.rb +34 -0
  155. data/spec/models/log_entry_dto_spec.rb +16 -10
  156. data/spec/models/media_dto_spec.rb +16 -10
  157. data/spec/models/media_metadata_spec.rb +34 -0
  158. data/spec/models/media_type_spec.rb +16 -10
  159. data/spec/models/notification_formatting_dto_spec.rb +16 -10
  160. data/spec/models/notification_send_spec.rb +16 -10
  161. data/spec/models/notification_setting_dto_spec.rb +17 -11
  162. data/spec/models/profile_dto_spec.rb +16 -10
  163. data/spec/models/publish_dto_spec.rb +16 -10
  164. data/spec/models/publish_many_dto_spec.rb +16 -10
  165. data/spec/models/resize_mode_spec.rb +16 -10
  166. data/spec/models/scheduling_dto_spec.rb +16 -10
  167. data/spec/models/scheduling_type_spec.rb +16 -10
  168. data/spec/models/subscription_dto_spec.rb +16 -10
  169. data/spec/models/template_dto_spec.rb +16 -10
  170. data/spec/models/topic_dto_spec.rb +16 -10
  171. data/spec/models/update_profile_dto_spec.rb +16 -10
  172. data/spec/models/upsert_app_dto_spec.rb +16 -10
  173. data/spec/models/upsert_template_dto_spec.rb +16 -10
  174. data/spec/models/upsert_templates_dto_spec.rb +16 -10
  175. data/spec/models/upsert_user_dto_spec.rb +16 -10
  176. data/spec/models/upsert_users_dto_spec.rb +16 -10
  177. data/spec/models/user_dto_spec.rb +16 -10
  178. data/spec/spec_helper.rb +5 -6
  179. data/{notifo.gemspec → swagger_client.gemspec} +9 -9
  180. metadata +101 -60
  181. data/lib/notifo.rb +0 -89
  182. data/lib/notifo/models/add_contributor_dto.rb +0 -277
  183. data/lib/notifo/models/app_contributor_dto.rb +0 -311
  184. data/lib/notifo/models/confirm_mode.rb +0 -38
  185. data/lib/notifo/models/email_template_dto.rb +0 -288
  186. data/lib/notifo/models/email_verification_status.rb +0 -39
  187. data/lib/notifo/models/iso_day_of_week.rb +0 -43
  188. data/lib/notifo/models/media_type.rb +0 -39
  189. data/lib/notifo/models/notification_send.rb +0 -39
  190. data/lib/notifo/models/resize_mode.rb +0 -42
  191. data/lib/notifo/models/scheduling_type.rb +0 -37
  192. data/lib/notifo/version.rb +0 -15
  193. data/notifo-io-1.0.0.gem +0 -0
data/docs/Body.md ADDED
@@ -0,0 +1,7 @@
1
+ # SwaggerClient::Body
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **file** | **String** | | [optional]
7
+
data/docs/ConfigsApi.md CHANGED
@@ -1,56 +1,34 @@
1
- # Notifo::ConfigsApi
1
+ # SwaggerClient::ConfigsApi
2
2
 
3
- All URIs are relative to *https://notifo.easierlife.com*
3
+ All URIs are relative to *https://app.notifo.io*
4
4
 
5
- | Method | HTTP request | Description |
6
- | ------ | ------------ | ----------- |
7
- | [**configs_get_languages**](ConfigsApi.md#configs_get_languages) | **GET** /api/languages | Get all supported languages. |
8
- | [**configs_get_timezones**](ConfigsApi.md#configs_get_timezones) | **GET** /api/timezones | Get all supported timezones. |
9
-
10
-
11
- ## configs_get_languages
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**configs_get_languages**](ConfigsApi.md#configs_get_languages) | **GET** /api/languages | Get all supported languages.
8
+ [**configs_get_timezones**](ConfigsApi.md#configs_get_timezones) | **GET** /api/timezones | Get all supported timezones.
12
9
 
10
+ # **configs_get_languages**
13
11
  > Array<String> configs_get_languages
14
12
 
15
13
  Get all supported languages.
16
14
 
17
- ### Examples
18
-
15
+ ### Example
19
16
  ```ruby
20
- require 'time'
21
- require 'notifo'
17
+ # load the gem
18
+ require 'swagger_client'
22
19
 
23
- api_instance = Notifo::ConfigsApi.new
20
+ api_instance = SwaggerClient::ConfigsApi.new
24
21
 
25
22
  begin
26
- # Get all supported languages.
23
+ #Get all supported languages.
27
24
  result = api_instance.configs_get_languages
28
25
  p result
29
- rescue Notifo::ApiError => e
30
- puts "Error when calling ConfigsApi->configs_get_languages: #{e}"
31
- end
32
- ```
33
-
34
- #### Using the configs_get_languages_with_http_info variant
35
-
36
- This returns an Array which contains the response data, status code and headers.
37
-
38
- > <Array(Array&lt;String&gt;, Integer, Hash)> configs_get_languages_with_http_info
39
-
40
- ```ruby
41
- begin
42
- # Get all supported languages.
43
- data, status_code, headers = api_instance.configs_get_languages_with_http_info
44
- p status_code # => 2xx
45
- p headers # => { ... }
46
- p data # => Array&lt;String&gt;
47
- rescue Notifo::ApiError => e
48
- puts "Error when calling ConfigsApi->configs_get_languages_with_http_info: #{e}"
26
+ rescue SwaggerClient::ApiError => e
27
+ puts "Exception when calling ConfigsApi->configs_get_languages: #{e}"
49
28
  end
50
29
  ```
51
30
 
52
31
  ### Parameters
53
-
54
32
  This endpoint does not need any parameter.
55
33
 
56
34
  ### Return type
@@ -63,53 +41,33 @@ No authorization required
63
41
 
64
42
  ### HTTP request headers
65
43
 
66
- - **Content-Type**: Not defined
67
- - **Accept**: application/json
44
+ - **Content-Type**: Not defined
45
+ - **Accept**: application/json
68
46
 
69
47
 
70
- ## configs_get_timezones
71
48
 
49
+ # **configs_get_timezones**
72
50
  > Array&lt;String&gt; configs_get_timezones
73
51
 
74
52
  Get all supported timezones.
75
53
 
76
- ### Examples
77
-
54
+ ### Example
78
55
  ```ruby
79
- require 'time'
80
- require 'notifo'
56
+ # load the gem
57
+ require 'swagger_client'
81
58
 
82
- api_instance = Notifo::ConfigsApi.new
59
+ api_instance = SwaggerClient::ConfigsApi.new
83
60
 
84
61
  begin
85
- # Get all supported timezones.
62
+ #Get all supported timezones.
86
63
  result = api_instance.configs_get_timezones
87
64
  p result
88
- rescue Notifo::ApiError => e
89
- puts "Error when calling ConfigsApi->configs_get_timezones: #{e}"
90
- end
91
- ```
92
-
93
- #### Using the configs_get_timezones_with_http_info variant
94
-
95
- This returns an Array which contains the response data, status code and headers.
96
-
97
- > <Array(Array&lt;String&gt;, Integer, Hash)> configs_get_timezones_with_http_info
98
-
99
- ```ruby
100
- begin
101
- # Get all supported timezones.
102
- data, status_code, headers = api_instance.configs_get_timezones_with_http_info
103
- p status_code # => 2xx
104
- p headers # => { ... }
105
- p data # => Array&lt;String&gt;
106
- rescue Notifo::ApiError => e
107
- puts "Error when calling ConfigsApi->configs_get_timezones_with_http_info: #{e}"
65
+ rescue SwaggerClient::ApiError => e
66
+ puts "Exception when calling ConfigsApi->configs_get_timezones: #{e}"
108
67
  end
109
68
  ```
110
69
 
111
70
  ### Parameters
112
-
113
71
  This endpoint does not need any parameter.
114
72
 
115
73
  ### Return type
@@ -122,6 +80,8 @@ No authorization required
122
80
 
123
81
  ### HTTP request headers
124
82
 
125
- - **Content-Type**: Not defined
126
- - **Accept**: application/json
83
+ - **Content-Type**: Not defined
84
+ - **Accept**: application/json
85
+
86
+
127
87
 
data/docs/ConfirmMode.md CHANGED
@@ -1,15 +1,6 @@
1
- # Notifo::ConfirmMode
1
+ # SwaggerClient::ConfirmMode
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::ConfirmMode.new()
14
- ```
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
15
6
 
@@ -1,18 +1,7 @@
1
- # Notifo::CreateEmailTemplateDto
1
+ # SwaggerClient::CreateEmailTemplateDto
2
2
 
3
3
  ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **language** | **String** | The new language. | |
8
-
9
- ## Example
10
-
11
- ```ruby
12
- require 'notifo'
13
-
14
- instance = Notifo::CreateEmailTemplateDto.new(
15
- language: null
16
- )
17
- ```
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **language** | **String** | The new language. |
18
7
 
@@ -1,22 +1,9 @@
1
- # Notifo::EmailTemplateDto
1
+ # SwaggerClient::EmailTemplateDto
2
2
 
3
3
  ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **subject** | **String** | The subject text. | |
8
- | **body_html** | **String** | The body html template. | |
9
- | **body_text** | **String** | The body text template. | [optional] |
10
-
11
- ## Example
12
-
13
- ```ruby
14
- require 'notifo'
15
-
16
- instance = Notifo::EmailTemplateDto.new(
17
- subject: null,
18
- body_html: null,
19
- body_text: null
20
- )
21
- ```
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **subject** | **String** | The subject text. |
7
+ **body_html** | **String** | The body html template. |
8
+ **body_text** | **String** | The body text template. | [optional]
22
9
 
@@ -0,0 +1,6 @@
1
+ # SwaggerClient::EmailTemplatesDto
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+
@@ -1,15 +1,6 @@
1
- # Notifo::EmailVerificationStatus
1
+ # SwaggerClient::EmailVerificationStatus
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::EmailVerificationStatus.new()
14
- ```
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
15
6
 
data/docs/ErrorDto.md CHANGED
@@ -1,26 +1,11 @@
1
- # Notifo::ErrorDto
1
+ # SwaggerClient::ErrorDto
2
2
 
3
3
  ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **message** | **String** | The error message. | [optional] |
8
- | **trace_id** | **String** | The optional trace id. | [optional] |
9
- | **type** | **String** | The error type, usually a link. | [optional] |
10
- | **details** | **Array&lt;String&gt;** | Detailed error messages. | [optional] |
11
- | **status_code** | **Integer** | Status code of the http response. | [optional] |
12
-
13
- ## Example
14
-
15
- ```ruby
16
- require 'notifo'
17
-
18
- instance = Notifo::ErrorDto.new(
19
- message: null,
20
- trace_id: null,
21
- type: null,
22
- details: null,
23
- status_code: null
24
- )
25
- ```
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **message** | **String** | The error message. | [optional]
7
+ **trace_id** | **String** | The optional trace id. | [optional]
8
+ **type** | **String** | The error type, usually a link. | [optional]
9
+ **details** | **Array&lt;String&gt;** | Detailed error messages. | [optional]
10
+ **status_code** | **Integer** | Status code of the http response. | [optional]
26
11
 
data/docs/EventDto.md CHANGED
@@ -1,40 +1,18 @@
1
- # Notifo::EventDto
1
+ # SwaggerClient::EventDto
2
2
 
3
3
  ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **id** | **String** | The id of the event. | |
8
- | **topic** | **String** | The topic path. | |
9
- | **creator_id** | **String** | A custom id to identity the creator. | [optional] |
10
- | **display_name** | **String** | The display name. | |
11
- | **data** | **String** | Additional user defined data. | [optional] |
12
- | **created** | **Time** | The time when the event has been created. | |
13
- | **formatting** | [**NotificationFormattingDto**](NotificationFormattingDto.md) | | |
14
- | **settings** | [**Hash&lt;String, NotificationSettingDto&gt;**](NotificationSettingDto.md) | Notification settings per channel. | |
15
- | **properties** | **Hash&lt;String, String&gt;** | User defined properties. | |
16
- | **scheduling** | [**SchedulingDto**](SchedulingDto.md) | | [optional] |
17
- | **counters** | **Hash&lt;String, Integer&gt;** | The statistics counters. | |
18
- | **silent** | **Boolean** | True when silent. | |
19
-
20
- ## Example
21
-
22
- ```ruby
23
- require 'notifo'
24
-
25
- instance = Notifo::EventDto.new(
26
- id: null,
27
- topic: null,
28
- creator_id: null,
29
- display_name: null,
30
- data: null,
31
- created: null,
32
- formatting: null,
33
- settings: null,
34
- properties: null,
35
- scheduling: null,
36
- counters: null,
37
- silent: null
38
- )
39
- ```
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **String** | The id of the event. |
7
+ **topic** | **String** | The topic path. |
8
+ **creator_id** | **String** | A custom id to identity the creator. | [optional]
9
+ **display_name** | **String** | The display name. |
10
+ **data** | **String** | Additional user defined data. | [optional]
11
+ **created** | **DateTime** | The time when the event has been created. |
12
+ **formatting** | [**NotificationFormattingDto**](NotificationFormattingDto.md) | |
13
+ **settings** | [**Hash&lt;String, NotificationSettingDto&gt;**](NotificationSettingDto.md) | Notification settings per channel. |
14
+ **properties** | **Hash&lt;String, String&gt;** | User defined properties. |
15
+ **scheduling** | [**SchedulingDto**](SchedulingDto.md) | | [optional]
16
+ **counters** | **Hash&lt;String, Integer&gt;** | The statistics counters. |
17
+ **silent** | **BOOLEAN** | True when silent. |
40
18
 
@@ -0,0 +1,6 @@
1
+ # SwaggerClient::EventProperties
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+
data/docs/EventsApi.md CHANGED
@@ -1,68 +1,47 @@
1
- # Notifo::EventsApi
1
+ # SwaggerClient::EventsApi
2
2
 
3
- All URIs are relative to *https://notifo.easierlife.com*
3
+ All URIs are relative to *https://app.notifo.io*
4
4
 
5
- | Method | HTTP request | Description |
6
- | ------ | ------------ | ----------- |
7
- | [**events_get_events**](EventsApi.md#events_get_events) | **GET** /api/apps/{appId}/events | Query events. |
8
- | [**events_post_events**](EventsApi.md#events_post_events) | **POST** /api/apps/{appId}/events | Publish events. |
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**events_get_events**](EventsApi.md#events_get_events) | **GET** /api/apps/{appId}/events | Query events.
8
+ [**events_post_events**](EventsApi.md#events_post_events) | **POST** /api/apps/{appId}/events | Publish events.
9
9
 
10
-
11
- ## events_get_events
12
-
13
- > <ListResponseDtoOfEventDto> events_get_events(app_id, opts)
10
+ # **events_get_events**
11
+ > ListResponseDtoOfEventDto events_get_events(app_id, opts)
14
12
 
15
13
  Query events.
16
14
 
17
- ### Examples
18
-
15
+ ### Example
19
16
  ```ruby
20
- require 'time'
21
- require 'notifo'
17
+ # load the gem
18
+ require 'swagger_client'
22
19
 
23
- api_instance = Notifo::EventsApi.new
20
+ api_instance = SwaggerClient::EventsApi.new
24
21
  app_id = 'app_id_example' # String | The app where the events belongs to.
25
- opts = {
22
+ opts = {
26
23
  query: 'query_example', # String | The optional query to search for items.
27
24
  take: 56, # Integer | The number of items to return.
28
25
  skip: 56 # Integer | The number of items to skip.
29
26
  }
30
27
 
31
28
  begin
32
- # Query events.
29
+ #Query events.
33
30
  result = api_instance.events_get_events(app_id, opts)
34
31
  p result
35
- rescue Notifo::ApiError => e
36
- puts "Error when calling EventsApi->events_get_events: #{e}"
37
- end
38
- ```
39
-
40
- #### Using the events_get_events_with_http_info variant
41
-
42
- This returns an Array which contains the response data, status code and headers.
43
-
44
- > <Array(<ListResponseDtoOfEventDto>, Integer, Hash)> events_get_events_with_http_info(app_id, opts)
45
-
46
- ```ruby
47
- begin
48
- # Query events.
49
- data, status_code, headers = api_instance.events_get_events_with_http_info(app_id, opts)
50
- p status_code # => 2xx
51
- p headers # => { ... }
52
- p data # => <ListResponseDtoOfEventDto>
53
- rescue Notifo::ApiError => e
54
- puts "Error when calling EventsApi->events_get_events_with_http_info: #{e}"
32
+ rescue SwaggerClient::ApiError => e
33
+ puts "Exception when calling EventsApi->events_get_events: #{e}"
55
34
  end
56
35
  ```
57
36
 
58
37
  ### Parameters
59
38
 
60
- | Name | Type | Description | Notes |
61
- | ---- | ---- | ----------- | ----- |
62
- | **app_id** | **String** | The app where the events belongs to. | |
63
- | **query** | **String** | The optional query to search for items. | [optional] |
64
- | **take** | **Integer** | The number of items to return. | [optional] |
65
- | **skip** | **Integer** | The number of items to skip. | [optional] |
39
+ Name | Type | Description | Notes
40
+ ------------- | ------------- | ------------- | -------------
41
+ **app_id** | **String**| The app where the events belongs to. |
42
+ **query** | **String**| The optional query to search for items. | [optional]
43
+ **take** | **Integer**| The number of items to return. | [optional]
44
+ **skip** | **Integer**| The number of items to skip. | [optional]
66
45
 
67
46
  ### Return type
68
47
 
@@ -74,58 +53,40 @@ No authorization required
74
53
 
75
54
  ### HTTP request headers
76
55
 
77
- - **Content-Type**: Not defined
78
- - **Accept**: application/json
56
+ - **Content-Type**: Not defined
57
+ - **Accept**: application/json
79
58
 
80
59
 
81
- ## events_post_events
82
60
 
83
- > events_post_events(app_id, publish_many_dto)
61
+ # **events_post_events**
62
+ > events_post_events(bodyapp_id)
84
63
 
85
64
  Publish events.
86
65
 
87
- ### Examples
88
-
66
+ ### Example
89
67
  ```ruby
90
- require 'time'
91
- require 'notifo'
68
+ # load the gem
69
+ require 'swagger_client'
92
70
 
93
- api_instance = Notifo::EventsApi.new
71
+ api_instance = SwaggerClient::EventsApi.new
72
+ body = SwaggerClient::PublishManyDto.new # PublishManyDto | The publish request.
94
73
  app_id = 'app_id_example' # String | The app where the events belongs to.
95
- publish_many_dto = Notifo::PublishManyDto.new({requests: [Notifo::PublishDto.new({topic: 'topic_example'})]}) # PublishManyDto | The publish request.
96
-
97
- begin
98
- # Publish events.
99
- api_instance.events_post_events(app_id, publish_many_dto)
100
- rescue Notifo::ApiError => e
101
- puts "Error when calling EventsApi->events_post_events: #{e}"
102
- end
103
- ```
104
74
 
105
- #### Using the events_post_events_with_http_info variant
106
75
 
107
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
108
-
109
- > <Array(nil, Integer, Hash)> events_post_events_with_http_info(app_id, publish_many_dto)
110
-
111
- ```ruby
112
76
  begin
113
- # Publish events.
114
- data, status_code, headers = api_instance.events_post_events_with_http_info(app_id, publish_many_dto)
115
- p status_code # => 2xx
116
- p headers # => { ... }
117
- p data # => nil
118
- rescue Notifo::ApiError => e
119
- puts "Error when calling EventsApi->events_post_events_with_http_info: #{e}"
77
+ #Publish events.
78
+ api_instance.events_post_events(bodyapp_id)
79
+ rescue SwaggerClient::ApiError => e
80
+ puts "Exception when calling EventsApi->events_post_events: #{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 events belongs to. | |
128
- | **publish_many_dto** | [**PublishManyDto**](PublishManyDto.md) | The publish request. | |
86
+ Name | Type | Description | Notes
87
+ ------------- | ------------- | ------------- | -------------
88
+ **body** | [**PublishManyDto**](PublishManyDto.md)| The publish request. |
89
+ **app_id** | **String**| The app where the events belongs to. |
129
90
 
130
91
  ### Return type
131
92
 
@@ -137,6 +98,8 @@ No authorization required
137
98
 
138
99
  ### HTTP request headers
139
100
 
140
- - **Content-Type**: application/json
141
- - **Accept**: application/json
101
+ - **Content-Type**: application/json
102
+ - **Accept**: application/json
103
+
104
+
142
105