notifo-io-easierlife 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/README.md +167 -0
- data/Rakefile +10 -0
- data/docs/AddAllowedTopicDto.md +18 -0
- data/docs/AddContributorDto.md +20 -0
- data/docs/AppContributorDto.md +22 -0
- data/docs/AppDetailsDto.md +48 -0
- data/docs/AppDto.md +28 -0
- data/docs/AppsApi.md +646 -0
- data/docs/ConfigsApi.md +127 -0
- data/docs/ConfirmMode.md +15 -0
- data/docs/CreateEmailTemplateDto.md +18 -0
- data/docs/EmailTemplateDto.md +22 -0
- data/docs/EmailVerificationStatus.md +15 -0
- data/docs/ErrorDto.md +26 -0
- data/docs/EventDto.md +40 -0
- data/docs/EventsApi.md +142 -0
- data/docs/IsoDayOfWeek.md +15 -0
- data/docs/ListResponseDtoOfEventDto.md +20 -0
- data/docs/ListResponseDtoOfLogEntryDto.md +20 -0
- data/docs/ListResponseDtoOfMediaDto.md +20 -0
- data/docs/ListResponseDtoOfSubscriptionDto.md +20 -0
- data/docs/ListResponseDtoOfTemplateDto.md +20 -0
- data/docs/ListResponseDtoOfTopicDto.md +20 -0
- data/docs/ListResponseDtoOfUserDto.md +20 -0
- data/docs/LogEntryDto.md +24 -0
- data/docs/LogsApi.md +78 -0
- data/docs/MediaApi.md +382 -0
- data/docs/MediaDto.md +30 -0
- data/docs/MediaType.md +15 -0
- data/docs/NotificationFormattingDto.md +32 -0
- data/docs/NotificationSend.md +15 -0
- data/docs/NotificationSettingDto.md +20 -0
- data/docs/ProfileDto.md +32 -0
- data/docs/PublishDto.md +36 -0
- data/docs/PublishManyDto.md +18 -0
- data/docs/ResizeMode.md +15 -0
- data/docs/SchedulingDto.md +24 -0
- data/docs/SchedulingType.md +15 -0
- data/docs/SubscriptionDto.md +20 -0
- data/docs/TemplateDto.md +22 -0
- data/docs/TemplatesApi.md +208 -0
- data/docs/TopicDto.md +22 -0
- data/docs/TopicsApi.md +78 -0
- data/docs/UpdateProfileDto.md +28 -0
- data/docs/UpsertAppDto.md +36 -0
- data/docs/UpsertTemplateDto.md +22 -0
- data/docs/UpsertTemplatesDto.md +18 -0
- data/docs/UpsertUserDto.md +32 -0
- data/docs/UpsertUsersDto.md +18 -0
- data/docs/UserApi.md +323 -0
- data/docs/UserDto.md +36 -0
- data/docs/UsersApi.md +610 -0
- data/git_push.sh +58 -0
- data/lib/notifo.rb +89 -0
- data/lib/notifo/api/apps_api.rb +678 -0
- data/lib/notifo/api/configs_api.rb +132 -0
- data/lib/notifo/api/events_api.rb +161 -0
- data/lib/notifo/api/logs_api.rb +92 -0
- data/lib/notifo/api/media_api.rb +419 -0
- data/lib/notifo/api/templates_api.rb +228 -0
- data/lib/notifo/api/topics_api.rb +92 -0
- data/lib/notifo/api/user_api.rb +331 -0
- data/lib/notifo/api/users_api.rb +667 -0
- data/lib/notifo/api_client.rb +389 -0
- data/lib/notifo/api_error.rb +57 -0
- data/lib/notifo/configuration.rb +270 -0
- data/lib/notifo/models/add_allowed_topic_dto.rb +243 -0
- data/lib/notifo/models/add_contributor_dto.rb +277 -0
- data/lib/notifo/models/app_contributor_dto.rb +311 -0
- data/lib/notifo/models/app_details_dto.rb +489 -0
- data/lib/notifo/models/app_dto.rb +362 -0
- data/lib/notifo/models/confirm_mode.rb +38 -0
- data/lib/notifo/models/create_email_template_dto.rb +243 -0
- data/lib/notifo/models/email_template_dto.rb +288 -0
- data/lib/notifo/models/email_verification_status.rb +39 -0
- data/lib/notifo/models/error_dto.rb +265 -0
- data/lib/notifo/models/event_dto.rb +456 -0
- data/lib/notifo/models/iso_day_of_week.rb +43 -0
- data/lib/notifo/models/list_response_dto_of_event_dto.rb +241 -0
- data/lib/notifo/models/list_response_dto_of_log_entry_dto.rb +241 -0
- data/lib/notifo/models/list_response_dto_of_media_dto.rb +241 -0
- data/lib/notifo/models/list_response_dto_of_subscription_dto.rb +241 -0
- data/lib/notifo/models/list_response_dto_of_template_dto.rb +241 -0
- data/lib/notifo/models/list_response_dto_of_topic_dto.rb +241 -0
- data/lib/notifo/models/list_response_dto_of_user_dto.rb +241 -0
- data/lib/notifo/models/log_entry_dto.rb +326 -0
- data/lib/notifo/models/media_dto.rb +390 -0
- data/lib/notifo/models/media_type.rb +39 -0
- data/lib/notifo/models/notification_formatting_dto.rb +305 -0
- data/lib/notifo/models/notification_send.rb +39 -0
- data/lib/notifo/models/notification_setting_dto.rb +234 -0
- data/lib/notifo/models/profile_dto.rb +361 -0
- data/lib/notifo/models/publish_dto.rb +338 -0
- data/lib/notifo/models/publish_many_dto.rb +226 -0
- data/lib/notifo/models/resize_mode.rb +42 -0
- data/lib/notifo/models/scheduling_dto.rb +248 -0
- data/lib/notifo/models/scheduling_type.rb +37 -0
- data/lib/notifo/models/subscription_dto.rb +256 -0
- data/lib/notifo/models/template_dto.rb +274 -0
- data/lib/notifo/models/topic_dto.rb +294 -0
- data/lib/notifo/models/update_profile_dto.rb +277 -0
- data/lib/notifo/models/upsert_app_dto.rb +321 -0
- data/lib/notifo/models/upsert_template_dto.rb +270 -0
- data/lib/notifo/models/upsert_templates_dto.rb +226 -0
- data/lib/notifo/models/upsert_user_dto.rb +299 -0
- data/lib/notifo/models/upsert_users_dto.rb +226 -0
- data/lib/notifo/models/user_dto.rb +381 -0
- data/lib/notifo/version.rb +15 -0
- data/notifo-io-1.0.0.gem +0 -0
- data/notifo.gemspec +38 -0
- data/spec/api/apps_api_spec.rb +151 -0
- data/spec/api/configs_api_spec.rb +55 -0
- data/spec/api/events_api_spec.rb +61 -0
- data/spec/api/logs_api_spec.rb +49 -0
- data/spec/api/media_api_spec.rb +117 -0
- data/spec/api/templates_api_spec.rb +73 -0
- data/spec/api/topics_api_spec.rb +49 -0
- data/spec/api/user_api_spec.rb +92 -0
- data/spec/api/users_api_spec.rb +152 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/add_allowed_topic_dto_spec.rb +34 -0
- data/spec/models/add_contributor_dto_spec.rb +40 -0
- data/spec/models/app_contributor_dto_spec.rb +46 -0
- data/spec/models/app_details_dto_spec.rb +124 -0
- data/spec/models/app_dto_spec.rb +64 -0
- data/spec/models/confirm_mode_spec.rb +28 -0
- data/spec/models/create_email_template_dto_spec.rb +34 -0
- data/spec/models/email_template_dto_spec.rb +46 -0
- data/spec/models/email_verification_status_spec.rb +28 -0
- data/spec/models/error_dto_spec.rb +58 -0
- data/spec/models/event_dto_spec.rb +100 -0
- data/spec/models/iso_day_of_week_spec.rb +28 -0
- data/spec/models/list_response_dto_of_event_dto_spec.rb +40 -0
- data/spec/models/list_response_dto_of_log_entry_dto_spec.rb +40 -0
- data/spec/models/list_response_dto_of_media_dto_spec.rb +40 -0
- data/spec/models/list_response_dto_of_subscription_dto_spec.rb +40 -0
- data/spec/models/list_response_dto_of_template_dto_spec.rb +40 -0
- data/spec/models/list_response_dto_of_topic_dto_spec.rb +40 -0
- data/spec/models/list_response_dto_of_user_dto_spec.rb +40 -0
- data/spec/models/log_entry_dto_spec.rb +52 -0
- data/spec/models/media_dto_spec.rb +70 -0
- data/spec/models/media_type_spec.rb +28 -0
- data/spec/models/notification_formatting_dto_spec.rb +76 -0
- data/spec/models/notification_send_spec.rb +28 -0
- data/spec/models/notification_setting_dto_spec.rb +40 -0
- data/spec/models/profile_dto_spec.rb +76 -0
- data/spec/models/publish_dto_spec.rb +88 -0
- data/spec/models/publish_many_dto_spec.rb +34 -0
- data/spec/models/resize_mode_spec.rb +28 -0
- data/spec/models/scheduling_dto_spec.rb +52 -0
- data/spec/models/scheduling_type_spec.rb +28 -0
- data/spec/models/subscription_dto_spec.rb +40 -0
- data/spec/models/template_dto_spec.rb +46 -0
- data/spec/models/topic_dto_spec.rb +46 -0
- data/spec/models/update_profile_dto_spec.rb +64 -0
- data/spec/models/upsert_app_dto_spec.rb +88 -0
- data/spec/models/upsert_template_dto_spec.rb +46 -0
- data/spec/models/upsert_templates_dto_spec.rb +34 -0
- data/spec/models/upsert_user_dto_spec.rb +76 -0
- data/spec/models/upsert_users_dto_spec.rb +34 -0
- data/spec/models/user_dto_spec.rb +88 -0
- data/spec/spec_helper.rb +111 -0
- metadata +301 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: 07ea8ed9c102cd9686de9cbab7db56b11fc27dab5d3f75183c2d3d2bd9038f80
|
4
|
+
data.tar.gz: ba1d1e39a2118c9c99cac10a604e452e236ff4101d4fb5ad8398ea367d881310
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 7fa790a4237a2cc1419864ba6254acbe9910412e34d2c25e24db37a596139383a0d5664133636d3bafa98d50f9f5e31db3f1ce8a0cbe5c3597a1ed5cf5acac4d
|
7
|
+
data.tar.gz: d97cf48b25b25ad7308941a6b3c021e694b87a7f741a5cf852b61ff964d0985c8b4a8b73bb00507a1f0176d27fff49f779164c951149ee51b29970ae945b93b0
|
data/Gemfile
ADDED
data/README.md
ADDED
@@ -0,0 +1,167 @@
|
|
1
|
+
# notifo
|
2
|
+
|
3
|
+
Notifo - the Ruby gem for the Notifo API
|
4
|
+
|
5
|
+
No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
|
6
|
+
|
7
|
+
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
|
+
|
9
|
+
- API version: 1.0.0
|
10
|
+
- Package version: 1.0.0
|
11
|
+
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
|
+
|
13
|
+
## Installation
|
14
|
+
|
15
|
+
### Build a gem
|
16
|
+
|
17
|
+
To build the Ruby code into a gem:
|
18
|
+
|
19
|
+
```shell
|
20
|
+
gem build notifo.gemspec
|
21
|
+
```
|
22
|
+
|
23
|
+
Then either install the gem locally:
|
24
|
+
|
25
|
+
```shell
|
26
|
+
gem install ./notifo-1.0.0.gem
|
27
|
+
```
|
28
|
+
|
29
|
+
(for development, run `gem install --dev ./notifo-1.0.0.gem` to install the development dependencies)
|
30
|
+
|
31
|
+
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
32
|
+
|
33
|
+
Finally add this to the Gemfile:
|
34
|
+
|
35
|
+
gem 'notifo', '~> 1.0.0'
|
36
|
+
|
37
|
+
### Install from Git
|
38
|
+
|
39
|
+
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:
|
40
|
+
|
41
|
+
gem 'notifo', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
|
42
|
+
|
43
|
+
### Include the Ruby code directly
|
44
|
+
|
45
|
+
Include the Ruby code directly using `-I` as follows:
|
46
|
+
|
47
|
+
```shell
|
48
|
+
ruby -Ilib script.rb
|
49
|
+
```
|
50
|
+
|
51
|
+
## Getting Started
|
52
|
+
|
53
|
+
Please follow the [installation](#installation) procedure and then run the following code:
|
54
|
+
|
55
|
+
```ruby
|
56
|
+
# Load the gem
|
57
|
+
require 'notifo'
|
58
|
+
|
59
|
+
api_instance = Notifo::AppsApi.new
|
60
|
+
app_id = 'app_id_example' # String | The id of the app.
|
61
|
+
contributor_id = 'contributor_id_example' # String | The contributor to remove.
|
62
|
+
|
63
|
+
begin
|
64
|
+
#Delete an app contributor.
|
65
|
+
result = api_instance.apps_delete_contributor(app_id, contributor_id)
|
66
|
+
p result
|
67
|
+
rescue Notifo::ApiError => e
|
68
|
+
puts "Exception when calling AppsApi->apps_delete_contributor: #{e}"
|
69
|
+
end
|
70
|
+
|
71
|
+
```
|
72
|
+
|
73
|
+
## Documentation for API Endpoints
|
74
|
+
|
75
|
+
All URIs are relative to *https://notifo.easierlife.com*
|
76
|
+
|
77
|
+
Class | Method | HTTP request | Description
|
78
|
+
------------ | ------------- | ------------- | -------------
|
79
|
+
*Notifo::AppsApi* | [**apps_delete_contributor**](docs/AppsApi.md#apps_delete_contributor) | **POST** /api/apps/{appId}/contributors/{contributorId} | Delete an app contributor.
|
80
|
+
*Notifo::AppsApi* | [**apps_delete_email_template**](docs/AppsApi.md#apps_delete_email_template) | **POST** /api/apps/{appId}/email-templates/{language} | Delete an app email template.
|
81
|
+
*Notifo::AppsApi* | [**apps_get_app**](docs/AppsApi.md#apps_get_app) | **GET** /api/apps/{appId} | Get app by id.
|
82
|
+
*Notifo::AppsApi* | [**apps_get_apps**](docs/AppsApi.md#apps_get_apps) | **GET** /api/apps | Get the user apps.
|
83
|
+
*Notifo::AppsApi* | [**apps_get_email_templates**](docs/AppsApi.md#apps_get_email_templates) | **GET** /api/apps/{appId}/email-templates | Get the app email templates.
|
84
|
+
*Notifo::AppsApi* | [**apps_post_app**](docs/AppsApi.md#apps_post_app) | **POST** /api/apps | Create an app.
|
85
|
+
*Notifo::AppsApi* | [**apps_post_contributor**](docs/AppsApi.md#apps_post_contributor) | **POST** /api/apps/{appId}/contributors | Add an app contributor.
|
86
|
+
*Notifo::AppsApi* | [**apps_post_email_template**](docs/AppsApi.md#apps_post_email_template) | **POST** /api/apps/{appId}/email-templates | Create an app email template.
|
87
|
+
*Notifo::AppsApi* | [**apps_put_app**](docs/AppsApi.md#apps_put_app) | **POST** /api/apps/{appId} | Update an app.
|
88
|
+
*Notifo::AppsApi* | [**apps_put_email_template**](docs/AppsApi.md#apps_put_email_template) | **PUT** /api/apps/{appId}/email-templates/{language} | Update an app email template.
|
89
|
+
*Notifo::ConfigsApi* | [**configs_get_languages**](docs/ConfigsApi.md#configs_get_languages) | **GET** /api/languages | Get all supported languages.
|
90
|
+
*Notifo::ConfigsApi* | [**configs_get_timezones**](docs/ConfigsApi.md#configs_get_timezones) | **GET** /api/timezones | Get all supported timezones.
|
91
|
+
*Notifo::EventsApi* | [**events_get_events**](docs/EventsApi.md#events_get_events) | **GET** /api/apps/{appId}/events | Query events.
|
92
|
+
*Notifo::EventsApi* | [**events_post_events**](docs/EventsApi.md#events_post_events) | **POST** /api/apps/{appId}/events | Publish events.
|
93
|
+
*Notifo::LogsApi* | [**logs_get_logs**](docs/LogsApi.md#logs_get_logs) | **GET** /api/apps/{appId}/logs | Query log entries.
|
94
|
+
*Notifo::MediaApi* | [**media_delete**](docs/MediaApi.md#media_delete) | **DELETE** /api/apps/{appId}/media/{fileName} | Delete a media.
|
95
|
+
*Notifo::MediaApi* | [**media_download**](docs/MediaApi.md#media_download) | **GET** /api/apps/{appId}/media/{fileName} | Download a media object.
|
96
|
+
*Notifo::MediaApi* | [**media_download2**](docs/MediaApi.md#media_download2) | **GET** /api/assets/{appId}/{fileName} | Download a media object.
|
97
|
+
*Notifo::MediaApi* | [**media_get_medias**](docs/MediaApi.md#media_get_medias) | **GET** /api/apps/{appId}/media | Query media items.
|
98
|
+
*Notifo::MediaApi* | [**media_upload**](docs/MediaApi.md#media_upload) | **POST** /api/apps/{appId}/media | Upload a media object.
|
99
|
+
*Notifo::TemplatesApi* | [**templates_delete_template**](docs/TemplatesApi.md#templates_delete_template) | **DELETE** /api/apps/{appId}/templates/{code} | Delete a template.
|
100
|
+
*Notifo::TemplatesApi* | [**templates_get_templates**](docs/TemplatesApi.md#templates_get_templates) | **GET** /api/apps/{appId}/templates | Query templates.
|
101
|
+
*Notifo::TemplatesApi* | [**templates_post_templates**](docs/TemplatesApi.md#templates_post_templates) | **POST** /api/apps/{appId}/templates | Upsert templates.
|
102
|
+
*Notifo::TopicsApi* | [**topics_get_topics**](docs/TopicsApi.md#topics_get_topics) | **GET** /api/apps/{appId}/topics | Query topics.
|
103
|
+
*Notifo::UserApi* | [**user_delete_subscription**](docs/UserApi.md#user_delete_subscription) | **DELETE** /api/me/subscriptions/{topic} | Deletes a user subscription.
|
104
|
+
*Notifo::UserApi* | [**user_get_subscription**](docs/UserApi.md#user_get_subscription) | **GET** /api/me/subscriptions/{topic} | Gets a user subscription.
|
105
|
+
*Notifo::UserApi* | [**user_get_user**](docs/UserApi.md#user_get_user) | **GET** /api/me | Get the current user.
|
106
|
+
*Notifo::UserApi* | [**user_post_subscription**](docs/UserApi.md#user_post_subscription) | **POST** /api/me/subscriptions | Creates a user subscription.
|
107
|
+
*Notifo::UserApi* | [**user_post_user**](docs/UserApi.md#user_post_user) | **POST** /api/me | Update the user.
|
108
|
+
*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} | Remove a user subscriptions.
|
110
|
+
*Notifo::UsersApi* | [**users_delete_user**](docs/UsersApi.md#users_delete_user) | **DELETE** /api/apps/{appId}/users/{id} | Delete a user.
|
111
|
+
*Notifo::UsersApi* | [**users_get_subscriptions**](docs/UsersApi.md#users_get_subscriptions) | **GET** /api/apps/{appId}/users/{id}/subscriptions | Query user subscriptions.
|
112
|
+
*Notifo::UsersApi* | [**users_get_user**](docs/UsersApi.md#users_get_user) | **GET** /api/apps/{appId}/users/{id} | Get a user.
|
113
|
+
*Notifo::UsersApi* | [**users_get_users**](docs/UsersApi.md#users_get_users) | **GET** /api/apps/{appId}/users | Query users.
|
114
|
+
*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* | [**users_post_subscription**](docs/UsersApi.md#users_post_subscription) | **POST** /api/apps/{appId}/users/{id}/subscriptions | Upsert a user subscriptions.
|
116
|
+
*Notifo::UsersApi* | [**users_post_users**](docs/UsersApi.md#users_post_users) | **POST** /api/apps/{appId}/users | Upsert users.
|
117
|
+
|
118
|
+
|
119
|
+
## Documentation for Models
|
120
|
+
|
121
|
+
- [Notifo::AddAllowedTopicDto](docs/AddAllowedTopicDto.md)
|
122
|
+
- [Notifo::AddContributorDto](docs/AddContributorDto.md)
|
123
|
+
- [Notifo::AppContributorDto](docs/AppContributorDto.md)
|
124
|
+
- [Notifo::AppDetailsDto](docs/AppDetailsDto.md)
|
125
|
+
- [Notifo::AppDto](docs/AppDto.md)
|
126
|
+
- [Notifo::ConfirmMode](docs/ConfirmMode.md)
|
127
|
+
- [Notifo::CreateEmailTemplateDto](docs/CreateEmailTemplateDto.md)
|
128
|
+
- [Notifo::EmailTemplateDto](docs/EmailTemplateDto.md)
|
129
|
+
- [Notifo::EmailVerificationStatus](docs/EmailVerificationStatus.md)
|
130
|
+
- [Notifo::ErrorDto](docs/ErrorDto.md)
|
131
|
+
- [Notifo::EventDto](docs/EventDto.md)
|
132
|
+
- [Notifo::IsoDayOfWeek](docs/IsoDayOfWeek.md)
|
133
|
+
- [Notifo::ListResponseDtoOfEventDto](docs/ListResponseDtoOfEventDto.md)
|
134
|
+
- [Notifo::ListResponseDtoOfLogEntryDto](docs/ListResponseDtoOfLogEntryDto.md)
|
135
|
+
- [Notifo::ListResponseDtoOfMediaDto](docs/ListResponseDtoOfMediaDto.md)
|
136
|
+
- [Notifo::ListResponseDtoOfSubscriptionDto](docs/ListResponseDtoOfSubscriptionDto.md)
|
137
|
+
- [Notifo::ListResponseDtoOfTemplateDto](docs/ListResponseDtoOfTemplateDto.md)
|
138
|
+
- [Notifo::ListResponseDtoOfTopicDto](docs/ListResponseDtoOfTopicDto.md)
|
139
|
+
- [Notifo::ListResponseDtoOfUserDto](docs/ListResponseDtoOfUserDto.md)
|
140
|
+
- [Notifo::LogEntryDto](docs/LogEntryDto.md)
|
141
|
+
- [Notifo::MediaDto](docs/MediaDto.md)
|
142
|
+
- [Notifo::MediaType](docs/MediaType.md)
|
143
|
+
- [Notifo::NotificationFormattingDto](docs/NotificationFormattingDto.md)
|
144
|
+
- [Notifo::NotificationSend](docs/NotificationSend.md)
|
145
|
+
- [Notifo::NotificationSettingDto](docs/NotificationSettingDto.md)
|
146
|
+
- [Notifo::ProfileDto](docs/ProfileDto.md)
|
147
|
+
- [Notifo::PublishDto](docs/PublishDto.md)
|
148
|
+
- [Notifo::PublishManyDto](docs/PublishManyDto.md)
|
149
|
+
- [Notifo::ResizeMode](docs/ResizeMode.md)
|
150
|
+
- [Notifo::SchedulingDto](docs/SchedulingDto.md)
|
151
|
+
- [Notifo::SchedulingType](docs/SchedulingType.md)
|
152
|
+
- [Notifo::SubscriptionDto](docs/SubscriptionDto.md)
|
153
|
+
- [Notifo::TemplateDto](docs/TemplateDto.md)
|
154
|
+
- [Notifo::TopicDto](docs/TopicDto.md)
|
155
|
+
- [Notifo::UpdateProfileDto](docs/UpdateProfileDto.md)
|
156
|
+
- [Notifo::UpsertAppDto](docs/UpsertAppDto.md)
|
157
|
+
- [Notifo::UpsertTemplateDto](docs/UpsertTemplateDto.md)
|
158
|
+
- [Notifo::UpsertTemplatesDto](docs/UpsertTemplatesDto.md)
|
159
|
+
- [Notifo::UpsertUserDto](docs/UpsertUserDto.md)
|
160
|
+
- [Notifo::UpsertUsersDto](docs/UpsertUsersDto.md)
|
161
|
+
- [Notifo::UserDto](docs/UserDto.md)
|
162
|
+
|
163
|
+
|
164
|
+
## Documentation for Authorization
|
165
|
+
|
166
|
+
All endpoints do not require authorization.
|
167
|
+
|
data/Rakefile
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
# Notifo::AddAllowedTopicDto
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **prefix** | **String** | The topic to add. | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'notifo'
|
13
|
+
|
14
|
+
instance = Notifo::AddAllowedTopicDto.new(
|
15
|
+
prefix: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# Notifo::AddContributorDto
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **email** | **String** | The email of the new contributor. | |
|
8
|
+
| **role** | **String** | The role. | |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'notifo'
|
14
|
+
|
15
|
+
instance = Notifo::AddContributorDto.new(
|
16
|
+
email: null,
|
17
|
+
role: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# Notifo::AppContributorDto
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **user_id** | **String** | The id of the user. | |
|
8
|
+
| **user_name** | **String** | The name of the user. | |
|
9
|
+
| **role** | **String** | The role. | |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'notifo'
|
15
|
+
|
16
|
+
instance = Notifo::AppContributorDto.new(
|
17
|
+
user_id: null,
|
18
|
+
user_name: null,
|
19
|
+
role: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,48 @@
|
|
1
|
+
# Notifo::AppDetailsDto
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | The id of the app. | |
|
8
|
+
| **name** | **String** | The app name. | |
|
9
|
+
| **role** | **String** | The current role. | |
|
10
|
+
| **languages** | **Array<String>** | The supported languages. | |
|
11
|
+
| **email_address** | **String** | The sender email address. | [optional] |
|
12
|
+
| **email_name** | **String** | The sender email name. | [optional] |
|
13
|
+
| **firebase_project** | **String** | The firebase project ID. | [optional] |
|
14
|
+
| **firebase_credential** | **String** | The firebase credentials. | [optional] |
|
15
|
+
| **webhook_url** | **String** | The webhook URL. | [optional] |
|
16
|
+
| **confirm_url** | **String** | The confirm URL. | [optional] |
|
17
|
+
| **allow_email** | **Boolean** | True, when emails are allowed. | |
|
18
|
+
| **allow_sms** | **Boolean** | True, when SMS are allowed. | |
|
19
|
+
| **email_verification_status** | [**EmailVerificationStatus**](EmailVerificationStatus.md) | | |
|
20
|
+
| **api_keys** | **Hash<String, String>** | The api keys. | |
|
21
|
+
| **contributors** | [**Array<AppContributorDto>**](AppContributorDto.md) | The contributors. | |
|
22
|
+
| **counters** | **Hash<String, Integer>** | The statistics counters. | |
|
23
|
+
|
24
|
+
## Example
|
25
|
+
|
26
|
+
```ruby
|
27
|
+
require 'notifo'
|
28
|
+
|
29
|
+
instance = Notifo::AppDetailsDto.new(
|
30
|
+
id: null,
|
31
|
+
name: null,
|
32
|
+
role: null,
|
33
|
+
languages: null,
|
34
|
+
email_address: null,
|
35
|
+
email_name: null,
|
36
|
+
firebase_project: null,
|
37
|
+
firebase_credential: null,
|
38
|
+
webhook_url: null,
|
39
|
+
confirm_url: null,
|
40
|
+
allow_email: null,
|
41
|
+
allow_sms: null,
|
42
|
+
email_verification_status: null,
|
43
|
+
api_keys: null,
|
44
|
+
contributors: null,
|
45
|
+
counters: null
|
46
|
+
)
|
47
|
+
```
|
48
|
+
|
data/docs/AppDto.md
ADDED
@@ -0,0 +1,28 @@
|
|
1
|
+
# Notifo::AppDto
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | The id of the app. | |
|
8
|
+
| **name** | **String** | The app name. | |
|
9
|
+
| **role** | **String** | The current role. | |
|
10
|
+
| **languages** | **Array<String>** | The supported languages. | |
|
11
|
+
| **api_keys** | **Hash<String, String>** | The api keys. | |
|
12
|
+
| **counters** | **Hash<String, Integer>** | The statistics counters. | |
|
13
|
+
|
14
|
+
## Example
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'notifo'
|
18
|
+
|
19
|
+
instance = Notifo::AppDto.new(
|
20
|
+
id: null,
|
21
|
+
name: null,
|
22
|
+
role: null,
|
23
|
+
languages: null,
|
24
|
+
api_keys: null,
|
25
|
+
counters: null
|
26
|
+
)
|
27
|
+
```
|
28
|
+
|
data/docs/AppsApi.md
ADDED
@@ -0,0 +1,646 @@
|
|
1
|
+
# Notifo::AppsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://notifo.easierlife.com*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**apps_delete_contributor**](AppsApi.md#apps_delete_contributor) | **POST** /api/apps/{appId}/contributors/{contributorId} | Delete an app contributor. |
|
8
|
+
| [**apps_delete_email_template**](AppsApi.md#apps_delete_email_template) | **POST** /api/apps/{appId}/email-templates/{language} | Delete an app email template. |
|
9
|
+
| [**apps_get_app**](AppsApi.md#apps_get_app) | **GET** /api/apps/{appId} | Get app by id. |
|
10
|
+
| [**apps_get_apps**](AppsApi.md#apps_get_apps) | **GET** /api/apps | Get the user apps. |
|
11
|
+
| [**apps_get_email_templates**](AppsApi.md#apps_get_email_templates) | **GET** /api/apps/{appId}/email-templates | Get the app email templates. |
|
12
|
+
| [**apps_post_app**](AppsApi.md#apps_post_app) | **POST** /api/apps | Create an app. |
|
13
|
+
| [**apps_post_contributor**](AppsApi.md#apps_post_contributor) | **POST** /api/apps/{appId}/contributors | Add an app contributor. |
|
14
|
+
| [**apps_post_email_template**](AppsApi.md#apps_post_email_template) | **POST** /api/apps/{appId}/email-templates | Create an app email template. |
|
15
|
+
| [**apps_put_app**](AppsApi.md#apps_put_app) | **POST** /api/apps/{appId} | Update an app. |
|
16
|
+
| [**apps_put_email_template**](AppsApi.md#apps_put_email_template) | **PUT** /api/apps/{appId}/email-templates/{language} | Update an app email template. |
|
17
|
+
|
18
|
+
|
19
|
+
## apps_delete_contributor
|
20
|
+
|
21
|
+
> <AppDetailsDto> apps_delete_contributor(app_id, contributor_id)
|
22
|
+
|
23
|
+
Delete an app contributor.
|
24
|
+
|
25
|
+
### Examples
|
26
|
+
|
27
|
+
```ruby
|
28
|
+
require 'time'
|
29
|
+
require 'notifo'
|
30
|
+
|
31
|
+
api_instance = Notifo::AppsApi.new
|
32
|
+
app_id = 'app_id_example' # String | The id of the app.
|
33
|
+
contributor_id = 'contributor_id_example' # String | The contributor to remove.
|
34
|
+
|
35
|
+
begin
|
36
|
+
# Delete an app contributor.
|
37
|
+
result = api_instance.apps_delete_contributor(app_id, contributor_id)
|
38
|
+
p result
|
39
|
+
rescue Notifo::ApiError => e
|
40
|
+
puts "Error when calling AppsApi->apps_delete_contributor: #{e}"
|
41
|
+
end
|
42
|
+
```
|
43
|
+
|
44
|
+
#### Using the apps_delete_contributor_with_http_info variant
|
45
|
+
|
46
|
+
This returns an Array which contains the response data, status code and headers.
|
47
|
+
|
48
|
+
> <Array(<AppDetailsDto>, Integer, Hash)> apps_delete_contributor_with_http_info(app_id, contributor_id)
|
49
|
+
|
50
|
+
```ruby
|
51
|
+
begin
|
52
|
+
# Delete an app contributor.
|
53
|
+
data, status_code, headers = api_instance.apps_delete_contributor_with_http_info(app_id, contributor_id)
|
54
|
+
p status_code # => 2xx
|
55
|
+
p headers # => { ... }
|
56
|
+
p data # => <AppDetailsDto>
|
57
|
+
rescue Notifo::ApiError => e
|
58
|
+
puts "Error when calling AppsApi->apps_delete_contributor_with_http_info: #{e}"
|
59
|
+
end
|
60
|
+
```
|
61
|
+
|
62
|
+
### Parameters
|
63
|
+
|
64
|
+
| Name | Type | Description | Notes |
|
65
|
+
| ---- | ---- | ----------- | ----- |
|
66
|
+
| **app_id** | **String** | The id of the app. | |
|
67
|
+
| **contributor_id** | **String** | The contributor to remove. | |
|
68
|
+
|
69
|
+
### Return type
|
70
|
+
|
71
|
+
[**AppDetailsDto**](AppDetailsDto.md)
|
72
|
+
|
73
|
+
### Authorization
|
74
|
+
|
75
|
+
No authorization required
|
76
|
+
|
77
|
+
### HTTP request headers
|
78
|
+
|
79
|
+
- **Content-Type**: Not defined
|
80
|
+
- **Accept**: application/json
|
81
|
+
|
82
|
+
|
83
|
+
## apps_delete_email_template
|
84
|
+
|
85
|
+
> apps_delete_email_template(app_id, language)
|
86
|
+
|
87
|
+
Delete an app email template.
|
88
|
+
|
89
|
+
### Examples
|
90
|
+
|
91
|
+
```ruby
|
92
|
+
require 'time'
|
93
|
+
require 'notifo'
|
94
|
+
|
95
|
+
api_instance = Notifo::AppsApi.new
|
96
|
+
app_id = 'app_id_example' # String | The id of the app where the email templates belong to.
|
97
|
+
language = 'language_example' # String | The language.
|
98
|
+
|
99
|
+
begin
|
100
|
+
# Delete an app email template.
|
101
|
+
api_instance.apps_delete_email_template(app_id, language)
|
102
|
+
rescue Notifo::ApiError => e
|
103
|
+
puts "Error when calling AppsApi->apps_delete_email_template: #{e}"
|
104
|
+
end
|
105
|
+
```
|
106
|
+
|
107
|
+
#### Using the apps_delete_email_template_with_http_info variant
|
108
|
+
|
109
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
110
|
+
|
111
|
+
> <Array(nil, Integer, Hash)> apps_delete_email_template_with_http_info(app_id, language)
|
112
|
+
|
113
|
+
```ruby
|
114
|
+
begin
|
115
|
+
# Delete an app email template.
|
116
|
+
data, status_code, headers = api_instance.apps_delete_email_template_with_http_info(app_id, language)
|
117
|
+
p status_code # => 2xx
|
118
|
+
p headers # => { ... }
|
119
|
+
p data # => nil
|
120
|
+
rescue Notifo::ApiError => e
|
121
|
+
puts "Error when calling AppsApi->apps_delete_email_template_with_http_info: #{e}"
|
122
|
+
end
|
123
|
+
```
|
124
|
+
|
125
|
+
### Parameters
|
126
|
+
|
127
|
+
| Name | Type | Description | Notes |
|
128
|
+
| ---- | ---- | ----------- | ----- |
|
129
|
+
| **app_id** | **String** | The id of the app where the email templates belong to. | |
|
130
|
+
| **language** | **String** | The language. | |
|
131
|
+
|
132
|
+
### Return type
|
133
|
+
|
134
|
+
nil (empty response body)
|
135
|
+
|
136
|
+
### Authorization
|
137
|
+
|
138
|
+
No authorization required
|
139
|
+
|
140
|
+
### HTTP request headers
|
141
|
+
|
142
|
+
- **Content-Type**: Not defined
|
143
|
+
- **Accept**: application/json
|
144
|
+
|
145
|
+
|
146
|
+
## apps_get_app
|
147
|
+
|
148
|
+
> <AppDetailsDto> apps_get_app(app_id)
|
149
|
+
|
150
|
+
Get app by id.
|
151
|
+
|
152
|
+
### Examples
|
153
|
+
|
154
|
+
```ruby
|
155
|
+
require 'time'
|
156
|
+
require 'notifo'
|
157
|
+
|
158
|
+
api_instance = Notifo::AppsApi.new
|
159
|
+
app_id = 'app_id_example' # String | The id of the app.
|
160
|
+
|
161
|
+
begin
|
162
|
+
# Get app by id.
|
163
|
+
result = api_instance.apps_get_app(app_id)
|
164
|
+
p result
|
165
|
+
rescue Notifo::ApiError => e
|
166
|
+
puts "Error when calling AppsApi->apps_get_app: #{e}"
|
167
|
+
end
|
168
|
+
```
|
169
|
+
|
170
|
+
#### Using the apps_get_app_with_http_info variant
|
171
|
+
|
172
|
+
This returns an Array which contains the response data, status code and headers.
|
173
|
+
|
174
|
+
> <Array(<AppDetailsDto>, Integer, Hash)> apps_get_app_with_http_info(app_id)
|
175
|
+
|
176
|
+
```ruby
|
177
|
+
begin
|
178
|
+
# Get app by id.
|
179
|
+
data, status_code, headers = api_instance.apps_get_app_with_http_info(app_id)
|
180
|
+
p status_code # => 2xx
|
181
|
+
p headers # => { ... }
|
182
|
+
p data # => <AppDetailsDto>
|
183
|
+
rescue Notifo::ApiError => e
|
184
|
+
puts "Error when calling AppsApi->apps_get_app_with_http_info: #{e}"
|
185
|
+
end
|
186
|
+
```
|
187
|
+
|
188
|
+
### Parameters
|
189
|
+
|
190
|
+
| Name | Type | Description | Notes |
|
191
|
+
| ---- | ---- | ----------- | ----- |
|
192
|
+
| **app_id** | **String** | The id of the app. | |
|
193
|
+
|
194
|
+
### Return type
|
195
|
+
|
196
|
+
[**AppDetailsDto**](AppDetailsDto.md)
|
197
|
+
|
198
|
+
### Authorization
|
199
|
+
|
200
|
+
No authorization required
|
201
|
+
|
202
|
+
### HTTP request headers
|
203
|
+
|
204
|
+
- **Content-Type**: Not defined
|
205
|
+
- **Accept**: application/json
|
206
|
+
|
207
|
+
|
208
|
+
## apps_get_apps
|
209
|
+
|
210
|
+
> <Array<AppDto>> apps_get_apps
|
211
|
+
|
212
|
+
Get the user apps.
|
213
|
+
|
214
|
+
### Examples
|
215
|
+
|
216
|
+
```ruby
|
217
|
+
require 'time'
|
218
|
+
require 'notifo'
|
219
|
+
|
220
|
+
api_instance = Notifo::AppsApi.new
|
221
|
+
|
222
|
+
begin
|
223
|
+
# Get the user apps.
|
224
|
+
result = api_instance.apps_get_apps
|
225
|
+
p result
|
226
|
+
rescue Notifo::ApiError => e
|
227
|
+
puts "Error when calling AppsApi->apps_get_apps: #{e}"
|
228
|
+
end
|
229
|
+
```
|
230
|
+
|
231
|
+
#### Using the apps_get_apps_with_http_info variant
|
232
|
+
|
233
|
+
This returns an Array which contains the response data, status code and headers.
|
234
|
+
|
235
|
+
> <Array(<Array<AppDto>>, Integer, Hash)> apps_get_apps_with_http_info
|
236
|
+
|
237
|
+
```ruby
|
238
|
+
begin
|
239
|
+
# Get the user apps.
|
240
|
+
data, status_code, headers = api_instance.apps_get_apps_with_http_info
|
241
|
+
p status_code # => 2xx
|
242
|
+
p headers # => { ... }
|
243
|
+
p data # => <Array<AppDto>>
|
244
|
+
rescue Notifo::ApiError => e
|
245
|
+
puts "Error when calling AppsApi->apps_get_apps_with_http_info: #{e}"
|
246
|
+
end
|
247
|
+
```
|
248
|
+
|
249
|
+
### Parameters
|
250
|
+
|
251
|
+
This endpoint does not need any parameter.
|
252
|
+
|
253
|
+
### Return type
|
254
|
+
|
255
|
+
[**Array<AppDto>**](AppDto.md)
|
256
|
+
|
257
|
+
### Authorization
|
258
|
+
|
259
|
+
No authorization required
|
260
|
+
|
261
|
+
### HTTP request headers
|
262
|
+
|
263
|
+
- **Content-Type**: Not defined
|
264
|
+
- **Accept**: application/json
|
265
|
+
|
266
|
+
|
267
|
+
## apps_get_email_templates
|
268
|
+
|
269
|
+
> <Hash<String, EmailTemplateDto>> apps_get_email_templates(app_id)
|
270
|
+
|
271
|
+
Get the app email templates.
|
272
|
+
|
273
|
+
### Examples
|
274
|
+
|
275
|
+
```ruby
|
276
|
+
require 'time'
|
277
|
+
require 'notifo'
|
278
|
+
|
279
|
+
api_instance = Notifo::AppsApi.new
|
280
|
+
app_id = 'app_id_example' # String | The id of the app where the email templates belong to.
|
281
|
+
|
282
|
+
begin
|
283
|
+
# Get the app email templates.
|
284
|
+
result = api_instance.apps_get_email_templates(app_id)
|
285
|
+
p result
|
286
|
+
rescue Notifo::ApiError => e
|
287
|
+
puts "Error when calling AppsApi->apps_get_email_templates: #{e}"
|
288
|
+
end
|
289
|
+
```
|
290
|
+
|
291
|
+
#### Using the apps_get_email_templates_with_http_info variant
|
292
|
+
|
293
|
+
This returns an Array which contains the response data, status code and headers.
|
294
|
+
|
295
|
+
> <Array(<Hash<String, EmailTemplateDto>>, Integer, Hash)> apps_get_email_templates_with_http_info(app_id)
|
296
|
+
|
297
|
+
```ruby
|
298
|
+
begin
|
299
|
+
# Get the app email templates.
|
300
|
+
data, status_code, headers = api_instance.apps_get_email_templates_with_http_info(app_id)
|
301
|
+
p status_code # => 2xx
|
302
|
+
p headers # => { ... }
|
303
|
+
p data # => <Hash<String, EmailTemplateDto>>
|
304
|
+
rescue Notifo::ApiError => e
|
305
|
+
puts "Error when calling AppsApi->apps_get_email_templates_with_http_info: #{e}"
|
306
|
+
end
|
307
|
+
```
|
308
|
+
|
309
|
+
### Parameters
|
310
|
+
|
311
|
+
| Name | Type | Description | Notes |
|
312
|
+
| ---- | ---- | ----------- | ----- |
|
313
|
+
| **app_id** | **String** | The id of the app where the email templates belong to. | |
|
314
|
+
|
315
|
+
### Return type
|
316
|
+
|
317
|
+
[**Hash<String, EmailTemplateDto>**](EmailTemplateDto.md)
|
318
|
+
|
319
|
+
### Authorization
|
320
|
+
|
321
|
+
No authorization required
|
322
|
+
|
323
|
+
### HTTP request headers
|
324
|
+
|
325
|
+
- **Content-Type**: Not defined
|
326
|
+
- **Accept**: application/json
|
327
|
+
|
328
|
+
|
329
|
+
## apps_post_app
|
330
|
+
|
331
|
+
> <AppDto> apps_post_app(upsert_app_dto)
|
332
|
+
|
333
|
+
Create an app.
|
334
|
+
|
335
|
+
### Examples
|
336
|
+
|
337
|
+
```ruby
|
338
|
+
require 'time'
|
339
|
+
require 'notifo'
|
340
|
+
|
341
|
+
api_instance = Notifo::AppsApi.new
|
342
|
+
upsert_app_dto = Notifo::UpsertAppDto.new # UpsertAppDto | The request object.
|
343
|
+
|
344
|
+
begin
|
345
|
+
# Create an app.
|
346
|
+
result = api_instance.apps_post_app(upsert_app_dto)
|
347
|
+
p result
|
348
|
+
rescue Notifo::ApiError => e
|
349
|
+
puts "Error when calling AppsApi->apps_post_app: #{e}"
|
350
|
+
end
|
351
|
+
```
|
352
|
+
|
353
|
+
#### Using the apps_post_app_with_http_info variant
|
354
|
+
|
355
|
+
This returns an Array which contains the response data, status code and headers.
|
356
|
+
|
357
|
+
> <Array(<AppDto>, Integer, Hash)> apps_post_app_with_http_info(upsert_app_dto)
|
358
|
+
|
359
|
+
```ruby
|
360
|
+
begin
|
361
|
+
# Create an app.
|
362
|
+
data, status_code, headers = api_instance.apps_post_app_with_http_info(upsert_app_dto)
|
363
|
+
p status_code # => 2xx
|
364
|
+
p headers # => { ... }
|
365
|
+
p data # => <AppDto>
|
366
|
+
rescue Notifo::ApiError => e
|
367
|
+
puts "Error when calling AppsApi->apps_post_app_with_http_info: #{e}"
|
368
|
+
end
|
369
|
+
```
|
370
|
+
|
371
|
+
### Parameters
|
372
|
+
|
373
|
+
| Name | Type | Description | Notes |
|
374
|
+
| ---- | ---- | ----------- | ----- |
|
375
|
+
| **upsert_app_dto** | [**UpsertAppDto**](UpsertAppDto.md) | The request object. | |
|
376
|
+
|
377
|
+
### Return type
|
378
|
+
|
379
|
+
[**AppDto**](AppDto.md)
|
380
|
+
|
381
|
+
### Authorization
|
382
|
+
|
383
|
+
No authorization required
|
384
|
+
|
385
|
+
### HTTP request headers
|
386
|
+
|
387
|
+
- **Content-Type**: application/json
|
388
|
+
- **Accept**: application/json
|
389
|
+
|
390
|
+
|
391
|
+
## apps_post_contributor
|
392
|
+
|
393
|
+
> <AppDetailsDto> apps_post_contributor(app_id, add_contributor_dto)
|
394
|
+
|
395
|
+
Add an app contributor.
|
396
|
+
|
397
|
+
### Examples
|
398
|
+
|
399
|
+
```ruby
|
400
|
+
require 'time'
|
401
|
+
require 'notifo'
|
402
|
+
|
403
|
+
api_instance = Notifo::AppsApi.new
|
404
|
+
app_id = 'app_id_example' # String | The id of the app.
|
405
|
+
add_contributor_dto = Notifo::AddContributorDto.new({email: 'email_example', role: 'role_example'}) # AddContributorDto | The request object.
|
406
|
+
|
407
|
+
begin
|
408
|
+
# Add an app contributor.
|
409
|
+
result = api_instance.apps_post_contributor(app_id, add_contributor_dto)
|
410
|
+
p result
|
411
|
+
rescue Notifo::ApiError => e
|
412
|
+
puts "Error when calling AppsApi->apps_post_contributor: #{e}"
|
413
|
+
end
|
414
|
+
```
|
415
|
+
|
416
|
+
#### Using the apps_post_contributor_with_http_info variant
|
417
|
+
|
418
|
+
This returns an Array which contains the response data, status code and headers.
|
419
|
+
|
420
|
+
> <Array(<AppDetailsDto>, Integer, Hash)> apps_post_contributor_with_http_info(app_id, add_contributor_dto)
|
421
|
+
|
422
|
+
```ruby
|
423
|
+
begin
|
424
|
+
# Add an app contributor.
|
425
|
+
data, status_code, headers = api_instance.apps_post_contributor_with_http_info(app_id, add_contributor_dto)
|
426
|
+
p status_code # => 2xx
|
427
|
+
p headers # => { ... }
|
428
|
+
p data # => <AppDetailsDto>
|
429
|
+
rescue Notifo::ApiError => e
|
430
|
+
puts "Error when calling AppsApi->apps_post_contributor_with_http_info: #{e}"
|
431
|
+
end
|
432
|
+
```
|
433
|
+
|
434
|
+
### Parameters
|
435
|
+
|
436
|
+
| Name | Type | Description | Notes |
|
437
|
+
| ---- | ---- | ----------- | ----- |
|
438
|
+
| **app_id** | **String** | The id of the app. | |
|
439
|
+
| **add_contributor_dto** | [**AddContributorDto**](AddContributorDto.md) | The request object. | |
|
440
|
+
|
441
|
+
### Return type
|
442
|
+
|
443
|
+
[**AppDetailsDto**](AppDetailsDto.md)
|
444
|
+
|
445
|
+
### Authorization
|
446
|
+
|
447
|
+
No authorization required
|
448
|
+
|
449
|
+
### HTTP request headers
|
450
|
+
|
451
|
+
- **Content-Type**: application/json
|
452
|
+
- **Accept**: application/json
|
453
|
+
|
454
|
+
|
455
|
+
## apps_post_email_template
|
456
|
+
|
457
|
+
> <EmailTemplateDto> apps_post_email_template(app_id, create_email_template_dto)
|
458
|
+
|
459
|
+
Create an app email template.
|
460
|
+
|
461
|
+
### Examples
|
462
|
+
|
463
|
+
```ruby
|
464
|
+
require 'time'
|
465
|
+
require 'notifo'
|
466
|
+
|
467
|
+
api_instance = Notifo::AppsApi.new
|
468
|
+
app_id = 'app_id_example' # String | The id of the app where the email templates belong to.
|
469
|
+
create_email_template_dto = Notifo::CreateEmailTemplateDto.new({language: 'language_example'}) # CreateEmailTemplateDto | The request object.
|
470
|
+
|
471
|
+
begin
|
472
|
+
# Create an app email template.
|
473
|
+
result = api_instance.apps_post_email_template(app_id, create_email_template_dto)
|
474
|
+
p result
|
475
|
+
rescue Notifo::ApiError => e
|
476
|
+
puts "Error when calling AppsApi->apps_post_email_template: #{e}"
|
477
|
+
end
|
478
|
+
```
|
479
|
+
|
480
|
+
#### Using the apps_post_email_template_with_http_info variant
|
481
|
+
|
482
|
+
This returns an Array which contains the response data, status code and headers.
|
483
|
+
|
484
|
+
> <Array(<EmailTemplateDto>, Integer, Hash)> apps_post_email_template_with_http_info(app_id, create_email_template_dto)
|
485
|
+
|
486
|
+
```ruby
|
487
|
+
begin
|
488
|
+
# Create an app email template.
|
489
|
+
data, status_code, headers = api_instance.apps_post_email_template_with_http_info(app_id, create_email_template_dto)
|
490
|
+
p status_code # => 2xx
|
491
|
+
p headers # => { ... }
|
492
|
+
p data # => <EmailTemplateDto>
|
493
|
+
rescue Notifo::ApiError => e
|
494
|
+
puts "Error when calling AppsApi->apps_post_email_template_with_http_info: #{e}"
|
495
|
+
end
|
496
|
+
```
|
497
|
+
|
498
|
+
### Parameters
|
499
|
+
|
500
|
+
| Name | Type | Description | Notes |
|
501
|
+
| ---- | ---- | ----------- | ----- |
|
502
|
+
| **app_id** | **String** | The id of the app where the email templates belong to. | |
|
503
|
+
| **create_email_template_dto** | [**CreateEmailTemplateDto**](CreateEmailTemplateDto.md) | The request object. | |
|
504
|
+
|
505
|
+
### Return type
|
506
|
+
|
507
|
+
[**EmailTemplateDto**](EmailTemplateDto.md)
|
508
|
+
|
509
|
+
### Authorization
|
510
|
+
|
511
|
+
No authorization required
|
512
|
+
|
513
|
+
### HTTP request headers
|
514
|
+
|
515
|
+
- **Content-Type**: application/json
|
516
|
+
- **Accept**: application/json
|
517
|
+
|
518
|
+
|
519
|
+
## apps_put_app
|
520
|
+
|
521
|
+
> <AppDetailsDto> apps_put_app(app_id, upsert_app_dto)
|
522
|
+
|
523
|
+
Update an app.
|
524
|
+
|
525
|
+
### Examples
|
526
|
+
|
527
|
+
```ruby
|
528
|
+
require 'time'
|
529
|
+
require 'notifo'
|
530
|
+
|
531
|
+
api_instance = Notifo::AppsApi.new
|
532
|
+
app_id = 'app_id_example' # String | The app id to update.
|
533
|
+
upsert_app_dto = Notifo::UpsertAppDto.new # UpsertAppDto | The request object.
|
534
|
+
|
535
|
+
begin
|
536
|
+
# Update an app.
|
537
|
+
result = api_instance.apps_put_app(app_id, upsert_app_dto)
|
538
|
+
p result
|
539
|
+
rescue Notifo::ApiError => e
|
540
|
+
puts "Error when calling AppsApi->apps_put_app: #{e}"
|
541
|
+
end
|
542
|
+
```
|
543
|
+
|
544
|
+
#### Using the apps_put_app_with_http_info variant
|
545
|
+
|
546
|
+
This returns an Array which contains the response data, status code and headers.
|
547
|
+
|
548
|
+
> <Array(<AppDetailsDto>, Integer, Hash)> apps_put_app_with_http_info(app_id, upsert_app_dto)
|
549
|
+
|
550
|
+
```ruby
|
551
|
+
begin
|
552
|
+
# Update an app.
|
553
|
+
data, status_code, headers = api_instance.apps_put_app_with_http_info(app_id, upsert_app_dto)
|
554
|
+
p status_code # => 2xx
|
555
|
+
p headers # => { ... }
|
556
|
+
p data # => <AppDetailsDto>
|
557
|
+
rescue Notifo::ApiError => e
|
558
|
+
puts "Error when calling AppsApi->apps_put_app_with_http_info: #{e}"
|
559
|
+
end
|
560
|
+
```
|
561
|
+
|
562
|
+
### Parameters
|
563
|
+
|
564
|
+
| Name | Type | Description | Notes |
|
565
|
+
| ---- | ---- | ----------- | ----- |
|
566
|
+
| **app_id** | **String** | The app id to update. | |
|
567
|
+
| **upsert_app_dto** | [**UpsertAppDto**](UpsertAppDto.md) | The request object. | |
|
568
|
+
|
569
|
+
### Return type
|
570
|
+
|
571
|
+
[**AppDetailsDto**](AppDetailsDto.md)
|
572
|
+
|
573
|
+
### Authorization
|
574
|
+
|
575
|
+
No authorization required
|
576
|
+
|
577
|
+
### HTTP request headers
|
578
|
+
|
579
|
+
- **Content-Type**: application/json
|
580
|
+
- **Accept**: application/json
|
581
|
+
|
582
|
+
|
583
|
+
## apps_put_email_template
|
584
|
+
|
585
|
+
> apps_put_email_template(app_id, language, email_template_dto)
|
586
|
+
|
587
|
+
Update an app email template.
|
588
|
+
|
589
|
+
### Examples
|
590
|
+
|
591
|
+
```ruby
|
592
|
+
require 'time'
|
593
|
+
require 'notifo'
|
594
|
+
|
595
|
+
api_instance = Notifo::AppsApi.new
|
596
|
+
app_id = 'app_id_example' # String | The id of the app where the email templates belong to.
|
597
|
+
language = 'language_example' # String | The language.
|
598
|
+
email_template_dto = Notifo::EmailTemplateDto.new({subject: 'subject_example', body_html: 'body_html_example'}) # EmailTemplateDto | The request object.
|
599
|
+
|
600
|
+
begin
|
601
|
+
# Update an app email template.
|
602
|
+
api_instance.apps_put_email_template(app_id, language, email_template_dto)
|
603
|
+
rescue Notifo::ApiError => e
|
604
|
+
puts "Error when calling AppsApi->apps_put_email_template: #{e}"
|
605
|
+
end
|
606
|
+
```
|
607
|
+
|
608
|
+
#### Using the apps_put_email_template_with_http_info variant
|
609
|
+
|
610
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
611
|
+
|
612
|
+
> <Array(nil, Integer, Hash)> apps_put_email_template_with_http_info(app_id, language, email_template_dto)
|
613
|
+
|
614
|
+
```ruby
|
615
|
+
begin
|
616
|
+
# Update an app email template.
|
617
|
+
data, status_code, headers = api_instance.apps_put_email_template_with_http_info(app_id, language, email_template_dto)
|
618
|
+
p status_code # => 2xx
|
619
|
+
p headers # => { ... }
|
620
|
+
p data # => nil
|
621
|
+
rescue Notifo::ApiError => e
|
622
|
+
puts "Error when calling AppsApi->apps_put_email_template_with_http_info: #{e}"
|
623
|
+
end
|
624
|
+
```
|
625
|
+
|
626
|
+
### Parameters
|
627
|
+
|
628
|
+
| Name | Type | Description | Notes |
|
629
|
+
| ---- | ---- | ----------- | ----- |
|
630
|
+
| **app_id** | **String** | The id of the app where the email templates belong to. | |
|
631
|
+
| **language** | **String** | The language. | |
|
632
|
+
| **email_template_dto** | [**EmailTemplateDto**](EmailTemplateDto.md) | The request object. | |
|
633
|
+
|
634
|
+
### Return type
|
635
|
+
|
636
|
+
nil (empty response body)
|
637
|
+
|
638
|
+
### Authorization
|
639
|
+
|
640
|
+
No authorization required
|
641
|
+
|
642
|
+
### HTTP request headers
|
643
|
+
|
644
|
+
- **Content-Type**: application/json
|
645
|
+
- **Accept**: application/json
|
646
|
+
|