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/AppDetailsDto.md
CHANGED
@@ -6,8 +6,10 @@ Name | Type | Description | Notes
|
|
6
6
|
**id** | **String** | The id of the app. |
|
7
7
|
**name** | **String** | The app name. |
|
8
8
|
**role** | **String** | The current role. |
|
9
|
-
**
|
9
|
+
**created** | **DateTime** | The date time (ISO 8601) when the app has been created. |
|
10
|
+
**last_update** | **DateTime** | The date time (ISO 8601) when the app has been updated. |
|
10
11
|
**confirm_url** | **String** | The confirm URL. | [optional]
|
12
|
+
**languages** | **Array<String>** | The supported languages. |
|
11
13
|
**api_keys** | **Hash<String, String>** | The api keys. |
|
12
14
|
**contributors** | [**Array<AppContributorDto>**](AppContributorDto.md) | The contributors. |
|
13
15
|
**counters** | **Hash<String, Integer>** | The statistics counters. |
|
data/docs/AppDto.md
CHANGED
@@ -6,6 +6,8 @@ Name | Type | Description | Notes
|
|
6
6
|
**id** | **String** | The id of the app. |
|
7
7
|
**name** | **String** | The app name. |
|
8
8
|
**role** | **String** | The current role. |
|
9
|
+
**created** | **DateTime** | The date time (ISO 8601) when the app has been created. |
|
10
|
+
**last_update** | **DateTime** | The date time (ISO 8601) when the app has been updated. |
|
9
11
|
**languages** | **Array<String>** | The supported languages. |
|
10
12
|
**api_keys** | **Hash<String, String>** | The api keys. |
|
11
13
|
**counters** | **Hash<String, Integer>** | The statistics counters. |
|
data/docs/AppsApi.md
CHANGED
@@ -5,18 +5,14 @@ All URIs are relative to *https://notifo.easierlife.com*
|
|
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) | **DELETE** /api/apps/{appId}/email-templates/{language} | Delete an app email template.
|
9
8
|
[**apps_delete_integration**](AppsApi.md#apps_delete_integration) | **DELETE** /api/apps/{appId}/integrations/{id} | Delete an app integration.
|
10
9
|
[**apps_get_app**](AppsApi.md#apps_get_app) | **GET** /api/apps/{appId} | Get app by id.
|
11
10
|
[**apps_get_apps**](AppsApi.md#apps_get_apps) | **GET** /api/apps | Get the user apps.
|
12
|
-
[**apps_get_email_templates**](AppsApi.md#apps_get_email_templates) | **GET** /api/apps/{appId}/email-templates | Get the app email templates.
|
13
11
|
[**apps_get_integrations**](AppsApi.md#apps_get_integrations) | **GET** /api/apps/{appId}/integrations | Get the app integrations.
|
14
12
|
[**apps_post_app**](AppsApi.md#apps_post_app) | **POST** /api/apps | Create an app.
|
15
13
|
[**apps_post_contributor**](AppsApi.md#apps_post_contributor) | **POST** /api/apps/{appId}/contributors | Add an app contributor.
|
16
|
-
[**apps_post_email_template**](AppsApi.md#apps_post_email_template) | **POST** /api/apps/{appId}/email-templates | Create an app email template.
|
17
14
|
[**apps_post_integration**](AppsApi.md#apps_post_integration) | **POST** /api/apps/{appId}/integration | Create an app integrations.
|
18
15
|
[**apps_put_app**](AppsApi.md#apps_put_app) | **POST** /api/apps/{appId} | Update an app.
|
19
|
-
[**apps_put_email_template**](AppsApi.md#apps_put_email_template) | **PUT** /api/apps/{appId}/email-templates/{language} | Update an app email template.
|
20
16
|
[**apps_put_integration**](AppsApi.md#apps_put_integration) | **PUT** /api/apps/{appId}/integrations/{id} | Update an app integration.
|
21
17
|
|
22
18
|
# **apps_delete_contributor**
|
@@ -65,51 +61,6 @@ No authorization required
|
|
65
61
|
|
66
62
|
|
67
63
|
|
68
|
-
# **apps_delete_email_template**
|
69
|
-
> apps_delete_email_template(app_id, language)
|
70
|
-
|
71
|
-
Delete an app email template.
|
72
|
-
|
73
|
-
### Example
|
74
|
-
```ruby
|
75
|
-
# load the gem
|
76
|
-
require 'notifo'
|
77
|
-
|
78
|
-
api_instance = Notifo::AppsApi.new
|
79
|
-
app_id = 'app_id_example' # String | The id of the app where the email templates belong to.
|
80
|
-
language = 'language_example' # String | The language.
|
81
|
-
|
82
|
-
|
83
|
-
begin
|
84
|
-
#Delete an app email template.
|
85
|
-
api_instance.apps_delete_email_template(app_id, language)
|
86
|
-
rescue Notifo::ApiError => e
|
87
|
-
puts "Exception when calling AppsApi->apps_delete_email_template: #{e}"
|
88
|
-
end
|
89
|
-
```
|
90
|
-
|
91
|
-
### Parameters
|
92
|
-
|
93
|
-
Name | Type | Description | Notes
|
94
|
-
------------- | ------------- | ------------- | -------------
|
95
|
-
**app_id** | **String**| The id of the app where the email templates belong to. |
|
96
|
-
**language** | **String**| The language. |
|
97
|
-
|
98
|
-
### Return type
|
99
|
-
|
100
|
-
nil (empty response body)
|
101
|
-
|
102
|
-
### Authorization
|
103
|
-
|
104
|
-
No authorization required
|
105
|
-
|
106
|
-
### HTTP request headers
|
107
|
-
|
108
|
-
- **Content-Type**: Not defined
|
109
|
-
- **Accept**: application/json
|
110
|
-
|
111
|
-
|
112
|
-
|
113
64
|
# **apps_delete_integration**
|
114
65
|
> apps_delete_integration(app_id, id)
|
115
66
|
|
@@ -238,50 +189,6 @@ No authorization required
|
|
238
189
|
|
239
190
|
|
240
191
|
|
241
|
-
# **apps_get_email_templates**
|
242
|
-
> EmailTemplatesDto apps_get_email_templates(app_id)
|
243
|
-
|
244
|
-
Get the app email templates.
|
245
|
-
|
246
|
-
### Example
|
247
|
-
```ruby
|
248
|
-
# load the gem
|
249
|
-
require 'notifo'
|
250
|
-
|
251
|
-
api_instance = Notifo::AppsApi.new
|
252
|
-
app_id = 'app_id_example' # String | The id of the app where the email templates belong to.
|
253
|
-
|
254
|
-
|
255
|
-
begin
|
256
|
-
#Get the app email templates.
|
257
|
-
result = api_instance.apps_get_email_templates(app_id)
|
258
|
-
p result
|
259
|
-
rescue Notifo::ApiError => e
|
260
|
-
puts "Exception when calling AppsApi->apps_get_email_templates: #{e}"
|
261
|
-
end
|
262
|
-
```
|
263
|
-
|
264
|
-
### Parameters
|
265
|
-
|
266
|
-
Name | Type | Description | Notes
|
267
|
-
------------- | ------------- | ------------- | -------------
|
268
|
-
**app_id** | **String**| The id of the app where the email templates belong to. |
|
269
|
-
|
270
|
-
### Return type
|
271
|
-
|
272
|
-
[**EmailTemplatesDto**](EmailTemplatesDto.md)
|
273
|
-
|
274
|
-
### Authorization
|
275
|
-
|
276
|
-
No authorization required
|
277
|
-
|
278
|
-
### HTTP request headers
|
279
|
-
|
280
|
-
- **Content-Type**: Not defined
|
281
|
-
- **Accept**: application/json
|
282
|
-
|
283
|
-
|
284
|
-
|
285
192
|
# **apps_get_integrations**
|
286
193
|
> ConfiguredIntegrationsDto apps_get_integrations(app_id)
|
287
194
|
|
@@ -416,52 +323,6 @@ No authorization required
|
|
416
323
|
|
417
324
|
|
418
325
|
|
419
|
-
# **apps_post_email_template**
|
420
|
-
> EmailTemplateDto apps_post_email_template(bodyapp_id)
|
421
|
-
|
422
|
-
Create an app email template.
|
423
|
-
|
424
|
-
### Example
|
425
|
-
```ruby
|
426
|
-
# load the gem
|
427
|
-
require 'notifo'
|
428
|
-
|
429
|
-
api_instance = Notifo::AppsApi.new
|
430
|
-
body = Notifo::CreateEmailTemplateDto.new # CreateEmailTemplateDto | The request object.
|
431
|
-
app_id = 'app_id_example' # String | The id of the app where the email templates belong to.
|
432
|
-
|
433
|
-
|
434
|
-
begin
|
435
|
-
#Create an app email template.
|
436
|
-
result = api_instance.apps_post_email_template(bodyapp_id)
|
437
|
-
p result
|
438
|
-
rescue Notifo::ApiError => e
|
439
|
-
puts "Exception when calling AppsApi->apps_post_email_template: #{e}"
|
440
|
-
end
|
441
|
-
```
|
442
|
-
|
443
|
-
### Parameters
|
444
|
-
|
445
|
-
Name | Type | Description | Notes
|
446
|
-
------------- | ------------- | ------------- | -------------
|
447
|
-
**body** | [**CreateEmailTemplateDto**](CreateEmailTemplateDto.md)| The request object. |
|
448
|
-
**app_id** | **String**| The id of the app where the email templates belong to. |
|
449
|
-
|
450
|
-
### Return type
|
451
|
-
|
452
|
-
[**EmailTemplateDto**](EmailTemplateDto.md)
|
453
|
-
|
454
|
-
### Authorization
|
455
|
-
|
456
|
-
No authorization required
|
457
|
-
|
458
|
-
### HTTP request headers
|
459
|
-
|
460
|
-
- **Content-Type**: application/json
|
461
|
-
- **Accept**: application/json
|
462
|
-
|
463
|
-
|
464
|
-
|
465
326
|
# **apps_post_integration**
|
466
327
|
> IntegrationCreatedDto apps_post_integration(bodyapp_id)
|
467
328
|
|
@@ -554,53 +415,6 @@ No authorization required
|
|
554
415
|
|
555
416
|
|
556
417
|
|
557
|
-
# **apps_put_email_template**
|
558
|
-
> apps_put_email_template(bodyapp_idlanguage)
|
559
|
-
|
560
|
-
Update an app email template.
|
561
|
-
|
562
|
-
### Example
|
563
|
-
```ruby
|
564
|
-
# load the gem
|
565
|
-
require 'notifo'
|
566
|
-
|
567
|
-
api_instance = Notifo::AppsApi.new
|
568
|
-
body = Notifo::EmailTemplateDto.new # EmailTemplateDto | The request object.
|
569
|
-
app_id = 'app_id_example' # String | The id of the app where the email templates belong to.
|
570
|
-
language = 'language_example' # String | The language.
|
571
|
-
|
572
|
-
|
573
|
-
begin
|
574
|
-
#Update an app email template.
|
575
|
-
api_instance.apps_put_email_template(bodyapp_idlanguage)
|
576
|
-
rescue Notifo::ApiError => e
|
577
|
-
puts "Exception when calling AppsApi->apps_put_email_template: #{e}"
|
578
|
-
end
|
579
|
-
```
|
580
|
-
|
581
|
-
### Parameters
|
582
|
-
|
583
|
-
Name | Type | Description | Notes
|
584
|
-
------------- | ------------- | ------------- | -------------
|
585
|
-
**body** | [**EmailTemplateDto**](EmailTemplateDto.md)| The request object. |
|
586
|
-
**app_id** | **String**| The id of the app where the email templates belong to. |
|
587
|
-
**language** | **String**| The language. |
|
588
|
-
|
589
|
-
### Return type
|
590
|
-
|
591
|
-
nil (empty response body)
|
592
|
-
|
593
|
-
### Authorization
|
594
|
-
|
595
|
-
No authorization required
|
596
|
-
|
597
|
-
### HTTP request headers
|
598
|
-
|
599
|
-
- **Content-Type**: application/json
|
600
|
-
- **Accept**: application/json
|
601
|
-
|
602
|
-
|
603
|
-
|
604
418
|
# **apps_put_integration**
|
605
419
|
> apps_put_integration(bodyapp_idid)
|
606
420
|
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# Notifo::ChannelSendInfoDto
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**status** | [**ProcessStatus**](ProcessStatus.md) | | [optional]
|
7
|
+
**last_update** | **DateTime** | The last update. | [optional]
|
8
|
+
**detail** | **String** | The details. | [optional]
|
9
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# Notifo::ChannelSettingDto
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**send** | [**ChannelSend**](ChannelSend.md) | |
|
7
|
+
**condition** | [**ChannelCondition**](ChannelCondition.md) | |
|
8
|
+
**delay_in_seconds** | **Integer** | The delay in seconds. | [optional]
|
9
|
+
**template** | **String** | The template if the channel supports it. | [optional]
|
10
|
+
**properties** | [**NotificationProperties**](NotificationProperties.md) | | [optional]
|
11
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# Notifo::ChannelTemplateDetailsDtoOfEmailTemplateDto
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **String** | The id of the template. |
|
7
|
+
**name** | **String** | The optional name of the template. | [optional]
|
8
|
+
**primary** | **BOOLEAN** | True, when the template is the primary template. |
|
9
|
+
**created** | **DateTime** | The date time (ISO 8601) when the template has been created. |
|
10
|
+
**last_update** | **DateTime** | The date time (ISO 8601) when the template has been updated. |
|
11
|
+
**languages** | [**Hash<String, EmailTemplateDto>**](EmailTemplateDto.md) | The language specific templates. |
|
12
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# Notifo::ChannelTemplateDetailsDtoOfMessagingTemplateDto
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **String** | The id of the template. |
|
7
|
+
**name** | **String** | The optional name of the template. | [optional]
|
8
|
+
**primary** | **BOOLEAN** | True, when the template is the primary template. |
|
9
|
+
**created** | **DateTime** | The date time (ISO 8601) when the template has been created. |
|
10
|
+
**last_update** | **DateTime** | The date time (ISO 8601) when the template has been updated. |
|
11
|
+
**languages** | [**Hash<String, MessagingTemplateDto>**](MessagingTemplateDto.md) | The language specific templates. |
|
12
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# Notifo::ChannelTemplateDetailsDtoOfSmsTemplateDto
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **String** | The id of the template. |
|
7
|
+
**name** | **String** | The optional name of the template. | [optional]
|
8
|
+
**primary** | **BOOLEAN** | True, when the template is the primary template. |
|
9
|
+
**created** | **DateTime** | The date time (ISO 8601) when the template has been created. |
|
10
|
+
**last_update** | **DateTime** | The date time (ISO 8601) when the template has been updated. |
|
11
|
+
**languages** | [**Hash<String, SmsTemplateDto>**](SmsTemplateDto.md) | The language specific templates. |
|
12
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# Notifo::ChannelTemplateDto
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **String** | The id of the template. |
|
7
|
+
**name** | **String** | The optional name of the template. | [optional]
|
8
|
+
**kind** | **String** | The kind of the template. | [optional]
|
9
|
+
**primary** | **BOOLEAN** | True, when the template is the primary template. |
|
10
|
+
**last_update** | **DateTime** | The last time the template has been updated. |
|
11
|
+
|
@@ -4,9 +4,10 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**type** | **String** | The integration type. |
|
7
|
-
**properties** |
|
7
|
+
**properties** | **Hash<String, String>** | The configured properties. |
|
8
8
|
**enabled** | **BOOLEAN** | True when enabled. | [optional]
|
9
9
|
**test** | **BOOLEAN** | True or false when only used for test or production mode. | [optional]
|
10
|
+
**condition** | **String** | The javascript condition. | [optional]
|
10
11
|
**priority** | **Integer** | The priority in which order the integrations must run. | [optional]
|
11
12
|
**status** | [**IntegrationStatus**](IntegrationStatus.md) | |
|
12
13
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**type** | **String** | The integration type. |
|
7
|
-
**properties** |
|
7
|
+
**properties** | **Hash<String, String>** | The configured properties. |
|
8
8
|
**enabled** | **BOOLEAN** | True when enabled. | [optional]
|
9
9
|
**test** | **BOOLEAN** | True when used for test events. | [optional]
|
10
10
|
**priority** | **Integer** | The priority in which order the integrations must run. | [optional]
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# Notifo::CreateSystemUserDto
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**email** | **String** | The email of the user. Unique value. |
|
7
|
+
**password** | **String** | The password of the user. | [optional]
|
8
|
+
**roles** | **Array<String>** | Additional role for the user. |
|
9
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Notifo::EmailFormattingError
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**message** | **String** | | [optional]
|
7
|
+
**template** | [**EmailTemplateType**](EmailTemplateType.md) | | [optional]
|
8
|
+
**line** | **Integer** | | [optional]
|
9
|
+
**column** | **Integer** | | [optional]
|
10
|
+
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# Notifo::EmailPreviewDto
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**result** | **String** | The rendered preview. | [optional]
|
7
|
+
**errors** | [**Array<EmailFormattingError>**](EmailFormattingError.md) | The errors when rendering a preview. | [optional]
|
8
|
+
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# Notifo::EmailPreviewRequestDto
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**template** | **String** | The preview to render. |
|
7
|
+
**type** | [**EmailPreviewType**](EmailPreviewType.md) | | [optional]
|
8
|
+
**kind** | **String** | The kind of the template. | [optional]
|
9
|
+
|
data/docs/EmailTemplateDto.md
CHANGED
@@ -6,4 +6,7 @@ Name | Type | Description | Notes
|
|
6
6
|
**subject** | **String** | The subject text. |
|
7
7
|
**body_html** | **String** | The body html template. |
|
8
8
|
**body_text** | **String** | The body text template. | [optional]
|
9
|
+
**from_email** | **String** | The optional from email. | [optional]
|
10
|
+
**from_name** | **String** | The optional from name. | [optional]
|
11
|
+
**kind** | **String** | The type of the template. | [optional]
|
9
12
|
|