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/docs/TopicsApi.md
CHANGED
@@ -1,133 +1,46 @@
|
|
1
1
|
# Notifo::TopicsApi
|
2
2
|
|
3
|
-
All URIs are relative to *https://
|
3
|
+
All URIs are relative to *https://notifo.easierlife.com*
|
4
4
|
|
5
|
-
|
6
|
-
|
7
|
-
|
8
|
-
| [**topics_get_topics**](TopicsApi.md#topics_get_topics) | **GET** /api/apps/{appId}/topics | Query topics. |
|
9
|
-
| [**topics_subscribe**](TopicsApi.md#topics_subscribe) | **POST** /api/web/subscriptions/{topic} | Creates a user subscription. |
|
10
|
-
| [**topics_unsubscribe**](TopicsApi.md#topics_unsubscribe) | **DELETE** /api/web/subscriptions/{topic} | Deletes a user subscription. |
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**topics_get_topics**](TopicsApi.md#topics_get_topics) | **GET** /api/apps/{appId}/topics | Query topics.
|
11
8
|
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
> topics_get_subscription(topic)
|
16
|
-
|
17
|
-
Gets a user subscription.
|
18
|
-
|
19
|
-
User Id and App Id are resolved using the API token.
|
20
|
-
|
21
|
-
### Examples
|
22
|
-
|
23
|
-
```ruby
|
24
|
-
require 'time'
|
25
|
-
require 'notifo'
|
26
|
-
|
27
|
-
api_instance = Notifo::TopicsApi.new
|
28
|
-
topic = 'topic_example' # String | The topic path.
|
29
|
-
|
30
|
-
begin
|
31
|
-
# Gets a user subscription.
|
32
|
-
api_instance.topics_get_subscription(topic)
|
33
|
-
rescue Notifo::ApiError => e
|
34
|
-
puts "Error when calling TopicsApi->topics_get_subscription: #{e}"
|
35
|
-
end
|
36
|
-
```
|
37
|
-
|
38
|
-
#### Using the topics_get_subscription_with_http_info variant
|
39
|
-
|
40
|
-
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
41
|
-
|
42
|
-
> <Array(nil, Integer, Hash)> topics_get_subscription_with_http_info(topic)
|
43
|
-
|
44
|
-
```ruby
|
45
|
-
begin
|
46
|
-
# Gets a user subscription.
|
47
|
-
data, status_code, headers = api_instance.topics_get_subscription_with_http_info(topic)
|
48
|
-
p status_code # => 2xx
|
49
|
-
p headers # => { ... }
|
50
|
-
p data # => nil
|
51
|
-
rescue Notifo::ApiError => e
|
52
|
-
puts "Error when calling TopicsApi->topics_get_subscription_with_http_info: #{e}"
|
53
|
-
end
|
54
|
-
```
|
55
|
-
|
56
|
-
### Parameters
|
57
|
-
|
58
|
-
| Name | Type | Description | Notes |
|
59
|
-
| ---- | ---- | ----------- | ----- |
|
60
|
-
| **topic** | **String** | The topic path. | |
|
61
|
-
|
62
|
-
### Return type
|
63
|
-
|
64
|
-
nil (empty response body)
|
65
|
-
|
66
|
-
### Authorization
|
67
|
-
|
68
|
-
No authorization required
|
69
|
-
|
70
|
-
### HTTP request headers
|
71
|
-
|
72
|
-
- **Content-Type**: Not defined
|
73
|
-
- **Accept**: application/json
|
74
|
-
|
75
|
-
|
76
|
-
## topics_get_topics
|
77
|
-
|
78
|
-
> <ListResponseDtoOfTopicDto> topics_get_topics(app_id, opts)
|
9
|
+
# **topics_get_topics**
|
10
|
+
> ListResponseDtoOfTopicDto topics_get_topics(app_id, opts)
|
79
11
|
|
80
12
|
Query topics.
|
81
13
|
|
82
|
-
###
|
83
|
-
|
14
|
+
### Example
|
84
15
|
```ruby
|
85
|
-
|
16
|
+
# load the gem
|
86
17
|
require 'notifo'
|
87
18
|
|
88
19
|
api_instance = Notifo::TopicsApi.new
|
89
20
|
app_id = 'app_id_example' # String | The app where the topics belongs to.
|
90
|
-
opts = {
|
21
|
+
opts = {
|
91
22
|
query: 'query_example', # String | The optional query to search for items.
|
92
23
|
take: 56, # Integer | The number of items to return.
|
93
24
|
skip: 56 # Integer | The number of items to skip.
|
94
25
|
}
|
95
26
|
|
96
27
|
begin
|
97
|
-
#
|
28
|
+
#Query topics.
|
98
29
|
result = api_instance.topics_get_topics(app_id, opts)
|
99
30
|
p result
|
100
31
|
rescue Notifo::ApiError => e
|
101
|
-
puts "
|
102
|
-
end
|
103
|
-
```
|
104
|
-
|
105
|
-
#### Using the topics_get_topics_with_http_info variant
|
106
|
-
|
107
|
-
This returns an Array which contains the response data, status code and headers.
|
108
|
-
|
109
|
-
> <Array(<ListResponseDtoOfTopicDto>, Integer, Hash)> topics_get_topics_with_http_info(app_id, opts)
|
110
|
-
|
111
|
-
```ruby
|
112
|
-
begin
|
113
|
-
# Query topics.
|
114
|
-
data, status_code, headers = api_instance.topics_get_topics_with_http_info(app_id, opts)
|
115
|
-
p status_code # => 2xx
|
116
|
-
p headers # => { ... }
|
117
|
-
p data # => <ListResponseDtoOfTopicDto>
|
118
|
-
rescue Notifo::ApiError => e
|
119
|
-
puts "Error when calling TopicsApi->topics_get_topics_with_http_info: #{e}"
|
32
|
+
puts "Exception when calling TopicsApi->topics_get_topics: #{e}"
|
120
33
|
end
|
121
34
|
```
|
122
35
|
|
123
36
|
### Parameters
|
124
37
|
|
125
|
-
|
126
|
-
|
127
|
-
|
128
|
-
|
129
|
-
|
130
|
-
|
38
|
+
Name | Type | Description | Notes
|
39
|
+
------------- | ------------- | ------------- | -------------
|
40
|
+
**app_id** | **String**| The app where the topics belongs to. |
|
41
|
+
**query** | **String**| The optional query to search for items. | [optional]
|
42
|
+
**take** | **Integer**| The number of items to return. | [optional]
|
43
|
+
**skip** | **Integer**| The number of items to skip. | [optional]
|
131
44
|
|
132
45
|
### Return type
|
133
46
|
|
@@ -139,132 +52,8 @@ No authorization required
|
|
139
52
|
|
140
53
|
### HTTP request headers
|
141
54
|
|
142
|
-
- **Content-Type**: Not defined
|
143
|
-
- **Accept**: application/json
|
144
|
-
|
145
|
-
|
146
|
-
## topics_subscribe
|
147
|
-
|
148
|
-
> topics_subscribe(topic)
|
149
|
-
|
150
|
-
Creates a user subscription.
|
151
|
-
|
152
|
-
User Id and App Id are resolved using the API token.
|
153
|
-
|
154
|
-
### Examples
|
155
|
-
|
156
|
-
```ruby
|
157
|
-
require 'time'
|
158
|
-
require 'notifo'
|
159
|
-
|
160
|
-
api_instance = Notifo::TopicsApi.new
|
161
|
-
topic = 'topic_example' # String | The topic path.
|
162
|
-
|
163
|
-
begin
|
164
|
-
# Creates a user subscription.
|
165
|
-
api_instance.topics_subscribe(topic)
|
166
|
-
rescue Notifo::ApiError => e
|
167
|
-
puts "Error when calling TopicsApi->topics_subscribe: #{e}"
|
168
|
-
end
|
169
|
-
```
|
170
|
-
|
171
|
-
#### Using the topics_subscribe_with_http_info variant
|
172
|
-
|
173
|
-
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
174
|
-
|
175
|
-
> <Array(nil, Integer, Hash)> topics_subscribe_with_http_info(topic)
|
176
|
-
|
177
|
-
```ruby
|
178
|
-
begin
|
179
|
-
# Creates a user subscription.
|
180
|
-
data, status_code, headers = api_instance.topics_subscribe_with_http_info(topic)
|
181
|
-
p status_code # => 2xx
|
182
|
-
p headers # => { ... }
|
183
|
-
p data # => nil
|
184
|
-
rescue Notifo::ApiError => e
|
185
|
-
puts "Error when calling TopicsApi->topics_subscribe_with_http_info: #{e}"
|
186
|
-
end
|
187
|
-
```
|
188
|
-
|
189
|
-
### Parameters
|
190
|
-
|
191
|
-
| Name | Type | Description | Notes |
|
192
|
-
| ---- | ---- | ----------- | ----- |
|
193
|
-
| **topic** | **String** | The topic path. | |
|
194
|
-
|
195
|
-
### Return type
|
196
|
-
|
197
|
-
nil (empty response body)
|
198
|
-
|
199
|
-
### Authorization
|
200
|
-
|
201
|
-
No authorization required
|
202
|
-
|
203
|
-
### HTTP request headers
|
204
|
-
|
205
|
-
- **Content-Type**: Not defined
|
206
|
-
- **Accept**: application/json
|
207
|
-
|
208
|
-
|
209
|
-
## topics_unsubscribe
|
210
|
-
|
211
|
-
> topics_unsubscribe(topic)
|
212
|
-
|
213
|
-
Deletes a user subscription.
|
214
|
-
|
215
|
-
User Id and App Id are resolved using the API token.
|
55
|
+
- **Content-Type**: Not defined
|
56
|
+
- **Accept**: application/json
|
216
57
|
|
217
|
-
### Examples
|
218
|
-
|
219
|
-
```ruby
|
220
|
-
require 'time'
|
221
|
-
require 'notifo'
|
222
|
-
|
223
|
-
api_instance = Notifo::TopicsApi.new
|
224
|
-
topic = 'topic_example' # String | The topic path.
|
225
|
-
|
226
|
-
begin
|
227
|
-
# Deletes a user subscription.
|
228
|
-
api_instance.topics_unsubscribe(topic)
|
229
|
-
rescue Notifo::ApiError => e
|
230
|
-
puts "Error when calling TopicsApi->topics_unsubscribe: #{e}"
|
231
|
-
end
|
232
|
-
```
|
233
|
-
|
234
|
-
#### Using the topics_unsubscribe_with_http_info variant
|
235
|
-
|
236
|
-
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
237
|
-
|
238
|
-
> <Array(nil, Integer, Hash)> topics_unsubscribe_with_http_info(topic)
|
239
|
-
|
240
|
-
```ruby
|
241
|
-
begin
|
242
|
-
# Deletes a user subscription.
|
243
|
-
data, status_code, headers = api_instance.topics_unsubscribe_with_http_info(topic)
|
244
|
-
p status_code # => 2xx
|
245
|
-
p headers # => { ... }
|
246
|
-
p data # => nil
|
247
|
-
rescue Notifo::ApiError => e
|
248
|
-
puts "Error when calling TopicsApi->topics_unsubscribe_with_http_info: #{e}"
|
249
|
-
end
|
250
|
-
```
|
251
|
-
|
252
|
-
### Parameters
|
253
|
-
|
254
|
-
| Name | Type | Description | Notes |
|
255
|
-
| ---- | ---- | ----------- | ----- |
|
256
|
-
| **topic** | **String** | The topic path. | |
|
257
|
-
|
258
|
-
### Return type
|
259
|
-
|
260
|
-
nil (empty response body)
|
261
|
-
|
262
|
-
### Authorization
|
263
|
-
|
264
|
-
No authorization required
|
265
|
-
|
266
|
-
### HTTP request headers
|
267
58
|
|
268
|
-
- **Content-Type**: Not defined
|
269
|
-
- **Accept**: application/json
|
270
59
|
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Notifo::TrackNotificationDto
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**confirmed** | **String** | The id of the noitifications to mark as confirmed. | [optional]
|
7
|
+
**seen** | **Array<String>** | The id of the noitifications to mark as seen. | [optional]
|
8
|
+
**channel** | **String** | The channel name. | [optional]
|
9
|
+
**device_identifier** | **String** | The device identifier. | [optional]
|
10
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Notifo::UpdateIntegrationDto
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**properties** | [**IntegrationProperties**](IntegrationProperties.md) | |
|
7
|
+
**enabled** | **BOOLEAN** | True when enabled. | [optional]
|
8
|
+
**test** | **BOOLEAN** | True when used for test events. | [optional]
|
9
|
+
**priority** | **Integer** | The priority in which order the integrations must run. | [optional]
|
10
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# Notifo::UpdateProfileDto
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**full_name** | **String** | The full name of the user. | [optional]
|
7
|
+
**email_address** | **String** | The email of the user. | [optional]
|
8
|
+
**phone_number** | **String** | The phone number. | [optional]
|
9
|
+
**preferred_language** | **String** | The preferred language of the user. | [optional]
|
10
|
+
**preferred_timezone** | **String** | The timezone of the user. | [optional]
|
11
|
+
**settings** | [**Hash<String, NotificationSettingDto>**](NotificationSettingDto.md) | Notification settings per channel. | [optional]
|
12
|
+
|
data/docs/UpsertAppDto.md
CHANGED
@@ -1,36 +1,16 @@
|
|
1
1
|
# Notifo::UpsertAppDto
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
| **allow_sms** | **Boolean** | True, when SMS are allowed. | [optional] |
|
17
|
-
|
18
|
-
## Example
|
19
|
-
|
20
|
-
```ruby
|
21
|
-
require 'notifo'
|
22
|
-
|
23
|
-
instance = Notifo::UpsertAppDto.new(
|
24
|
-
name: null,
|
25
|
-
languages: null,
|
26
|
-
email_address: null,
|
27
|
-
email_name: null,
|
28
|
-
firebase_project: null,
|
29
|
-
firebase_credential: null,
|
30
|
-
webhook_url: null,
|
31
|
-
confirm_url: null,
|
32
|
-
allow_email: null,
|
33
|
-
allow_sms: null
|
34
|
-
)
|
35
|
-
```
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**name** | **String** | The app name. | [optional]
|
7
|
+
**languages** | **Array<String>** | The supported languages. | [optional]
|
8
|
+
**email_address** | **String** | The sender email address. | [optional]
|
9
|
+
**email_name** | **String** | The sender email name. | [optional]
|
10
|
+
**firebase_project** | **String** | The firebase project ID. | [optional]
|
11
|
+
**firebase_credential** | **String** | The firebase credentials. | [optional]
|
12
|
+
**webhook_url** | **String** | The webhook URL. | [optional]
|
13
|
+
**confirm_url** | **String** | The confirm URL. | [optional]
|
14
|
+
**allow_email** | **BOOLEAN** | True, when emails are allowed. | [optional]
|
15
|
+
**allow_sms** | **BOOLEAN** | True, when SMS are allowed. | [optional]
|
36
16
|
|
data/docs/UpsertTemplateDto.md
CHANGED
@@ -1,22 +1,9 @@
|
|
1
1
|
# Notifo::UpsertTemplateDto
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
|
7
|
-
|
8
|
-
|
9
|
-
| **settings** | [**OneOfmap**](OneOfmap.md) | Notification settings per channel. | [optional] |
|
10
|
-
|
11
|
-
## Example
|
12
|
-
|
13
|
-
```ruby
|
14
|
-
require 'notifo'
|
15
|
-
|
16
|
-
instance = Notifo::UpsertTemplateDto.new(
|
17
|
-
code: null,
|
18
|
-
formatting: null,
|
19
|
-
settings: null
|
20
|
-
)
|
21
|
-
```
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**code** | **String** | The code of the template. |
|
7
|
+
**formatting** | [**NotificationFormattingDto**](NotificationFormattingDto.md) | |
|
8
|
+
**settings** | [**Hash<String, NotificationSettingDto>**](NotificationSettingDto.md) | Notification settings per channel. | [optional]
|
22
9
|
|
data/docs/UpsertTemplatesDto.md
CHANGED
@@ -1,18 +1,7 @@
|
|
1
1
|
# Notifo::UpsertTemplatesDto
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
|
7
|
-
| **requests** | [**Array<UpsertTemplateDto>**](UpsertTemplateDto.md) | The templates to update. | [optional] |
|
8
|
-
|
9
|
-
## Example
|
10
|
-
|
11
|
-
```ruby
|
12
|
-
require 'notifo'
|
13
|
-
|
14
|
-
instance = Notifo::UpsertTemplatesDto.new(
|
15
|
-
requests: null
|
16
|
-
)
|
17
|
-
```
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**requests** | [**Array<UpsertTemplateDto>**](UpsertTemplateDto.md) | The templates to update. |
|
18
7
|
|
data/docs/UpsertUserDto.md
CHANGED
@@ -1,32 +1,15 @@
|
|
1
1
|
# Notifo::UpsertUserDto
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
## Example
|
17
|
-
|
18
|
-
```ruby
|
19
|
-
require 'notifo'
|
20
|
-
|
21
|
-
instance = Notifo::UpsertUserDto.new(
|
22
|
-
id: null,
|
23
|
-
full_name: null,
|
24
|
-
email_address: null,
|
25
|
-
phone_number: null,
|
26
|
-
preferred_language: null,
|
27
|
-
preferred_timezone: null,
|
28
|
-
requires_whitelisted_topics: null,
|
29
|
-
settings: null
|
30
|
-
)
|
31
|
-
```
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **String** | The id of the user. | [optional]
|
7
|
+
**full_name** | **String** | The full name of the user. | [optional]
|
8
|
+
**email_address** | **String** | The email of the user. | [optional]
|
9
|
+
**phone_number** | **String** | The phone number. | [optional]
|
10
|
+
**threema_id** | **String** | The threema id. | [optional]
|
11
|
+
**preferred_language** | **String** | The preferred language of the user. | [optional]
|
12
|
+
**preferred_timezone** | **String** | The timezone of the user. | [optional]
|
13
|
+
**requires_whitelisted_topics** | **BOOLEAN** | True when only whitelisted topic are allowed. | [optional]
|
14
|
+
**settings** | [**Hash<String, NotificationSettingDto>**](NotificationSettingDto.md) | Notification settings per channel. | [optional]
|
32
15
|
|