notifo-io 1.0.0.2 → 1.0.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 +3 -3
- data/docs/AddAllowedTopicDto.md +1 -1
- data/docs/AddContributorDto.md +2 -2
- data/docs/AppContributorDto.md +3 -3
- data/docs/AppDetailsDto.md +10 -10
- data/docs/AppDto.md +6 -6
- data/docs/AppsApi.md +8 -8
- data/docs/ConfigsApi.md +1 -1
- data/docs/CreateEmailTemplateDto.md +1 -1
- data/docs/EmailTemplateDto.md +2 -2
- data/docs/EventDto.md +9 -9
- data/docs/EventsApi.md +2 -2
- data/docs/ListResponseDtoOfEventDto.md +2 -2
- data/docs/ListResponseDtoOfLogEntryDto.md +2 -2
- data/docs/ListResponseDtoOfMediaDto.md +2 -2
- data/docs/ListResponseDtoOfSubscriptionDto.md +2 -2
- data/docs/ListResponseDtoOfTemplateDto.md +2 -2
- data/docs/ListResponseDtoOfTopicDto.md +2 -2
- data/docs/ListResponseDtoOfUserDto.md +2 -2
- data/docs/LogEntryDto.md +4 -4
- data/docs/LogsApi.md +1 -1
- data/docs/MediaApi.md +89 -2
- data/docs/MediaDto.md +8 -6
- data/docs/NotificationFormattingDto.md +2 -2
- data/docs/NotificationSettingDto.md +1 -1
- data/docs/ProfileDto.md +5 -5
- data/docs/PublishDto.md +1 -1
- data/docs/PublishManyDto.md +1 -1
- data/docs/SubscriptionDto.md +1 -1
- data/docs/TemplateDto.md +3 -3
- data/docs/TemplatesApi.md +2 -2
- data/docs/TopicDto.md +3 -3
- data/docs/TopicsApi.md +1 -1
- data/docs/UpsertTemplateDto.md +2 -2
- data/docs/UpsertTemplatesDto.md +1 -1
- data/docs/UpsertUsersDto.md +1 -1
- data/docs/UserApi.md +2 -2
- data/docs/UserDto.md +5 -5
- data/docs/UsersApi.md +4 -4
- data/lib/notifo.rb +1 -2
- data/lib/notifo/api/apps_api.rb +4 -4
- data/lib/notifo/api/configs_api.rb +1 -1
- data/lib/notifo/api/events_api.rb +1 -1
- data/lib/notifo/api/logs_api.rb +1 -1
- data/lib/notifo/api/media_api.rb +99 -2
- data/lib/notifo/api/templates_api.rb +1 -1
- data/lib/notifo/api/topics_api.rb +1 -1
- data/lib/notifo/api/user_api.rb +1 -1
- data/lib/notifo/api/users_api.rb +1 -1
- data/lib/notifo/api_client.rb +2 -2
- data/lib/notifo/api_error.rb +1 -1
- data/lib/notifo/configuration.rb +9 -7
- data/lib/notifo/models/add_allowed_topic_dto.rb +25 -1
- data/lib/notifo/models/add_contributor_dto.rb +49 -1
- data/lib/notifo/models/app_contributor_dto.rb +73 -1
- data/lib/notifo/models/app_details_dto.rb +108 -1
- data/lib/notifo/models/app_dto.rb +88 -1
- data/lib/notifo/models/confirm_mode.rb +1 -1
- data/lib/notifo/models/create_email_template_dto.rb +25 -1
- data/lib/notifo/models/email_template_dto.rb +49 -1
- data/lib/notifo/models/email_verification_status.rb +1 -1
- data/lib/notifo/models/error_dto.rb +1 -1
- data/lib/notifo/models/event_dto.rb +122 -2
- data/lib/notifo/models/iso_day_of_week.rb +1 -1
- data/lib/notifo/models/list_response_dto_of_event_dto.rb +11 -1
- data/lib/notifo/models/list_response_dto_of_log_entry_dto.rb +11 -1
- data/lib/notifo/models/list_response_dto_of_media_dto.rb +11 -1
- data/lib/notifo/models/list_response_dto_of_subscription_dto.rb +11 -1
- data/lib/notifo/models/list_response_dto_of_template_dto.rb +11 -1
- data/lib/notifo/models/list_response_dto_of_topic_dto.rb +11 -1
- data/lib/notifo/models/list_response_dto_of_user_dto.rb +11 -1
- data/lib/notifo/models/log_entry_dto.rb +78 -1
- data/lib/notifo/models/media_dto.rb +123 -2
- data/lib/notifo/models/media_type.rb +1 -1
- data/lib/notifo/models/notification_formatting_dto.rb +11 -1
- data/lib/notifo/models/notification_send.rb +1 -1
- data/lib/notifo/models/notification_setting_dto.rb +6 -1
- data/lib/notifo/models/profile_dto.rb +67 -1
- data/lib/notifo/models/publish_dto.rb +25 -1
- data/lib/notifo/models/publish_many_dto.rb +6 -1
- data/lib/notifo/models/resize_mode.rb +1 -1
- data/lib/notifo/models/scheduling_dto.rb +1 -1
- data/lib/notifo/models/scheduling_type.rb +1 -1
- data/lib/notifo/models/subscription_dto.rb +25 -1
- data/lib/notifo/models/template_dto.rb +35 -1
- data/lib/notifo/models/topic_dto.rb +54 -1
- data/lib/notifo/models/update_profile_dto.rb +1 -1
- data/lib/notifo/models/upsert_app_dto.rb +1 -1
- data/lib/notifo/models/upsert_template_dto.rb +30 -1
- data/lib/notifo/models/upsert_templates_dto.rb +6 -1
- data/lib/notifo/models/upsert_user_dto.rb +1 -1
- data/lib/notifo/models/upsert_users_dto.rb +6 -1
- data/lib/notifo/models/user_dto.rb +69 -1
- data/lib/notifo/version.rb +1 -1
- data/notifo-io-1.0.0.2.gem +0 -0
- data/notifo.gemspec +4 -4
- data/spec/api_client_spec.rb +1 -1
- data/spec/configuration_spec.rb +4 -4
- data/spec/spec_helper.rb +1 -1
- metadata +7 -5
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 9d062b4c430988329a313e8aa0c77ab40c55e9309b571e996c2e1871aeb51173
|
4
|
+
data.tar.gz: 35fc9503fb989aab8d97bcf3e621c711f3d2115fade957367655d26660a09343
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 2b7663aef8fb5f0adf76040913ac9f4f10c999d3fbd6c57d56e26b5e6f5c3332b6377c4523e40c7612babbee06a3ddb260c22922e0184f7359ecd06aff2ece92
|
7
|
+
data.tar.gz: cdadaedfe34a5a6214e96029857160fb9ad457d0d327093aaae94b4242fa9ffa247d6fc9666dcfa68b16e96f7161a02073304432e91d9c5abf6333cd5356a55d
|
data/README.md
CHANGED
@@ -72,7 +72,7 @@ end
|
|
72
72
|
|
73
73
|
## Documentation for API Endpoints
|
74
74
|
|
75
|
-
All URIs are relative to *
|
75
|
+
All URIs are relative to *http://localhost*
|
76
76
|
|
77
77
|
Class | Method | HTTP request | Description
|
78
78
|
------------ | ------------- | ------------- | -------------
|
@@ -92,7 +92,8 @@ Class | Method | HTTP request | Description
|
|
92
92
|
*Notifo::EventsApi* | [**events_post_events**](docs/EventsApi.md#events_post_events) | **POST** /api/apps/{appId}/events | Publish events.
|
93
93
|
*Notifo::LogsApi* | [**logs_get_logs**](docs/LogsApi.md#logs_get_logs) | **GET** /api/apps/{appId}/logs | Query log entries.
|
94
94
|
*Notifo::MediaApi* | [**media_delete**](docs/MediaApi.md#media_delete) | **DELETE** /api/apps/{appId}/media/{fileName} | Delete a media.
|
95
|
-
*Notifo::MediaApi* | [**media_download**](docs/MediaApi.md#media_download) | **GET** /api/
|
95
|
+
*Notifo::MediaApi* | [**media_download**](docs/MediaApi.md#media_download) | **GET** /api/apps/{appId}/media/{fileName} | Download a media object.
|
96
|
+
*Notifo::MediaApi* | [**media_download2**](docs/MediaApi.md#media_download2) | **GET** /api/assets/{appId}/{fileName} | Download a media object.
|
96
97
|
*Notifo::MediaApi* | [**media_get_medias**](docs/MediaApi.md#media_get_medias) | **GET** /api/apps/{appId}/media | Query media items.
|
97
98
|
*Notifo::MediaApi* | [**media_upload**](docs/MediaApi.md#media_upload) | **POST** /api/apps/{appId}/media | Upload a media object.
|
98
99
|
*Notifo::TemplatesApi* | [**templates_delete_template**](docs/TemplatesApi.md#templates_delete_template) | **DELETE** /api/apps/{appId}/templates/{code} | Delete a template.
|
@@ -128,7 +129,6 @@ Class | Method | HTTP request | Description
|
|
128
129
|
- [Notifo::EmailVerificationStatus](docs/EmailVerificationStatus.md)
|
129
130
|
- [Notifo::ErrorDto](docs/ErrorDto.md)
|
130
131
|
- [Notifo::EventDto](docs/EventDto.md)
|
131
|
-
- [Notifo::InlineObject](docs/InlineObject.md)
|
132
132
|
- [Notifo::IsoDayOfWeek](docs/IsoDayOfWeek.md)
|
133
133
|
- [Notifo::ListResponseDtoOfEventDto](docs/ListResponseDtoOfEventDto.md)
|
134
134
|
- [Notifo::ListResponseDtoOfLogEntryDto](docs/ListResponseDtoOfLogEntryDto.md)
|
data/docs/AddAllowedTopicDto.md
CHANGED
data/docs/AddContributorDto.md
CHANGED
@@ -4,8 +4,8 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **email** | **String** | The email of the new contributor. |
|
8
|
-
| **role** | **String** | The role. |
|
7
|
+
| **email** | **String** | The email of the new contributor. | |
|
8
|
+
| **role** | **String** | The role. | |
|
9
9
|
|
10
10
|
## Example
|
11
11
|
|
data/docs/AppContributorDto.md
CHANGED
@@ -4,9 +4,9 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **user_id** | **String** | The id of the user. |
|
8
|
-
| **user_name** | **String** | The name of the user. |
|
9
|
-
| **role** | **String** | The role. |
|
7
|
+
| **user_id** | **String** | The id of the user. | |
|
8
|
+
| **user_name** | **String** | The name of the user. | |
|
9
|
+
| **role** | **String** | The role. | |
|
10
10
|
|
11
11
|
## Example
|
12
12
|
|
data/docs/AppDetailsDto.md
CHANGED
@@ -4,22 +4,22 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **id** | **String** | The id of the app. |
|
8
|
-
| **name** | **String** | The app name. |
|
9
|
-
| **role** | **String** | The current role. |
|
10
|
-
| **languages** | **Array<String>** | The supported languages. |
|
7
|
+
| **id** | **String** | The id of the app. | |
|
8
|
+
| **name** | **String** | The app name. | |
|
9
|
+
| **role** | **String** | The current role. | |
|
10
|
+
| **languages** | **Array<String>** | The supported languages. | |
|
11
11
|
| **email_address** | **String** | The sender email address. | [optional] |
|
12
12
|
| **email_name** | **String** | The sender email name. | [optional] |
|
13
13
|
| **firebase_project** | **String** | The firebase project ID. | [optional] |
|
14
14
|
| **firebase_credential** | **String** | The firebase credentials. | [optional] |
|
15
15
|
| **webhook_url** | **String** | The webhook URL. | [optional] |
|
16
16
|
| **confirm_url** | **String** | The confirm URL. | [optional] |
|
17
|
-
| **allow_email** | **Boolean** | True, when emails are allowed. |
|
18
|
-
| **allow_sms** | **Boolean** | True, when SMS are allowed. |
|
19
|
-
| **email_verification_status** | [**EmailVerificationStatus**](EmailVerificationStatus.md) | |
|
20
|
-
| **api_keys** | **Hash<String, String>** | The api keys. |
|
21
|
-
| **contributors** | [**Array<AppContributorDto>**](AppContributorDto.md) | The contributors. |
|
22
|
-
| **counters** | **Hash<String, Integer>** | The statistics counters. |
|
17
|
+
| **allow_email** | **Boolean** | True, when emails are allowed. | |
|
18
|
+
| **allow_sms** | **Boolean** | True, when SMS are allowed. | |
|
19
|
+
| **email_verification_status** | [**EmailVerificationStatus**](EmailVerificationStatus.md) | | |
|
20
|
+
| **api_keys** | **Hash<String, String>** | The api keys. | |
|
21
|
+
| **contributors** | [**Array<AppContributorDto>**](AppContributorDto.md) | The contributors. | |
|
22
|
+
| **counters** | **Hash<String, Integer>** | The statistics counters. | |
|
23
23
|
|
24
24
|
## Example
|
25
25
|
|
data/docs/AppDto.md
CHANGED
@@ -4,12 +4,12 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **id** | **String** | The id of the app. |
|
8
|
-
| **name** | **String** | The app name. |
|
9
|
-
| **role** | **String** | The current role. |
|
10
|
-
| **languages** | **Array<String>** | The supported languages. |
|
11
|
-
| **api_keys** | **Hash<String, String>** | The api keys. |
|
12
|
-
| **counters** | **Hash<String, Integer>** | The statistics counters. |
|
7
|
+
| **id** | **String** | The id of the app. | |
|
8
|
+
| **name** | **String** | The app name. | |
|
9
|
+
| **role** | **String** | The current role. | |
|
10
|
+
| **languages** | **Array<String>** | The supported languages. | |
|
11
|
+
| **api_keys** | **Hash<String, String>** | The api keys. | |
|
12
|
+
| **counters** | **Hash<String, Integer>** | The statistics counters. | |
|
13
13
|
|
14
14
|
## Example
|
15
15
|
|
data/docs/AppsApi.md
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
# Notifo::AppsApi
|
2
2
|
|
3
|
-
All URIs are relative to *
|
3
|
+
All URIs are relative to *http://localhost*
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
@@ -402,7 +402,7 @@ require 'notifo'
|
|
402
402
|
|
403
403
|
api_instance = Notifo::AppsApi.new
|
404
404
|
app_id = 'app_id_example' # String | The id of the app.
|
405
|
-
add_contributor_dto = Notifo::AddContributorDto.new # AddContributorDto | The request object.
|
405
|
+
add_contributor_dto = Notifo::AddContributorDto.new({email: 'email_example', role: 'role_example'}) # AddContributorDto | The request object.
|
406
406
|
|
407
407
|
begin
|
408
408
|
# Add an app contributor.
|
@@ -454,7 +454,7 @@ No authorization required
|
|
454
454
|
|
455
455
|
## apps_post_email_template
|
456
456
|
|
457
|
-
> <
|
457
|
+
> <EmailTemplateDto> apps_post_email_template(app_id, create_email_template_dto)
|
458
458
|
|
459
459
|
Create an app email template.
|
460
460
|
|
@@ -466,7 +466,7 @@ require 'notifo'
|
|
466
466
|
|
467
467
|
api_instance = Notifo::AppsApi.new
|
468
468
|
app_id = 'app_id_example' # String | The id of the app where the email templates belong to.
|
469
|
-
create_email_template_dto = Notifo::CreateEmailTemplateDto.new # CreateEmailTemplateDto | The request object.
|
469
|
+
create_email_template_dto = Notifo::CreateEmailTemplateDto.new({language: 'language_example'}) # CreateEmailTemplateDto | The request object.
|
470
470
|
|
471
471
|
begin
|
472
472
|
# Create an app email template.
|
@@ -481,7 +481,7 @@ end
|
|
481
481
|
|
482
482
|
This returns an Array which contains the response data, status code and headers.
|
483
483
|
|
484
|
-
> <Array(<
|
484
|
+
> <Array(<EmailTemplateDto>, Integer, Hash)> apps_post_email_template_with_http_info(app_id, create_email_template_dto)
|
485
485
|
|
486
486
|
```ruby
|
487
487
|
begin
|
@@ -489,7 +489,7 @@ begin
|
|
489
489
|
data, status_code, headers = api_instance.apps_post_email_template_with_http_info(app_id, create_email_template_dto)
|
490
490
|
p status_code # => 2xx
|
491
491
|
p headers # => { ... }
|
492
|
-
p data # => <
|
492
|
+
p data # => <EmailTemplateDto>
|
493
493
|
rescue Notifo::ApiError => e
|
494
494
|
puts "Error when calling AppsApi->apps_post_email_template_with_http_info: #{e}"
|
495
495
|
end
|
@@ -504,7 +504,7 @@ end
|
|
504
504
|
|
505
505
|
### Return type
|
506
506
|
|
507
|
-
[**
|
507
|
+
[**EmailTemplateDto**](EmailTemplateDto.md)
|
508
508
|
|
509
509
|
### Authorization
|
510
510
|
|
@@ -595,7 +595,7 @@ require 'notifo'
|
|
595
595
|
api_instance = Notifo::AppsApi.new
|
596
596
|
app_id = 'app_id_example' # String | The id of the app where the email templates belong to.
|
597
597
|
language = 'language_example' # String | The language.
|
598
|
-
email_template_dto = Notifo::EmailTemplateDto.new # EmailTemplateDto | The request object.
|
598
|
+
email_template_dto = Notifo::EmailTemplateDto.new({subject: 'subject_example', body_html: 'body_html_example'}) # EmailTemplateDto | The request object.
|
599
599
|
|
600
600
|
begin
|
601
601
|
# Update an app email template.
|
data/docs/ConfigsApi.md
CHANGED
data/docs/EmailTemplateDto.md
CHANGED
@@ -4,8 +4,8 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **subject** | **String** | The subject text. |
|
8
|
-
| **body_html** | **String** | The body html template. |
|
7
|
+
| **subject** | **String** | The subject text. | |
|
8
|
+
| **body_html** | **String** | The body html template. | |
|
9
9
|
| **body_text** | **String** | The body text template. | [optional] |
|
10
10
|
|
11
11
|
## Example
|
data/docs/EventDto.md
CHANGED
@@ -4,18 +4,18 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **id** | **String** | The id of the event. |
|
8
|
-
| **topic** | **String** | The topic path. |
|
7
|
+
| **id** | **String** | The id of the event. | |
|
8
|
+
| **topic** | **String** | The topic path. | |
|
9
9
|
| **creator_id** | **String** | A custom id to identity the creator. | [optional] |
|
10
|
-
| **display_name** | **String** | The display name. |
|
10
|
+
| **display_name** | **String** | The display name. | |
|
11
11
|
| **data** | **String** | Additional user defined data. | [optional] |
|
12
|
-
| **created** | **Time** | The time when the event has been created. |
|
13
|
-
| **formatting** | [**NotificationFormattingDto**](NotificationFormattingDto.md) | |
|
14
|
-
| **settings** | [**Hash<String, NotificationSettingDto>**](NotificationSettingDto.md) | Notification settings per channel. |
|
15
|
-
| **properties** | **Hash<String, String>** | User defined properties. |
|
12
|
+
| **created** | **Time** | The time when the event has been created. | |
|
13
|
+
| **formatting** | [**NotificationFormattingDto**](NotificationFormattingDto.md) | | |
|
14
|
+
| **settings** | [**Hash<String, NotificationSettingDto>**](NotificationSettingDto.md) | Notification settings per channel. | |
|
15
|
+
| **properties** | **Hash<String, String>** | User defined properties. | |
|
16
16
|
| **scheduling** | [**SchedulingDto**](SchedulingDto.md) | | [optional] |
|
17
|
-
| **counters** | **Hash<String, Integer>** | The statistics counters. |
|
18
|
-
| **silent** | **Boolean** | True when silent. |
|
17
|
+
| **counters** | **Hash<String, Integer>** | The statistics counters. | |
|
18
|
+
| **silent** | **Boolean** | True when silent. | |
|
19
19
|
|
20
20
|
## Example
|
21
21
|
|
data/docs/EventsApi.md
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
# Notifo::EventsApi
|
2
2
|
|
3
|
-
All URIs are relative to *
|
3
|
+
All URIs are relative to *http://localhost*
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
@@ -92,7 +92,7 @@ require 'notifo'
|
|
92
92
|
|
93
93
|
api_instance = Notifo::EventsApi.new
|
94
94
|
app_id = 'app_id_example' # String | The app where the events belongs to.
|
95
|
-
publish_many_dto = Notifo::PublishManyDto.new # PublishManyDto | The publish request.
|
95
|
+
publish_many_dto = Notifo::PublishManyDto.new({requests: [Notifo::PublishDto.new({topic: 'topic_example'})]}) # PublishManyDto | The publish request.
|
96
96
|
|
97
97
|
begin
|
98
98
|
# Publish events.
|
@@ -4,8 +4,8 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **items** | [**Array<EventDto>**](EventDto.md) | The items. |
|
8
|
-
| **total** | **Integer** | The total number of items. |
|
7
|
+
| **items** | [**Array<EventDto>**](EventDto.md) | The items. | |
|
8
|
+
| **total** | **Integer** | The total number of items. | |
|
9
9
|
|
10
10
|
## Example
|
11
11
|
|
@@ -4,8 +4,8 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **items** | [**Array<LogEntryDto>**](LogEntryDto.md) | The items. |
|
8
|
-
| **total** | **Integer** | The total number of items. |
|
7
|
+
| **items** | [**Array<LogEntryDto>**](LogEntryDto.md) | The items. | |
|
8
|
+
| **total** | **Integer** | The total number of items. | |
|
9
9
|
|
10
10
|
## Example
|
11
11
|
|
@@ -4,8 +4,8 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **items** | [**Array<MediaDto>**](MediaDto.md) | The items. |
|
8
|
-
| **total** | **Integer** | The total number of items. |
|
7
|
+
| **items** | [**Array<MediaDto>**](MediaDto.md) | The items. | |
|
8
|
+
| **total** | **Integer** | The total number of items. | |
|
9
9
|
|
10
10
|
## Example
|
11
11
|
|
@@ -4,8 +4,8 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **items** | [**Array<SubscriptionDto>**](SubscriptionDto.md) | The items. |
|
8
|
-
| **total** | **Integer** | The total number of items. |
|
7
|
+
| **items** | [**Array<SubscriptionDto>**](SubscriptionDto.md) | The items. | |
|
8
|
+
| **total** | **Integer** | The total number of items. | |
|
9
9
|
|
10
10
|
## Example
|
11
11
|
|
@@ -4,8 +4,8 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **items** | [**Array<TemplateDto>**](TemplateDto.md) | The items. |
|
8
|
-
| **total** | **Integer** | The total number of items. |
|
7
|
+
| **items** | [**Array<TemplateDto>**](TemplateDto.md) | The items. | |
|
8
|
+
| **total** | **Integer** | The total number of items. | |
|
9
9
|
|
10
10
|
## Example
|
11
11
|
|
@@ -4,8 +4,8 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **items** | [**Array<TopicDto>**](TopicDto.md) | The items. |
|
8
|
-
| **total** | **Integer** | The total number of items. |
|
7
|
+
| **items** | [**Array<TopicDto>**](TopicDto.md) | The items. | |
|
8
|
+
| **total** | **Integer** | The total number of items. | |
|
9
9
|
|
10
10
|
## Example
|
11
11
|
|
@@ -4,8 +4,8 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **items** | [**Array<UserDto>**](UserDto.md) | The items. |
|
8
|
-
| **total** | **Integer** | The total number of items. |
|
7
|
+
| **items** | [**Array<UserDto>**](UserDto.md) | The items. | |
|
8
|
+
| **total** | **Integer** | The total number of items. | |
|
9
9
|
|
10
10
|
## Example
|
11
11
|
|
data/docs/LogEntryDto.md
CHANGED
@@ -4,10 +4,10 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **message** | **String** | The log message. |
|
8
|
-
| **first_seen** | **Time** | The first time this message has been seen. |
|
9
|
-
| **last_seen** | **Time** | The last time this message has been seen. |
|
10
|
-
| **count** | **Integer** | The number of items the message has been seen. |
|
7
|
+
| **message** | **String** | The log message. | |
|
8
|
+
| **first_seen** | **Time** | The first time this message has been seen. | |
|
9
|
+
| **last_seen** | **Time** | The last time this message has been seen. | |
|
10
|
+
| **count** | **Integer** | The number of items the message has been seen. | |
|
11
11
|
|
12
12
|
## Example
|
13
13
|
|
data/docs/LogsApi.md
CHANGED
data/docs/MediaApi.md
CHANGED
@@ -1,11 +1,12 @@
|
|
1
1
|
# Notifo::MediaApi
|
2
2
|
|
3
|
-
All URIs are relative to *
|
3
|
+
All URIs are relative to *http://localhost*
|
4
4
|
|
5
5
|
| Method | HTTP request | Description |
|
6
6
|
| ------ | ------------ | ----------- |
|
7
7
|
| [**media_delete**](MediaApi.md#media_delete) | **DELETE** /api/apps/{appId}/media/{fileName} | Delete a media. |
|
8
|
-
| [**media_download**](MediaApi.md#media_download) | **GET** /api/
|
8
|
+
| [**media_download**](MediaApi.md#media_download) | **GET** /api/apps/{appId}/media/{fileName} | Download a media object. |
|
9
|
+
| [**media_download2**](MediaApi.md#media_download2) | **GET** /api/assets/{appId}/{fileName} | Download a media object. |
|
9
10
|
| [**media_get_medias**](MediaApi.md#media_get_medias) | **GET** /api/apps/{appId}/media | Query media items. |
|
10
11
|
| [**media_upload**](MediaApi.md#media_upload) | **POST** /api/apps/{appId}/media | Upload a media object. |
|
11
12
|
|
@@ -159,6 +160,92 @@ No authorization required
|
|
159
160
|
- **Accept**: application/octet-stream, application/json
|
160
161
|
|
161
162
|
|
163
|
+
## media_download2
|
164
|
+
|
165
|
+
> File media_download2(app_id, file_name, opts)
|
166
|
+
|
167
|
+
Download a media object.
|
168
|
+
|
169
|
+
### Examples
|
170
|
+
|
171
|
+
```ruby
|
172
|
+
require 'time'
|
173
|
+
require 'notifo'
|
174
|
+
|
175
|
+
api_instance = Notifo::MediaApi.new
|
176
|
+
app_id = 'app_id_example' # String | The app id where the media belongs to.
|
177
|
+
file_name = 'file_name_example' # String | The name of the media to download.
|
178
|
+
opts = {
|
179
|
+
cache: 789, # Integer | The cache duration.
|
180
|
+
download: 56, # Integer | Set it to 1 to create a download response.
|
181
|
+
width: 56, # Integer | The target width when an image.
|
182
|
+
height: 56, # Integer | The target height when an image.
|
183
|
+
quality: 56, # Integer | The target quality when an image.
|
184
|
+
preset: 'preset_example', # String | A preset dimension.
|
185
|
+
mode: Notifo::ResizeMode::CROP, # ResizeMode | The resize mode.
|
186
|
+
focus_x: 3.4, # Float | The x position of the focues point.
|
187
|
+
focus_y: 3.4, # Float | The y position of the focues point.
|
188
|
+
force: true # Boolean | True to resize it and clear the cache.
|
189
|
+
}
|
190
|
+
|
191
|
+
begin
|
192
|
+
# Download a media object.
|
193
|
+
result = api_instance.media_download2(app_id, file_name, opts)
|
194
|
+
p result
|
195
|
+
rescue Notifo::ApiError => e
|
196
|
+
puts "Error when calling MediaApi->media_download2: #{e}"
|
197
|
+
end
|
198
|
+
```
|
199
|
+
|
200
|
+
#### Using the media_download2_with_http_info variant
|
201
|
+
|
202
|
+
This returns an Array which contains the response data, status code and headers.
|
203
|
+
|
204
|
+
> <Array(File, Integer, Hash)> media_download2_with_http_info(app_id, file_name, opts)
|
205
|
+
|
206
|
+
```ruby
|
207
|
+
begin
|
208
|
+
# Download a media object.
|
209
|
+
data, status_code, headers = api_instance.media_download2_with_http_info(app_id, file_name, opts)
|
210
|
+
p status_code # => 2xx
|
211
|
+
p headers # => { ... }
|
212
|
+
p data # => File
|
213
|
+
rescue Notifo::ApiError => e
|
214
|
+
puts "Error when calling MediaApi->media_download2_with_http_info: #{e}"
|
215
|
+
end
|
216
|
+
```
|
217
|
+
|
218
|
+
### Parameters
|
219
|
+
|
220
|
+
| Name | Type | Description | Notes |
|
221
|
+
| ---- | ---- | ----------- | ----- |
|
222
|
+
| **app_id** | **String** | The app id where the media belongs to. | |
|
223
|
+
| **file_name** | **String** | The name of the media to download. | |
|
224
|
+
| **cache** | **Integer** | The cache duration. | [optional] |
|
225
|
+
| **download** | **Integer** | Set it to 1 to create a download response. | [optional] |
|
226
|
+
| **width** | **Integer** | The target width when an image. | [optional] |
|
227
|
+
| **height** | **Integer** | The target height when an image. | [optional] |
|
228
|
+
| **quality** | **Integer** | The target quality when an image. | [optional] |
|
229
|
+
| **preset** | **String** | A preset dimension. | [optional] |
|
230
|
+
| **mode** | [**ResizeMode**](.md) | The resize mode. | [optional] |
|
231
|
+
| **focus_x** | **Float** | The x position of the focues point. | [optional] |
|
232
|
+
| **focus_y** | **Float** | The y position of the focues point. | [optional] |
|
233
|
+
| **force** | **Boolean** | True to resize it and clear the cache. | [optional] |
|
234
|
+
|
235
|
+
### Return type
|
236
|
+
|
237
|
+
**File**
|
238
|
+
|
239
|
+
### Authorization
|
240
|
+
|
241
|
+
No authorization required
|
242
|
+
|
243
|
+
### HTTP request headers
|
244
|
+
|
245
|
+
- **Content-Type**: Not defined
|
246
|
+
- **Accept**: application/octet-stream, application/json
|
247
|
+
|
248
|
+
|
162
249
|
## media_get_medias
|
163
250
|
|
164
251
|
> <ListResponseDtoOfMediaDto> media_get_medias(app_id, opts)
|