notifo
Notifo - the Ruby gem for the Notifo API
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
This SDK is automatically generated by the Swagger Codegen project:
- API version: 1.0.0
- Package version: 1.0.0
- Build package: io.swagger.codegen.v3.generators.ruby.RubyClientCodegen
Installation
Build a gem
To build the Ruby code into a gem:
gem build notifo.gemspec
Then either install the gem locally:
gem install ./notifo-1.0.0.gem
(for development, run gem install --dev ./notifo-1.0.0.gem
to install the development dependencies)
or publish the gem to a gem hosting service, e.g. RubyGems.
Finally add this to the Gemfile:
gem 'notifo', '~> 1.0.0'
Install from Git
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:
gem 'notifo', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
Include the Ruby code directly
Include the Ruby code directly using -I
as follows:
ruby -Ilib script.rb
Getting Started
Please follow the installation procedure and then run the following code:
# Load the gem
require 'notifo'
api_instance = Notifo::AppsApi.new
app_id = 'app_id_example' # String | The id of the app.
contributor_id = 'contributor_id_example' # String | The contributor to remove.
begin
#Delete an app contributor.
result = api_instance.apps_delete_contributor(app_id, contributor_id)
p result
rescue Notifo::ApiError => e
puts "Exception when calling AppsApi->apps_delete_contributor: #{e}"
end
api_instance = Notifo::AppsApi.new
app_id = 'app_id_example' # String | The id of the app where the email templates belong to.
id = 'id_example' # String | The id of the integration.
begin
#Delete an app integration.
api_instance.apps_delete_integration(app_id, id)
rescue Notifo::ApiError => e
puts "Exception when calling AppsApi->apps_delete_integration: #{e}"
end
api_instance = Notifo::AppsApi.new
app_id = 'app_id_example' # String | The id of the app.
begin
#Get app by id.
result = api_instance.apps_get_app(app_id)
p result
rescue Notifo::ApiError => e
puts "Exception when calling AppsApi->apps_get_app: #{e}"
end
api_instance = Notifo::AppsApi.new
begin
#Get the user apps.
result = api_instance.apps_get_apps
p result
rescue Notifo::ApiError => e
puts "Exception when calling AppsApi->apps_get_apps: #{e}"
end
api_instance = Notifo::AppsApi.new
app_id = 'app_id_example' # String | The id of the app where the integrations belong to.
begin
#Get the app integrations.
result = api_instance.apps_get_integrations(app_id)
p result
rescue Notifo::ApiError => e
puts "Exception when calling AppsApi->apps_get_integrations: #{e}"
end
api_instance = Notifo::AppsApi.new
body = Notifo::UpsertAppDto.new # UpsertAppDto | The request object.
begin
#Create an app.
result = api_instance.apps_post_app(body)
p result
rescue Notifo::ApiError => e
puts "Exception when calling AppsApi->apps_post_app: #{e}"
end
api_instance = Notifo::AppsApi.new
body = Notifo::AddContributorDto.new # AddContributorDto | The request object.
app_id = 'app_id_example' # String | The id of the app.
begin
#Add an app contributor.
result = api_instance.apps_post_contributor(body, app_id)
p result
rescue Notifo::ApiError => e
puts "Exception when calling AppsApi->apps_post_contributor: #{e}"
end
api_instance = Notifo::AppsApi.new
body = Notifo::CreateIntegrationDto.new # CreateIntegrationDto | The request object.
app_id = 'app_id_example' # String | The id of the app where the integration belong to.
begin
#Create an app integrations.
result = api_instance.apps_post_integration(body, app_id)
p result
rescue Notifo::ApiError => e
puts "Exception when calling AppsApi->apps_post_integration: #{e}"
end
api_instance = Notifo::AppsApi.new
body = Notifo::UpsertAppDto.new # UpsertAppDto | The request object.
app_id = 'app_id_example' # String | The app id to update.
begin
#Update an app.
result = api_instance.apps_put_app(body, app_id)
p result
rescue Notifo::ApiError => e
puts "Exception when calling AppsApi->apps_put_app: #{e}"
end
api_instance = Notifo::AppsApi.new
body = Notifo::UpdateIntegrationDto.new # UpdateIntegrationDto | The request object.
app_id = 'app_id_example' # String | The id of the app where the integration belong to.
id = 'id_example' # String | The id of the integration.
begin
#Update an app integration.
api_instance.apps_put_integration(body, app_id, id)
rescue Notifo::ApiError => e
puts "Exception when calling AppsApi->apps_put_integration: #{e}"
end
api_instance = Notifo::ConfigsApi.new
begin
#Get all supported languages.
result = api_instance.configs_get_languages
p result
rescue Notifo::ApiError => e
puts "Exception when calling ConfigsApi->configs_get_languages: #{e}"
end
api_instance = Notifo::ConfigsApi.new
begin
#Get all supported timezones.
result = api_instance.configs_get_timezones
p result
rescue Notifo::ApiError => e
puts "Exception when calling ConfigsApi->configs_get_timezones: #{e}"
end
api_instance = Notifo::DiagnosticsApi.new
begin
#Creates a dump and writes it into storage..
api_instance.diagnostics_get_dump
rescue Notifo::ApiError => e
puts "Exception when calling DiagnosticsApi->diagnostics_get_dump: #{e}"
end
api_instance = Notifo::DiagnosticsApi.new
begin
#Creates a gc dump and writes it into storage.
api_instance.diagnostics_get_gc_dump
rescue Notifo::ApiError => e
puts "Exception when calling DiagnosticsApi->diagnostics_get_gc_dump: #{e}"
end
api_instance = Notifo::EmailTemplatesApi.new
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
id = 'id_example' # String | The template ID.
begin
#Get the HTML preview for a channel template.
result = api_instance.email_template_preview_get_preview(app_id, id)
p result
rescue Notifo::ApiError => e
puts "Exception when calling EmailTemplatesApi->email_template_preview_get_preview: #{e}"
end
api_instance = Notifo::EmailTemplatesApi.new
body = Notifo::EmailPreviewRequestDto.new # EmailPreviewRequestDto | The template to render.
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
begin
#Render a preview for a email template.
result = api_instance.email_template_preview_post_preview(body, app_id)
p result
rescue Notifo::ApiError => e
puts "Exception when calling EmailTemplatesApi->email_template_preview_post_preview: #{e}"
end
api_instance = Notifo::EmailTemplatesApi.new
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
code = 'code_example' # String | The template ID.
begin
#Delete a channel template.
api_instance.email_templates_delete_template(app_id, code)
rescue Notifo::ApiError => e
puts "Exception when calling EmailTemplatesApi->email_templates_delete_template: #{e}"
end
api_instance = Notifo::EmailTemplatesApi.new
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
code = 'code_example' # String | The template ID.
language = 'language_example' # String | The language.
begin
#Delete a language channel template.
api_instance.email_templates_delete_template_language(app_id, code, language)
rescue Notifo::ApiError => e
puts "Exception when calling EmailTemplatesApi->email_templates_delete_template_language: #{e}"
end
api_instance = Notifo::EmailTemplatesApi.new
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
id = 'id_example' # String | The template ID.
begin
#Get the channel template by id.
result = api_instance.email_templates_get_template(app_id, id)
p result
rescue Notifo::ApiError => e
puts "Exception when calling EmailTemplatesApi->email_templates_get_template: #{e}"
end
api_instance = Notifo::EmailTemplatesApi.new
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
opts = {
query: 'query_example', # String | The optional query to search for items.
take: 56, # Integer | The number of items to return.
skip: 56 # Integer | The number of items to skip.
}
begin
#Get the channel templates.
result = api_instance.email_templates_get_templates(app_id, opts)
p result
rescue Notifo::ApiError => e
puts "Exception when calling EmailTemplatesApi->email_templates_get_templates: #{e}"
end
api_instance = Notifo::EmailTemplatesApi.new
body = Notifo::CreateChannelTemplateDto.new # CreateChannelTemplateDto | The request object.
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
begin
#Create a channel template.
result = api_instance.email_templates_post_template(body, app_id)
p result
rescue Notifo::ApiError => e
puts "Exception when calling EmailTemplatesApi->email_templates_post_template: #{e}"
end
api_instance = Notifo::EmailTemplatesApi.new
body = Notifo::CreateChannelTemplateLanguageDto.new # CreateChannelTemplateLanguageDto | The request object.
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
code = 'code_example' # String | The template code.
begin
#Create an app template language.
result = api_instance.email_templates_post_template_language(body, app_id, code)
p result
rescue Notifo::ApiError => e
puts "Exception when calling EmailTemplatesApi->email_templates_post_template_language: #{e}"
end
api_instance = Notifo::EmailTemplatesApi.new
body = Notifo::UpdateChannelTemplateDtoOfEmailTemplateDto.new # UpdateChannelTemplateDtoOfEmailTemplateDto | The request object.
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
code = 'code_example' # String | The template code.
begin
#Update an app template.
api_instance.email_templates_put_template(body, app_id, code)
rescue Notifo::ApiError => e
puts "Exception when calling EmailTemplatesApi->email_templates_put_template: #{e}"
end
api_instance = Notifo::EmailTemplatesApi.new
body = Notifo::EmailTemplateDto.new # EmailTemplateDto | The request object.
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
code = 'code_example' # String | The template code.
language = 'language_example' # String | The language.
begin
#Update a channel template language.
api_instance.email_templates_put_template_language(body, app_id, code, language)
rescue Notifo::ApiError => e
puts "Exception when calling EmailTemplatesApi->email_templates_put_template_language: #{e}"
end
api_instance = Notifo::EventsApi.new
app_id = 'app_id_example' # String | The app where the events belongs to.
opts = {
channels: ['channels_example'], # Array<String> | The active channels.
query: 'query_example', # String | The optional query to search for items.
take: 56, # Integer | The number of items to return.
skip: 56 # Integer | The number of items to skip.
}
begin
#Query events.
result = api_instance.events_get_events(app_id, opts)
p result
rescue Notifo::ApiError => e
puts "Exception when calling EventsApi->events_get_events: #{e}"
end
api_instance = Notifo::EventsApi.new
body = Notifo::PublishManyDto.new # PublishManyDto | The publish request.
app_id = 'app_id_example' # String | The app where the events belongs to.
begin
#Publish events.
api_instance.events_post_events(body, app_id)
rescue Notifo::ApiError => e
puts "Exception when calling EventsApi->events_post_events: #{e}"
end
api_instance = Notifo::EventsApi.new
body = Notifo::PublishDto.new # PublishDto | The publish request.
begin
#Publish an event for the current user.
api_instance.events_post_my_events(body)
rescue Notifo::ApiError => e
puts "Exception when calling EventsApi->events_post_my_events: #{e}"
end
api_instance = Notifo::LogsApi.new
app_id = 'app_id_example' # String | The app where the log entries belongs to.
opts = {
query: 'query_example', # String | The optional query to search for items.
take: 56, # Integer | The number of items to return.
skip: 56 # Integer | The number of items to skip.
}
begin
#Query log entries.
result = api_instance.logs_get_logs(app_id, opts)
p result
rescue Notifo::ApiError => e
puts "Exception when calling LogsApi->logs_get_logs: #{e}"
end
api_instance = Notifo::MediaApi.new
app_id = 'app_id_example' # String | The app id where the media belongs to.
file_name = 'file_name_example' # String | The file name of the media.
begin
#Delete a media.
api_instance.media_delete(app_id, file_name)
rescue Notifo::ApiError => e
puts "Exception when calling MediaApi->media_delete: #{e}"
end
api_instance = Notifo::MediaApi.new
app_id = 'app_id_example' # String | The app id where the media belongs to.
file_name = 'file_name_example' # String | The name of the media to download.
opts = {
cache: 789, # Integer | The cache duration.
download: 56, # Integer | Set it to 1 to create a download response.
bg: 'bg_example', # String | Optional background color.
width: 56, # Integer | The target width when an image.
height: 56, # Integer | The target height when an image.
quality: 56, # Integer | The target quality when an image.
preset: 'preset_example', # String | A preset dimension.
mode: Notifo::ResizeMode.new, # ResizeMode | The resize mode.
focus_x: 3.4, # Float | The x position of the focues point.
focus_y: 3.4, # Float | The y position of the focues point.
force: true, # BOOLEAN | True to resize it and clear the cache.
empty_on_failure: true # BOOLEAN | True, to return an empty image on failure.
}
begin
#Download a media object.
result = api_instance.media_download(app_id, file_name, opts)
p result
rescue Notifo::ApiError => e
puts "Exception when calling MediaApi->media_download: #{e}"
end
api_instance = Notifo::MediaApi.new
app_id = 'app_id_example' # String | The app id where the media belongs to.
file_name = 'file_name_example' # String | The name of the media to download.
opts = {
cache: 789, # Integer | The cache duration.
download: 56, # Integer | Set it to 1 to create a download response.
bg: 'bg_example', # String | Optional background color.
width: 56, # Integer | The target width when an image.
height: 56, # Integer | The target height when an image.
quality: 56, # Integer | The target quality when an image.
preset: 'preset_example', # String | A preset dimension.
mode: Notifo::ResizeMode.new, # ResizeMode | The resize mode.
focus_x: 3.4, # Float | The x position of the focues point.
focus_y: 3.4, # Float | The y position of the focues point.
force: true, # BOOLEAN | True to resize it and clear the cache.
empty_on_failure: true # BOOLEAN | True, to return an empty image on failure.
}
begin
#Download a media object.
result = api_instance.media_download2(app_id, file_name, opts)
p result
rescue Notifo::ApiError => e
puts "Exception when calling MediaApi->media_download2: #{e}"
end
api_instance = Notifo::MediaApi.new
app_id = 'app_id_example' # String | The app id where the media belongs to.
file_name = 'file_name_example' # String | The name of the media to download.
opts = {
cache: 789, # Integer | The cache duration.
download: 56, # Integer | Set it to 1 to create a download response.
bg: 'bg_example', # String | Optional background color.
width: 56, # Integer | The target width when an image.
height: 56, # Integer | The target height when an image.
quality: 56, # Integer | The target quality when an image.
preset: 'preset_example', # String | A preset dimension.
mode: Notifo::ResizeMode.new, # ResizeMode | The resize mode.
focus_x: 3.4, # Float | The x position of the focues point.
focus_y: 3.4, # Float | The y position of the focues point.
force: true, # BOOLEAN | True to resize it and clear the cache.
empty_on_failure: true # BOOLEAN | True, to return an empty image on failure.
}
begin
#Download a media object.
result = api_instance.media_download3(app_id, file_name, opts)
p result
rescue Notifo::ApiError => e
puts "Exception when calling MediaApi->media_download3: #{e}"
end
api_instance = Notifo::MediaApi.new
app_id = 'app_id_example' # String | The app where the media belongs to.
opts = {
query: 'query_example', # String | The optional query to search for items.
take: 56, # Integer | The number of items to return.
skip: 56 # Integer | The number of items to skip.
}
begin
#Query media items.
result = api_instance.media_get_medias(app_id, opts)
p result
rescue Notifo::ApiError => e
puts "Exception when calling MediaApi->media_get_medias: #{e}"
end
api_instance = Notifo::MediaApi.new
opts = {
url: 'url_example', # String | The app id where the media belongs to.
cache: 789, # Integer | The cache duration.
download: 56, # Integer | Set it to 1 to create a download response.
bg: 'bg_example', # String | Optional background color.
width: 56, # Integer | The target width when an image.
height: 56, # Integer | The target height when an image.
quality: 56, # Integer | The target quality when an image.
preset: 'preset_example', # String | A preset dimension.
mode: Notifo::ResizeMode.new, # ResizeMode | The resize mode.
focus_x: 3.4, # Float | The x position of the focues point.
focus_y: 3.4, # Float | The y position of the focues point.
force: true, # BOOLEAN | True to resize it and clear the cache.
empty_on_failure: true # BOOLEAN | True, to return an empty image on failure.
}
begin
#Download a media object.
result = api_instance.media_proxy_proxy_image(opts)
p result
rescue Notifo::ApiError => e
puts "Exception when calling MediaApi->media_proxy_proxy_image: #{e}"
end
api_instance = Notifo::MediaApi.new
app_id = 'app_id_example' # String | The app id where the media belongs to.
opts = {
file: 'file_example' # String |
}
begin
#Upload a media object.
api_instance.media_upload(app_id, opts)
rescue Notifo::ApiError => e
puts "Exception when calling MediaApi->media_upload: #{e}"
end
api_instance = Notifo::MessagingTemplatesApi.new
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
code = 'code_example' # String | The template ID.
begin
#Delete a channel template.
api_instance.messaging_templates_delete_template(app_id, code)
rescue Notifo::ApiError => e
puts "Exception when calling MessagingTemplatesApi->messaging_templates_delete_template: #{e}"
end
api_instance = Notifo::MessagingTemplatesApi.new
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
code = 'code_example' # String | The template ID.
language = 'language_example' # String | The language.
begin
#Delete a language channel template.
api_instance.messaging_templates_delete_template_language(app_id, code, language)
rescue Notifo::ApiError => e
puts "Exception when calling MessagingTemplatesApi->messaging_templates_delete_template_language: #{e}"
end
api_instance = Notifo::MessagingTemplatesApi.new
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
id = 'id_example' # String | The template ID.
begin
#Get the channel template by id.
result = api_instance.messaging_templates_get_template(app_id, id)
p result
rescue Notifo::ApiError => e
puts "Exception when calling MessagingTemplatesApi->messaging_templates_get_template: #{e}"
end
api_instance = Notifo::MessagingTemplatesApi.new
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
opts = {
query: 'query_example', # String | The optional query to search for items.
take: 56, # Integer | The number of items to return.
skip: 56 # Integer | The number of items to skip.
}
begin
#Get the channel templates.
result = api_instance.messaging_templates_get_templates(app_id, opts)
p result
rescue Notifo::ApiError => e
puts "Exception when calling MessagingTemplatesApi->messaging_templates_get_templates: #{e}"
end
api_instance = Notifo::MessagingTemplatesApi.new
body = Notifo::CreateChannelTemplateDto.new # CreateChannelTemplateDto | The request object.
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
begin
#Create a channel template.
result = api_instance.messaging_templates_post_template(body, app_id)
p result
rescue Notifo::ApiError => e
puts "Exception when calling MessagingTemplatesApi->messaging_templates_post_template: #{e}"
end
api_instance = Notifo::MessagingTemplatesApi.new
body = Notifo::CreateChannelTemplateLanguageDto.new # CreateChannelTemplateLanguageDto | The request object.
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
code = 'code_example' # String | The template code.
begin
#Create an app template language.
result = api_instance.messaging_templates_post_template_language(body, app_id, code)
p result
rescue Notifo::ApiError => e
puts "Exception when calling MessagingTemplatesApi->messaging_templates_post_template_language: #{e}"
end
api_instance = Notifo::MessagingTemplatesApi.new
body = Notifo::UpdateChannelTemplateDtoOfMessagingTemplateDto.new # UpdateChannelTemplateDtoOfMessagingTemplateDto | The request object.
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
code = 'code_example' # String | The template code.
begin
#Update an app template.
api_instance.messaging_templates_put_template(body, app_id, code)
rescue Notifo::ApiError => e
puts "Exception when calling MessagingTemplatesApi->messaging_templates_put_template: #{e}"
end
api_instance = Notifo::MessagingTemplatesApi.new
body = Notifo::MessagingTemplateDto.new # MessagingTemplateDto | The request object.
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
code = 'code_example' # String | The template code.
language = 'language_example' # String | The language.
begin
#Update a channel template language.
api_instance.messaging_templates_put_template_language(body, app_id, code, language)
rescue Notifo::ApiError => e
puts "Exception when calling MessagingTemplatesApi->messaging_templates_put_template_language: #{e}"
end
api_instance = Notifo::MobilePushApi.new
token = 'token_example' # String | The token to remove.
begin
#Deletes a mobile push token for the current user.
api_instance.mobile_push_delete_my_token(token)
rescue Notifo::ApiError => e
puts "Exception when calling MobilePushApi->mobile_push_delete_my_token: #{e}"
end
api_instance = Notifo::MobilePushApi.new
begin
#Returns the mobile push tokens.
result = api_instance.mobile_push_get_my_token
p result
rescue Notifo::ApiError => e
puts "Exception when calling MobilePushApi->mobile_push_get_my_token: #{e}"
end
api_instance = Notifo::MobilePushApi.new
body = Notifo::RegisterMobileTokenDto.new # RegisterMobileTokenDto | The request object.
begin
#Register a mobile push token for the current user.
api_instance.mobile_push_post_my_token(body)
rescue Notifo::ApiError => e
puts "Exception when calling MobilePushApi->mobile_push_post_my_token: #{e}"
end
api_instance = Notifo::NotificationsApi.new
body = Notifo::TrackNotificationDto.new # TrackNotificationDto | The request object.
begin
#Confirms the user notifications for the current user.
api_instance.notifications_confirm_me(body)
rescue Notifo::ApiError => e
puts "Exception when calling NotificationsApi->notifications_confirm_me: #{e}"
end
api_instance = Notifo::NotificationsApi.new
app_id = 'app_id_example' # String | The app where the user belongs to.
opts = {
channels: ['channels_example'], # Array<String> | The active channels.
channel: 'channel_example', # String | The source channel.
correlation_id: 'correlation_id_example', # String | The correlation ID, that can be used to query notifications.
query: 'query_example', # String | The optional query to search for items.
take: 56, # Integer | The number of items to return.
skip: 56 # Integer | The number of items to skip.
}
begin
#Query notifications.
result = api_instance.notifications_get_all_notifications(app_id, opts)
p result
rescue Notifo::ApiError => e
puts "Exception when calling NotificationsApi->notifications_get_all_notifications: #{e}"
end
api_instance = Notifo::NotificationsApi.new
opts = {
channel: 'channel_example' # String | The tracking channel.
}
begin
#Query archived user notifications of the current user.
result = api_instance.notifications_get_my_archive(opts)
p result
rescue Notifo::ApiError => e
puts "Exception when calling NotificationsApi->notifications_get_my_archive: #{e}"
end
api_instance = Notifo::NotificationsApi.new
opts = {
device_identifier: 'device_identifier_example', # String | The device identifier (aka mobile push token).
after: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | The max age of the notifications.
include_unseen: true, # BOOLEAN | True to also include unseen notifications.
take: 56 # Integer | The number of notifications to query.
}
begin
#Query user notifications of the current user for a specific device.
result = api_instance.notifications_get_my_device_notifications(opts)
p result
rescue Notifo::ApiError => e
puts "Exception when calling NotificationsApi->notifications_get_my_device_notifications: #{e}"
end
api_instance = Notifo::NotificationsApi.new
opts = {
channels: ['channels_example'], # Array<String> | The active channels.
channel: 'channel_example', # String | The source channel.
correlation_id: 'correlation_id_example', # String | The correlation ID, that can be used to query notifications.
query: 'query_example', # String | The optional query to search for items.
take: 56, # Integer | The number of items to return.
skip: 56 # Integer | The number of items to skip.
}
begin
#Query user notifications of the current user.
result = api_instance.notifications_get_my_notifications(opts)
p result
rescue Notifo::ApiError => e
puts "Exception when calling NotificationsApi->notifications_get_my_notifications: #{e}"
end
api_instance = Notifo::NotificationsApi.new
app_id = 'app_id_example' # String | The app where the user belongs to.
id = 'id_example' # String | The user id.
opts = {
channels: ['channels_example'], # Array<String> | The active channels.
channel: 'channel_example', # String | The source channel.
correlation_id: 'correlation_id_example', # String | The correlation ID, that can be used to query notifications.
query: 'query_example', # String | The optional query to search for items.
take: 56, # Integer | The number of items to return.
skip: 56 # Integer | The number of items to skip.
}
begin
#Query user notifications.
result = api_instance.notifications_get_notifications(app_id, id, opts)
p result
rescue Notifo::ApiError => e
puts "Exception when calling NotificationsApi->notifications_get_notifications: #{e}"
end
api_instance = Notifo::PingApi.new
begin
#Get some info about the API.
result = api_instance.ping_get_info
p result
rescue Notifo::ApiError => e
puts "Exception when calling PingApi->ping_get_info: #{e}"
end
api_instance = Notifo::PingApi.new
begin
#Get ping status of the API.
api_instance.ping_get_old_ping
rescue Notifo::ApiError => e
puts "Exception when calling PingApi->ping_get_old_ping: #{e}"
end
api_instance = Notifo::PingApi.new
begin
#Get ping status of the API.
api_instance.ping_get_ping
rescue Notifo::ApiError => e
puts "Exception when calling PingApi->ping_get_ping: #{e}"
end
api_instance = Notifo::SmsTemplatesApi.new
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
code = 'code_example' # String | The template ID.
begin
#Delete a channel template.
api_instance.sms_templates_delete_template(app_id, code)
rescue Notifo::ApiError => e
puts "Exception when calling SmsTemplatesApi->sms_templates_delete_template: #{e}"
end
api_instance = Notifo::SmsTemplatesApi.new
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
code = 'code_example' # String | The template ID.
language = 'language_example' # String | The language.
begin
#Delete a language channel template.
api_instance.sms_templates_delete_template_language(app_id, code, language)
rescue Notifo::ApiError => e
puts "Exception when calling SmsTemplatesApi->sms_templates_delete_template_language: #{e}"
end
api_instance = Notifo::SmsTemplatesApi.new
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
id = 'id_example' # String | The template ID.
begin
#Get the channel template by id.
result = api_instance.sms_templates_get_template(app_id, id)
p result
rescue Notifo::ApiError => e
puts "Exception when calling SmsTemplatesApi->sms_templates_get_template: #{e}"
end
api_instance = Notifo::SmsTemplatesApi.new
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
opts = {
query: 'query_example', # String | The optional query to search for items.
take: 56, # Integer | The number of items to return.
skip: 56 # Integer | The number of items to skip.
}
begin
#Get the channel templates.
result = api_instance.sms_templates_get_templates(app_id, opts)
p result
rescue Notifo::ApiError => e
puts "Exception when calling SmsTemplatesApi->sms_templates_get_templates: #{e}"
end
api_instance = Notifo::SmsTemplatesApi.new
body = Notifo::CreateChannelTemplateDto.new # CreateChannelTemplateDto | The request object.
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
begin
#Create a channel template.
result = api_instance.sms_templates_post_template(body, app_id)
p result
rescue Notifo::ApiError => e
puts "Exception when calling SmsTemplatesApi->sms_templates_post_template: #{e}"
end
api_instance = Notifo::SmsTemplatesApi.new
body = Notifo::CreateChannelTemplateLanguageDto.new # CreateChannelTemplateLanguageDto | The request object.
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
code = 'code_example' # String | The template code.
begin
#Create an app template language.
result = api_instance.sms_templates_post_template_language(body, app_id, code)
p result
rescue Notifo::ApiError => e
puts "Exception when calling SmsTemplatesApi->sms_templates_post_template_language: #{e}"
end
api_instance = Notifo::SmsTemplatesApi.new
body = Notifo::UpdateChannelTemplateDtoOfSmsTemplateDto.new # UpdateChannelTemplateDtoOfSmsTemplateDto | The request object.
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
code = 'code_example' # String | The template code.
begin
#Update an app template.
api_instance.sms_templates_put_template(body, app_id, code)
rescue Notifo::ApiError => e
puts "Exception when calling SmsTemplatesApi->sms_templates_put_template: #{e}"
end
api_instance = Notifo::SmsTemplatesApi.new
body = Notifo::SmsTemplateDto.new # SmsTemplateDto | The request object.
app_id = 'app_id_example' # String | The id of the app where the templates belong to.
code = 'code_example' # String | The template code.
language = 'language_example' # String | The language.
begin
#Update a channel template language.
api_instance.sms_templates_put_template_language(body, app_id, code, language)
rescue Notifo::ApiError => e
puts "Exception when calling SmsTemplatesApi->sms_templates_put_template_language: #{e}"
end
api_instance = Notifo::SystemUsersApi.new
id = 'id_example' # String | The user ID.
begin
#Delete the user.
api_instance.system_users_delete_user(id)
rescue Notifo::ApiError => e
puts "Exception when calling SystemUsersApi->system_users_delete_user: #{e}"
end
api_instance = Notifo::SystemUsersApi.new
id = 'id_example' # String | The user ID.
begin
#Get a user.
result = api_instance.system_users_get_user(id)
p result
rescue Notifo::ApiError => e
puts "Exception when calling SystemUsersApi->system_users_get_user: #{e}"
end
api_instance = Notifo::SystemUsersApi.new
opts = {
query: 'query_example', # String | The optional query to search for items.
take: 56, # Integer | The number of items to return.
skip: 56 # Integer | The number of items to skip.
}
begin
#Query users.
result = api_instance.system_users_get_users(opts)
p result
rescue Notifo::ApiError => e
puts "Exception when calling SystemUsersApi->system_users_get_users: #{e}"
end
api_instance = Notifo::SystemUsersApi.new
id = 'id_example' # String | The user ID.
begin
#Lock the user.
result = api_instance.system_users_lock_user(id)
p result
rescue Notifo::ApiError => e
puts "Exception when calling SystemUsersApi->system_users_lock_user: #{e}"
end
api_instance = Notifo::SystemUsersApi.new
body = Notifo::CreateSystemUserDto.new # CreateSystemUserDto | The create request.
begin
#Create a user.
result = api_instance.system_users_post_user(body)
p result
rescue Notifo::ApiError => e
puts "Exception when calling SystemUsersApi->system_users_post_user: #{e}"
end
api_instance = Notifo::SystemUsersApi.new
body = Notifo::UpdateSystemUserDto.new # UpdateSystemUserDto | The update request.
id = 'id_example' # String | The user ID.
begin
#Update the user.
result = api_instance.system_users_put_user(body, id)
p result
rescue Notifo::ApiError => e
puts "Exception when calling SystemUsersApi->system_users_put_user: #{e}"
end
api_instance = Notifo::SystemUsersApi.new
id = 'id_example' # String | The user ID.
begin
#Unlock the user.
result = api_instance.system_users_unlock_user(id)
p result
rescue Notifo::ApiError => e
puts "Exception when calling SystemUsersApi->system_users_unlock_user: #{e}"
end
api_instance = Notifo::TemplatesApi.new
app_id = 'app_id_example' # String | The app where the templates belong to.
code = 'code_example' # String | The template code to delete.
begin
#Delete a template.
api_instance.templates_delete_template(app_id, code)
rescue Notifo::ApiError => e
puts "Exception when calling TemplatesApi->templates_delete_template: #{e}"
end
api_instance = Notifo::TemplatesApi.new
app_id = 'app_id_example' # String | The app where the templates belongs to.
opts = {
query: 'query_example', # String | The optional query to search for items.
take: 56, # Integer | The number of items to return.
skip: 56 # Integer | The number of items to skip.
}
begin
#Query templates.
result = api_instance.templates_get_templates(app_id, opts)
p result
rescue Notifo::ApiError => e
puts "Exception when calling TemplatesApi->templates_get_templates: #{e}"
end
api_instance = Notifo::TemplatesApi.new
body = Notifo::UpsertTemplatesDto.new # UpsertTemplatesDto | The upsert request.
app_id = 'app_id_example' # String | The app where the templates belong to.
begin
#Upsert templates.
result = api_instance.templates_post_templates(body, app_id)
p result
rescue Notifo::ApiError => e
puts "Exception when calling TemplatesApi->templates_post_templates: #{e}"
end
api_instance = Notifo::TopicsApi.new
app_id = 'app_id_example' # String | The app where the topics belong to.
path = 'path_example' # String | The path of the topic to delete.
begin
#Delete a topic.
api_instance.topics_delete_topic(app_id, path)
rescue Notifo::ApiError => e
puts "Exception when calling TopicsApi->topics_delete_topic: #{e}"
end
api_instance = Notifo::TopicsApi.new
app_id = 'app_id_example' # String | The app where the topics belongs to.
opts = {
scope: Notifo::TopicQueryScope.new, # TopicQueryScope | The scope of the query.
query: 'query_example', # String | The optional query to search for items.
take: 56, # Integer | The number of items to return.
skip: 56 # Integer | The number of items to skip.
}
begin
#Query topics.
result = api_instance.topics_get_topics(app_id, opts)
p result
rescue Notifo::ApiError => e
puts "Exception when calling TopicsApi->topics_get_topics: #{e}"
end
api_instance = Notifo::TopicsApi.new
body = Notifo::UpsertTopicsDto.new # UpsertTopicsDto | The upsert request.
app_id = 'app_id_example' # String | The app where the topics belong to.
begin
#Upsert topics.
result = api_instance.topics_post_topics(body, app_id)
p result
rescue Notifo::ApiError => e
puts "Exception when calling TopicsApi->topics_post_topics: #{e}"
end
api_instance = Notifo::UserApi.new
prefix = 'prefix_example' # String | The topic prefix.
begin
#Remove my subscription.
api_instance.user_delete_subscription(prefix)
rescue Notifo::ApiError => e
puts "Exception when calling UserApi->user_delete_subscription: #{e}"
end
api_instance = Notifo::UserApi.new
begin
#Get the current admin user.
result = api_instance.user_get_admin_user
p result
rescue Notifo::ApiError => e
puts "Exception when calling UserApi->user_get_admin_user: #{e}"
end
api_instance = Notifo::UserApi.new
topic = 'topic_example' # String | The topic path.
begin
#Gets a user subscription.
result = api_instance.user_get_my_subscription(topic)
p result
rescue Notifo::ApiError => e
puts "Exception when calling UserApi->user_get_my_subscription: #{e}"
end
api_instance = Notifo::UserApi.new
opts = {
topics: 'topics_example', # String | The topics we are interested in.
query: 'query_example', # String | The optional query to search for items.
take: 56, # Integer | The number of items to return.
skip: 56 # Integer | The number of items to skip.
}
begin
#Query the user subscriptions.
result = api_instance.user_get_my_subscriptions(opts)
p result
rescue Notifo::ApiError => e
puts "Exception when calling UserApi->user_get_my_subscriptions: #{e}"
end
api_instance = Notifo::UserApi.new
opts = {
language: 'language_example' # String | The optional language.
}
begin
#Query the user topics.
result = api_instance.user_get_topics(opts)
p result
rescue Notifo::ApiError => e
puts "Exception when calling UserApi->user_get_topics: #{e}"
end
api_instance = Notifo::UserApi.new
begin
#Get the current user.
result = api_instance.user_get_user
p result
rescue Notifo::ApiError => e
puts "Exception when calling UserApi->user_get_user: #{e}"
end
api_instance = Notifo::UserApi.new
body = Notifo::SubscribeManyDto.new # SubscribeManyDto | The subscription settings.
begin
#Upserts or deletes my subscriptions.
api_instance.user_post_my_subscriptions(body)
rescue Notifo::ApiError => e
puts "Exception when calling UserApi->user_post_my_subscriptions: #{e}"
end
api_instance = Notifo::UserApi.new
body = Notifo::UpdateProfileDto.new # UpdateProfileDto | The upsert request.
begin
#Update the user.
result = api_instance.user_post_user(body)
p result
rescue Notifo::ApiError => e
puts "Exception when calling UserApi->user_post_user: #{e}"
end
api_instance = Notifo::UsersApi.new
app_id = 'app_id_example' # String | The app where the users belong to.
id = 'id_example' # String | The user ID.
prefix = 'prefix_example' # String | The topic prefix.
begin
#Remove an allowed topic.
api_instance.users_delete_allowed_topic(app_id, id, prefix)
rescue Notifo::ApiError => e
puts "Exception when calling UsersApi->users_delete_allowed_topic: #{e}"
end
api_instance = Notifo::UsersApi.new
app_id = 'app_id_example' # String | The app where the users belong to.
id = 'id_example' # String | The user ID.
token = 'token_example' # String | The token.
begin
#Remove an web push token.
api_instance.users_delete_mobile_push_token(app_id, id, token)
rescue Notifo::ApiError => e
puts "Exception when calling UsersApi->users_delete_mobile_push_token: #{e}"
end
api_instance = Notifo::UsersApi.new
app_id = 'app_id_example' # String | The app where the user belongs to.
id = 'id_example' # String | The user ID.
prefix = 'prefix_example' # String | The topic prefix.
begin
#Unsubscribes a user from a subscription.
api_instance.users_delete_subscription(app_id, id, prefix)
rescue Notifo::ApiError => e
puts "Exception when calling UsersApi->users_delete_subscription: #{e}"
end
api_instance = Notifo::UsersApi.new
app_id = 'app_id_example' # String | The app where the users belongs to.
id = 'id_example' # String | The user id to delete.
begin
#Delete a user.
api_instance.users_delete_user(app_id, id)
rescue Notifo::ApiError => e
puts "Exception when calling UsersApi->users_delete_user: #{e}"
end
api_instance = Notifo::UsersApi.new
app_id = 'app_id_example' # String | The app where the users belong to.
id = 'id_example' # String | The user ID.
endpoint = 'endpoint_example' # String | The endpoint.
begin
#Remove an web push subscription.
api_instance.users_delete_web_push_subscription(app_id, id, endpoint)
rescue Notifo::ApiError => e
puts "Exception when calling UsersApi->users_delete_web_push_subscription: #{e}"
end
api_instance = Notifo::UsersApi.new
app_id = 'app_id_example' # String | The app where the user belongs to.
id = 'id_example' # String | The user ID.
opts = {
query: 'query_example', # String | The optional query to search for items.
take: 56, # Integer | The number of items to return.
skip: 56 # Integer | The number of items to skip.
}
begin
#Query user subscriptions.
result = api_instance.users_get_subscriptions(app_id, id, opts)
p result
rescue Notifo::ApiError => e
puts "Exception when calling UsersApi->users_get_subscriptions: #{e}"
end
api_instance = Notifo::UsersApi.new
app_id = 'app_id_example' # String | The app where the user belongs to.
id = 'id_example' # String | The user ID.
opts = {
with_details: false # BOOLEAN | Provide extra details, might be expensive.
}
begin
#Get a user.
result = api_instance.users_get_user(app_id, id, opts)
p result
rescue Notifo::ApiError => e
puts "Exception when calling UsersApi->users_get_user: #{e}"
end
api_instance = Notifo::UsersApi.new
app_id = 'app_id_example' # String | The app where the users belongs to.
opts = {
query: 'query_example', # String | The optional query to search for items.
take: 56, # Integer | The number of items to return.
skip: 56, # Integer | The number of items to skip.
with_details: false # BOOLEAN | Provide extra details, might be expensive.
}
begin
#Query users.
result = api_instance.users_get_users(app_id, opts)
p result
rescue Notifo::ApiError => e
puts "Exception when calling UsersApi->users_get_users: #{e}"
end
api_instance = Notifo::UsersApi.new
body = Notifo::AddAllowedTopicDto.new # AddAllowedTopicDto | The upsert request.
app_id = 'app_id_example' # String | The app where the users belong to.
id = 'id_example' # String | The user ID.
begin
#Add an allowed topic.
api_instance.users_post_allowed_topic(body, app_id, id)
rescue Notifo::ApiError => e
puts "Exception when calling UsersApi->users_post_allowed_topic: #{e}"
end
api_instance = Notifo::UsersApi.new
body = Notifo::SubscribeManyDto.new # SubscribeManyDto | The subscription object.
app_id = 'app_id_example' # String | The app where the user belongs to.
id = 'id_example' # String | The user ID.
begin
#Upserts or deletes multiple user subscriptions.
api_instance.users_post_subscriptions(body, app_id, id)
rescue Notifo::ApiError => e
puts "Exception when calling UsersApi->users_post_subscriptions: #{e}"
end
api_instance = Notifo::UsersApi.new
body = Notifo::UpsertUsersDto.new # UpsertUsersDto | The upsert request.
app_id = 'app_id_example' # String | The app where the users belong to.
begin
#Upsert users.
result = api_instance.users_post_users(body, app_id)
p result
rescue Notifo::ApiError => e
puts "Exception when calling UsersApi->users_post_users: #{e}"
end
Documentation for API Endpoints
All URIs are relative to https://notifo-dev.easierlife.com
Class | Method | HTTP request | Description |
---|---|---|---|
Notifo::AppsApi | apps_delete_contributor | POST /api/apps/appId/contributors/contributorId | Delete an app contributor. |
Notifo::AppsApi | apps_delete_integration | DELETE /api/apps/appId/integrations/id | Delete an app integration. |
Notifo::AppsApi | apps_get_app | GET /api/apps/appId | Get app by id. |
Notifo::AppsApi | apps_get_apps | GET /api/apps | Get the user apps. |
Notifo::AppsApi | apps_get_integrations | GET /api/apps/appId/integrations | Get the app integrations. |
Notifo::AppsApi | apps_post_app | POST /api/apps | Create an app. |
Notifo::AppsApi | apps_post_contributor | POST /api/apps/appId/contributors | Add an app contributor. |
Notifo::AppsApi | apps_post_integration | POST /api/apps/appId/integration | Create an app integrations. |
Notifo::AppsApi | apps_put_app | POST /api/apps/appId | Update an app. |
Notifo::AppsApi | apps_put_integration | PUT /api/apps/appId/integrations/id | Update an app integration. |
Notifo::ConfigsApi | configs_get_languages | GET /api/languages | Get all supported languages. |
Notifo::ConfigsApi | configs_get_timezones | GET /api/timezones | Get all supported timezones. |
Notifo::DiagnosticsApi | diagnostics_get_dump | GET /api/diagnostics/dump | Creates a dump and writes it into storage.. |
Notifo::DiagnosticsApi | diagnostics_get_gc_dump | GET /api/diagnostics/gcdump | Creates a gc dump and writes it into storage. |
Notifo::EmailTemplatesApi | email_template_preview_get_preview | GET /api/apps/appId/email-templates/id/preview | Get the HTML preview for a channel template. |
Notifo::EmailTemplatesApi | email_template_preview_post_preview | POST /api/apps/appId/email-templates/render | Render a preview for a email template. |
Notifo::EmailTemplatesApi | email_templates_delete_template | DELETE /api/apps/appId/email-templates/code | Delete a channel template. |
Notifo::EmailTemplatesApi | email_templates_delete_template_language | DELETE /api/apps/appId/email-templates/code/language | Delete a language channel template. |
Notifo::EmailTemplatesApi | email_templates_get_template | GET /api/apps/appId/email-templates/id | Get the channel template by id. |
Notifo::EmailTemplatesApi | email_templates_get_templates | GET /api/apps/appId/email-templates | Get the channel templates. |
Notifo::EmailTemplatesApi | email_templates_post_template | POST /api/apps/appId/email-templates | Create a channel template. |
Notifo::EmailTemplatesApi | email_templates_post_template_language | POST /api/apps/appId/email-templates/code | Create an app template language. |
Notifo::EmailTemplatesApi | email_templates_put_template | PUT /api/apps/appId/email-templates/code | Update an app template. |
Notifo::EmailTemplatesApi | email_templates_put_template_language | PUT /api/apps/appId/email-templates/code/language | Update a channel template language. |
Notifo::EventsApi | events_get_events | GET /api/apps/appId/events | Query events. |
Notifo::EventsApi | events_post_events | POST /api/apps/appId/events | Publish events. |
Notifo::EventsApi | events_post_my_events | POST /api/me/events | Publish an event for the current user. |
Notifo::LogsApi | logs_get_logs | GET /api/apps/appId/logs | Query log entries. |
Notifo::MediaApi | media_delete | DELETE /api/apps/appId/media/fileName | Delete a media. |
Notifo::MediaApi | media_download | GET /api/apps/appId/media/fileName | Download a media object. |
Notifo::MediaApi | media_download2 | GET /api/asset/appId/fileName | Download a media object. |
Notifo::MediaApi | media_download3 | GET /api/assets/appId/fileName | Download a media object. |
Notifo::MediaApi | media_get_medias | GET /api/apps/appId/media | Query media items. |
Notifo::MediaApi | media_proxy_proxy_image | GET /api/assets/proxy | Download a media object. |
Notifo::MediaApi | media_upload | POST /api/apps/appId/media | Upload a media object. |
Notifo::MessagingTemplatesApi | messaging_templates_delete_template | DELETE /api/apps/appId/messaging-templates/code | Delete a channel template. |
Notifo::MessagingTemplatesApi | messaging_templates_delete_template_language | DELETE /api/apps/appId/messaging-templates/code/language | Delete a language channel template. |
Notifo::MessagingTemplatesApi | messaging_templates_get_template | GET /api/apps/appId/messaging-templates/id | Get the channel template by id. |
Notifo::MessagingTemplatesApi | messaging_templates_get_templates | GET /api/apps/appId/messaging-templates | Get the channel templates. |
Notifo::MessagingTemplatesApi | messaging_templates_post_template | POST /api/apps/appId/messaging-templates | Create a channel template. |
Notifo::MessagingTemplatesApi | messaging_templates_post_template_language | POST /api/apps/appId/messaging-templates/code | Create an app template language. |
Notifo::MessagingTemplatesApi | messaging_templates_put_template | PUT /api/apps/appId/messaging-templates/code | Update an app template. |
Notifo::MessagingTemplatesApi | messaging_templates_put_template_language | PUT /api/apps/appId/messaging-templates/code/language | Update a channel template language. |
Notifo::MobilePushApi | mobile_push_delete_my_token | DELETE /api/me/mobilepush/token | Deletes a mobile push token for the current user. |
Notifo::MobilePushApi | mobile_push_get_my_token | GET /api/me/mobilepush | Returns the mobile push tokens. |
Notifo::MobilePushApi | mobile_push_post_my_token | POST /api/me/mobilepush | Register a mobile push token for the current user. |
Notifo::NotificationsApi | notifications_confirm_me | POST /api/me/notifications/handled | Confirms the user notifications for the current user. |
Notifo::NotificationsApi | notifications_get_all_notifications | GET /api/apps/appId/notifications | Query notifications. |
Notifo::NotificationsApi | notifications_get_my_archive | GET /api/me/notifications/archive | Query archived user notifications of the current user. |
Notifo::NotificationsApi | notifications_get_my_device_notifications | GET /api/me/notifications/device | Query user notifications of the current user for a specific device. |
Notifo::NotificationsApi | notifications_get_my_notifications | GET /api/me/notifications | Query user notifications of the current user. |
Notifo::NotificationsApi | notifications_get_notifications | GET /api/apps/appId/users/id/notifications | Query user notifications. |
Notifo::PingApi | ping_get_info | GET /api/info | Get some info about the API. |
Notifo::PingApi | ping_get_old_ping | GET /ping | Get ping status of the API. |
Notifo::PingApi | ping_get_ping | GET /api/ping | Get ping status of the API. |
Notifo::SmsTemplatesApi | sms_templates_delete_template | DELETE /api/apps/appId/sms-templates/code | Delete a channel template. |
Notifo::SmsTemplatesApi | sms_templates_delete_template_language | DELETE /api/apps/appId/sms-templates/code/language | Delete a language channel template. |
Notifo::SmsTemplatesApi | sms_templates_get_template | GET /api/apps/appId/sms-templates/id | Get the channel template by id. |
Notifo::SmsTemplatesApi | sms_templates_get_templates | GET /api/apps/appId/sms-templates | Get the channel templates. |
Notifo::SmsTemplatesApi | sms_templates_post_template | POST /api/apps/appId/sms-templates | Create a channel template. |
Notifo::SmsTemplatesApi | sms_templates_post_template_language | POST /api/apps/appId/sms-templates/code | Create an app template language. |
Notifo::SmsTemplatesApi | sms_templates_put_template | PUT /api/apps/appId/sms-templates/code | Update an app template. |
Notifo::SmsTemplatesApi | sms_templates_put_template_language | PUT /api/apps/appId/sms-templates/code/language | Update a channel template language. |
Notifo::SystemUsersApi | system_users_delete_user | DELETE /api/system-users/id | Delete the user. |
Notifo::SystemUsersApi | system_users_get_user | GET /api/system-users/id | Get a user. |
Notifo::SystemUsersApi | system_users_get_users | GET /api/system-users | Query users. |
Notifo::SystemUsersApi | system_users_lock_user | PUT /api/system-users/id/lock | Lock the user. |
Notifo::SystemUsersApi | system_users_post_user | POST /api/system-users | Create a user. |
Notifo::SystemUsersApi | system_users_put_user | PUT /api/system-users/id | Update the user. |
Notifo::SystemUsersApi | system_users_unlock_user | PUT /api/system-users/id/unlock | Unlock the user. |
Notifo::TemplatesApi | templates_delete_template | DELETE /api/apps/appId/templates/code | Delete a template. |
Notifo::TemplatesApi | templates_get_templates | GET /api/apps/appId/templates | Query templates. |
Notifo::TemplatesApi | templates_post_templates | POST /api/apps/appId/templates | Upsert templates. |
Notifo::TopicsApi | topics_delete_topic | DELETE /api/apps/appId/topics/path | Delete a topic. |
Notifo::TopicsApi | topics_get_topics | GET /api/apps/appId/topics | Query topics. |
Notifo::TopicsApi | topics_post_topics | POST /api/apps/appId/topics | Upsert topics. |
Notifo::UserApi | user_delete_subscription | POST /api/me/subscriptions/prefix | Remove my subscription. |
Notifo::UserApi | user_get_admin_user | GET /api/me/admin | Get the current admin user. |
Notifo::UserApi | user_get_my_subscription | GET /api/me/subscriptions/topic | Gets a user subscription. |
Notifo::UserApi | user_get_my_subscriptions | GET /api/me/subscriptions | Query the user subscriptions. |
Notifo::UserApi | user_get_topics | GET /api/me/topics | Query the user topics. |
Notifo::UserApi | user_get_user | GET /api/me | Get the current user. |
Notifo::UserApi | user_post_my_subscriptions | POST /api/me/subscriptions | Upserts or deletes my subscriptions. |
Notifo::UserApi | user_post_user | POST /api/me | Update the user. |
Notifo::UsersApi | users_delete_allowed_topic | DELETE /api/apps/appId/users/id/allowed-topics/prefix | Remove an allowed topic. |
Notifo::UsersApi | users_delete_mobile_push_token | DELETE /api/apps/appId/users/id/mobilepush/token | Remove an web push token. |
Notifo::UsersApi | users_delete_subscription | DELETE /api/apps/appId/users/id/subscriptions/prefix | Unsubscribes a user from a subscription. |
Notifo::UsersApi | users_delete_user | DELETE /api/apps/appId/users/id | Delete a user. |
Notifo::UsersApi | users_delete_web_push_subscription | DELETE /api/apps/appId/users/id/webpush/endpoint | Remove an web push subscription. |
Notifo::UsersApi | users_get_subscriptions | GET /api/apps/appId/users/id/subscriptions | Query user subscriptions. |
Notifo::UsersApi | users_get_user | GET /api/apps/appId/users/id | Get a user. |
Notifo::UsersApi | users_get_users | GET /api/apps/appId/users | Query users. |
Notifo::UsersApi | users_post_allowed_topic | POST /api/apps/appId/users/id/allowed-topics | Add an allowed topic. |
Notifo::UsersApi | users_post_subscriptions | POST /api/apps/appId/users/id/subscriptions | Upserts or deletes multiple user subscriptions. |
Notifo::UsersApi | users_post_users | POST /api/apps/appId/users | Upsert users. |
Documentation for Models
- Notifo::AddAllowedTopicDto
- Notifo::AddContributorDto
- Notifo::AdminProfileDto
- Notifo::AppContributorDto
- Notifo::AppDetailsDto
- Notifo::AppDto
- Notifo::AppIdMediaBody
- Notifo::ChannelCondition
- Notifo::ChannelSend
- Notifo::ChannelSendInfoDto
- Notifo::ChannelSettingDto
- Notifo::ChannelTemplateDetailsDtoOfEmailTemplateDto
- Notifo::ChannelTemplateDetailsDtoOfMessagingTemplateDto
- Notifo::ChannelTemplateDetailsDtoOfSmsTemplateDto
- Notifo::ChannelTemplateDto
- Notifo::ConfiguredIntegrationDto
- Notifo::ConfiguredIntegrationsDto
- Notifo::ConfirmMode
- Notifo::CreateChannelTemplateDto
- Notifo::CreateChannelTemplateLanguageDto
- Notifo::CreateIntegrationDto
- Notifo::CreateSystemUserDto
- Notifo::EmailFormattingError
- Notifo::EmailPreviewDto
- Notifo::EmailPreviewRequestDto
- Notifo::EmailPreviewType
- Notifo::EmailTemplateDto
- Notifo::EmailTemplateType
- Notifo::ErrorDto
- Notifo::EventDto
- Notifo::HandledInfoDto
- Notifo::InfoDto
- Notifo::IntegrationCreatedDto
- Notifo::IntegrationDefinitionDto
- Notifo::IntegrationPropertyDto
- Notifo::IntegrationStatus
- Notifo::IsoDayOfWeek
- Notifo::ListResponseDtoOfChannelTemplateDto
- Notifo::ListResponseDtoOfEventDto
- Notifo::ListResponseDtoOfLogEntryDto
- Notifo::ListResponseDtoOfMediaDto
- Notifo::ListResponseDtoOfMobilePushTokenDto
- Notifo::ListResponseDtoOfSubscriptionDto
- Notifo::ListResponseDtoOfSystemUserDto
- Notifo::ListResponseDtoOfTemplateDto
- Notifo::ListResponseDtoOfTopicDto
- Notifo::ListResponseDtoOfUserDto
- Notifo::ListResponseDtoOfUserNotificationDetailsDto
- Notifo::ListResponseDtoOfUserNotificationDto
- Notifo::LocalizedText
- Notifo::LogEntryDto
- Notifo::MediaDto
- Notifo::MediaMetadata
- Notifo::MediaType
- Notifo::MessagingTemplateDto
- Notifo::MobileDeviceType
- Notifo::MobilePushTokenDto
- Notifo::MobilePushTokenDto2
- Notifo::NotificationFormattingDto
- Notifo::NotificationProperties
- Notifo::ProcessStatus
- Notifo::ProfileDto
- Notifo::PropertyType
- Notifo::PublishDto
- Notifo::PublishManyDto
- Notifo::RegisterMobileTokenDto
- Notifo::ResizeMode
- Notifo::SchedulingDto
- Notifo::SchedulingType
- Notifo::SendConfiguration
- Notifo::SmsTemplateDto
- Notifo::SubscribeDto
- Notifo::SubscribeManyDto
- Notifo::SubscriptionDto
- Notifo::SystemUserDto
- Notifo::TemplateDto
- Notifo::TopicChannel
- Notifo::TopicDto
- Notifo::TopicQueryScope
- Notifo::TrackNotificationDto
- Notifo::UpdateChannelTemplateDtoOfEmailTemplateDto
- Notifo::UpdateChannelTemplateDtoOfMessagingTemplateDto
- Notifo::UpdateChannelTemplateDtoOfSmsTemplateDto
- Notifo::UpdateIntegrationDto
- Notifo::UpdateProfileDto
- Notifo::UpdateSystemUserDto
- Notifo::UpsertAppDto
- Notifo::UpsertTemplateDto
- Notifo::UpsertTemplatesDto
- Notifo::UpsertTopicDto
- Notifo::UpsertTopicsDto
- Notifo::UpsertUserDto
- Notifo::UpsertUsersDto
- Notifo::UserDto
- Notifo::UserNotificationBaseDto
- Notifo::UserNotificationChannelDto
- Notifo::UserNotificationDetailsDto
- Notifo::UserNotificationDto
- Notifo::UserPropertyDto
- Notifo::UserTopicDto
- Notifo::WebPushSubscriptionDto
Documentation for Authorization
All endpoints do not require authorization.