notifo-io-easierlife 1.0.0 → 1.0.1.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +599 -97
- data/Rakefile +0 -2
- data/docs/AddAllowedTopicDto.md +4 -15
- data/docs/AddContributorDto.md +5 -17
- data/docs/AppContributorDto.md +6 -19
- data/docs/AppDetailsDto.md +19 -45
- data/docs/AppDto.md +9 -25
- data/docs/AppsApi.md +181 -363
- data/docs/Body.md +7 -0
- data/docs/ConfigsApi.md +28 -68
- data/docs/ConfirmMode.md +3 -12
- data/docs/CreateEmailTemplateDto.md +4 -15
- data/docs/EmailTemplateDto.md +6 -19
- data/docs/EmailTemplatesDto.md +6 -0
- data/docs/EmailVerificationStatus.md +3 -12
- data/docs/ErrorDto.md +8 -23
- data/docs/EventDto.md +15 -37
- data/docs/EventProperties.md +6 -0
- data/docs/EventsApi.md +43 -80
- data/docs/IsoDayOfWeek.md +3 -12
- data/docs/ListResponseDtoOfEventDto.md +5 -17
- data/docs/ListResponseDtoOfLogEntryDto.md +5 -17
- data/docs/ListResponseDtoOfMediaDto.md +5 -17
- data/docs/ListResponseDtoOfSubscriptionDto.md +5 -17
- data/docs/ListResponseDtoOfTemplateDto.md +5 -17
- data/docs/ListResponseDtoOfTopicDto.md +5 -17
- data/docs/ListResponseDtoOfUserDto.md +5 -17
- data/docs/LocalizedText.md +6 -0
- data/docs/LogEntryDto.md +7 -21
- data/docs/LogsApi.md +25 -44
- data/docs/MediaApi.md +118 -212
- data/docs/MediaDto.md +10 -27
- data/docs/MediaMetadata.md +6 -0
- data/docs/MediaType.md +3 -12
- data/docs/NotificationFormattingDto.md +11 -29
- data/docs/NotificationSend.md +3 -12
- data/docs/NotificationSettingDto.md +5 -17
- data/docs/ProfileDto.md +11 -29
- data/docs/PublishDto.md +13 -33
- data/docs/PublishManyDto.md +4 -15
- data/docs/ResizeMode.md +3 -12
- data/docs/SchedulingDto.md +7 -21
- data/docs/SchedulingType.md +3 -12
- data/docs/SubscriptionDto.md +5 -17
- data/docs/TemplateDto.md +6 -19
- data/docs/TemplatesApi.md +61 -116
- data/docs/TopicDto.md +6 -19
- data/docs/TopicsApi.md +25 -44
- data/docs/UpdateProfileDto.md +9 -25
- data/docs/UpsertAppDto.md +13 -33
- data/docs/UpsertTemplateDto.md +6 -19
- data/docs/UpsertTemplatesDto.md +4 -15
- data/docs/UpsertUserDto.md +11 -29
- data/docs/UpsertUsersDto.md +4 -15
- data/docs/UserApi.md +84 -176
- data/docs/UserDto.md +13 -33
- data/docs/UsersApi.md +173 -337
- data/git_push.sh +7 -10
- data/lib/swagger_client.rb +93 -0
- data/lib/{notifo → swagger_client}/api/apps_api.rb +131 -203
- data/lib/{notifo → swagger_client}/api/configs_api.rb +15 -31
- data/lib/{notifo → swagger_client}/api/events_api.rb +30 -46
- data/lib/{notifo → swagger_client}/api/logs_api.rb +13 -22
- data/lib/{notifo → swagger_client}/api/media_api.rb +61 -98
- data/lib/{notifo → swagger_client}/api/templates_api.rb +40 -63
- data/lib/{notifo → swagger_client}/api/topics_api.rb +13 -22
- data/lib/{notifo → swagger_client}/api/user_api.rb +52 -89
- data/lib/{notifo → swagger_client}/api/users_api.rb +122 -187
- data/lib/{notifo → swagger_client}/api_client.rb +55 -57
- data/lib/{notifo → swagger_client}/api_error.rb +6 -6
- data/lib/{notifo → swagger_client}/configuration.rb +12 -84
- data/lib/{notifo → swagger_client}/models/add_allowed_topic_dto.rb +16 -47
- data/lib/swagger_client/models/add_contributor_dto.rb +227 -0
- data/lib/swagger_client/models/app_contributor_dto.rb +242 -0
- data/lib/{notifo → swagger_client}/models/app_details_dto.rb +31 -106
- data/lib/{notifo → swagger_client}/models/app_dto.rb +21 -90
- data/lib/swagger_client/models/body.rb +206 -0
- data/lib/swagger_client/models/confirm_mode.rb +29 -0
- data/lib/{notifo → swagger_client}/models/create_email_template_dto.rb +16 -47
- data/lib/swagger_client/models/email_template_dto.rb +237 -0
- data/lib/swagger_client/models/email_templates_dto.rb +201 -0
- data/lib/swagger_client/models/email_verification_status.rb +30 -0
- data/lib/{notifo → swagger_client}/models/error_dto.rb +20 -36
- data/lib/{notifo → swagger_client}/models/event_dto.rb +27 -117
- data/lib/swagger_client/models/event_properties.rb +201 -0
- data/lib/swagger_client/models/iso_day_of_week.rb +34 -0
- data/lib/{notifo/models/list_response_dto_of_subscription_dto.rb → swagger_client/models/list_response_dto_of_event_dto.rb} +18 -30
- data/lib/{notifo → swagger_client}/models/list_response_dto_of_log_entry_dto.rb +17 -29
- data/lib/{notifo → swagger_client}/models/list_response_dto_of_media_dto.rb +17 -29
- data/lib/{notifo/models/list_response_dto_of_event_dto.rb → swagger_client/models/list_response_dto_of_subscription_dto.rb} +18 -30
- data/lib/{notifo → swagger_client}/models/list_response_dto_of_template_dto.rb +17 -29
- data/lib/{notifo → swagger_client}/models/list_response_dto_of_topic_dto.rb +17 -29
- data/lib/{notifo → swagger_client}/models/list_response_dto_of_user_dto.rb +17 -29
- data/lib/swagger_client/models/localized_text.rb +201 -0
- data/lib/{notifo → swagger_client}/models/log_entry_dto.rb +19 -88
- data/lib/{notifo → swagger_client}/models/media_dto.rb +23 -113
- data/lib/swagger_client/models/media_metadata.rb +201 -0
- data/lib/swagger_client/models/media_type.rb +30 -0
- data/lib/{notifo → swagger_client}/models/notification_formatting_dto.rb +30 -56
- data/lib/swagger_client/models/notification_send.rb +30 -0
- data/lib/{notifo → swagger_client}/models/notification_setting_dto.rb +26 -39
- data/lib/{notifo → swagger_client}/models/profile_dto.rb +23 -76
- data/lib/{notifo → swagger_client}/models/publish_dto.rb +26 -63
- data/lib/{notifo → swagger_client}/models/publish_many_dto.rb +16 -28
- data/lib/swagger_client/models/resize_mode.rb +33 -0
- data/lib/{notifo → swagger_client}/models/scheduling_dto.rb +19 -32
- data/lib/swagger_client/models/scheduling_type.rb +28 -0
- data/lib/{notifo → swagger_client}/models/subscription_dto.rb +17 -49
- data/lib/{notifo → swagger_client}/models/template_dto.rb +18 -49
- data/lib/{notifo → swagger_client}/models/topic_dto.rb +18 -68
- data/lib/{notifo → swagger_client}/models/update_profile_dto.rb +21 -39
- data/lib/{notifo → swagger_client}/models/upsert_app_dto.rb +25 -47
- data/lib/{notifo → swagger_client}/models/upsert_template_dto.rb +18 -50
- data/lib/{notifo → swagger_client}/models/upsert_templates_dto.rb +16 -28
- data/lib/{notifo → swagger_client}/models/upsert_user_dto.rb +23 -43
- data/lib/{notifo → swagger_client}/models/upsert_users_dto.rb +16 -28
- data/lib/{notifo → swagger_client}/models/user_dto.rb +25 -80
- data/lib/swagger_client/version.rb +14 -0
- data/spec/api/apps_api_spec.rb +14 -15
- data/spec/api/configs_api_spec.rb +8 -9
- data/spec/api/events_api_spec.rb +9 -10
- data/spec/api/logs_api_spec.rb +8 -9
- data/spec/api/media_api_spec.rb +13 -14
- data/spec/api/templates_api_spec.rb +9 -10
- data/spec/api/topics_api_spec.rb +8 -9
- data/spec/api/user_api_spec.rb +10 -11
- data/spec/api/users_api_spec.rb +11 -12
- data/spec/api_client_spec.rb +34 -35
- data/spec/base_object_spec.rb +109 -0
- data/spec/configuration_spec.rb +7 -8
- data/spec/models/add_allowed_topic_dto_spec.rb +16 -10
- data/spec/models/add_contributor_dto_spec.rb +16 -10
- data/spec/models/app_contributor_dto_spec.rb +16 -10
- data/spec/models/app_details_dto_spec.rb +16 -10
- data/spec/models/app_dto_spec.rb +16 -10
- data/spec/models/body_spec.rb +40 -0
- data/spec/models/confirm_mode_spec.rb +16 -10
- data/spec/models/create_email_template_dto_spec.rb +16 -10
- data/spec/models/email_template_dto_spec.rb +16 -10
- data/spec/models/email_templates_dto_spec.rb +34 -0
- data/spec/models/email_verification_status_spec.rb +16 -10
- data/spec/models/error_dto_spec.rb +16 -10
- data/spec/models/event_dto_spec.rb +16 -10
- data/spec/models/event_properties_spec.rb +34 -0
- data/spec/models/iso_day_of_week_spec.rb +16 -10
- data/spec/models/list_response_dto_of_event_dto_spec.rb +16 -10
- data/spec/models/list_response_dto_of_log_entry_dto_spec.rb +16 -10
- data/spec/models/list_response_dto_of_media_dto_spec.rb +16 -10
- data/spec/models/list_response_dto_of_subscription_dto_spec.rb +16 -10
- data/spec/models/list_response_dto_of_template_dto_spec.rb +16 -10
- data/spec/models/list_response_dto_of_topic_dto_spec.rb +16 -10
- data/spec/models/list_response_dto_of_user_dto_spec.rb +16 -10
- data/spec/models/localized_text_spec.rb +34 -0
- data/spec/models/log_entry_dto_spec.rb +16 -10
- data/spec/models/media_dto_spec.rb +16 -10
- data/spec/models/media_metadata_spec.rb +34 -0
- data/spec/models/media_type_spec.rb +16 -10
- data/spec/models/notification_formatting_dto_spec.rb +16 -10
- data/spec/models/notification_send_spec.rb +16 -10
- data/spec/models/notification_setting_dto_spec.rb +17 -11
- data/spec/models/profile_dto_spec.rb +16 -10
- data/spec/models/publish_dto_spec.rb +16 -10
- data/spec/models/publish_many_dto_spec.rb +16 -10
- data/spec/models/resize_mode_spec.rb +16 -10
- data/spec/models/scheduling_dto_spec.rb +16 -10
- data/spec/models/scheduling_type_spec.rb +16 -10
- data/spec/models/subscription_dto_spec.rb +16 -10
- data/spec/models/template_dto_spec.rb +16 -10
- data/spec/models/topic_dto_spec.rb +16 -10
- data/spec/models/update_profile_dto_spec.rb +16 -10
- data/spec/models/upsert_app_dto_spec.rb +16 -10
- data/spec/models/upsert_template_dto_spec.rb +16 -10
- data/spec/models/upsert_templates_dto_spec.rb +16 -10
- data/spec/models/upsert_user_dto_spec.rb +16 -10
- data/spec/models/upsert_users_dto_spec.rb +16 -10
- data/spec/models/user_dto_spec.rb +16 -10
- data/spec/spec_helper.rb +5 -6
- data/{notifo.gemspec → swagger_client.gemspec} +9 -9
- metadata +101 -60
- data/lib/notifo.rb +0 -89
- data/lib/notifo/models/add_contributor_dto.rb +0 -277
- data/lib/notifo/models/app_contributor_dto.rb +0 -311
- data/lib/notifo/models/confirm_mode.rb +0 -38
- data/lib/notifo/models/email_template_dto.rb +0 -288
- data/lib/notifo/models/email_verification_status.rb +0 -39
- data/lib/notifo/models/iso_day_of_week.rb +0 -43
- data/lib/notifo/models/media_type.rb +0 -39
- data/lib/notifo/models/notification_send.rb +0 -39
- data/lib/notifo/models/resize_mode.rb +0 -42
- data/lib/notifo/models/scheduling_type.rb +0 -37
- data/lib/notifo/version.rb +0 -15
- data/notifo-io-1.0.0.gem +0 -0
data/docs/TopicDto.md
CHANGED
@@ -1,22 +1,9 @@
|
|
1
|
-
#
|
1
|
+
# SwaggerClient::TopicDto
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
|
7
|
-
|
8
|
-
|
9
|
-
| **counters** | **Hash<String, Integer>** | The statistics counters. | |
|
10
|
-
|
11
|
-
## Example
|
12
|
-
|
13
|
-
```ruby
|
14
|
-
require 'notifo'
|
15
|
-
|
16
|
-
instance = Notifo::TopicDto.new(
|
17
|
-
path: null,
|
18
|
-
last_update: null,
|
19
|
-
counters: null
|
20
|
-
)
|
21
|
-
```
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**path** | **String** | The topic path. |
|
7
|
+
**last_update** | **DateTime** | THe last update to the topic. |
|
8
|
+
**counters** | **Hash<String, Integer>** | The statistics counters. |
|
22
9
|
|
data/docs/TopicsApi.md
CHANGED
@@ -1,67 +1,46 @@
|
|
1
|
-
#
|
1
|
+
# SwaggerClient::TopicsApi
|
2
2
|
|
3
|
-
All URIs are relative to *https://notifo.
|
3
|
+
All URIs are relative to *https://app.notifo.io*
|
4
4
|
|
5
|
-
|
6
|
-
|
7
|
-
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**topics_get_topics**](TopicsApi.md#topics_get_topics) | **GET** /api/apps/{appId}/topics | Query topics.
|
8
8
|
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
> <ListResponseDtoOfTopicDto> topics_get_topics(app_id, opts)
|
9
|
+
# **topics_get_topics**
|
10
|
+
> ListResponseDtoOfTopicDto topics_get_topics(app_id, opts)
|
13
11
|
|
14
12
|
Query topics.
|
15
13
|
|
16
|
-
###
|
17
|
-
|
14
|
+
### Example
|
18
15
|
```ruby
|
19
|
-
|
20
|
-
require '
|
16
|
+
# load the gem
|
17
|
+
require 'swagger_client'
|
21
18
|
|
22
|
-
api_instance =
|
19
|
+
api_instance = SwaggerClient::TopicsApi.new
|
23
20
|
app_id = 'app_id_example' # String | The app where the topics belongs to.
|
24
|
-
opts = {
|
21
|
+
opts = {
|
25
22
|
query: 'query_example', # String | The optional query to search for items.
|
26
23
|
take: 56, # Integer | The number of items to return.
|
27
24
|
skip: 56 # Integer | The number of items to skip.
|
28
25
|
}
|
29
26
|
|
30
27
|
begin
|
31
|
-
#
|
28
|
+
#Query topics.
|
32
29
|
result = api_instance.topics_get_topics(app_id, opts)
|
33
30
|
p result
|
34
|
-
rescue
|
35
|
-
puts "
|
36
|
-
end
|
37
|
-
```
|
38
|
-
|
39
|
-
#### Using the topics_get_topics_with_http_info variant
|
40
|
-
|
41
|
-
This returns an Array which contains the response data, status code and headers.
|
42
|
-
|
43
|
-
> <Array(<ListResponseDtoOfTopicDto>, Integer, Hash)> topics_get_topics_with_http_info(app_id, opts)
|
44
|
-
|
45
|
-
```ruby
|
46
|
-
begin
|
47
|
-
# Query topics.
|
48
|
-
data, status_code, headers = api_instance.topics_get_topics_with_http_info(app_id, opts)
|
49
|
-
p status_code # => 2xx
|
50
|
-
p headers # => { ... }
|
51
|
-
p data # => <ListResponseDtoOfTopicDto>
|
52
|
-
rescue Notifo::ApiError => e
|
53
|
-
puts "Error when calling TopicsApi->topics_get_topics_with_http_info: #{e}"
|
31
|
+
rescue SwaggerClient::ApiError => e
|
32
|
+
puts "Exception when calling TopicsApi->topics_get_topics: #{e}"
|
54
33
|
end
|
55
34
|
```
|
56
35
|
|
57
36
|
### Parameters
|
58
37
|
|
59
|
-
|
60
|
-
|
61
|
-
|
62
|
-
|
63
|
-
|
64
|
-
|
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]
|
65
44
|
|
66
45
|
### Return type
|
67
46
|
|
@@ -73,6 +52,8 @@ No authorization required
|
|
73
52
|
|
74
53
|
### HTTP request headers
|
75
54
|
|
76
|
-
- **Content-Type**: Not defined
|
77
|
-
- **Accept**: application/json
|
55
|
+
- **Content-Type**: Not defined
|
56
|
+
- **Accept**: application/json
|
57
|
+
|
58
|
+
|
78
59
|
|
data/docs/UpdateProfileDto.md
CHANGED
@@ -1,28 +1,12 @@
|
|
1
|
-
#
|
1
|
+
# SwaggerClient::UpdateProfileDto
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
| **settings** | [**Hash<String, NotificationSettingDto>**](NotificationSettingDto.md) | Notification settings per channel. | [optional] |
|
13
|
-
|
14
|
-
## Example
|
15
|
-
|
16
|
-
```ruby
|
17
|
-
require 'notifo'
|
18
|
-
|
19
|
-
instance = Notifo::UpdateProfileDto.new(
|
20
|
-
full_name: null,
|
21
|
-
email_address: null,
|
22
|
-
phone_number: null,
|
23
|
-
preferred_language: null,
|
24
|
-
preferred_timezone: null,
|
25
|
-
settings: null
|
26
|
-
)
|
27
|
-
```
|
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]
|
28
12
|
|
data/docs/UpsertAppDto.md
CHANGED
@@ -1,36 +1,16 @@
|
|
1
|
-
#
|
1
|
+
# SwaggerClient::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
|
+
# SwaggerClient::UpsertTemplateDto
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
|
7
|
-
|
8
|
-
|
9
|
-
| **settings** | [**Hash<String, NotificationSettingDto>**](NotificationSettingDto.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
|
+
# SwaggerClient::UpsertTemplatesDto
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
|
7
|
-
| **requests** | [**Array<UpsertTemplateDto>**](UpsertTemplateDto.md) | The templates to update. | |
|
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,14 @@
|
|
1
|
-
#
|
1
|
+
# SwaggerClient::UpsertUserDto
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
|
14
|
-
| **settings** | [**Hash<String, NotificationSettingDto>**](NotificationSettingDto.md) | Notification settings per channel. | [optional] |
|
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
|
+
**preferred_language** | **String** | The preferred language of the user. | [optional]
|
11
|
+
**preferred_timezone** | **String** | The timezone of the user. | [optional]
|
12
|
+
**requires_whitelisted_topics** | **BOOLEAN** | True when only whitelisted topic are allowed. | [optional]
|
13
|
+
**settings** | [**Hash<String, NotificationSettingDto>**](NotificationSettingDto.md) | Notification settings per channel. | [optional]
|
32
14
|
|
data/docs/UpsertUsersDto.md
CHANGED
@@ -1,18 +1,7 @@
|
|
1
|
-
#
|
1
|
+
# SwaggerClient::UpsertUsersDto
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
|
7
|
-
| **requests** | [**Array<UpsertUserDto>**](UpsertUserDto.md) | The users to update. | |
|
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
CHANGED
@@ -1,64 +1,44 @@
|
|
1
|
-
#
|
1
|
+
# SwaggerClient::UserApi
|
2
2
|
|
3
|
-
All URIs are relative to *https://notifo.
|
3
|
+
All URIs are relative to *https://app.notifo.io*
|
4
4
|
|
5
|
-
|
6
|
-
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
|
14
|
-
## user_delete_subscription
|
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.
|
15
12
|
|
13
|
+
# **user_delete_subscription**
|
16
14
|
> user_delete_subscription(topic)
|
17
15
|
|
18
16
|
Deletes a user subscription.
|
19
17
|
|
20
18
|
User Id and App Id are resolved using the API token.
|
21
19
|
|
22
|
-
###
|
23
|
-
|
20
|
+
### Example
|
24
21
|
```ruby
|
25
|
-
|
26
|
-
require '
|
22
|
+
# load the gem
|
23
|
+
require 'swagger_client'
|
27
24
|
|
28
|
-
api_instance =
|
25
|
+
api_instance = SwaggerClient::UserApi.new
|
29
26
|
topic = 'topic_example' # String | The topic path.
|
30
27
|
|
31
|
-
begin
|
32
|
-
# Deletes a user subscription.
|
33
|
-
api_instance.user_delete_subscription(topic)
|
34
|
-
rescue Notifo::ApiError => e
|
35
|
-
puts "Error when calling UserApi->user_delete_subscription: #{e}"
|
36
|
-
end
|
37
|
-
```
|
38
28
|
|
39
|
-
#### Using the user_delete_subscription_with_http_info variant
|
40
|
-
|
41
|
-
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
42
|
-
|
43
|
-
> <Array(nil, Integer, Hash)> user_delete_subscription_with_http_info(topic)
|
44
|
-
|
45
|
-
```ruby
|
46
29
|
begin
|
47
|
-
#
|
48
|
-
|
49
|
-
|
50
|
-
|
51
|
-
p data # => nil
|
52
|
-
rescue Notifo::ApiError => e
|
53
|
-
puts "Error when calling UserApi->user_delete_subscription_with_http_info: #{e}"
|
30
|
+
#Deletes a user subscription.
|
31
|
+
api_instance.user_delete_subscription(topic)
|
32
|
+
rescue SwaggerClient::ApiError => e
|
33
|
+
puts "Exception when calling UserApi->user_delete_subscription: #{e}"
|
54
34
|
end
|
55
35
|
```
|
56
36
|
|
57
37
|
### Parameters
|
58
38
|
|
59
|
-
|
60
|
-
|
61
|
-
|
39
|
+
Name | Type | Description | Notes
|
40
|
+
------------- | ------------- | ------------- | -------------
|
41
|
+
**topic** | **String**| The topic path. |
|
62
42
|
|
63
43
|
### Return type
|
64
44
|
|
@@ -70,59 +50,41 @@ No authorization required
|
|
70
50
|
|
71
51
|
### HTTP request headers
|
72
52
|
|
73
|
-
- **Content-Type**: Not defined
|
74
|
-
- **Accept**: application/json
|
53
|
+
- **Content-Type**: Not defined
|
54
|
+
- **Accept**: application/json
|
75
55
|
|
76
56
|
|
77
|
-
## user_get_subscription
|
78
57
|
|
79
|
-
|
58
|
+
# **user_get_subscription**
|
59
|
+
> SubscriptionDto user_get_subscription(topic)
|
80
60
|
|
81
61
|
Gets a user subscription.
|
82
62
|
|
83
63
|
User Id and App Id are resolved using the API token.
|
84
64
|
|
85
|
-
###
|
86
|
-
|
65
|
+
### Example
|
87
66
|
```ruby
|
88
|
-
|
89
|
-
require '
|
67
|
+
# load the gem
|
68
|
+
require 'swagger_client'
|
90
69
|
|
91
|
-
api_instance =
|
70
|
+
api_instance = SwaggerClient::UserApi.new
|
92
71
|
topic = 'topic_example' # String | The topic path.
|
93
72
|
|
73
|
+
|
94
74
|
begin
|
95
|
-
#
|
75
|
+
#Gets a user subscription.
|
96
76
|
result = api_instance.user_get_subscription(topic)
|
97
77
|
p result
|
98
|
-
rescue
|
99
|
-
puts "
|
100
|
-
end
|
101
|
-
```
|
102
|
-
|
103
|
-
#### Using the user_get_subscription_with_http_info variant
|
104
|
-
|
105
|
-
This returns an Array which contains the response data, status code and headers.
|
106
|
-
|
107
|
-
> <Array(<SubscriptionDto>, Integer, Hash)> user_get_subscription_with_http_info(topic)
|
108
|
-
|
109
|
-
```ruby
|
110
|
-
begin
|
111
|
-
# Gets a user subscription.
|
112
|
-
data, status_code, headers = api_instance.user_get_subscription_with_http_info(topic)
|
113
|
-
p status_code # => 2xx
|
114
|
-
p headers # => { ... }
|
115
|
-
p data # => <SubscriptionDto>
|
116
|
-
rescue Notifo::ApiError => e
|
117
|
-
puts "Error when calling UserApi->user_get_subscription_with_http_info: #{e}"
|
78
|
+
rescue SwaggerClient::ApiError => e
|
79
|
+
puts "Exception when calling UserApi->user_get_subscription: #{e}"
|
118
80
|
end
|
119
81
|
```
|
120
82
|
|
121
83
|
### Parameters
|
122
84
|
|
123
|
-
|
124
|
-
|
125
|
-
|
85
|
+
Name | Type | Description | Notes
|
86
|
+
------------- | ------------- | ------------- | -------------
|
87
|
+
**topic** | **String**| The topic path. |
|
126
88
|
|
127
89
|
### Return type
|
128
90
|
|
@@ -134,53 +96,33 @@ No authorization required
|
|
134
96
|
|
135
97
|
### HTTP request headers
|
136
98
|
|
137
|
-
- **Content-Type**: Not defined
|
138
|
-
- **Accept**: application/json
|
99
|
+
- **Content-Type**: Not defined
|
100
|
+
- **Accept**: application/json
|
139
101
|
|
140
102
|
|
141
|
-
## user_get_user
|
142
103
|
|
143
|
-
|
104
|
+
# **user_get_user**
|
105
|
+
> ProfileDto user_get_user
|
144
106
|
|
145
107
|
Get the current user.
|
146
108
|
|
147
|
-
###
|
148
|
-
|
109
|
+
### Example
|
149
110
|
```ruby
|
150
|
-
|
151
|
-
require '
|
111
|
+
# load the gem
|
112
|
+
require 'swagger_client'
|
152
113
|
|
153
|
-
api_instance =
|
114
|
+
api_instance = SwaggerClient::UserApi.new
|
154
115
|
|
155
116
|
begin
|
156
|
-
#
|
117
|
+
#Get the current user.
|
157
118
|
result = api_instance.user_get_user
|
158
119
|
p result
|
159
|
-
rescue
|
160
|
-
puts "
|
161
|
-
end
|
162
|
-
```
|
163
|
-
|
164
|
-
#### Using the user_get_user_with_http_info variant
|
165
|
-
|
166
|
-
This returns an Array which contains the response data, status code and headers.
|
167
|
-
|
168
|
-
> <Array(<ProfileDto>, Integer, Hash)> user_get_user_with_http_info
|
169
|
-
|
170
|
-
```ruby
|
171
|
-
begin
|
172
|
-
# Get the current user.
|
173
|
-
data, status_code, headers = api_instance.user_get_user_with_http_info
|
174
|
-
p status_code # => 2xx
|
175
|
-
p headers # => { ... }
|
176
|
-
p data # => <ProfileDto>
|
177
|
-
rescue Notifo::ApiError => e
|
178
|
-
puts "Error when calling UserApi->user_get_user_with_http_info: #{e}"
|
120
|
+
rescue SwaggerClient::ApiError => e
|
121
|
+
puts "Exception when calling UserApi->user_get_user: #{e}"
|
179
122
|
end
|
180
123
|
```
|
181
124
|
|
182
125
|
### Parameters
|
183
|
-
|
184
126
|
This endpoint does not need any parameter.
|
185
127
|
|
186
128
|
### Return type
|
@@ -193,58 +135,40 @@ No authorization required
|
|
193
135
|
|
194
136
|
### HTTP request headers
|
195
137
|
|
196
|
-
- **Content-Type**: Not defined
|
197
|
-
- **Accept**: application/json
|
138
|
+
- **Content-Type**: Not defined
|
139
|
+
- **Accept**: application/json
|
198
140
|
|
199
141
|
|
200
|
-
## user_post_subscription
|
201
142
|
|
202
|
-
|
143
|
+
# **user_post_subscription**
|
144
|
+
> user_post_subscription(body)
|
203
145
|
|
204
146
|
Creates a user subscription.
|
205
147
|
|
206
148
|
User Id and App Id are resolved using the API token.
|
207
149
|
|
208
|
-
###
|
209
|
-
|
150
|
+
### Example
|
210
151
|
```ruby
|
211
|
-
|
212
|
-
require '
|
213
|
-
|
214
|
-
api_instance = Notifo::UserApi.new
|
215
|
-
subscription_dto = Notifo::SubscriptionDto.new({topic_prefix: 'topic_prefix_example'}) # SubscriptionDto | The subscription settings.
|
216
|
-
|
217
|
-
begin
|
218
|
-
# Creates a user subscription.
|
219
|
-
api_instance.user_post_subscription(subscription_dto)
|
220
|
-
rescue Notifo::ApiError => e
|
221
|
-
puts "Error when calling UserApi->user_post_subscription: #{e}"
|
222
|
-
end
|
223
|
-
```
|
224
|
-
|
225
|
-
#### Using the user_post_subscription_with_http_info variant
|
152
|
+
# load the gem
|
153
|
+
require 'swagger_client'
|
226
154
|
|
227
|
-
|
155
|
+
api_instance = SwaggerClient::UserApi.new
|
156
|
+
body = SwaggerClient::SubscriptionDto.new # SubscriptionDto | The subscription settings.
|
228
157
|
|
229
|
-
> <Array(nil, Integer, Hash)> user_post_subscription_with_http_info(subscription_dto)
|
230
158
|
|
231
|
-
```ruby
|
232
159
|
begin
|
233
|
-
#
|
234
|
-
|
235
|
-
|
236
|
-
|
237
|
-
p data # => nil
|
238
|
-
rescue Notifo::ApiError => e
|
239
|
-
puts "Error when calling UserApi->user_post_subscription_with_http_info: #{e}"
|
160
|
+
#Creates a user subscription.
|
161
|
+
api_instance.user_post_subscription(body)
|
162
|
+
rescue SwaggerClient::ApiError => e
|
163
|
+
puts "Exception when calling UserApi->user_post_subscription: #{e}"
|
240
164
|
end
|
241
165
|
```
|
242
166
|
|
243
167
|
### Parameters
|
244
168
|
|
245
|
-
|
246
|
-
|
247
|
-
|
169
|
+
Name | Type | Description | Notes
|
170
|
+
------------- | ------------- | ------------- | -------------
|
171
|
+
**body** | [**SubscriptionDto**](SubscriptionDto.md)| The subscription settings. |
|
248
172
|
|
249
173
|
### Return type
|
250
174
|
|
@@ -256,57 +180,39 @@ No authorization required
|
|
256
180
|
|
257
181
|
### HTTP request headers
|
258
182
|
|
259
|
-
- **Content-Type**: application/json
|
260
|
-
- **Accept**: application/json
|
183
|
+
- **Content-Type**: application/json
|
184
|
+
- **Accept**: application/json
|
261
185
|
|
262
186
|
|
263
|
-
## user_post_user
|
264
187
|
|
265
|
-
|
188
|
+
# **user_post_user**
|
189
|
+
> ProfileDto user_post_user(body)
|
266
190
|
|
267
191
|
Update the user.
|
268
192
|
|
269
|
-
###
|
270
|
-
|
193
|
+
### Example
|
271
194
|
```ruby
|
272
|
-
|
273
|
-
require '
|
195
|
+
# load the gem
|
196
|
+
require 'swagger_client'
|
274
197
|
|
275
|
-
api_instance =
|
276
|
-
|
277
|
-
|
278
|
-
begin
|
279
|
-
# Update the user.
|
280
|
-
result = api_instance.user_post_user(update_profile_dto)
|
281
|
-
p result
|
282
|
-
rescue Notifo::ApiError => e
|
283
|
-
puts "Error when calling UserApi->user_post_user: #{e}"
|
284
|
-
end
|
285
|
-
```
|
198
|
+
api_instance = SwaggerClient::UserApi.new
|
199
|
+
body = SwaggerClient::UpdateProfileDto.new # UpdateProfileDto | The upsert request.
|
286
200
|
|
287
|
-
#### Using the user_post_user_with_http_info variant
|
288
201
|
|
289
|
-
This returns an Array which contains the response data, status code and headers.
|
290
|
-
|
291
|
-
> <Array(<ProfileDto>, Integer, Hash)> user_post_user_with_http_info(update_profile_dto)
|
292
|
-
|
293
|
-
```ruby
|
294
202
|
begin
|
295
|
-
#
|
296
|
-
|
297
|
-
p
|
298
|
-
|
299
|
-
|
300
|
-
rescue Notifo::ApiError => e
|
301
|
-
puts "Error when calling UserApi->user_post_user_with_http_info: #{e}"
|
203
|
+
#Update the user.
|
204
|
+
result = api_instance.user_post_user(body)
|
205
|
+
p result
|
206
|
+
rescue SwaggerClient::ApiError => e
|
207
|
+
puts "Exception when calling UserApi->user_post_user: #{e}"
|
302
208
|
end
|
303
209
|
```
|
304
210
|
|
305
211
|
### Parameters
|
306
212
|
|
307
|
-
|
308
|
-
|
309
|
-
|
213
|
+
Name | Type | Description | Notes
|
214
|
+
------------- | ------------- | ------------- | -------------
|
215
|
+
**body** | [**UpdateProfileDto**](UpdateProfileDto.md)| The upsert request. |
|
310
216
|
|
311
217
|
### Return type
|
312
218
|
|
@@ -318,6 +224,8 @@ No authorization required
|
|
318
224
|
|
319
225
|
### HTTP request headers
|
320
226
|
|
321
|
-
- **Content-Type**: application/json
|
322
|
-
- **Accept**: application/json
|
227
|
+
- **Content-Type**: application/json
|
228
|
+
- **Accept**: application/json
|
229
|
+
|
230
|
+
|
323
231
|
|