notifo-io 1.0.1.1 → 1.0.1.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +205 -4
- data/docs/AppDetailsDto.md +0 -8
- data/docs/AppIdMediaBody.md +7 -0
- data/docs/AppsApi.md +188 -2
- data/docs/AuthorizationApi.md +121 -0
- data/docs/ConfigsApi.md +1 -1
- data/docs/ConfiguredIntegrationDto.md +12 -0
- data/docs/ConfiguredIntegrationsDto.md +8 -0
- data/docs/CreateIntegrationDto.md +11 -0
- data/docs/EventDto.md +1 -0
- data/docs/EventsApi.md +45 -1
- data/docs/IntegrationCreatedDto.md +8 -0
- data/docs/IntegrationDefinitionDto.md +11 -0
- data/docs/IntegrationProperties.md +6 -0
- data/docs/IntegrationPropertyDto.md +17 -0
- data/docs/IntegrationPropertyType.md +6 -0
- data/docs/IntegrationStatus.md +6 -0
- data/docs/ListResponseDtoOfMobilePushTokenDto.md +8 -0
- data/docs/ListResponseDtoOfNotificationDto.md +8 -0
- data/docs/LogsApi.md +1 -1
- data/docs/MediaApi.md +1 -1
- data/docs/MobileDeviceType.md +6 -0
- data/docs/MobilePushApi.md +135 -0
- data/docs/MobilePushTokenDto.md +8 -0
- data/docs/NotificationDto.md +21 -0
- data/docs/NotificationsApi.md +141 -0
- data/docs/PublishDto.md +2 -0
- data/docs/RegisterMobileTokenDto.md +8 -0
- data/docs/TemplatesApi.md +1 -1
- data/docs/TopicsApi.md +1 -1
- data/docs/TrackNotificationDto.md +10 -0
- data/docs/UpdateIntegrationDto.md +10 -0
- data/docs/UpsertUserDto.md +1 -0
- data/docs/UserApi.md +1 -1
- data/docs/UserDto.md +3 -0
- data/docs/UserInfoApi.md +83 -0
- data/docs/UsersApi.md +1 -1
- data/lib/notifo.rb +23 -3
- data/lib/notifo/api/apps_api.rb +246 -2
- data/lib/notifo/api/authorization_api.rb +158 -0
- data/lib/notifo/api/configs_api.rb +1 -1
- data/lib/notifo/api/events_api.rb +57 -1
- data/lib/notifo/api/logs_api.rb +1 -1
- data/lib/notifo/api/media_api.rb +1 -1
- data/lib/notifo/api/mobile_push_api.rb +178 -0
- data/lib/notifo/api/notifications_api.rb +181 -0
- data/lib/notifo/api/templates_api.rb +1 -1
- data/lib/notifo/api/topics_api.rb +1 -1
- data/lib/notifo/api/user_api.rb +1 -1
- data/lib/notifo/api/user_info_api.rb +112 -0
- data/lib/notifo/api/users_api.rb +1 -1
- data/lib/notifo/api_client.rb +1 -1
- data/lib/notifo/api_error.rb +1 -1
- data/lib/notifo/configuration.rb +3 -3
- data/lib/notifo/models/add_allowed_topic_dto.rb +1 -1
- data/lib/notifo/models/add_contributor_dto.rb +1 -1
- data/lib/notifo/models/app_contributor_dto.rb +1 -1
- data/lib/notifo/models/app_details_dto.rb +3 -96
- data/lib/notifo/models/app_dto.rb +1 -1
- data/lib/notifo/models/app_id_media_body.rb +207 -0
- data/lib/notifo/models/configured_integration_dto.rb +271 -0
- data/lib/notifo/models/configured_integrations_dto.rb +231 -0
- data/lib/notifo/models/confirm_mode.rb +1 -1
- data/lib/notifo/models/create_email_template_dto.rb +1 -1
- data/lib/notifo/models/create_integration_dto.rb +257 -0
- data/lib/notifo/models/email_template_dto.rb +2 -1
- data/lib/notifo/models/email_templates_dto.rb +1 -1
- data/lib/notifo/models/error_dto.rb +5 -1
- data/lib/notifo/models/event_dto.rb +18 -5
- data/lib/notifo/models/event_properties.rb +1 -1
- data/lib/notifo/models/integration_created_dto.rb +226 -0
- data/lib/notifo/models/integration_definition_dto.rb +272 -0
- data/lib/notifo/models/integration_properties.rb +201 -0
- data/lib/notifo/models/integration_property_dto.rb +319 -0
- data/lib/notifo/models/integration_property_type.rb +31 -0
- data/lib/notifo/models/integration_status.rb +29 -0
- data/lib/notifo/models/iso_day_of_week.rb +1 -1
- data/lib/notifo/models/list_response_dto_of_event_dto.rb +1 -1
- data/lib/notifo/models/list_response_dto_of_log_entry_dto.rb +1 -1
- data/lib/notifo/models/list_response_dto_of_media_dto.rb +1 -1
- data/lib/notifo/models/list_response_dto_of_mobile_push_token_dto.rb +229 -0
- data/lib/notifo/models/list_response_dto_of_notification_dto.rb +229 -0
- data/lib/notifo/models/list_response_dto_of_subscription_dto.rb +1 -1
- data/lib/notifo/models/list_response_dto_of_template_dto.rb +1 -1
- data/lib/notifo/models/list_response_dto_of_topic_dto.rb +1 -1
- data/lib/notifo/models/list_response_dto_of_user_dto.rb +1 -1
- data/lib/notifo/models/localized_text.rb +1 -1
- data/lib/notifo/models/log_entry_dto.rb +1 -1
- data/lib/notifo/models/media_dto.rb +1 -1
- data/lib/notifo/models/media_metadata.rb +1 -1
- data/lib/notifo/models/media_type.rb +1 -1
- data/lib/notifo/models/mobile_device_type.rb +29 -0
- data/lib/notifo/models/mobile_push_token_dto.rb +221 -0
- data/lib/notifo/models/notification_dto.rb +386 -0
- data/lib/notifo/models/notification_formatting_dto.rb +1 -1
- data/lib/notifo/models/notification_send.rb +1 -1
- data/lib/notifo/models/notification_setting_dto.rb +2 -1
- data/lib/notifo/models/profile_dto.rb +4 -1
- data/lib/notifo/models/publish_dto.rb +30 -5
- data/lib/notifo/models/publish_many_dto.rb +1 -1
- data/lib/notifo/models/register_mobile_token_dto.rb +221 -0
- data/lib/notifo/models/resize_mode.rb +1 -1
- data/lib/notifo/models/scheduling_dto.rb +2 -1
- data/lib/notifo/models/scheduling_type.rb +1 -1
- data/lib/notifo/models/subscription_dto.rb +2 -1
- data/lib/notifo/models/template_dto.rb +1 -1
- data/lib/notifo/models/topic_dto.rb +1 -1
- data/lib/notifo/models/track_notification_dto.rb +243 -0
- data/lib/notifo/models/update_integration_dto.rb +242 -0
- data/lib/notifo/models/update_profile_dto.rb +7 -1
- data/lib/notifo/models/upsert_app_dto.rb +11 -1
- data/lib/notifo/models/upsert_template_dto.rb +2 -1
- data/lib/notifo/models/upsert_templates_dto.rb +1 -1
- data/lib/notifo/models/upsert_user_dto.rb +21 -2
- data/lib/notifo/models/upsert_users_dto.rb +1 -1
- data/lib/notifo/models/user_dto.rb +48 -2
- data/lib/notifo/version.rb +1 -1
- data/notifo-io-1.0.1.1.gem +0 -0
- data/notifo.gemspec +2 -2
- data/spec/api/authorization_api_spec.rb +61 -0
- data/spec/api/mobile_push_api_spec.rb +66 -0
- data/spec/api/notifications_api_spec.rb +68 -0
- data/spec/api/user_info_api_spec.rb +52 -0
- data/spec/models/app_id_media_body_spec.rb +40 -0
- data/spec/models/configured_integration_dto_spec.rb +70 -0
- data/spec/models/configured_integrations_dto_spec.rb +46 -0
- data/spec/models/create_integration_dto_spec.rb +64 -0
- data/spec/models/integration_created_dto_spec.rb +46 -0
- data/spec/models/integration_definition_dto_spec.rb +64 -0
- data/spec/models/integration_properties_spec.rb +34 -0
- data/spec/models/integration_property_dto_spec.rb +100 -0
- data/spec/models/integration_property_type_spec.rb +34 -0
- data/spec/models/integration_status_spec.rb +34 -0
- data/spec/models/list_response_dto_of_mobile_push_token_dto_spec.rb +46 -0
- data/spec/models/list_response_dto_of_notification_dto_spec.rb +46 -0
- data/spec/models/mobile_device_type_spec.rb +34 -0
- data/spec/models/mobile_push_token_dto_spec.rb +46 -0
- data/spec/models/notification_dto_spec.rb +124 -0
- data/spec/models/register_mobile_token_dto_spec.rb +46 -0
- data/spec/models/track_notification_dto_spec.rb +58 -0
- data/spec/models/update_integration_dto_spec.rb +58 -0
- metadata +91 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 6bbd6b15fb206d184caa21d3bd0ca7f0cfeed06797f2d65c33b42537c6616ad4
|
4
|
+
data.tar.gz: 1092106649a1c6c2136ecd97441abd5f45b0911d885169a9a793ee78bc895c80
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 112af1bfc5ee3f774a8cd308174398c6591458fe8b405c864793b1eca2a41eec5ad3d59064b34d9be431bd2834cab7f4c7b4fe4ec5bb7d6ecb3b7d9ddf1cddec
|
7
|
+
data.tar.gz: 47e52057b246f67f9469189ca8f9962999b5a925355830cc5bacb1dd0c608a32f875bff308c1d8725e652df0c1dbb173ba6bdf4bb04d68da4f56509ebfbaa801
|
data/README.md
CHANGED
@@ -79,6 +79,18 @@ rescue Notifo::ApiError => e
|
|
79
79
|
puts "Exception when calling AppsApi->apps_delete_email_template: #{e}"
|
80
80
|
end
|
81
81
|
|
82
|
+
api_instance = Notifo::AppsApi.new
|
83
|
+
app_id = 'app_id_example' # String | The id of the app where the email templates belong to.
|
84
|
+
id = 'id_example' # String | The id of the integration.
|
85
|
+
|
86
|
+
|
87
|
+
begin
|
88
|
+
#Delete an app integration.
|
89
|
+
api_instance.apps_delete_integration(app_id, id)
|
90
|
+
rescue Notifo::ApiError => e
|
91
|
+
puts "Exception when calling AppsApi->apps_delete_integration: #{e}"
|
92
|
+
end
|
93
|
+
|
82
94
|
api_instance = Notifo::AppsApi.new
|
83
95
|
app_id = 'app_id_example' # String | The id of the app.
|
84
96
|
|
@@ -113,6 +125,18 @@ rescue Notifo::ApiError => e
|
|
113
125
|
puts "Exception when calling AppsApi->apps_get_email_templates: #{e}"
|
114
126
|
end
|
115
127
|
|
128
|
+
api_instance = Notifo::AppsApi.new
|
129
|
+
app_id = 'app_id_example' # String | The id of the app where the integrations belong to.
|
130
|
+
|
131
|
+
|
132
|
+
begin
|
133
|
+
#Get the app integrations.
|
134
|
+
result = api_instance.apps_get_integrations(app_id)
|
135
|
+
p result
|
136
|
+
rescue Notifo::ApiError => e
|
137
|
+
puts "Exception when calling AppsApi->apps_get_integrations: #{e}"
|
138
|
+
end
|
139
|
+
|
116
140
|
api_instance = Notifo::AppsApi.new
|
117
141
|
body = Notifo::UpsertAppDto.new # UpsertAppDto | The request object.
|
118
142
|
|
@@ -151,6 +175,19 @@ rescue Notifo::ApiError => e
|
|
151
175
|
puts "Exception when calling AppsApi->apps_post_email_template: #{e}"
|
152
176
|
end
|
153
177
|
|
178
|
+
api_instance = Notifo::AppsApi.new
|
179
|
+
body = Notifo::CreateIntegrationDto.new # CreateIntegrationDto | The request object.
|
180
|
+
app_id = 'app_id_example' # String | The id of the app where the integration belong to.
|
181
|
+
|
182
|
+
|
183
|
+
begin
|
184
|
+
#Create an app integrations.
|
185
|
+
result = api_instance.apps_post_integration(body, app_id)
|
186
|
+
p result
|
187
|
+
rescue Notifo::ApiError => e
|
188
|
+
puts "Exception when calling AppsApi->apps_post_integration: #{e}"
|
189
|
+
end
|
190
|
+
|
154
191
|
api_instance = Notifo::AppsApi.new
|
155
192
|
body = Notifo::UpsertAppDto.new # UpsertAppDto | The request object.
|
156
193
|
app_id = 'app_id_example' # String | The app id to update.
|
@@ -177,6 +214,43 @@ rescue Notifo::ApiError => e
|
|
177
214
|
puts "Exception when calling AppsApi->apps_put_email_template: #{e}"
|
178
215
|
end
|
179
216
|
|
217
|
+
api_instance = Notifo::AppsApi.new
|
218
|
+
body = Notifo::UpdateIntegrationDto.new # UpdateIntegrationDto | The request object.
|
219
|
+
app_id = 'app_id_example' # String | The id of the app where the integration belong to.
|
220
|
+
id = 'id_example' # String | The id of the integration.
|
221
|
+
|
222
|
+
|
223
|
+
begin
|
224
|
+
#Update an app integration.
|
225
|
+
api_instance.apps_put_integration(body, app_id, id)
|
226
|
+
rescue Notifo::ApiError => e
|
227
|
+
puts "Exception when calling AppsApi->apps_put_integration: #{e}"
|
228
|
+
end
|
229
|
+
|
230
|
+
api_instance = Notifo::AuthorizationApi.new
|
231
|
+
|
232
|
+
begin
|
233
|
+
api_instance.authorization_authorize
|
234
|
+
rescue Notifo::ApiError => e
|
235
|
+
puts "Exception when calling AuthorizationApi->authorization_authorize: #{e}"
|
236
|
+
end
|
237
|
+
|
238
|
+
api_instance = Notifo::AuthorizationApi.new
|
239
|
+
|
240
|
+
begin
|
241
|
+
api_instance.authorization_exchange
|
242
|
+
rescue Notifo::ApiError => e
|
243
|
+
puts "Exception when calling AuthorizationApi->authorization_exchange: #{e}"
|
244
|
+
end
|
245
|
+
|
246
|
+
api_instance = Notifo::AuthorizationApi.new
|
247
|
+
|
248
|
+
begin
|
249
|
+
api_instance.authorization_logout
|
250
|
+
rescue Notifo::ApiError => e
|
251
|
+
puts "Exception when calling AuthorizationApi->authorization_logout: #{e}"
|
252
|
+
end
|
253
|
+
|
180
254
|
api_instance = Notifo::ConfigsApi.new
|
181
255
|
|
182
256
|
begin
|
@@ -225,6 +299,17 @@ rescue Notifo::ApiError => e
|
|
225
299
|
puts "Exception when calling EventsApi->events_post_events: #{e}"
|
226
300
|
end
|
227
301
|
|
302
|
+
api_instance = Notifo::EventsApi.new
|
303
|
+
body = Notifo::PublishDto.new # PublishDto | The publish request.
|
304
|
+
|
305
|
+
|
306
|
+
begin
|
307
|
+
#Publish an event for the current user.
|
308
|
+
api_instance.events_post_events2(body)
|
309
|
+
rescue Notifo::ApiError => e
|
310
|
+
puts "Exception when calling EventsApi->events_post_events2: #{e}"
|
311
|
+
end
|
312
|
+
|
228
313
|
api_instance = Notifo::LogsApi.new
|
229
314
|
app_id = 'app_id_example' # String | The app where the log entries belongs to.
|
230
315
|
opts = {
|
@@ -330,6 +415,74 @@ rescue Notifo::ApiError => e
|
|
330
415
|
puts "Exception when calling MediaApi->media_upload: #{e}"
|
331
416
|
end
|
332
417
|
|
418
|
+
api_instance = Notifo::MobilePushApi.new
|
419
|
+
token = 'token_example' # String | The token to remove.
|
420
|
+
|
421
|
+
|
422
|
+
begin
|
423
|
+
#Deletes a mobile push token for the current user.
|
424
|
+
api_instance.mobile_push_delete_token(token)
|
425
|
+
rescue Notifo::ApiError => e
|
426
|
+
puts "Exception when calling MobilePushApi->mobile_push_delete_token: #{e}"
|
427
|
+
end
|
428
|
+
|
429
|
+
api_instance = Notifo::MobilePushApi.new
|
430
|
+
|
431
|
+
begin
|
432
|
+
#Returns the mobile push tokens.
|
433
|
+
result = api_instance.mobile_push_get_tokens
|
434
|
+
p result
|
435
|
+
rescue Notifo::ApiError => e
|
436
|
+
puts "Exception when calling MobilePushApi->mobile_push_get_tokens: #{e}"
|
437
|
+
end
|
438
|
+
|
439
|
+
api_instance = Notifo::MobilePushApi.new
|
440
|
+
body = Notifo::RegisterMobileTokenDto.new # RegisterMobileTokenDto | The request object.
|
441
|
+
|
442
|
+
|
443
|
+
begin
|
444
|
+
#Register a mobile push token for the current user.
|
445
|
+
api_instance.mobile_push_post_token(body)
|
446
|
+
rescue Notifo::ApiError => e
|
447
|
+
puts "Exception when calling MobilePushApi->mobile_push_post_token: #{e}"
|
448
|
+
end
|
449
|
+
|
450
|
+
api_instance = Notifo::NotificationsApi.new
|
451
|
+
body = Notifo::TrackNotificationDto.new # TrackNotificationDto | The request object.
|
452
|
+
|
453
|
+
|
454
|
+
begin
|
455
|
+
#Confirms the user notifications for the current user.
|
456
|
+
api_instance.notifications_confirm(body)
|
457
|
+
rescue Notifo::ApiError => e
|
458
|
+
puts "Exception when calling NotificationsApi->notifications_confirm: #{e}"
|
459
|
+
end
|
460
|
+
|
461
|
+
api_instance = Notifo::NotificationsApi.new
|
462
|
+
|
463
|
+
begin
|
464
|
+
#Query archhived user notifications of the current user.
|
465
|
+
result = api_instance.notifications_get_archive
|
466
|
+
p result
|
467
|
+
rescue Notifo::ApiError => e
|
468
|
+
puts "Exception when calling NotificationsApi->notifications_get_archive: #{e}"
|
469
|
+
end
|
470
|
+
|
471
|
+
api_instance = Notifo::NotificationsApi.new
|
472
|
+
opts = {
|
473
|
+
query: 'query_example', # String | The optional query to search for items.
|
474
|
+
take: 56, # Integer | The number of items to return.
|
475
|
+
skip: 56 # Integer | The number of items to skip.
|
476
|
+
}
|
477
|
+
|
478
|
+
begin
|
479
|
+
#Query user notifications of the current user.
|
480
|
+
result = api_instance.notifications_get_notifications(opts)
|
481
|
+
p result
|
482
|
+
rescue Notifo::ApiError => e
|
483
|
+
puts "Exception when calling NotificationsApi->notifications_get_notifications: #{e}"
|
484
|
+
end
|
485
|
+
|
333
486
|
api_instance = Notifo::TemplatesApi.new
|
334
487
|
app_id = 'app_id_example' # String | The app where the templates belong to.
|
335
488
|
code = 'code_example' # String | The template code to delete.
|
@@ -444,6 +597,22 @@ rescue Notifo::ApiError => e
|
|
444
597
|
puts "Exception when calling UserApi->user_post_user: #{e}"
|
445
598
|
end
|
446
599
|
|
600
|
+
api_instance = Notifo::UserInfoApi.new
|
601
|
+
|
602
|
+
begin
|
603
|
+
api_instance.user_info_userinfo
|
604
|
+
rescue Notifo::ApiError => e
|
605
|
+
puts "Exception when calling UserInfoApi->user_info_userinfo: #{e}"
|
606
|
+
end
|
607
|
+
|
608
|
+
api_instance = Notifo::UserInfoApi.new
|
609
|
+
|
610
|
+
begin
|
611
|
+
api_instance.user_info_userinfo2
|
612
|
+
rescue Notifo::ApiError => e
|
613
|
+
puts "Exception when calling UserInfoApi->user_info_userinfo2: #{e}"
|
614
|
+
end
|
615
|
+
|
447
616
|
api_instance = Notifo::UsersApi.new
|
448
617
|
app_id = 'app_id_example' # String | The app where the users belong to.
|
449
618
|
id = 'id_example' # String | The user id.
|
@@ -571,30 +740,44 @@ end
|
|
571
740
|
|
572
741
|
## Documentation for API Endpoints
|
573
742
|
|
574
|
-
All URIs are relative to *https://
|
743
|
+
All URIs are relative to *https://notifo.easierlife.com*
|
575
744
|
|
576
745
|
Class | Method | HTTP request | Description
|
577
746
|
------------ | ------------- | ------------- | -------------
|
578
747
|
*Notifo::AppsApi* | [**apps_delete_contributor**](docs/AppsApi.md#apps_delete_contributor) | **POST** /api/apps/{appId}/contributors/{contributorId} | Delete an app contributor.
|
579
|
-
*Notifo::AppsApi* | [**apps_delete_email_template**](docs/AppsApi.md#apps_delete_email_template) | **
|
748
|
+
*Notifo::AppsApi* | [**apps_delete_email_template**](docs/AppsApi.md#apps_delete_email_template) | **DELETE** /api/apps/{appId}/email-templates/{language} | Delete an app email template.
|
749
|
+
*Notifo::AppsApi* | [**apps_delete_integration**](docs/AppsApi.md#apps_delete_integration) | **DELETE** /api/apps/{appId}/integrations/{id} | Delete an app integration.
|
580
750
|
*Notifo::AppsApi* | [**apps_get_app**](docs/AppsApi.md#apps_get_app) | **GET** /api/apps/{appId} | Get app by id.
|
581
751
|
*Notifo::AppsApi* | [**apps_get_apps**](docs/AppsApi.md#apps_get_apps) | **GET** /api/apps | Get the user apps.
|
582
752
|
*Notifo::AppsApi* | [**apps_get_email_templates**](docs/AppsApi.md#apps_get_email_templates) | **GET** /api/apps/{appId}/email-templates | Get the app email templates.
|
753
|
+
*Notifo::AppsApi* | [**apps_get_integrations**](docs/AppsApi.md#apps_get_integrations) | **GET** /api/apps/{appId}/integrations | Get the app integrations.
|
583
754
|
*Notifo::AppsApi* | [**apps_post_app**](docs/AppsApi.md#apps_post_app) | **POST** /api/apps | Create an app.
|
584
755
|
*Notifo::AppsApi* | [**apps_post_contributor**](docs/AppsApi.md#apps_post_contributor) | **POST** /api/apps/{appId}/contributors | Add an app contributor.
|
585
756
|
*Notifo::AppsApi* | [**apps_post_email_template**](docs/AppsApi.md#apps_post_email_template) | **POST** /api/apps/{appId}/email-templates | Create an app email template.
|
757
|
+
*Notifo::AppsApi* | [**apps_post_integration**](docs/AppsApi.md#apps_post_integration) | **POST** /api/apps/{appId}/integration | Create an app integrations.
|
586
758
|
*Notifo::AppsApi* | [**apps_put_app**](docs/AppsApi.md#apps_put_app) | **POST** /api/apps/{appId} | Update an app.
|
587
759
|
*Notifo::AppsApi* | [**apps_put_email_template**](docs/AppsApi.md#apps_put_email_template) | **PUT** /api/apps/{appId}/email-templates/{language} | Update an app email template.
|
760
|
+
*Notifo::AppsApi* | [**apps_put_integration**](docs/AppsApi.md#apps_put_integration) | **PUT** /api/apps/{appId}/integrations/{id} | Update an app integration.
|
761
|
+
*Notifo::AuthorizationApi* | [**authorization_authorize**](docs/AuthorizationApi.md#authorization_authorize) | **GET** /connect/authorize |
|
762
|
+
*Notifo::AuthorizationApi* | [**authorization_exchange**](docs/AuthorizationApi.md#authorization_exchange) | **POST** /connect/token |
|
763
|
+
*Notifo::AuthorizationApi* | [**authorization_logout**](docs/AuthorizationApi.md#authorization_logout) | **GET** /connect/logout |
|
588
764
|
*Notifo::ConfigsApi* | [**configs_get_languages**](docs/ConfigsApi.md#configs_get_languages) | **GET** /api/languages | Get all supported languages.
|
589
765
|
*Notifo::ConfigsApi* | [**configs_get_timezones**](docs/ConfigsApi.md#configs_get_timezones) | **GET** /api/timezones | Get all supported timezones.
|
590
766
|
*Notifo::EventsApi* | [**events_get_events**](docs/EventsApi.md#events_get_events) | **GET** /api/apps/{appId}/events | Query events.
|
591
767
|
*Notifo::EventsApi* | [**events_post_events**](docs/EventsApi.md#events_post_events) | **POST** /api/apps/{appId}/events | Publish events.
|
768
|
+
*Notifo::EventsApi* | [**events_post_events2**](docs/EventsApi.md#events_post_events2) | **POST** /api/me/events | Publish an event for the current user.
|
592
769
|
*Notifo::LogsApi* | [**logs_get_logs**](docs/LogsApi.md#logs_get_logs) | **GET** /api/apps/{appId}/logs | Query log entries.
|
593
770
|
*Notifo::MediaApi* | [**media_delete**](docs/MediaApi.md#media_delete) | **DELETE** /api/apps/{appId}/media/{fileName} | Delete a media.
|
594
771
|
*Notifo::MediaApi* | [**media_download**](docs/MediaApi.md#media_download) | **GET** /api/apps/{appId}/media/{fileName} | Download a media object.
|
595
772
|
*Notifo::MediaApi* | [**media_download2**](docs/MediaApi.md#media_download2) | **GET** /api/assets/{appId}/{fileName} | Download a media object.
|
596
773
|
*Notifo::MediaApi* | [**media_get_medias**](docs/MediaApi.md#media_get_medias) | **GET** /api/apps/{appId}/media | Query media items.
|
597
774
|
*Notifo::MediaApi* | [**media_upload**](docs/MediaApi.md#media_upload) | **POST** /api/apps/{appId}/media | Upload a media object.
|
775
|
+
*Notifo::MobilePushApi* | [**mobile_push_delete_token**](docs/MobilePushApi.md#mobile_push_delete_token) | **DELETE** /api/me/mobilepush/{token} | Deletes a mobile push token for the current user.
|
776
|
+
*Notifo::MobilePushApi* | [**mobile_push_get_tokens**](docs/MobilePushApi.md#mobile_push_get_tokens) | **GET** /api/me/mobilepush | Returns the mobile push tokens.
|
777
|
+
*Notifo::MobilePushApi* | [**mobile_push_post_token**](docs/MobilePushApi.md#mobile_push_post_token) | **POST** /api/me/mobilepush | Register a mobile push token for the current user.
|
778
|
+
*Notifo::NotificationsApi* | [**notifications_confirm**](docs/NotificationsApi.md#notifications_confirm) | **POST** /api/me/notifications/handled | Confirms the user notifications for the current user.
|
779
|
+
*Notifo::NotificationsApi* | [**notifications_get_archive**](docs/NotificationsApi.md#notifications_get_archive) | **GET** /api/me/notifications/archive | Query archhived user notifications of the current user.
|
780
|
+
*Notifo::NotificationsApi* | [**notifications_get_notifications**](docs/NotificationsApi.md#notifications_get_notifications) | **GET** /api/me/notifications | Query user notifications of the current user.
|
598
781
|
*Notifo::TemplatesApi* | [**templates_delete_template**](docs/TemplatesApi.md#templates_delete_template) | **DELETE** /api/apps/{appId}/templates/{code} | Delete a template.
|
599
782
|
*Notifo::TemplatesApi* | [**templates_get_templates**](docs/TemplatesApi.md#templates_get_templates) | **GET** /api/apps/{appId}/templates | Query templates.
|
600
783
|
*Notifo::TemplatesApi* | [**templates_post_templates**](docs/TemplatesApi.md#templates_post_templates) | **POST** /api/apps/{appId}/templates | Upsert templates.
|
@@ -604,6 +787,8 @@ Class | Method | HTTP request | Description
|
|
604
787
|
*Notifo::UserApi* | [**user_get_user**](docs/UserApi.md#user_get_user) | **GET** /api/me | Get the current user.
|
605
788
|
*Notifo::UserApi* | [**user_post_subscription**](docs/UserApi.md#user_post_subscription) | **POST** /api/me/subscriptions | Creates a user subscription.
|
606
789
|
*Notifo::UserApi* | [**user_post_user**](docs/UserApi.md#user_post_user) | **POST** /api/me | Update the user.
|
790
|
+
*Notifo::UserInfoApi* | [**user_info_userinfo**](docs/UserInfoApi.md#user_info_userinfo) | **GET** /connect/userinfo |
|
791
|
+
*Notifo::UserInfoApi* | [**user_info_userinfo2**](docs/UserInfoApi.md#user_info_userinfo2) | **POST** /connect/userinfo |
|
607
792
|
*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.
|
608
793
|
*Notifo::UsersApi* | [**users_delete_subscription**](docs/UsersApi.md#users_delete_subscription) | **DELETE** /api/apps/{appId}/users/{id}/subscriptions/{prefix} | Remove a user subscriptions.
|
609
794
|
*Notifo::UsersApi* | [**users_delete_user**](docs/UsersApi.md#users_delete_user) | **DELETE** /api/apps/{appId}/users/{id} | Delete a user.
|
@@ -621,19 +806,29 @@ Class | Method | HTTP request | Description
|
|
621
806
|
- [Notifo::AppContributorDto](docs/AppContributorDto.md)
|
622
807
|
- [Notifo::AppDetailsDto](docs/AppDetailsDto.md)
|
623
808
|
- [Notifo::AppDto](docs/AppDto.md)
|
624
|
-
- [Notifo::
|
809
|
+
- [Notifo::AppIdMediaBody](docs/AppIdMediaBody.md)
|
810
|
+
- [Notifo::ConfiguredIntegrationDto](docs/ConfiguredIntegrationDto.md)
|
811
|
+
- [Notifo::ConfiguredIntegrationsDto](docs/ConfiguredIntegrationsDto.md)
|
625
812
|
- [Notifo::ConfirmMode](docs/ConfirmMode.md)
|
626
813
|
- [Notifo::CreateEmailTemplateDto](docs/CreateEmailTemplateDto.md)
|
814
|
+
- [Notifo::CreateIntegrationDto](docs/CreateIntegrationDto.md)
|
627
815
|
- [Notifo::EmailTemplateDto](docs/EmailTemplateDto.md)
|
628
816
|
- [Notifo::EmailTemplatesDto](docs/EmailTemplatesDto.md)
|
629
|
-
- [Notifo::EmailVerificationStatus](docs/EmailVerificationStatus.md)
|
630
817
|
- [Notifo::ErrorDto](docs/ErrorDto.md)
|
631
818
|
- [Notifo::EventDto](docs/EventDto.md)
|
632
819
|
- [Notifo::EventProperties](docs/EventProperties.md)
|
820
|
+
- [Notifo::IntegrationCreatedDto](docs/IntegrationCreatedDto.md)
|
821
|
+
- [Notifo::IntegrationDefinitionDto](docs/IntegrationDefinitionDto.md)
|
822
|
+
- [Notifo::IntegrationProperties](docs/IntegrationProperties.md)
|
823
|
+
- [Notifo::IntegrationPropertyDto](docs/IntegrationPropertyDto.md)
|
824
|
+
- [Notifo::IntegrationPropertyType](docs/IntegrationPropertyType.md)
|
825
|
+
- [Notifo::IntegrationStatus](docs/IntegrationStatus.md)
|
633
826
|
- [Notifo::IsoDayOfWeek](docs/IsoDayOfWeek.md)
|
634
827
|
- [Notifo::ListResponseDtoOfEventDto](docs/ListResponseDtoOfEventDto.md)
|
635
828
|
- [Notifo::ListResponseDtoOfLogEntryDto](docs/ListResponseDtoOfLogEntryDto.md)
|
636
829
|
- [Notifo::ListResponseDtoOfMediaDto](docs/ListResponseDtoOfMediaDto.md)
|
830
|
+
- [Notifo::ListResponseDtoOfMobilePushTokenDto](docs/ListResponseDtoOfMobilePushTokenDto.md)
|
831
|
+
- [Notifo::ListResponseDtoOfNotificationDto](docs/ListResponseDtoOfNotificationDto.md)
|
637
832
|
- [Notifo::ListResponseDtoOfSubscriptionDto](docs/ListResponseDtoOfSubscriptionDto.md)
|
638
833
|
- [Notifo::ListResponseDtoOfTemplateDto](docs/ListResponseDtoOfTemplateDto.md)
|
639
834
|
- [Notifo::ListResponseDtoOfTopicDto](docs/ListResponseDtoOfTopicDto.md)
|
@@ -643,18 +838,24 @@ Class | Method | HTTP request | Description
|
|
643
838
|
- [Notifo::MediaDto](docs/MediaDto.md)
|
644
839
|
- [Notifo::MediaMetadata](docs/MediaMetadata.md)
|
645
840
|
- [Notifo::MediaType](docs/MediaType.md)
|
841
|
+
- [Notifo::MobileDeviceType](docs/MobileDeviceType.md)
|
842
|
+
- [Notifo::MobilePushTokenDto](docs/MobilePushTokenDto.md)
|
843
|
+
- [Notifo::NotificationDto](docs/NotificationDto.md)
|
646
844
|
- [Notifo::NotificationFormattingDto](docs/NotificationFormattingDto.md)
|
647
845
|
- [Notifo::NotificationSend](docs/NotificationSend.md)
|
648
846
|
- [Notifo::NotificationSettingDto](docs/NotificationSettingDto.md)
|
649
847
|
- [Notifo::ProfileDto](docs/ProfileDto.md)
|
650
848
|
- [Notifo::PublishDto](docs/PublishDto.md)
|
651
849
|
- [Notifo::PublishManyDto](docs/PublishManyDto.md)
|
850
|
+
- [Notifo::RegisterMobileTokenDto](docs/RegisterMobileTokenDto.md)
|
652
851
|
- [Notifo::ResizeMode](docs/ResizeMode.md)
|
653
852
|
- [Notifo::SchedulingDto](docs/SchedulingDto.md)
|
654
853
|
- [Notifo::SchedulingType](docs/SchedulingType.md)
|
655
854
|
- [Notifo::SubscriptionDto](docs/SubscriptionDto.md)
|
656
855
|
- [Notifo::TemplateDto](docs/TemplateDto.md)
|
657
856
|
- [Notifo::TopicDto](docs/TopicDto.md)
|
857
|
+
- [Notifo::TrackNotificationDto](docs/TrackNotificationDto.md)
|
858
|
+
- [Notifo::UpdateIntegrationDto](docs/UpdateIntegrationDto.md)
|
658
859
|
- [Notifo::UpdateProfileDto](docs/UpdateProfileDto.md)
|
659
860
|
- [Notifo::UpsertAppDto](docs/UpsertAppDto.md)
|
660
861
|
- [Notifo::UpsertTemplateDto](docs/UpsertTemplateDto.md)
|
data/docs/AppDetailsDto.md
CHANGED
@@ -7,15 +7,7 @@ Name | Type | Description | Notes
|
|
7
7
|
**name** | **String** | The app name. |
|
8
8
|
**role** | **String** | The current role. |
|
9
9
|
**languages** | **Array<String>** | The supported languages. |
|
10
|
-
**email_address** | **String** | The sender email address. | [optional]
|
11
|
-
**email_name** | **String** | The sender email name. | [optional]
|
12
|
-
**firebase_project** | **String** | The firebase project ID. | [optional]
|
13
|
-
**firebase_credential** | **String** | The firebase credentials. | [optional]
|
14
|
-
**webhook_url** | **String** | The webhook URL. | [optional]
|
15
10
|
**confirm_url** | **String** | The confirm URL. | [optional]
|
16
|
-
**allow_email** | **BOOLEAN** | True, when emails are allowed. |
|
17
|
-
**allow_sms** | **BOOLEAN** | True, when SMS are allowed. |
|
18
|
-
**email_verification_status** | [**EmailVerificationStatus**](EmailVerificationStatus.md) | |
|
19
11
|
**api_keys** | **Hash<String, String>** | The api keys. |
|
20
12
|
**contributors** | [**Array<AppContributorDto>**](AppContributorDto.md) | The contributors. |
|
21
13
|
**counters** | **Hash<String, Integer>** | The statistics counters. |
|
data/docs/AppsApi.md
CHANGED
@@ -1,19 +1,23 @@
|
|
1
1
|
# Notifo::AppsApi
|
2
2
|
|
3
|
-
All URIs are relative to *https://
|
3
|
+
All URIs are relative to *https://notifo.easierlife.com*
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**apps_delete_contributor**](AppsApi.md#apps_delete_contributor) | **POST** /api/apps/{appId}/contributors/{contributorId} | Delete an app contributor.
|
8
|
-
[**apps_delete_email_template**](AppsApi.md#apps_delete_email_template) | **
|
8
|
+
[**apps_delete_email_template**](AppsApi.md#apps_delete_email_template) | **DELETE** /api/apps/{appId}/email-templates/{language} | Delete an app email template.
|
9
|
+
[**apps_delete_integration**](AppsApi.md#apps_delete_integration) | **DELETE** /api/apps/{appId}/integrations/{id} | Delete an app integration.
|
9
10
|
[**apps_get_app**](AppsApi.md#apps_get_app) | **GET** /api/apps/{appId} | Get app by id.
|
10
11
|
[**apps_get_apps**](AppsApi.md#apps_get_apps) | **GET** /api/apps | Get the user apps.
|
11
12
|
[**apps_get_email_templates**](AppsApi.md#apps_get_email_templates) | **GET** /api/apps/{appId}/email-templates | Get the app email templates.
|
13
|
+
[**apps_get_integrations**](AppsApi.md#apps_get_integrations) | **GET** /api/apps/{appId}/integrations | Get the app integrations.
|
12
14
|
[**apps_post_app**](AppsApi.md#apps_post_app) | **POST** /api/apps | Create an app.
|
13
15
|
[**apps_post_contributor**](AppsApi.md#apps_post_contributor) | **POST** /api/apps/{appId}/contributors | Add an app contributor.
|
14
16
|
[**apps_post_email_template**](AppsApi.md#apps_post_email_template) | **POST** /api/apps/{appId}/email-templates | Create an app email template.
|
17
|
+
[**apps_post_integration**](AppsApi.md#apps_post_integration) | **POST** /api/apps/{appId}/integration | Create an app integrations.
|
15
18
|
[**apps_put_app**](AppsApi.md#apps_put_app) | **POST** /api/apps/{appId} | Update an app.
|
16
19
|
[**apps_put_email_template**](AppsApi.md#apps_put_email_template) | **PUT** /api/apps/{appId}/email-templates/{language} | Update an app email template.
|
20
|
+
[**apps_put_integration**](AppsApi.md#apps_put_integration) | **PUT** /api/apps/{appId}/integrations/{id} | Update an app integration.
|
17
21
|
|
18
22
|
# **apps_delete_contributor**
|
19
23
|
> AppDetailsDto apps_delete_contributor(app_id, contributor_id)
|
@@ -106,6 +110,51 @@ No authorization required
|
|
106
110
|
|
107
111
|
|
108
112
|
|
113
|
+
# **apps_delete_integration**
|
114
|
+
> apps_delete_integration(app_id, id)
|
115
|
+
|
116
|
+
Delete an app integration.
|
117
|
+
|
118
|
+
### Example
|
119
|
+
```ruby
|
120
|
+
# load the gem
|
121
|
+
require 'notifo'
|
122
|
+
|
123
|
+
api_instance = Notifo::AppsApi.new
|
124
|
+
app_id = 'app_id_example' # String | The id of the app where the email templates belong to.
|
125
|
+
id = 'id_example' # String | The id of the integration.
|
126
|
+
|
127
|
+
|
128
|
+
begin
|
129
|
+
#Delete an app integration.
|
130
|
+
api_instance.apps_delete_integration(app_id, id)
|
131
|
+
rescue Notifo::ApiError => e
|
132
|
+
puts "Exception when calling AppsApi->apps_delete_integration: #{e}"
|
133
|
+
end
|
134
|
+
```
|
135
|
+
|
136
|
+
### Parameters
|
137
|
+
|
138
|
+
Name | Type | Description | Notes
|
139
|
+
------------- | ------------- | ------------- | -------------
|
140
|
+
**app_id** | **String**| The id of the app where the email templates belong to. |
|
141
|
+
**id** | **String**| The id of the integration. |
|
142
|
+
|
143
|
+
### Return type
|
144
|
+
|
145
|
+
nil (empty response body)
|
146
|
+
|
147
|
+
### Authorization
|
148
|
+
|
149
|
+
No authorization required
|
150
|
+
|
151
|
+
### HTTP request headers
|
152
|
+
|
153
|
+
- **Content-Type**: Not defined
|
154
|
+
- **Accept**: application/json
|
155
|
+
|
156
|
+
|
157
|
+
|
109
158
|
# **apps_get_app**
|
110
159
|
> AppDetailsDto apps_get_app(app_id)
|
111
160
|
|
@@ -233,6 +282,50 @@ No authorization required
|
|
233
282
|
|
234
283
|
|
235
284
|
|
285
|
+
# **apps_get_integrations**
|
286
|
+
> ConfiguredIntegrationsDto apps_get_integrations(app_id)
|
287
|
+
|
288
|
+
Get the app integrations.
|
289
|
+
|
290
|
+
### Example
|
291
|
+
```ruby
|
292
|
+
# load the gem
|
293
|
+
require 'notifo'
|
294
|
+
|
295
|
+
api_instance = Notifo::AppsApi.new
|
296
|
+
app_id = 'app_id_example' # String | The id of the app where the integrations belong to.
|
297
|
+
|
298
|
+
|
299
|
+
begin
|
300
|
+
#Get the app integrations.
|
301
|
+
result = api_instance.apps_get_integrations(app_id)
|
302
|
+
p result
|
303
|
+
rescue Notifo::ApiError => e
|
304
|
+
puts "Exception when calling AppsApi->apps_get_integrations: #{e}"
|
305
|
+
end
|
306
|
+
```
|
307
|
+
|
308
|
+
### Parameters
|
309
|
+
|
310
|
+
Name | Type | Description | Notes
|
311
|
+
------------- | ------------- | ------------- | -------------
|
312
|
+
**app_id** | **String**| The id of the app where the integrations belong to. |
|
313
|
+
|
314
|
+
### Return type
|
315
|
+
|
316
|
+
[**ConfiguredIntegrationsDto**](ConfiguredIntegrationsDto.md)
|
317
|
+
|
318
|
+
### Authorization
|
319
|
+
|
320
|
+
No authorization required
|
321
|
+
|
322
|
+
### HTTP request headers
|
323
|
+
|
324
|
+
- **Content-Type**: Not defined
|
325
|
+
- **Accept**: application/json
|
326
|
+
|
327
|
+
|
328
|
+
|
236
329
|
# **apps_post_app**
|
237
330
|
> AppDto apps_post_app(body)
|
238
331
|
|
@@ -369,6 +462,52 @@ No authorization required
|
|
369
462
|
|
370
463
|
|
371
464
|
|
465
|
+
# **apps_post_integration**
|
466
|
+
> IntegrationCreatedDto apps_post_integration(bodyapp_id)
|
467
|
+
|
468
|
+
Create an app integrations.
|
469
|
+
|
470
|
+
### Example
|
471
|
+
```ruby
|
472
|
+
# load the gem
|
473
|
+
require 'notifo'
|
474
|
+
|
475
|
+
api_instance = Notifo::AppsApi.new
|
476
|
+
body = Notifo::CreateIntegrationDto.new # CreateIntegrationDto | The request object.
|
477
|
+
app_id = 'app_id_example' # String | The id of the app where the integration belong to.
|
478
|
+
|
479
|
+
|
480
|
+
begin
|
481
|
+
#Create an app integrations.
|
482
|
+
result = api_instance.apps_post_integration(bodyapp_id)
|
483
|
+
p result
|
484
|
+
rescue Notifo::ApiError => e
|
485
|
+
puts "Exception when calling AppsApi->apps_post_integration: #{e}"
|
486
|
+
end
|
487
|
+
```
|
488
|
+
|
489
|
+
### Parameters
|
490
|
+
|
491
|
+
Name | Type | Description | Notes
|
492
|
+
------------- | ------------- | ------------- | -------------
|
493
|
+
**body** | [**CreateIntegrationDto**](CreateIntegrationDto.md)| The request object. |
|
494
|
+
**app_id** | **String**| The id of the app where the integration belong to. |
|
495
|
+
|
496
|
+
### Return type
|
497
|
+
|
498
|
+
[**IntegrationCreatedDto**](IntegrationCreatedDto.md)
|
499
|
+
|
500
|
+
### Authorization
|
501
|
+
|
502
|
+
No authorization required
|
503
|
+
|
504
|
+
### HTTP request headers
|
505
|
+
|
506
|
+
- **Content-Type**: application/json
|
507
|
+
- **Accept**: application/json
|
508
|
+
|
509
|
+
|
510
|
+
|
372
511
|
# **apps_put_app**
|
373
512
|
> AppDetailsDto apps_put_app(bodyapp_id)
|
374
513
|
|
@@ -462,3 +601,50 @@ No authorization required
|
|
462
601
|
|
463
602
|
|
464
603
|
|
604
|
+
# **apps_put_integration**
|
605
|
+
> apps_put_integration(bodyapp_idid)
|
606
|
+
|
607
|
+
Update an app integration.
|
608
|
+
|
609
|
+
### Example
|
610
|
+
```ruby
|
611
|
+
# load the gem
|
612
|
+
require 'notifo'
|
613
|
+
|
614
|
+
api_instance = Notifo::AppsApi.new
|
615
|
+
body = Notifo::UpdateIntegrationDto.new # UpdateIntegrationDto | The request object.
|
616
|
+
app_id = 'app_id_example' # String | The id of the app where the integration belong to.
|
617
|
+
id = 'id_example' # String | The id of the integration.
|
618
|
+
|
619
|
+
|
620
|
+
begin
|
621
|
+
#Update an app integration.
|
622
|
+
api_instance.apps_put_integration(bodyapp_idid)
|
623
|
+
rescue Notifo::ApiError => e
|
624
|
+
puts "Exception when calling AppsApi->apps_put_integration: #{e}"
|
625
|
+
end
|
626
|
+
```
|
627
|
+
|
628
|
+
### Parameters
|
629
|
+
|
630
|
+
Name | Type | Description | Notes
|
631
|
+
------------- | ------------- | ------------- | -------------
|
632
|
+
**body** | [**UpdateIntegrationDto**](UpdateIntegrationDto.md)| The request object. |
|
633
|
+
**app_id** | **String**| The id of the app where the integration belong to. |
|
634
|
+
**id** | **String**| The id of the integration. |
|
635
|
+
|
636
|
+
### Return type
|
637
|
+
|
638
|
+
nil (empty response body)
|
639
|
+
|
640
|
+
### Authorization
|
641
|
+
|
642
|
+
No authorization required
|
643
|
+
|
644
|
+
### HTTP request headers
|
645
|
+
|
646
|
+
- **Content-Type**: application/json
|
647
|
+
- **Accept**: application/json
|
648
|
+
|
649
|
+
|
650
|
+
|