notifo-io 1.0.0.pre → 1.0.1.2
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +726 -19
- data/Rakefile +0 -2
- data/docs/AddAllowedTopicDto.md +7 -0
- data/docs/AddContributorDto.md +4 -16
- data/docs/AppContributorDto.md +5 -18
- data/docs/AppDetailsDto.md +10 -44
- data/docs/AppDto.md +8 -24
- data/docs/AppIdMediaBody.md +7 -0
- data/docs/AppsApi.md +301 -297
- data/docs/AuthorizationApi.md +121 -0
- data/docs/Body.md +7 -0
- data/docs/ConfigsApi.md +21 -61
- data/docs/ConfiguredIntegrationDto.md +12 -0
- data/docs/ConfiguredIntegrationsDto.md +8 -0
- data/docs/ConfirmMode.md +2 -11
- data/docs/CreateEmailTemplateDto.md +3 -14
- data/docs/CreateIntegrationDto.md +11 -0
- data/docs/EmailTemplateDto.md +5 -18
- data/docs/EmailTemplatesDto.md +6 -0
- data/docs/EmailVerificationStatus.md +2 -11
- data/docs/ErrorDto.md +7 -22
- data/docs/EventDto.md +15 -36
- data/docs/EventProperties.md +6 -0
- data/docs/EventsApi.md +72 -65
- data/docs/IntegrationCreatedDto.md +8 -0
- data/docs/IntegrationDefinitionDto.md +11 -0
- data/docs/IntegrationProperties.md +6 -0
- data/docs/IntegrationPropertyDto.md +17 -0
- data/docs/IntegrationPropertyType.md +6 -0
- data/docs/IntegrationStatus.md +6 -0
- data/docs/IsoDayOfWeek.md +2 -11
- data/docs/ListResponseDtoOfEventDto.md +4 -16
- data/docs/ListResponseDtoOfLogEntryDto.md +4 -16
- data/docs/ListResponseDtoOfMediaDto.md +4 -16
- data/docs/ListResponseDtoOfMobilePushTokenDto.md +8 -0
- data/docs/ListResponseDtoOfNotificationDto.md +8 -0
- data/docs/ListResponseDtoOfSubscriptionDto.md +4 -16
- data/docs/ListResponseDtoOfTemplateDto.md +4 -16
- data/docs/ListResponseDtoOfTopicDto.md +4 -16
- data/docs/ListResponseDtoOfUserDto.md +4 -16
- data/docs/LocalizedText.md +6 -0
- data/docs/LogEntryDto.md +6 -20
- data/docs/LogsApi.md +21 -40
- data/docs/MediaApi.md +134 -141
- data/docs/MediaDto.md +9 -24
- data/docs/MediaMetadata.md +6 -0
- data/docs/MediaType.md +2 -11
- data/docs/MobileDeviceType.md +6 -0
- data/docs/MobilePushApi.md +135 -0
- data/docs/MobilePushTokenDto.md +8 -0
- data/docs/NotificationDto.md +21 -0
- data/docs/NotificationFormattingDto.md +10 -28
- data/docs/NotificationSend.md +6 -0
- data/docs/NotificationSettingDto.md +4 -16
- data/docs/NotificationsApi.md +141 -0
- data/docs/ProfileDto.md +14 -0
- data/docs/PublishDto.md +18 -0
- data/docs/PublishManyDto.md +7 -0
- data/docs/RegisterMobileTokenDto.md +8 -0
- data/docs/ResizeMode.md +2 -11
- data/docs/SchedulingDto.md +6 -20
- data/docs/SchedulingType.md +2 -11
- data/docs/SubscriptionDto.md +4 -16
- data/docs/TemplateDto.md +5 -18
- data/docs/TemplatesApi.md +51 -106
- data/docs/TopicDto.md +5 -18
- data/docs/TopicsApi.md +19 -230
- data/docs/TrackNotificationDto.md +10 -0
- data/docs/UpdateIntegrationDto.md +10 -0
- data/docs/UpdateProfileDto.md +12 -0
- data/docs/UpsertAppDto.md +12 -32
- data/docs/UpsertTemplateDto.md +5 -18
- data/docs/UpsertTemplatesDto.md +3 -14
- data/docs/UpsertUserDto.md +11 -28
- data/docs/UpsertUsersDto.md +3 -14
- data/docs/UserApi.md +231 -0
- data/docs/UserDto.md +15 -32
- data/docs/UserInfoApi.md +83 -0
- data/docs/UsersApi.md +144 -308
- data/git_push.sh +7 -10
- data/lib/notifo.rb +37 -11
- data/lib/notifo/api/apps_api.rb +373 -201
- data/lib/notifo/api/authorization_api.rb +158 -0
- data/lib/notifo/api/configs_api.rb +14 -30
- data/lib/notifo/api/events_api.rb +85 -45
- data/lib/notifo/api/logs_api.rb +12 -21
- data/lib/notifo/api/media_api.rb +137 -77
- data/lib/notifo/api/mobile_push_api.rb +178 -0
- data/lib/notifo/api/notifications_api.rb +181 -0
- data/lib/notifo/api/templates_api.rb +39 -62
- data/lib/notifo/api/topics_api.rb +12 -210
- data/lib/notifo/api/user_api.rb +294 -0
- data/lib/notifo/api/user_info_api.rb +112 -0
- data/lib/notifo/api/users_api.rb +121 -186
- data/lib/notifo/api_client.rb +53 -55
- data/lib/notifo/api_error.rb +5 -5
- data/lib/notifo/configuration.rb +8 -78
- data/lib/notifo/models/{add_allowed_topic_request.rb → add_allowed_topic_dto.rb} +21 -28
- data/lib/notifo/models/add_contributor_dto.rb +24 -26
- data/lib/notifo/models/app_contributor_dto.rb +30 -27
- data/lib/notifo/models/app_details_dto.rb +59 -119
- data/lib/notifo/models/app_dto.rb +51 -31
- data/lib/notifo/models/{inline_object.rb → app_id_media_body.rb} +16 -28
- data/lib/notifo/models/body.rb +206 -0
- data/lib/notifo/models/configured_integration_dto.rb +271 -0
- data/lib/notifo/models/configured_integrations_dto.rb +231 -0
- data/lib/notifo/models/confirm_mode.rb +7 -16
- data/lib/notifo/models/create_email_template_dto.rb +18 -25
- data/lib/notifo/models/create_integration_dto.rb +257 -0
- data/lib/notifo/models/email_template_dto.rb +25 -27
- data/lib/notifo/models/email_templates_dto.rb +201 -0
- data/lib/notifo/models/email_verification_status.rb +8 -17
- data/lib/notifo/models/error_dto.rb +17 -29
- data/lib/notifo/models/event_dto.rb +92 -46
- data/lib/notifo/models/event_properties.rb +201 -0
- data/lib/notifo/models/{subscribe_dto.rb → integration_created_dto.rb} +39 -42
- data/lib/notifo/models/integration_definition_dto.rb +272 -0
- data/lib/notifo/models/integration_properties.rb +201 -0
- data/lib/notifo/models/integration_property_dto.rb +319 -0
- data/lib/notifo/models/integration_property_type.rb +31 -0
- data/lib/notifo/models/integration_status.rb +29 -0
- data/lib/notifo/models/iso_day_of_week.rb +12 -21
- data/lib/notifo/models/list_response_dto_of_event_dto.rb +24 -26
- data/lib/notifo/models/list_response_dto_of_log_entry_dto.rb +24 -26
- data/lib/notifo/models/list_response_dto_of_media_dto.rb +24 -26
- data/lib/notifo/models/list_response_dto_of_mobile_push_token_dto.rb +229 -0
- data/lib/notifo/models/list_response_dto_of_notification_dto.rb +229 -0
- data/lib/notifo/models/list_response_dto_of_subscription_dto.rb +24 -26
- data/lib/notifo/models/list_response_dto_of_template_dto.rb +24 -26
- data/lib/notifo/models/list_response_dto_of_topic_dto.rb +24 -26
- data/lib/notifo/models/list_response_dto_of_user_dto.rb +24 -26
- data/lib/notifo/models/localized_text.rb +201 -0
- data/lib/notifo/models/log_entry_dto.rb +36 -28
- data/lib/notifo/models/media_dto.rb +64 -33
- data/lib/notifo/models/media_metadata.rb +201 -0
- data/lib/notifo/models/media_type.rb +8 -17
- data/lib/notifo/models/mobile_device_type.rb +29 -0
- data/lib/notifo/models/mobile_push_token_dto.rb +221 -0
- data/lib/notifo/models/notification_dto.rb +386 -0
- data/lib/notifo/models/notification_formatting_dto.rb +30 -46
- data/lib/notifo/models/notification_send.rb +30 -0
- data/lib/notifo/models/notification_setting_dto.rb +25 -34
- data/lib/notifo/models/profile_dto.rb +311 -0
- data/lib/notifo/models/{publish_request_dto.rb → publish_dto.rb} +55 -44
- data/lib/notifo/models/{publish_many_request_dto.rb → publish_many_dto.rb} +21 -28
- data/lib/notifo/models/register_mobile_token_dto.rb +221 -0
- data/lib/notifo/models/resize_mode.rb +11 -20
- data/lib/notifo/models/scheduling_dto.rb +16 -31
- data/lib/notifo/models/scheduling_type.rb +6 -15
- data/lib/notifo/models/subscription_dto.rb +23 -27
- data/lib/notifo/models/template_dto.rb +33 -29
- data/lib/notifo/models/topic_dto.rb +33 -28
- data/lib/notifo/models/track_notification_dto.rb +243 -0
- data/lib/notifo/models/update_integration_dto.rb +242 -0
- data/lib/notifo/models/update_profile_dto.rb +265 -0
- data/lib/notifo/models/upsert_app_dto.rb +22 -34
- data/lib/notifo/models/upsert_template_dto.rb +28 -29
- data/lib/notifo/models/upsert_templates_dto.rb +18 -25
- data/lib/notifo/models/upsert_user_dto.rb +35 -34
- data/lib/notifo/models/upsert_users_dto.rb +18 -25
- data/lib/notifo/models/user_dto.rb +100 -37
- data/lib/notifo/version.rb +4 -5
- data/notifo-io-1.0.1.1.gem +0 -0
- data/notifo.gemspec +10 -10
- data/spec/api/apps_api_spec.rb +14 -15
- data/spec/api/authorization_api_spec.rb +61 -0
- data/spec/api/configs_api_spec.rb +7 -8
- data/spec/api/events_api_spec.rb +8 -9
- data/spec/api/logs_api_spec.rb +7 -8
- data/spec/api/media_api_spec.rb +33 -12
- data/spec/api/mobile_push_api_spec.rb +66 -0
- data/spec/api/notifications_api_spec.rb +68 -0
- data/spec/api/templates_api_spec.rb +8 -9
- data/spec/api/topics_api_spec.rb +7 -44
- data/spec/api/user_api_spec.rb +91 -0
- data/spec/api/user_info_api_spec.rb +52 -0
- data/spec/api/users_api_spec.rb +10 -11
- data/spec/api_client_spec.rb +5 -6
- data/spec/base_object_spec.rb +109 -0
- data/spec/configuration_spec.rb +4 -5
- data/spec/models/add_allowed_topic_dto_spec.rb +40 -0
- data/spec/models/add_contributor_dto_spec.rb +15 -9
- data/spec/models/app_contributor_dto_spec.rb +15 -9
- data/spec/models/app_details_dto_spec.rb +15 -9
- data/spec/models/app_dto_spec.rb +15 -9
- data/spec/models/app_id_media_body_spec.rb +40 -0
- data/spec/models/body_spec.rb +40 -0
- data/spec/models/configured_integration_dto_spec.rb +70 -0
- data/spec/models/configured_integrations_dto_spec.rb +46 -0
- data/spec/models/confirm_mode_spec.rb +15 -9
- data/spec/models/create_email_template_dto_spec.rb +15 -9
- data/spec/models/create_integration_dto_spec.rb +64 -0
- data/spec/models/email_template_dto_spec.rb +15 -9
- data/spec/models/email_templates_dto_spec.rb +34 -0
- data/spec/models/email_verification_status_spec.rb +15 -9
- data/spec/models/error_dto_spec.rb +15 -9
- data/spec/models/event_dto_spec.rb +15 -9
- data/spec/models/event_properties_spec.rb +34 -0
- data/spec/models/integration_created_dto_spec.rb +46 -0
- data/spec/models/integration_definition_dto_spec.rb +64 -0
- data/spec/models/integration_properties_spec.rb +34 -0
- data/spec/models/integration_property_dto_spec.rb +100 -0
- data/spec/models/integration_property_type_spec.rb +34 -0
- data/spec/models/integration_status_spec.rb +34 -0
- data/spec/models/iso_day_of_week_spec.rb +15 -9
- data/spec/models/list_response_dto_of_event_dto_spec.rb +15 -9
- data/spec/models/list_response_dto_of_log_entry_dto_spec.rb +15 -9
- data/spec/models/list_response_dto_of_media_dto_spec.rb +15 -9
- data/spec/models/list_response_dto_of_mobile_push_token_dto_spec.rb +46 -0
- data/spec/models/list_response_dto_of_notification_dto_spec.rb +46 -0
- data/spec/models/list_response_dto_of_subscription_dto_spec.rb +15 -9
- data/spec/models/list_response_dto_of_template_dto_spec.rb +15 -9
- data/spec/models/list_response_dto_of_topic_dto_spec.rb +15 -9
- data/spec/models/list_response_dto_of_user_dto_spec.rb +15 -9
- data/spec/models/localized_text_spec.rb +34 -0
- data/spec/models/log_entry_dto_spec.rb +15 -9
- data/spec/models/media_dto_spec.rb +21 -9
- data/spec/models/media_metadata_spec.rb +34 -0
- data/spec/models/media_type_spec.rb +15 -9
- data/spec/models/mobile_device_type_spec.rb +34 -0
- data/spec/models/mobile_push_token_dto_spec.rb +46 -0
- data/spec/models/notification_dto_spec.rb +124 -0
- data/spec/models/notification_formatting_dto_spec.rb +15 -9
- data/spec/models/notification_send_spec.rb +34 -0
- data/spec/models/notification_setting_dto_spec.rb +16 -10
- data/spec/models/profile_dto_spec.rb +82 -0
- data/spec/models/{publish_request_dto_spec.rb → publish_dto_spec.rb} +18 -12
- data/spec/models/publish_many_dto_spec.rb +40 -0
- data/spec/models/register_mobile_token_dto_spec.rb +46 -0
- data/spec/models/resize_mode_spec.rb +15 -9
- data/spec/models/scheduling_dto_spec.rb +15 -9
- data/spec/models/scheduling_type_spec.rb +15 -9
- data/spec/models/subscription_dto_spec.rb +15 -9
- data/spec/models/template_dto_spec.rb +15 -9
- data/spec/models/topic_dto_spec.rb +15 -9
- data/spec/models/track_notification_dto_spec.rb +58 -0
- data/spec/models/update_integration_dto_spec.rb +58 -0
- data/spec/models/update_profile_dto_spec.rb +70 -0
- data/spec/models/upsert_app_dto_spec.rb +15 -9
- data/spec/models/upsert_template_dto_spec.rb +15 -9
- data/spec/models/upsert_templates_dto_spec.rb +15 -9
- data/spec/models/upsert_user_dto_spec.rb +15 -9
- data/spec/models/upsert_users_dto_spec.rb +15 -9
- data/spec/models/user_dto_spec.rb +15 -9
- data/spec/spec_helper.rb +4 -5
- metadata +167 -30
- data/docs/AddAllowedTopicRequest.md +0 -18
- data/docs/InlineObject.md +0 -18
- data/docs/PublishManyRequestDto.md +0 -18
- data/docs/PublishRequestDto.md +0 -36
- data/docs/SubscribeDto.md +0 -20
- data/notifo-io-1.0.0.gem +0 -0
- data/notifo-io-1.0.0.pre.beta.gem +0 -0
- data/spec/models/add_allowed_topic_request_spec.rb +0 -34
- data/spec/models/inline_object_spec.rb +0 -34
- data/spec/models/publish_many_request_dto_spec.rb +0 -34
- data/spec/models/subscribe_dto_spec.rb +0 -40
@@ -1,20 +1,8 @@
|
|
1
1
|
# Notifo::ListResponseDtoOfTopicDto
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
|
7
|
-
|
8
|
-
| **total** | **Integer** | The total number of items. | [optional] |
|
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
|
# Notifo::ListResponseDtoOfUserDto
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
|
7
|
-
|
8
|
-
| **total** | **Integer** | The total number of items. | [optional] |
|
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
|
# Notifo::LogEntryDto
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
|
5
|
-
|
6
|
-
|
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
| **count** | **Integer** | The number of items the message has been seen. | [optional] |
|
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
|
# Notifo::LogsApi
|
2
2
|
|
3
|
-
All URIs are relative to *https://
|
3
|
+
All URIs are relative to *https://notifo.easierlife.com*
|
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
|
-
|
16
|
+
# load the gem
|
20
17
|
require 'notifo'
|
21
18
|
|
22
19
|
api_instance = Notifo::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
31
|
rescue Notifo::ApiError => e
|
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}"
|
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,63 +1,44 @@
|
|
1
1
|
# Notifo::MediaApi
|
2
2
|
|
3
|
-
All URIs are relative to *https://
|
3
|
+
All URIs are relative to *https://notifo.easierlife.com*
|
4
4
|
|
5
|
-
|
6
|
-
|
7
|
-
|
8
|
-
|
9
|
-
|
10
|
-
|
11
|
-
|
12
|
-
|
13
|
-
## 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.
|
14
12
|
|
13
|
+
# **media_delete**
|
15
14
|
> media_delete(app_id, file_name)
|
16
15
|
|
17
16
|
Delete a media.
|
18
17
|
|
19
|
-
###
|
20
|
-
|
18
|
+
### Example
|
21
19
|
```ruby
|
22
|
-
|
20
|
+
# load the gem
|
23
21
|
require 'notifo'
|
24
22
|
|
25
23
|
api_instance = Notifo::MediaApi.new
|
26
24
|
app_id = 'app_id_example' # String | The app id where the media belongs to.
|
27
25
|
file_name = 'file_name_example' # String | The file name of the media.
|
28
26
|
|
29
|
-
begin
|
30
|
-
# Delete a media.
|
31
|
-
api_instance.media_delete(app_id, file_name)
|
32
|
-
rescue Notifo::ApiError => e
|
33
|
-
puts "Error when calling MediaApi->media_delete: #{e}"
|
34
|
-
end
|
35
|
-
```
|
36
|
-
|
37
|
-
#### Using the media_delete_with_http_info variant
|
38
27
|
|
39
|
-
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
40
|
-
|
41
|
-
> <Array(nil, Integer, Hash)> media_delete_with_http_info(app_id, file_name)
|
42
|
-
|
43
|
-
```ruby
|
44
28
|
begin
|
45
|
-
#
|
46
|
-
|
47
|
-
p status_code # => 2xx
|
48
|
-
p headers # => { ... }
|
49
|
-
p data # => nil
|
29
|
+
#Delete a media.
|
30
|
+
api_instance.media_delete(app_id, file_name)
|
50
31
|
rescue Notifo::ApiError => e
|
51
|
-
puts "
|
32
|
+
puts "Exception when calling MediaApi->media_delete: #{e}"
|
52
33
|
end
|
53
34
|
```
|
54
35
|
|
55
36
|
### Parameters
|
56
37
|
|
57
|
-
|
58
|
-
|
59
|
-
|
60
|
-
|
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. |
|
61
42
|
|
62
43
|
### Return type
|
63
44
|
|
@@ -69,85 +50,133 @@ No authorization required
|
|
69
50
|
|
70
51
|
### HTTP request headers
|
71
52
|
|
72
|
-
- **Content-Type**: Not defined
|
73
|
-
- **Accept**: application/json
|
53
|
+
- **Content-Type**: Not defined
|
54
|
+
- **Accept**: application/json
|
74
55
|
|
75
56
|
|
76
|
-
## media_download
|
77
57
|
|
78
|
-
|
58
|
+
# **media_download**
|
59
|
+
> String media_download(app_id, file_name, opts)
|
79
60
|
|
80
61
|
Download a media object.
|
81
62
|
|
82
|
-
###
|
83
|
-
|
63
|
+
### Example
|
84
64
|
```ruby
|
85
|
-
|
65
|
+
# load the gem
|
86
66
|
require 'notifo'
|
87
67
|
|
88
68
|
api_instance = Notifo::MediaApi.new
|
89
69
|
app_id = 'app_id_example' # String | The app id where the media belongs to.
|
90
70
|
file_name = 'file_name_example' # String | The name of the media to download.
|
91
|
-
opts = {
|
71
|
+
opts = {
|
92
72
|
cache: 789, # Integer | The cache duration.
|
93
73
|
download: 56, # Integer | Set it to 1 to create a download response.
|
94
74
|
width: 56, # Integer | The target width when an image.
|
95
75
|
height: 56, # Integer | The target height when an image.
|
96
76
|
quality: 56, # Integer | The target quality when an image.
|
97
77
|
preset: 'preset_example', # String | A preset dimension.
|
98
|
-
mode:
|
78
|
+
mode: Notifo::ResizeMode.new, # ResizeMode | The resize mode.
|
99
79
|
focus_x: 3.4, # Float | The x position of the focues point.
|
100
80
|
focus_y: 3.4, # Float | The y position of the focues point.
|
101
|
-
force: true #
|
81
|
+
force: true # BOOLEAN | True to resize it and clear the cache.
|
102
82
|
}
|
103
83
|
|
104
84
|
begin
|
105
|
-
#
|
85
|
+
#Download a media object.
|
106
86
|
result = api_instance.media_download(app_id, file_name, opts)
|
107
87
|
p result
|
108
88
|
rescue Notifo::ApiError => e
|
109
|
-
puts "
|
89
|
+
puts "Exception when calling MediaApi->media_download: #{e}"
|
110
90
|
end
|
111
91
|
```
|
112
92
|
|
113
|
-
|
93
|
+
### Parameters
|
94
|
+
|
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]
|
109
|
+
|
110
|
+
### Return type
|
111
|
+
|
112
|
+
**String**
|
113
|
+
|
114
|
+
### Authorization
|
115
|
+
|
116
|
+
No authorization required
|
117
|
+
|
118
|
+
### HTTP request headers
|
119
|
+
|
120
|
+
- **Content-Type**: Not defined
|
121
|
+
- **Accept**: application/octet-stream, application/json
|
114
122
|
|
115
|
-
This returns an Array which contains the response data, status code and headers.
|
116
123
|
|
117
|
-
> <Array(File, Integer, Hash)> media_download_with_http_info(app_id, file_name, opts)
|
118
124
|
|
125
|
+
# **media_download2**
|
126
|
+
> String media_download2(app_id, file_name, opts)
|
127
|
+
|
128
|
+
Download a media object.
|
129
|
+
|
130
|
+
### Example
|
119
131
|
```ruby
|
132
|
+
# load the gem
|
133
|
+
require 'notifo'
|
134
|
+
|
135
|
+
api_instance = Notifo::MediaApi.new
|
136
|
+
app_id = 'app_id_example' # String | The app id where the media belongs to.
|
137
|
+
file_name = 'file_name_example' # String | The name of the media to download.
|
138
|
+
opts = {
|
139
|
+
cache: 789, # Integer | The cache duration.
|
140
|
+
download: 56, # Integer | Set it to 1 to create a download response.
|
141
|
+
width: 56, # Integer | The target width when an image.
|
142
|
+
height: 56, # Integer | The target height when an image.
|
143
|
+
quality: 56, # Integer | The target quality when an image.
|
144
|
+
preset: 'preset_example', # String | A preset dimension.
|
145
|
+
mode: Notifo::ResizeMode.new, # ResizeMode | The resize mode.
|
146
|
+
focus_x: 3.4, # Float | The x position of the focues point.
|
147
|
+
focus_y: 3.4, # Float | The y position of the focues point.
|
148
|
+
force: true # BOOLEAN | True to resize it and clear the cache.
|
149
|
+
}
|
150
|
+
|
120
151
|
begin
|
121
|
-
#
|
122
|
-
|
123
|
-
p
|
124
|
-
p headers # => { ... }
|
125
|
-
p data # => File
|
152
|
+
#Download a media object.
|
153
|
+
result = api_instance.media_download2(app_id, file_name, opts)
|
154
|
+
p result
|
126
155
|
rescue Notifo::ApiError => e
|
127
|
-
puts "
|
156
|
+
puts "Exception when calling MediaApi->media_download2: #{e}"
|
128
157
|
end
|
129
158
|
```
|
130
159
|
|
131
160
|
### Parameters
|
132
161
|
|
133
|
-
|
134
|
-
|
135
|
-
|
136
|
-
|
137
|
-
|
138
|
-
|
139
|
-
|
140
|
-
|
141
|
-
|
142
|
-
|
143
|
-
|
144
|
-
|
145
|
-
|
146
|
-
|
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]
|
147
176
|
|
148
177
|
### Return type
|
149
178
|
|
150
|
-
**
|
179
|
+
**String**
|
151
180
|
|
152
181
|
### Authorization
|
153
182
|
|
@@ -155,65 +184,46 @@ No authorization required
|
|
155
184
|
|
156
185
|
### HTTP request headers
|
157
186
|
|
158
|
-
- **Content-Type**: Not defined
|
159
|
-
- **Accept**: application/octet-stream, application/json
|
187
|
+
- **Content-Type**: Not defined
|
188
|
+
- **Accept**: application/octet-stream, application/json
|
160
189
|
|
161
190
|
|
162
|
-
## media_get_medias
|
163
191
|
|
164
|
-
|
192
|
+
# **media_get_medias**
|
193
|
+
> ListResponseDtoOfMediaDto media_get_medias(app_id, opts)
|
165
194
|
|
166
195
|
Query media items.
|
167
196
|
|
168
|
-
###
|
169
|
-
|
197
|
+
### Example
|
170
198
|
```ruby
|
171
|
-
|
199
|
+
# load the gem
|
172
200
|
require 'notifo'
|
173
201
|
|
174
202
|
api_instance = Notifo::MediaApi.new
|
175
203
|
app_id = 'app_id_example' # String | The app where the media belongs to.
|
176
|
-
opts = {
|
204
|
+
opts = {
|
177
205
|
query: 'query_example', # String | The optional query to search for items.
|
178
206
|
take: 56, # Integer | The number of items to return.
|
179
207
|
skip: 56 # Integer | The number of items to skip.
|
180
208
|
}
|
181
209
|
|
182
210
|
begin
|
183
|
-
#
|
211
|
+
#Query media items.
|
184
212
|
result = api_instance.media_get_medias(app_id, opts)
|
185
213
|
p result
|
186
214
|
rescue Notifo::ApiError => e
|
187
|
-
puts "
|
188
|
-
end
|
189
|
-
```
|
190
|
-
|
191
|
-
#### Using the media_get_medias_with_http_info variant
|
192
|
-
|
193
|
-
This returns an Array which contains the response data, status code and headers.
|
194
|
-
|
195
|
-
> <Array(<ListResponseDtoOfMediaDto>, Integer, Hash)> media_get_medias_with_http_info(app_id, opts)
|
196
|
-
|
197
|
-
```ruby
|
198
|
-
begin
|
199
|
-
# Query media items.
|
200
|
-
data, status_code, headers = api_instance.media_get_medias_with_http_info(app_id, opts)
|
201
|
-
p status_code # => 2xx
|
202
|
-
p headers # => { ... }
|
203
|
-
p data # => <ListResponseDtoOfMediaDto>
|
204
|
-
rescue Notifo::ApiError => e
|
205
|
-
puts "Error when calling MediaApi->media_get_medias_with_http_info: #{e}"
|
215
|
+
puts "Exception when calling MediaApi->media_get_medias: #{e}"
|
206
216
|
end
|
207
217
|
```
|
208
218
|
|
209
219
|
### Parameters
|
210
220
|
|
211
|
-
|
212
|
-
|
213
|
-
|
214
|
-
|
215
|
-
|
216
|
-
|
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]
|
217
227
|
|
218
228
|
### Return type
|
219
229
|
|
@@ -225,60 +235,41 @@ No authorization required
|
|
225
235
|
|
226
236
|
### HTTP request headers
|
227
237
|
|
228
|
-
- **Content-Type**: Not defined
|
229
|
-
- **Accept**: application/json
|
238
|
+
- **Content-Type**: Not defined
|
239
|
+
- **Accept**: application/json
|
230
240
|
|
231
241
|
|
232
|
-
## media_upload
|
233
242
|
|
243
|
+
# **media_upload**
|
234
244
|
> media_upload(app_id, opts)
|
235
245
|
|
236
246
|
Upload a media object.
|
237
247
|
|
238
|
-
###
|
239
|
-
|
248
|
+
### Example
|
240
249
|
```ruby
|
241
|
-
|
250
|
+
# load the gem
|
242
251
|
require 'notifo'
|
243
252
|
|
244
253
|
api_instance = Notifo::MediaApi.new
|
245
254
|
app_id = 'app_id_example' # String | The app id where the media belongs to.
|
246
|
-
opts = {
|
247
|
-
file:
|
255
|
+
opts = {
|
256
|
+
file: 'file_example' # String |
|
248
257
|
}
|
249
258
|
|
250
259
|
begin
|
251
|
-
#
|
260
|
+
#Upload a media object.
|
252
261
|
api_instance.media_upload(app_id, opts)
|
253
262
|
rescue Notifo::ApiError => e
|
254
|
-
puts "
|
255
|
-
end
|
256
|
-
```
|
257
|
-
|
258
|
-
#### Using the media_upload_with_http_info variant
|
259
|
-
|
260
|
-
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
261
|
-
|
262
|
-
> <Array(nil, Integer, Hash)> media_upload_with_http_info(app_id, opts)
|
263
|
-
|
264
|
-
```ruby
|
265
|
-
begin
|
266
|
-
# Upload a media object.
|
267
|
-
data, status_code, headers = api_instance.media_upload_with_http_info(app_id, opts)
|
268
|
-
p status_code # => 2xx
|
269
|
-
p headers # => { ... }
|
270
|
-
p data # => nil
|
271
|
-
rescue Notifo::ApiError => e
|
272
|
-
puts "Error when calling MediaApi->media_upload_with_http_info: #{e}"
|
263
|
+
puts "Exception when calling MediaApi->media_upload: #{e}"
|
273
264
|
end
|
274
265
|
```
|
275
266
|
|
276
267
|
### Parameters
|
277
268
|
|
278
|
-
|
279
|
-
|
280
|
-
|
281
|
-
|
269
|
+
Name | Type | Description | Notes
|
270
|
+
------------- | ------------- | ------------- | -------------
|
271
|
+
**app_id** | **String**| The app id where the media belongs to. |
|
272
|
+
**file** | **String**| | [optional]
|
282
273
|
|
283
274
|
### Return type
|
284
275
|
|
@@ -290,6 +281,8 @@ No authorization required
|
|
290
281
|
|
291
282
|
### HTTP request headers
|
292
283
|
|
293
|
-
- **Content-Type**: multipart/form-data
|
294
|
-
- **Accept**: application/json
|
284
|
+
- **Content-Type**: multipart/form-data
|
285
|
+
- **Accept**: application/json
|
286
|
+
|
287
|
+
|
295
288
|
|