notifo-io 1.0.0.pre → 1.0.1.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +726 -19
- data/Rakefile +0 -2
- data/docs/AddAllowedTopicDto.md +7 -0
- data/docs/AddContributorDto.md +4 -16
- data/docs/AppContributorDto.md +5 -18
- data/docs/AppDetailsDto.md +10 -44
- data/docs/AppDto.md +8 -24
- data/docs/AppIdMediaBody.md +7 -0
- data/docs/AppsApi.md +301 -297
- data/docs/AuthorizationApi.md +121 -0
- data/docs/Body.md +7 -0
- data/docs/ConfigsApi.md +21 -61
- data/docs/ConfiguredIntegrationDto.md +12 -0
- data/docs/ConfiguredIntegrationsDto.md +8 -0
- data/docs/ConfirmMode.md +2 -11
- data/docs/CreateEmailTemplateDto.md +3 -14
- data/docs/CreateIntegrationDto.md +11 -0
- data/docs/EmailTemplateDto.md +5 -18
- data/docs/EmailTemplatesDto.md +6 -0
- data/docs/EmailVerificationStatus.md +2 -11
- data/docs/ErrorDto.md +7 -22
- data/docs/EventDto.md +15 -36
- data/docs/EventProperties.md +6 -0
- data/docs/EventsApi.md +72 -65
- data/docs/IntegrationCreatedDto.md +8 -0
- data/docs/IntegrationDefinitionDto.md +11 -0
- data/docs/IntegrationProperties.md +6 -0
- data/docs/IntegrationPropertyDto.md +17 -0
- data/docs/IntegrationPropertyType.md +6 -0
- data/docs/IntegrationStatus.md +6 -0
- data/docs/IsoDayOfWeek.md +2 -11
- data/docs/ListResponseDtoOfEventDto.md +4 -16
- data/docs/ListResponseDtoOfLogEntryDto.md +4 -16
- data/docs/ListResponseDtoOfMediaDto.md +4 -16
- data/docs/ListResponseDtoOfMobilePushTokenDto.md +8 -0
- data/docs/ListResponseDtoOfNotificationDto.md +8 -0
- data/docs/ListResponseDtoOfSubscriptionDto.md +4 -16
- data/docs/ListResponseDtoOfTemplateDto.md +4 -16
- data/docs/ListResponseDtoOfTopicDto.md +4 -16
- data/docs/ListResponseDtoOfUserDto.md +4 -16
- data/docs/LocalizedText.md +6 -0
- data/docs/LogEntryDto.md +6 -20
- data/docs/LogsApi.md +21 -40
- data/docs/MediaApi.md +134 -141
- data/docs/MediaDto.md +9 -24
- data/docs/MediaMetadata.md +6 -0
- data/docs/MediaType.md +2 -11
- data/docs/MobileDeviceType.md +6 -0
- data/docs/MobilePushApi.md +135 -0
- data/docs/MobilePushTokenDto.md +8 -0
- data/docs/NotificationDto.md +21 -0
- data/docs/NotificationFormattingDto.md +10 -28
- data/docs/NotificationSend.md +6 -0
- data/docs/NotificationSettingDto.md +4 -16
- data/docs/NotificationsApi.md +141 -0
- data/docs/ProfileDto.md +14 -0
- data/docs/PublishDto.md +18 -0
- data/docs/PublishManyDto.md +7 -0
- data/docs/RegisterMobileTokenDto.md +8 -0
- data/docs/ResizeMode.md +2 -11
- data/docs/SchedulingDto.md +6 -20
- data/docs/SchedulingType.md +2 -11
- data/docs/SubscriptionDto.md +4 -16
- data/docs/TemplateDto.md +5 -18
- data/docs/TemplatesApi.md +51 -106
- data/docs/TopicDto.md +5 -18
- data/docs/TopicsApi.md +19 -230
- data/docs/TrackNotificationDto.md +10 -0
- data/docs/UpdateIntegrationDto.md +10 -0
- data/docs/UpdateProfileDto.md +12 -0
- data/docs/UpsertAppDto.md +12 -32
- data/docs/UpsertTemplateDto.md +5 -18
- data/docs/UpsertTemplatesDto.md +3 -14
- data/docs/UpsertUserDto.md +11 -28
- data/docs/UpsertUsersDto.md +3 -14
- data/docs/UserApi.md +231 -0
- data/docs/UserDto.md +15 -32
- data/docs/UserInfoApi.md +83 -0
- data/docs/UsersApi.md +144 -308
- data/git_push.sh +7 -10
- data/lib/notifo.rb +37 -11
- data/lib/notifo/api/apps_api.rb +373 -201
- data/lib/notifo/api/authorization_api.rb +158 -0
- data/lib/notifo/api/configs_api.rb +14 -30
- data/lib/notifo/api/events_api.rb +85 -45
- data/lib/notifo/api/logs_api.rb +12 -21
- data/lib/notifo/api/media_api.rb +137 -77
- data/lib/notifo/api/mobile_push_api.rb +178 -0
- data/lib/notifo/api/notifications_api.rb +181 -0
- data/lib/notifo/api/templates_api.rb +39 -62
- data/lib/notifo/api/topics_api.rb +12 -210
- data/lib/notifo/api/user_api.rb +294 -0
- data/lib/notifo/api/user_info_api.rb +112 -0
- data/lib/notifo/api/users_api.rb +121 -186
- data/lib/notifo/api_client.rb +53 -55
- data/lib/notifo/api_error.rb +5 -5
- data/lib/notifo/configuration.rb +8 -78
- data/lib/notifo/models/{add_allowed_topic_request.rb → add_allowed_topic_dto.rb} +21 -28
- data/lib/notifo/models/add_contributor_dto.rb +24 -26
- data/lib/notifo/models/app_contributor_dto.rb +30 -27
- data/lib/notifo/models/app_details_dto.rb +59 -119
- data/lib/notifo/models/app_dto.rb +51 -31
- data/lib/notifo/models/{inline_object.rb → app_id_media_body.rb} +16 -28
- data/lib/notifo/models/body.rb +206 -0
- data/lib/notifo/models/configured_integration_dto.rb +271 -0
- data/lib/notifo/models/configured_integrations_dto.rb +231 -0
- data/lib/notifo/models/confirm_mode.rb +7 -16
- data/lib/notifo/models/create_email_template_dto.rb +18 -25
- data/lib/notifo/models/create_integration_dto.rb +257 -0
- data/lib/notifo/models/email_template_dto.rb +25 -27
- data/lib/notifo/models/email_templates_dto.rb +201 -0
- data/lib/notifo/models/email_verification_status.rb +8 -17
- data/lib/notifo/models/error_dto.rb +17 -29
- data/lib/notifo/models/event_dto.rb +92 -46
- data/lib/notifo/models/event_properties.rb +201 -0
- data/lib/notifo/models/{subscribe_dto.rb → integration_created_dto.rb} +39 -42
- data/lib/notifo/models/integration_definition_dto.rb +272 -0
- data/lib/notifo/models/integration_properties.rb +201 -0
- data/lib/notifo/models/integration_property_dto.rb +319 -0
- data/lib/notifo/models/integration_property_type.rb +31 -0
- data/lib/notifo/models/integration_status.rb +29 -0
- data/lib/notifo/models/iso_day_of_week.rb +12 -21
- data/lib/notifo/models/list_response_dto_of_event_dto.rb +24 -26
- data/lib/notifo/models/list_response_dto_of_log_entry_dto.rb +24 -26
- data/lib/notifo/models/list_response_dto_of_media_dto.rb +24 -26
- data/lib/notifo/models/list_response_dto_of_mobile_push_token_dto.rb +229 -0
- data/lib/notifo/models/list_response_dto_of_notification_dto.rb +229 -0
- data/lib/notifo/models/list_response_dto_of_subscription_dto.rb +24 -26
- data/lib/notifo/models/list_response_dto_of_template_dto.rb +24 -26
- data/lib/notifo/models/list_response_dto_of_topic_dto.rb +24 -26
- data/lib/notifo/models/list_response_dto_of_user_dto.rb +24 -26
- data/lib/notifo/models/localized_text.rb +201 -0
- data/lib/notifo/models/log_entry_dto.rb +36 -28
- data/lib/notifo/models/media_dto.rb +64 -33
- data/lib/notifo/models/media_metadata.rb +201 -0
- data/lib/notifo/models/media_type.rb +8 -17
- data/lib/notifo/models/mobile_device_type.rb +29 -0
- data/lib/notifo/models/mobile_push_token_dto.rb +221 -0
- data/lib/notifo/models/notification_dto.rb +386 -0
- data/lib/notifo/models/notification_formatting_dto.rb +30 -46
- data/lib/notifo/models/notification_send.rb +30 -0
- data/lib/notifo/models/notification_setting_dto.rb +25 -34
- data/lib/notifo/models/profile_dto.rb +311 -0
- data/lib/notifo/models/{publish_request_dto.rb → publish_dto.rb} +55 -44
- data/lib/notifo/models/{publish_many_request_dto.rb → publish_many_dto.rb} +21 -28
- data/lib/notifo/models/register_mobile_token_dto.rb +221 -0
- data/lib/notifo/models/resize_mode.rb +11 -20
- data/lib/notifo/models/scheduling_dto.rb +16 -31
- data/lib/notifo/models/scheduling_type.rb +6 -15
- data/lib/notifo/models/subscription_dto.rb +23 -27
- data/lib/notifo/models/template_dto.rb +33 -29
- data/lib/notifo/models/topic_dto.rb +33 -28
- data/lib/notifo/models/track_notification_dto.rb +243 -0
- data/lib/notifo/models/update_integration_dto.rb +242 -0
- data/lib/notifo/models/update_profile_dto.rb +265 -0
- data/lib/notifo/models/upsert_app_dto.rb +22 -34
- data/lib/notifo/models/upsert_template_dto.rb +28 -29
- data/lib/notifo/models/upsert_templates_dto.rb +18 -25
- data/lib/notifo/models/upsert_user_dto.rb +35 -34
- data/lib/notifo/models/upsert_users_dto.rb +18 -25
- data/lib/notifo/models/user_dto.rb +100 -37
- data/lib/notifo/version.rb +4 -5
- data/notifo-io-1.0.1.1.gem +0 -0
- data/notifo.gemspec +10 -10
- data/spec/api/apps_api_spec.rb +14 -15
- data/spec/api/authorization_api_spec.rb +61 -0
- data/spec/api/configs_api_spec.rb +7 -8
- data/spec/api/events_api_spec.rb +8 -9
- data/spec/api/logs_api_spec.rb +7 -8
- data/spec/api/media_api_spec.rb +33 -12
- data/spec/api/mobile_push_api_spec.rb +66 -0
- data/spec/api/notifications_api_spec.rb +68 -0
- data/spec/api/templates_api_spec.rb +8 -9
- data/spec/api/topics_api_spec.rb +7 -44
- data/spec/api/user_api_spec.rb +91 -0
- data/spec/api/user_info_api_spec.rb +52 -0
- data/spec/api/users_api_spec.rb +10 -11
- data/spec/api_client_spec.rb +5 -6
- data/spec/base_object_spec.rb +109 -0
- data/spec/configuration_spec.rb +4 -5
- data/spec/models/add_allowed_topic_dto_spec.rb +40 -0
- data/spec/models/add_contributor_dto_spec.rb +15 -9
- data/spec/models/app_contributor_dto_spec.rb +15 -9
- data/spec/models/app_details_dto_spec.rb +15 -9
- data/spec/models/app_dto_spec.rb +15 -9
- data/spec/models/app_id_media_body_spec.rb +40 -0
- data/spec/models/body_spec.rb +40 -0
- data/spec/models/configured_integration_dto_spec.rb +70 -0
- data/spec/models/configured_integrations_dto_spec.rb +46 -0
- data/spec/models/confirm_mode_spec.rb +15 -9
- data/spec/models/create_email_template_dto_spec.rb +15 -9
- data/spec/models/create_integration_dto_spec.rb +64 -0
- data/spec/models/email_template_dto_spec.rb +15 -9
- data/spec/models/email_templates_dto_spec.rb +34 -0
- data/spec/models/email_verification_status_spec.rb +15 -9
- data/spec/models/error_dto_spec.rb +15 -9
- data/spec/models/event_dto_spec.rb +15 -9
- data/spec/models/event_properties_spec.rb +34 -0
- data/spec/models/integration_created_dto_spec.rb +46 -0
- data/spec/models/integration_definition_dto_spec.rb +64 -0
- data/spec/models/integration_properties_spec.rb +34 -0
- data/spec/models/integration_property_dto_spec.rb +100 -0
- data/spec/models/integration_property_type_spec.rb +34 -0
- data/spec/models/integration_status_spec.rb +34 -0
- data/spec/models/iso_day_of_week_spec.rb +15 -9
- data/spec/models/list_response_dto_of_event_dto_spec.rb +15 -9
- data/spec/models/list_response_dto_of_log_entry_dto_spec.rb +15 -9
- data/spec/models/list_response_dto_of_media_dto_spec.rb +15 -9
- data/spec/models/list_response_dto_of_mobile_push_token_dto_spec.rb +46 -0
- data/spec/models/list_response_dto_of_notification_dto_spec.rb +46 -0
- data/spec/models/list_response_dto_of_subscription_dto_spec.rb +15 -9
- data/spec/models/list_response_dto_of_template_dto_spec.rb +15 -9
- data/spec/models/list_response_dto_of_topic_dto_spec.rb +15 -9
- data/spec/models/list_response_dto_of_user_dto_spec.rb +15 -9
- data/spec/models/localized_text_spec.rb +34 -0
- data/spec/models/log_entry_dto_spec.rb +15 -9
- data/spec/models/media_dto_spec.rb +21 -9
- data/spec/models/media_metadata_spec.rb +34 -0
- data/spec/models/media_type_spec.rb +15 -9
- data/spec/models/mobile_device_type_spec.rb +34 -0
- data/spec/models/mobile_push_token_dto_spec.rb +46 -0
- data/spec/models/notification_dto_spec.rb +124 -0
- data/spec/models/notification_formatting_dto_spec.rb +15 -9
- data/spec/models/notification_send_spec.rb +34 -0
- data/spec/models/notification_setting_dto_spec.rb +16 -10
- data/spec/models/profile_dto_spec.rb +82 -0
- data/spec/models/{publish_request_dto_spec.rb → publish_dto_spec.rb} +18 -12
- data/spec/models/publish_many_dto_spec.rb +40 -0
- data/spec/models/register_mobile_token_dto_spec.rb +46 -0
- data/spec/models/resize_mode_spec.rb +15 -9
- data/spec/models/scheduling_dto_spec.rb +15 -9
- data/spec/models/scheduling_type_spec.rb +15 -9
- data/spec/models/subscription_dto_spec.rb +15 -9
- data/spec/models/template_dto_spec.rb +15 -9
- data/spec/models/topic_dto_spec.rb +15 -9
- data/spec/models/track_notification_dto_spec.rb +58 -0
- data/spec/models/update_integration_dto_spec.rb +58 -0
- data/spec/models/update_profile_dto_spec.rb +70 -0
- data/spec/models/upsert_app_dto_spec.rb +15 -9
- data/spec/models/upsert_template_dto_spec.rb +15 -9
- data/spec/models/upsert_templates_dto_spec.rb +15 -9
- data/spec/models/upsert_user_dto_spec.rb +15 -9
- data/spec/models/upsert_users_dto_spec.rb +15 -9
- data/spec/models/user_dto_spec.rb +15 -9
- data/spec/spec_helper.rb +4 -5
- metadata +167 -30
- data/docs/AddAllowedTopicRequest.md +0 -18
- data/docs/InlineObject.md +0 -18
- data/docs/PublishManyRequestDto.md +0 -18
- data/docs/PublishRequestDto.md +0 -36
- data/docs/SubscribeDto.md +0 -20
- data/notifo-io-1.0.0.gem +0 -0
- data/notifo-io-1.0.0.pre.beta.gem +0 -0
- data/spec/models/add_allowed_topic_request_spec.rb +0 -34
- data/spec/models/inline_object_spec.rb +0 -34
- data/spec/models/publish_many_request_dto_spec.rb +0 -34
- data/spec/models/subscribe_dto_spec.rb +0 -40
data/Rakefile
CHANGED
data/docs/AddContributorDto.md
CHANGED
@@ -1,20 +1,8 @@
|
|
1
1
|
# Notifo::AddContributorDto
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
|
7
|
-
|
8
|
-
| **role** | **String** | The role. | [optional] |
|
9
|
-
|
10
|
-
## Example
|
11
|
-
|
12
|
-
```ruby
|
13
|
-
require 'notifo'
|
14
|
-
|
15
|
-
instance = Notifo::AddContributorDto.new(
|
16
|
-
email: null,
|
17
|
-
role: null
|
18
|
-
)
|
19
|
-
```
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**email** | **String** | The email of the new contributor. |
|
7
|
+
**role** | **String** | The role. |
|
20
8
|
|
data/docs/AppContributorDto.md
CHANGED
@@ -1,22 +1,9 @@
|
|
1
1
|
# Notifo::AppContributorDto
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
|
7
|
-
|
8
|
-
|
9
|
-
| **role** | **String** | The role. | [optional] |
|
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
|
-
```
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**user_id** | **String** | The id of the user. |
|
7
|
+
**user_name** | **String** | The name of the user. |
|
8
|
+
**role** | **String** | The role. |
|
22
9
|
|
data/docs/AppDetailsDto.md
CHANGED
@@ -1,48 +1,14 @@
|
|
1
1
|
# Notifo::AppDetailsDto
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
|
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. | [optional] |
|
18
|
-
| **allow_sms** | **Boolean** | True, when SMS are allowed. | [optional] |
|
19
|
-
| **email_verification_status** | [**OneOfEmailVerificationStatus**](OneOfEmailVerificationStatus.md) | The verification status of the email. | [optional] |
|
20
|
-
| **api_keys** | **Hash<String, String>** | The api keys. | [optional] |
|
21
|
-
| **contributors** | [**Array<AppContributorDto>**](AppContributorDto.md) | The contributors. | [optional] |
|
22
|
-
| **counters** | [**OneOfmap**](OneOfmap.md) | The statistics counters. | [optional] |
|
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
|
-
```
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **String** | The id of the app. |
|
7
|
+
**name** | **String** | The app name. |
|
8
|
+
**role** | **String** | The current role. |
|
9
|
+
**languages** | **Array<String>** | The supported languages. |
|
10
|
+
**confirm_url** | **String** | The confirm URL. | [optional]
|
11
|
+
**api_keys** | **Hash<String, String>** | The api keys. |
|
12
|
+
**contributors** | [**Array<AppContributorDto>**](AppContributorDto.md) | The contributors. |
|
13
|
+
**counters** | **Hash<String, Integer>** | The statistics counters. |
|
48
14
|
|
data/docs/AppDto.md
CHANGED
@@ -1,28 +1,12 @@
|
|
1
1
|
# Notifo::AppDto
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
| **counters** | [**OneOfmap**](OneOfmap.md) | The statistics counters. | [optional] |
|
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
|
-
```
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **String** | The id of the app. |
|
7
|
+
**name** | **String** | The app name. |
|
8
|
+
**role** | **String** | The current role. |
|
9
|
+
**languages** | **Array<String>** | The supported languages. |
|
10
|
+
**api_keys** | **Hash<String, String>** | The api keys. |
|
11
|
+
**counters** | **Hash<String, Integer>** | The statistics counters. |
|
28
12
|
|
data/docs/AppsApi.md
CHANGED
@@ -1,70 +1,54 @@
|
|
1
1
|
# Notifo::AppsApi
|
2
2
|
|
3
|
-
All URIs are relative to *https://
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
|
20
|
-
|
21
|
-
|
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) | **DELETE** /api/apps/{appId}/email-templates/{language} | Delete an app email template.
|
9
|
+
[**apps_delete_integration**](AppsApi.md#apps_delete_integration) | **DELETE** /api/apps/{appId}/integrations/{id} | Delete an app integration.
|
10
|
+
[**apps_get_app**](AppsApi.md#apps_get_app) | **GET** /api/apps/{appId} | Get app by id.
|
11
|
+
[**apps_get_apps**](AppsApi.md#apps_get_apps) | **GET** /api/apps | Get the user apps.
|
12
|
+
[**apps_get_email_templates**](AppsApi.md#apps_get_email_templates) | **GET** /api/apps/{appId}/email-templates | Get the app email templates.
|
13
|
+
[**apps_get_integrations**](AppsApi.md#apps_get_integrations) | **GET** /api/apps/{appId}/integrations | Get the app integrations.
|
14
|
+
[**apps_post_app**](AppsApi.md#apps_post_app) | **POST** /api/apps | Create an app.
|
15
|
+
[**apps_post_contributor**](AppsApi.md#apps_post_contributor) | **POST** /api/apps/{appId}/contributors | Add an app contributor.
|
16
|
+
[**apps_post_email_template**](AppsApi.md#apps_post_email_template) | **POST** /api/apps/{appId}/email-templates | Create an app email template.
|
17
|
+
[**apps_post_integration**](AppsApi.md#apps_post_integration) | **POST** /api/apps/{appId}/integration | Create an app integrations.
|
18
|
+
[**apps_put_app**](AppsApi.md#apps_put_app) | **POST** /api/apps/{appId} | Update an app.
|
19
|
+
[**apps_put_email_template**](AppsApi.md#apps_put_email_template) | **PUT** /api/apps/{appId}/email-templates/{language} | Update an app email template.
|
20
|
+
[**apps_put_integration**](AppsApi.md#apps_put_integration) | **PUT** /api/apps/{appId}/integrations/{id} | Update an app integration.
|
21
|
+
|
22
|
+
# **apps_delete_contributor**
|
23
|
+
> AppDetailsDto apps_delete_contributor(app_id, contributor_id)
|
22
24
|
|
23
25
|
Delete an app contributor.
|
24
26
|
|
25
|
-
###
|
26
|
-
|
27
|
+
### Example
|
27
28
|
```ruby
|
28
|
-
|
29
|
+
# load the gem
|
29
30
|
require 'notifo'
|
30
31
|
|
31
32
|
api_instance = Notifo::AppsApi.new
|
32
33
|
app_id = 'app_id_example' # String | The id of the app.
|
33
34
|
contributor_id = 'contributor_id_example' # String | The contributor to remove.
|
34
35
|
|
36
|
+
|
35
37
|
begin
|
36
|
-
#
|
38
|
+
#Delete an app contributor.
|
37
39
|
result = api_instance.apps_delete_contributor(app_id, contributor_id)
|
38
40
|
p result
|
39
41
|
rescue Notifo::ApiError => e
|
40
|
-
puts "
|
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}"
|
42
|
+
puts "Exception when calling AppsApi->apps_delete_contributor: #{e}"
|
59
43
|
end
|
60
44
|
```
|
61
45
|
|
62
46
|
### Parameters
|
63
47
|
|
64
|
-
|
65
|
-
|
66
|
-
|
67
|
-
|
48
|
+
Name | Type | Description | Notes
|
49
|
+
------------- | ------------- | ------------- | -------------
|
50
|
+
**app_id** | **String**| The id of the app. |
|
51
|
+
**contributor_id** | **String**| The contributor to remove. |
|
68
52
|
|
69
53
|
### Return type
|
70
54
|
|
@@ -76,58 +60,85 @@ No authorization required
|
|
76
60
|
|
77
61
|
### HTTP request headers
|
78
62
|
|
79
|
-
- **Content-Type**: Not defined
|
80
|
-
- **Accept**: application/json
|
63
|
+
- **Content-Type**: Not defined
|
64
|
+
- **Accept**: application/json
|
81
65
|
|
82
66
|
|
83
|
-
## apps_delete_email_template
|
84
67
|
|
68
|
+
# **apps_delete_email_template**
|
85
69
|
> apps_delete_email_template(app_id, language)
|
86
70
|
|
87
71
|
Delete an app email template.
|
88
72
|
|
89
|
-
###
|
90
|
-
|
73
|
+
### Example
|
91
74
|
```ruby
|
92
|
-
|
75
|
+
# load the gem
|
93
76
|
require 'notifo'
|
94
77
|
|
95
78
|
api_instance = Notifo::AppsApi.new
|
96
79
|
app_id = 'app_id_example' # String | The id of the app where the email templates belong to.
|
97
80
|
language = 'language_example' # String | The language.
|
98
81
|
|
82
|
+
|
99
83
|
begin
|
100
|
-
#
|
84
|
+
#Delete an app email template.
|
101
85
|
api_instance.apps_delete_email_template(app_id, language)
|
102
86
|
rescue Notifo::ApiError => e
|
103
|
-
puts "
|
87
|
+
puts "Exception when calling AppsApi->apps_delete_email_template: #{e}"
|
104
88
|
end
|
105
89
|
```
|
106
90
|
|
107
|
-
|
91
|
+
### Parameters
|
108
92
|
|
109
|
-
|
93
|
+
Name | Type | Description | Notes
|
94
|
+
------------- | ------------- | ------------- | -------------
|
95
|
+
**app_id** | **String**| The id of the app where the email templates belong to. |
|
96
|
+
**language** | **String**| The language. |
|
110
97
|
|
111
|
-
|
98
|
+
### Return type
|
99
|
+
|
100
|
+
nil (empty response body)
|
112
101
|
|
102
|
+
### Authorization
|
103
|
+
|
104
|
+
No authorization required
|
105
|
+
|
106
|
+
### HTTP request headers
|
107
|
+
|
108
|
+
- **Content-Type**: Not defined
|
109
|
+
- **Accept**: application/json
|
110
|
+
|
111
|
+
|
112
|
+
|
113
|
+
# **apps_delete_integration**
|
114
|
+
> apps_delete_integration(app_id, id)
|
115
|
+
|
116
|
+
Delete an app integration.
|
117
|
+
|
118
|
+
### Example
|
113
119
|
```ruby
|
120
|
+
# load the gem
|
121
|
+
require 'notifo'
|
122
|
+
|
123
|
+
api_instance = Notifo::AppsApi.new
|
124
|
+
app_id = 'app_id_example' # String | The id of the app where the email templates belong to.
|
125
|
+
id = 'id_example' # String | The id of the integration.
|
126
|
+
|
127
|
+
|
114
128
|
begin
|
115
|
-
#
|
116
|
-
|
117
|
-
p status_code # => 2xx
|
118
|
-
p headers # => { ... }
|
119
|
-
p data # => nil
|
129
|
+
#Delete an app integration.
|
130
|
+
api_instance.apps_delete_integration(app_id, id)
|
120
131
|
rescue Notifo::ApiError => e
|
121
|
-
puts "
|
132
|
+
puts "Exception when calling AppsApi->apps_delete_integration: #{e}"
|
122
133
|
end
|
123
134
|
```
|
124
135
|
|
125
136
|
### Parameters
|
126
137
|
|
127
|
-
|
128
|
-
|
129
|
-
|
130
|
-
|
138
|
+
Name | Type | Description | Notes
|
139
|
+
------------- | ------------- | ------------- | -------------
|
140
|
+
**app_id** | **String**| The id of the app where the email templates belong to. |
|
141
|
+
**id** | **String**| The id of the integration. |
|
131
142
|
|
132
143
|
### Return type
|
133
144
|
|
@@ -139,57 +150,39 @@ No authorization required
|
|
139
150
|
|
140
151
|
### HTTP request headers
|
141
152
|
|
142
|
-
- **Content-Type**: Not defined
|
143
|
-
- **Accept**: application/json
|
153
|
+
- **Content-Type**: Not defined
|
154
|
+
- **Accept**: application/json
|
144
155
|
|
145
156
|
|
146
|
-
## apps_get_app
|
147
157
|
|
148
|
-
|
158
|
+
# **apps_get_app**
|
159
|
+
> AppDetailsDto apps_get_app(app_id)
|
149
160
|
|
150
161
|
Get app by id.
|
151
162
|
|
152
|
-
###
|
153
|
-
|
163
|
+
### Example
|
154
164
|
```ruby
|
155
|
-
|
165
|
+
# load the gem
|
156
166
|
require 'notifo'
|
157
167
|
|
158
168
|
api_instance = Notifo::AppsApi.new
|
159
169
|
app_id = 'app_id_example' # String | The id of the app.
|
160
170
|
|
171
|
+
|
161
172
|
begin
|
162
|
-
#
|
173
|
+
#Get app by id.
|
163
174
|
result = api_instance.apps_get_app(app_id)
|
164
175
|
p result
|
165
176
|
rescue Notifo::ApiError => e
|
166
|
-
puts "
|
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}"
|
177
|
+
puts "Exception when calling AppsApi->apps_get_app: #{e}"
|
185
178
|
end
|
186
179
|
```
|
187
180
|
|
188
181
|
### Parameters
|
189
182
|
|
190
|
-
|
191
|
-
|
192
|
-
|
183
|
+
Name | Type | Description | Notes
|
184
|
+
------------- | ------------- | ------------- | -------------
|
185
|
+
**app_id** | **String**| The id of the app. |
|
193
186
|
|
194
187
|
### Return type
|
195
188
|
|
@@ -201,53 +194,33 @@ No authorization required
|
|
201
194
|
|
202
195
|
### HTTP request headers
|
203
196
|
|
204
|
-
- **Content-Type**: Not defined
|
205
|
-
- **Accept**: application/json
|
197
|
+
- **Content-Type**: Not defined
|
198
|
+
- **Accept**: application/json
|
206
199
|
|
207
200
|
|
208
|
-
## apps_get_apps
|
209
201
|
|
210
|
-
|
202
|
+
# **apps_get_apps**
|
203
|
+
> Array<AppDto> apps_get_apps
|
211
204
|
|
212
205
|
Get the user apps.
|
213
206
|
|
214
|
-
###
|
215
|
-
|
207
|
+
### Example
|
216
208
|
```ruby
|
217
|
-
|
209
|
+
# load the gem
|
218
210
|
require 'notifo'
|
219
211
|
|
220
212
|
api_instance = Notifo::AppsApi.new
|
221
213
|
|
222
214
|
begin
|
223
|
-
#
|
215
|
+
#Get the user apps.
|
224
216
|
result = api_instance.apps_get_apps
|
225
217
|
p result
|
226
218
|
rescue Notifo::ApiError => e
|
227
|
-
puts "
|
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}"
|
219
|
+
puts "Exception when calling AppsApi->apps_get_apps: #{e}"
|
246
220
|
end
|
247
221
|
```
|
248
222
|
|
249
223
|
### Parameters
|
250
|
-
|
251
224
|
This endpoint does not need any parameter.
|
252
225
|
|
253
226
|
### Return type
|
@@ -260,61 +233,87 @@ No authorization required
|
|
260
233
|
|
261
234
|
### HTTP request headers
|
262
235
|
|
263
|
-
- **Content-Type**: Not defined
|
264
|
-
- **Accept**: application/json
|
236
|
+
- **Content-Type**: Not defined
|
237
|
+
- **Accept**: application/json
|
265
238
|
|
266
239
|
|
267
|
-
## apps_get_email_templates
|
268
240
|
|
269
|
-
|
241
|
+
# **apps_get_email_templates**
|
242
|
+
> EmailTemplatesDto apps_get_email_templates(app_id)
|
270
243
|
|
271
244
|
Get the app email templates.
|
272
245
|
|
273
|
-
###
|
274
|
-
|
246
|
+
### Example
|
275
247
|
```ruby
|
276
|
-
|
248
|
+
# load the gem
|
277
249
|
require 'notifo'
|
278
250
|
|
279
251
|
api_instance = Notifo::AppsApi.new
|
280
252
|
app_id = 'app_id_example' # String | The id of the app where the email templates belong to.
|
281
253
|
|
254
|
+
|
282
255
|
begin
|
283
|
-
#
|
256
|
+
#Get the app email templates.
|
284
257
|
result = api_instance.apps_get_email_templates(app_id)
|
285
258
|
p result
|
286
259
|
rescue Notifo::ApiError => e
|
287
|
-
puts "
|
260
|
+
puts "Exception when calling AppsApi->apps_get_email_templates: #{e}"
|
288
261
|
end
|
289
262
|
```
|
290
263
|
|
291
|
-
|
264
|
+
### Parameters
|
265
|
+
|
266
|
+
Name | Type | Description | Notes
|
267
|
+
------------- | ------------- | ------------- | -------------
|
268
|
+
**app_id** | **String**| The id of the app where the email templates belong to. |
|
269
|
+
|
270
|
+
### Return type
|
271
|
+
|
272
|
+
[**EmailTemplatesDto**](EmailTemplatesDto.md)
|
273
|
+
|
274
|
+
### Authorization
|
275
|
+
|
276
|
+
No authorization required
|
277
|
+
|
278
|
+
### HTTP request headers
|
279
|
+
|
280
|
+
- **Content-Type**: Not defined
|
281
|
+
- **Accept**: application/json
|
282
|
+
|
283
|
+
|
292
284
|
|
293
|
-
|
285
|
+
# **apps_get_integrations**
|
286
|
+
> ConfiguredIntegrationsDto apps_get_integrations(app_id)
|
294
287
|
|
295
|
-
|
288
|
+
Get the app integrations.
|
296
289
|
|
290
|
+
### Example
|
297
291
|
```ruby
|
292
|
+
# load the gem
|
293
|
+
require 'notifo'
|
294
|
+
|
295
|
+
api_instance = Notifo::AppsApi.new
|
296
|
+
app_id = 'app_id_example' # String | The id of the app where the integrations belong to.
|
297
|
+
|
298
|
+
|
298
299
|
begin
|
299
|
-
#
|
300
|
-
|
301
|
-
p
|
302
|
-
p headers # => { ... }
|
303
|
-
p data # => <Hash<String, EmailTemplateDto>>
|
300
|
+
#Get the app integrations.
|
301
|
+
result = api_instance.apps_get_integrations(app_id)
|
302
|
+
p result
|
304
303
|
rescue Notifo::ApiError => e
|
305
|
-
puts "
|
304
|
+
puts "Exception when calling AppsApi->apps_get_integrations: #{e}"
|
306
305
|
end
|
307
306
|
```
|
308
307
|
|
309
308
|
### Parameters
|
310
309
|
|
311
|
-
|
312
|
-
|
313
|
-
|
310
|
+
Name | Type | Description | Notes
|
311
|
+
------------- | ------------- | ------------- | -------------
|
312
|
+
**app_id** | **String**| The id of the app where the integrations belong to. |
|
314
313
|
|
315
314
|
### Return type
|
316
315
|
|
317
|
-
[**
|
316
|
+
[**ConfiguredIntegrationsDto**](ConfiguredIntegrationsDto.md)
|
318
317
|
|
319
318
|
### Authorization
|
320
319
|
|
@@ -322,57 +321,39 @@ No authorization required
|
|
322
321
|
|
323
322
|
### HTTP request headers
|
324
323
|
|
325
|
-
- **Content-Type**: Not defined
|
326
|
-
- **Accept**: application/json
|
324
|
+
- **Content-Type**: Not defined
|
325
|
+
- **Accept**: application/json
|
327
326
|
|
328
327
|
|
329
|
-
## apps_post_app
|
330
328
|
|
331
|
-
|
329
|
+
# **apps_post_app**
|
330
|
+
> AppDto apps_post_app(body)
|
332
331
|
|
333
332
|
Create an app.
|
334
333
|
|
335
|
-
###
|
336
|
-
|
334
|
+
### Example
|
337
335
|
```ruby
|
338
|
-
|
336
|
+
# load the gem
|
339
337
|
require 'notifo'
|
340
338
|
|
341
339
|
api_instance = Notifo::AppsApi.new
|
342
|
-
|
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.
|
340
|
+
body = Notifo::UpsertAppDto.new # UpsertAppDto | The request object.
|
356
341
|
|
357
|
-
> <Array(<AppDto>, Integer, Hash)> apps_post_app_with_http_info(upsert_app_dto)
|
358
342
|
|
359
|
-
```ruby
|
360
343
|
begin
|
361
|
-
#
|
362
|
-
|
363
|
-
p
|
364
|
-
p headers # => { ... }
|
365
|
-
p data # => <AppDto>
|
344
|
+
#Create an app.
|
345
|
+
result = api_instance.apps_post_app(body)
|
346
|
+
p result
|
366
347
|
rescue Notifo::ApiError => e
|
367
|
-
puts "
|
348
|
+
puts "Exception when calling AppsApi->apps_post_app: #{e}"
|
368
349
|
end
|
369
350
|
```
|
370
351
|
|
371
352
|
### Parameters
|
372
353
|
|
373
|
-
|
374
|
-
|
375
|
-
|
354
|
+
Name | Type | Description | Notes
|
355
|
+
------------- | ------------- | ------------- | -------------
|
356
|
+
**body** | [**UpsertAppDto**](UpsertAppDto.md)| The request object. |
|
376
357
|
|
377
358
|
### Return type
|
378
359
|
|
@@ -384,59 +365,41 @@ No authorization required
|
|
384
365
|
|
385
366
|
### HTTP request headers
|
386
367
|
|
387
|
-
- **Content-Type**: application/json
|
388
|
-
- **Accept**: application/json
|
368
|
+
- **Content-Type**: application/json
|
369
|
+
- **Accept**: application/json
|
389
370
|
|
390
371
|
|
391
|
-
## apps_post_contributor
|
392
372
|
|
393
|
-
|
373
|
+
# **apps_post_contributor**
|
374
|
+
> AppDetailsDto apps_post_contributor(bodyapp_id)
|
394
375
|
|
395
376
|
Add an app contributor.
|
396
377
|
|
397
|
-
###
|
398
|
-
|
378
|
+
### Example
|
399
379
|
```ruby
|
400
|
-
|
380
|
+
# load the gem
|
401
381
|
require 'notifo'
|
402
382
|
|
403
383
|
api_instance = Notifo::AppsApi.new
|
384
|
+
body = Notifo::AddContributorDto.new # AddContributorDto | The request object.
|
404
385
|
app_id = 'app_id_example' # String | The id of the app.
|
405
|
-
add_contributor_dto = Notifo::AddContributorDto.new # 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
386
|
|
418
|
-
This returns an Array which contains the response data, status code and headers.
|
419
387
|
|
420
|
-
> <Array(<AppDetailsDto>, Integer, Hash)> apps_post_contributor_with_http_info(app_id, add_contributor_dto)
|
421
|
-
|
422
|
-
```ruby
|
423
388
|
begin
|
424
|
-
#
|
425
|
-
|
426
|
-
p
|
427
|
-
p headers # => { ... }
|
428
|
-
p data # => <AppDetailsDto>
|
389
|
+
#Add an app contributor.
|
390
|
+
result = api_instance.apps_post_contributor(bodyapp_id)
|
391
|
+
p result
|
429
392
|
rescue Notifo::ApiError => e
|
430
|
-
puts "
|
393
|
+
puts "Exception when calling AppsApi->apps_post_contributor: #{e}"
|
431
394
|
end
|
432
395
|
```
|
433
396
|
|
434
397
|
### Parameters
|
435
398
|
|
436
|
-
|
437
|
-
|
438
|
-
|
439
|
-
|
399
|
+
Name | Type | Description | Notes
|
400
|
+
------------- | ------------- | ------------- | -------------
|
401
|
+
**body** | [**AddContributorDto**](AddContributorDto.md)| The request object. |
|
402
|
+
**app_id** | **String**| The id of the app. |
|
440
403
|
|
441
404
|
### Return type
|
442
405
|
|
@@ -448,63 +411,91 @@ No authorization required
|
|
448
411
|
|
449
412
|
### HTTP request headers
|
450
413
|
|
451
|
-
- **Content-Type**: application/json
|
452
|
-
- **Accept**: application/json
|
414
|
+
- **Content-Type**: application/json
|
415
|
+
- **Accept**: application/json
|
453
416
|
|
454
417
|
|
455
|
-
## apps_post_email_template
|
456
418
|
|
457
|
-
|
419
|
+
# **apps_post_email_template**
|
420
|
+
> EmailTemplateDto apps_post_email_template(bodyapp_id)
|
458
421
|
|
459
422
|
Create an app email template.
|
460
423
|
|
461
|
-
###
|
462
|
-
|
424
|
+
### Example
|
463
425
|
```ruby
|
464
|
-
|
426
|
+
# load the gem
|
465
427
|
require 'notifo'
|
466
428
|
|
467
429
|
api_instance = Notifo::AppsApi.new
|
430
|
+
body = Notifo::CreateEmailTemplateDto.new # CreateEmailTemplateDto | The request object.
|
468
431
|
app_id = 'app_id_example' # String | The id of the app where the email templates belong to.
|
469
|
-
|
432
|
+
|
470
433
|
|
471
434
|
begin
|
472
|
-
#
|
473
|
-
result = api_instance.apps_post_email_template(
|
435
|
+
#Create an app email template.
|
436
|
+
result = api_instance.apps_post_email_template(bodyapp_id)
|
474
437
|
p result
|
475
438
|
rescue Notifo::ApiError => e
|
476
|
-
puts "
|
439
|
+
puts "Exception when calling AppsApi->apps_post_email_template: #{e}"
|
477
440
|
end
|
478
441
|
```
|
479
442
|
|
480
|
-
|
443
|
+
### Parameters
|
444
|
+
|
445
|
+
Name | Type | Description | Notes
|
446
|
+
------------- | ------------- | ------------- | -------------
|
447
|
+
**body** | [**CreateEmailTemplateDto**](CreateEmailTemplateDto.md)| The request object. |
|
448
|
+
**app_id** | **String**| The id of the app where the email templates belong to. |
|
449
|
+
|
450
|
+
### Return type
|
451
|
+
|
452
|
+
[**EmailTemplateDto**](EmailTemplateDto.md)
|
481
453
|
|
482
|
-
|
454
|
+
### Authorization
|
455
|
+
|
456
|
+
No authorization required
|
457
|
+
|
458
|
+
### HTTP request headers
|
483
459
|
|
484
|
-
|
460
|
+
- **Content-Type**: application/json
|
461
|
+
- **Accept**: application/json
|
485
462
|
|
463
|
+
|
464
|
+
|
465
|
+
# **apps_post_integration**
|
466
|
+
> IntegrationCreatedDto apps_post_integration(bodyapp_id)
|
467
|
+
|
468
|
+
Create an app integrations.
|
469
|
+
|
470
|
+
### Example
|
486
471
|
```ruby
|
472
|
+
# load the gem
|
473
|
+
require 'notifo'
|
474
|
+
|
475
|
+
api_instance = Notifo::AppsApi.new
|
476
|
+
body = Notifo::CreateIntegrationDto.new # CreateIntegrationDto | The request object.
|
477
|
+
app_id = 'app_id_example' # String | The id of the app where the integration belong to.
|
478
|
+
|
479
|
+
|
487
480
|
begin
|
488
|
-
#
|
489
|
-
|
490
|
-
p
|
491
|
-
p headers # => { ... }
|
492
|
-
p data # => <Hash<String, EmailTemplateDto>>
|
481
|
+
#Create an app integrations.
|
482
|
+
result = api_instance.apps_post_integration(bodyapp_id)
|
483
|
+
p result
|
493
484
|
rescue Notifo::ApiError => e
|
494
|
-
puts "
|
485
|
+
puts "Exception when calling AppsApi->apps_post_integration: #{e}"
|
495
486
|
end
|
496
487
|
```
|
497
488
|
|
498
489
|
### Parameters
|
499
490
|
|
500
|
-
|
501
|
-
|
502
|
-
|
503
|
-
|
491
|
+
Name | Type | Description | Notes
|
492
|
+
------------- | ------------- | ------------- | -------------
|
493
|
+
**body** | [**CreateIntegrationDto**](CreateIntegrationDto.md)| The request object. |
|
494
|
+
**app_id** | **String**| The id of the app where the integration belong to. |
|
504
495
|
|
505
496
|
### Return type
|
506
497
|
|
507
|
-
[**
|
498
|
+
[**IntegrationCreatedDto**](IntegrationCreatedDto.md)
|
508
499
|
|
509
500
|
### Authorization
|
510
501
|
|
@@ -512,59 +503,41 @@ No authorization required
|
|
512
503
|
|
513
504
|
### HTTP request headers
|
514
505
|
|
515
|
-
- **Content-Type**: application/json
|
516
|
-
- **Accept**: application/json
|
506
|
+
- **Content-Type**: application/json
|
507
|
+
- **Accept**: application/json
|
517
508
|
|
518
509
|
|
519
|
-
## apps_put_app
|
520
510
|
|
521
|
-
|
511
|
+
# **apps_put_app**
|
512
|
+
> AppDetailsDto apps_put_app(bodyapp_id)
|
522
513
|
|
523
514
|
Update an app.
|
524
515
|
|
525
|
-
###
|
526
|
-
|
516
|
+
### Example
|
527
517
|
```ruby
|
528
|
-
|
518
|
+
# load the gem
|
529
519
|
require 'notifo'
|
530
520
|
|
531
521
|
api_instance = Notifo::AppsApi.new
|
522
|
+
body = Notifo::UpsertAppDto.new # UpsertAppDto | The request object.
|
532
523
|
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
524
|
|
546
|
-
This returns an Array which contains the response data, status code and headers.
|
547
525
|
|
548
|
-
> <Array(<AppDetailsDto>, Integer, Hash)> apps_put_app_with_http_info(app_id, upsert_app_dto)
|
549
|
-
|
550
|
-
```ruby
|
551
526
|
begin
|
552
|
-
#
|
553
|
-
|
554
|
-
p
|
555
|
-
p headers # => { ... }
|
556
|
-
p data # => <AppDetailsDto>
|
527
|
+
#Update an app.
|
528
|
+
result = api_instance.apps_put_app(bodyapp_id)
|
529
|
+
p result
|
557
530
|
rescue Notifo::ApiError => e
|
558
|
-
puts "
|
531
|
+
puts "Exception when calling AppsApi->apps_put_app: #{e}"
|
559
532
|
end
|
560
533
|
```
|
561
534
|
|
562
535
|
### Parameters
|
563
536
|
|
564
|
-
|
565
|
-
|
566
|
-
|
567
|
-
|
537
|
+
Name | Type | Description | Notes
|
538
|
+
------------- | ------------- | ------------- | -------------
|
539
|
+
**body** | [**UpsertAppDto**](UpsertAppDto.md)| The request object. |
|
540
|
+
**app_id** | **String**| The app id to update. |
|
568
541
|
|
569
542
|
### Return type
|
570
543
|
|
@@ -576,60 +549,89 @@ No authorization required
|
|
576
549
|
|
577
550
|
### HTTP request headers
|
578
551
|
|
579
|
-
- **Content-Type**: application/json
|
580
|
-
- **Accept**: application/json
|
552
|
+
- **Content-Type**: application/json
|
553
|
+
- **Accept**: application/json
|
581
554
|
|
582
555
|
|
583
|
-
## apps_put_email_template
|
584
556
|
|
585
|
-
|
557
|
+
# **apps_put_email_template**
|
558
|
+
> apps_put_email_template(bodyapp_idlanguage)
|
586
559
|
|
587
560
|
Update an app email template.
|
588
561
|
|
589
|
-
###
|
590
|
-
|
562
|
+
### Example
|
591
563
|
```ruby
|
592
|
-
|
564
|
+
# load the gem
|
593
565
|
require 'notifo'
|
594
566
|
|
595
567
|
api_instance = Notifo::AppsApi.new
|
568
|
+
body = Notifo::EmailTemplateDto.new # EmailTemplateDto | The request object.
|
596
569
|
app_id = 'app_id_example' # String | The id of the app where the email templates belong to.
|
597
570
|
language = 'language_example' # String | The language.
|
598
|
-
|
571
|
+
|
599
572
|
|
600
573
|
begin
|
601
|
-
#
|
602
|
-
api_instance.apps_put_email_template(
|
574
|
+
#Update an app email template.
|
575
|
+
api_instance.apps_put_email_template(bodyapp_idlanguage)
|
603
576
|
rescue Notifo::ApiError => e
|
604
|
-
puts "
|
577
|
+
puts "Exception when calling AppsApi->apps_put_email_template: #{e}"
|
605
578
|
end
|
606
579
|
```
|
607
580
|
|
608
|
-
|
581
|
+
### Parameters
|
582
|
+
|
583
|
+
Name | Type | Description | Notes
|
584
|
+
------------- | ------------- | ------------- | -------------
|
585
|
+
**body** | [**EmailTemplateDto**](EmailTemplateDto.md)| The request object. |
|
586
|
+
**app_id** | **String**| The id of the app where the email templates belong to. |
|
587
|
+
**language** | **String**| The language. |
|
609
588
|
|
610
|
-
|
589
|
+
### Return type
|
590
|
+
|
591
|
+
nil (empty response body)
|
592
|
+
|
593
|
+
### Authorization
|
594
|
+
|
595
|
+
No authorization required
|
596
|
+
|
597
|
+
### HTTP request headers
|
598
|
+
|
599
|
+
- **Content-Type**: application/json
|
600
|
+
- **Accept**: application/json
|
611
601
|
|
612
|
-
> <Array(nil, Integer, Hash)> apps_put_email_template_with_http_info(app_id, language, email_template_dto)
|
613
602
|
|
603
|
+
|
604
|
+
# **apps_put_integration**
|
605
|
+
> apps_put_integration(bodyapp_idid)
|
606
|
+
|
607
|
+
Update an app integration.
|
608
|
+
|
609
|
+
### Example
|
614
610
|
```ruby
|
611
|
+
# load the gem
|
612
|
+
require 'notifo'
|
613
|
+
|
614
|
+
api_instance = Notifo::AppsApi.new
|
615
|
+
body = Notifo::UpdateIntegrationDto.new # UpdateIntegrationDto | The request object.
|
616
|
+
app_id = 'app_id_example' # String | The id of the app where the integration belong to.
|
617
|
+
id = 'id_example' # String | The id of the integration.
|
618
|
+
|
619
|
+
|
615
620
|
begin
|
616
|
-
#
|
617
|
-
|
618
|
-
p status_code # => 2xx
|
619
|
-
p headers # => { ... }
|
620
|
-
p data # => nil
|
621
|
+
#Update an app integration.
|
622
|
+
api_instance.apps_put_integration(bodyapp_idid)
|
621
623
|
rescue Notifo::ApiError => e
|
622
|
-
puts "
|
624
|
+
puts "Exception when calling AppsApi->apps_put_integration: #{e}"
|
623
625
|
end
|
624
626
|
```
|
625
627
|
|
626
628
|
### Parameters
|
627
629
|
|
628
|
-
|
629
|
-
|
630
|
-
|
631
|
-
|
632
|
-
|
630
|
+
Name | Type | Description | Notes
|
631
|
+
------------- | ------------- | ------------- | -------------
|
632
|
+
**body** | [**UpdateIntegrationDto**](UpdateIntegrationDto.md)| The request object. |
|
633
|
+
**app_id** | **String**| The id of the app where the integration belong to. |
|
634
|
+
**id** | **String**| The id of the integration. |
|
633
635
|
|
634
636
|
### Return type
|
635
637
|
|
@@ -641,6 +643,8 @@ No authorization required
|
|
641
643
|
|
642
644
|
### HTTP request headers
|
643
645
|
|
644
|
-
- **Content-Type**: application/json
|
645
|
-
- **Accept**: application/json
|
646
|
+
- **Content-Type**: application/json
|
647
|
+
- **Accept**: application/json
|
648
|
+
|
649
|
+
|
646
650
|
|