notifo-io 1.0.1 → 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 +1242 -42
- data/Rakefile +0 -2
- data/docs/AddAllowedTopicDto.md +3 -14
- data/docs/AddContributorDto.md +4 -16
- data/docs/AppContributorDto.md +5 -18
- data/docs/AppDetailsDto.md +12 -44
- data/docs/AppDto.md +10 -24
- data/docs/AppIdMediaBody.md +7 -0
- data/docs/AppsApi.md +161 -343
- data/docs/ChannelCondition.md +6 -0
- data/docs/ChannelSend.md +6 -0
- 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/ConfigsApi.md +21 -61
- data/docs/ConfiguredIntegrationDto.md +13 -0
- data/docs/ConfiguredIntegrationsDto.md +8 -0
- data/docs/ConfirmMode.md +2 -11
- data/docs/CreateChannelTemplateDto.md +7 -0
- data/docs/CreateChannelTemplateLanguageDto.md +7 -0
- data/docs/CreateIntegrationDto.md +11 -0
- 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/EmailPreviewType.md +6 -0
- data/docs/EmailTemplateDto.md +8 -18
- data/docs/EmailTemplateType.md +6 -0
- data/docs/EmailTemplatesApi.md +488 -0
- data/docs/ErrorDto.md +8 -22
- data/docs/EventDto.md +17 -36
- data/docs/EventsApi.md +74 -65
- data/docs/HandledInfoDto.md +8 -0
- data/docs/IntegrationCreatedDto.md +8 -0
- data/docs/IntegrationDefinitionDto.md +11 -0
- data/docs/IntegrationPropertyDto.md +19 -0
- data/docs/IntegrationPropertyType.md +6 -0
- data/docs/IntegrationStatus.md +6 -0
- data/docs/IsoDayOfWeek.md +2 -11
- data/docs/ListResponseDtoOfChannelTemplateDto.md +8 -0
- data/docs/ListResponseDtoOfEventDto.md +4 -16
- data/docs/ListResponseDtoOfLogEntryDto.md +4 -16
- data/docs/ListResponseDtoOfMediaDto.md +4 -16
- data/docs/ListResponseDtoOfMobilePushTokenDto.md +8 -0
- data/docs/ListResponseDtoOfSubscriptionDto.md +4 -16
- data/docs/ListResponseDtoOfSystemUserDto.md +8 -0
- data/docs/ListResponseDtoOfTemplateDto.md +4 -16
- data/docs/ListResponseDtoOfTopicDto.md +4 -16
- data/docs/ListResponseDtoOfUserDto.md +4 -16
- data/docs/ListResponseDtoOfUserNotificationDetailsDto.md +8 -0
- data/docs/ListResponseDtoOfUserNotificationDto.md +8 -0
- data/docs/LocalizedText.md +6 -0
- data/docs/LogEntryDto.md +6 -20
- data/docs/LogsApi.md +21 -40
- data/docs/MediaApi.md +102 -196
- data/docs/MediaDto.md +11 -26
- data/docs/MediaMetadata.md +6 -0
- data/docs/MediaType.md +2 -11
- data/docs/MessagingTemplateDto.md +7 -0
- data/docs/MessagingTemplatesApi.md +394 -0
- data/docs/MobileDeviceType.md +6 -0
- data/docs/MobilePushApi.md +135 -0
- data/docs/MobilePushTokenDto.md +9 -0
- data/docs/MobilePushTokenDto2.md +8 -0
- data/docs/NotificationFormattingDto.md +10 -28
- data/docs/NotificationProperties.md +6 -0
- data/docs/NotificationsApi.md +199 -0
- data/docs/PingApi.md +48 -0
- data/docs/ProcessStatus.md +6 -0
- data/docs/ProfileDto.md +11 -28
- data/docs/PublishDto.md +14 -32
- data/docs/PublishManyDto.md +3 -14
- data/docs/RegisterMobileTokenDto.md +8 -0
- data/docs/ResizeMode.md +2 -11
- data/docs/SchedulingDto.md +6 -20
- data/docs/SchedulingType.md +2 -11
- data/docs/SmsTemplateDto.md +7 -0
- data/docs/SmsTemplatesApi.md +394 -0
- data/docs/SubscribeDto.md +8 -0
- data/docs/SubscribeManyDto.md +8 -0
- data/docs/SubscriptionDto.md +4 -16
- data/docs/SystemUserDto.md +11 -0
- data/docs/SystemUsersApi.md +327 -0
- data/docs/TemplateDto.md +7 -18
- data/docs/TemplatesApi.md +52 -108
- data/docs/TopicChannel.md +6 -0
- data/docs/TopicDto.md +11 -18
- data/docs/TopicQueryScope.md +6 -0
- data/docs/TopicsApi.md +106 -30
- data/docs/TrackNotificationDto.md +10 -0
- data/docs/UpdateChannelTemplateDtoOfEmailTemplateDto.md +9 -0
- data/docs/UpdateChannelTemplateDtoOfMessagingTemplateDto.md +9 -0
- data/docs/UpdateChannelTemplateDtoOfSmsTemplateDto.md +9 -0
- data/docs/UpdateIntegrationDto.md +11 -0
- data/docs/UpdateProfileDto.md +8 -24
- data/docs/UpdateSystemUserDto.md +9 -0
- data/docs/UpsertAppDto.md +12 -32
- data/docs/UpsertTemplateDto.md +5 -18
- data/docs/UpsertTemplatesDto.md +3 -14
- data/docs/UpsertTopicDto.md +11 -0
- data/docs/UpsertTopicsDto.md +7 -0
- data/docs/UpsertUserDto.md +11 -28
- data/docs/UpsertUsersDto.md +3 -14
- data/docs/UserApi.md +156 -150
- data/docs/UserDto.md +20 -32
- data/docs/UserNotificationBaseDto.md +23 -0
- data/docs/UserNotificationChannelDto.md +11 -0
- data/docs/UserNotificationDetailsDto.md +27 -0
- data/docs/UserNotificationDto.md +25 -0
- data/docs/UserPropertyDto.md +9 -0
- data/docs/UserTopicDto.md +11 -0
- data/docs/UsersApi.md +161 -320
- data/git_push.sh +7 -10
- data/lib/notifo/api/apps_api.rb +164 -236
- data/lib/notifo/api/configs_api.rb +14 -30
- data/lib/notifo/api/email_templates_api.rb +663 -0
- data/lib/notifo/api/events_api.rb +88 -45
- data/lib/notifo/api/logs_api.rb +12 -21
- data/lib/notifo/api/media_api.rb +60 -97
- data/lib/notifo/api/messaging_templates_api.rb +541 -0
- data/lib/notifo/api/mobile_push_api.rb +178 -0
- data/lib/notifo/api/notifications_api.rb +256 -0
- 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 +43 -66
- data/lib/notifo/api/topics_api.rb +137 -21
- data/lib/notifo/api/user_api.rb +178 -104
- data/lib/notifo/api/users_api.rb +140 -199
- data/lib/notifo/api_client.rb +54 -56
- data/lib/notifo/api_error.rb +5 -5
- data/lib/notifo/configuration.rb +12 -84
- data/lib/notifo/models/add_allowed_topic_dto.rb +13 -44
- data/lib/notifo/models/add_contributor_dto.rb +14 -64
- data/lib/notifo/models/app_contributor_dto.rb +15 -84
- data/lib/notifo/models/app_details_dto.rb +51 -189
- data/lib/notifo/models/app_dto.rb +47 -86
- data/lib/notifo/models/{inline_object.rb → app_id_media_body.rb} +16 -28
- data/lib/notifo/models/channel_condition.rb +30 -0
- data/lib/notifo/models/channel_send.rb +30 -0
- 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 +285 -0
- data/lib/notifo/models/configured_integrations_dto.rb +231 -0
- data/lib/notifo/models/confirm_mode.rb +6 -16
- data/lib/notifo/models/create_channel_template_dto.rb +208 -0
- data/lib/notifo/models/{create_email_template_dto.rb → create_channel_template_language_dto.rb} +16 -47
- data/lib/notifo/models/create_integration_dto.rb +262 -0
- 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/{notification_setting_dto.rb → email_preview_request_dto.rb} +43 -45
- data/lib/notifo/models/email_preview_type.rb +28 -0
- data/lib/notifo/models/email_template_dto.rb +52 -69
- data/lib/notifo/models/email_template_type.rb +30 -0
- data/lib/notifo/models/error_dto.rb +29 -30
- data/lib/notifo/models/event_dto.rb +60 -115
- data/lib/notifo/models/handled_info_dto.rb +218 -0
- data/lib/notifo/models/integration_created_dto.rb +226 -0
- data/lib/notifo/models/integration_definition_dto.rb +272 -0
- data/lib/notifo/models/integration_property_dto.rb +347 -0
- data/lib/notifo/models/integration_property_type.rb +31 -0
- data/lib/notifo/models/integration_status.rb +29 -0
- data/lib/notifo/models/iso_day_of_week.rb +12 -21
- 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 +14 -26
- data/lib/notifo/models/list_response_dto_of_log_entry_dto.rb +14 -26
- data/lib/notifo/models/list_response_dto_of_media_dto.rb +14 -26
- data/lib/notifo/models/list_response_dto_of_mobile_push_token_dto.rb +229 -0
- data/lib/notifo/models/list_response_dto_of_subscription_dto.rb +14 -26
- data/lib/notifo/models/list_response_dto_of_system_user_dto.rb +229 -0
- data/lib/notifo/models/list_response_dto_of_template_dto.rb +14 -26
- data/lib/notifo/models/list_response_dto_of_topic_dto.rb +14 -26
- data/lib/notifo/models/list_response_dto_of_user_dto.rb +14 -26
- 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 +201 -0
- data/lib/notifo/models/log_entry_dto.rb +16 -85
- data/lib/notifo/models/media_dto.rb +56 -116
- data/lib/notifo/models/media_metadata.rb +201 -0
- data/lib/notifo/models/media_type.rb +8 -17
- data/lib/notifo/models/messaging_template_dto.rb +212 -0
- data/lib/notifo/models/mobile_device_type.rb +29 -0
- data/lib/notifo/models/mobile_push_token_dto.rb +237 -0
- data/lib/notifo/models/mobile_push_token_dto2.rb +221 -0
- data/lib/notifo/models/notification_formatting_dto.rb +27 -58
- data/lib/notifo/models/notification_properties.rb +201 -0
- data/lib/notifo/models/process_status.rb +31 -0
- data/lib/notifo/models/profile_dto.rb +33 -71
- data/lib/notifo/models/publish_dto.rb +47 -59
- data/lib/notifo/models/publish_many_dto.rb +13 -25
- data/lib/notifo/models/register_mobile_token_dto.rb +221 -0
- data/lib/notifo/models/resize_mode.rb +11 -20
- data/lib/notifo/models/scheduling_dto.rb +16 -28
- data/lib/notifo/models/scheduling_type.rb +6 -15
- data/lib/notifo/models/sms_template_dto.rb +212 -0
- 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 +17 -44
- data/lib/notifo/models/system_user_dto.rb +269 -0
- data/lib/notifo/models/template_dto.rb +44 -45
- data/lib/notifo/models/topic_channel.rb +28 -0
- data/lib/notifo/models/topic_dto.rb +81 -65
- data/lib/notifo/models/topic_query_scope.rb +29 -0
- data/lib/notifo/models/track_notification_dto.rb +243 -0
- 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 +258 -0
- data/lib/notifo/models/update_profile_dto.rb +18 -30
- data/lib/notifo/models/update_system_user_dto.rb +240 -0
- data/lib/notifo/models/upsert_app_dto.rb +22 -34
- data/lib/notifo/models/upsert_template_dto.rb +15 -46
- data/lib/notifo/models/upsert_templates_dto.rb +13 -25
- 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 +34 -33
- data/lib/notifo/models/upsert_users_dto.rb +13 -25
- data/lib/notifo/models/user_dto.rb +137 -73
- data/lib/notifo/models/user_notification_base_dto.rb +402 -0
- 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 +4 -5
- data/lib/notifo.rb +71 -9
- data/notifo.gemspec +8 -8
- data/spec/api/apps_api_spec.rb +31 -32
- data/spec/api/configs_api_spec.rb +7 -8
- data/spec/api/email_templates_api_spec.rb +161 -0
- data/spec/api/events_api_spec.rb +20 -9
- data/spec/api/logs_api_spec.rb +7 -8
- data/spec/api/media_api_spec.rb +32 -11
- data/spec/api/messaging_templates_api_spec.rb +137 -0
- data/spec/api/mobile_push_api_spec.rb +66 -0
- data/spec/api/notifications_api_spec.rb +85 -0
- 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 +9 -10
- data/spec/api/topics_api_spec.rb +32 -8
- data/spec/api/user_api_spec.rb +41 -17
- data/spec/api/users_api_spec.rb +24 -23
- data/spec/api_client_spec.rb +5 -6
- data/spec/base_object_spec.rb +109 -0
- data/spec/configuration_spec.rb +7 -8
- data/spec/models/add_allowed_topic_dto_spec.rb +15 -9
- data/spec/models/add_contributor_dto_spec.rb +15 -9
- data/spec/models/app_contributor_dto_spec.rb +15 -9
- data/spec/models/app_details_dto_spec.rb +18 -48
- data/spec/models/app_dto_spec.rb +27 -9
- data/spec/models/app_id_media_body_spec.rb +40 -0
- data/spec/models/channel_condition_spec.rb +34 -0
- data/spec/models/channel_send_info_dto_spec.rb +52 -0
- data/spec/models/channel_send_spec.rb +34 -0
- 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 +76 -0
- data/spec/models/configured_integrations_dto_spec.rb +46 -0
- data/spec/models/confirm_mode_spec.rb +15 -9
- data/spec/models/create_channel_template_dto_spec.rb +40 -0
- data/spec/models/create_channel_template_language_dto_spec.rb +40 -0
- data/spec/models/create_integration_dto_spec.rb +64 -0
- data/spec/models/create_system_user_dto_spec.rb +52 -0
- data/spec/models/email_formatting_error_spec.rb +58 -0
- data/spec/models/email_preview_dto_spec.rb +46 -0
- data/spec/models/email_preview_request_dto_spec.rb +52 -0
- data/spec/models/email_preview_type_spec.rb +34 -0
- data/spec/models/email_template_dto_spec.rb +33 -9
- data/spec/models/email_template_type_spec.rb +34 -0
- data/spec/models/error_dto_spec.rb +21 -9
- data/spec/models/event_dto_spec.rb +33 -9
- data/spec/models/handled_info_dto_spec.rb +46 -0
- data/spec/models/integration_created_dto_spec.rb +46 -0
- data/spec/models/integration_definition_dto_spec.rb +64 -0
- data/spec/models/integration_property_dto_spec.rb +112 -0
- data/spec/models/integration_property_type_spec.rb +34 -0
- data/spec/models/integration_status_spec.rb +34 -0
- data/spec/models/iso_day_of_week_spec.rb +15 -9
- 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 +15 -9
- data/spec/models/list_response_dto_of_log_entry_dto_spec.rb +15 -9
- data/spec/models/list_response_dto_of_media_dto_spec.rb +15 -9
- data/spec/models/list_response_dto_of_mobile_push_token_dto_spec.rb +46 -0
- data/spec/models/list_response_dto_of_subscription_dto_spec.rb +15 -9
- data/spec/models/list_response_dto_of_system_user_dto_spec.rb +46 -0
- data/spec/models/list_response_dto_of_template_dto_spec.rb +15 -9
- data/spec/models/list_response_dto_of_topic_dto_spec.rb +15 -9
- data/spec/models/list_response_dto_of_user_dto_spec.rb +15 -9
- 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 +34 -0
- data/spec/models/log_entry_dto_spec.rb +15 -9
- data/spec/models/media_dto_spec.rb +33 -9
- data/spec/models/media_metadata_spec.rb +34 -0
- data/spec/models/media_type_spec.rb +15 -9
- data/spec/models/messaging_template_dto_spec.rb +40 -0
- data/spec/models/mobile_device_type_spec.rb +34 -0
- data/spec/models/mobile_push_token_dto2_spec.rb +46 -0
- data/spec/models/mobile_push_token_dto_spec.rb +52 -0
- data/spec/models/notification_formatting_dto_spec.rb +15 -9
- 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 +21 -9
- data/spec/models/publish_dto_spec.rb +27 -9
- data/spec/models/publish_many_dto_spec.rb +15 -9
- data/spec/models/register_mobile_token_dto_spec.rb +46 -0
- data/spec/models/resize_mode_spec.rb +15 -9
- data/spec/models/scheduling_dto_spec.rb +15 -9
- data/spec/models/scheduling_type_spec.rb +15 -9
- data/spec/models/sms_template_dto_spec.rb +40 -0
- 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 +15 -9
- data/spec/models/system_user_dto_spec.rb +64 -0
- data/spec/models/template_dto_spec.rb +27 -9
- data/spec/models/topic_channel_spec.rb +34 -0
- data/spec/models/topic_dto_spec.rb +51 -9
- data/spec/models/topic_query_scope_spec.rb +34 -0
- data/spec/models/track_notification_dto_spec.rb +58 -0
- 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 +64 -0
- data/spec/models/update_profile_dto_spec.rb +15 -9
- data/spec/models/update_system_user_dto_spec.rb +52 -0
- data/spec/models/upsert_app_dto_spec.rb +15 -9
- data/spec/models/upsert_template_dto_spec.rb +15 -9
- data/spec/models/upsert_templates_dto_spec.rb +15 -9
- 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 +21 -9
- data/spec/models/upsert_users_dto_spec.rb +15 -9
- data/spec/models/user_dto_spec.rb +63 -9
- data/spec/models/user_notification_base_dto_spec.rb +136 -0
- 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 +4 -5
- metadata +299 -32
- data/docs/CreateEmailTemplateDto.md +0 -18
- data/docs/EmailVerificationStatus.md +0 -15
- data/docs/InlineObject.md +0 -18
- data/docs/NotificationSend.md +0 -15
- data/docs/NotificationSettingDto.md +0 -20
- data/lib/notifo/models/email_verification_status.rb +0 -39
- data/lib/notifo/models/notification_send.rb +0 -39
- data/notifo-1.0.0.gem +0 -0
- data/notifo-io-1.0.0.2.gem +0 -0
- data/notifo-io-1.0.0.gem +0 -0
- data/spec/models/create_email_template_dto_spec.rb +0 -34
- data/spec/models/email_verification_status_spec.rb +0 -28
- data/spec/models/inline_object_spec.rb +0 -34
- data/spec/models/notification_send_spec.rb +0 -28
- data/spec/models/notification_setting_dto_spec.rb +0 -40
data/README.md
CHANGED
@@ -2,13 +2,13 @@
|
|
2
2
|
|
3
3
|
Notifo - the Ruby gem for the Notifo API
|
4
4
|
|
5
|
-
No description provided (generated by
|
5
|
+
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
|
6
6
|
|
7
|
-
This SDK is automatically generated by the [
|
7
|
+
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
8
8
|
|
9
9
|
- API version: 1.0.0
|
10
10
|
- Package version: 1.0.0
|
11
|
-
- Build package:
|
11
|
+
- Build package: io.swagger.codegen.v3.generators.ruby.RubyClientCodegen
|
12
12
|
|
13
13
|
## Installation
|
14
14
|
|
@@ -25,97 +25,1242 @@ Then either install the gem locally:
|
|
25
25
|
```shell
|
26
26
|
gem install ./notifo-1.0.0.gem
|
27
27
|
```
|
28
|
+
(for development, run `gem install --dev ./notifo-1.0.0.gem` to install the development dependencies)
|
29
|
+
|
30
|
+
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
31
|
+
|
32
|
+
Finally add this to the Gemfile:
|
33
|
+
|
34
|
+
gem 'notifo', '~> 1.0.0'
|
35
|
+
|
36
|
+
### Install from Git
|
37
|
+
|
38
|
+
If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
|
39
|
+
|
40
|
+
gem 'notifo', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
|
41
|
+
|
42
|
+
### Include the Ruby code directly
|
43
|
+
|
44
|
+
Include the Ruby code directly using `-I` as follows:
|
45
|
+
|
46
|
+
```shell
|
47
|
+
ruby -Ilib script.rb
|
48
|
+
```
|
49
|
+
|
50
|
+
## Getting Started
|
51
|
+
|
52
|
+
Please follow the [installation](#installation) procedure and then run the following code:
|
53
|
+
```ruby
|
54
|
+
# Load the gem
|
55
|
+
require 'notifo'
|
56
|
+
|
57
|
+
api_instance = Notifo::AppsApi.new
|
58
|
+
app_id = 'app_id_example' # String | The id of the app.
|
59
|
+
contributor_id = 'contributor_id_example' # String | The contributor to remove.
|
60
|
+
|
61
|
+
|
62
|
+
begin
|
63
|
+
#Delete an app contributor.
|
64
|
+
result = api_instance.apps_delete_contributor(app_id, contributor_id)
|
65
|
+
p result
|
66
|
+
rescue Notifo::ApiError => e
|
67
|
+
puts "Exception when calling AppsApi->apps_delete_contributor: #{e}"
|
68
|
+
end
|
69
|
+
|
70
|
+
api_instance = Notifo::AppsApi.new
|
71
|
+
app_id = 'app_id_example' # String | The id of the app where the email templates belong to.
|
72
|
+
id = 'id_example' # String | The id of the integration.
|
73
|
+
|
74
|
+
|
75
|
+
begin
|
76
|
+
#Delete an app integration.
|
77
|
+
api_instance.apps_delete_integration(app_id, id)
|
78
|
+
rescue Notifo::ApiError => e
|
79
|
+
puts "Exception when calling AppsApi->apps_delete_integration: #{e}"
|
80
|
+
end
|
81
|
+
|
82
|
+
api_instance = Notifo::AppsApi.new
|
83
|
+
app_id = 'app_id_example' # String | The id of the app.
|
84
|
+
|
85
|
+
|
86
|
+
begin
|
87
|
+
#Get app by id.
|
88
|
+
result = api_instance.apps_get_app(app_id)
|
89
|
+
p result
|
90
|
+
rescue Notifo::ApiError => e
|
91
|
+
puts "Exception when calling AppsApi->apps_get_app: #{e}"
|
92
|
+
end
|
93
|
+
|
94
|
+
api_instance = Notifo::AppsApi.new
|
95
|
+
|
96
|
+
begin
|
97
|
+
#Get the user apps.
|
98
|
+
result = api_instance.apps_get_apps
|
99
|
+
p result
|
100
|
+
rescue Notifo::ApiError => e
|
101
|
+
puts "Exception when calling AppsApi->apps_get_apps: #{e}"
|
102
|
+
end
|
103
|
+
|
104
|
+
api_instance = Notifo::AppsApi.new
|
105
|
+
app_id = 'app_id_example' # String | The id of the app where the integrations belong to.
|
106
|
+
|
107
|
+
|
108
|
+
begin
|
109
|
+
#Get the app integrations.
|
110
|
+
result = api_instance.apps_get_integrations(app_id)
|
111
|
+
p result
|
112
|
+
rescue Notifo::ApiError => e
|
113
|
+
puts "Exception when calling AppsApi->apps_get_integrations: #{e}"
|
114
|
+
end
|
115
|
+
|
116
|
+
api_instance = Notifo::AppsApi.new
|
117
|
+
body = Notifo::UpsertAppDto.new # UpsertAppDto | The request object.
|
118
|
+
|
119
|
+
|
120
|
+
begin
|
121
|
+
#Create an app.
|
122
|
+
result = api_instance.apps_post_app(body)
|
123
|
+
p result
|
124
|
+
rescue Notifo::ApiError => e
|
125
|
+
puts "Exception when calling AppsApi->apps_post_app: #{e}"
|
126
|
+
end
|
127
|
+
|
128
|
+
api_instance = Notifo::AppsApi.new
|
129
|
+
body = Notifo::AddContributorDto.new # AddContributorDto | The request object.
|
130
|
+
app_id = 'app_id_example' # String | The id of the app.
|
131
|
+
|
132
|
+
|
133
|
+
begin
|
134
|
+
#Add an app contributor.
|
135
|
+
result = api_instance.apps_post_contributor(body, app_id)
|
136
|
+
p result
|
137
|
+
rescue Notifo::ApiError => e
|
138
|
+
puts "Exception when calling AppsApi->apps_post_contributor: #{e}"
|
139
|
+
end
|
140
|
+
|
141
|
+
api_instance = Notifo::AppsApi.new
|
142
|
+
body = Notifo::CreateIntegrationDto.new # CreateIntegrationDto | The request object.
|
143
|
+
app_id = 'app_id_example' # String | The id of the app where the integration belong to.
|
144
|
+
|
145
|
+
|
146
|
+
begin
|
147
|
+
#Create an app integrations.
|
148
|
+
result = api_instance.apps_post_integration(body, app_id)
|
149
|
+
p result
|
150
|
+
rescue Notifo::ApiError => e
|
151
|
+
puts "Exception when calling AppsApi->apps_post_integration: #{e}"
|
152
|
+
end
|
153
|
+
|
154
|
+
api_instance = Notifo::AppsApi.new
|
155
|
+
body = Notifo::UpsertAppDto.new # UpsertAppDto | The request object.
|
156
|
+
app_id = 'app_id_example' # String | The app id to update.
|
157
|
+
|
158
|
+
|
159
|
+
begin
|
160
|
+
#Update an app.
|
161
|
+
result = api_instance.apps_put_app(body, app_id)
|
162
|
+
p result
|
163
|
+
rescue Notifo::ApiError => e
|
164
|
+
puts "Exception when calling AppsApi->apps_put_app: #{e}"
|
165
|
+
end
|
166
|
+
|
167
|
+
api_instance = Notifo::AppsApi.new
|
168
|
+
body = Notifo::UpdateIntegrationDto.new # UpdateIntegrationDto | The request object.
|
169
|
+
app_id = 'app_id_example' # String | The id of the app where the integration belong to.
|
170
|
+
id = 'id_example' # String | The id of the integration.
|
171
|
+
|
172
|
+
|
173
|
+
begin
|
174
|
+
#Update an app integration.
|
175
|
+
api_instance.apps_put_integration(body, app_id, id)
|
176
|
+
rescue Notifo::ApiError => e
|
177
|
+
puts "Exception when calling AppsApi->apps_put_integration: #{e}"
|
178
|
+
end
|
179
|
+
|
180
|
+
api_instance = Notifo::ConfigsApi.new
|
181
|
+
|
182
|
+
begin
|
183
|
+
#Get all supported languages.
|
184
|
+
result = api_instance.configs_get_languages
|
185
|
+
p result
|
186
|
+
rescue Notifo::ApiError => e
|
187
|
+
puts "Exception when calling ConfigsApi->configs_get_languages: #{e}"
|
188
|
+
end
|
189
|
+
|
190
|
+
api_instance = Notifo::ConfigsApi.new
|
191
|
+
|
192
|
+
begin
|
193
|
+
#Get all supported timezones.
|
194
|
+
result = api_instance.configs_get_timezones
|
195
|
+
p result
|
196
|
+
rescue Notifo::ApiError => e
|
197
|
+
puts "Exception when calling ConfigsApi->configs_get_timezones: #{e}"
|
198
|
+
end
|
199
|
+
|
200
|
+
api_instance = Notifo::EmailTemplatesApi.new
|
201
|
+
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
|
202
|
+
id = 'id_example' # String | The template ID.
|
203
|
+
|
204
|
+
|
205
|
+
begin
|
206
|
+
#Get the HTML preview for a channel template.
|
207
|
+
result = api_instance.email_template_preview_get_preview(app_id, id)
|
208
|
+
p result
|
209
|
+
rescue Notifo::ApiError => e
|
210
|
+
puts "Exception when calling EmailTemplatesApi->email_template_preview_get_preview: #{e}"
|
211
|
+
end
|
212
|
+
|
213
|
+
api_instance = Notifo::EmailTemplatesApi.new
|
214
|
+
body = Notifo::EmailPreviewRequestDto.new # EmailPreviewRequestDto | The template to render.
|
215
|
+
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
|
216
|
+
|
217
|
+
|
218
|
+
begin
|
219
|
+
#Render a preview for a email template.
|
220
|
+
result = api_instance.email_template_preview_post_preview(body, app_id)
|
221
|
+
p result
|
222
|
+
rescue Notifo::ApiError => e
|
223
|
+
puts "Exception when calling EmailTemplatesApi->email_template_preview_post_preview: #{e}"
|
224
|
+
end
|
225
|
+
|
226
|
+
api_instance = Notifo::EmailTemplatesApi.new
|
227
|
+
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
|
228
|
+
id = 'id_example' # String | The template ID.
|
229
|
+
|
230
|
+
|
231
|
+
begin
|
232
|
+
#Delete a channel template.
|
233
|
+
api_instance.email_templates_delete_template(app_id, id)
|
234
|
+
rescue Notifo::ApiError => e
|
235
|
+
puts "Exception when calling EmailTemplatesApi->email_templates_delete_template: #{e}"
|
236
|
+
end
|
237
|
+
|
238
|
+
api_instance = Notifo::EmailTemplatesApi.new
|
239
|
+
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
|
240
|
+
id = 'id_example' # String | The template ID.
|
241
|
+
language = 'language_example' # String | The language.
|
242
|
+
|
243
|
+
|
244
|
+
begin
|
245
|
+
#Delete a language channel template.
|
246
|
+
api_instance.email_templates_delete_template_language(app_id, id, language)
|
247
|
+
rescue Notifo::ApiError => e
|
248
|
+
puts "Exception when calling EmailTemplatesApi->email_templates_delete_template_language: #{e}"
|
249
|
+
end
|
250
|
+
|
251
|
+
api_instance = Notifo::EmailTemplatesApi.new
|
252
|
+
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
|
253
|
+
id = 'id_example' # String | The template ID.
|
254
|
+
|
255
|
+
|
256
|
+
begin
|
257
|
+
#Get the channel template by id.
|
258
|
+
result = api_instance.email_templates_get_template(app_id, id)
|
259
|
+
p result
|
260
|
+
rescue Notifo::ApiError => e
|
261
|
+
puts "Exception when calling EmailTemplatesApi->email_templates_get_template: #{e}"
|
262
|
+
end
|
263
|
+
|
264
|
+
api_instance = Notifo::EmailTemplatesApi.new
|
265
|
+
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
|
266
|
+
opts = {
|
267
|
+
query: 'query_example', # String | The optional query to search for items.
|
268
|
+
take: 56, # Integer | The number of items to return.
|
269
|
+
skip: 56 # Integer | The number of items to skip.
|
270
|
+
}
|
271
|
+
|
272
|
+
begin
|
273
|
+
#Get the channel templates.
|
274
|
+
result = api_instance.email_templates_get_templates(app_id, opts)
|
275
|
+
p result
|
276
|
+
rescue Notifo::ApiError => e
|
277
|
+
puts "Exception when calling EmailTemplatesApi->email_templates_get_templates: #{e}"
|
278
|
+
end
|
279
|
+
|
280
|
+
api_instance = Notifo::EmailTemplatesApi.new
|
281
|
+
body = Notifo::CreateChannelTemplateDto.new # CreateChannelTemplateDto | The request object.
|
282
|
+
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
|
283
|
+
|
284
|
+
|
285
|
+
begin
|
286
|
+
#Create a channel template.
|
287
|
+
result = api_instance.email_templates_post_template(body, app_id)
|
288
|
+
p result
|
289
|
+
rescue Notifo::ApiError => e
|
290
|
+
puts "Exception when calling EmailTemplatesApi->email_templates_post_template: #{e}"
|
291
|
+
end
|
292
|
+
|
293
|
+
api_instance = Notifo::EmailTemplatesApi.new
|
294
|
+
body = Notifo::CreateChannelTemplateLanguageDto.new # CreateChannelTemplateLanguageDto | The request object.
|
295
|
+
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
|
296
|
+
id = 'id_example' # String | The template ID.
|
297
|
+
|
298
|
+
|
299
|
+
begin
|
300
|
+
#Create an app template language.
|
301
|
+
result = api_instance.email_templates_post_template_language(body, app_id, id)
|
302
|
+
p result
|
303
|
+
rescue Notifo::ApiError => e
|
304
|
+
puts "Exception when calling EmailTemplatesApi->email_templates_post_template_language: #{e}"
|
305
|
+
end
|
306
|
+
|
307
|
+
api_instance = Notifo::EmailTemplatesApi.new
|
308
|
+
body = Notifo::UpdateChannelTemplateDtoOfEmailTemplateDto.new # UpdateChannelTemplateDtoOfEmailTemplateDto | The request object.
|
309
|
+
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
|
310
|
+
id = 'id_example' # String | The template ID.
|
311
|
+
|
312
|
+
|
313
|
+
begin
|
314
|
+
#Update an app template.
|
315
|
+
api_instance.email_templates_put_template(body, app_id, id)
|
316
|
+
rescue Notifo::ApiError => e
|
317
|
+
puts "Exception when calling EmailTemplatesApi->email_templates_put_template: #{e}"
|
318
|
+
end
|
319
|
+
|
320
|
+
api_instance = Notifo::EmailTemplatesApi.new
|
321
|
+
body = Notifo::EmailTemplateDto.new # EmailTemplateDto | The request object.
|
322
|
+
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
|
323
|
+
id = 'id_example' # String | The template ID.
|
324
|
+
language = 'language_example' # String | The language.
|
325
|
+
|
326
|
+
|
327
|
+
begin
|
328
|
+
#Update a channel template language.
|
329
|
+
api_instance.email_templates_put_template_language(body, app_id, id, language)
|
330
|
+
rescue Notifo::ApiError => e
|
331
|
+
puts "Exception when calling EmailTemplatesApi->email_templates_put_template_language: #{e}"
|
332
|
+
end
|
333
|
+
|
334
|
+
api_instance = Notifo::EventsApi.new
|
335
|
+
app_id = 'app_id_example' # String | The app where the events belongs to.
|
336
|
+
opts = {
|
337
|
+
channels: ['channels_example'], # Array<String> | The active channels.
|
338
|
+
query: 'query_example', # String | The optional query to search for items.
|
339
|
+
take: 56, # Integer | The number of items to return.
|
340
|
+
skip: 56 # Integer | The number of items to skip.
|
341
|
+
}
|
342
|
+
|
343
|
+
begin
|
344
|
+
#Query events.
|
345
|
+
result = api_instance.events_get_events(app_id, opts)
|
346
|
+
p result
|
347
|
+
rescue Notifo::ApiError => e
|
348
|
+
puts "Exception when calling EventsApi->events_get_events: #{e}"
|
349
|
+
end
|
350
|
+
|
351
|
+
api_instance = Notifo::EventsApi.new
|
352
|
+
body = Notifo::PublishManyDto.new # PublishManyDto | The publish request.
|
353
|
+
app_id = 'app_id_example' # String | The app where the events belongs to.
|
354
|
+
|
355
|
+
|
356
|
+
begin
|
357
|
+
#Publish events.
|
358
|
+
api_instance.events_post_events(body, app_id)
|
359
|
+
rescue Notifo::ApiError => e
|
360
|
+
puts "Exception when calling EventsApi->events_post_events: #{e}"
|
361
|
+
end
|
362
|
+
|
363
|
+
api_instance = Notifo::EventsApi.new
|
364
|
+
body = Notifo::PublishDto.new # PublishDto | The publish request.
|
365
|
+
|
366
|
+
|
367
|
+
begin
|
368
|
+
#Publish an event for the current user.
|
369
|
+
api_instance.events_post_my_events(body)
|
370
|
+
rescue Notifo::ApiError => e
|
371
|
+
puts "Exception when calling EventsApi->events_post_my_events: #{e}"
|
372
|
+
end
|
373
|
+
|
374
|
+
api_instance = Notifo::LogsApi.new
|
375
|
+
app_id = 'app_id_example' # String | The app where the log entries belongs to.
|
376
|
+
opts = {
|
377
|
+
query: 'query_example', # String | The optional query to search for items.
|
378
|
+
take: 56, # Integer | The number of items to return.
|
379
|
+
skip: 56 # Integer | The number of items to skip.
|
380
|
+
}
|
381
|
+
|
382
|
+
begin
|
383
|
+
#Query log entries.
|
384
|
+
result = api_instance.logs_get_logs(app_id, opts)
|
385
|
+
p result
|
386
|
+
rescue Notifo::ApiError => e
|
387
|
+
puts "Exception when calling LogsApi->logs_get_logs: #{e}"
|
388
|
+
end
|
389
|
+
|
390
|
+
api_instance = Notifo::MediaApi.new
|
391
|
+
app_id = 'app_id_example' # String | The app id where the media belongs to.
|
392
|
+
file_name = 'file_name_example' # String | The file name of the media.
|
393
|
+
|
394
|
+
|
395
|
+
begin
|
396
|
+
#Delete a media.
|
397
|
+
api_instance.media_delete(app_id, file_name)
|
398
|
+
rescue Notifo::ApiError => e
|
399
|
+
puts "Exception when calling MediaApi->media_delete: #{e}"
|
400
|
+
end
|
401
|
+
|
402
|
+
api_instance = Notifo::MediaApi.new
|
403
|
+
app_id = 'app_id_example' # String | The app id where the media belongs to.
|
404
|
+
file_name = 'file_name_example' # String | The name of the media to download.
|
405
|
+
opts = {
|
406
|
+
cache: 789, # Integer | The cache duration.
|
407
|
+
download: 56, # Integer | Set it to 1 to create a download response.
|
408
|
+
width: 56, # Integer | The target width when an image.
|
409
|
+
height: 56, # Integer | The target height when an image.
|
410
|
+
quality: 56, # Integer | The target quality when an image.
|
411
|
+
preset: 'preset_example', # String | A preset dimension.
|
412
|
+
mode: Notifo::ResizeMode.new, # ResizeMode | The resize mode.
|
413
|
+
focus_x: 3.4, # Float | The x position of the focues point.
|
414
|
+
focus_y: 3.4, # Float | The y position of the focues point.
|
415
|
+
force: true # BOOLEAN | True to resize it and clear the cache.
|
416
|
+
}
|
417
|
+
|
418
|
+
begin
|
419
|
+
#Download a media object.
|
420
|
+
result = api_instance.media_download(app_id, file_name, opts)
|
421
|
+
p result
|
422
|
+
rescue Notifo::ApiError => e
|
423
|
+
puts "Exception when calling MediaApi->media_download: #{e}"
|
424
|
+
end
|
425
|
+
|
426
|
+
api_instance = Notifo::MediaApi.new
|
427
|
+
app_id = 'app_id_example' # String | The app id where the media belongs to.
|
428
|
+
file_name = 'file_name_example' # String | The name of the media to download.
|
429
|
+
opts = {
|
430
|
+
cache: 789, # Integer | The cache duration.
|
431
|
+
download: 56, # Integer | Set it to 1 to create a download response.
|
432
|
+
width: 56, # Integer | The target width when an image.
|
433
|
+
height: 56, # Integer | The target height when an image.
|
434
|
+
quality: 56, # Integer | The target quality when an image.
|
435
|
+
preset: 'preset_example', # String | A preset dimension.
|
436
|
+
mode: Notifo::ResizeMode.new, # ResizeMode | The resize mode.
|
437
|
+
focus_x: 3.4, # Float | The x position of the focues point.
|
438
|
+
focus_y: 3.4, # Float | The y position of the focues point.
|
439
|
+
force: true # BOOLEAN | True to resize it and clear the cache.
|
440
|
+
}
|
441
|
+
|
442
|
+
begin
|
443
|
+
#Download a media object.
|
444
|
+
result = api_instance.media_download2(app_id, file_name, opts)
|
445
|
+
p result
|
446
|
+
rescue Notifo::ApiError => e
|
447
|
+
puts "Exception when calling MediaApi->media_download2: #{e}"
|
448
|
+
end
|
449
|
+
|
450
|
+
api_instance = Notifo::MediaApi.new
|
451
|
+
app_id = 'app_id_example' # String | The app where the media belongs to.
|
452
|
+
opts = {
|
453
|
+
query: 'query_example', # String | The optional query to search for items.
|
454
|
+
take: 56, # Integer | The number of items to return.
|
455
|
+
skip: 56 # Integer | The number of items to skip.
|
456
|
+
}
|
457
|
+
|
458
|
+
begin
|
459
|
+
#Query media items.
|
460
|
+
result = api_instance.media_get_medias(app_id, opts)
|
461
|
+
p result
|
462
|
+
rescue Notifo::ApiError => e
|
463
|
+
puts "Exception when calling MediaApi->media_get_medias: #{e}"
|
464
|
+
end
|
465
|
+
|
466
|
+
api_instance = Notifo::MediaApi.new
|
467
|
+
app_id = 'app_id_example' # String | The app id where the media belongs to.
|
468
|
+
opts = {
|
469
|
+
file: 'file_example' # String |
|
470
|
+
}
|
471
|
+
|
472
|
+
begin
|
473
|
+
#Upload a media object.
|
474
|
+
api_instance.media_upload(app_id, opts)
|
475
|
+
rescue Notifo::ApiError => e
|
476
|
+
puts "Exception when calling MediaApi->media_upload: #{e}"
|
477
|
+
end
|
478
|
+
|
479
|
+
api_instance = Notifo::MessagingTemplatesApi.new
|
480
|
+
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
|
481
|
+
id = 'id_example' # String | The template ID.
|
482
|
+
|
483
|
+
|
484
|
+
begin
|
485
|
+
#Delete a channel template.
|
486
|
+
api_instance.messaging_templates_delete_template(app_id, id)
|
487
|
+
rescue Notifo::ApiError => e
|
488
|
+
puts "Exception when calling MessagingTemplatesApi->messaging_templates_delete_template: #{e}"
|
489
|
+
end
|
490
|
+
|
491
|
+
api_instance = Notifo::MessagingTemplatesApi.new
|
492
|
+
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
|
493
|
+
id = 'id_example' # String | The template ID.
|
494
|
+
language = 'language_example' # String | The language.
|
495
|
+
|
496
|
+
|
497
|
+
begin
|
498
|
+
#Delete a language channel template.
|
499
|
+
api_instance.messaging_templates_delete_template_language(app_id, id, language)
|
500
|
+
rescue Notifo::ApiError => e
|
501
|
+
puts "Exception when calling MessagingTemplatesApi->messaging_templates_delete_template_language: #{e}"
|
502
|
+
end
|
503
|
+
|
504
|
+
api_instance = Notifo::MessagingTemplatesApi.new
|
505
|
+
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
|
506
|
+
id = 'id_example' # String | The template ID.
|
507
|
+
|
508
|
+
|
509
|
+
begin
|
510
|
+
#Get the channel template by id.
|
511
|
+
result = api_instance.messaging_templates_get_template(app_id, id)
|
512
|
+
p result
|
513
|
+
rescue Notifo::ApiError => e
|
514
|
+
puts "Exception when calling MessagingTemplatesApi->messaging_templates_get_template: #{e}"
|
515
|
+
end
|
516
|
+
|
517
|
+
api_instance = Notifo::MessagingTemplatesApi.new
|
518
|
+
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
|
519
|
+
opts = {
|
520
|
+
query: 'query_example', # String | The optional query to search for items.
|
521
|
+
take: 56, # Integer | The number of items to return.
|
522
|
+
skip: 56 # Integer | The number of items to skip.
|
523
|
+
}
|
524
|
+
|
525
|
+
begin
|
526
|
+
#Get the channel templates.
|
527
|
+
result = api_instance.messaging_templates_get_templates(app_id, opts)
|
528
|
+
p result
|
529
|
+
rescue Notifo::ApiError => e
|
530
|
+
puts "Exception when calling MessagingTemplatesApi->messaging_templates_get_templates: #{e}"
|
531
|
+
end
|
532
|
+
|
533
|
+
api_instance = Notifo::MessagingTemplatesApi.new
|
534
|
+
body = Notifo::CreateChannelTemplateDto.new # CreateChannelTemplateDto | The request object.
|
535
|
+
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
|
536
|
+
|
537
|
+
|
538
|
+
begin
|
539
|
+
#Create a channel template.
|
540
|
+
result = api_instance.messaging_templates_post_template(body, app_id)
|
541
|
+
p result
|
542
|
+
rescue Notifo::ApiError => e
|
543
|
+
puts "Exception when calling MessagingTemplatesApi->messaging_templates_post_template: #{e}"
|
544
|
+
end
|
545
|
+
|
546
|
+
api_instance = Notifo::MessagingTemplatesApi.new
|
547
|
+
body = Notifo::CreateChannelTemplateLanguageDto.new # CreateChannelTemplateLanguageDto | The request object.
|
548
|
+
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
|
549
|
+
id = 'id_example' # String | The template ID.
|
550
|
+
|
551
|
+
|
552
|
+
begin
|
553
|
+
#Create an app template language.
|
554
|
+
result = api_instance.messaging_templates_post_template_language(body, app_id, id)
|
555
|
+
p result
|
556
|
+
rescue Notifo::ApiError => e
|
557
|
+
puts "Exception when calling MessagingTemplatesApi->messaging_templates_post_template_language: #{e}"
|
558
|
+
end
|
559
|
+
|
560
|
+
api_instance = Notifo::MessagingTemplatesApi.new
|
561
|
+
body = Notifo::UpdateChannelTemplateDtoOfMessagingTemplateDto.new # UpdateChannelTemplateDtoOfMessagingTemplateDto | The request object.
|
562
|
+
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
|
563
|
+
id = 'id_example' # String | The template ID.
|
564
|
+
|
565
|
+
|
566
|
+
begin
|
567
|
+
#Update an app template.
|
568
|
+
api_instance.messaging_templates_put_template(body, app_id, id)
|
569
|
+
rescue Notifo::ApiError => e
|
570
|
+
puts "Exception when calling MessagingTemplatesApi->messaging_templates_put_template: #{e}"
|
571
|
+
end
|
572
|
+
|
573
|
+
api_instance = Notifo::MessagingTemplatesApi.new
|
574
|
+
body = Notifo::MessagingTemplateDto.new # MessagingTemplateDto | The request object.
|
575
|
+
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
|
576
|
+
id = 'id_example' # String | The template ID.
|
577
|
+
language = 'language_example' # String | The language.
|
578
|
+
|
579
|
+
|
580
|
+
begin
|
581
|
+
#Update a channel template language.
|
582
|
+
api_instance.messaging_templates_put_template_language(body, app_id, id, language)
|
583
|
+
rescue Notifo::ApiError => e
|
584
|
+
puts "Exception when calling MessagingTemplatesApi->messaging_templates_put_template_language: #{e}"
|
585
|
+
end
|
586
|
+
|
587
|
+
api_instance = Notifo::MobilePushApi.new
|
588
|
+
token = 'token_example' # String | The token to remove.
|
589
|
+
|
590
|
+
|
591
|
+
begin
|
592
|
+
#Deletes a mobile push token for the current user.
|
593
|
+
api_instance.mobile_push_delete_my_token(token)
|
594
|
+
rescue Notifo::ApiError => e
|
595
|
+
puts "Exception when calling MobilePushApi->mobile_push_delete_my_token: #{e}"
|
596
|
+
end
|
597
|
+
|
598
|
+
api_instance = Notifo::MobilePushApi.new
|
599
|
+
|
600
|
+
begin
|
601
|
+
#Returns the mobile push tokens.
|
602
|
+
result = api_instance.mobile_push_get_my_token
|
603
|
+
p result
|
604
|
+
rescue Notifo::ApiError => e
|
605
|
+
puts "Exception when calling MobilePushApi->mobile_push_get_my_token: #{e}"
|
606
|
+
end
|
607
|
+
|
608
|
+
api_instance = Notifo::MobilePushApi.new
|
609
|
+
body = Notifo::RegisterMobileTokenDto.new # RegisterMobileTokenDto | The request object.
|
610
|
+
|
611
|
+
|
612
|
+
begin
|
613
|
+
#Register a mobile push token for the current user.
|
614
|
+
api_instance.mobile_push_post_my_token(body)
|
615
|
+
rescue Notifo::ApiError => e
|
616
|
+
puts "Exception when calling MobilePushApi->mobile_push_post_my_token: #{e}"
|
617
|
+
end
|
618
|
+
|
619
|
+
api_instance = Notifo::NotificationsApi.new
|
620
|
+
body = Notifo::TrackNotificationDto.new # TrackNotificationDto | The request object.
|
621
|
+
|
622
|
+
|
623
|
+
begin
|
624
|
+
#Confirms the user notifications for the current user.
|
625
|
+
api_instance.notifications_confirm_me(body)
|
626
|
+
rescue Notifo::ApiError => e
|
627
|
+
puts "Exception when calling NotificationsApi->notifications_confirm_me: #{e}"
|
628
|
+
end
|
629
|
+
|
630
|
+
api_instance = Notifo::NotificationsApi.new
|
631
|
+
|
632
|
+
begin
|
633
|
+
#Query archhived user notifications of the current user.
|
634
|
+
result = api_instance.notifications_get_my_archive
|
635
|
+
p result
|
636
|
+
rescue Notifo::ApiError => e
|
637
|
+
puts "Exception when calling NotificationsApi->notifications_get_my_archive: #{e}"
|
638
|
+
end
|
639
|
+
|
640
|
+
api_instance = Notifo::NotificationsApi.new
|
641
|
+
opts = {
|
642
|
+
channels: ['channels_example'], # Array<String> | The active channels.
|
643
|
+
query: 'query_example', # String | The optional query to search for items.
|
644
|
+
take: 56, # Integer | The number of items to return.
|
645
|
+
skip: 56 # Integer | The number of items to skip.
|
646
|
+
}
|
28
647
|
|
29
|
-
|
648
|
+
begin
|
649
|
+
#Query user notifications of the current user.
|
650
|
+
result = api_instance.notifications_get_my_notifications(opts)
|
651
|
+
p result
|
652
|
+
rescue Notifo::ApiError => e
|
653
|
+
puts "Exception when calling NotificationsApi->notifications_get_my_notifications: #{e}"
|
654
|
+
end
|
30
655
|
|
31
|
-
|
656
|
+
api_instance = Notifo::NotificationsApi.new
|
657
|
+
app_id = 'app_id_example' # String | The app where the user belongs to.
|
658
|
+
id = 'id_example' # String | The user id.
|
659
|
+
opts = {
|
660
|
+
channels: ['channels_example'], # Array<String> | The active channels.
|
661
|
+
query: 'query_example', # String | The optional query to search for items.
|
662
|
+
take: 56, # Integer | The number of items to return.
|
663
|
+
skip: 56 # Integer | The number of items to skip.
|
664
|
+
}
|
32
665
|
|
33
|
-
|
666
|
+
begin
|
667
|
+
#Query user notifications.
|
668
|
+
result = api_instance.notifications_get_notifications(app_id, id, opts)
|
669
|
+
p result
|
670
|
+
rescue Notifo::ApiError => e
|
671
|
+
puts "Exception when calling NotificationsApi->notifications_get_notifications: #{e}"
|
672
|
+
end
|
34
673
|
|
35
|
-
|
674
|
+
api_instance = Notifo::PingApi.new
|
36
675
|
|
37
|
-
|
676
|
+
begin
|
677
|
+
#Get ping status of the API.
|
678
|
+
api_instance.ping_get_ping
|
679
|
+
rescue Notifo::ApiError => e
|
680
|
+
puts "Exception when calling PingApi->ping_get_ping: #{e}"
|
681
|
+
end
|
38
682
|
|
39
|
-
|
683
|
+
api_instance = Notifo::SmsTemplatesApi.new
|
684
|
+
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
|
685
|
+
id = 'id_example' # String | The template ID.
|
40
686
|
|
41
|
-
gem 'notifo', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
|
42
687
|
|
43
|
-
|
688
|
+
begin
|
689
|
+
#Delete a channel template.
|
690
|
+
api_instance.sms_templates_delete_template(app_id, id)
|
691
|
+
rescue Notifo::ApiError => e
|
692
|
+
puts "Exception when calling SmsTemplatesApi->sms_templates_delete_template: #{e}"
|
693
|
+
end
|
44
694
|
|
45
|
-
|
695
|
+
api_instance = Notifo::SmsTemplatesApi.new
|
696
|
+
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
|
697
|
+
id = 'id_example' # String | The template ID.
|
698
|
+
language = 'language_example' # String | The language.
|
46
699
|
|
47
|
-
```shell
|
48
|
-
ruby -Ilib script.rb
|
49
|
-
```
|
50
700
|
|
51
|
-
|
701
|
+
begin
|
702
|
+
#Delete a language channel template.
|
703
|
+
api_instance.sms_templates_delete_template_language(app_id, id, language)
|
704
|
+
rescue Notifo::ApiError => e
|
705
|
+
puts "Exception when calling SmsTemplatesApi->sms_templates_delete_template_language: #{e}"
|
706
|
+
end
|
52
707
|
|
53
|
-
|
708
|
+
api_instance = Notifo::SmsTemplatesApi.new
|
709
|
+
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
|
710
|
+
id = 'id_example' # String | The template ID.
|
54
711
|
|
55
|
-
```ruby
|
56
|
-
# Load the gem
|
57
|
-
require 'notifo'
|
58
712
|
|
59
|
-
|
60
|
-
|
61
|
-
|
713
|
+
begin
|
714
|
+
#Get the channel template by id.
|
715
|
+
result = api_instance.sms_templates_get_template(app_id, id)
|
716
|
+
p result
|
717
|
+
rescue Notifo::ApiError => e
|
718
|
+
puts "Exception when calling SmsTemplatesApi->sms_templates_get_template: #{e}"
|
719
|
+
end
|
720
|
+
|
721
|
+
api_instance = Notifo::SmsTemplatesApi.new
|
722
|
+
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
|
723
|
+
opts = {
|
724
|
+
query: 'query_example', # String | The optional query to search for items.
|
725
|
+
take: 56, # Integer | The number of items to return.
|
726
|
+
skip: 56 # Integer | The number of items to skip.
|
727
|
+
}
|
62
728
|
|
63
729
|
begin
|
64
|
-
#
|
65
|
-
result = api_instance.
|
730
|
+
#Get the channel templates.
|
731
|
+
result = api_instance.sms_templates_get_templates(app_id, opts)
|
66
732
|
p result
|
67
733
|
rescue Notifo::ApiError => e
|
68
|
-
puts "Exception when calling
|
734
|
+
puts "Exception when calling SmsTemplatesApi->sms_templates_get_templates: #{e}"
|
735
|
+
end
|
736
|
+
|
737
|
+
api_instance = Notifo::SmsTemplatesApi.new
|
738
|
+
body = Notifo::CreateChannelTemplateDto.new # CreateChannelTemplateDto | The request object.
|
739
|
+
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
|
740
|
+
|
741
|
+
|
742
|
+
begin
|
743
|
+
#Create a channel template.
|
744
|
+
result = api_instance.sms_templates_post_template(body, app_id)
|
745
|
+
p result
|
746
|
+
rescue Notifo::ApiError => e
|
747
|
+
puts "Exception when calling SmsTemplatesApi->sms_templates_post_template: #{e}"
|
748
|
+
end
|
749
|
+
|
750
|
+
api_instance = Notifo::SmsTemplatesApi.new
|
751
|
+
body = Notifo::CreateChannelTemplateLanguageDto.new # CreateChannelTemplateLanguageDto | The request object.
|
752
|
+
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
|
753
|
+
id = 'id_example' # String | The template ID.
|
754
|
+
|
755
|
+
|
756
|
+
begin
|
757
|
+
#Create an app template language.
|
758
|
+
result = api_instance.sms_templates_post_template_language(body, app_id, id)
|
759
|
+
p result
|
760
|
+
rescue Notifo::ApiError => e
|
761
|
+
puts "Exception when calling SmsTemplatesApi->sms_templates_post_template_language: #{e}"
|
762
|
+
end
|
763
|
+
|
764
|
+
api_instance = Notifo::SmsTemplatesApi.new
|
765
|
+
body = Notifo::UpdateChannelTemplateDtoOfSmsTemplateDto.new # UpdateChannelTemplateDtoOfSmsTemplateDto | The request object.
|
766
|
+
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
|
767
|
+
id = 'id_example' # String | The template ID.
|
768
|
+
|
769
|
+
|
770
|
+
begin
|
771
|
+
#Update an app template.
|
772
|
+
api_instance.sms_templates_put_template(body, app_id, id)
|
773
|
+
rescue Notifo::ApiError => e
|
774
|
+
puts "Exception when calling SmsTemplatesApi->sms_templates_put_template: #{e}"
|
775
|
+
end
|
776
|
+
|
777
|
+
api_instance = Notifo::SmsTemplatesApi.new
|
778
|
+
body = Notifo::SmsTemplateDto.new # SmsTemplateDto | The request object.
|
779
|
+
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
|
780
|
+
id = 'id_example' # String | The template ID.
|
781
|
+
language = 'language_example' # String | The language.
|
782
|
+
|
783
|
+
|
784
|
+
begin
|
785
|
+
#Update a channel template language.
|
786
|
+
api_instance.sms_templates_put_template_language(body, app_id, id, language)
|
787
|
+
rescue Notifo::ApiError => e
|
788
|
+
puts "Exception when calling SmsTemplatesApi->sms_templates_put_template_language: #{e}"
|
789
|
+
end
|
790
|
+
|
791
|
+
api_instance = Notifo::SystemUsersApi.new
|
792
|
+
id = 'id_example' # String | The user ID.
|
793
|
+
|
794
|
+
|
795
|
+
begin
|
796
|
+
#Delete the user.
|
797
|
+
api_instance.system_users_delete_user(id)
|
798
|
+
rescue Notifo::ApiError => e
|
799
|
+
puts "Exception when calling SystemUsersApi->system_users_delete_user: #{e}"
|
800
|
+
end
|
801
|
+
|
802
|
+
api_instance = Notifo::SystemUsersApi.new
|
803
|
+
id = 'id_example' # String | The user ID.
|
804
|
+
|
805
|
+
|
806
|
+
begin
|
807
|
+
#Get a user.
|
808
|
+
api_instance.system_users_get_user(id)
|
809
|
+
rescue Notifo::ApiError => e
|
810
|
+
puts "Exception when calling SystemUsersApi->system_users_get_user: #{e}"
|
811
|
+
end
|
812
|
+
|
813
|
+
api_instance = Notifo::SystemUsersApi.new
|
814
|
+
opts = {
|
815
|
+
query: 'query_example', # String | The optional query to search for items.
|
816
|
+
take: 56, # Integer | The number of items to return.
|
817
|
+
skip: 56 # Integer | The number of items to skip.
|
818
|
+
}
|
819
|
+
|
820
|
+
begin
|
821
|
+
#Query users.
|
822
|
+
result = api_instance.system_users_get_users(opts)
|
823
|
+
p result
|
824
|
+
rescue Notifo::ApiError => e
|
825
|
+
puts "Exception when calling SystemUsersApi->system_users_get_users: #{e}"
|
826
|
+
end
|
827
|
+
|
828
|
+
api_instance = Notifo::SystemUsersApi.new
|
829
|
+
id = 'id_example' # String | The user ID.
|
830
|
+
|
831
|
+
|
832
|
+
begin
|
833
|
+
#Lock the user.
|
834
|
+
result = api_instance.system_users_lock_user(id)
|
835
|
+
p result
|
836
|
+
rescue Notifo::ApiError => e
|
837
|
+
puts "Exception when calling SystemUsersApi->system_users_lock_user: #{e}"
|
838
|
+
end
|
839
|
+
|
840
|
+
api_instance = Notifo::SystemUsersApi.new
|
841
|
+
body = Notifo::CreateSystemUserDto.new # CreateSystemUserDto | The create request.
|
842
|
+
|
843
|
+
|
844
|
+
begin
|
845
|
+
#Create a user.
|
846
|
+
result = api_instance.system_users_post_user(body)
|
847
|
+
p result
|
848
|
+
rescue Notifo::ApiError => e
|
849
|
+
puts "Exception when calling SystemUsersApi->system_users_post_user: #{e}"
|
850
|
+
end
|
851
|
+
|
852
|
+
api_instance = Notifo::SystemUsersApi.new
|
853
|
+
body = Notifo::UpdateSystemUserDto.new # UpdateSystemUserDto | The update request.
|
854
|
+
id = 'id_example' # String | The user ID.
|
855
|
+
|
856
|
+
|
857
|
+
begin
|
858
|
+
#Update the user.
|
859
|
+
result = api_instance.system_users_put_user(body, id)
|
860
|
+
p result
|
861
|
+
rescue Notifo::ApiError => e
|
862
|
+
puts "Exception when calling SystemUsersApi->system_users_put_user: #{e}"
|
863
|
+
end
|
864
|
+
|
865
|
+
api_instance = Notifo::SystemUsersApi.new
|
866
|
+
id = 'id_example' # String | The user ID.
|
867
|
+
|
868
|
+
|
869
|
+
begin
|
870
|
+
#Unlock the user.
|
871
|
+
result = api_instance.system_users_unlock_user(id)
|
872
|
+
p result
|
873
|
+
rescue Notifo::ApiError => e
|
874
|
+
puts "Exception when calling SystemUsersApi->system_users_unlock_user: #{e}"
|
875
|
+
end
|
876
|
+
|
877
|
+
api_instance = Notifo::TemplatesApi.new
|
878
|
+
app_id = 'app_id_example' # String | The app where the templates belong to.
|
879
|
+
code = 'code_example' # String | The template code to delete.
|
880
|
+
|
881
|
+
|
882
|
+
begin
|
883
|
+
#Delete a template.
|
884
|
+
api_instance.templates_delete_template(app_id, code)
|
885
|
+
rescue Notifo::ApiError => e
|
886
|
+
puts "Exception when calling TemplatesApi->templates_delete_template: #{e}"
|
887
|
+
end
|
888
|
+
|
889
|
+
api_instance = Notifo::TemplatesApi.new
|
890
|
+
app_id = 'app_id_example' # String | The app where the templates belongs to.
|
891
|
+
opts = {
|
892
|
+
query: 'query_example', # String | The optional query to search for items.
|
893
|
+
take: 56, # Integer | The number of items to return.
|
894
|
+
skip: 56 # Integer | The number of items to skip.
|
895
|
+
}
|
896
|
+
|
897
|
+
begin
|
898
|
+
#Query templates.
|
899
|
+
result = api_instance.templates_get_templates(app_id, opts)
|
900
|
+
p result
|
901
|
+
rescue Notifo::ApiError => e
|
902
|
+
puts "Exception when calling TemplatesApi->templates_get_templates: #{e}"
|
903
|
+
end
|
904
|
+
|
905
|
+
api_instance = Notifo::TemplatesApi.new
|
906
|
+
body = Notifo::UpsertTemplatesDto.new # UpsertTemplatesDto | The upsert request.
|
907
|
+
app_id = 'app_id_example' # String | The app where the templates belong to.
|
908
|
+
|
909
|
+
|
910
|
+
begin
|
911
|
+
#Upsert templates.
|
912
|
+
result = api_instance.templates_post_templates(body, app_id)
|
913
|
+
p result
|
914
|
+
rescue Notifo::ApiError => e
|
915
|
+
puts "Exception when calling TemplatesApi->templates_post_templates: #{e}"
|
916
|
+
end
|
917
|
+
|
918
|
+
api_instance = Notifo::TopicsApi.new
|
919
|
+
app_id = 'app_id_example' # String | The app where the topics belong to.
|
920
|
+
id = 'id_example' # String | The ID of the topic to delete.
|
921
|
+
|
922
|
+
|
923
|
+
begin
|
924
|
+
#Delete a topic.
|
925
|
+
api_instance.topics_delete_topic(app_id, id)
|
926
|
+
rescue Notifo::ApiError => e
|
927
|
+
puts "Exception when calling TopicsApi->topics_delete_topic: #{e}"
|
928
|
+
end
|
929
|
+
|
930
|
+
api_instance = Notifo::TopicsApi.new
|
931
|
+
app_id = 'app_id_example' # String | The app where the topics belongs to.
|
932
|
+
opts = {
|
933
|
+
scope: Notifo::TopicQueryScope.new, # TopicQueryScope | The scope of the query.
|
934
|
+
query: 'query_example', # String | The optional query to search for items.
|
935
|
+
take: 56, # Integer | The number of items to return.
|
936
|
+
skip: 56 # Integer | The number of items to skip.
|
937
|
+
}
|
938
|
+
|
939
|
+
begin
|
940
|
+
#Query topics.
|
941
|
+
result = api_instance.topics_get_topics(app_id, opts)
|
942
|
+
p result
|
943
|
+
rescue Notifo::ApiError => e
|
944
|
+
puts "Exception when calling TopicsApi->topics_get_topics: #{e}"
|
945
|
+
end
|
946
|
+
|
947
|
+
api_instance = Notifo::TopicsApi.new
|
948
|
+
body = Notifo::UpsertTopicsDto.new # UpsertTopicsDto | The upsert request.
|
949
|
+
app_id = 'app_id_example' # String | The app where the topics belong to.
|
950
|
+
|
951
|
+
|
952
|
+
begin
|
953
|
+
#Upsert topics.
|
954
|
+
result = api_instance.topics_post_topics(body, app_id)
|
955
|
+
p result
|
956
|
+
rescue Notifo::ApiError => e
|
957
|
+
puts "Exception when calling TopicsApi->topics_post_topics: #{e}"
|
958
|
+
end
|
959
|
+
|
960
|
+
api_instance = Notifo::UserApi.new
|
961
|
+
prefix = 'prefix_example' # String | The topic prefix.
|
962
|
+
|
963
|
+
|
964
|
+
begin
|
965
|
+
#Remove my subscription.
|
966
|
+
api_instance.user_delete_subscription(prefix)
|
967
|
+
rescue Notifo::ApiError => e
|
968
|
+
puts "Exception when calling UserApi->user_delete_subscription: #{e}"
|
969
|
+
end
|
970
|
+
|
971
|
+
api_instance = Notifo::UserApi.new
|
972
|
+
topic = 'topic_example' # String | The topic path.
|
973
|
+
|
974
|
+
|
975
|
+
begin
|
976
|
+
#Gets a user subscription.
|
977
|
+
result = api_instance.user_get_my_subscription(topic)
|
978
|
+
p result
|
979
|
+
rescue Notifo::ApiError => e
|
980
|
+
puts "Exception when calling UserApi->user_get_my_subscription: #{e}"
|
981
|
+
end
|
982
|
+
|
983
|
+
api_instance = Notifo::UserApi.new
|
984
|
+
opts = {
|
985
|
+
topics: 'topics_example', # String | The topics we are interested in.
|
986
|
+
query: 'query_example', # String | The optional query to search for items.
|
987
|
+
take: 56, # Integer | The number of items to return.
|
988
|
+
skip: 56 # Integer | The number of items to skip.
|
989
|
+
}
|
990
|
+
|
991
|
+
begin
|
992
|
+
#Query the user subscriptions.
|
993
|
+
result = api_instance.user_get_my_subscriptions(opts)
|
994
|
+
p result
|
995
|
+
rescue Notifo::ApiError => e
|
996
|
+
puts "Exception when calling UserApi->user_get_my_subscriptions: #{e}"
|
997
|
+
end
|
998
|
+
|
999
|
+
api_instance = Notifo::UserApi.new
|
1000
|
+
opts = {
|
1001
|
+
language: 'language_example' # String | The optional language.
|
1002
|
+
}
|
1003
|
+
|
1004
|
+
begin
|
1005
|
+
#Query the user topics.
|
1006
|
+
result = api_instance.user_get_topics(opts)
|
1007
|
+
p result
|
1008
|
+
rescue Notifo::ApiError => e
|
1009
|
+
puts "Exception when calling UserApi->user_get_topics: #{e}"
|
1010
|
+
end
|
1011
|
+
|
1012
|
+
api_instance = Notifo::UserApi.new
|
1013
|
+
|
1014
|
+
begin
|
1015
|
+
#Get the current user.
|
1016
|
+
result = api_instance.user_get_user
|
1017
|
+
p result
|
1018
|
+
rescue Notifo::ApiError => e
|
1019
|
+
puts "Exception when calling UserApi->user_get_user: #{e}"
|
1020
|
+
end
|
1021
|
+
|
1022
|
+
api_instance = Notifo::UserApi.new
|
1023
|
+
body = Notifo::SubscribeManyDto.new # SubscribeManyDto | The subscription settings.
|
1024
|
+
|
1025
|
+
|
1026
|
+
begin
|
1027
|
+
#Upserts or deletes my subscriptions.
|
1028
|
+
api_instance.user_post_my_subscriptions(body)
|
1029
|
+
rescue Notifo::ApiError => e
|
1030
|
+
puts "Exception when calling UserApi->user_post_my_subscriptions: #{e}"
|
69
1031
|
end
|
70
1032
|
|
1033
|
+
api_instance = Notifo::UserApi.new
|
1034
|
+
body = Notifo::UpdateProfileDto.new # UpdateProfileDto | The upsert request.
|
1035
|
+
|
1036
|
+
|
1037
|
+
begin
|
1038
|
+
#Update the user.
|
1039
|
+
result = api_instance.user_post_user(body)
|
1040
|
+
p result
|
1041
|
+
rescue Notifo::ApiError => e
|
1042
|
+
puts "Exception when calling UserApi->user_post_user: #{e}"
|
1043
|
+
end
|
1044
|
+
|
1045
|
+
api_instance = Notifo::UsersApi.new
|
1046
|
+
app_id = 'app_id_example' # String | The app where the users belong to.
|
1047
|
+
id = 'id_example' # String | The user ID.
|
1048
|
+
prefix = 'prefix_example' # String | The topic prefix.
|
1049
|
+
|
1050
|
+
|
1051
|
+
begin
|
1052
|
+
#Remove an allowed topic.
|
1053
|
+
api_instance.users_delete_allowed_topic(app_id, id, prefix)
|
1054
|
+
rescue Notifo::ApiError => e
|
1055
|
+
puts "Exception when calling UsersApi->users_delete_allowed_topic: #{e}"
|
1056
|
+
end
|
1057
|
+
|
1058
|
+
api_instance = Notifo::UsersApi.new
|
1059
|
+
app_id = 'app_id_example' # String | The app where the user belongs to.
|
1060
|
+
id = 'id_example' # String | The user ID.
|
1061
|
+
prefix = 'prefix_example' # String | The topic prefix.
|
1062
|
+
|
1063
|
+
|
1064
|
+
begin
|
1065
|
+
#Unsubscribes a user from a subscription.
|
1066
|
+
api_instance.users_delete_subscription(app_id, id, prefix)
|
1067
|
+
rescue Notifo::ApiError => e
|
1068
|
+
puts "Exception when calling UsersApi->users_delete_subscription: #{e}"
|
1069
|
+
end
|
1070
|
+
|
1071
|
+
api_instance = Notifo::UsersApi.new
|
1072
|
+
app_id = 'app_id_example' # String | The app where the users belongs to.
|
1073
|
+
id = 'id_example' # String | The user id to delete.
|
1074
|
+
|
1075
|
+
|
1076
|
+
begin
|
1077
|
+
#Delete a user.
|
1078
|
+
result = api_instance.users_delete_user(app_id, id)
|
1079
|
+
p result
|
1080
|
+
rescue Notifo::ApiError => e
|
1081
|
+
puts "Exception when calling UsersApi->users_delete_user: #{e}"
|
1082
|
+
end
|
1083
|
+
|
1084
|
+
api_instance = Notifo::UsersApi.new
|
1085
|
+
app_id = 'app_id_example' # String | The app where the user belongs to.
|
1086
|
+
id = 'id_example' # String | The user ID.
|
1087
|
+
opts = {
|
1088
|
+
query: 'query_example', # String | The optional query to search for items.
|
1089
|
+
take: 56, # Integer | The number of items to return.
|
1090
|
+
skip: 56 # Integer | The number of items to skip.
|
1091
|
+
}
|
1092
|
+
|
1093
|
+
begin
|
1094
|
+
#Query user subscriptions.
|
1095
|
+
result = api_instance.users_get_subscriptions(app_id, id, opts)
|
1096
|
+
p result
|
1097
|
+
rescue Notifo::ApiError => e
|
1098
|
+
puts "Exception when calling UsersApi->users_get_subscriptions: #{e}"
|
1099
|
+
end
|
1100
|
+
|
1101
|
+
api_instance = Notifo::UsersApi.new
|
1102
|
+
app_id = 'app_id_example' # String | The app where the user belongs to.
|
1103
|
+
id = 'id_example' # String | The user ID.
|
1104
|
+
opts = {
|
1105
|
+
with_details: false # BOOLEAN | Provide extra details, might be expensive.
|
1106
|
+
}
|
1107
|
+
|
1108
|
+
begin
|
1109
|
+
#Get a user.
|
1110
|
+
result = api_instance.users_get_user(app_id, id, opts)
|
1111
|
+
p result
|
1112
|
+
rescue Notifo::ApiError => e
|
1113
|
+
puts "Exception when calling UsersApi->users_get_user: #{e}"
|
1114
|
+
end
|
1115
|
+
|
1116
|
+
api_instance = Notifo::UsersApi.new
|
1117
|
+
app_id = 'app_id_example' # String | The app where the users belongs to.
|
1118
|
+
opts = {
|
1119
|
+
query: 'query_example', # String | The optional query to search for items.
|
1120
|
+
take: 56, # Integer | The number of items to return.
|
1121
|
+
skip: 56, # Integer | The number of items to skip.
|
1122
|
+
with_details: false # BOOLEAN | Provide extra details, might be expensive.
|
1123
|
+
}
|
1124
|
+
|
1125
|
+
begin
|
1126
|
+
#Query users.
|
1127
|
+
result = api_instance.users_get_users(app_id, opts)
|
1128
|
+
p result
|
1129
|
+
rescue Notifo::ApiError => e
|
1130
|
+
puts "Exception when calling UsersApi->users_get_users: #{e}"
|
1131
|
+
end
|
1132
|
+
|
1133
|
+
api_instance = Notifo::UsersApi.new
|
1134
|
+
body = Notifo::AddAllowedTopicDto.new # AddAllowedTopicDto | The upsert request.
|
1135
|
+
app_id = 'app_id_example' # String | The app where the users belong to.
|
1136
|
+
id = 'id_example' # String | The user ID.
|
1137
|
+
|
1138
|
+
|
1139
|
+
begin
|
1140
|
+
#Add an allowed topic.
|
1141
|
+
api_instance.users_post_allowed_topic(body, app_id, id)
|
1142
|
+
rescue Notifo::ApiError => e
|
1143
|
+
puts "Exception when calling UsersApi->users_post_allowed_topic: #{e}"
|
1144
|
+
end
|
1145
|
+
|
1146
|
+
api_instance = Notifo::UsersApi.new
|
1147
|
+
body = Notifo::SubscribeManyDto.new # SubscribeManyDto | The subscription object.
|
1148
|
+
app_id = 'app_id_example' # String | The app where the user belongs to.
|
1149
|
+
id = 'id_example' # String | The user ID.
|
1150
|
+
|
1151
|
+
|
1152
|
+
begin
|
1153
|
+
#Upserts or deletes multiple user subscriptions.
|
1154
|
+
api_instance.users_post_subscriptions(body, app_id, id)
|
1155
|
+
rescue Notifo::ApiError => e
|
1156
|
+
puts "Exception when calling UsersApi->users_post_subscriptions: #{e}"
|
1157
|
+
end
|
1158
|
+
|
1159
|
+
api_instance = Notifo::UsersApi.new
|
1160
|
+
body = Notifo::UpsertUsersDto.new # UpsertUsersDto | The upsert request.
|
1161
|
+
app_id = 'app_id_example' # String | The app where the users belong to.
|
1162
|
+
|
1163
|
+
|
1164
|
+
begin
|
1165
|
+
#Upsert users.
|
1166
|
+
result = api_instance.users_post_users(body, app_id)
|
1167
|
+
p result
|
1168
|
+
rescue Notifo::ApiError => e
|
1169
|
+
puts "Exception when calling UsersApi->users_post_users: #{e}"
|
1170
|
+
end
|
71
1171
|
```
|
72
1172
|
|
73
1173
|
## Documentation for API Endpoints
|
74
1174
|
|
75
|
-
All URIs are relative to *
|
1175
|
+
All URIs are relative to *https://notifo.easierlife.com*
|
76
1176
|
|
77
1177
|
Class | Method | HTTP request | Description
|
78
1178
|
------------ | ------------- | ------------- | -------------
|
79
1179
|
*Notifo::AppsApi* | [**apps_delete_contributor**](docs/AppsApi.md#apps_delete_contributor) | **POST** /api/apps/{appId}/contributors/{contributorId} | Delete an app contributor.
|
80
|
-
*Notifo::AppsApi* | [**
|
1180
|
+
*Notifo::AppsApi* | [**apps_delete_integration**](docs/AppsApi.md#apps_delete_integration) | **DELETE** /api/apps/{appId}/integrations/{id} | Delete an app integration.
|
81
1181
|
*Notifo::AppsApi* | [**apps_get_app**](docs/AppsApi.md#apps_get_app) | **GET** /api/apps/{appId} | Get app by id.
|
82
1182
|
*Notifo::AppsApi* | [**apps_get_apps**](docs/AppsApi.md#apps_get_apps) | **GET** /api/apps | Get the user apps.
|
83
|
-
*Notifo::AppsApi* | [**
|
1183
|
+
*Notifo::AppsApi* | [**apps_get_integrations**](docs/AppsApi.md#apps_get_integrations) | **GET** /api/apps/{appId}/integrations | Get the app integrations.
|
84
1184
|
*Notifo::AppsApi* | [**apps_post_app**](docs/AppsApi.md#apps_post_app) | **POST** /api/apps | Create an app.
|
85
1185
|
*Notifo::AppsApi* | [**apps_post_contributor**](docs/AppsApi.md#apps_post_contributor) | **POST** /api/apps/{appId}/contributors | Add an app contributor.
|
86
|
-
*Notifo::AppsApi* | [**
|
1186
|
+
*Notifo::AppsApi* | [**apps_post_integration**](docs/AppsApi.md#apps_post_integration) | **POST** /api/apps/{appId}/integration | Create an app integrations.
|
87
1187
|
*Notifo::AppsApi* | [**apps_put_app**](docs/AppsApi.md#apps_put_app) | **POST** /api/apps/{appId} | Update an app.
|
88
|
-
*Notifo::AppsApi* | [**
|
1188
|
+
*Notifo::AppsApi* | [**apps_put_integration**](docs/AppsApi.md#apps_put_integration) | **PUT** /api/apps/{appId}/integrations/{id} | Update an app integration.
|
89
1189
|
*Notifo::ConfigsApi* | [**configs_get_languages**](docs/ConfigsApi.md#configs_get_languages) | **GET** /api/languages | Get all supported languages.
|
90
1190
|
*Notifo::ConfigsApi* | [**configs_get_timezones**](docs/ConfigsApi.md#configs_get_timezones) | **GET** /api/timezones | Get all supported timezones.
|
1191
|
+
*Notifo::EmailTemplatesApi* | [**email_template_preview_get_preview**](docs/EmailTemplatesApi.md#email_template_preview_get_preview) | **GET** /api/apps/{appId}/email-templates/{id}/preview | Get the HTML preview for a channel template.
|
1192
|
+
*Notifo::EmailTemplatesApi* | [**email_template_preview_post_preview**](docs/EmailTemplatesApi.md#email_template_preview_post_preview) | **POST** /api/apps/{appId}/email-templates/render | Render a preview for a email template.
|
1193
|
+
*Notifo::EmailTemplatesApi* | [**email_templates_delete_template**](docs/EmailTemplatesApi.md#email_templates_delete_template) | **DELETE** /api/apps/{appId}/email-templates/{id} | Delete a channel template.
|
1194
|
+
*Notifo::EmailTemplatesApi* | [**email_templates_delete_template_language**](docs/EmailTemplatesApi.md#email_templates_delete_template_language) | **DELETE** /api/apps/{appId}/email-templates/{id}/{language} | Delete a language channel template.
|
1195
|
+
*Notifo::EmailTemplatesApi* | [**email_templates_get_template**](docs/EmailTemplatesApi.md#email_templates_get_template) | **GET** /api/apps/{appId}/email-templates/{id} | Get the channel template by id.
|
1196
|
+
*Notifo::EmailTemplatesApi* | [**email_templates_get_templates**](docs/EmailTemplatesApi.md#email_templates_get_templates) | **GET** /api/apps/{appId}/email-templates | Get the channel templates.
|
1197
|
+
*Notifo::EmailTemplatesApi* | [**email_templates_post_template**](docs/EmailTemplatesApi.md#email_templates_post_template) | **POST** /api/apps/{appId}/email-templates | Create a channel template.
|
1198
|
+
*Notifo::EmailTemplatesApi* | [**email_templates_post_template_language**](docs/EmailTemplatesApi.md#email_templates_post_template_language) | **POST** /api/apps/{appId}/email-templates/{id} | Create an app template language.
|
1199
|
+
*Notifo::EmailTemplatesApi* | [**email_templates_put_template**](docs/EmailTemplatesApi.md#email_templates_put_template) | **PUT** /api/apps/{appId}/email-templates/{id} | Update an app template.
|
1200
|
+
*Notifo::EmailTemplatesApi* | [**email_templates_put_template_language**](docs/EmailTemplatesApi.md#email_templates_put_template_language) | **PUT** /api/apps/{appId}/email-templates/{id}/{language} | Update a channel template language.
|
91
1201
|
*Notifo::EventsApi* | [**events_get_events**](docs/EventsApi.md#events_get_events) | **GET** /api/apps/{appId}/events | Query events.
|
92
1202
|
*Notifo::EventsApi* | [**events_post_events**](docs/EventsApi.md#events_post_events) | **POST** /api/apps/{appId}/events | Publish events.
|
1203
|
+
*Notifo::EventsApi* | [**events_post_my_events**](docs/EventsApi.md#events_post_my_events) | **POST** /api/me/events | Publish an event for the current user.
|
93
1204
|
*Notifo::LogsApi* | [**logs_get_logs**](docs/LogsApi.md#logs_get_logs) | **GET** /api/apps/{appId}/logs | Query log entries.
|
94
1205
|
*Notifo::MediaApi* | [**media_delete**](docs/MediaApi.md#media_delete) | **DELETE** /api/apps/{appId}/media/{fileName} | Delete a media.
|
95
1206
|
*Notifo::MediaApi* | [**media_download**](docs/MediaApi.md#media_download) | **GET** /api/apps/{appId}/media/{fileName} | Download a media object.
|
96
1207
|
*Notifo::MediaApi* | [**media_download2**](docs/MediaApi.md#media_download2) | **GET** /api/assets/{appId}/{fileName} | Download a media object.
|
97
1208
|
*Notifo::MediaApi* | [**media_get_medias**](docs/MediaApi.md#media_get_medias) | **GET** /api/apps/{appId}/media | Query media items.
|
98
1209
|
*Notifo::MediaApi* | [**media_upload**](docs/MediaApi.md#media_upload) | **POST** /api/apps/{appId}/media | Upload a media object.
|
1210
|
+
*Notifo::MessagingTemplatesApi* | [**messaging_templates_delete_template**](docs/MessagingTemplatesApi.md#messaging_templates_delete_template) | **DELETE** /api/apps/{appId}/messaging-templates/{id} | Delete a channel template.
|
1211
|
+
*Notifo::MessagingTemplatesApi* | [**messaging_templates_delete_template_language**](docs/MessagingTemplatesApi.md#messaging_templates_delete_template_language) | **DELETE** /api/apps/{appId}/messaging-templates/{id}/{language} | Delete a language channel template.
|
1212
|
+
*Notifo::MessagingTemplatesApi* | [**messaging_templates_get_template**](docs/MessagingTemplatesApi.md#messaging_templates_get_template) | **GET** /api/apps/{appId}/messaging-templates/{id} | Get the channel template by id.
|
1213
|
+
*Notifo::MessagingTemplatesApi* | [**messaging_templates_get_templates**](docs/MessagingTemplatesApi.md#messaging_templates_get_templates) | **GET** /api/apps/{appId}/messaging-templates | Get the channel templates.
|
1214
|
+
*Notifo::MessagingTemplatesApi* | [**messaging_templates_post_template**](docs/MessagingTemplatesApi.md#messaging_templates_post_template) | **POST** /api/apps/{appId}/messaging-templates | Create a channel template.
|
1215
|
+
*Notifo::MessagingTemplatesApi* | [**messaging_templates_post_template_language**](docs/MessagingTemplatesApi.md#messaging_templates_post_template_language) | **POST** /api/apps/{appId}/messaging-templates/{id} | Create an app template language.
|
1216
|
+
*Notifo::MessagingTemplatesApi* | [**messaging_templates_put_template**](docs/MessagingTemplatesApi.md#messaging_templates_put_template) | **PUT** /api/apps/{appId}/messaging-templates/{id} | Update an app template.
|
1217
|
+
*Notifo::MessagingTemplatesApi* | [**messaging_templates_put_template_language**](docs/MessagingTemplatesApi.md#messaging_templates_put_template_language) | **PUT** /api/apps/{appId}/messaging-templates/{id}/{language} | Update a channel template language.
|
1218
|
+
*Notifo::MobilePushApi* | [**mobile_push_delete_my_token**](docs/MobilePushApi.md#mobile_push_delete_my_token) | **DELETE** /api/me/mobilepush/{token} | Deletes a mobile push token for the current user.
|
1219
|
+
*Notifo::MobilePushApi* | [**mobile_push_get_my_token**](docs/MobilePushApi.md#mobile_push_get_my_token) | **GET** /api/me/mobilepush | Returns the mobile push tokens.
|
1220
|
+
*Notifo::MobilePushApi* | [**mobile_push_post_my_token**](docs/MobilePushApi.md#mobile_push_post_my_token) | **POST** /api/me/mobilepush | Register a mobile push token for the current user.
|
1221
|
+
*Notifo::NotificationsApi* | [**notifications_confirm_me**](docs/NotificationsApi.md#notifications_confirm_me) | **POST** /api/me/notifications/handled | Confirms the user notifications for the current user.
|
1222
|
+
*Notifo::NotificationsApi* | [**notifications_get_my_archive**](docs/NotificationsApi.md#notifications_get_my_archive) | **GET** /api/me/notifications/archive | Query archhived user notifications of the current user.
|
1223
|
+
*Notifo::NotificationsApi* | [**notifications_get_my_notifications**](docs/NotificationsApi.md#notifications_get_my_notifications) | **GET** /api/me/notifications | Query user notifications of the current user.
|
1224
|
+
*Notifo::NotificationsApi* | [**notifications_get_notifications**](docs/NotificationsApi.md#notifications_get_notifications) | **GET** /api/apps/{appId}/users/{id}/notifications | Query user notifications.
|
1225
|
+
*Notifo::PingApi* | [**ping_get_ping**](docs/PingApi.md#ping_get_ping) | **GET** /ping | Get ping status of the API.
|
1226
|
+
*Notifo::SmsTemplatesApi* | [**sms_templates_delete_template**](docs/SmsTemplatesApi.md#sms_templates_delete_template) | **DELETE** /api/apps/{appId}/sms-templates/{id} | Delete a channel template.
|
1227
|
+
*Notifo::SmsTemplatesApi* | [**sms_templates_delete_template_language**](docs/SmsTemplatesApi.md#sms_templates_delete_template_language) | **DELETE** /api/apps/{appId}/sms-templates/{id}/{language} | Delete a language channel template.
|
1228
|
+
*Notifo::SmsTemplatesApi* | [**sms_templates_get_template**](docs/SmsTemplatesApi.md#sms_templates_get_template) | **GET** /api/apps/{appId}/sms-templates/{id} | Get the channel template by id.
|
1229
|
+
*Notifo::SmsTemplatesApi* | [**sms_templates_get_templates**](docs/SmsTemplatesApi.md#sms_templates_get_templates) | **GET** /api/apps/{appId}/sms-templates | Get the channel templates.
|
1230
|
+
*Notifo::SmsTemplatesApi* | [**sms_templates_post_template**](docs/SmsTemplatesApi.md#sms_templates_post_template) | **POST** /api/apps/{appId}/sms-templates | Create a channel template.
|
1231
|
+
*Notifo::SmsTemplatesApi* | [**sms_templates_post_template_language**](docs/SmsTemplatesApi.md#sms_templates_post_template_language) | **POST** /api/apps/{appId}/sms-templates/{id} | Create an app template language.
|
1232
|
+
*Notifo::SmsTemplatesApi* | [**sms_templates_put_template**](docs/SmsTemplatesApi.md#sms_templates_put_template) | **PUT** /api/apps/{appId}/sms-templates/{id} | Update an app template.
|
1233
|
+
*Notifo::SmsTemplatesApi* | [**sms_templates_put_template_language**](docs/SmsTemplatesApi.md#sms_templates_put_template_language) | **PUT** /api/apps/{appId}/sms-templates/{id}/{language} | Update a channel template language.
|
1234
|
+
*Notifo::SystemUsersApi* | [**system_users_delete_user**](docs/SystemUsersApi.md#system_users_delete_user) | **DELETE** /api/system-users/{id} | Delete the user.
|
1235
|
+
*Notifo::SystemUsersApi* | [**system_users_get_user**](docs/SystemUsersApi.md#system_users_get_user) | **GET** /api/system-users/{id} | Get a user.
|
1236
|
+
*Notifo::SystemUsersApi* | [**system_users_get_users**](docs/SystemUsersApi.md#system_users_get_users) | **GET** /api/system-users | Query users.
|
1237
|
+
*Notifo::SystemUsersApi* | [**system_users_lock_user**](docs/SystemUsersApi.md#system_users_lock_user) | **PUT** /api/system-users/{id}/lock | Lock the user.
|
1238
|
+
*Notifo::SystemUsersApi* | [**system_users_post_user**](docs/SystemUsersApi.md#system_users_post_user) | **POST** /api/system-users | Create a user.
|
1239
|
+
*Notifo::SystemUsersApi* | [**system_users_put_user**](docs/SystemUsersApi.md#system_users_put_user) | **PUT** /api/system-users/{id} | Update the user.
|
1240
|
+
*Notifo::SystemUsersApi* | [**system_users_unlock_user**](docs/SystemUsersApi.md#system_users_unlock_user) | **PUT** /api/system-users/{id}/unlock | Unlock the user.
|
99
1241
|
*Notifo::TemplatesApi* | [**templates_delete_template**](docs/TemplatesApi.md#templates_delete_template) | **DELETE** /api/apps/{appId}/templates/{code} | Delete a template.
|
100
1242
|
*Notifo::TemplatesApi* | [**templates_get_templates**](docs/TemplatesApi.md#templates_get_templates) | **GET** /api/apps/{appId}/templates | Query templates.
|
101
1243
|
*Notifo::TemplatesApi* | [**templates_post_templates**](docs/TemplatesApi.md#templates_post_templates) | **POST** /api/apps/{appId}/templates | Upsert templates.
|
1244
|
+
*Notifo::TopicsApi* | [**topics_delete_topic**](docs/TopicsApi.md#topics_delete_topic) | **DELETE** /api/apps/{appId}/topics/{id} | Delete a topic.
|
102
1245
|
*Notifo::TopicsApi* | [**topics_get_topics**](docs/TopicsApi.md#topics_get_topics) | **GET** /api/apps/{appId}/topics | Query topics.
|
103
|
-
*Notifo::
|
104
|
-
*Notifo::UserApi* | [**
|
1246
|
+
*Notifo::TopicsApi* | [**topics_post_topics**](docs/TopicsApi.md#topics_post_topics) | **POST** /api/apps/{appId}/topics | Upsert topics.
|
1247
|
+
*Notifo::UserApi* | [**user_delete_subscription**](docs/UserApi.md#user_delete_subscription) | **POST** /api/me/subscriptions/{prefix} | Remove my subscription.
|
1248
|
+
*Notifo::UserApi* | [**user_get_my_subscription**](docs/UserApi.md#user_get_my_subscription) | **GET** /api/me/subscriptions/{topic} | Gets a user subscription.
|
1249
|
+
*Notifo::UserApi* | [**user_get_my_subscriptions**](docs/UserApi.md#user_get_my_subscriptions) | **GET** /api/me/subscriptions | Query the user subscriptions.
|
1250
|
+
*Notifo::UserApi* | [**user_get_topics**](docs/UserApi.md#user_get_topics) | **GET** /api/me/topics | Query the user topics.
|
105
1251
|
*Notifo::UserApi* | [**user_get_user**](docs/UserApi.md#user_get_user) | **GET** /api/me | Get the current user.
|
106
|
-
*Notifo::UserApi* | [**
|
1252
|
+
*Notifo::UserApi* | [**user_post_my_subscriptions**](docs/UserApi.md#user_post_my_subscriptions) | **POST** /api/me/subscriptions | Upserts or deletes my subscriptions.
|
107
1253
|
*Notifo::UserApi* | [**user_post_user**](docs/UserApi.md#user_post_user) | **POST** /api/me | Update the user.
|
108
1254
|
*Notifo::UsersApi* | [**users_delete_allowed_topic**](docs/UsersApi.md#users_delete_allowed_topic) | **DELETE** /api/apps/{appId}/users/{id}/allowed-topics/{prefix} | Remove an allowed topic.
|
109
|
-
*Notifo::UsersApi* | [**users_delete_subscription**](docs/UsersApi.md#users_delete_subscription) | **DELETE** /api/apps/{appId}/users/{id}/subscriptions/{prefix} |
|
1255
|
+
*Notifo::UsersApi* | [**users_delete_subscription**](docs/UsersApi.md#users_delete_subscription) | **DELETE** /api/apps/{appId}/users/{id}/subscriptions/{prefix} | Unsubscribes a user from a subscription.
|
110
1256
|
*Notifo::UsersApi* | [**users_delete_user**](docs/UsersApi.md#users_delete_user) | **DELETE** /api/apps/{appId}/users/{id} | Delete a user.
|
111
1257
|
*Notifo::UsersApi* | [**users_get_subscriptions**](docs/UsersApi.md#users_get_subscriptions) | **GET** /api/apps/{appId}/users/{id}/subscriptions | Query user subscriptions.
|
112
1258
|
*Notifo::UsersApi* | [**users_get_user**](docs/UsersApi.md#users_get_user) | **GET** /api/apps/{appId}/users/{id} | Get a user.
|
113
1259
|
*Notifo::UsersApi* | [**users_get_users**](docs/UsersApi.md#users_get_users) | **GET** /api/apps/{appId}/users | Query users.
|
114
1260
|
*Notifo::UsersApi* | [**users_post_allowed_topic**](docs/UsersApi.md#users_post_allowed_topic) | **POST** /api/apps/{appId}/users/{id}/allowed-topics | Add an allowed topic.
|
115
|
-
*Notifo::UsersApi* | [**
|
1261
|
+
*Notifo::UsersApi* | [**users_post_subscriptions**](docs/UsersApi.md#users_post_subscriptions) | **POST** /api/apps/{appId}/users/{id}/subscriptions | Upserts or deletes multiple user subscriptions.
|
116
1262
|
*Notifo::UsersApi* | [**users_post_users**](docs/UsersApi.md#users_post_users) | **POST** /api/apps/{appId}/users | Upsert users.
|
117
1263
|
|
118
|
-
|
119
1264
|
## Documentation for Models
|
120
1265
|
|
121
1266
|
- [Notifo::AddAllowedTopicDto](docs/AddAllowedTopicDto.md)
|
@@ -123,43 +1268,98 @@ Class | Method | HTTP request | Description
|
|
123
1268
|
- [Notifo::AppContributorDto](docs/AppContributorDto.md)
|
124
1269
|
- [Notifo::AppDetailsDto](docs/AppDetailsDto.md)
|
125
1270
|
- [Notifo::AppDto](docs/AppDto.md)
|
1271
|
+
- [Notifo::AppIdMediaBody](docs/AppIdMediaBody.md)
|
1272
|
+
- [Notifo::ChannelCondition](docs/ChannelCondition.md)
|
1273
|
+
- [Notifo::ChannelSend](docs/ChannelSend.md)
|
1274
|
+
- [Notifo::ChannelSendInfoDto](docs/ChannelSendInfoDto.md)
|
1275
|
+
- [Notifo::ChannelSettingDto](docs/ChannelSettingDto.md)
|
1276
|
+
- [Notifo::ChannelTemplateDetailsDtoOfEmailTemplateDto](docs/ChannelTemplateDetailsDtoOfEmailTemplateDto.md)
|
1277
|
+
- [Notifo::ChannelTemplateDetailsDtoOfMessagingTemplateDto](docs/ChannelTemplateDetailsDtoOfMessagingTemplateDto.md)
|
1278
|
+
- [Notifo::ChannelTemplateDetailsDtoOfSmsTemplateDto](docs/ChannelTemplateDetailsDtoOfSmsTemplateDto.md)
|
1279
|
+
- [Notifo::ChannelTemplateDto](docs/ChannelTemplateDto.md)
|
1280
|
+
- [Notifo::ConfiguredIntegrationDto](docs/ConfiguredIntegrationDto.md)
|
1281
|
+
- [Notifo::ConfiguredIntegrationsDto](docs/ConfiguredIntegrationsDto.md)
|
126
1282
|
- [Notifo::ConfirmMode](docs/ConfirmMode.md)
|
127
|
-
- [Notifo::
|
1283
|
+
- [Notifo::CreateChannelTemplateDto](docs/CreateChannelTemplateDto.md)
|
1284
|
+
- [Notifo::CreateChannelTemplateLanguageDto](docs/CreateChannelTemplateLanguageDto.md)
|
1285
|
+
- [Notifo::CreateIntegrationDto](docs/CreateIntegrationDto.md)
|
1286
|
+
- [Notifo::CreateSystemUserDto](docs/CreateSystemUserDto.md)
|
1287
|
+
- [Notifo::EmailFormattingError](docs/EmailFormattingError.md)
|
1288
|
+
- [Notifo::EmailPreviewDto](docs/EmailPreviewDto.md)
|
1289
|
+
- [Notifo::EmailPreviewRequestDto](docs/EmailPreviewRequestDto.md)
|
1290
|
+
- [Notifo::EmailPreviewType](docs/EmailPreviewType.md)
|
128
1291
|
- [Notifo::EmailTemplateDto](docs/EmailTemplateDto.md)
|
129
|
-
- [Notifo::
|
1292
|
+
- [Notifo::EmailTemplateType](docs/EmailTemplateType.md)
|
130
1293
|
- [Notifo::ErrorDto](docs/ErrorDto.md)
|
131
1294
|
- [Notifo::EventDto](docs/EventDto.md)
|
1295
|
+
- [Notifo::HandledInfoDto](docs/HandledInfoDto.md)
|
1296
|
+
- [Notifo::IntegrationCreatedDto](docs/IntegrationCreatedDto.md)
|
1297
|
+
- [Notifo::IntegrationDefinitionDto](docs/IntegrationDefinitionDto.md)
|
1298
|
+
- [Notifo::IntegrationPropertyDto](docs/IntegrationPropertyDto.md)
|
1299
|
+
- [Notifo::IntegrationPropertyType](docs/IntegrationPropertyType.md)
|
1300
|
+
- [Notifo::IntegrationStatus](docs/IntegrationStatus.md)
|
132
1301
|
- [Notifo::IsoDayOfWeek](docs/IsoDayOfWeek.md)
|
1302
|
+
- [Notifo::ListResponseDtoOfChannelTemplateDto](docs/ListResponseDtoOfChannelTemplateDto.md)
|
133
1303
|
- [Notifo::ListResponseDtoOfEventDto](docs/ListResponseDtoOfEventDto.md)
|
134
1304
|
- [Notifo::ListResponseDtoOfLogEntryDto](docs/ListResponseDtoOfLogEntryDto.md)
|
135
1305
|
- [Notifo::ListResponseDtoOfMediaDto](docs/ListResponseDtoOfMediaDto.md)
|
1306
|
+
- [Notifo::ListResponseDtoOfMobilePushTokenDto](docs/ListResponseDtoOfMobilePushTokenDto.md)
|
136
1307
|
- [Notifo::ListResponseDtoOfSubscriptionDto](docs/ListResponseDtoOfSubscriptionDto.md)
|
1308
|
+
- [Notifo::ListResponseDtoOfSystemUserDto](docs/ListResponseDtoOfSystemUserDto.md)
|
137
1309
|
- [Notifo::ListResponseDtoOfTemplateDto](docs/ListResponseDtoOfTemplateDto.md)
|
138
1310
|
- [Notifo::ListResponseDtoOfTopicDto](docs/ListResponseDtoOfTopicDto.md)
|
139
1311
|
- [Notifo::ListResponseDtoOfUserDto](docs/ListResponseDtoOfUserDto.md)
|
1312
|
+
- [Notifo::ListResponseDtoOfUserNotificationDetailsDto](docs/ListResponseDtoOfUserNotificationDetailsDto.md)
|
1313
|
+
- [Notifo::ListResponseDtoOfUserNotificationDto](docs/ListResponseDtoOfUserNotificationDto.md)
|
1314
|
+
- [Notifo::LocalizedText](docs/LocalizedText.md)
|
140
1315
|
- [Notifo::LogEntryDto](docs/LogEntryDto.md)
|
141
1316
|
- [Notifo::MediaDto](docs/MediaDto.md)
|
1317
|
+
- [Notifo::MediaMetadata](docs/MediaMetadata.md)
|
142
1318
|
- [Notifo::MediaType](docs/MediaType.md)
|
1319
|
+
- [Notifo::MessagingTemplateDto](docs/MessagingTemplateDto.md)
|
1320
|
+
- [Notifo::MobileDeviceType](docs/MobileDeviceType.md)
|
1321
|
+
- [Notifo::MobilePushTokenDto](docs/MobilePushTokenDto.md)
|
1322
|
+
- [Notifo::MobilePushTokenDto2](docs/MobilePushTokenDto2.md)
|
143
1323
|
- [Notifo::NotificationFormattingDto](docs/NotificationFormattingDto.md)
|
144
|
-
- [Notifo::
|
145
|
-
- [Notifo::
|
1324
|
+
- [Notifo::NotificationProperties](docs/NotificationProperties.md)
|
1325
|
+
- [Notifo::ProcessStatus](docs/ProcessStatus.md)
|
146
1326
|
- [Notifo::ProfileDto](docs/ProfileDto.md)
|
147
1327
|
- [Notifo::PublishDto](docs/PublishDto.md)
|
148
1328
|
- [Notifo::PublishManyDto](docs/PublishManyDto.md)
|
1329
|
+
- [Notifo::RegisterMobileTokenDto](docs/RegisterMobileTokenDto.md)
|
149
1330
|
- [Notifo::ResizeMode](docs/ResizeMode.md)
|
150
1331
|
- [Notifo::SchedulingDto](docs/SchedulingDto.md)
|
151
1332
|
- [Notifo::SchedulingType](docs/SchedulingType.md)
|
1333
|
+
- [Notifo::SmsTemplateDto](docs/SmsTemplateDto.md)
|
1334
|
+
- [Notifo::SubscribeDto](docs/SubscribeDto.md)
|
1335
|
+
- [Notifo::SubscribeManyDto](docs/SubscribeManyDto.md)
|
152
1336
|
- [Notifo::SubscriptionDto](docs/SubscriptionDto.md)
|
1337
|
+
- [Notifo::SystemUserDto](docs/SystemUserDto.md)
|
153
1338
|
- [Notifo::TemplateDto](docs/TemplateDto.md)
|
1339
|
+
- [Notifo::TopicChannel](docs/TopicChannel.md)
|
154
1340
|
- [Notifo::TopicDto](docs/TopicDto.md)
|
1341
|
+
- [Notifo::TopicQueryScope](docs/TopicQueryScope.md)
|
1342
|
+
- [Notifo::TrackNotificationDto](docs/TrackNotificationDto.md)
|
1343
|
+
- [Notifo::UpdateChannelTemplateDtoOfEmailTemplateDto](docs/UpdateChannelTemplateDtoOfEmailTemplateDto.md)
|
1344
|
+
- [Notifo::UpdateChannelTemplateDtoOfMessagingTemplateDto](docs/UpdateChannelTemplateDtoOfMessagingTemplateDto.md)
|
1345
|
+
- [Notifo::UpdateChannelTemplateDtoOfSmsTemplateDto](docs/UpdateChannelTemplateDtoOfSmsTemplateDto.md)
|
1346
|
+
- [Notifo::UpdateIntegrationDto](docs/UpdateIntegrationDto.md)
|
155
1347
|
- [Notifo::UpdateProfileDto](docs/UpdateProfileDto.md)
|
1348
|
+
- [Notifo::UpdateSystemUserDto](docs/UpdateSystemUserDto.md)
|
156
1349
|
- [Notifo::UpsertAppDto](docs/UpsertAppDto.md)
|
157
1350
|
- [Notifo::UpsertTemplateDto](docs/UpsertTemplateDto.md)
|
158
1351
|
- [Notifo::UpsertTemplatesDto](docs/UpsertTemplatesDto.md)
|
1352
|
+
- [Notifo::UpsertTopicDto](docs/UpsertTopicDto.md)
|
1353
|
+
- [Notifo::UpsertTopicsDto](docs/UpsertTopicsDto.md)
|
159
1354
|
- [Notifo::UpsertUserDto](docs/UpsertUserDto.md)
|
160
1355
|
- [Notifo::UpsertUsersDto](docs/UpsertUsersDto.md)
|
161
1356
|
- [Notifo::UserDto](docs/UserDto.md)
|
162
|
-
|
1357
|
+
- [Notifo::UserNotificationBaseDto](docs/UserNotificationBaseDto.md)
|
1358
|
+
- [Notifo::UserNotificationChannelDto](docs/UserNotificationChannelDto.md)
|
1359
|
+
- [Notifo::UserNotificationDetailsDto](docs/UserNotificationDetailsDto.md)
|
1360
|
+
- [Notifo::UserNotificationDto](docs/UserNotificationDto.md)
|
1361
|
+
- [Notifo::UserPropertyDto](docs/UserPropertyDto.md)
|
1362
|
+
- [Notifo::UserTopicDto](docs/UserTopicDto.md)
|
163
1363
|
|
164
1364
|
## Documentation for Authorization
|
165
1365
|
|