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/IsoDayOfWeek.md
CHANGED
@@ -1,15 +1,6 @@
|
|
1
|
-
#
|
1
|
+
# SwaggerClient::IsoDayOfWeek
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
|
8
|
-
## Example
|
9
|
-
|
10
|
-
```ruby
|
11
|
-
require 'notifo'
|
12
|
-
|
13
|
-
instance = Notifo::IsoDayOfWeek.new()
|
14
|
-
```
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
15
6
|
|
@@ -1,20 +1,8 @@
|
|
1
|
-
#
|
1
|
+
# SwaggerClient::ListResponseDtoOfEventDto
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
|
7
|
-
|
8
|
-
| **total** | **Integer** | The total number of items. | |
|
9
|
-
|
10
|
-
## Example
|
11
|
-
|
12
|
-
```ruby
|
13
|
-
require 'notifo'
|
14
|
-
|
15
|
-
instance = Notifo::ListResponseDtoOfEventDto.new(
|
16
|
-
items: null,
|
17
|
-
total: null
|
18
|
-
)
|
19
|
-
```
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**items** | [**Array<EventDto>**](EventDto.md) | The items. |
|
7
|
+
**total** | **Integer** | The total number of items. |
|
20
8
|
|
@@ -1,20 +1,8 @@
|
|
1
|
-
#
|
1
|
+
# SwaggerClient::ListResponseDtoOfLogEntryDto
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
|
7
|
-
|
8
|
-
| **total** | **Integer** | The total number of items. | |
|
9
|
-
|
10
|
-
## Example
|
11
|
-
|
12
|
-
```ruby
|
13
|
-
require 'notifo'
|
14
|
-
|
15
|
-
instance = Notifo::ListResponseDtoOfLogEntryDto.new(
|
16
|
-
items: null,
|
17
|
-
total: null
|
18
|
-
)
|
19
|
-
```
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**items** | [**Array<LogEntryDto>**](LogEntryDto.md) | The items. |
|
7
|
+
**total** | **Integer** | The total number of items. |
|
20
8
|
|
@@ -1,20 +1,8 @@
|
|
1
|
-
#
|
1
|
+
# SwaggerClient::ListResponseDtoOfMediaDto
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
|
7
|
-
|
8
|
-
| **total** | **Integer** | The total number of items. | |
|
9
|
-
|
10
|
-
## Example
|
11
|
-
|
12
|
-
```ruby
|
13
|
-
require 'notifo'
|
14
|
-
|
15
|
-
instance = Notifo::ListResponseDtoOfMediaDto.new(
|
16
|
-
items: null,
|
17
|
-
total: null
|
18
|
-
)
|
19
|
-
```
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**items** | [**Array<MediaDto>**](MediaDto.md) | The items. |
|
7
|
+
**total** | **Integer** | The total number of items. |
|
20
8
|
|
@@ -1,20 +1,8 @@
|
|
1
|
-
#
|
1
|
+
# SwaggerClient::ListResponseDtoOfSubscriptionDto
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
|
7
|
-
|
8
|
-
| **total** | **Integer** | The total number of items. | |
|
9
|
-
|
10
|
-
## Example
|
11
|
-
|
12
|
-
```ruby
|
13
|
-
require 'notifo'
|
14
|
-
|
15
|
-
instance = Notifo::ListResponseDtoOfSubscriptionDto.new(
|
16
|
-
items: null,
|
17
|
-
total: null
|
18
|
-
)
|
19
|
-
```
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**items** | [**Array<SubscriptionDto>**](SubscriptionDto.md) | The items. |
|
7
|
+
**total** | **Integer** | The total number of items. |
|
20
8
|
|
@@ -1,20 +1,8 @@
|
|
1
|
-
#
|
1
|
+
# SwaggerClient::ListResponseDtoOfTemplateDto
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
|
7
|
-
|
8
|
-
| **total** | **Integer** | The total number of items. | |
|
9
|
-
|
10
|
-
## Example
|
11
|
-
|
12
|
-
```ruby
|
13
|
-
require 'notifo'
|
14
|
-
|
15
|
-
instance = Notifo::ListResponseDtoOfTemplateDto.new(
|
16
|
-
items: null,
|
17
|
-
total: null
|
18
|
-
)
|
19
|
-
```
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**items** | [**Array<TemplateDto>**](TemplateDto.md) | The items. |
|
7
|
+
**total** | **Integer** | The total number of items. |
|
20
8
|
|
@@ -1,20 +1,8 @@
|
|
1
|
-
#
|
1
|
+
# SwaggerClient::ListResponseDtoOfTopicDto
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
|
7
|
-
|
8
|
-
| **total** | **Integer** | The total number of items. | |
|
9
|
-
|
10
|
-
## Example
|
11
|
-
|
12
|
-
```ruby
|
13
|
-
require 'notifo'
|
14
|
-
|
15
|
-
instance = Notifo::ListResponseDtoOfTopicDto.new(
|
16
|
-
items: null,
|
17
|
-
total: null
|
18
|
-
)
|
19
|
-
```
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**items** | [**Array<TopicDto>**](TopicDto.md) | The items. |
|
7
|
+
**total** | **Integer** | The total number of items. |
|
20
8
|
|
@@ -1,20 +1,8 @@
|
|
1
|
-
#
|
1
|
+
# SwaggerClient::ListResponseDtoOfUserDto
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
|
7
|
-
|
8
|
-
| **total** | **Integer** | The total number of items. | |
|
9
|
-
|
10
|
-
## Example
|
11
|
-
|
12
|
-
```ruby
|
13
|
-
require 'notifo'
|
14
|
-
|
15
|
-
instance = Notifo::ListResponseDtoOfUserDto.new(
|
16
|
-
items: null,
|
17
|
-
total: null
|
18
|
-
)
|
19
|
-
```
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**items** | [**Array<UserDto>**](UserDto.md) | The items. |
|
7
|
+
**total** | **Integer** | The total number of items. |
|
20
8
|
|
data/docs/LogEntryDto.md
CHANGED
@@ -1,24 +1,10 @@
|
|
1
|
-
#
|
1
|
+
# SwaggerClient::LogEntryDto
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
| **count** | **Integer** | The number of items the message has been seen. | |
|
11
|
-
|
12
|
-
## Example
|
13
|
-
|
14
|
-
```ruby
|
15
|
-
require 'notifo'
|
16
|
-
|
17
|
-
instance = Notifo::LogEntryDto.new(
|
18
|
-
message: null,
|
19
|
-
first_seen: null,
|
20
|
-
last_seen: null,
|
21
|
-
count: null
|
22
|
-
)
|
23
|
-
```
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**message** | **String** | The log message. |
|
7
|
+
**first_seen** | **DateTime** | The first time this message has been seen. |
|
8
|
+
**last_seen** | **DateTime** | The last time this message has been seen. |
|
9
|
+
**count** | **Integer** | The number of items the message has been seen. |
|
24
10
|
|
data/docs/LogsApi.md
CHANGED
@@ -1,67 +1,46 @@
|
|
1
|
-
#
|
1
|
+
# SwaggerClient::LogsApi
|
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
|
+
[**logs_get_logs**](LogsApi.md#logs_get_logs) | **GET** /api/apps/{appId}/logs | Query log entries.
|
8
8
|
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
> <ListResponseDtoOfLogEntryDto> logs_get_logs(app_id, opts)
|
9
|
+
# **logs_get_logs**
|
10
|
+
> ListResponseDtoOfLogEntryDto logs_get_logs(app_id, opts)
|
13
11
|
|
14
12
|
Query log entries.
|
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::LogsApi.new
|
23
20
|
app_id = 'app_id_example' # String | The app where the log entries 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 log entries.
|
32
29
|
result = api_instance.logs_get_logs(app_id, opts)
|
33
30
|
p result
|
34
|
-
rescue
|
35
|
-
puts "
|
36
|
-
end
|
37
|
-
```
|
38
|
-
|
39
|
-
#### Using the logs_get_logs_with_http_info variant
|
40
|
-
|
41
|
-
This returns an Array which contains the response data, status code and headers.
|
42
|
-
|
43
|
-
> <Array(<ListResponseDtoOfLogEntryDto>, Integer, Hash)> logs_get_logs_with_http_info(app_id, opts)
|
44
|
-
|
45
|
-
```ruby
|
46
|
-
begin
|
47
|
-
# Query log entries.
|
48
|
-
data, status_code, headers = api_instance.logs_get_logs_with_http_info(app_id, opts)
|
49
|
-
p status_code # => 2xx
|
50
|
-
p headers # => { ... }
|
51
|
-
p data # => <ListResponseDtoOfLogEntryDto>
|
52
|
-
rescue Notifo::ApiError => e
|
53
|
-
puts "Error when calling LogsApi->logs_get_logs_with_http_info: #{e}"
|
31
|
+
rescue SwaggerClient::ApiError => e
|
32
|
+
puts "Exception when calling LogsApi->logs_get_logs: #{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 log entries 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/MediaApi.md
CHANGED
@@ -1,64 +1,44 @@
|
|
1
|
-
#
|
1
|
+
# SwaggerClient::MediaApi
|
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
|
-
## media_delete
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
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/apps/{appId}/media/{fileName} | Download a media object.
|
9
|
+
[**media_download2**](MediaApi.md#media_download2) | **GET** /api/assets/{appId}/{fileName} | Download a media object.
|
10
|
+
[**media_get_medias**](MediaApi.md#media_get_medias) | **GET** /api/apps/{appId}/media | Query media items.
|
11
|
+
[**media_upload**](MediaApi.md#media_upload) | **POST** /api/apps/{appId}/media | Upload a media object.
|
15
12
|
|
13
|
+
# **media_delete**
|
16
14
|
> media_delete(app_id, file_name)
|
17
15
|
|
18
16
|
Delete a media.
|
19
17
|
|
20
|
-
###
|
21
|
-
|
18
|
+
### Example
|
22
19
|
```ruby
|
23
|
-
|
24
|
-
require '
|
20
|
+
# load the gem
|
21
|
+
require 'swagger_client'
|
25
22
|
|
26
|
-
api_instance =
|
23
|
+
api_instance = SwaggerClient::MediaApi.new
|
27
24
|
app_id = 'app_id_example' # String | The app id where the media belongs to.
|
28
25
|
file_name = 'file_name_example' # String | The file name of the media.
|
29
26
|
|
30
|
-
begin
|
31
|
-
# Delete a media.
|
32
|
-
api_instance.media_delete(app_id, file_name)
|
33
|
-
rescue Notifo::ApiError => e
|
34
|
-
puts "Error when calling MediaApi->media_delete: #{e}"
|
35
|
-
end
|
36
|
-
```
|
37
27
|
|
38
|
-
#### Using the media_delete_with_http_info variant
|
39
|
-
|
40
|
-
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
41
|
-
|
42
|
-
> <Array(nil, Integer, Hash)> media_delete_with_http_info(app_id, file_name)
|
43
|
-
|
44
|
-
```ruby
|
45
28
|
begin
|
46
|
-
#
|
47
|
-
|
48
|
-
|
49
|
-
|
50
|
-
p data # => nil
|
51
|
-
rescue Notifo::ApiError => e
|
52
|
-
puts "Error when calling MediaApi->media_delete_with_http_info: #{e}"
|
29
|
+
#Delete a media.
|
30
|
+
api_instance.media_delete(app_id, file_name)
|
31
|
+
rescue SwaggerClient::ApiError => e
|
32
|
+
puts "Exception when calling MediaApi->media_delete: #{e}"
|
53
33
|
end
|
54
34
|
```
|
55
35
|
|
56
36
|
### Parameters
|
57
37
|
|
58
|
-
|
59
|
-
|
60
|
-
|
61
|
-
|
38
|
+
Name | Type | Description | Notes
|
39
|
+
------------- | ------------- | ------------- | -------------
|
40
|
+
**app_id** | **String**| The app id where the media belongs to. |
|
41
|
+
**file_name** | **String**| The file name of the media. |
|
62
42
|
|
63
43
|
### Return type
|
64
44
|
|
@@ -70,85 +50,66 @@ 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
|
-
## media_download
|
78
57
|
|
79
|
-
|
58
|
+
# **media_download**
|
59
|
+
> String media_download(app_id, file_name, opts)
|
80
60
|
|
81
61
|
Download a media object.
|
82
62
|
|
83
|
-
###
|
84
|
-
|
63
|
+
### Example
|
85
64
|
```ruby
|
86
|
-
|
87
|
-
require '
|
65
|
+
# load the gem
|
66
|
+
require 'swagger_client'
|
88
67
|
|
89
|
-
api_instance =
|
68
|
+
api_instance = SwaggerClient::MediaApi.new
|
90
69
|
app_id = 'app_id_example' # String | The app id where the media belongs to.
|
91
70
|
file_name = 'file_name_example' # String | The name of the media to download.
|
92
|
-
opts = {
|
71
|
+
opts = {
|
93
72
|
cache: 789, # Integer | The cache duration.
|
94
73
|
download: 56, # Integer | Set it to 1 to create a download response.
|
95
74
|
width: 56, # Integer | The target width when an image.
|
96
75
|
height: 56, # Integer | The target height when an image.
|
97
76
|
quality: 56, # Integer | The target quality when an image.
|
98
77
|
preset: 'preset_example', # String | A preset dimension.
|
99
|
-
mode:
|
78
|
+
mode: SwaggerClient::ResizeMode.new, # ResizeMode | The resize mode.
|
100
79
|
focus_x: 3.4, # Float | The x position of the focues point.
|
101
80
|
focus_y: 3.4, # Float | The y position of the focues point.
|
102
|
-
force: true #
|
81
|
+
force: true # BOOLEAN | True to resize it and clear the cache.
|
103
82
|
}
|
104
83
|
|
105
84
|
begin
|
106
|
-
#
|
85
|
+
#Download a media object.
|
107
86
|
result = api_instance.media_download(app_id, file_name, opts)
|
108
87
|
p result
|
109
|
-
rescue
|
110
|
-
puts "
|
111
|
-
end
|
112
|
-
```
|
113
|
-
|
114
|
-
#### Using the media_download_with_http_info variant
|
115
|
-
|
116
|
-
This returns an Array which contains the response data, status code and headers.
|
117
|
-
|
118
|
-
> <Array(File, Integer, Hash)> media_download_with_http_info(app_id, file_name, opts)
|
119
|
-
|
120
|
-
```ruby
|
121
|
-
begin
|
122
|
-
# Download a media object.
|
123
|
-
data, status_code, headers = api_instance.media_download_with_http_info(app_id, file_name, opts)
|
124
|
-
p status_code # => 2xx
|
125
|
-
p headers # => { ... }
|
126
|
-
p data # => File
|
127
|
-
rescue Notifo::ApiError => e
|
128
|
-
puts "Error when calling MediaApi->media_download_with_http_info: #{e}"
|
88
|
+
rescue SwaggerClient::ApiError => e
|
89
|
+
puts "Exception when calling MediaApi->media_download: #{e}"
|
129
90
|
end
|
130
91
|
```
|
131
92
|
|
132
93
|
### Parameters
|
133
94
|
|
134
|
-
|
135
|
-
|
136
|
-
|
137
|
-
|
138
|
-
|
139
|
-
|
140
|
-
|
141
|
-
|
142
|
-
|
143
|
-
|
144
|
-
|
145
|
-
|
146
|
-
|
147
|
-
|
95
|
+
Name | Type | Description | Notes
|
96
|
+
------------- | ------------- | ------------- | -------------
|
97
|
+
**app_id** | **String**| The app id where the media belongs to. |
|
98
|
+
**file_name** | **String**| The name of the media to download. |
|
99
|
+
**cache** | **Integer**| The cache duration. | [optional]
|
100
|
+
**download** | **Integer**| Set it to 1 to create a download response. | [optional]
|
101
|
+
**width** | **Integer**| The target width when an image. | [optional]
|
102
|
+
**height** | **Integer**| The target height when an image. | [optional]
|
103
|
+
**quality** | **Integer**| The target quality when an image. | [optional]
|
104
|
+
**preset** | **String**| A preset dimension. | [optional]
|
105
|
+
**mode** | [**ResizeMode**](.md)| The resize mode. | [optional]
|
106
|
+
**focus_x** | **Float**| The x position of the focues point. | [optional]
|
107
|
+
**focus_y** | **Float**| The y position of the focues point. | [optional]
|
108
|
+
**force** | **BOOLEAN**| True to resize it and clear the cache. | [optional]
|
148
109
|
|
149
110
|
### Return type
|
150
111
|
|
151
|
-
**
|
112
|
+
**String**
|
152
113
|
|
153
114
|
### Authorization
|
154
115
|
|
@@ -156,85 +117,66 @@ No authorization required
|
|
156
117
|
|
157
118
|
### HTTP request headers
|
158
119
|
|
159
|
-
- **Content-Type**: Not defined
|
160
|
-
- **Accept**: application/octet-stream, application/json
|
120
|
+
- **Content-Type**: Not defined
|
121
|
+
- **Accept**: application/octet-stream, application/json
|
161
122
|
|
162
123
|
|
163
|
-
## media_download2
|
164
124
|
|
165
|
-
|
125
|
+
# **media_download2**
|
126
|
+
> String media_download2(app_id, file_name, opts)
|
166
127
|
|
167
128
|
Download a media object.
|
168
129
|
|
169
|
-
###
|
170
|
-
|
130
|
+
### Example
|
171
131
|
```ruby
|
172
|
-
|
173
|
-
require '
|
132
|
+
# load the gem
|
133
|
+
require 'swagger_client'
|
174
134
|
|
175
|
-
api_instance =
|
135
|
+
api_instance = SwaggerClient::MediaApi.new
|
176
136
|
app_id = 'app_id_example' # String | The app id where the media belongs to.
|
177
137
|
file_name = 'file_name_example' # String | The name of the media to download.
|
178
|
-
opts = {
|
138
|
+
opts = {
|
179
139
|
cache: 789, # Integer | The cache duration.
|
180
140
|
download: 56, # Integer | Set it to 1 to create a download response.
|
181
141
|
width: 56, # Integer | The target width when an image.
|
182
142
|
height: 56, # Integer | The target height when an image.
|
183
143
|
quality: 56, # Integer | The target quality when an image.
|
184
144
|
preset: 'preset_example', # String | A preset dimension.
|
185
|
-
mode:
|
145
|
+
mode: SwaggerClient::ResizeMode.new, # ResizeMode | The resize mode.
|
186
146
|
focus_x: 3.4, # Float | The x position of the focues point.
|
187
147
|
focus_y: 3.4, # Float | The y position of the focues point.
|
188
|
-
force: true #
|
148
|
+
force: true # BOOLEAN | True to resize it and clear the cache.
|
189
149
|
}
|
190
150
|
|
191
151
|
begin
|
192
|
-
#
|
152
|
+
#Download a media object.
|
193
153
|
result = api_instance.media_download2(app_id, file_name, opts)
|
194
154
|
p result
|
195
|
-
rescue
|
196
|
-
puts "
|
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}"
|
155
|
+
rescue SwaggerClient::ApiError => e
|
156
|
+
puts "Exception when calling MediaApi->media_download2: #{e}"
|
215
157
|
end
|
216
158
|
```
|
217
159
|
|
218
160
|
### Parameters
|
219
161
|
|
220
|
-
|
221
|
-
|
222
|
-
|
223
|
-
|
224
|
-
|
225
|
-
|
226
|
-
|
227
|
-
|
228
|
-
|
229
|
-
|
230
|
-
|
231
|
-
|
232
|
-
|
233
|
-
|
162
|
+
Name | Type | Description | Notes
|
163
|
+
------------- | ------------- | ------------- | -------------
|
164
|
+
**app_id** | **String**| The app id where the media belongs to. |
|
165
|
+
**file_name** | **String**| The name of the media to download. |
|
166
|
+
**cache** | **Integer**| The cache duration. | [optional]
|
167
|
+
**download** | **Integer**| Set it to 1 to create a download response. | [optional]
|
168
|
+
**width** | **Integer**| The target width when an image. | [optional]
|
169
|
+
**height** | **Integer**| The target height when an image. | [optional]
|
170
|
+
**quality** | **Integer**| The target quality when an image. | [optional]
|
171
|
+
**preset** | **String**| A preset dimension. | [optional]
|
172
|
+
**mode** | [**ResizeMode**](.md)| The resize mode. | [optional]
|
173
|
+
**focus_x** | **Float**| The x position of the focues point. | [optional]
|
174
|
+
**focus_y** | **Float**| The y position of the focues point. | [optional]
|
175
|
+
**force** | **BOOLEAN**| True to resize it and clear the cache. | [optional]
|
234
176
|
|
235
177
|
### Return type
|
236
178
|
|
237
|
-
**
|
179
|
+
**String**
|
238
180
|
|
239
181
|
### Authorization
|
240
182
|
|
@@ -242,65 +184,46 @@ No authorization required
|
|
242
184
|
|
243
185
|
### HTTP request headers
|
244
186
|
|
245
|
-
- **Content-Type**: Not defined
|
246
|
-
- **Accept**: application/octet-stream, application/json
|
187
|
+
- **Content-Type**: Not defined
|
188
|
+
- **Accept**: application/octet-stream, application/json
|
247
189
|
|
248
190
|
|
249
|
-
## media_get_medias
|
250
191
|
|
251
|
-
|
192
|
+
# **media_get_medias**
|
193
|
+
> ListResponseDtoOfMediaDto media_get_medias(app_id, opts)
|
252
194
|
|
253
195
|
Query media items.
|
254
196
|
|
255
|
-
###
|
256
|
-
|
197
|
+
### Example
|
257
198
|
```ruby
|
258
|
-
|
259
|
-
require '
|
199
|
+
# load the gem
|
200
|
+
require 'swagger_client'
|
260
201
|
|
261
|
-
api_instance =
|
202
|
+
api_instance = SwaggerClient::MediaApi.new
|
262
203
|
app_id = 'app_id_example' # String | The app where the media belongs to.
|
263
|
-
opts = {
|
204
|
+
opts = {
|
264
205
|
query: 'query_example', # String | The optional query to search for items.
|
265
206
|
take: 56, # Integer | The number of items to return.
|
266
207
|
skip: 56 # Integer | The number of items to skip.
|
267
208
|
}
|
268
209
|
|
269
210
|
begin
|
270
|
-
#
|
211
|
+
#Query media items.
|
271
212
|
result = api_instance.media_get_medias(app_id, opts)
|
272
213
|
p result
|
273
|
-
rescue
|
274
|
-
puts "
|
275
|
-
end
|
276
|
-
```
|
277
|
-
|
278
|
-
#### Using the media_get_medias_with_http_info variant
|
279
|
-
|
280
|
-
This returns an Array which contains the response data, status code and headers.
|
281
|
-
|
282
|
-
> <Array(<ListResponseDtoOfMediaDto>, Integer, Hash)> media_get_medias_with_http_info(app_id, opts)
|
283
|
-
|
284
|
-
```ruby
|
285
|
-
begin
|
286
|
-
# Query media items.
|
287
|
-
data, status_code, headers = api_instance.media_get_medias_with_http_info(app_id, opts)
|
288
|
-
p status_code # => 2xx
|
289
|
-
p headers # => { ... }
|
290
|
-
p data # => <ListResponseDtoOfMediaDto>
|
291
|
-
rescue Notifo::ApiError => e
|
292
|
-
puts "Error when calling MediaApi->media_get_medias_with_http_info: #{e}"
|
214
|
+
rescue SwaggerClient::ApiError => e
|
215
|
+
puts "Exception when calling MediaApi->media_get_medias: #{e}"
|
293
216
|
end
|
294
217
|
```
|
295
218
|
|
296
219
|
### Parameters
|
297
220
|
|
298
|
-
|
299
|
-
|
300
|
-
|
301
|
-
|
302
|
-
|
303
|
-
|
221
|
+
Name | Type | Description | Notes
|
222
|
+
------------- | ------------- | ------------- | -------------
|
223
|
+
**app_id** | **String**| The app where the media belongs to. |
|
224
|
+
**query** | **String**| The optional query to search for items. | [optional]
|
225
|
+
**take** | **Integer**| The number of items to return. | [optional]
|
226
|
+
**skip** | **Integer**| The number of items to skip. | [optional]
|
304
227
|
|
305
228
|
### Return type
|
306
229
|
|
@@ -312,60 +235,41 @@ No authorization required
|
|
312
235
|
|
313
236
|
### HTTP request headers
|
314
237
|
|
315
|
-
- **Content-Type**: Not defined
|
316
|
-
- **Accept**: application/json
|
238
|
+
- **Content-Type**: Not defined
|
239
|
+
- **Accept**: application/json
|
317
240
|
|
318
241
|
|
319
|
-
## media_upload
|
320
242
|
|
243
|
+
# **media_upload**
|
321
244
|
> media_upload(app_id, opts)
|
322
245
|
|
323
246
|
Upload a media object.
|
324
247
|
|
325
|
-
###
|
326
|
-
|
248
|
+
### Example
|
327
249
|
```ruby
|
328
|
-
|
329
|
-
require '
|
250
|
+
# load the gem
|
251
|
+
require 'swagger_client'
|
330
252
|
|
331
|
-
api_instance =
|
253
|
+
api_instance = SwaggerClient::MediaApi.new
|
332
254
|
app_id = 'app_id_example' # String | The app id where the media belongs to.
|
333
|
-
opts = {
|
334
|
-
file:
|
255
|
+
opts = {
|
256
|
+
file: 'file_example' # String |
|
335
257
|
}
|
336
258
|
|
337
259
|
begin
|
338
|
-
#
|
260
|
+
#Upload a media object.
|
339
261
|
api_instance.media_upload(app_id, opts)
|
340
|
-
rescue
|
341
|
-
puts "
|
342
|
-
end
|
343
|
-
```
|
344
|
-
|
345
|
-
#### Using the media_upload_with_http_info variant
|
346
|
-
|
347
|
-
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
348
|
-
|
349
|
-
> <Array(nil, Integer, Hash)> media_upload_with_http_info(app_id, opts)
|
350
|
-
|
351
|
-
```ruby
|
352
|
-
begin
|
353
|
-
# Upload a media object.
|
354
|
-
data, status_code, headers = api_instance.media_upload_with_http_info(app_id, opts)
|
355
|
-
p status_code # => 2xx
|
356
|
-
p headers # => { ... }
|
357
|
-
p data # => nil
|
358
|
-
rescue Notifo::ApiError => e
|
359
|
-
puts "Error when calling MediaApi->media_upload_with_http_info: #{e}"
|
262
|
+
rescue SwaggerClient::ApiError => e
|
263
|
+
puts "Exception when calling MediaApi->media_upload: #{e}"
|
360
264
|
end
|
361
265
|
```
|
362
266
|
|
363
267
|
### Parameters
|
364
268
|
|
365
|
-
|
366
|
-
|
367
|
-
|
368
|
-
|
269
|
+
Name | Type | Description | Notes
|
270
|
+
------------- | ------------- | ------------- | -------------
|
271
|
+
**app_id** | **String**| The app id where the media belongs to. |
|
272
|
+
**file** | **String**| | [optional]
|
369
273
|
|
370
274
|
### Return type
|
371
275
|
|
@@ -377,6 +281,8 @@ No authorization required
|
|
377
281
|
|
378
282
|
### HTTP request headers
|
379
283
|
|
380
|
-
- **Content-Type**: multipart/form-data
|
381
|
-
- **Accept**: application/json
|
284
|
+
- **Content-Type**: multipart/form-data
|
285
|
+
- **Accept**: application/json
|
286
|
+
|
287
|
+
|
382
288
|
|