notifo-io 1.0.1.2 → 1.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +646 -149
- data/docs/AppDetailsDto.md +3 -1
- data/docs/AppDto.md +2 -0
- data/docs/AppsApi.md +0 -186
- data/docs/{NotificationSend.md → ChannelCondition.md} +1 -1
- data/docs/{EventProperties.md → ChannelSend.md} +1 -1
- data/docs/ChannelSendInfoDto.md +9 -0
- data/docs/ChannelSettingDto.md +11 -0
- data/docs/ChannelTemplateDetailsDtoOfEmailTemplateDto.md +12 -0
- data/docs/ChannelTemplateDetailsDtoOfMessagingTemplateDto.md +12 -0
- data/docs/ChannelTemplateDetailsDtoOfSmsTemplateDto.md +12 -0
- data/docs/ChannelTemplateDto.md +11 -0
- data/docs/ConfiguredIntegrationDto.md +2 -1
- data/docs/CreateChannelTemplateDto.md +7 -0
- data/docs/{CreateEmailTemplateDto.md → CreateChannelTemplateLanguageDto.md} +1 -1
- data/docs/CreateIntegrationDto.md +1 -1
- data/docs/CreateSystemUserDto.md +9 -0
- data/docs/EmailFormattingError.md +10 -0
- data/docs/EmailPreviewDto.md +8 -0
- data/docs/EmailPreviewRequestDto.md +9 -0
- data/docs/{EmailTemplatesDto.md → EmailPreviewType.md} +1 -1
- data/docs/EmailTemplateDto.md +3 -0
- data/docs/{IntegrationProperties.md → EmailTemplateType.md} +1 -1
- data/docs/EmailTemplatesApi.md +488 -0
- data/docs/ErrorDto.md +1 -0
- data/docs/EventDto.md +3 -1
- data/docs/EventsApi.md +7 -5
- data/docs/HandledInfoDto.md +8 -0
- data/docs/IntegrationPropertyDto.md +2 -0
- data/docs/ListResponseDtoOfChannelTemplateDto.md +8 -0
- data/docs/ListResponseDtoOfMobilePushTokenDto.md +1 -1
- data/docs/{ListResponseDtoOfNotificationDto.md → ListResponseDtoOfSystemUserDto.md} +2 -2
- data/docs/ListResponseDtoOfUserNotificationDetailsDto.md +8 -0
- data/docs/ListResponseDtoOfUserNotificationDto.md +8 -0
- data/docs/MediaDto.md +3 -1
- data/docs/{Body.md → MessagingTemplateDto.md} +2 -2
- data/docs/MessagingTemplatesApi.md +394 -0
- data/docs/MobilePushApi.md +15 -15
- data/docs/MobilePushTokenDto.md +3 -2
- data/docs/MobilePushTokenDto2.md +8 -0
- data/docs/NotificationFormattingDto.md +1 -1
- data/docs/NotificationProperties.md +6 -0
- data/docs/NotificationsApi.md +74 -16
- data/docs/PingApi.md +48 -0
- data/docs/ProcessStatus.md +6 -0
- data/docs/ProfileDto.md +2 -1
- data/docs/PublishDto.md +2 -2
- data/docs/{EmailVerificationStatus.md → SmsTemplateDto.md} +2 -1
- data/docs/SmsTemplatesApi.md +394 -0
- data/docs/SubscribeDto.md +8 -0
- data/docs/SubscribeManyDto.md +8 -0
- data/docs/SubscriptionDto.md +1 -1
- data/docs/SystemUserDto.md +11 -0
- data/docs/SystemUsersApi.md +327 -0
- data/docs/TemplateDto.md +3 -1
- data/docs/TemplatesApi.md +3 -4
- data/docs/TopicChannel.md +6 -0
- data/docs/TopicDto.md +7 -1
- data/docs/TopicQueryScope.md +6 -0
- data/docs/TopicsApi.md +95 -0
- data/docs/UpdateChannelTemplateDtoOfEmailTemplateDto.md +9 -0
- data/docs/UpdateChannelTemplateDtoOfMessagingTemplateDto.md +9 -0
- data/docs/UpdateChannelTemplateDtoOfSmsTemplateDto.md +9 -0
- data/docs/UpdateIntegrationDto.md +2 -1
- data/docs/UpdateProfileDto.md +1 -1
- data/docs/UpdateSystemUserDto.md +9 -0
- data/docs/UpsertTemplateDto.md +1 -1
- data/docs/UpsertTopicDto.md +11 -0
- data/docs/UpsertTopicsDto.md +7 -0
- data/docs/UpsertUserDto.md +2 -2
- data/docs/UserApi.md +119 -21
- data/docs/UserDto.md +7 -2
- data/docs/UserNotificationBaseDto.md +23 -0
- data/docs/UserNotificationChannelDto.md +11 -0
- data/docs/UserNotificationDetailsDto.md +27 -0
- data/docs/{NotificationDto.md → UserNotificationDto.md} +9 -5
- data/docs/UserPropertyDto.md +9 -0
- data/docs/UserTopicDto.md +11 -0
- data/docs/UsersApi.md +37 -32
- data/lib/notifo/api/apps_api.rb +1 -245
- data/lib/notifo/api/configs_api.rb +1 -1
- data/lib/notifo/api/email_templates_api.rb +663 -0
- data/lib/notifo/api/events_api.rb +10 -7
- data/lib/notifo/api/logs_api.rb +1 -1
- data/lib/notifo/api/media_api.rb +1 -1
- data/lib/notifo/api/messaging_templates_api.rb +541 -0
- data/lib/notifo/api/mobile_push_api.rb +18 -18
- data/lib/notifo/api/notifications_api.rb +97 -22
- data/lib/notifo/api/ping_api.rb +70 -0
- data/lib/notifo/api/sms_templates_api.rb +541 -0
- data/lib/notifo/api/system_users_api.rb +411 -0
- data/lib/notifo/api/templates_api.rb +6 -6
- data/lib/notifo/api/topics_api.rb +126 -1
- data/lib/notifo/api/user_api.rb +138 -27
- data/lib/notifo/api/users_api.rb +38 -32
- data/lib/notifo/api_client.rb +1 -1
- data/lib/notifo/api_error.rb +1 -1
- data/lib/notifo/configuration.rb +1 -1
- 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 +41 -11
- data/lib/notifo/models/app_dto.rb +32 -2
- data/lib/notifo/models/app_id_media_body.rb +1 -1
- data/lib/notifo/models/channel_condition.rb +30 -0
- data/lib/notifo/models/{notification_send.rb → channel_send.rb} +4 -4
- data/lib/notifo/models/channel_send_info_dto.rb +227 -0
- data/lib/notifo/models/channel_setting_dto.rb +256 -0
- data/lib/notifo/models/channel_template_details_dto_of_email_template_dto.rb +285 -0
- data/lib/notifo/models/channel_template_details_dto_of_messaging_template_dto.rb +285 -0
- data/lib/notifo/models/channel_template_details_dto_of_sms_template_dto.rb +285 -0
- data/lib/notifo/models/channel_template_dto.rb +264 -0
- data/lib/notifo/models/configured_integration_dto.rb +17 -3
- data/lib/notifo/models/configured_integrations_dto.rb +1 -1
- data/lib/notifo/models/confirm_mode.rb +2 -3
- data/lib/notifo/models/{body.rb → create_channel_template_dto.rb} +13 -11
- data/lib/notifo/models/{create_email_template_dto.rb → create_channel_template_language_dto.rb} +4 -4
- data/lib/notifo/models/create_integration_dto.rb +7 -2
- data/lib/notifo/models/create_system_user_dto.rb +240 -0
- data/lib/notifo/models/email_formatting_error.rb +233 -0
- data/lib/notifo/models/email_preview_dto.rb +221 -0
- data/lib/notifo/models/email_preview_request_dto.rb +232 -0
- data/lib/notifo/models/email_preview_type.rb +28 -0
- data/lib/notifo/models/email_template_dto.rb +39 -6
- data/lib/notifo/models/email_template_type.rb +30 -0
- data/lib/notifo/models/error_dto.rb +13 -2
- data/lib/notifo/models/event_dto.rb +24 -2
- data/lib/notifo/models/handled_info_dto.rb +218 -0
- data/lib/notifo/models/integration_created_dto.rb +1 -1
- data/lib/notifo/models/integration_definition_dto.rb +1 -1
- data/lib/notifo/models/integration_property_dto.rb +30 -2
- data/lib/notifo/models/integration_property_type.rb +1 -1
- data/lib/notifo/models/integration_status.rb +1 -1
- data/lib/notifo/models/iso_day_of_week.rb +1 -1
- data/lib/notifo/models/list_response_dto_of_channel_template_dto.rb +229 -0
- 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 +1 -1
- data/lib/notifo/models/list_response_dto_of_subscription_dto.rb +1 -1
- data/lib/notifo/models/{list_response_dto_of_notification_dto.rb → list_response_dto_of_system_user_dto.rb} +4 -4
- 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/list_response_dto_of_user_notification_details_dto.rb +229 -0
- data/lib/notifo/models/list_response_dto_of_user_notification_dto.rb +229 -0
- 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 +42 -12
- data/lib/notifo/models/media_metadata.rb +1 -1
- data/lib/notifo/models/media_type.rb +1 -1
- data/lib/notifo/models/messaging_template_dto.rb +212 -0
- data/lib/notifo/models/mobile_device_type.rb +1 -1
- data/lib/notifo/models/mobile_push_token_dto.rb +22 -6
- data/lib/notifo/models/{notification_setting_dto.rb → mobile_push_token_dto2.rb} +21 -22
- data/lib/notifo/models/notification_formatting_dto.rb +1 -6
- data/lib/notifo/models/{event_properties.rb → notification_properties.rb} +4 -4
- data/lib/notifo/models/{email_verification_status.rb → process_status.rb} +8 -7
- data/lib/notifo/models/profile_dto.rb +14 -2
- data/lib/notifo/models/publish_dto.rb +1 -1
- data/lib/notifo/models/publish_many_dto.rb +1 -1
- data/lib/notifo/models/register_mobile_token_dto.rb +1 -1
- data/lib/notifo/models/resize_mode.rb +1 -1
- data/lib/notifo/models/scheduling_dto.rb +1 -1
- data/lib/notifo/models/scheduling_type.rb +1 -1
- data/lib/notifo/models/{email_templates_dto.rb → sms_template_dto.rb} +22 -11
- data/lib/notifo/models/subscribe_dto.rb +225 -0
- data/lib/notifo/models/subscribe_many_dto.rb +223 -0
- data/lib/notifo/models/subscription_dto.rb +6 -2
- data/lib/notifo/models/system_user_dto.rb +269 -0
- data/lib/notifo/models/template_dto.rb +32 -2
- data/lib/notifo/models/topic_channel.rb +28 -0
- data/lib/notifo/models/topic_dto.rb +69 -3
- data/lib/notifo/models/topic_query_scope.rb +29 -0
- data/lib/notifo/models/track_notification_dto.rb +1 -1
- data/lib/notifo/models/update_channel_template_dto_of_email_template_dto.rb +232 -0
- data/lib/notifo/models/update_channel_template_dto_of_messaging_template_dto.rb +232 -0
- data/lib/notifo/models/update_channel_template_dto_of_sms_template_dto.rb +232 -0
- data/lib/notifo/models/update_integration_dto.rb +19 -3
- data/lib/notifo/models/update_profile_dto.rb +1 -1
- data/lib/notifo/models/update_system_user_dto.rb +240 -0
- data/lib/notifo/models/upsert_app_dto.rb +1 -1
- data/lib/notifo/models/upsert_template_dto.rb +1 -1
- data/lib/notifo/models/upsert_templates_dto.rb +1 -1
- data/lib/notifo/models/upsert_topic_dto.rb +249 -0
- data/lib/notifo/models/upsert_topics_dto.rb +214 -0
- data/lib/notifo/models/upsert_user_dto.rb +15 -13
- data/lib/notifo/models/upsert_users_dto.rb +1 -1
- data/lib/notifo/models/user_dto.rb +89 -16
- data/lib/notifo/models/{notification_dto.rb → user_notification_base_dto.rb} +62 -46
- data/lib/notifo/models/user_notification_channel_dto.rb +261 -0
- data/lib/notifo/models/user_notification_details_dto.rb +450 -0
- data/lib/notifo/models/user_notification_dto.rb +436 -0
- data/lib/notifo/models/user_property_dto.rb +234 -0
- data/lib/notifo/models/user_topic_dto.rb +265 -0
- data/lib/notifo/version.rb +1 -1
- data/lib/notifo.rb +49 -11
- data/notifo.gemspec +3 -3
- data/spec/api/apps_api_spec.rb +20 -20
- data/spec/api/configs_api_spec.rb +1 -1
- data/spec/api/email_templates_api_spec.rb +161 -0
- data/spec/api/events_api_spec.rb +13 -1
- data/spec/api/logs_api_spec.rb +1 -1
- data/spec/api/media_api_spec.rb +1 -1
- data/spec/api/messaging_templates_api_spec.rb +137 -0
- data/spec/api/mobile_push_api_spec.rb +7 -7
- data/spec/api/notifications_api_spec.rb +25 -8
- data/spec/api/ping_api_spec.rb +45 -0
- data/spec/api/sms_templates_api_spec.rb +137 -0
- data/spec/api/system_users_api_spec.rb +114 -0
- data/spec/api/templates_api_spec.rb +2 -2
- data/spec/api/topics_api_spec.rb +26 -1
- data/spec/api/user_api_spec.rb +33 -8
- data/spec/api/users_api_spec.rb +15 -13
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +4 -4
- data/spec/models/add_allowed_topic_dto_spec.rb +1 -1
- data/spec/models/add_contributor_dto_spec.rb +1 -1
- data/spec/models/app_contributor_dto_spec.rb +1 -1
- data/spec/models/app_details_dto_spec.rb +4 -40
- data/spec/models/app_dto_spec.rb +13 -1
- data/spec/models/app_id_media_body_spec.rb +1 -1
- data/spec/models/{notification_send_spec.rb → channel_condition_spec.rb} +7 -7
- data/spec/models/channel_send_info_dto_spec.rb +52 -0
- data/spec/models/{event_properties_spec.rb → channel_send_spec.rb} +7 -7
- data/spec/models/channel_setting_dto_spec.rb +64 -0
- data/spec/models/channel_template_details_dto_of_email_template_dto_spec.rb +70 -0
- data/spec/models/channel_template_details_dto_of_messaging_template_dto_spec.rb +70 -0
- data/spec/models/channel_template_details_dto_of_sms_template_dto_spec.rb +70 -0
- data/spec/models/channel_template_dto_spec.rb +64 -0
- data/spec/models/configured_integration_dto_spec.rb +7 -1
- data/spec/models/configured_integrations_dto_spec.rb +1 -1
- data/spec/models/confirm_mode_spec.rb +1 -1
- data/spec/models/create_channel_template_dto_spec.rb +40 -0
- data/spec/models/{create_email_template_dto_spec.rb → create_channel_template_language_dto_spec.rb} +7 -7
- data/spec/models/create_integration_dto_spec.rb +1 -1
- data/spec/models/create_system_user_dto_spec.rb +52 -0
- data/spec/{api/authorization_api_spec.rb → models/email_formatting_error_spec.rb} +16 -19
- data/spec/models/{notification_setting_dto_spec.rb → email_preview_dto_spec.rb} +9 -9
- data/spec/models/email_preview_request_dto_spec.rb +52 -0
- data/spec/models/{email_templates_dto_spec.rb → email_preview_type_spec.rb} +7 -7
- data/spec/models/email_template_dto_spec.rb +19 -1
- data/spec/models/{integration_properties_spec.rb → email_template_type_spec.rb} +7 -7
- data/spec/models/error_dto_spec.rb +7 -1
- data/spec/models/event_dto_spec.rb +19 -1
- data/spec/models/handled_info_dto_spec.rb +46 -0
- data/spec/models/integration_created_dto_spec.rb +1 -1
- data/spec/models/integration_definition_dto_spec.rb +1 -1
- data/spec/models/integration_property_dto_spec.rb +13 -1
- data/spec/models/integration_property_type_spec.rb +1 -1
- data/spec/models/integration_status_spec.rb +1 -1
- data/spec/models/iso_day_of_week_spec.rb +1 -1
- data/spec/models/list_response_dto_of_channel_template_dto_spec.rb +46 -0
- data/spec/models/list_response_dto_of_event_dto_spec.rb +1 -1
- data/spec/models/list_response_dto_of_log_entry_dto_spec.rb +1 -1
- data/spec/models/list_response_dto_of_media_dto_spec.rb +1 -1
- data/spec/models/list_response_dto_of_mobile_push_token_dto_spec.rb +1 -1
- data/spec/models/list_response_dto_of_subscription_dto_spec.rb +1 -1
- data/spec/models/{list_response_dto_of_notification_dto_spec.rb → list_response_dto_of_system_user_dto_spec.rb} +7 -7
- data/spec/models/list_response_dto_of_template_dto_spec.rb +1 -1
- data/spec/models/list_response_dto_of_topic_dto_spec.rb +1 -1
- data/spec/models/list_response_dto_of_user_dto_spec.rb +1 -1
- data/spec/models/list_response_dto_of_user_notification_details_dto_spec.rb +46 -0
- data/spec/{api/user_info_api_spec.rb → models/list_response_dto_of_user_notification_dto_spec.rb} +10 -16
- data/spec/models/localized_text_spec.rb +1 -1
- data/spec/models/log_entry_dto_spec.rb +1 -1
- data/spec/models/media_dto_spec.rb +14 -2
- data/spec/models/media_metadata_spec.rb +1 -1
- data/spec/models/media_type_spec.rb +1 -1
- data/spec/models/messaging_template_dto_spec.rb +40 -0
- data/spec/models/mobile_device_type_spec.rb +1 -1
- data/spec/models/mobile_push_token_dto2_spec.rb +46 -0
- data/spec/models/mobile_push_token_dto_spec.rb +7 -1
- data/spec/models/notification_formatting_dto_spec.rb +1 -1
- data/spec/models/notification_properties_spec.rb +34 -0
- data/spec/models/process_status_spec.rb +34 -0
- data/spec/models/profile_dto_spec.rb +7 -1
- data/spec/models/publish_dto_spec.rb +13 -1
- data/spec/models/publish_many_dto_spec.rb +1 -1
- data/spec/models/register_mobile_token_dto_spec.rb +1 -1
- data/spec/models/resize_mode_spec.rb +1 -1
- data/spec/models/scheduling_dto_spec.rb +1 -1
- data/spec/models/scheduling_type_spec.rb +1 -1
- data/spec/models/{body_spec.rb → sms_template_dto_spec.rb} +8 -8
- data/spec/models/subscribe_dto_spec.rb +46 -0
- data/spec/models/subscribe_many_dto_spec.rb +46 -0
- data/spec/models/subscription_dto_spec.rb +1 -1
- data/spec/models/system_user_dto_spec.rb +64 -0
- data/spec/models/template_dto_spec.rb +13 -1
- data/spec/models/topic_channel_spec.rb +34 -0
- data/spec/models/topic_dto_spec.rb +37 -1
- data/spec/models/topic_query_scope_spec.rb +34 -0
- data/spec/models/track_notification_dto_spec.rb +1 -1
- data/spec/models/update_channel_template_dto_of_email_template_dto_spec.rb +52 -0
- data/spec/models/update_channel_template_dto_of_messaging_template_dto_spec.rb +52 -0
- data/spec/models/update_channel_template_dto_of_sms_template_dto_spec.rb +52 -0
- data/spec/models/update_integration_dto_spec.rb +7 -1
- data/spec/models/update_profile_dto_spec.rb +1 -1
- data/spec/models/update_system_user_dto_spec.rb +52 -0
- data/spec/models/upsert_app_dto_spec.rb +1 -1
- data/spec/models/upsert_template_dto_spec.rb +1 -1
- data/spec/models/upsert_templates_dto_spec.rb +1 -1
- data/spec/models/upsert_topic_dto_spec.rb +64 -0
- data/spec/models/upsert_topics_dto_spec.rb +40 -0
- data/spec/models/upsert_user_dto_spec.rb +7 -1
- data/spec/models/upsert_users_dto_spec.rb +1 -1
- data/spec/models/user_dto_spec.rb +49 -1
- data/spec/models/{notification_dto_spec.rb → user_notification_base_dto_spec.rb} +23 -11
- data/spec/models/user_notification_channel_dto_spec.rb +64 -0
- data/spec/models/user_notification_details_dto_spec.rb +160 -0
- data/spec/models/user_notification_dto_spec.rb +148 -0
- data/spec/models/user_property_dto_spec.rb +52 -0
- data/spec/models/user_topic_dto_spec.rb +64 -0
- data/spec/spec_helper.rb +1 -1
- metadata +207 -64
- data/docs/AuthorizationApi.md +0 -121
- data/docs/NotificationSettingDto.md +0 -8
- data/docs/UserInfoApi.md +0 -83
- data/lib/notifo/api/authorization_api.rb +0 -158
- data/lib/notifo/api/user_info_api.rb +0 -112
- data/lib/notifo/models/integration_properties.rb +0 -201
- data/notifo-io-1.0.1.1.gem +0 -0
- data/spec/models/email_verification_status_spec.rb +0 -34
data/docs/PingApi.md
ADDED
@@ -0,0 +1,48 @@
|
|
1
|
+
# Notifo::PingApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://notifo.easierlife.com*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**ping_get_ping**](PingApi.md#ping_get_ping) | **GET** /ping | Get ping status of the API.
|
8
|
+
|
9
|
+
# **ping_get_ping**
|
10
|
+
> ping_get_ping
|
11
|
+
|
12
|
+
Get ping status of the API.
|
13
|
+
|
14
|
+
Can be used to test, if the Squidex API is alive and responding.
|
15
|
+
|
16
|
+
### Example
|
17
|
+
```ruby
|
18
|
+
# load the gem
|
19
|
+
require 'notifo'
|
20
|
+
|
21
|
+
api_instance = Notifo::PingApi.new
|
22
|
+
|
23
|
+
begin
|
24
|
+
#Get ping status of the API.
|
25
|
+
api_instance.ping_get_ping
|
26
|
+
rescue Notifo::ApiError => e
|
27
|
+
puts "Exception when calling PingApi->ping_get_ping: #{e}"
|
28
|
+
end
|
29
|
+
```
|
30
|
+
|
31
|
+
### Parameters
|
32
|
+
This endpoint does not need any parameter.
|
33
|
+
|
34
|
+
### Return type
|
35
|
+
|
36
|
+
nil (empty response body)
|
37
|
+
|
38
|
+
### Authorization
|
39
|
+
|
40
|
+
No authorization required
|
41
|
+
|
42
|
+
### HTTP request headers
|
43
|
+
|
44
|
+
- **Content-Type**: Not defined
|
45
|
+
- **Accept**: application/json
|
46
|
+
|
47
|
+
|
48
|
+
|
data/docs/ProfileDto.md
CHANGED
@@ -6,9 +6,10 @@ Name | Type | Description | Notes
|
|
6
6
|
**full_name** | **String** | The full name of the user. |
|
7
7
|
**email_address** | **String** | The email of the user. |
|
8
8
|
**phone_number** | **String** | The phone number. | [optional]
|
9
|
+
**allowed_topics** | **Array<String>** | The allowed Topics. | [optional]
|
9
10
|
**preferred_language** | **String** | The preferred language of the user. | [optional]
|
10
11
|
**preferred_timezone** | **String** | The timezone of the user. | [optional]
|
11
12
|
**supported_languages** | **Array<String>** | The supported languages. |
|
12
13
|
**supported_timezones** | **Array<String>** | The supported timezones. |
|
13
|
-
**settings** | [**Hash<String,
|
14
|
+
**settings** | [**Hash<String, ChannelSettingDto>**](ChannelSettingDto.md) | Notification settings per channel. |
|
14
15
|
|
data/docs/PublishDto.md
CHANGED
@@ -9,8 +9,8 @@ Name | Type | Description | Notes
|
|
9
9
|
**data** | **String** | Additional user defined data. | [optional]
|
10
10
|
**timestamp** | **DateTime** | A custom timestamp. | [optional]
|
11
11
|
**preformatted** | [**NotificationFormattingDto**](NotificationFormattingDto.md) | | [optional]
|
12
|
-
**settings** | [**Hash<String,
|
13
|
-
**properties** | [**
|
12
|
+
**settings** | [**Hash<String, ChannelSettingDto>**](ChannelSettingDto.md) | The notification settings. | [optional]
|
13
|
+
**properties** | [**NotificationProperties**](NotificationProperties.md) | | [optional]
|
14
14
|
**scheduling** | [**SchedulingDto**](SchedulingDto.md) | | [optional]
|
15
15
|
**silent** | **BOOLEAN** | True when silent. | [optional]
|
16
16
|
**test** | **BOOLEAN** | True when using test integrations. | [optional]
|
@@ -0,0 +1,394 @@
|
|
1
|
+
# Notifo::SmsTemplatesApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://notifo.easierlife.com*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**sms_templates_delete_template**](SmsTemplatesApi.md#sms_templates_delete_template) | **DELETE** /api/apps/{appId}/sms-templates/{id} | Delete a channel template.
|
8
|
+
[**sms_templates_delete_template_language**](SmsTemplatesApi.md#sms_templates_delete_template_language) | **DELETE** /api/apps/{appId}/sms-templates/{id}/{language} | Delete a language channel template.
|
9
|
+
[**sms_templates_get_template**](SmsTemplatesApi.md#sms_templates_get_template) | **GET** /api/apps/{appId}/sms-templates/{id} | Get the channel template by id.
|
10
|
+
[**sms_templates_get_templates**](SmsTemplatesApi.md#sms_templates_get_templates) | **GET** /api/apps/{appId}/sms-templates | Get the channel templates.
|
11
|
+
[**sms_templates_post_template**](SmsTemplatesApi.md#sms_templates_post_template) | **POST** /api/apps/{appId}/sms-templates | Create a channel template.
|
12
|
+
[**sms_templates_post_template_language**](SmsTemplatesApi.md#sms_templates_post_template_language) | **POST** /api/apps/{appId}/sms-templates/{id} | Create an app template language.
|
13
|
+
[**sms_templates_put_template**](SmsTemplatesApi.md#sms_templates_put_template) | **PUT** /api/apps/{appId}/sms-templates/{id} | Update an app template.
|
14
|
+
[**sms_templates_put_template_language**](SmsTemplatesApi.md#sms_templates_put_template_language) | **PUT** /api/apps/{appId}/sms-templates/{id}/{language} | Update a channel template language.
|
15
|
+
|
16
|
+
# **sms_templates_delete_template**
|
17
|
+
> sms_templates_delete_template(app_id, id)
|
18
|
+
|
19
|
+
Delete a channel template.
|
20
|
+
|
21
|
+
### Example
|
22
|
+
```ruby
|
23
|
+
# load the gem
|
24
|
+
require 'notifo'
|
25
|
+
|
26
|
+
api_instance = Notifo::SmsTemplatesApi.new
|
27
|
+
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
|
28
|
+
id = 'id_example' # String | The template ID.
|
29
|
+
|
30
|
+
|
31
|
+
begin
|
32
|
+
#Delete a channel template.
|
33
|
+
api_instance.sms_templates_delete_template(app_id, id)
|
34
|
+
rescue Notifo::ApiError => e
|
35
|
+
puts "Exception when calling SmsTemplatesApi->sms_templates_delete_template: #{e}"
|
36
|
+
end
|
37
|
+
```
|
38
|
+
|
39
|
+
### Parameters
|
40
|
+
|
41
|
+
Name | Type | Description | Notes
|
42
|
+
------------- | ------------- | ------------- | -------------
|
43
|
+
**app_id** | **String**| The id of the app where the templates belong to. |
|
44
|
+
**id** | **String**| The template ID. |
|
45
|
+
|
46
|
+
### Return type
|
47
|
+
|
48
|
+
nil (empty response body)
|
49
|
+
|
50
|
+
### Authorization
|
51
|
+
|
52
|
+
No authorization required
|
53
|
+
|
54
|
+
### HTTP request headers
|
55
|
+
|
56
|
+
- **Content-Type**: Not defined
|
57
|
+
- **Accept**: application/json
|
58
|
+
|
59
|
+
|
60
|
+
|
61
|
+
# **sms_templates_delete_template_language**
|
62
|
+
> sms_templates_delete_template_language(app_id, id, language)
|
63
|
+
|
64
|
+
Delete a language channel template.
|
65
|
+
|
66
|
+
### Example
|
67
|
+
```ruby
|
68
|
+
# load the gem
|
69
|
+
require 'notifo'
|
70
|
+
|
71
|
+
api_instance = Notifo::SmsTemplatesApi.new
|
72
|
+
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
|
73
|
+
id = 'id_example' # String | The template ID.
|
74
|
+
language = 'language_example' # String | The language.
|
75
|
+
|
76
|
+
|
77
|
+
begin
|
78
|
+
#Delete a language channel template.
|
79
|
+
api_instance.sms_templates_delete_template_language(app_id, id, language)
|
80
|
+
rescue Notifo::ApiError => e
|
81
|
+
puts "Exception when calling SmsTemplatesApi->sms_templates_delete_template_language: #{e}"
|
82
|
+
end
|
83
|
+
```
|
84
|
+
|
85
|
+
### Parameters
|
86
|
+
|
87
|
+
Name | Type | Description | Notes
|
88
|
+
------------- | ------------- | ------------- | -------------
|
89
|
+
**app_id** | **String**| The id of the app where the templates belong to. |
|
90
|
+
**id** | **String**| The template ID. |
|
91
|
+
**language** | **String**| The language. |
|
92
|
+
|
93
|
+
### Return type
|
94
|
+
|
95
|
+
nil (empty response body)
|
96
|
+
|
97
|
+
### Authorization
|
98
|
+
|
99
|
+
No authorization required
|
100
|
+
|
101
|
+
### HTTP request headers
|
102
|
+
|
103
|
+
- **Content-Type**: Not defined
|
104
|
+
- **Accept**: application/json
|
105
|
+
|
106
|
+
|
107
|
+
|
108
|
+
# **sms_templates_get_template**
|
109
|
+
> ChannelTemplateDetailsDtoOfSmsTemplateDto sms_templates_get_template(app_id, id)
|
110
|
+
|
111
|
+
Get the channel template by id.
|
112
|
+
|
113
|
+
### Example
|
114
|
+
```ruby
|
115
|
+
# load the gem
|
116
|
+
require 'notifo'
|
117
|
+
|
118
|
+
api_instance = Notifo::SmsTemplatesApi.new
|
119
|
+
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
|
120
|
+
id = 'id_example' # String | The template ID.
|
121
|
+
|
122
|
+
|
123
|
+
begin
|
124
|
+
#Get the channel template by id.
|
125
|
+
result = api_instance.sms_templates_get_template(app_id, id)
|
126
|
+
p result
|
127
|
+
rescue Notifo::ApiError => e
|
128
|
+
puts "Exception when calling SmsTemplatesApi->sms_templates_get_template: #{e}"
|
129
|
+
end
|
130
|
+
```
|
131
|
+
|
132
|
+
### Parameters
|
133
|
+
|
134
|
+
Name | Type | Description | Notes
|
135
|
+
------------- | ------------- | ------------- | -------------
|
136
|
+
**app_id** | **String**| The id of the app where the templates belong to. |
|
137
|
+
**id** | **String**| The template ID. |
|
138
|
+
|
139
|
+
### Return type
|
140
|
+
|
141
|
+
[**ChannelTemplateDetailsDtoOfSmsTemplateDto**](ChannelTemplateDetailsDtoOfSmsTemplateDto.md)
|
142
|
+
|
143
|
+
### Authorization
|
144
|
+
|
145
|
+
No authorization required
|
146
|
+
|
147
|
+
### HTTP request headers
|
148
|
+
|
149
|
+
- **Content-Type**: Not defined
|
150
|
+
- **Accept**: application/json
|
151
|
+
|
152
|
+
|
153
|
+
|
154
|
+
# **sms_templates_get_templates**
|
155
|
+
> ListResponseDtoOfChannelTemplateDto sms_templates_get_templates(app_id, opts)
|
156
|
+
|
157
|
+
Get the channel templates.
|
158
|
+
|
159
|
+
### Example
|
160
|
+
```ruby
|
161
|
+
# load the gem
|
162
|
+
require 'notifo'
|
163
|
+
|
164
|
+
api_instance = Notifo::SmsTemplatesApi.new
|
165
|
+
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
|
166
|
+
opts = {
|
167
|
+
query: 'query_example', # String | The optional query to search for items.
|
168
|
+
take: 56, # Integer | The number of items to return.
|
169
|
+
skip: 56 # Integer | The number of items to skip.
|
170
|
+
}
|
171
|
+
|
172
|
+
begin
|
173
|
+
#Get the channel templates.
|
174
|
+
result = api_instance.sms_templates_get_templates(app_id, opts)
|
175
|
+
p result
|
176
|
+
rescue Notifo::ApiError => e
|
177
|
+
puts "Exception when calling SmsTemplatesApi->sms_templates_get_templates: #{e}"
|
178
|
+
end
|
179
|
+
```
|
180
|
+
|
181
|
+
### Parameters
|
182
|
+
|
183
|
+
Name | Type | Description | Notes
|
184
|
+
------------- | ------------- | ------------- | -------------
|
185
|
+
**app_id** | **String**| The id of the app where the templates belong to. |
|
186
|
+
**query** | **String**| The optional query to search for items. | [optional]
|
187
|
+
**take** | **Integer**| The number of items to return. | [optional]
|
188
|
+
**skip** | **Integer**| The number of items to skip. | [optional]
|
189
|
+
|
190
|
+
### Return type
|
191
|
+
|
192
|
+
[**ListResponseDtoOfChannelTemplateDto**](ListResponseDtoOfChannelTemplateDto.md)
|
193
|
+
|
194
|
+
### Authorization
|
195
|
+
|
196
|
+
No authorization required
|
197
|
+
|
198
|
+
### HTTP request headers
|
199
|
+
|
200
|
+
- **Content-Type**: Not defined
|
201
|
+
- **Accept**: application/json
|
202
|
+
|
203
|
+
|
204
|
+
|
205
|
+
# **sms_templates_post_template**
|
206
|
+
> ChannelTemplateDetailsDtoOfSmsTemplateDto sms_templates_post_template(bodyapp_id)
|
207
|
+
|
208
|
+
Create a channel template.
|
209
|
+
|
210
|
+
### Example
|
211
|
+
```ruby
|
212
|
+
# load the gem
|
213
|
+
require 'notifo'
|
214
|
+
|
215
|
+
api_instance = Notifo::SmsTemplatesApi.new
|
216
|
+
body = Notifo::CreateChannelTemplateDto.new # CreateChannelTemplateDto | The request object.
|
217
|
+
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
|
218
|
+
|
219
|
+
|
220
|
+
begin
|
221
|
+
#Create a channel template.
|
222
|
+
result = api_instance.sms_templates_post_template(bodyapp_id)
|
223
|
+
p result
|
224
|
+
rescue Notifo::ApiError => e
|
225
|
+
puts "Exception when calling SmsTemplatesApi->sms_templates_post_template: #{e}"
|
226
|
+
end
|
227
|
+
```
|
228
|
+
|
229
|
+
### Parameters
|
230
|
+
|
231
|
+
Name | Type | Description | Notes
|
232
|
+
------------- | ------------- | ------------- | -------------
|
233
|
+
**body** | [**CreateChannelTemplateDto**](CreateChannelTemplateDto.md)| The request object. |
|
234
|
+
**app_id** | **String**| The id of the app where the templates belong to. |
|
235
|
+
|
236
|
+
### Return type
|
237
|
+
|
238
|
+
[**ChannelTemplateDetailsDtoOfSmsTemplateDto**](ChannelTemplateDetailsDtoOfSmsTemplateDto.md)
|
239
|
+
|
240
|
+
### Authorization
|
241
|
+
|
242
|
+
No authorization required
|
243
|
+
|
244
|
+
### HTTP request headers
|
245
|
+
|
246
|
+
- **Content-Type**: application/json
|
247
|
+
- **Accept**: application/json
|
248
|
+
|
249
|
+
|
250
|
+
|
251
|
+
# **sms_templates_post_template_language**
|
252
|
+
> SmsTemplateDto sms_templates_post_template_language(bodyapp_idid)
|
253
|
+
|
254
|
+
Create an app template language.
|
255
|
+
|
256
|
+
### Example
|
257
|
+
```ruby
|
258
|
+
# load the gem
|
259
|
+
require 'notifo'
|
260
|
+
|
261
|
+
api_instance = Notifo::SmsTemplatesApi.new
|
262
|
+
body = Notifo::CreateChannelTemplateLanguageDto.new # CreateChannelTemplateLanguageDto | The request object.
|
263
|
+
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
|
264
|
+
id = 'id_example' # String | The template ID.
|
265
|
+
|
266
|
+
|
267
|
+
begin
|
268
|
+
#Create an app template language.
|
269
|
+
result = api_instance.sms_templates_post_template_language(bodyapp_idid)
|
270
|
+
p result
|
271
|
+
rescue Notifo::ApiError => e
|
272
|
+
puts "Exception when calling SmsTemplatesApi->sms_templates_post_template_language: #{e}"
|
273
|
+
end
|
274
|
+
```
|
275
|
+
|
276
|
+
### Parameters
|
277
|
+
|
278
|
+
Name | Type | Description | Notes
|
279
|
+
------------- | ------------- | ------------- | -------------
|
280
|
+
**body** | [**CreateChannelTemplateLanguageDto**](CreateChannelTemplateLanguageDto.md)| The request object. |
|
281
|
+
**app_id** | **String**| The id of the app where the templates belong to. |
|
282
|
+
**id** | **String**| The template ID. |
|
283
|
+
|
284
|
+
### Return type
|
285
|
+
|
286
|
+
[**SmsTemplateDto**](SmsTemplateDto.md)
|
287
|
+
|
288
|
+
### Authorization
|
289
|
+
|
290
|
+
No authorization required
|
291
|
+
|
292
|
+
### HTTP request headers
|
293
|
+
|
294
|
+
- **Content-Type**: application/json
|
295
|
+
- **Accept**: application/json
|
296
|
+
|
297
|
+
|
298
|
+
|
299
|
+
# **sms_templates_put_template**
|
300
|
+
> sms_templates_put_template(bodyapp_idid)
|
301
|
+
|
302
|
+
Update an app template.
|
303
|
+
|
304
|
+
### Example
|
305
|
+
```ruby
|
306
|
+
# load the gem
|
307
|
+
require 'notifo'
|
308
|
+
|
309
|
+
api_instance = Notifo::SmsTemplatesApi.new
|
310
|
+
body = Notifo::UpdateChannelTemplateDtoOfSmsTemplateDto.new # UpdateChannelTemplateDtoOfSmsTemplateDto | The request object.
|
311
|
+
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
|
312
|
+
id = 'id_example' # String | The template ID.
|
313
|
+
|
314
|
+
|
315
|
+
begin
|
316
|
+
#Update an app template.
|
317
|
+
api_instance.sms_templates_put_template(bodyapp_idid)
|
318
|
+
rescue Notifo::ApiError => e
|
319
|
+
puts "Exception when calling SmsTemplatesApi->sms_templates_put_template: #{e}"
|
320
|
+
end
|
321
|
+
```
|
322
|
+
|
323
|
+
### Parameters
|
324
|
+
|
325
|
+
Name | Type | Description | Notes
|
326
|
+
------------- | ------------- | ------------- | -------------
|
327
|
+
**body** | [**UpdateChannelTemplateDtoOfSmsTemplateDto**](UpdateChannelTemplateDtoOfSmsTemplateDto.md)| The request object. |
|
328
|
+
**app_id** | **String**| The id of the app where the templates belong to. |
|
329
|
+
**id** | **String**| The template ID. |
|
330
|
+
|
331
|
+
### Return type
|
332
|
+
|
333
|
+
nil (empty response body)
|
334
|
+
|
335
|
+
### Authorization
|
336
|
+
|
337
|
+
No authorization required
|
338
|
+
|
339
|
+
### HTTP request headers
|
340
|
+
|
341
|
+
- **Content-Type**: application/json
|
342
|
+
- **Accept**: application/json
|
343
|
+
|
344
|
+
|
345
|
+
|
346
|
+
# **sms_templates_put_template_language**
|
347
|
+
> sms_templates_put_template_language(bodyapp_ididlanguage)
|
348
|
+
|
349
|
+
Update a channel template language.
|
350
|
+
|
351
|
+
### Example
|
352
|
+
```ruby
|
353
|
+
# load the gem
|
354
|
+
require 'notifo'
|
355
|
+
|
356
|
+
api_instance = Notifo::SmsTemplatesApi.new
|
357
|
+
body = Notifo::SmsTemplateDto.new # SmsTemplateDto | The request object.
|
358
|
+
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
|
359
|
+
id = 'id_example' # String | The template ID.
|
360
|
+
language = 'language_example' # String | The language.
|
361
|
+
|
362
|
+
|
363
|
+
begin
|
364
|
+
#Update a channel template language.
|
365
|
+
api_instance.sms_templates_put_template_language(bodyapp_ididlanguage)
|
366
|
+
rescue Notifo::ApiError => e
|
367
|
+
puts "Exception when calling SmsTemplatesApi->sms_templates_put_template_language: #{e}"
|
368
|
+
end
|
369
|
+
```
|
370
|
+
|
371
|
+
### Parameters
|
372
|
+
|
373
|
+
Name | Type | Description | Notes
|
374
|
+
------------- | ------------- | ------------- | -------------
|
375
|
+
**body** | [**SmsTemplateDto**](SmsTemplateDto.md)| The request object. |
|
376
|
+
**app_id** | **String**| The id of the app where the templates belong to. |
|
377
|
+
**id** | **String**| The template ID. |
|
378
|
+
**language** | **String**| The language. |
|
379
|
+
|
380
|
+
### Return type
|
381
|
+
|
382
|
+
nil (empty response body)
|
383
|
+
|
384
|
+
### Authorization
|
385
|
+
|
386
|
+
No authorization required
|
387
|
+
|
388
|
+
### HTTP request headers
|
389
|
+
|
390
|
+
- **Content-Type**: application/json
|
391
|
+
- **Accept**: application/json
|
392
|
+
|
393
|
+
|
394
|
+
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# Notifo::SubscribeDto
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**topic_prefix** | **String** | The topic to add. |
|
7
|
+
**topic_settings** | [**Hash<String, ChannelSettingDto>**](ChannelSettingDto.md) | Notification settings per channel. | [optional]
|
8
|
+
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# Notifo::SubscribeManyDto
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**subscribe** | [**Array<SubscribeDto>**](SubscribeDto.md) | A list of topics to create. | [optional]
|
7
|
+
**unsubscribe** | **Array<String>** | A list of topics to unsubscribe from. | [optional]
|
8
|
+
|
data/docs/SubscriptionDto.md
CHANGED
@@ -4,5 +4,5 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**topic_prefix** | **String** | The topic to add. |
|
7
|
-
**topic_settings** | [**Hash<String,
|
7
|
+
**topic_settings** | [**Hash<String, ChannelSettingDto>**](ChannelSettingDto.md) | Notification settings per channel. |
|
8
8
|
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# Notifo::SystemUserDto
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **String** | The id of the user. |
|
7
|
+
**email** | **String** | The email of the user. Unique value. |
|
8
|
+
**is_locked** | **BOOLEAN** | Determines if the user is locked. |
|
9
|
+
**roles** | **Array<String>** | Additional role for the user. |
|
10
|
+
**can_update** | **BOOLEAN** | True if the user can be updated. | [optional]
|
11
|
+
|