notifo-io 1.0.1 → 1.0.1.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (185) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +510 -8
  3. data/Rakefile +0 -2
  4. data/docs/AddAllowedTopicDto.md +3 -14
  5. data/docs/AddContributorDto.md +4 -16
  6. data/docs/AppContributorDto.md +5 -18
  7. data/docs/AppDetailsDto.md +18 -44
  8. data/docs/AppDto.md +8 -24
  9. data/docs/AppsApi.md +149 -331
  10. data/docs/Body.md +7 -0
  11. data/docs/ConfigsApi.md +21 -61
  12. data/docs/ConfirmMode.md +2 -11
  13. data/docs/CreateEmailTemplateDto.md +3 -14
  14. data/docs/EmailTemplateDto.md +5 -18
  15. data/docs/EmailTemplatesDto.md +6 -0
  16. data/docs/EmailVerificationStatus.md +2 -11
  17. data/docs/ErrorDto.md +7 -22
  18. data/docs/EventDto.md +14 -36
  19. data/docs/EventProperties.md +6 -0
  20. data/docs/EventsApi.md +36 -73
  21. data/docs/IsoDayOfWeek.md +2 -11
  22. data/docs/ListResponseDtoOfEventDto.md +4 -16
  23. data/docs/ListResponseDtoOfLogEntryDto.md +4 -16
  24. data/docs/ListResponseDtoOfMediaDto.md +4 -16
  25. data/docs/ListResponseDtoOfSubscriptionDto.md +4 -16
  26. data/docs/ListResponseDtoOfTemplateDto.md +4 -16
  27. data/docs/ListResponseDtoOfTopicDto.md +4 -16
  28. data/docs/ListResponseDtoOfUserDto.md +4 -16
  29. data/docs/LocalizedText.md +6 -0
  30. data/docs/LogEntryDto.md +6 -20
  31. data/docs/LogsApi.md +21 -40
  32. data/docs/MediaApi.md +102 -196
  33. data/docs/MediaDto.md +9 -26
  34. data/docs/MediaMetadata.md +6 -0
  35. data/docs/MediaType.md +2 -11
  36. data/docs/NotificationFormattingDto.md +10 -28
  37. data/docs/NotificationSend.md +2 -11
  38. data/docs/NotificationSettingDto.md +4 -16
  39. data/docs/ProfileDto.md +10 -28
  40. data/docs/PublishDto.md +12 -32
  41. data/docs/PublishManyDto.md +3 -14
  42. data/docs/ResizeMode.md +2 -11
  43. data/docs/SchedulingDto.md +6 -20
  44. data/docs/SchedulingType.md +2 -11
  45. data/docs/SubscriptionDto.md +4 -16
  46. data/docs/TemplateDto.md +5 -18
  47. data/docs/TemplatesApi.md +51 -106
  48. data/docs/TopicDto.md +5 -18
  49. data/docs/TopicsApi.md +21 -40
  50. data/docs/UpdateProfileDto.md +8 -24
  51. data/docs/UpsertAppDto.md +12 -32
  52. data/docs/UpsertTemplateDto.md +5 -18
  53. data/docs/UpsertTemplatesDto.md +3 -14
  54. data/docs/UpsertUserDto.md +10 -28
  55. data/docs/UpsertUsersDto.md +3 -14
  56. data/docs/UserApi.md +68 -160
  57. data/docs/UserDto.md +12 -32
  58. data/docs/UsersApi.md +144 -308
  59. data/git_push.sh +7 -10
  60. data/lib/notifo.rb +9 -5
  61. data/lib/notifo/api/apps_api.rb +130 -202
  62. data/lib/notifo/api/configs_api.rb +14 -30
  63. data/lib/notifo/api/events_api.rb +29 -45
  64. data/lib/notifo/api/logs_api.rb +12 -21
  65. data/lib/notifo/api/media_api.rb +60 -97
  66. data/lib/notifo/api/templates_api.rb +39 -62
  67. data/lib/notifo/api/topics_api.rb +12 -21
  68. data/lib/notifo/api/user_api.rb +51 -88
  69. data/lib/notifo/api/users_api.rb +121 -186
  70. data/lib/notifo/api_client.rb +54 -56
  71. data/lib/notifo/api_error.rb +5 -5
  72. data/lib/notifo/configuration.rb +12 -84
  73. data/lib/notifo/models/add_allowed_topic_dto.rb +13 -44
  74. data/lib/notifo/models/add_contributor_dto.rb +14 -64
  75. data/lib/notifo/models/app_contributor_dto.rb +15 -84
  76. data/lib/notifo/models/app_details_dto.rb +28 -103
  77. data/lib/notifo/models/app_dto.rb +18 -87
  78. data/lib/notifo/models/{inline_object.rb → body.rb} +16 -29
  79. data/lib/notifo/models/confirm_mode.rb +7 -16
  80. data/lib/notifo/models/create_email_template_dto.rb +13 -44
  81. data/lib/notifo/models/email_template_dto.rb +15 -66
  82. data/lib/notifo/models/email_templates_dto.rb +201 -0
  83. data/lib/notifo/models/email_verification_status.rb +8 -17
  84. data/lib/notifo/models/error_dto.rb +17 -33
  85. data/lib/notifo/models/event_dto.rb +24 -114
  86. data/lib/notifo/models/event_properties.rb +201 -0
  87. data/lib/notifo/models/iso_day_of_week.rb +12 -21
  88. data/lib/notifo/models/list_response_dto_of_event_dto.rb +14 -26
  89. data/lib/notifo/models/list_response_dto_of_log_entry_dto.rb +14 -26
  90. data/lib/notifo/models/list_response_dto_of_media_dto.rb +14 -26
  91. data/lib/notifo/models/list_response_dto_of_subscription_dto.rb +14 -26
  92. data/lib/notifo/models/list_response_dto_of_template_dto.rb +14 -26
  93. data/lib/notifo/models/list_response_dto_of_topic_dto.rb +14 -26
  94. data/lib/notifo/models/list_response_dto_of_user_dto.rb +14 -26
  95. data/lib/notifo/models/localized_text.rb +201 -0
  96. data/lib/notifo/models/log_entry_dto.rb +16 -85
  97. data/lib/notifo/models/media_dto.rb +20 -110
  98. data/lib/notifo/models/media_metadata.rb +201 -0
  99. data/lib/notifo/models/media_type.rb +8 -17
  100. data/lib/notifo/models/notification_formatting_dto.rb +27 -53
  101. data/lib/notifo/models/notification_send.rb +8 -17
  102. data/lib/notifo/models/notification_setting_dto.rb +23 -36
  103. data/lib/notifo/models/profile_dto.rb +20 -73
  104. data/lib/notifo/models/publish_dto.rb +23 -60
  105. data/lib/notifo/models/publish_many_dto.rb +13 -25
  106. data/lib/notifo/models/resize_mode.rb +11 -20
  107. data/lib/notifo/models/scheduling_dto.rb +16 -29
  108. data/lib/notifo/models/scheduling_type.rb +6 -15
  109. data/lib/notifo/models/subscription_dto.rb +14 -46
  110. data/lib/notifo/models/template_dto.rb +15 -46
  111. data/lib/notifo/models/topic_dto.rb +15 -65
  112. data/lib/notifo/models/update_profile_dto.rb +18 -36
  113. data/lib/notifo/models/upsert_app_dto.rb +22 -44
  114. data/lib/notifo/models/upsert_template_dto.rb +15 -47
  115. data/lib/notifo/models/upsert_templates_dto.rb +13 -25
  116. data/lib/notifo/models/upsert_user_dto.rb +20 -40
  117. data/lib/notifo/models/upsert_users_dto.rb +13 -25
  118. data/lib/notifo/models/user_dto.rb +22 -77
  119. data/lib/notifo/version.rb +4 -5
  120. data/notifo.gemspec +7 -7
  121. data/spec/api/apps_api_spec.rb +14 -15
  122. data/spec/api/configs_api_spec.rb +7 -8
  123. data/spec/api/events_api_spec.rb +8 -9
  124. data/spec/api/logs_api_spec.rb +7 -8
  125. data/spec/api/media_api_spec.rb +32 -11
  126. data/spec/api/templates_api_spec.rb +8 -9
  127. data/spec/api/topics_api_spec.rb +7 -8
  128. data/spec/api/user_api_spec.rb +9 -10
  129. data/spec/api/users_api_spec.rb +10 -11
  130. data/spec/api_client_spec.rb +5 -6
  131. data/spec/base_object_spec.rb +109 -0
  132. data/spec/configuration_spec.rb +7 -8
  133. data/spec/models/add_allowed_topic_dto_spec.rb +15 -9
  134. data/spec/models/add_contributor_dto_spec.rb +15 -9
  135. data/spec/models/app_contributor_dto_spec.rb +15 -9
  136. data/spec/models/app_details_dto_spec.rb +15 -9
  137. data/spec/models/app_dto_spec.rb +15 -9
  138. data/spec/models/body_spec.rb +40 -0
  139. data/spec/models/confirm_mode_spec.rb +15 -9
  140. data/spec/models/create_email_template_dto_spec.rb +15 -9
  141. data/spec/models/email_template_dto_spec.rb +15 -9
  142. data/spec/models/email_templates_dto_spec.rb +34 -0
  143. data/spec/models/email_verification_status_spec.rb +15 -9
  144. data/spec/models/error_dto_spec.rb +15 -9
  145. data/spec/models/event_dto_spec.rb +15 -9
  146. data/spec/models/event_properties_spec.rb +34 -0
  147. data/spec/models/iso_day_of_week_spec.rb +15 -9
  148. data/spec/models/list_response_dto_of_event_dto_spec.rb +15 -9
  149. data/spec/models/list_response_dto_of_log_entry_dto_spec.rb +15 -9
  150. data/spec/models/list_response_dto_of_media_dto_spec.rb +15 -9
  151. data/spec/models/list_response_dto_of_subscription_dto_spec.rb +15 -9
  152. data/spec/models/list_response_dto_of_template_dto_spec.rb +15 -9
  153. data/spec/models/list_response_dto_of_topic_dto_spec.rb +15 -9
  154. data/spec/models/list_response_dto_of_user_dto_spec.rb +15 -9
  155. data/spec/models/localized_text_spec.rb +34 -0
  156. data/spec/models/log_entry_dto_spec.rb +15 -9
  157. data/spec/models/media_dto_spec.rb +21 -9
  158. data/spec/models/media_metadata_spec.rb +34 -0
  159. data/spec/models/media_type_spec.rb +15 -9
  160. data/spec/models/notification_formatting_dto_spec.rb +15 -9
  161. data/spec/models/notification_send_spec.rb +15 -9
  162. data/spec/models/notification_setting_dto_spec.rb +16 -10
  163. data/spec/models/profile_dto_spec.rb +15 -9
  164. data/spec/models/publish_dto_spec.rb +15 -9
  165. data/spec/models/publish_many_dto_spec.rb +15 -9
  166. data/spec/models/resize_mode_spec.rb +15 -9
  167. data/spec/models/scheduling_dto_spec.rb +15 -9
  168. data/spec/models/scheduling_type_spec.rb +15 -9
  169. data/spec/models/subscription_dto_spec.rb +15 -9
  170. data/spec/models/template_dto_spec.rb +15 -9
  171. data/spec/models/topic_dto_spec.rb +15 -9
  172. data/spec/models/update_profile_dto_spec.rb +15 -9
  173. data/spec/models/upsert_app_dto_spec.rb +15 -9
  174. data/spec/models/upsert_template_dto_spec.rb +15 -9
  175. data/spec/models/upsert_templates_dto_spec.rb +15 -9
  176. data/spec/models/upsert_user_dto_spec.rb +15 -9
  177. data/spec/models/upsert_users_dto_spec.rb +15 -9
  178. data/spec/models/user_dto_spec.rb +15 -9
  179. data/spec/spec_helper.rb +4 -5
  180. metadata +44 -9
  181. data/docs/InlineObject.md +0 -18
  182. data/notifo-1.0.0.gem +0 -0
  183. data/notifo-io-1.0.0.2.gem +0 -0
  184. data/notifo-io-1.0.0.gem +0 -0
  185. data/spec/models/inline_object_spec.rb +0 -34
data/docs/IsoDayOfWeek.md CHANGED
@@ -1,15 +1,6 @@
1
1
  # Notifo::IsoDayOfWeek
2
2
 
3
3
  ## Properties
4
-
5
- | Name | Type | Description | Notes |
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
  # Notifo::ListResponseDtoOfEventDto
2
2
 
3
3
  ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **items** | [**Array<EventDto>**](EventDto.md) | The items. | |
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
  # Notifo::ListResponseDtoOfLogEntryDto
2
2
 
3
3
  ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **items** | [**Array<LogEntryDto>**](LogEntryDto.md) | The items. | |
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
  # Notifo::ListResponseDtoOfMediaDto
2
2
 
3
3
  ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **items** | [**Array<MediaDto>**](MediaDto.md) | The items. | |
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
  # Notifo::ListResponseDtoOfSubscriptionDto
2
2
 
3
3
  ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **items** | [**Array<SubscriptionDto>**](SubscriptionDto.md) | The items. | |
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
  # Notifo::ListResponseDtoOfTemplateDto
2
2
 
3
3
  ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **items** | [**Array<TemplateDto>**](TemplateDto.md) | The items. | |
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
  # Notifo::ListResponseDtoOfTopicDto
2
2
 
3
3
  ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **items** | [**Array<TopicDto>**](TopicDto.md) | The items. | |
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
  # Notifo::ListResponseDtoOfUserDto
2
2
 
3
3
  ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **items** | [**Array<UserDto>**](UserDto.md) | The items. | |
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
 
@@ -0,0 +1,6 @@
1
+ # Notifo::LocalizedText
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+
data/docs/LogEntryDto.md CHANGED
@@ -1,24 +1,10 @@
1
1
  # Notifo::LogEntryDto
2
2
 
3
3
  ## Properties
4
-
5
- | Name | Type | Description | Notes |
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. | |
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 *http://localhost*
3
+ All URIs are relative to *https://app.notifo.io*
4
4
 
5
- | Method | HTTP request | Description |
6
- | ------ | ------------ | ----------- |
7
- | [**logs_get_logs**](LogsApi.md#logs_get_logs) | **GET** /api/apps/{appId}/logs | Query log entries. |
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
- ## logs_get_logs
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
- ### Examples
17
-
14
+ ### Example
18
15
  ```ruby
19
- require 'time'
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
- # Query log entries.
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 "Error when calling LogsApi->logs_get_logs: #{e}"
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
- | Name | Type | Description | Notes |
60
- | ---- | ---- | ----------- | ----- |
61
- | **app_id** | **String** | The app where the log entries belongs to. | |
62
- | **query** | **String** | The optional query to search for items. | [optional] |
63
- | **take** | **Integer** | The number of items to return. | [optional] |
64
- | **skip** | **Integer** | The number of items to skip. | [optional] |
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
  # Notifo::MediaApi
2
2
 
3
- All URIs are relative to *http://localhost*
3
+ All URIs are relative to *https://app.notifo.io*
4
4
 
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. |
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
- ### Examples
21
-
18
+ ### Example
22
19
  ```ruby
23
- require 'time'
20
+ # load the gem
24
21
  require 'notifo'
25
22
 
26
23
  api_instance = Notifo::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
-
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
27
 
44
- ```ruby
45
28
  begin
46
- # Delete a media.
47
- data, status_code, headers = api_instance.media_delete_with_http_info(app_id, file_name)
48
- p status_code # => 2xx
49
- p headers # => { ... }
50
- p data # => nil
29
+ #Delete a media.
30
+ api_instance.media_delete(app_id, file_name)
51
31
  rescue Notifo::ApiError => e
52
- puts "Error when calling MediaApi->media_delete_with_http_info: #{e}"
32
+ puts "Exception when calling MediaApi->media_delete: #{e}"
53
33
  end
54
34
  ```
55
35
 
56
36
  ### Parameters
57
37
 
58
- | Name | Type | Description | Notes |
59
- | ---- | ---- | ----------- | ----- |
60
- | **app_id** | **String** | The app id where the media belongs to. | |
61
- | **file_name** | **String** | The file name of the media. | |
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
- > File media_download(app_id, file_name, opts)
58
+ # **media_download**
59
+ > String media_download(app_id, file_name, opts)
80
60
 
81
61
  Download a media object.
82
62
 
83
- ### Examples
84
-
63
+ ### Example
85
64
  ```ruby
86
- require 'time'
65
+ # load the gem
87
66
  require 'notifo'
88
67
 
89
68
  api_instance = Notifo::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: Notifo::ResizeMode::CROP, # ResizeMode | The resize mode.
78
+ mode: Notifo::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 # Boolean | True to resize it and clear the cache.
81
+ force: true # BOOLEAN | True to resize it and clear the cache.
103
82
  }
104
83
 
105
84
  begin
106
- # Download a media object.
85
+ #Download a media object.
107
86
  result = api_instance.media_download(app_id, file_name, opts)
108
87
  p result
109
88
  rescue Notifo::ApiError => e
110
- puts "Error when calling MediaApi->media_download: #{e}"
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}"
89
+ puts "Exception when calling MediaApi->media_download: #{e}"
129
90
  end
130
91
  ```
131
92
 
132
93
  ### Parameters
133
94
 
134
- | Name | Type | Description | Notes |
135
- | ---- | ---- | ----------- | ----- |
136
- | **app_id** | **String** | The app id where the media belongs to. | |
137
- | **file_name** | **String** | The name of the media to download. | |
138
- | **cache** | **Integer** | The cache duration. | [optional] |
139
- | **download** | **Integer** | Set it to 1 to create a download response. | [optional] |
140
- | **width** | **Integer** | The target width when an image. | [optional] |
141
- | **height** | **Integer** | The target height when an image. | [optional] |
142
- | **quality** | **Integer** | The target quality when an image. | [optional] |
143
- | **preset** | **String** | A preset dimension. | [optional] |
144
- | **mode** | [**ResizeMode**](.md) | The resize mode. | [optional] |
145
- | **focus_x** | **Float** | The x position of the focues point. | [optional] |
146
- | **focus_y** | **Float** | The y position of the focues point. | [optional] |
147
- | **force** | **Boolean** | True to resize it and clear the cache. | [optional] |
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
- **File**
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
- > File media_download2(app_id, file_name, opts)
125
+ # **media_download2**
126
+ > String media_download2(app_id, file_name, opts)
166
127
 
167
128
  Download a media object.
168
129
 
169
- ### Examples
170
-
130
+ ### Example
171
131
  ```ruby
172
- require 'time'
132
+ # load the gem
173
133
  require 'notifo'
174
134
 
175
135
  api_instance = Notifo::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: Notifo::ResizeMode::CROP, # ResizeMode | The resize mode.
145
+ mode: Notifo::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 # Boolean | True to resize it and clear the cache.
148
+ force: true # BOOLEAN | True to resize it and clear the cache.
189
149
  }
190
150
 
191
151
  begin
192
- # Download a media object.
152
+ #Download a media object.
193
153
  result = api_instance.media_download2(app_id, file_name, opts)
194
154
  p result
195
155
  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}"
156
+ puts "Exception when calling MediaApi->media_download2: #{e}"
215
157
  end
216
158
  ```
217
159
 
218
160
  ### Parameters
219
161
 
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] |
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
- **File**
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
- > <ListResponseDtoOfMediaDto> media_get_medias(app_id, opts)
192
+ # **media_get_medias**
193
+ > ListResponseDtoOfMediaDto media_get_medias(app_id, opts)
252
194
 
253
195
  Query media items.
254
196
 
255
- ### Examples
256
-
197
+ ### Example
257
198
  ```ruby
258
- require 'time'
199
+ # load the gem
259
200
  require 'notifo'
260
201
 
261
202
  api_instance = Notifo::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
- # Query media items.
211
+ #Query media items.
271
212
  result = api_instance.media_get_medias(app_id, opts)
272
213
  p result
273
214
  rescue Notifo::ApiError => e
274
- puts "Error when calling MediaApi->media_get_medias: #{e}"
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}"
215
+ puts "Exception when calling MediaApi->media_get_medias: #{e}"
293
216
  end
294
217
  ```
295
218
 
296
219
  ### Parameters
297
220
 
298
- | Name | Type | Description | Notes |
299
- | ---- | ---- | ----------- | ----- |
300
- | **app_id** | **String** | The app where the media belongs to. | |
301
- | **query** | **String** | The optional query to search for items. | [optional] |
302
- | **take** | **Integer** | The number of items to return. | [optional] |
303
- | **skip** | **Integer** | The number of items to skip. | [optional] |
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
- ### Examples
326
-
248
+ ### Example
327
249
  ```ruby
328
- require 'time'
250
+ # load the gem
329
251
  require 'notifo'
330
252
 
331
253
  api_instance = Notifo::MediaApi.new
332
254
  app_id = 'app_id_example' # String | The app id where the media belongs to.
333
- opts = {
334
- file: File.new('/path/to/some/file') # File |
255
+ opts = {
256
+ file: 'file_example' # String |
335
257
  }
336
258
 
337
259
  begin
338
- # Upload a media object.
260
+ #Upload a media object.
339
261
  api_instance.media_upload(app_id, opts)
340
262
  rescue Notifo::ApiError => e
341
- puts "Error when calling MediaApi->media_upload: #{e}"
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}"
263
+ puts "Exception when calling MediaApi->media_upload: #{e}"
360
264
  end
361
265
  ```
362
266
 
363
267
  ### Parameters
364
268
 
365
- | Name | Type | Description | Notes |
366
- | ---- | ---- | ----------- | ----- |
367
- | **app_id** | **String** | The app id where the media belongs to. | |
368
- | **file** | **File** | | [optional] |
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