notifo-io 1.0.1.2 → 1.2.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 +838 -156
- data/docs/AddContributorDto.md +1 -1
- data/docs/AdminProfileDto.md +7 -0
- data/docs/AppDetailsDto.md +3 -1
- data/docs/AppDto.md +2 -0
- data/docs/AppsApi.md +1 -187
- data/docs/{NotificationSend.md → ChannelCondition.md} +1 -1
- data/docs/{EventProperties.md → ChannelSend.md} +1 -1
- data/docs/ChannelSendInfoDto.md +13 -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/ConfigsApi.md +1 -1
- 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/DiagnosticsApi.md +85 -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 +1 -1
- data/docs/EventsApi.md +8 -6
- data/docs/HandledInfoDto.md +8 -0
- data/docs/{EmailVerificationStatus.md → InfoDto.md} +2 -1
- data/docs/IntegrationPropertyDto.md +3 -1
- 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/LogsApi.md +1 -1
- data/docs/MediaApi.md +154 -4
- data/docs/MediaDto.md +3 -1
- data/docs/MessagingTemplateDto.md +7 -0
- data/docs/MessagingTemplatesApi.md +394 -0
- data/docs/MobilePushApi.md +16 -16
- data/docs/MobilePushTokenDto.md +4 -2
- data/docs/MobilePushTokenDto2.md +9 -0
- data/docs/NotificationFormattingDto.md +1 -1
- data/docs/NotificationProperties.md +6 -0
- data/docs/NotificationsApi.md +202 -20
- data/docs/PingApi.md +131 -0
- data/docs/ProcessStatus.md +6 -0
- data/docs/ProfileDto.md +2 -1
- data/docs/PropertyType.md +6 -0
- data/docs/PublishDto.md +4 -2
- data/docs/RegisterMobileTokenDto.md +1 -0
- data/docs/SendConfiguration.md +6 -0
- data/docs/{Body.md → SmsTemplateDto.md} +2 -2
- 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 +328 -0
- data/docs/TemplateDto.md +3 -1
- data/docs/TemplatesApi.md +4 -5
- data/docs/TopicChannel.md +6 -0
- data/docs/TopicDto.md +7 -1
- data/docs/TopicQueryScope.md +6 -0
- data/docs/TopicsApi.md +96 -1
- data/docs/TrackNotificationDto.md +1 -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 +160 -22
- data/docs/UserDto.md +8 -4
- data/docs/UserNotificationBaseDto.md +24 -0
- data/docs/UserNotificationChannelDto.md +11 -0
- data/docs/UserNotificationDetailsDto.md +28 -0
- data/docs/{NotificationDto.md → UserNotificationDto.md} +10 -5
- data/docs/UserPropertyDto.md +9 -0
- data/docs/UserTopicDto.md +11 -0
- data/docs/UsersApi.md +134 -34
- data/docs/WebPushSubscriptionDto.md +7 -0
- data/lib/notifo/api/apps_api.rb +1 -245
- data/lib/notifo/api/configs_api.rb +1 -1
- data/lib/notifo/api/{user_info_api.rb → diagnostics_api.rb} +19 -15
- 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 +197 -2
- 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 +246 -24
- data/lib/notifo/api/{authorization_api.rb → ping_api.rb} +37 -25
- 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 +186 -27
- data/lib/notifo/api/users_api.rb +171 -33
- 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 +2 -6
- data/lib/notifo/models/{body.rb → admin_profile_dto.rb} +13 -11
- 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 +269 -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/{integration_properties.rb → create_channel_template_dto.rb} +18 -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 +1 -1
- data/lib/notifo/models/handled_info_dto.rb +218 -0
- data/lib/notifo/models/info_dto.rb +212 -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_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 +33 -6
- data/lib/notifo/models/mobile_push_token_dto2.rb +232 -0
- 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/{integration_property_type.rb → property_type.rb} +4 -4
- data/lib/notifo/models/publish_dto.rb +26 -2
- data/lib/notifo/models/publish_many_dto.rb +1 -1
- data/lib/notifo/models/register_mobile_token_dto.rb +16 -5
- 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 → send_configuration.rb} +4 -4
- data/lib/notifo/models/sms_template_dto.rb +212 -0
- data/lib/notifo/models/subscribe_dto.rb +225 -0
- data/lib/notifo/models/{notification_setting_dto.rb → subscribe_many_dto.rb} +25 -24
- 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 +12 -2
- 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 +96 -36
- data/lib/notifo/models/{notification_dto.rb → user_notification_base_dto.rb} +73 -46
- data/lib/notifo/models/user_notification_channel_dto.rb +261 -0
- data/lib/notifo/models/user_notification_details_dto.rb +461 -0
- data/lib/notifo/models/user_notification_dto.rb +447 -0
- data/lib/notifo/models/user_property_dto.rb +234 -0
- data/lib/notifo/models/user_topic_dto.rb +265 -0
- data/lib/notifo/models/web_push_subscription_dto.rb +212 -0
- data/lib/notifo/version.rb +1 -1
- data/lib/notifo.rb +55 -12
- data/notifo.gemspec +3 -4
- data/spec/api/apps_api_spec.rb +20 -20
- data/spec/api/configs_api_spec.rb +1 -1
- data/spec/api/{user_info_api_spec.rb → diagnostics_api_spec.rb} +13 -11
- 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 +52 -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 +62 -9
- data/spec/api/{authorization_api_spec.rb → ping_api_spec.rb} +20 -14
- 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 +43 -8
- data/spec/api/users_api_spec.rb +41 -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/admin_profile_dto_spec.rb +40 -0
- 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 +76 -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/models/email_formatting_error_spec.rb +58 -0
- 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 +7 -1
- data/spec/models/handled_info_dto_spec.rb +46 -0
- data/spec/models/{body_spec.rb → info_dto_spec.rb} +8 -8
- 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_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/models/list_response_dto_of_user_notification_dto_spec.rb +46 -0
- 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 +52 -0
- data/spec/models/mobile_push_token_dto_spec.rb +13 -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/property_type_spec.rb +34 -0
- data/spec/models/publish_dto_spec.rb +25 -1
- data/spec/models/publish_many_dto_spec.rb +1 -1
- data/spec/models/register_mobile_token_dto_spec.rb +7 -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/send_configuration_spec.rb +34 -0
- data/spec/models/{integration_property_type_spec.rb → sms_template_dto_spec.rb} +13 -7
- 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 +7 -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 +43 -1
- data/spec/models/{notification_dto_spec.rb → user_notification_base_dto_spec.rb} +29 -11
- data/spec/models/user_notification_channel_dto_spec.rb +64 -0
- data/spec/models/user_notification_details_dto_spec.rb +166 -0
- data/spec/models/user_notification_dto_spec.rb +154 -0
- data/spec/models/user_property_dto_spec.rb +52 -0
- data/spec/models/user_topic_dto_spec.rb +64 -0
- data/spec/models/web_push_subscription_dto_spec.rb +40 -0
- data/spec/spec_helper.rb +1 -1
- metadata +232 -69
- data/docs/AuthorizationApi.md +0 -121
- data/docs/IntegrationPropertyType.md +0 -6
- data/docs/NotificationSettingDto.md +0 -8
- data/docs/UserInfoApi.md +0 -83
- data/notifo-io-1.0.1.1.gem +0 -0
- data/spec/models/email_verification_status_spec.rb +0 -34
data/docs/MediaApi.md
CHANGED
@@ -1,13 +1,15 @@
|
|
1
1
|
# Notifo::MediaApi
|
2
2
|
|
3
|
-
All URIs are relative to *https://notifo.easierlife.com*
|
3
|
+
All URIs are relative to *https://notifo-dev.easierlife.com*
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**media_delete**](MediaApi.md#media_delete) | **DELETE** /api/apps/{appId}/media/{fileName} | Delete a media.
|
8
8
|
[**media_download**](MediaApi.md#media_download) | **GET** /api/apps/{appId}/media/{fileName} | Download a media object.
|
9
|
-
[**media_download2**](MediaApi.md#media_download2) | **GET** /api/
|
9
|
+
[**media_download2**](MediaApi.md#media_download2) | **GET** /api/asset/{appId}/{fileName} | Download a media object.
|
10
|
+
[**media_download3**](MediaApi.md#media_download3) | **GET** /api/assets/{appId}/{fileName} | Download a media object.
|
10
11
|
[**media_get_medias**](MediaApi.md#media_get_medias) | **GET** /api/apps/{appId}/media | Query media items.
|
12
|
+
[**media_proxy_proxy_image**](MediaApi.md#media_proxy_proxy_image) | **GET** /api/assets/proxy | Download a media object.
|
11
13
|
[**media_upload**](MediaApi.md#media_upload) | **POST** /api/apps/{appId}/media | Upload a media object.
|
12
14
|
|
13
15
|
# **media_delete**
|
@@ -71,6 +73,7 @@ file_name = 'file_name_example' # String | The name of the media to download.
|
|
71
73
|
opts = {
|
72
74
|
cache: 789, # Integer | The cache duration.
|
73
75
|
download: 56, # Integer | Set it to 1 to create a download response.
|
76
|
+
bg: 'bg_example', # String | Optional background color.
|
74
77
|
width: 56, # Integer | The target width when an image.
|
75
78
|
height: 56, # Integer | The target height when an image.
|
76
79
|
quality: 56, # Integer | The target quality when an image.
|
@@ -78,7 +81,8 @@ opts = {
|
|
78
81
|
mode: Notifo::ResizeMode.new, # ResizeMode | The resize mode.
|
79
82
|
focus_x: 3.4, # Float | The x position of the focues point.
|
80
83
|
focus_y: 3.4, # Float | The y position of the focues point.
|
81
|
-
force: true # BOOLEAN | True to resize it and clear the cache.
|
84
|
+
force: true, # BOOLEAN | True to resize it and clear the cache.
|
85
|
+
empty_on_failure: true # BOOLEAN | True, to return an empty image on failure.
|
82
86
|
}
|
83
87
|
|
84
88
|
begin
|
@@ -98,6 +102,7 @@ Name | Type | Description | Notes
|
|
98
102
|
**file_name** | **String**| The name of the media to download. |
|
99
103
|
**cache** | **Integer**| The cache duration. | [optional]
|
100
104
|
**download** | **Integer**| Set it to 1 to create a download response. | [optional]
|
105
|
+
**bg** | **String**| Optional background color. | [optional]
|
101
106
|
**width** | **Integer**| The target width when an image. | [optional]
|
102
107
|
**height** | **Integer**| The target height when an image. | [optional]
|
103
108
|
**quality** | **Integer**| The target quality when an image. | [optional]
|
@@ -106,6 +111,7 @@ Name | Type | Description | Notes
|
|
106
111
|
**focus_x** | **Float**| The x position of the focues point. | [optional]
|
107
112
|
**focus_y** | **Float**| The y position of the focues point. | [optional]
|
108
113
|
**force** | **BOOLEAN**| True to resize it and clear the cache. | [optional]
|
114
|
+
**empty_on_failure** | **BOOLEAN**| True, to return an empty image on failure. | [optional]
|
109
115
|
|
110
116
|
### Return type
|
111
117
|
|
@@ -138,6 +144,7 @@ file_name = 'file_name_example' # String | The name of the media to download.
|
|
138
144
|
opts = {
|
139
145
|
cache: 789, # Integer | The cache duration.
|
140
146
|
download: 56, # Integer | Set it to 1 to create a download response.
|
147
|
+
bg: 'bg_example', # String | Optional background color.
|
141
148
|
width: 56, # Integer | The target width when an image.
|
142
149
|
height: 56, # Integer | The target height when an image.
|
143
150
|
quality: 56, # Integer | The target quality when an image.
|
@@ -145,7 +152,8 @@ opts = {
|
|
145
152
|
mode: Notifo::ResizeMode.new, # ResizeMode | The resize mode.
|
146
153
|
focus_x: 3.4, # Float | The x position of the focues point.
|
147
154
|
focus_y: 3.4, # Float | The y position of the focues point.
|
148
|
-
force: true # BOOLEAN | True to resize it and clear the cache.
|
155
|
+
force: true, # BOOLEAN | True to resize it and clear the cache.
|
156
|
+
empty_on_failure: true # BOOLEAN | True, to return an empty image on failure.
|
149
157
|
}
|
150
158
|
|
151
159
|
begin
|
@@ -165,6 +173,7 @@ Name | Type | Description | Notes
|
|
165
173
|
**file_name** | **String**| The name of the media to download. |
|
166
174
|
**cache** | **Integer**| The cache duration. | [optional]
|
167
175
|
**download** | **Integer**| Set it to 1 to create a download response. | [optional]
|
176
|
+
**bg** | **String**| Optional background color. | [optional]
|
168
177
|
**width** | **Integer**| The target width when an image. | [optional]
|
169
178
|
**height** | **Integer**| The target height when an image. | [optional]
|
170
179
|
**quality** | **Integer**| The target quality when an image. | [optional]
|
@@ -173,6 +182,78 @@ Name | Type | Description | Notes
|
|
173
182
|
**focus_x** | **Float**| The x position of the focues point. | [optional]
|
174
183
|
**focus_y** | **Float**| The y position of the focues point. | [optional]
|
175
184
|
**force** | **BOOLEAN**| True to resize it and clear the cache. | [optional]
|
185
|
+
**empty_on_failure** | **BOOLEAN**| True, to return an empty image on failure. | [optional]
|
186
|
+
|
187
|
+
### Return type
|
188
|
+
|
189
|
+
**String**
|
190
|
+
|
191
|
+
### Authorization
|
192
|
+
|
193
|
+
No authorization required
|
194
|
+
|
195
|
+
### HTTP request headers
|
196
|
+
|
197
|
+
- **Content-Type**: Not defined
|
198
|
+
- **Accept**: application/octet-stream, application/json
|
199
|
+
|
200
|
+
|
201
|
+
|
202
|
+
# **media_download3**
|
203
|
+
> String media_download3(app_id, file_name, opts)
|
204
|
+
|
205
|
+
Download a media object.
|
206
|
+
|
207
|
+
### Example
|
208
|
+
```ruby
|
209
|
+
# load the gem
|
210
|
+
require 'notifo'
|
211
|
+
|
212
|
+
api_instance = Notifo::MediaApi.new
|
213
|
+
app_id = 'app_id_example' # String | The app id where the media belongs to.
|
214
|
+
file_name = 'file_name_example' # String | The name of the media to download.
|
215
|
+
opts = {
|
216
|
+
cache: 789, # Integer | The cache duration.
|
217
|
+
download: 56, # Integer | Set it to 1 to create a download response.
|
218
|
+
bg: 'bg_example', # String | Optional background color.
|
219
|
+
width: 56, # Integer | The target width when an image.
|
220
|
+
height: 56, # Integer | The target height when an image.
|
221
|
+
quality: 56, # Integer | The target quality when an image.
|
222
|
+
preset: 'preset_example', # String | A preset dimension.
|
223
|
+
mode: Notifo::ResizeMode.new, # ResizeMode | The resize mode.
|
224
|
+
focus_x: 3.4, # Float | The x position of the focues point.
|
225
|
+
focus_y: 3.4, # Float | The y position of the focues point.
|
226
|
+
force: true, # BOOLEAN | True to resize it and clear the cache.
|
227
|
+
empty_on_failure: true # BOOLEAN | True, to return an empty image on failure.
|
228
|
+
}
|
229
|
+
|
230
|
+
begin
|
231
|
+
#Download a media object.
|
232
|
+
result = api_instance.media_download3(app_id, file_name, opts)
|
233
|
+
p result
|
234
|
+
rescue Notifo::ApiError => e
|
235
|
+
puts "Exception when calling MediaApi->media_download3: #{e}"
|
236
|
+
end
|
237
|
+
```
|
238
|
+
|
239
|
+
### Parameters
|
240
|
+
|
241
|
+
Name | Type | Description | Notes
|
242
|
+
------------- | ------------- | ------------- | -------------
|
243
|
+
**app_id** | **String**| The app id where the media belongs to. |
|
244
|
+
**file_name** | **String**| The name of the media to download. |
|
245
|
+
**cache** | **Integer**| The cache duration. | [optional]
|
246
|
+
**download** | **Integer**| Set it to 1 to create a download response. | [optional]
|
247
|
+
**bg** | **String**| Optional background color. | [optional]
|
248
|
+
**width** | **Integer**| The target width when an image. | [optional]
|
249
|
+
**height** | **Integer**| The target height when an image. | [optional]
|
250
|
+
**quality** | **Integer**| The target quality when an image. | [optional]
|
251
|
+
**preset** | **String**| A preset dimension. | [optional]
|
252
|
+
**mode** | [**ResizeMode**](.md)| The resize mode. | [optional]
|
253
|
+
**focus_x** | **Float**| The x position of the focues point. | [optional]
|
254
|
+
**focus_y** | **Float**| The y position of the focues point. | [optional]
|
255
|
+
**force** | **BOOLEAN**| True to resize it and clear the cache. | [optional]
|
256
|
+
**empty_on_failure** | **BOOLEAN**| True, to return an empty image on failure. | [optional]
|
176
257
|
|
177
258
|
### Return type
|
178
259
|
|
@@ -240,6 +321,75 @@ No authorization required
|
|
240
321
|
|
241
322
|
|
242
323
|
|
324
|
+
# **media_proxy_proxy_image**
|
325
|
+
> String media_proxy_proxy_image(opts)
|
326
|
+
|
327
|
+
Download a media object.
|
328
|
+
|
329
|
+
### Example
|
330
|
+
```ruby
|
331
|
+
# load the gem
|
332
|
+
require 'notifo'
|
333
|
+
|
334
|
+
api_instance = Notifo::MediaApi.new
|
335
|
+
opts = {
|
336
|
+
url: 'url_example', # String | The app id where the media belongs to.
|
337
|
+
cache: 789, # Integer | The cache duration.
|
338
|
+
download: 56, # Integer | Set it to 1 to create a download response.
|
339
|
+
bg: 'bg_example', # String | Optional background color.
|
340
|
+
width: 56, # Integer | The target width when an image.
|
341
|
+
height: 56, # Integer | The target height when an image.
|
342
|
+
quality: 56, # Integer | The target quality when an image.
|
343
|
+
preset: 'preset_example', # String | A preset dimension.
|
344
|
+
mode: Notifo::ResizeMode.new, # ResizeMode | The resize mode.
|
345
|
+
focus_x: 3.4, # Float | The x position of the focues point.
|
346
|
+
focus_y: 3.4, # Float | The y position of the focues point.
|
347
|
+
force: true, # BOOLEAN | True to resize it and clear the cache.
|
348
|
+
empty_on_failure: true # BOOLEAN | True, to return an empty image on failure.
|
349
|
+
}
|
350
|
+
|
351
|
+
begin
|
352
|
+
#Download a media object.
|
353
|
+
result = api_instance.media_proxy_proxy_image(opts)
|
354
|
+
p result
|
355
|
+
rescue Notifo::ApiError => e
|
356
|
+
puts "Exception when calling MediaApi->media_proxy_proxy_image: #{e}"
|
357
|
+
end
|
358
|
+
```
|
359
|
+
|
360
|
+
### Parameters
|
361
|
+
|
362
|
+
Name | Type | Description | Notes
|
363
|
+
------------- | ------------- | ------------- | -------------
|
364
|
+
**url** | **String**| The app id where the media belongs to. | [optional]
|
365
|
+
**cache** | **Integer**| The cache duration. | [optional]
|
366
|
+
**download** | **Integer**| Set it to 1 to create a download response. | [optional]
|
367
|
+
**bg** | **String**| Optional background color. | [optional]
|
368
|
+
**width** | **Integer**| The target width when an image. | [optional]
|
369
|
+
**height** | **Integer**| The target height when an image. | [optional]
|
370
|
+
**quality** | **Integer**| The target quality when an image. | [optional]
|
371
|
+
**preset** | **String**| A preset dimension. | [optional]
|
372
|
+
**mode** | [**ResizeMode**](.md)| The resize mode. | [optional]
|
373
|
+
**focus_x** | **Float**| The x position of the focues point. | [optional]
|
374
|
+
**focus_y** | **Float**| The y position of the focues point. | [optional]
|
375
|
+
**force** | **BOOLEAN**| True to resize it and clear the cache. | [optional]
|
376
|
+
**empty_on_failure** | **BOOLEAN**| True, to return an empty image on failure. | [optional]
|
377
|
+
|
378
|
+
### Return type
|
379
|
+
|
380
|
+
**String**
|
381
|
+
|
382
|
+
### Authorization
|
383
|
+
|
384
|
+
No authorization required
|
385
|
+
|
386
|
+
### HTTP request headers
|
387
|
+
|
388
|
+
- **Content-Type**: Not defined
|
389
|
+
- **Accept**: application/octet-stream, application/json
|
390
|
+
|
391
|
+
|
392
|
+
|
243
393
|
# **media_upload**
|
244
394
|
> media_upload(app_id, opts)
|
245
395
|
|
data/docs/MediaDto.md
CHANGED
@@ -6,8 +6,10 @@ Name | Type | Description | Notes
|
|
6
6
|
**mime_type** | **String** | The mime type. |
|
7
7
|
**file_name** | **String** | The file name. |
|
8
8
|
**file_info** | **String** | Generated information about the file. |
|
9
|
-
**file_size** | **Integer** | The size of the media file. |
|
10
9
|
**url** | **String** | The url to the media item. |
|
10
|
+
**file_size** | **Integer** | The size of the media file. |
|
11
|
+
**created** | **DateTime** | The date time (ISO 8601) when the media has been created. |
|
12
|
+
**last_update** | **DateTime** | The date time (ISO 8601) when the media has been updated. |
|
11
13
|
**type** | [**MediaType**](MediaType.md) | |
|
12
14
|
**metadata** | [**MediaMetadata**](MediaMetadata.md) | |
|
13
15
|
|
@@ -0,0 +1,394 @@
|
|
1
|
+
# Notifo::MessagingTemplatesApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://notifo-dev.easierlife.com*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**messaging_templates_delete_template**](MessagingTemplatesApi.md#messaging_templates_delete_template) | **DELETE** /api/apps/{appId}/messaging-templates/{code} | Delete a channel template.
|
8
|
+
[**messaging_templates_delete_template_language**](MessagingTemplatesApi.md#messaging_templates_delete_template_language) | **DELETE** /api/apps/{appId}/messaging-templates/{code}/{language} | Delete a language channel template.
|
9
|
+
[**messaging_templates_get_template**](MessagingTemplatesApi.md#messaging_templates_get_template) | **GET** /api/apps/{appId}/messaging-templates/{id} | Get the channel template by id.
|
10
|
+
[**messaging_templates_get_templates**](MessagingTemplatesApi.md#messaging_templates_get_templates) | **GET** /api/apps/{appId}/messaging-templates | Get the channel templates.
|
11
|
+
[**messaging_templates_post_template**](MessagingTemplatesApi.md#messaging_templates_post_template) | **POST** /api/apps/{appId}/messaging-templates | Create a channel template.
|
12
|
+
[**messaging_templates_post_template_language**](MessagingTemplatesApi.md#messaging_templates_post_template_language) | **POST** /api/apps/{appId}/messaging-templates/{code} | Create an app template language.
|
13
|
+
[**messaging_templates_put_template**](MessagingTemplatesApi.md#messaging_templates_put_template) | **PUT** /api/apps/{appId}/messaging-templates/{code} | Update an app template.
|
14
|
+
[**messaging_templates_put_template_language**](MessagingTemplatesApi.md#messaging_templates_put_template_language) | **PUT** /api/apps/{appId}/messaging-templates/{code}/{language} | Update a channel template language.
|
15
|
+
|
16
|
+
# **messaging_templates_delete_template**
|
17
|
+
> messaging_templates_delete_template(app_id, code)
|
18
|
+
|
19
|
+
Delete a channel template.
|
20
|
+
|
21
|
+
### Example
|
22
|
+
```ruby
|
23
|
+
# load the gem
|
24
|
+
require 'notifo'
|
25
|
+
|
26
|
+
api_instance = Notifo::MessagingTemplatesApi.new
|
27
|
+
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
|
28
|
+
code = 'code_example' # String | The template ID.
|
29
|
+
|
30
|
+
|
31
|
+
begin
|
32
|
+
#Delete a channel template.
|
33
|
+
api_instance.messaging_templates_delete_template(app_id, code)
|
34
|
+
rescue Notifo::ApiError => e
|
35
|
+
puts "Exception when calling MessagingTemplatesApi->messaging_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
|
+
**code** | **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
|
+
# **messaging_templates_delete_template_language**
|
62
|
+
> messaging_templates_delete_template_language(app_id, code, 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::MessagingTemplatesApi.new
|
72
|
+
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
|
73
|
+
code = 'code_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.messaging_templates_delete_template_language(app_id, code, language)
|
80
|
+
rescue Notifo::ApiError => e
|
81
|
+
puts "Exception when calling MessagingTemplatesApi->messaging_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
|
+
**code** | **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
|
+
# **messaging_templates_get_template**
|
109
|
+
> ChannelTemplateDetailsDtoOfMessagingTemplateDto messaging_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::MessagingTemplatesApi.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.messaging_templates_get_template(app_id, id)
|
126
|
+
p result
|
127
|
+
rescue Notifo::ApiError => e
|
128
|
+
puts "Exception when calling MessagingTemplatesApi->messaging_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
|
+
[**ChannelTemplateDetailsDtoOfMessagingTemplateDto**](ChannelTemplateDetailsDtoOfMessagingTemplateDto.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
|
+
# **messaging_templates_get_templates**
|
155
|
+
> ListResponseDtoOfChannelTemplateDto messaging_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::MessagingTemplatesApi.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.messaging_templates_get_templates(app_id, opts)
|
175
|
+
p result
|
176
|
+
rescue Notifo::ApiError => e
|
177
|
+
puts "Exception when calling MessagingTemplatesApi->messaging_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
|
+
# **messaging_templates_post_template**
|
206
|
+
> ChannelTemplateDetailsDtoOfMessagingTemplateDto messaging_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::MessagingTemplatesApi.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.messaging_templates_post_template(bodyapp_id)
|
223
|
+
p result
|
224
|
+
rescue Notifo::ApiError => e
|
225
|
+
puts "Exception when calling MessagingTemplatesApi->messaging_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
|
+
[**ChannelTemplateDetailsDtoOfMessagingTemplateDto**](ChannelTemplateDetailsDtoOfMessagingTemplateDto.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
|
+
# **messaging_templates_post_template_language**
|
252
|
+
> MessagingTemplateDto messaging_templates_post_template_language(bodyapp_idcode)
|
253
|
+
|
254
|
+
Create an app template language.
|
255
|
+
|
256
|
+
### Example
|
257
|
+
```ruby
|
258
|
+
# load the gem
|
259
|
+
require 'notifo'
|
260
|
+
|
261
|
+
api_instance = Notifo::MessagingTemplatesApi.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
|
+
code = 'code_example' # String | The template code.
|
265
|
+
|
266
|
+
|
267
|
+
begin
|
268
|
+
#Create an app template language.
|
269
|
+
result = api_instance.messaging_templates_post_template_language(bodyapp_idcode)
|
270
|
+
p result
|
271
|
+
rescue Notifo::ApiError => e
|
272
|
+
puts "Exception when calling MessagingTemplatesApi->messaging_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
|
+
**code** | **String**| The template code. |
|
283
|
+
|
284
|
+
### Return type
|
285
|
+
|
286
|
+
[**MessagingTemplateDto**](MessagingTemplateDto.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
|
+
# **messaging_templates_put_template**
|
300
|
+
> messaging_templates_put_template(bodyapp_idcode)
|
301
|
+
|
302
|
+
Update an app template.
|
303
|
+
|
304
|
+
### Example
|
305
|
+
```ruby
|
306
|
+
# load the gem
|
307
|
+
require 'notifo'
|
308
|
+
|
309
|
+
api_instance = Notifo::MessagingTemplatesApi.new
|
310
|
+
body = Notifo::UpdateChannelTemplateDtoOfMessagingTemplateDto.new # UpdateChannelTemplateDtoOfMessagingTemplateDto | The request object.
|
311
|
+
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
|
312
|
+
code = 'code_example' # String | The template code.
|
313
|
+
|
314
|
+
|
315
|
+
begin
|
316
|
+
#Update an app template.
|
317
|
+
api_instance.messaging_templates_put_template(bodyapp_idcode)
|
318
|
+
rescue Notifo::ApiError => e
|
319
|
+
puts "Exception when calling MessagingTemplatesApi->messaging_templates_put_template: #{e}"
|
320
|
+
end
|
321
|
+
```
|
322
|
+
|
323
|
+
### Parameters
|
324
|
+
|
325
|
+
Name | Type | Description | Notes
|
326
|
+
------------- | ------------- | ------------- | -------------
|
327
|
+
**body** | [**UpdateChannelTemplateDtoOfMessagingTemplateDto**](UpdateChannelTemplateDtoOfMessagingTemplateDto.md)| The request object. |
|
328
|
+
**app_id** | **String**| The id of the app where the templates belong to. |
|
329
|
+
**code** | **String**| The template code. |
|
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
|
+
# **messaging_templates_put_template_language**
|
347
|
+
> messaging_templates_put_template_language(bodyapp_idcodelanguage)
|
348
|
+
|
349
|
+
Update a channel template language.
|
350
|
+
|
351
|
+
### Example
|
352
|
+
```ruby
|
353
|
+
# load the gem
|
354
|
+
require 'notifo'
|
355
|
+
|
356
|
+
api_instance = Notifo::MessagingTemplatesApi.new
|
357
|
+
body = Notifo::MessagingTemplateDto.new # MessagingTemplateDto | The request object.
|
358
|
+
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
|
359
|
+
code = 'code_example' # String | The template code.
|
360
|
+
language = 'language_example' # String | The language.
|
361
|
+
|
362
|
+
|
363
|
+
begin
|
364
|
+
#Update a channel template language.
|
365
|
+
api_instance.messaging_templates_put_template_language(bodyapp_idcodelanguage)
|
366
|
+
rescue Notifo::ApiError => e
|
367
|
+
puts "Exception when calling MessagingTemplatesApi->messaging_templates_put_template_language: #{e}"
|
368
|
+
end
|
369
|
+
```
|
370
|
+
|
371
|
+
### Parameters
|
372
|
+
|
373
|
+
Name | Type | Description | Notes
|
374
|
+
------------- | ------------- | ------------- | -------------
|
375
|
+
**body** | [**MessagingTemplateDto**](MessagingTemplateDto.md)| The request object. |
|
376
|
+
**app_id** | **String**| The id of the app where the templates belong to. |
|
377
|
+
**code** | **String**| The template code. |
|
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
|
+
|