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