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/UpsertUsersDto.md
CHANGED
@@ -1,18 +1,7 @@
|
|
1
1
|
# Notifo::UpsertUsersDto
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
|
7
|
-
| **requests** | [**Array<UpsertUserDto>**](UpsertUserDto.md) | The users to update. | [optional] |
|
8
|
-
|
9
|
-
## Example
|
10
|
-
|
11
|
-
```ruby
|
12
|
-
require 'notifo'
|
13
|
-
|
14
|
-
instance = Notifo::UpsertUsersDto.new(
|
15
|
-
requests: null
|
16
|
-
)
|
17
|
-
```
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**requests** | [**Array<UpsertUserDto>**](UpsertUserDto.md) | The users to update. |
|
18
7
|
|
data/docs/UserApi.md
ADDED
@@ -0,0 +1,231 @@
|
|
1
|
+
# Notifo::UserApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://notifo.easierlife.com*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**user_delete_subscription**](UserApi.md#user_delete_subscription) | **DELETE** /api/me/subscriptions/{topic} | Deletes a user subscription.
|
8
|
+
[**user_get_subscription**](UserApi.md#user_get_subscription) | **GET** /api/me/subscriptions/{topic} | Gets a user subscription.
|
9
|
+
[**user_get_user**](UserApi.md#user_get_user) | **GET** /api/me | Get the current user.
|
10
|
+
[**user_post_subscription**](UserApi.md#user_post_subscription) | **POST** /api/me/subscriptions | Creates a user subscription.
|
11
|
+
[**user_post_user**](UserApi.md#user_post_user) | **POST** /api/me | Update the user.
|
12
|
+
|
13
|
+
# **user_delete_subscription**
|
14
|
+
> user_delete_subscription(topic)
|
15
|
+
|
16
|
+
Deletes a user subscription.
|
17
|
+
|
18
|
+
User Id and App Id are resolved using the API token.
|
19
|
+
|
20
|
+
### Example
|
21
|
+
```ruby
|
22
|
+
# load the gem
|
23
|
+
require 'notifo'
|
24
|
+
|
25
|
+
api_instance = Notifo::UserApi.new
|
26
|
+
topic = 'topic_example' # String | The topic path.
|
27
|
+
|
28
|
+
|
29
|
+
begin
|
30
|
+
#Deletes a user subscription.
|
31
|
+
api_instance.user_delete_subscription(topic)
|
32
|
+
rescue Notifo::ApiError => e
|
33
|
+
puts "Exception when calling UserApi->user_delete_subscription: #{e}"
|
34
|
+
end
|
35
|
+
```
|
36
|
+
|
37
|
+
### Parameters
|
38
|
+
|
39
|
+
Name | Type | Description | Notes
|
40
|
+
------------- | ------------- | ------------- | -------------
|
41
|
+
**topic** | **String**| The topic path. |
|
42
|
+
|
43
|
+
### Return type
|
44
|
+
|
45
|
+
nil (empty response body)
|
46
|
+
|
47
|
+
### Authorization
|
48
|
+
|
49
|
+
No authorization required
|
50
|
+
|
51
|
+
### HTTP request headers
|
52
|
+
|
53
|
+
- **Content-Type**: Not defined
|
54
|
+
- **Accept**: application/json
|
55
|
+
|
56
|
+
|
57
|
+
|
58
|
+
# **user_get_subscription**
|
59
|
+
> SubscriptionDto user_get_subscription(topic)
|
60
|
+
|
61
|
+
Gets a user subscription.
|
62
|
+
|
63
|
+
User Id and App Id are resolved using the API token.
|
64
|
+
|
65
|
+
### Example
|
66
|
+
```ruby
|
67
|
+
# load the gem
|
68
|
+
require 'notifo'
|
69
|
+
|
70
|
+
api_instance = Notifo::UserApi.new
|
71
|
+
topic = 'topic_example' # String | The topic path.
|
72
|
+
|
73
|
+
|
74
|
+
begin
|
75
|
+
#Gets a user subscription.
|
76
|
+
result = api_instance.user_get_subscription(topic)
|
77
|
+
p result
|
78
|
+
rescue Notifo::ApiError => e
|
79
|
+
puts "Exception when calling UserApi->user_get_subscription: #{e}"
|
80
|
+
end
|
81
|
+
```
|
82
|
+
|
83
|
+
### Parameters
|
84
|
+
|
85
|
+
Name | Type | Description | Notes
|
86
|
+
------------- | ------------- | ------------- | -------------
|
87
|
+
**topic** | **String**| The topic path. |
|
88
|
+
|
89
|
+
### Return type
|
90
|
+
|
91
|
+
[**SubscriptionDto**](SubscriptionDto.md)
|
92
|
+
|
93
|
+
### Authorization
|
94
|
+
|
95
|
+
No authorization required
|
96
|
+
|
97
|
+
### HTTP request headers
|
98
|
+
|
99
|
+
- **Content-Type**: Not defined
|
100
|
+
- **Accept**: application/json
|
101
|
+
|
102
|
+
|
103
|
+
|
104
|
+
# **user_get_user**
|
105
|
+
> ProfileDto user_get_user
|
106
|
+
|
107
|
+
Get the current user.
|
108
|
+
|
109
|
+
### Example
|
110
|
+
```ruby
|
111
|
+
# load the gem
|
112
|
+
require 'notifo'
|
113
|
+
|
114
|
+
api_instance = Notifo::UserApi.new
|
115
|
+
|
116
|
+
begin
|
117
|
+
#Get the current user.
|
118
|
+
result = api_instance.user_get_user
|
119
|
+
p result
|
120
|
+
rescue Notifo::ApiError => e
|
121
|
+
puts "Exception when calling UserApi->user_get_user: #{e}"
|
122
|
+
end
|
123
|
+
```
|
124
|
+
|
125
|
+
### Parameters
|
126
|
+
This endpoint does not need any parameter.
|
127
|
+
|
128
|
+
### Return type
|
129
|
+
|
130
|
+
[**ProfileDto**](ProfileDto.md)
|
131
|
+
|
132
|
+
### Authorization
|
133
|
+
|
134
|
+
No authorization required
|
135
|
+
|
136
|
+
### HTTP request headers
|
137
|
+
|
138
|
+
- **Content-Type**: Not defined
|
139
|
+
- **Accept**: application/json
|
140
|
+
|
141
|
+
|
142
|
+
|
143
|
+
# **user_post_subscription**
|
144
|
+
> user_post_subscription(body)
|
145
|
+
|
146
|
+
Creates a user subscription.
|
147
|
+
|
148
|
+
User Id and App Id are resolved using the API token.
|
149
|
+
|
150
|
+
### Example
|
151
|
+
```ruby
|
152
|
+
# load the gem
|
153
|
+
require 'notifo'
|
154
|
+
|
155
|
+
api_instance = Notifo::UserApi.new
|
156
|
+
body = Notifo::SubscriptionDto.new # SubscriptionDto | The subscription settings.
|
157
|
+
|
158
|
+
|
159
|
+
begin
|
160
|
+
#Creates a user subscription.
|
161
|
+
api_instance.user_post_subscription(body)
|
162
|
+
rescue Notifo::ApiError => e
|
163
|
+
puts "Exception when calling UserApi->user_post_subscription: #{e}"
|
164
|
+
end
|
165
|
+
```
|
166
|
+
|
167
|
+
### Parameters
|
168
|
+
|
169
|
+
Name | Type | Description | Notes
|
170
|
+
------------- | ------------- | ------------- | -------------
|
171
|
+
**body** | [**SubscriptionDto**](SubscriptionDto.md)| The subscription settings. |
|
172
|
+
|
173
|
+
### Return type
|
174
|
+
|
175
|
+
nil (empty response body)
|
176
|
+
|
177
|
+
### Authorization
|
178
|
+
|
179
|
+
No authorization required
|
180
|
+
|
181
|
+
### HTTP request headers
|
182
|
+
|
183
|
+
- **Content-Type**: application/json
|
184
|
+
- **Accept**: application/json
|
185
|
+
|
186
|
+
|
187
|
+
|
188
|
+
# **user_post_user**
|
189
|
+
> ProfileDto user_post_user(body)
|
190
|
+
|
191
|
+
Update the user.
|
192
|
+
|
193
|
+
### Example
|
194
|
+
```ruby
|
195
|
+
# load the gem
|
196
|
+
require 'notifo'
|
197
|
+
|
198
|
+
api_instance = Notifo::UserApi.new
|
199
|
+
body = Notifo::UpdateProfileDto.new # UpdateProfileDto | The upsert request.
|
200
|
+
|
201
|
+
|
202
|
+
begin
|
203
|
+
#Update the user.
|
204
|
+
result = api_instance.user_post_user(body)
|
205
|
+
p result
|
206
|
+
rescue Notifo::ApiError => e
|
207
|
+
puts "Exception when calling UserApi->user_post_user: #{e}"
|
208
|
+
end
|
209
|
+
```
|
210
|
+
|
211
|
+
### Parameters
|
212
|
+
|
213
|
+
Name | Type | Description | Notes
|
214
|
+
------------- | ------------- | ------------- | -------------
|
215
|
+
**body** | [**UpdateProfileDto**](UpdateProfileDto.md)| The upsert request. |
|
216
|
+
|
217
|
+
### Return type
|
218
|
+
|
219
|
+
[**ProfileDto**](ProfileDto.md)
|
220
|
+
|
221
|
+
### Authorization
|
222
|
+
|
223
|
+
No authorization required
|
224
|
+
|
225
|
+
### HTTP request headers
|
226
|
+
|
227
|
+
- **Content-Type**: application/json
|
228
|
+
- **Accept**: application/json
|
229
|
+
|
230
|
+
|
231
|
+
|
data/docs/UserDto.md
CHANGED
@@ -1,36 +1,19 @@
|
|
1
1
|
# Notifo::UserDto
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
|
19
|
-
|
20
|
-
```ruby
|
21
|
-
require 'notifo'
|
22
|
-
|
23
|
-
instance = Notifo::UserDto.new(
|
24
|
-
id: null,
|
25
|
-
api_key: null,
|
26
|
-
full_name: null,
|
27
|
-
email_address: null,
|
28
|
-
phone_number: null,
|
29
|
-
preferred_language: null,
|
30
|
-
preferred_timezone: null,
|
31
|
-
requires_whitelisted_topics: null,
|
32
|
-
settings: null,
|
33
|
-
counters: null
|
34
|
-
)
|
35
|
-
```
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **String** | The id of the user. |
|
7
|
+
**api_key** | **String** | The unique api key for the user. |
|
8
|
+
**full_name** | **String** | The full name of the user. | [optional]
|
9
|
+
**email_address** | **String** | The email of the user. | [optional]
|
10
|
+
**phone_number** | **String** | The phone number. | [optional]
|
11
|
+
**threema_id** | **String** | The threema id. | [optional]
|
12
|
+
**preferred_language** | **String** | The preferred language of the user. | [optional]
|
13
|
+
**preferred_timezone** | **String** | The timezone of the user. | [optional]
|
14
|
+
**number_of_web_push_tokens** | **Integer** | The number of web hook tokens. |
|
15
|
+
**number_of_mobile_push_tokens** | **Integer** | The number of web hook tokens. |
|
16
|
+
**requires_whitelisted_topics** | **BOOLEAN** | True when only whitelisted topic are allowed. |
|
17
|
+
**settings** | [**Hash<String, NotificationSettingDto>**](NotificationSettingDto.md) | Notification settings per channel. |
|
18
|
+
**counters** | **Hash<String, Integer>** | The statistics counters. |
|
36
19
|
|
data/docs/UserInfoApi.md
ADDED
@@ -0,0 +1,83 @@
|
|
1
|
+
# Notifo::UserInfoApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://notifo.easierlife.com*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**user_info_userinfo**](UserInfoApi.md#user_info_userinfo) | **GET** /connect/userinfo |
|
8
|
+
[**user_info_userinfo2**](UserInfoApi.md#user_info_userinfo2) | **POST** /connect/userinfo |
|
9
|
+
|
10
|
+
# **user_info_userinfo**
|
11
|
+
> user_info_userinfo
|
12
|
+
|
13
|
+
|
14
|
+
|
15
|
+
### Example
|
16
|
+
```ruby
|
17
|
+
# load the gem
|
18
|
+
require 'notifo'
|
19
|
+
|
20
|
+
api_instance = Notifo::UserInfoApi.new
|
21
|
+
|
22
|
+
begin
|
23
|
+
api_instance.user_info_userinfo
|
24
|
+
rescue Notifo::ApiError => e
|
25
|
+
puts "Exception when calling UserInfoApi->user_info_userinfo: #{e}"
|
26
|
+
end
|
27
|
+
```
|
28
|
+
|
29
|
+
### Parameters
|
30
|
+
This endpoint does not need any parameter.
|
31
|
+
|
32
|
+
### Return type
|
33
|
+
|
34
|
+
nil (empty response body)
|
35
|
+
|
36
|
+
### Authorization
|
37
|
+
|
38
|
+
No authorization required
|
39
|
+
|
40
|
+
### HTTP request headers
|
41
|
+
|
42
|
+
- **Content-Type**: Not defined
|
43
|
+
- **Accept**: application/json
|
44
|
+
|
45
|
+
|
46
|
+
|
47
|
+
# **user_info_userinfo2**
|
48
|
+
> user_info_userinfo2
|
49
|
+
|
50
|
+
|
51
|
+
|
52
|
+
### Example
|
53
|
+
```ruby
|
54
|
+
# load the gem
|
55
|
+
require 'notifo'
|
56
|
+
|
57
|
+
api_instance = Notifo::UserInfoApi.new
|
58
|
+
|
59
|
+
begin
|
60
|
+
api_instance.user_info_userinfo2
|
61
|
+
rescue Notifo::ApiError => e
|
62
|
+
puts "Exception when calling UserInfoApi->user_info_userinfo2: #{e}"
|
63
|
+
end
|
64
|
+
```
|
65
|
+
|
66
|
+
### Parameters
|
67
|
+
This endpoint does not need any parameter.
|
68
|
+
|
69
|
+
### Return type
|
70
|
+
|
71
|
+
nil (empty response body)
|
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
|
+
|
data/docs/UsersApi.md
CHANGED
@@ -1,30 +1,27 @@
|
|
1
1
|
# Notifo::UsersApi
|
2
2
|
|
3
|
-
All URIs are relative to *https://
|
4
|
-
|
5
|
-
|
6
|
-
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
|
14
|
-
|
15
|
-
|
16
|
-
|
17
|
-
|
18
|
-
## users_delete_allowed_topic
|
19
|
-
|
3
|
+
All URIs are relative to *https://notifo.easierlife.com*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**users_delete_allowed_topic**](UsersApi.md#users_delete_allowed_topic) | **DELETE** /api/apps/{appId}/users/{id}/allowed-topics/{prefix} | Remove an allowed topic.
|
8
|
+
[**users_delete_subscription**](UsersApi.md#users_delete_subscription) | **DELETE** /api/apps/{appId}/users/{id}/subscriptions/{prefix} | Remove a user subscriptions.
|
9
|
+
[**users_delete_user**](UsersApi.md#users_delete_user) | **DELETE** /api/apps/{appId}/users/{id} | Delete a user.
|
10
|
+
[**users_get_subscriptions**](UsersApi.md#users_get_subscriptions) | **GET** /api/apps/{appId}/users/{id}/subscriptions | Query user subscriptions.
|
11
|
+
[**users_get_user**](UsersApi.md#users_get_user) | **GET** /api/apps/{appId}/users/{id} | Get a user.
|
12
|
+
[**users_get_users**](UsersApi.md#users_get_users) | **GET** /api/apps/{appId}/users | Query users.
|
13
|
+
[**users_post_allowed_topic**](UsersApi.md#users_post_allowed_topic) | **POST** /api/apps/{appId}/users/{id}/allowed-topics | Add an allowed topic.
|
14
|
+
[**users_post_subscription**](UsersApi.md#users_post_subscription) | **POST** /api/apps/{appId}/users/{id}/subscriptions | Upsert a user subscriptions.
|
15
|
+
[**users_post_users**](UsersApi.md#users_post_users) | **POST** /api/apps/{appId}/users | Upsert users.
|
16
|
+
|
17
|
+
# **users_delete_allowed_topic**
|
20
18
|
> users_delete_allowed_topic(app_id, id, prefix)
|
21
19
|
|
22
20
|
Remove an allowed topic.
|
23
21
|
|
24
|
-
###
|
25
|
-
|
22
|
+
### Example
|
26
23
|
```ruby
|
27
|
-
|
24
|
+
# load the gem
|
28
25
|
require 'notifo'
|
29
26
|
|
30
27
|
api_instance = Notifo::UsersApi.new
|
@@ -32,39 +29,22 @@ app_id = 'app_id_example' # String | The app where the users belong to.
|
|
32
29
|
id = 'id_example' # String | The user id.
|
33
30
|
prefix = 'prefix_example' # String | The topic prefix.
|
34
31
|
|
35
|
-
begin
|
36
|
-
# Remove an allowed topic.
|
37
|
-
api_instance.users_delete_allowed_topic(app_id, id, prefix)
|
38
|
-
rescue Notifo::ApiError => e
|
39
|
-
puts "Error when calling UsersApi->users_delete_allowed_topic: #{e}"
|
40
|
-
end
|
41
|
-
```
|
42
|
-
|
43
|
-
#### Using the users_delete_allowed_topic_with_http_info variant
|
44
|
-
|
45
|
-
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
46
|
-
|
47
|
-
> <Array(nil, Integer, Hash)> users_delete_allowed_topic_with_http_info(app_id, id, prefix)
|
48
32
|
|
49
|
-
```ruby
|
50
33
|
begin
|
51
|
-
#
|
52
|
-
|
53
|
-
p status_code # => 2xx
|
54
|
-
p headers # => { ... }
|
55
|
-
p data # => nil
|
34
|
+
#Remove an allowed topic.
|
35
|
+
api_instance.users_delete_allowed_topic(app_id, id, prefix)
|
56
36
|
rescue Notifo::ApiError => e
|
57
|
-
puts "
|
37
|
+
puts "Exception when calling UsersApi->users_delete_allowed_topic: #{e}"
|
58
38
|
end
|
59
39
|
```
|
60
40
|
|
61
41
|
### Parameters
|
62
42
|
|
63
|
-
|
64
|
-
|
65
|
-
|
66
|
-
|
67
|
-
|
43
|
+
Name | Type | Description | Notes
|
44
|
+
------------- | ------------- | ------------- | -------------
|
45
|
+
**app_id** | **String**| The app where the users belong to. |
|
46
|
+
**id** | **String**| The user id. |
|
47
|
+
**prefix** | **String**| The topic prefix. |
|
68
48
|
|
69
49
|
### Return type
|
70
50
|
|
@@ -76,20 +56,19 @@ No authorization required
|
|
76
56
|
|
77
57
|
### HTTP request headers
|
78
58
|
|
79
|
-
- **Content-Type**: Not defined
|
80
|
-
- **Accept**: application/json
|
59
|
+
- **Content-Type**: Not defined
|
60
|
+
- **Accept**: application/json
|
81
61
|
|
82
62
|
|
83
|
-
## users_delete_subscription
|
84
63
|
|
64
|
+
# **users_delete_subscription**
|
85
65
|
> users_delete_subscription(app_id, id, prefix)
|
86
66
|
|
87
67
|
Remove a user subscriptions.
|
88
68
|
|
89
|
-
###
|
90
|
-
|
69
|
+
### Example
|
91
70
|
```ruby
|
92
|
-
|
71
|
+
# load the gem
|
93
72
|
require 'notifo'
|
94
73
|
|
95
74
|
api_instance = Notifo::UsersApi.new
|
@@ -97,39 +76,22 @@ app_id = 'app_id_example' # String | The app where the user belongs to.
|
|
97
76
|
id = 'id_example' # String | The user id.
|
98
77
|
prefix = 'prefix_example' # String | The topic prefix.
|
99
78
|
|
100
|
-
begin
|
101
|
-
# Remove a user subscriptions.
|
102
|
-
api_instance.users_delete_subscription(app_id, id, prefix)
|
103
|
-
rescue Notifo::ApiError => e
|
104
|
-
puts "Error when calling UsersApi->users_delete_subscription: #{e}"
|
105
|
-
end
|
106
|
-
```
|
107
|
-
|
108
|
-
#### Using the users_delete_subscription_with_http_info variant
|
109
79
|
|
110
|
-
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
111
|
-
|
112
|
-
> <Array(nil, Integer, Hash)> users_delete_subscription_with_http_info(app_id, id, prefix)
|
113
|
-
|
114
|
-
```ruby
|
115
80
|
begin
|
116
|
-
#
|
117
|
-
|
118
|
-
p status_code # => 2xx
|
119
|
-
p headers # => { ... }
|
120
|
-
p data # => nil
|
81
|
+
#Remove a user subscriptions.
|
82
|
+
api_instance.users_delete_subscription(app_id, id, prefix)
|
121
83
|
rescue Notifo::ApiError => e
|
122
|
-
puts "
|
84
|
+
puts "Exception when calling UsersApi->users_delete_subscription: #{e}"
|
123
85
|
end
|
124
86
|
```
|
125
87
|
|
126
88
|
### Parameters
|
127
89
|
|
128
|
-
|
129
|
-
|
130
|
-
|
131
|
-
|
132
|
-
|
90
|
+
Name | Type | Description | Notes
|
91
|
+
------------- | ------------- | ------------- | -------------
|
92
|
+
**app_id** | **String**| The app where the user belongs to. |
|
93
|
+
**id** | **String**| The user id. |
|
94
|
+
**prefix** | **String**| The topic prefix. |
|
133
95
|
|
134
96
|
### Return type
|
135
97
|
|
@@ -141,59 +103,41 @@ No authorization required
|
|
141
103
|
|
142
104
|
### HTTP request headers
|
143
105
|
|
144
|
-
- **Content-Type**: Not defined
|
145
|
-
- **Accept**: application/json
|
106
|
+
- **Content-Type**: Not defined
|
107
|
+
- **Accept**: application/json
|
146
108
|
|
147
109
|
|
148
|
-
## users_delete_user
|
149
110
|
|
150
|
-
|
111
|
+
# **users_delete_user**
|
112
|
+
> ListResponseDtoOfUserDto users_delete_user(app_id, id)
|
151
113
|
|
152
114
|
Delete a user.
|
153
115
|
|
154
|
-
###
|
155
|
-
|
116
|
+
### Example
|
156
117
|
```ruby
|
157
|
-
|
118
|
+
# load the gem
|
158
119
|
require 'notifo'
|
159
120
|
|
160
121
|
api_instance = Notifo::UsersApi.new
|
161
122
|
app_id = 'app_id_example' # String | The app where the users belongs to.
|
162
123
|
id = 'id_example' # String | The user id to delete.
|
163
124
|
|
125
|
+
|
164
126
|
begin
|
165
|
-
#
|
127
|
+
#Delete a user.
|
166
128
|
result = api_instance.users_delete_user(app_id, id)
|
167
129
|
p result
|
168
130
|
rescue Notifo::ApiError => e
|
169
|
-
puts "
|
170
|
-
end
|
171
|
-
```
|
172
|
-
|
173
|
-
#### Using the users_delete_user_with_http_info variant
|
174
|
-
|
175
|
-
This returns an Array which contains the response data, status code and headers.
|
176
|
-
|
177
|
-
> <Array(<ListResponseDtoOfUserDto>, Integer, Hash)> users_delete_user_with_http_info(app_id, id)
|
178
|
-
|
179
|
-
```ruby
|
180
|
-
begin
|
181
|
-
# Delete a user.
|
182
|
-
data, status_code, headers = api_instance.users_delete_user_with_http_info(app_id, id)
|
183
|
-
p status_code # => 2xx
|
184
|
-
p headers # => { ... }
|
185
|
-
p data # => <ListResponseDtoOfUserDto>
|
186
|
-
rescue Notifo::ApiError => e
|
187
|
-
puts "Error when calling UsersApi->users_delete_user_with_http_info: #{e}"
|
131
|
+
puts "Exception when calling UsersApi->users_delete_user: #{e}"
|
188
132
|
end
|
189
133
|
```
|
190
134
|
|
191
135
|
### Parameters
|
192
136
|
|
193
|
-
|
194
|
-
|
195
|
-
|
196
|
-
|
137
|
+
Name | Type | Description | Notes
|
138
|
+
------------- | ------------- | ------------- | -------------
|
139
|
+
**app_id** | **String**| The app where the users belongs to. |
|
140
|
+
**id** | **String**| The user id to delete. |
|
197
141
|
|
198
142
|
### Return type
|
199
143
|
|
@@ -205,67 +149,48 @@ No authorization required
|
|
205
149
|
|
206
150
|
### HTTP request headers
|
207
151
|
|
208
|
-
- **Content-Type**: Not defined
|
209
|
-
- **Accept**: application/json
|
152
|
+
- **Content-Type**: Not defined
|
153
|
+
- **Accept**: application/json
|
210
154
|
|
211
155
|
|
212
|
-
## users_get_subscriptions
|
213
156
|
|
214
|
-
|
157
|
+
# **users_get_subscriptions**
|
158
|
+
> ListResponseDtoOfSubscriptionDto users_get_subscriptions(app_id, id, opts)
|
215
159
|
|
216
160
|
Query user subscriptions.
|
217
161
|
|
218
|
-
###
|
219
|
-
|
162
|
+
### Example
|
220
163
|
```ruby
|
221
|
-
|
164
|
+
# load the gem
|
222
165
|
require 'notifo'
|
223
166
|
|
224
167
|
api_instance = Notifo::UsersApi.new
|
225
168
|
app_id = 'app_id_example' # String | The app where the user belongs to.
|
226
169
|
id = 'id_example' # String | The user id.
|
227
|
-
opts = {
|
170
|
+
opts = {
|
228
171
|
query: 'query_example', # String | The optional query to search for items.
|
229
172
|
take: 56, # Integer | The number of items to return.
|
230
173
|
skip: 56 # Integer | The number of items to skip.
|
231
174
|
}
|
232
175
|
|
233
176
|
begin
|
234
|
-
#
|
177
|
+
#Query user subscriptions.
|
235
178
|
result = api_instance.users_get_subscriptions(app_id, id, opts)
|
236
179
|
p result
|
237
180
|
rescue Notifo::ApiError => e
|
238
|
-
puts "
|
239
|
-
end
|
240
|
-
```
|
241
|
-
|
242
|
-
#### Using the users_get_subscriptions_with_http_info variant
|
243
|
-
|
244
|
-
This returns an Array which contains the response data, status code and headers.
|
245
|
-
|
246
|
-
> <Array(<ListResponseDtoOfSubscriptionDto>, Integer, Hash)> users_get_subscriptions_with_http_info(app_id, id, opts)
|
247
|
-
|
248
|
-
```ruby
|
249
|
-
begin
|
250
|
-
# Query user subscriptions.
|
251
|
-
data, status_code, headers = api_instance.users_get_subscriptions_with_http_info(app_id, id, opts)
|
252
|
-
p status_code # => 2xx
|
253
|
-
p headers # => { ... }
|
254
|
-
p data # => <ListResponseDtoOfSubscriptionDto>
|
255
|
-
rescue Notifo::ApiError => e
|
256
|
-
puts "Error when calling UsersApi->users_get_subscriptions_with_http_info: #{e}"
|
181
|
+
puts "Exception when calling UsersApi->users_get_subscriptions: #{e}"
|
257
182
|
end
|
258
183
|
```
|
259
184
|
|
260
185
|
### Parameters
|
261
186
|
|
262
|
-
|
263
|
-
|
264
|
-
|
265
|
-
|
266
|
-
|
267
|
-
|
268
|
-
|
187
|
+
Name | Type | Description | Notes
|
188
|
+
------------- | ------------- | ------------- | -------------
|
189
|
+
**app_id** | **String**| The app where the user belongs to. |
|
190
|
+
**id** | **String**| The user id. |
|
191
|
+
**query** | **String**| The optional query to search for items. | [optional]
|
192
|
+
**take** | **Integer**| The number of items to return. | [optional]
|
193
|
+
**skip** | **Integer**| The number of items to skip. | [optional]
|
269
194
|
|
270
195
|
### Return type
|
271
196
|
|
@@ -277,59 +202,41 @@ No authorization required
|
|
277
202
|
|
278
203
|
### HTTP request headers
|
279
204
|
|
280
|
-
- **Content-Type**: Not defined
|
281
|
-
- **Accept**: application/json
|
205
|
+
- **Content-Type**: Not defined
|
206
|
+
- **Accept**: application/json
|
282
207
|
|
283
208
|
|
284
|
-
## users_get_user
|
285
209
|
|
286
|
-
|
210
|
+
# **users_get_user**
|
211
|
+
> ListResponseDtoOfUserDto users_get_user(app_id, id)
|
287
212
|
|
288
213
|
Get a user.
|
289
214
|
|
290
|
-
###
|
291
|
-
|
215
|
+
### Example
|
292
216
|
```ruby
|
293
|
-
|
217
|
+
# load the gem
|
294
218
|
require 'notifo'
|
295
219
|
|
296
220
|
api_instance = Notifo::UsersApi.new
|
297
221
|
app_id = 'app_id_example' # String | The app where the user belongs to.
|
298
222
|
id = 'id_example' # String | The user id.
|
299
223
|
|
224
|
+
|
300
225
|
begin
|
301
|
-
#
|
226
|
+
#Get a user.
|
302
227
|
result = api_instance.users_get_user(app_id, id)
|
303
228
|
p result
|
304
229
|
rescue Notifo::ApiError => e
|
305
|
-
puts "
|
306
|
-
end
|
307
|
-
```
|
308
|
-
|
309
|
-
#### Using the users_get_user_with_http_info variant
|
310
|
-
|
311
|
-
This returns an Array which contains the response data, status code and headers.
|
312
|
-
|
313
|
-
> <Array(<ListResponseDtoOfUserDto>, Integer, Hash)> users_get_user_with_http_info(app_id, id)
|
314
|
-
|
315
|
-
```ruby
|
316
|
-
begin
|
317
|
-
# Get a user.
|
318
|
-
data, status_code, headers = api_instance.users_get_user_with_http_info(app_id, id)
|
319
|
-
p status_code # => 2xx
|
320
|
-
p headers # => { ... }
|
321
|
-
p data # => <ListResponseDtoOfUserDto>
|
322
|
-
rescue Notifo::ApiError => e
|
323
|
-
puts "Error when calling UsersApi->users_get_user_with_http_info: #{e}"
|
230
|
+
puts "Exception when calling UsersApi->users_get_user: #{e}"
|
324
231
|
end
|
325
232
|
```
|
326
233
|
|
327
234
|
### Parameters
|
328
235
|
|
329
|
-
|
330
|
-
|
331
|
-
|
332
|
-
|
236
|
+
Name | Type | Description | Notes
|
237
|
+
------------- | ------------- | ------------- | -------------
|
238
|
+
**app_id** | **String**| The app where the user belongs to. |
|
239
|
+
**id** | **String**| The user id. |
|
333
240
|
|
334
241
|
### Return type
|
335
242
|
|
@@ -341,65 +248,46 @@ No authorization required
|
|
341
248
|
|
342
249
|
### HTTP request headers
|
343
250
|
|
344
|
-
- **Content-Type**: Not defined
|
345
|
-
- **Accept**: application/json
|
251
|
+
- **Content-Type**: Not defined
|
252
|
+
- **Accept**: application/json
|
346
253
|
|
347
254
|
|
348
|
-
## users_get_users
|
349
255
|
|
350
|
-
|
256
|
+
# **users_get_users**
|
257
|
+
> ListResponseDtoOfUserDto users_get_users(app_id, opts)
|
351
258
|
|
352
259
|
Query users.
|
353
260
|
|
354
|
-
###
|
355
|
-
|
261
|
+
### Example
|
356
262
|
```ruby
|
357
|
-
|
263
|
+
# load the gem
|
358
264
|
require 'notifo'
|
359
265
|
|
360
266
|
api_instance = Notifo::UsersApi.new
|
361
267
|
app_id = 'app_id_example' # String | The app where the users belongs to.
|
362
|
-
opts = {
|
268
|
+
opts = {
|
363
269
|
query: 'query_example', # String | The optional query to search for items.
|
364
270
|
take: 56, # Integer | The number of items to return.
|
365
271
|
skip: 56 # Integer | The number of items to skip.
|
366
272
|
}
|
367
273
|
|
368
274
|
begin
|
369
|
-
#
|
275
|
+
#Query users.
|
370
276
|
result = api_instance.users_get_users(app_id, opts)
|
371
277
|
p result
|
372
278
|
rescue Notifo::ApiError => e
|
373
|
-
puts "
|
374
|
-
end
|
375
|
-
```
|
376
|
-
|
377
|
-
#### Using the users_get_users_with_http_info variant
|
378
|
-
|
379
|
-
This returns an Array which contains the response data, status code and headers.
|
380
|
-
|
381
|
-
> <Array(<ListResponseDtoOfUserDto>, Integer, Hash)> users_get_users_with_http_info(app_id, opts)
|
382
|
-
|
383
|
-
```ruby
|
384
|
-
begin
|
385
|
-
# Query users.
|
386
|
-
data, status_code, headers = api_instance.users_get_users_with_http_info(app_id, opts)
|
387
|
-
p status_code # => 2xx
|
388
|
-
p headers # => { ... }
|
389
|
-
p data # => <ListResponseDtoOfUserDto>
|
390
|
-
rescue Notifo::ApiError => e
|
391
|
-
puts "Error when calling UsersApi->users_get_users_with_http_info: #{e}"
|
279
|
+
puts "Exception when calling UsersApi->users_get_users: #{e}"
|
392
280
|
end
|
393
281
|
```
|
394
282
|
|
395
283
|
### Parameters
|
396
284
|
|
397
|
-
|
398
|
-
|
399
|
-
|
400
|
-
|
401
|
-
|
402
|
-
|
285
|
+
Name | Type | Description | Notes
|
286
|
+
------------- | ------------- | ------------- | -------------
|
287
|
+
**app_id** | **String**| The app where the users belongs to. |
|
288
|
+
**query** | **String**| The optional query to search for items. | [optional]
|
289
|
+
**take** | **Integer**| The number of items to return. | [optional]
|
290
|
+
**skip** | **Integer**| The number of items to skip. | [optional]
|
403
291
|
|
404
292
|
### Return type
|
405
293
|
|
@@ -411,60 +299,42 @@ No authorization required
|
|
411
299
|
|
412
300
|
### HTTP request headers
|
413
301
|
|
414
|
-
- **Content-Type**: Not defined
|
415
|
-
- **Accept**: application/json
|
302
|
+
- **Content-Type**: Not defined
|
303
|
+
- **Accept**: application/json
|
416
304
|
|
417
305
|
|
418
|
-
## users_post_allowed_topic
|
419
306
|
|
420
|
-
|
307
|
+
# **users_post_allowed_topic**
|
308
|
+
> users_post_allowed_topic(bodyapp_idid)
|
421
309
|
|
422
310
|
Add an allowed topic.
|
423
311
|
|
424
|
-
###
|
425
|
-
|
312
|
+
### Example
|
426
313
|
```ruby
|
427
|
-
|
314
|
+
# load the gem
|
428
315
|
require 'notifo'
|
429
316
|
|
430
317
|
api_instance = Notifo::UsersApi.new
|
318
|
+
body = Notifo::AddAllowedTopicDto.new # AddAllowedTopicDto | The upsert request.
|
431
319
|
app_id = 'app_id_example' # String | The app where the users belong to.
|
432
320
|
id = 'id_example' # String | The user id.
|
433
|
-
add_allowed_topic_request = Notifo::AddAllowedTopicRequest.new # AddAllowedTopicRequest | The upsert request.
|
434
|
-
|
435
|
-
begin
|
436
|
-
# Add an allowed topic.
|
437
|
-
api_instance.users_post_allowed_topic(app_id, id, add_allowed_topic_request)
|
438
|
-
rescue Notifo::ApiError => e
|
439
|
-
puts "Error when calling UsersApi->users_post_allowed_topic: #{e}"
|
440
|
-
end
|
441
|
-
```
|
442
|
-
|
443
|
-
#### Using the users_post_allowed_topic_with_http_info variant
|
444
321
|
|
445
|
-
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
446
322
|
|
447
|
-
> <Array(nil, Integer, Hash)> users_post_allowed_topic_with_http_info(app_id, id, add_allowed_topic_request)
|
448
|
-
|
449
|
-
```ruby
|
450
323
|
begin
|
451
|
-
#
|
452
|
-
|
453
|
-
p status_code # => 2xx
|
454
|
-
p headers # => { ... }
|
455
|
-
p data # => nil
|
324
|
+
#Add an allowed topic.
|
325
|
+
api_instance.users_post_allowed_topic(bodyapp_idid)
|
456
326
|
rescue Notifo::ApiError => e
|
457
|
-
puts "
|
327
|
+
puts "Exception when calling UsersApi->users_post_allowed_topic: #{e}"
|
458
328
|
end
|
459
329
|
```
|
460
330
|
|
461
331
|
### Parameters
|
462
332
|
|
463
|
-
|
464
|
-
|
465
|
-
|
466
|
-
|
467
|
-
|
333
|
+
Name | Type | Description | Notes
|
334
|
+
------------- | ------------- | ------------- | -------------
|
335
|
+
**body** | [**AddAllowedTopicDto**](AddAllowedTopicDto.md)| The upsert request. |
|
336
|
+
**app_id** | **String**| The app where the users belong to. |
|
337
|
+
**id** | **String**| The user id. |
|
468
338
|
|
469
339
|
### Return type
|
470
340
|
|
@@ -476,60 +346,42 @@ No authorization required
|
|
476
346
|
|
477
347
|
### HTTP request headers
|
478
348
|
|
479
|
-
- **Content-Type**: application/json
|
480
|
-
- **Accept**: application/json
|
349
|
+
- **Content-Type**: application/json
|
350
|
+
- **Accept**: application/json
|
481
351
|
|
482
352
|
|
483
|
-
## users_post_subscription
|
484
353
|
|
485
|
-
|
354
|
+
# **users_post_subscription**
|
355
|
+
> users_post_subscription(bodyapp_idid)
|
486
356
|
|
487
357
|
Upsert a user subscriptions.
|
488
358
|
|
489
|
-
###
|
490
|
-
|
359
|
+
### Example
|
491
360
|
```ruby
|
492
|
-
|
361
|
+
# load the gem
|
493
362
|
require 'notifo'
|
494
363
|
|
495
364
|
api_instance = Notifo::UsersApi.new
|
365
|
+
body = Notifo::SubscriptionDto.new # SubscriptionDto | The subscription object.
|
496
366
|
app_id = 'app_id_example' # String | The app where the user belongs to.
|
497
367
|
id = 'id_example' # String | The user id.
|
498
|
-
subscribe_dto = Notifo::SubscribeDto.new # SubscribeDto | The subscription object.
|
499
|
-
|
500
|
-
begin
|
501
|
-
# Upsert a user subscriptions.
|
502
|
-
api_instance.users_post_subscription(app_id, id, subscribe_dto)
|
503
|
-
rescue Notifo::ApiError => e
|
504
|
-
puts "Error when calling UsersApi->users_post_subscription: #{e}"
|
505
|
-
end
|
506
|
-
```
|
507
|
-
|
508
|
-
#### Using the users_post_subscription_with_http_info variant
|
509
368
|
|
510
|
-
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
511
369
|
|
512
|
-
> <Array(nil, Integer, Hash)> users_post_subscription_with_http_info(app_id, id, subscribe_dto)
|
513
|
-
|
514
|
-
```ruby
|
515
370
|
begin
|
516
|
-
#
|
517
|
-
|
518
|
-
p status_code # => 2xx
|
519
|
-
p headers # => { ... }
|
520
|
-
p data # => nil
|
371
|
+
#Upsert a user subscriptions.
|
372
|
+
api_instance.users_post_subscription(bodyapp_idid)
|
521
373
|
rescue Notifo::ApiError => e
|
522
|
-
puts "
|
374
|
+
puts "Exception when calling UsersApi->users_post_subscription: #{e}"
|
523
375
|
end
|
524
376
|
```
|
525
377
|
|
526
378
|
### Parameters
|
527
379
|
|
528
|
-
|
529
|
-
|
530
|
-
|
531
|
-
|
532
|
-
|
380
|
+
Name | Type | Description | Notes
|
381
|
+
------------- | ------------- | ------------- | -------------
|
382
|
+
**body** | [**SubscriptionDto**](SubscriptionDto.md)| The subscription object. |
|
383
|
+
**app_id** | **String**| The app where the user belongs to. |
|
384
|
+
**id** | **String**| The user id. |
|
533
385
|
|
534
386
|
### Return type
|
535
387
|
|
@@ -541,59 +393,41 @@ No authorization required
|
|
541
393
|
|
542
394
|
### HTTP request headers
|
543
395
|
|
544
|
-
- **Content-Type**: application/json
|
545
|
-
- **Accept**: application/json
|
396
|
+
- **Content-Type**: application/json
|
397
|
+
- **Accept**: application/json
|
546
398
|
|
547
399
|
|
548
|
-
## users_post_users
|
549
400
|
|
550
|
-
|
401
|
+
# **users_post_users**
|
402
|
+
> Array<UserDto> users_post_users(bodyapp_id)
|
551
403
|
|
552
404
|
Upsert users.
|
553
405
|
|
554
|
-
###
|
555
|
-
|
406
|
+
### Example
|
556
407
|
```ruby
|
557
|
-
|
408
|
+
# load the gem
|
558
409
|
require 'notifo'
|
559
410
|
|
560
411
|
api_instance = Notifo::UsersApi.new
|
412
|
+
body = Notifo::UpsertUsersDto.new # UpsertUsersDto | The upsert request.
|
561
413
|
app_id = 'app_id_example' # String | The app where the users belong to.
|
562
|
-
upsert_users_dto = Notifo::UpsertUsersDto.new # UpsertUsersDto | The upsert request.
|
563
414
|
|
564
|
-
begin
|
565
|
-
# Upsert users.
|
566
|
-
result = api_instance.users_post_users(app_id, upsert_users_dto)
|
567
|
-
p result
|
568
|
-
rescue Notifo::ApiError => e
|
569
|
-
puts "Error when calling UsersApi->users_post_users: #{e}"
|
570
|
-
end
|
571
|
-
```
|
572
|
-
|
573
|
-
#### Using the users_post_users_with_http_info variant
|
574
415
|
|
575
|
-
This returns an Array which contains the response data, status code and headers.
|
576
|
-
|
577
|
-
> <Array(<Array<UserDto>>, Integer, Hash)> users_post_users_with_http_info(app_id, upsert_users_dto)
|
578
|
-
|
579
|
-
```ruby
|
580
416
|
begin
|
581
|
-
#
|
582
|
-
|
583
|
-
p
|
584
|
-
p headers # => { ... }
|
585
|
-
p data # => <Array<UserDto>>
|
417
|
+
#Upsert users.
|
418
|
+
result = api_instance.users_post_users(bodyapp_id)
|
419
|
+
p result
|
586
420
|
rescue Notifo::ApiError => e
|
587
|
-
puts "
|
421
|
+
puts "Exception when calling UsersApi->users_post_users: #{e}"
|
588
422
|
end
|
589
423
|
```
|
590
424
|
|
591
425
|
### Parameters
|
592
426
|
|
593
|
-
|
594
|
-
|
595
|
-
|
596
|
-
|
427
|
+
Name | Type | Description | Notes
|
428
|
+
------------- | ------------- | ------------- | -------------
|
429
|
+
**body** | [**UpsertUsersDto**](UpsertUsersDto.md)| The upsert request. |
|
430
|
+
**app_id** | **String**| The app where the users belong to. |
|
597
431
|
|
598
432
|
### Return type
|
599
433
|
|
@@ -605,6 +439,8 @@ No authorization required
|
|
605
439
|
|
606
440
|
### HTTP request headers
|
607
441
|
|
608
|
-
- **Content-Type**: application/json
|
609
|
-
- **Accept**: application/json
|
442
|
+
- **Content-Type**: application/json
|
443
|
+
- **Accept**: application/json
|
444
|
+
|
445
|
+
|
610
446
|
|