notifo-io 1.0.0.1 → 1.0.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (71) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +11 -7
  3. data/docs/{AddAllowedTopicRequest.md → AddAllowedTopicDto.md} +2 -2
  4. data/docs/AppDetailsDto.md +2 -2
  5. data/docs/AppDto.md +1 -1
  6. data/docs/EventDto.md +5 -5
  7. data/docs/EventsApi.md +6 -6
  8. data/docs/MediaApi.md +2 -2
  9. data/docs/MediaDto.md +2 -2
  10. data/docs/NotificationFormattingDto.md +8 -8
  11. data/docs/NotificationSend.md +15 -0
  12. data/docs/NotificationSettingDto.md +1 -1
  13. data/docs/ProfileDto.md +32 -0
  14. data/docs/{PublishRequestDto.md → PublishDto.md} +5 -5
  15. data/docs/PublishManyDto.md +18 -0
  16. data/docs/SchedulingDto.md +2 -2
  17. data/docs/SubscriptionDto.md +1 -1
  18. data/docs/TemplateDto.md +2 -2
  19. data/docs/TopicDto.md +1 -1
  20. data/docs/TopicsApi.md +0 -192
  21. data/docs/UpdateProfileDto.md +28 -0
  22. data/docs/UpsertTemplateDto.md +2 -2
  23. data/docs/UpsertUserDto.md +1 -1
  24. data/docs/UserApi.md +323 -0
  25. data/docs/UserDto.md +2 -2
  26. data/docs/UsersApi.md +12 -12
  27. data/lib/notifo.rb +7 -4
  28. data/lib/notifo/api/events_api.rb +9 -9
  29. data/lib/notifo/api/media_api.rb +2 -2
  30. data/lib/notifo/api/topics_api.rb +0 -189
  31. data/lib/notifo/api/user_api.rb +331 -0
  32. data/lib/notifo/api/users_api.rb +18 -18
  33. data/lib/notifo/models/{add_allowed_topic_request.rb → add_allowed_topic_dto.rb} +3 -3
  34. data/lib/notifo/models/app_details_dto.rb +5 -4
  35. data/lib/notifo/models/app_dto.rb +4 -2
  36. data/lib/notifo/models/event_dto.rb +14 -11
  37. data/lib/notifo/models/media_dto.rb +5 -5
  38. data/lib/notifo/models/notification_formatting_dto.rb +29 -29
  39. data/lib/notifo/models/notification_send.rb +39 -0
  40. data/lib/notifo/models/notification_setting_dto.rb +1 -3
  41. data/lib/notifo/models/profile_dto.rb +295 -0
  42. data/lib/notifo/models/{publish_request_dto.rb → publish_dto.rb} +10 -11
  43. data/lib/notifo/models/{publish_many_request_dto.rb → publish_many_dto.rb} +4 -4
  44. data/lib/notifo/models/scheduling_dto.rb +2 -5
  45. data/lib/notifo/models/subscription_dto.rb +5 -2
  46. data/lib/notifo/models/template_dto.rb +5 -4
  47. data/lib/notifo/models/topic_dto.rb +4 -2
  48. data/lib/notifo/models/{subscribe_dto.rb → update_profile_dto.rb} +65 -17
  49. data/lib/notifo/models/upsert_template_dto.rb +5 -4
  50. data/lib/notifo/models/upsert_user_dto.rb +4 -2
  51. data/lib/notifo/models/user_dto.rb +8 -4
  52. data/notifo-1.0.0.gem +0 -0
  53. data/notifo-io-1.0.0.gem +0 -0
  54. data/notifo.gemspec +5 -5
  55. data/spec/api/events_api_spec.rb +1 -1
  56. data/spec/api/media_api_spec.rb +1 -1
  57. data/spec/api/topics_api_spec.rb +0 -36
  58. data/spec/api/user_api_spec.rb +92 -0
  59. data/spec/api/users_api_spec.rb +2 -2
  60. data/spec/models/{add_allowed_topic_request_spec.rb → add_allowed_topic_dto_spec.rb} +6 -6
  61. data/spec/models/notification_send_spec.rb +28 -0
  62. data/spec/models/profile_dto_spec.rb +76 -0
  63. data/spec/models/{publish_request_dto_spec.rb → publish_dto_spec.rb} +6 -6
  64. data/spec/models/{publish_many_request_dto_spec.rb → publish_many_dto_spec.rb} +6 -6
  65. data/spec/models/update_profile_dto_spec.rb +64 -0
  66. metadata +35 -25
  67. data/docs/PublishManyRequestDto.md +0 -18
  68. data/docs/SubscribeDto.md +0 -20
  69. data/notifo-io-1.0.0.pre.beta.gem +0 -0
  70. data/notifo-io-1.0.0.pre.gem +0 -0
  71. data/spec/models/subscribe_dto_spec.rb +0 -40
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: dc3b0ae11de4b01d561ef71c10742e66c9606a2b58a167f39f9d3ba2ef5f6a07
4
- data.tar.gz: 8d56e7cc60d1d48e4e9898f476a177f18540aa1c9034baacfe971d49a0946de6
3
+ metadata.gz: 6e89937a4474f160aa9381708e5ba41f49efd7da61337375afcfaebfec8ae411
4
+ data.tar.gz: 4711e849d7fc679fe748cbfb8950aa4ddf279c556e46e036e7d7ec78b51e67e0
5
5
  SHA512:
6
- metadata.gz: 9aa51616191a042b6f0c8413b2536d3da606dec054c5cf9108583947ba136cf83ab65bda980d9136c1159659813d9b258a722818c34aee9d3449d835aab65350
7
- data.tar.gz: 21ee9d1caf5735d904a14d3dcc42c622a051de697a2dd2d360e72731b4c3ea6f2a14f50f9309d542437df7d9587449bbbe118c3f957a37b1aaabe7fcd976ee75
6
+ metadata.gz: 4bd4e10d54c3d7361de0e9cb502aa3b5c6e2266c0bbc75a1dc12f7fc65f1eaae062af80b1838d2c4d917031a1728a58f76841d6ccc1a121d4a5cf01e34fb3d27
7
+ data.tar.gz: 8701fd53c3dd61eba53c611721339ee7942d6957a1562c368f58bf1509818e2bcb0450ff33a892bd9a86cc0b0c761006a0e952e274e20676d884754a1ff65408
data/README.md CHANGED
@@ -98,10 +98,12 @@ Class | Method | HTTP request | Description
98
98
  *Notifo::TemplatesApi* | [**templates_delete_template**](docs/TemplatesApi.md#templates_delete_template) | **DELETE** /api/apps/{appId}/templates/{code} | Delete a template.
99
99
  *Notifo::TemplatesApi* | [**templates_get_templates**](docs/TemplatesApi.md#templates_get_templates) | **GET** /api/apps/{appId}/templates | Query templates.
100
100
  *Notifo::TemplatesApi* | [**templates_post_templates**](docs/TemplatesApi.md#templates_post_templates) | **POST** /api/apps/{appId}/templates | Upsert templates.
101
- *Notifo::TopicsApi* | [**topics_get_subscription**](docs/TopicsApi.md#topics_get_subscription) | **GET** /api/web/subscriptions/{topic} | Gets a user subscription.
102
101
  *Notifo::TopicsApi* | [**topics_get_topics**](docs/TopicsApi.md#topics_get_topics) | **GET** /api/apps/{appId}/topics | Query topics.
103
- *Notifo::TopicsApi* | [**topics_subscribe**](docs/TopicsApi.md#topics_subscribe) | **POST** /api/web/subscriptions/{topic} | Creates a user subscription.
104
- *Notifo::TopicsApi* | [**topics_unsubscribe**](docs/TopicsApi.md#topics_unsubscribe) | **DELETE** /api/web/subscriptions/{topic} | Deletes a user subscription.
102
+ *Notifo::UserApi* | [**user_delete_subscription**](docs/UserApi.md#user_delete_subscription) | **DELETE** /api/me/subscriptions/{topic} | Deletes a user subscription.
103
+ *Notifo::UserApi* | [**user_get_subscription**](docs/UserApi.md#user_get_subscription) | **GET** /api/me/subscriptions/{topic} | Gets a user subscription.
104
+ *Notifo::UserApi* | [**user_get_user**](docs/UserApi.md#user_get_user) | **GET** /api/me | Get the current user.
105
+ *Notifo::UserApi* | [**user_post_subscription**](docs/UserApi.md#user_post_subscription) | **POST** /api/me/subscriptions | Creates a user subscription.
106
+ *Notifo::UserApi* | [**user_post_user**](docs/UserApi.md#user_post_user) | **POST** /api/me | Update the user.
105
107
  *Notifo::UsersApi* | [**users_delete_allowed_topic**](docs/UsersApi.md#users_delete_allowed_topic) | **DELETE** /api/apps/{appId}/users/{id}/allowed-topics/{prefix} | Remove an allowed topic.
106
108
  *Notifo::UsersApi* | [**users_delete_subscription**](docs/UsersApi.md#users_delete_subscription) | **DELETE** /api/apps/{appId}/users/{id}/subscriptions/{prefix} | Remove a user subscriptions.
107
109
  *Notifo::UsersApi* | [**users_delete_user**](docs/UsersApi.md#users_delete_user) | **DELETE** /api/apps/{appId}/users/{id} | Delete a user.
@@ -115,7 +117,7 @@ Class | Method | HTTP request | Description
115
117
 
116
118
  ## Documentation for Models
117
119
 
118
- - [Notifo::AddAllowedTopicRequest](docs/AddAllowedTopicRequest.md)
120
+ - [Notifo::AddAllowedTopicDto](docs/AddAllowedTopicDto.md)
119
121
  - [Notifo::AddContributorDto](docs/AddContributorDto.md)
120
122
  - [Notifo::AppContributorDto](docs/AppContributorDto.md)
121
123
  - [Notifo::AppDetailsDto](docs/AppDetailsDto.md)
@@ -139,16 +141,18 @@ Class | Method | HTTP request | Description
139
141
  - [Notifo::MediaDto](docs/MediaDto.md)
140
142
  - [Notifo::MediaType](docs/MediaType.md)
141
143
  - [Notifo::NotificationFormattingDto](docs/NotificationFormattingDto.md)
144
+ - [Notifo::NotificationSend](docs/NotificationSend.md)
142
145
  - [Notifo::NotificationSettingDto](docs/NotificationSettingDto.md)
143
- - [Notifo::PublishManyRequestDto](docs/PublishManyRequestDto.md)
144
- - [Notifo::PublishRequestDto](docs/PublishRequestDto.md)
146
+ - [Notifo::ProfileDto](docs/ProfileDto.md)
147
+ - [Notifo::PublishDto](docs/PublishDto.md)
148
+ - [Notifo::PublishManyDto](docs/PublishManyDto.md)
145
149
  - [Notifo::ResizeMode](docs/ResizeMode.md)
146
150
  - [Notifo::SchedulingDto](docs/SchedulingDto.md)
147
151
  - [Notifo::SchedulingType](docs/SchedulingType.md)
148
- - [Notifo::SubscribeDto](docs/SubscribeDto.md)
149
152
  - [Notifo::SubscriptionDto](docs/SubscriptionDto.md)
150
153
  - [Notifo::TemplateDto](docs/TemplateDto.md)
151
154
  - [Notifo::TopicDto](docs/TopicDto.md)
155
+ - [Notifo::UpdateProfileDto](docs/UpdateProfileDto.md)
152
156
  - [Notifo::UpsertAppDto](docs/UpsertAppDto.md)
153
157
  - [Notifo::UpsertTemplateDto](docs/UpsertTemplateDto.md)
154
158
  - [Notifo::UpsertTemplatesDto](docs/UpsertTemplatesDto.md)
@@ -1,4 +1,4 @@
1
- # Notifo::AddAllowedTopicRequest
1
+ # Notifo::AddAllowedTopicDto
2
2
 
3
3
  ## Properties
4
4
 
@@ -11,7 +11,7 @@
11
11
  ```ruby
12
12
  require 'notifo'
13
13
 
14
- instance = Notifo::AddAllowedTopicRequest.new(
14
+ instance = Notifo::AddAllowedTopicDto.new(
15
15
  prefix: null
16
16
  )
17
17
  ```
@@ -16,10 +16,10 @@
16
16
  | **confirm_url** | **String** | The confirm URL. | [optional] |
17
17
  | **allow_email** | **Boolean** | True, when emails are allowed. | [optional] |
18
18
  | **allow_sms** | **Boolean** | True, when SMS are allowed. | [optional] |
19
- | **email_verification_status** | [**OneOfEmailVerificationStatus**](OneOfEmailVerificationStatus.md) | The verification status of the email. | [optional] |
19
+ | **email_verification_status** | [**EmailVerificationStatus**](EmailVerificationStatus.md) | | [optional] |
20
20
  | **api_keys** | **Hash<String, String>** | The api keys. | [optional] |
21
21
  | **contributors** | [**Array<AppContributorDto>**](AppContributorDto.md) | The contributors. | [optional] |
22
- | **counters** | [**OneOfmap**](OneOfmap.md) | The statistics counters. | [optional] |
22
+ | **counters** | **Hash<String, Integer>** | The statistics counters. | [optional] |
23
23
 
24
24
  ## Example
25
25
 
@@ -9,7 +9,7 @@
9
9
  | **role** | **String** | The current role. | [optional] |
10
10
  | **languages** | **Array<String>** | The supported languages. | [optional] |
11
11
  | **api_keys** | **Hash<String, String>** | The api keys. | [optional] |
12
- | **counters** | [**OneOfmap**](OneOfmap.md) | The statistics counters. | [optional] |
12
+ | **counters** | **Hash<String, Integer>** | The statistics counters. | [optional] |
13
13
 
14
14
  ## Example
15
15
 
@@ -10,11 +10,11 @@
10
10
  | **display_name** | **String** | The display name. | [optional] |
11
11
  | **data** | **String** | Additional user defined data. | [optional] |
12
12
  | **created** | **Time** | The time when the event has been created. | [optional] |
13
- | **formatting** | [**OneOfNotificationFormattingDto**](OneOfNotificationFormattingDto.md) | The final formatting infos. | [optional] |
14
- | **settings** | [**OneOfmap**](OneOfmap.md) | Notification settings per channel. | [optional] |
15
- | **properties** | [**OneOfmap**](OneOfmap.md) | User defined properties. | [optional] |
16
- | **scheduling** | [**OneOfSchedulingDto**](OneOfSchedulingDto.md) | The scheduling options. | [optional] |
17
- | **counters** | [**OneOfmap**](OneOfmap.md) | The statistics counters. | [optional] |
13
+ | **formatting** | [**NotificationFormattingDto**](NotificationFormattingDto.md) | | [optional] |
14
+ | **settings** | [**Hash<String, NotificationSettingDto>**](NotificationSettingDto.md) | Notification settings per channel. | [optional] |
15
+ | **properties** | **Hash<String, String>** | User defined properties. | [optional] |
16
+ | **scheduling** | [**SchedulingDto**](SchedulingDto.md) | | [optional] |
17
+ | **counters** | **Hash<String, Integer>** | The statistics counters. | [optional] |
18
18
  | **silent** | **Boolean** | True when silent. | [optional] |
19
19
 
20
20
  ## Example
@@ -80,7 +80,7 @@ No authorization required
80
80
 
81
81
  ## events_post_events
82
82
 
83
- > events_post_events(app_id, publish_many_request_dto)
83
+ > events_post_events(app_id, publish_many_dto)
84
84
 
85
85
  Publish events.
86
86
 
@@ -92,11 +92,11 @@ require 'notifo'
92
92
 
93
93
  api_instance = Notifo::EventsApi.new
94
94
  app_id = 'app_id_example' # String | The app where the events belongs to.
95
- publish_many_request_dto = Notifo::PublishManyRequestDto.new # PublishManyRequestDto | The publish request.
95
+ publish_many_dto = Notifo::PublishManyDto.new # PublishManyDto | The publish request.
96
96
 
97
97
  begin
98
98
  # Publish events.
99
- api_instance.events_post_events(app_id, publish_many_request_dto)
99
+ api_instance.events_post_events(app_id, publish_many_dto)
100
100
  rescue Notifo::ApiError => e
101
101
  puts "Error when calling EventsApi->events_post_events: #{e}"
102
102
  end
@@ -106,12 +106,12 @@ end
106
106
 
107
107
  This returns an Array which contains the response data (`nil` in this case), status code and headers.
108
108
 
109
- > <Array(nil, Integer, Hash)> events_post_events_with_http_info(app_id, publish_many_request_dto)
109
+ > <Array(nil, Integer, Hash)> events_post_events_with_http_info(app_id, publish_many_dto)
110
110
 
111
111
  ```ruby
112
112
  begin
113
113
  # Publish events.
114
- data, status_code, headers = api_instance.events_post_events_with_http_info(app_id, publish_many_request_dto)
114
+ data, status_code, headers = api_instance.events_post_events_with_http_info(app_id, publish_many_dto)
115
115
  p status_code # => 2xx
116
116
  p headers # => { ... }
117
117
  p data # => nil
@@ -125,7 +125,7 @@ end
125
125
  | Name | Type | Description | Notes |
126
126
  | ---- | ---- | ----------- | ----- |
127
127
  | **app_id** | **String** | The app where the events belongs to. | |
128
- | **publish_many_request_dto** | [**PublishManyRequestDto**](PublishManyRequestDto.md) | The publish request. | |
128
+ | **publish_many_dto** | [**PublishManyDto**](PublishManyDto.md) | The publish request. | |
129
129
 
130
130
  ### Return type
131
131
 
@@ -95,7 +95,7 @@ opts = {
95
95
  height: 56, # Integer | The target height when an image.
96
96
  quality: 56, # Integer | The target quality when an image.
97
97
  preset: 'preset_example', # String | A preset dimension.
98
- mode: TODO, # OneOfResizeMode | The resize mode.
98
+ mode: Notifo::ResizeMode::CROP, # ResizeMode | The resize mode.
99
99
  focus_x: 3.4, # Float | The x position of the focues point.
100
100
  focus_y: 3.4, # Float | The y position of the focues point.
101
101
  force: true # Boolean | True to resize it and clear the cache.
@@ -140,7 +140,7 @@ end
140
140
  | **height** | **Integer** | The target height when an image. | [optional] |
141
141
  | **quality** | **Integer** | The target quality when an image. | [optional] |
142
142
  | **preset** | **String** | A preset dimension. | [optional] |
143
- | **mode** | [**OneOfResizeMode**](.md) | The resize mode. | [optional] |
143
+ | **mode** | [**ResizeMode**](.md) | The resize mode. | [optional] |
144
144
  | **focus_x** | **Float** | The x position of the focues point. | [optional] |
145
145
  | **focus_y** | **Float** | The y position of the focues point. | [optional] |
146
146
  | **force** | **Boolean** | True to resize it and clear the cache. | [optional] |
@@ -8,8 +8,8 @@
8
8
  | **file_name** | **String** | The file name. | [optional] |
9
9
  | **file_info** | **String** | Generated information about the file. | [optional] |
10
10
  | **file_size** | **Integer** | The size of the media file. | [optional] |
11
- | **type** | [**OneOfMediaType**](OneOfMediaType.md) | The type of the media. | [optional] |
12
- | **metadata** | [**OneOfmap**](OneOfmap.md) | Metadata about the media. | [optional] |
11
+ | **type** | [**MediaType**](MediaType.md) | | [optional] |
12
+ | **metadata** | **Hash&lt;String, String&gt;** | | [optional] |
13
13
 
14
14
  ## Example
15
15
 
@@ -4,14 +4,14 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **subject** | [**OneOfmap**](OneOfmap.md) | The required subject with one entry per language. | [optional] |
8
- | **body** | [**OneOfmap**](OneOfmap.md) | The optional body with one entry per language. | [optional] |
9
- | **confirm_text** | [**OneOfmap**](OneOfmap.md) | The optional confirm text with one entry per language. | [optional] |
10
- | **image_small** | [**OneOfmap**](OneOfmap.md) | The optional small image with one entry per language. | [optional] |
11
- | **image_large** | [**OneOfmap**](OneOfmap.md) | The optional large image with one entry per language. | [optional] |
12
- | **link_url** | [**OneOfmap**](OneOfmap.md) | The optional link url with one entry per language. | [optional] |
13
- | **link_text** | [**OneOfmap**](OneOfmap.md) | The optional link name with one entry per language. | [optional] |
14
- | **confirm_mode** | [**OneOfConfirmMode**](OneOfConfirmMode.md) | The confirmation mode. | [optional] |
7
+ | **subject** | **Hash&lt;String, String&gt;** | | [optional] |
8
+ | **body** | **Hash&lt;String, String&gt;** | | [optional] |
9
+ | **confirm_text** | **Hash&lt;String, String&gt;** | | [optional] |
10
+ | **image_small** | **Hash&lt;String, String&gt;** | | [optional] |
11
+ | **image_large** | **Hash&lt;String, String&gt;** | | [optional] |
12
+ | **link_url** | **Hash&lt;String, String&gt;** | | [optional] |
13
+ | **link_text** | **Hash&lt;String, String&gt;** | | [optional] |
14
+ | **confirm_mode** | [**ConfirmMode**](ConfirmMode.md) | | [optional] |
15
15
 
16
16
  ## Example
17
17
 
@@ -0,0 +1,15 @@
1
+ # Notifo::NotificationSend
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+
8
+ ## Example
9
+
10
+ ```ruby
11
+ require 'notifo'
12
+
13
+ instance = Notifo::NotificationSend.new()
14
+ ```
15
+
@@ -4,7 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **_send** | **Boolean** | True or false to send the notification for the channel. | [optional] |
7
+ | **_send** | [**NotificationSend**](NotificationSend.md) | | [optional] |
8
8
  | **delay_in_seconds** | **Integer** | The delay in seconds. | [optional] |
9
9
 
10
10
  ## Example
@@ -0,0 +1,32 @@
1
+ # Notifo::ProfileDto
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **full_name** | **String** | The full name of the user. | [optional] |
8
+ | **email_address** | **String** | The email of the user. | [optional] |
9
+ | **phone_number** | **String** | The phone number. | [optional] |
10
+ | **preferred_language** | **String** | The preferred language of the user. | [optional] |
11
+ | **preferred_timezone** | **String** | The timezone of the user. | [optional] |
12
+ | **supported_languages** | **Array&lt;String&gt;** | The supported languages. | [optional] |
13
+ | **supported_timezones** | **Array&lt;String&gt;** | The supported timezones. | [optional] |
14
+ | **settings** | [**Hash&lt;String, NotificationSettingDto&gt;**](NotificationSettingDto.md) | Notification settings per channel. | [optional] |
15
+
16
+ ## Example
17
+
18
+ ```ruby
19
+ require 'notifo'
20
+
21
+ instance = Notifo::ProfileDto.new(
22
+ full_name: null,
23
+ email_address: null,
24
+ phone_number: null,
25
+ preferred_language: null,
26
+ preferred_timezone: null,
27
+ supported_languages: null,
28
+ supported_timezones: null,
29
+ settings: null
30
+ )
31
+ ```
32
+
@@ -1,4 +1,4 @@
1
- # Notifo::PublishRequestDto
1
+ # Notifo::PublishDto
2
2
 
3
3
  ## Properties
4
4
 
@@ -9,10 +9,10 @@
9
9
  | **template_code** | **String** | The template code. | [optional] |
10
10
  | **data** | **String** | Additional user defined data. | [optional] |
11
11
  | **timestamp** | **Time** | A custom timestamp. | [optional] |
12
- | **preformatted** | [**OneOfNotificationFormattingDto**](OneOfNotificationFormattingDto.md) | Preformatting when no template is used. | [optional] |
12
+ | **preformatted** | [**NotificationFormattingDto**](NotificationFormattingDto.md) | | [optional] |
13
13
  | **settings** | [**Hash&lt;String, NotificationSettingDto&gt;**](NotificationSettingDto.md) | The notification settings. | [optional] |
14
- | **properties** | [**OneOfmap**](OneOfmap.md) | User defined properties. | [optional] |
15
- | **scheduling** | [**OneOfSchedulingDto**](OneOfSchedulingDto.md) | The scheduling options. | [optional] |
14
+ | **properties** | **Hash&lt;String, String&gt;** | | [optional] |
15
+ | **scheduling** | [**SchedulingDto**](SchedulingDto.md) | | [optional] |
16
16
  | **silent** | **Boolean** | True when silent. | [optional] |
17
17
 
18
18
  ## Example
@@ -20,7 +20,7 @@
20
20
  ```ruby
21
21
  require 'notifo'
22
22
 
23
- instance = Notifo::PublishRequestDto.new(
23
+ instance = Notifo::PublishDto.new(
24
24
  topic: null,
25
25
  creator_id: null,
26
26
  template_code: null,
@@ -0,0 +1,18 @@
1
+ # Notifo::PublishManyDto
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **requests** | [**Array&lt;PublishDto&gt;**](PublishDto.md) | The publish requests. | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'notifo'
13
+
14
+ instance = Notifo::PublishManyDto.new(
15
+ requests: null
16
+ )
17
+ ```
18
+
@@ -4,8 +4,8 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
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] |
7
+ | **type** | [**SchedulingType**](SchedulingType.md) | | [optional] |
8
+ | **next_week_day** | [**IsoDayOfWeek**](IsoDayOfWeek.md) | | [optional] |
9
9
  | **date** | **Date** | The scheduling date. | [optional] |
10
10
  | **time** | **String** | The scheduling time. | [optional] |
11
11
 
@@ -5,7 +5,7 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **topic_prefix** | **String** | The topic to add. | [optional] |
8
- | **topic_settings** | [**OneOfmap**](OneOfmap.md) | Notification settings per channel. | [optional] |
8
+ | **topic_settings** | [**Hash&lt;String, NotificationSettingDto&gt;**](NotificationSettingDto.md) | Notification settings per channel. | [optional] |
9
9
 
10
10
  ## Example
11
11
 
@@ -5,8 +5,8 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
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] |
8
+ | **formatting** | [**NotificationFormattingDto**](NotificationFormattingDto.md) | | [optional] |
9
+ | **settings** | [**Hash&lt;String, NotificationSettingDto&gt;**](NotificationSettingDto.md) | Notification settings per channel. | [optional] |
10
10
 
11
11
  ## Example
12
12
 
@@ -6,7 +6,7 @@
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **path** | **String** | The topic path. | [optional] |
8
8
  | **last_update** | **Time** | THe last update to the topic. | [optional] |
9
- | **counters** | [**OneOfmap**](OneOfmap.md) | The statistics counters. | [optional] |
9
+ | **counters** | **Hash&lt;String, Integer&gt;** | The statistics counters. | [optional] |
10
10
 
11
11
  ## Example
12
12
 
@@ -4,73 +4,7 @@ All URIs are relative to *https://app.notifo.io*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
- | [**topics_get_subscription**](TopicsApi.md#topics_get_subscription) | **GET** /api/web/subscriptions/{topic} | Gets a user subscription. |
8
7
  | [**topics_get_topics**](TopicsApi.md#topics_get_topics) | **GET** /api/apps/{appId}/topics | Query topics. |
9
- | [**topics_subscribe**](TopicsApi.md#topics_subscribe) | **POST** /api/web/subscriptions/{topic} | Creates a user subscription. |
10
- | [**topics_unsubscribe**](TopicsApi.md#topics_unsubscribe) | **DELETE** /api/web/subscriptions/{topic} | Deletes a user subscription. |
11
-
12
-
13
- ## topics_get_subscription
14
-
15
- > topics_get_subscription(topic)
16
-
17
- Gets a user subscription.
18
-
19
- User Id and App Id are resolved using the API token.
20
-
21
- ### Examples
22
-
23
- ```ruby
24
- require 'time'
25
- require 'notifo'
26
-
27
- api_instance = Notifo::TopicsApi.new
28
- topic = 'topic_example' # String | The topic path.
29
-
30
- begin
31
- # Gets a user subscription.
32
- api_instance.topics_get_subscription(topic)
33
- rescue Notifo::ApiError => e
34
- puts "Error when calling TopicsApi->topics_get_subscription: #{e}"
35
- end
36
- ```
37
-
38
- #### Using the topics_get_subscription_with_http_info variant
39
-
40
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
41
-
42
- > <Array(nil, Integer, Hash)> topics_get_subscription_with_http_info(topic)
43
-
44
- ```ruby
45
- begin
46
- # Gets a user subscription.
47
- data, status_code, headers = api_instance.topics_get_subscription_with_http_info(topic)
48
- p status_code # => 2xx
49
- p headers # => { ... }
50
- p data # => nil
51
- rescue Notifo::ApiError => e
52
- puts "Error when calling TopicsApi->topics_get_subscription_with_http_info: #{e}"
53
- end
54
- ```
55
-
56
- ### Parameters
57
-
58
- | Name | Type | Description | Notes |
59
- | ---- | ---- | ----------- | ----- |
60
- | **topic** | **String** | The topic path. | |
61
-
62
- ### Return type
63
-
64
- nil (empty response body)
65
-
66
- ### Authorization
67
-
68
- No authorization required
69
-
70
- ### HTTP request headers
71
-
72
- - **Content-Type**: Not defined
73
- - **Accept**: application/json
74
8
 
75
9
 
76
10
  ## topics_get_topics
@@ -142,129 +76,3 @@ No authorization required
142
76
  - **Content-Type**: Not defined
143
77
  - **Accept**: application/json
144
78
 
145
-
146
- ## topics_subscribe
147
-
148
- > topics_subscribe(topic)
149
-
150
- Creates a user subscription.
151
-
152
- User Id and App Id are resolved using the API token.
153
-
154
- ### Examples
155
-
156
- ```ruby
157
- require 'time'
158
- require 'notifo'
159
-
160
- api_instance = Notifo::TopicsApi.new
161
- topic = 'topic_example' # String | The topic path.
162
-
163
- begin
164
- # Creates a user subscription.
165
- api_instance.topics_subscribe(topic)
166
- rescue Notifo::ApiError => e
167
- puts "Error when calling TopicsApi->topics_subscribe: #{e}"
168
- end
169
- ```
170
-
171
- #### Using the topics_subscribe_with_http_info variant
172
-
173
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
174
-
175
- > <Array(nil, Integer, Hash)> topics_subscribe_with_http_info(topic)
176
-
177
- ```ruby
178
- begin
179
- # Creates a user subscription.
180
- data, status_code, headers = api_instance.topics_subscribe_with_http_info(topic)
181
- p status_code # => 2xx
182
- p headers # => { ... }
183
- p data # => nil
184
- rescue Notifo::ApiError => e
185
- puts "Error when calling TopicsApi->topics_subscribe_with_http_info: #{e}"
186
- end
187
- ```
188
-
189
- ### Parameters
190
-
191
- | Name | Type | Description | Notes |
192
- | ---- | ---- | ----------- | ----- |
193
- | **topic** | **String** | The topic path. | |
194
-
195
- ### Return type
196
-
197
- nil (empty response body)
198
-
199
- ### Authorization
200
-
201
- No authorization required
202
-
203
- ### HTTP request headers
204
-
205
- - **Content-Type**: Not defined
206
- - **Accept**: application/json
207
-
208
-
209
- ## topics_unsubscribe
210
-
211
- > topics_unsubscribe(topic)
212
-
213
- Deletes a user subscription.
214
-
215
- User Id and App Id are resolved using the API token.
216
-
217
- ### Examples
218
-
219
- ```ruby
220
- require 'time'
221
- require 'notifo'
222
-
223
- api_instance = Notifo::TopicsApi.new
224
- topic = 'topic_example' # String | The topic path.
225
-
226
- begin
227
- # Deletes a user subscription.
228
- api_instance.topics_unsubscribe(topic)
229
- rescue Notifo::ApiError => e
230
- puts "Error when calling TopicsApi->topics_unsubscribe: #{e}"
231
- end
232
- ```
233
-
234
- #### Using the topics_unsubscribe_with_http_info variant
235
-
236
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
237
-
238
- > <Array(nil, Integer, Hash)> topics_unsubscribe_with_http_info(topic)
239
-
240
- ```ruby
241
- begin
242
- # Deletes a user subscription.
243
- data, status_code, headers = api_instance.topics_unsubscribe_with_http_info(topic)
244
- p status_code # => 2xx
245
- p headers # => { ... }
246
- p data # => nil
247
- rescue Notifo::ApiError => e
248
- puts "Error when calling TopicsApi->topics_unsubscribe_with_http_info: #{e}"
249
- end
250
- ```
251
-
252
- ### Parameters
253
-
254
- | Name | Type | Description | Notes |
255
- | ---- | ---- | ----------- | ----- |
256
- | **topic** | **String** | The topic path. | |
257
-
258
- ### Return type
259
-
260
- nil (empty response body)
261
-
262
- ### Authorization
263
-
264
- No authorization required
265
-
266
- ### HTTP request headers
267
-
268
- - **Content-Type**: Not defined
269
- - **Accept**: application/json
270
-