notifo-io 1.1.0 → 1.2.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (283) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +245 -60
  3. data/docs/AddContributorDto.md +1 -1
  4. data/docs/AdminProfileDto.md +7 -0
  5. data/docs/AppsApi.md +1 -1
  6. data/docs/ChannelSendInfoDto.md +4 -0
  7. data/docs/ConfigsApi.md +1 -1
  8. data/docs/DiagnosticsApi.md +85 -0
  9. data/docs/EmailTemplatesApi.md +26 -26
  10. data/docs/EventDto.md +0 -2
  11. data/docs/EventsApi.md +1 -1
  12. data/docs/InfoDto.md +7 -0
  13. data/docs/IntegrationPropertyDto.md +1 -1
  14. data/docs/LogsApi.md +1 -1
  15. data/docs/MediaApi.md +154 -4
  16. data/docs/MessagingTemplatesApi.md +26 -26
  17. data/docs/MobilePushApi.md +1 -1
  18. data/docs/MobilePushTokenDto.md +1 -0
  19. data/docs/MobilePushTokenDto2.md +1 -0
  20. data/docs/NotificationsApi.md +131 -7
  21. data/docs/PingApi.md +85 -2
  22. data/docs/{IntegrationPropertyType.md → PropertyType.md} +1 -1
  23. data/docs/PublishDto.md +2 -0
  24. data/docs/RegisterMobileTokenDto.md +1 -0
  25. data/docs/SendConfiguration.md +6 -0
  26. data/docs/SmsTemplatesApi.md +26 -26
  27. data/docs/SystemUsersApi.md +5 -4
  28. data/docs/TemplatesApi.md +1 -1
  29. data/docs/TopicsApi.md +6 -6
  30. data/docs/TrackNotificationDto.md +1 -0
  31. data/docs/UserApi.md +41 -1
  32. data/docs/UserDto.md +1 -2
  33. data/docs/UserNotificationBaseDto.md +1 -0
  34. data/docs/UserNotificationDetailsDto.md +1 -0
  35. data/docs/UserNotificationDto.md +1 -0
  36. data/docs/UsersApi.md +101 -6
  37. data/docs/WebPushSubscriptionDto.md +7 -0
  38. data/lib/notifo/api/apps_api.rb +1 -1
  39. data/lib/notifo/api/configs_api.rb +1 -1
  40. data/lib/notifo/api/diagnostics_api.rb +116 -0
  41. data/lib/notifo/api/email_templates_api.rb +46 -46
  42. data/lib/notifo/api/events_api.rb +1 -1
  43. data/lib/notifo/api/logs_api.rb +1 -1
  44. data/lib/notifo/api/media_api.rb +197 -2
  45. data/lib/notifo/api/messaging_templates_api.rb +46 -46
  46. data/lib/notifo/api/mobile_push_api.rb +1 -1
  47. data/lib/notifo/api/notifications_api.rb +150 -3
  48. data/lib/notifo/api/ping_api.rb +102 -2
  49. data/lib/notifo/api/sms_templates_api.rb +46 -46
  50. data/lib/notifo/api/system_users_api.rb +6 -6
  51. data/lib/notifo/api/templates_api.rb +1 -1
  52. data/lib/notifo/api/topics_api.rb +10 -10
  53. data/lib/notifo/api/user_api.rb +49 -1
  54. data/lib/notifo/api/users_api.rb +139 -7
  55. data/lib/notifo/api_client.rb +1 -1
  56. data/lib/notifo/api_error.rb +1 -1
  57. data/lib/notifo/configuration.rb +3 -3
  58. data/lib/notifo/models/add_allowed_topic_dto.rb +1 -1
  59. data/lib/notifo/models/add_contributor_dto.rb +2 -6
  60. data/lib/notifo/models/admin_profile_dto.rb +208 -0
  61. data/lib/notifo/models/app_contributor_dto.rb +1 -1
  62. data/lib/notifo/models/app_details_dto.rb +1 -1
  63. data/lib/notifo/models/app_dto.rb +1 -1
  64. data/lib/notifo/models/app_id_media_body.rb +1 -1
  65. data/lib/notifo/models/channel_condition.rb +1 -1
  66. data/lib/notifo/models/channel_send.rb +1 -1
  67. data/lib/notifo/models/channel_send_info_dto.rb +48 -6
  68. data/lib/notifo/models/channel_setting_dto.rb +1 -1
  69. data/lib/notifo/models/channel_template_details_dto_of_email_template_dto.rb +1 -1
  70. data/lib/notifo/models/channel_template_details_dto_of_messaging_template_dto.rb +1 -1
  71. data/lib/notifo/models/channel_template_details_dto_of_sms_template_dto.rb +1 -1
  72. data/lib/notifo/models/channel_template_dto.rb +1 -1
  73. data/lib/notifo/models/configured_integration_dto.rb +1 -1
  74. data/lib/notifo/models/configured_integrations_dto.rb +1 -1
  75. data/lib/notifo/models/confirm_mode.rb +1 -1
  76. data/lib/notifo/models/create_channel_template_dto.rb +1 -1
  77. data/lib/notifo/models/create_channel_template_language_dto.rb +1 -1
  78. data/lib/notifo/models/create_integration_dto.rb +1 -1
  79. data/lib/notifo/models/create_system_user_dto.rb +1 -1
  80. data/lib/notifo/models/email_formatting_error.rb +1 -1
  81. data/lib/notifo/models/email_preview_dto.rb +1 -1
  82. data/lib/notifo/models/email_preview_request_dto.rb +1 -1
  83. data/lib/notifo/models/email_preview_type.rb +1 -1
  84. data/lib/notifo/models/email_template_dto.rb +1 -1
  85. data/lib/notifo/models/email_template_type.rb +1 -1
  86. data/lib/notifo/models/error_dto.rb +1 -1
  87. data/lib/notifo/models/event_dto.rb +2 -24
  88. data/lib/notifo/models/handled_info_dto.rb +1 -1
  89. data/lib/notifo/models/info_dto.rb +212 -0
  90. data/lib/notifo/models/integration_created_dto.rb +1 -1
  91. data/lib/notifo/models/integration_definition_dto.rb +1 -1
  92. data/lib/notifo/models/integration_property_dto.rb +1 -1
  93. data/lib/notifo/models/integration_status.rb +1 -1
  94. data/lib/notifo/models/iso_day_of_week.rb +1 -1
  95. data/lib/notifo/models/list_response_dto_of_channel_template_dto.rb +1 -1
  96. data/lib/notifo/models/list_response_dto_of_event_dto.rb +1 -1
  97. data/lib/notifo/models/list_response_dto_of_log_entry_dto.rb +1 -1
  98. data/lib/notifo/models/list_response_dto_of_media_dto.rb +1 -1
  99. data/lib/notifo/models/list_response_dto_of_mobile_push_token_dto.rb +1 -1
  100. data/lib/notifo/models/list_response_dto_of_subscription_dto.rb +1 -1
  101. data/lib/notifo/models/list_response_dto_of_system_user_dto.rb +1 -1
  102. data/lib/notifo/models/list_response_dto_of_template_dto.rb +1 -1
  103. data/lib/notifo/models/list_response_dto_of_topic_dto.rb +1 -1
  104. data/lib/notifo/models/list_response_dto_of_user_dto.rb +1 -1
  105. data/lib/notifo/models/list_response_dto_of_user_notification_details_dto.rb +1 -1
  106. data/lib/notifo/models/list_response_dto_of_user_notification_dto.rb +1 -1
  107. data/lib/notifo/models/localized_text.rb +1 -1
  108. data/lib/notifo/models/log_entry_dto.rb +1 -1
  109. data/lib/notifo/models/media_dto.rb +1 -1
  110. data/lib/notifo/models/media_metadata.rb +1 -1
  111. data/lib/notifo/models/media_type.rb +1 -1
  112. data/lib/notifo/models/messaging_template_dto.rb +1 -1
  113. data/lib/notifo/models/mobile_device_type.rb +1 -1
  114. data/lib/notifo/models/mobile_push_token_dto.rb +13 -2
  115. data/lib/notifo/models/mobile_push_token_dto2.rb +16 -5
  116. data/lib/notifo/models/notification_formatting_dto.rb +1 -1
  117. data/lib/notifo/models/notification_properties.rb +1 -1
  118. data/lib/notifo/models/process_status.rb +1 -1
  119. data/lib/notifo/models/profile_dto.rb +1 -1
  120. data/lib/notifo/models/{integration_property_type.rb → property_type.rb} +4 -4
  121. data/lib/notifo/models/publish_dto.rb +26 -2
  122. data/lib/notifo/models/publish_many_dto.rb +1 -1
  123. data/lib/notifo/models/register_mobile_token_dto.rb +16 -5
  124. data/lib/notifo/models/resize_mode.rb +1 -1
  125. data/lib/notifo/models/scheduling_dto.rb +1 -1
  126. data/lib/notifo/models/scheduling_type.rb +1 -1
  127. data/lib/notifo/models/send_configuration.rb +201 -0
  128. data/lib/notifo/models/sms_template_dto.rb +1 -1
  129. data/lib/notifo/models/subscribe_dto.rb +1 -1
  130. data/lib/notifo/models/subscribe_many_dto.rb +1 -1
  131. data/lib/notifo/models/subscription_dto.rb +1 -1
  132. data/lib/notifo/models/system_user_dto.rb +1 -1
  133. data/lib/notifo/models/template_dto.rb +1 -1
  134. data/lib/notifo/models/topic_channel.rb +2 -2
  135. data/lib/notifo/models/topic_dto.rb +1 -1
  136. data/lib/notifo/models/topic_query_scope.rb +1 -1
  137. data/lib/notifo/models/track_notification_dto.rb +12 -2
  138. data/lib/notifo/models/update_channel_template_dto_of_email_template_dto.rb +1 -1
  139. data/lib/notifo/models/update_channel_template_dto_of_messaging_template_dto.rb +1 -1
  140. data/lib/notifo/models/update_channel_template_dto_of_sms_template_dto.rb +1 -1
  141. data/lib/notifo/models/update_integration_dto.rb +1 -1
  142. data/lib/notifo/models/update_profile_dto.rb +1 -1
  143. data/lib/notifo/models/update_system_user_dto.rb +1 -1
  144. data/lib/notifo/models/upsert_app_dto.rb +1 -1
  145. data/lib/notifo/models/upsert_template_dto.rb +1 -1
  146. data/lib/notifo/models/upsert_templates_dto.rb +1 -1
  147. data/lib/notifo/models/upsert_topic_dto.rb +1 -1
  148. data/lib/notifo/models/upsert_topics_dto.rb +1 -1
  149. data/lib/notifo/models/upsert_user_dto.rb +1 -1
  150. data/lib/notifo/models/upsert_users_dto.rb +1 -1
  151. data/lib/notifo/models/user_dto.rb +19 -32
  152. data/lib/notifo/models/user_notification_base_dto.rb +13 -2
  153. data/lib/notifo/models/user_notification_channel_dto.rb +1 -1
  154. data/lib/notifo/models/user_notification_details_dto.rb +13 -2
  155. data/lib/notifo/models/user_notification_dto.rb +13 -2
  156. data/lib/notifo/models/user_property_dto.rb +1 -1
  157. data/lib/notifo/models/user_topic_dto.rb +1 -1
  158. data/lib/notifo/models/web_push_subscription_dto.rb +212 -0
  159. data/lib/notifo/version.rb +1 -1
  160. data/lib/notifo.rb +7 -2
  161. data/notifo.gemspec +2 -3
  162. data/spec/api/apps_api_spec.rb +1 -1
  163. data/spec/api/configs_api_spec.rb +1 -1
  164. data/spec/api/diagnostics_api_spec.rb +54 -0
  165. data/spec/api/email_templates_api_spec.rb +6 -6
  166. data/spec/api/events_api_spec.rb +1 -1
  167. data/spec/api/logs_api_spec.rb +1 -1
  168. data/spec/api/media_api_spec.rb +52 -1
  169. data/spec/api/messaging_templates_api_spec.rb +6 -6
  170. data/spec/api/mobile_push_api_spec.rb +1 -1
  171. data/spec/api/notifications_api_spec.rb +38 -2
  172. data/spec/api/ping_api_spec.rb +23 -1
  173. data/spec/api/sms_templates_api_spec.rb +6 -6
  174. data/spec/api/system_users_api_spec.rb +2 -2
  175. data/spec/api/templates_api_spec.rb +1 -1
  176. data/spec/api/topics_api_spec.rb +2 -2
  177. data/spec/api/user_api_spec.rb +11 -1
  178. data/spec/api/users_api_spec.rb +28 -2
  179. data/spec/api_client_spec.rb +1 -1
  180. data/spec/configuration_spec.rb +4 -4
  181. data/spec/models/add_allowed_topic_dto_spec.rb +1 -1
  182. data/spec/models/add_contributor_dto_spec.rb +1 -1
  183. data/spec/models/admin_profile_dto_spec.rb +40 -0
  184. data/spec/models/app_contributor_dto_spec.rb +1 -1
  185. data/spec/models/app_details_dto_spec.rb +1 -1
  186. data/spec/models/app_dto_spec.rb +1 -1
  187. data/spec/models/app_id_media_body_spec.rb +1 -1
  188. data/spec/models/channel_condition_spec.rb +1 -1
  189. data/spec/models/channel_send_info_dto_spec.rb +25 -1
  190. data/spec/models/channel_send_spec.rb +1 -1
  191. data/spec/models/channel_setting_dto_spec.rb +1 -1
  192. data/spec/models/channel_template_details_dto_of_email_template_dto_spec.rb +1 -1
  193. data/spec/models/channel_template_details_dto_of_messaging_template_dto_spec.rb +1 -1
  194. data/spec/models/channel_template_details_dto_of_sms_template_dto_spec.rb +1 -1
  195. data/spec/models/channel_template_dto_spec.rb +1 -1
  196. data/spec/models/configured_integration_dto_spec.rb +1 -1
  197. data/spec/models/configured_integrations_dto_spec.rb +1 -1
  198. data/spec/models/confirm_mode_spec.rb +1 -1
  199. data/spec/models/create_channel_template_dto_spec.rb +1 -1
  200. data/spec/models/create_channel_template_language_dto_spec.rb +1 -1
  201. data/spec/models/create_integration_dto_spec.rb +1 -1
  202. data/spec/models/create_system_user_dto_spec.rb +1 -1
  203. data/spec/models/email_formatting_error_spec.rb +1 -1
  204. data/spec/models/email_preview_dto_spec.rb +1 -1
  205. data/spec/models/email_preview_request_dto_spec.rb +1 -1
  206. data/spec/models/email_preview_type_spec.rb +1 -1
  207. data/spec/models/email_template_dto_spec.rb +1 -1
  208. data/spec/models/email_template_type_spec.rb +1 -1
  209. data/spec/models/error_dto_spec.rb +1 -1
  210. data/spec/models/event_dto_spec.rb +1 -13
  211. data/spec/models/handled_info_dto_spec.rb +1 -1
  212. data/spec/models/info_dto_spec.rb +40 -0
  213. data/spec/models/integration_created_dto_spec.rb +1 -1
  214. data/spec/models/integration_definition_dto_spec.rb +1 -1
  215. data/spec/models/integration_property_dto_spec.rb +1 -1
  216. data/spec/models/integration_status_spec.rb +1 -1
  217. data/spec/models/iso_day_of_week_spec.rb +1 -1
  218. data/spec/models/list_response_dto_of_channel_template_dto_spec.rb +1 -1
  219. data/spec/models/list_response_dto_of_event_dto_spec.rb +1 -1
  220. data/spec/models/list_response_dto_of_log_entry_dto_spec.rb +1 -1
  221. data/spec/models/list_response_dto_of_media_dto_spec.rb +1 -1
  222. data/spec/models/list_response_dto_of_mobile_push_token_dto_spec.rb +1 -1
  223. data/spec/models/list_response_dto_of_subscription_dto_spec.rb +1 -1
  224. data/spec/models/list_response_dto_of_system_user_dto_spec.rb +1 -1
  225. data/spec/models/list_response_dto_of_template_dto_spec.rb +1 -1
  226. data/spec/models/list_response_dto_of_topic_dto_spec.rb +1 -1
  227. data/spec/models/list_response_dto_of_user_dto_spec.rb +1 -1
  228. data/spec/models/list_response_dto_of_user_notification_details_dto_spec.rb +1 -1
  229. data/spec/models/list_response_dto_of_user_notification_dto_spec.rb +1 -1
  230. data/spec/models/localized_text_spec.rb +1 -1
  231. data/spec/models/log_entry_dto_spec.rb +1 -1
  232. data/spec/models/media_dto_spec.rb +1 -1
  233. data/spec/models/media_metadata_spec.rb +1 -1
  234. data/spec/models/media_type_spec.rb +1 -1
  235. data/spec/models/messaging_template_dto_spec.rb +1 -1
  236. data/spec/models/mobile_device_type_spec.rb +1 -1
  237. data/spec/models/mobile_push_token_dto2_spec.rb +7 -1
  238. data/spec/models/mobile_push_token_dto_spec.rb +7 -1
  239. data/spec/models/notification_formatting_dto_spec.rb +1 -1
  240. data/spec/models/notification_properties_spec.rb +1 -1
  241. data/spec/models/process_status_spec.rb +1 -1
  242. data/spec/models/profile_dto_spec.rb +1 -1
  243. data/spec/models/{integration_property_type_spec.rb → property_type_spec.rb} +7 -7
  244. data/spec/models/publish_dto_spec.rb +13 -1
  245. data/spec/models/publish_many_dto_spec.rb +1 -1
  246. data/spec/models/register_mobile_token_dto_spec.rb +7 -1
  247. data/spec/models/resize_mode_spec.rb +1 -1
  248. data/spec/models/scheduling_dto_spec.rb +1 -1
  249. data/spec/models/scheduling_type_spec.rb +1 -1
  250. data/spec/models/send_configuration_spec.rb +34 -0
  251. data/spec/models/sms_template_dto_spec.rb +1 -1
  252. data/spec/models/subscribe_dto_spec.rb +1 -1
  253. data/spec/models/subscribe_many_dto_spec.rb +1 -1
  254. data/spec/models/subscription_dto_spec.rb +1 -1
  255. data/spec/models/system_user_dto_spec.rb +1 -1
  256. data/spec/models/template_dto_spec.rb +1 -1
  257. data/spec/models/topic_channel_spec.rb +1 -1
  258. data/spec/models/topic_dto_spec.rb +1 -1
  259. data/spec/models/topic_query_scope_spec.rb +1 -1
  260. data/spec/models/track_notification_dto_spec.rb +7 -1
  261. data/spec/models/update_channel_template_dto_of_email_template_dto_spec.rb +1 -1
  262. data/spec/models/update_channel_template_dto_of_messaging_template_dto_spec.rb +1 -1
  263. data/spec/models/update_channel_template_dto_of_sms_template_dto_spec.rb +1 -1
  264. data/spec/models/update_integration_dto_spec.rb +1 -1
  265. data/spec/models/update_profile_dto_spec.rb +1 -1
  266. data/spec/models/update_system_user_dto_spec.rb +1 -1
  267. data/spec/models/upsert_app_dto_spec.rb +1 -1
  268. data/spec/models/upsert_template_dto_spec.rb +1 -1
  269. data/spec/models/upsert_templates_dto_spec.rb +1 -1
  270. data/spec/models/upsert_topic_dto_spec.rb +1 -1
  271. data/spec/models/upsert_topics_dto_spec.rb +1 -1
  272. data/spec/models/upsert_user_dto_spec.rb +1 -1
  273. data/spec/models/upsert_users_dto_spec.rb +1 -1
  274. data/spec/models/user_dto_spec.rb +7 -13
  275. data/spec/models/user_notification_base_dto_spec.rb +7 -1
  276. data/spec/models/user_notification_channel_dto_spec.rb +1 -1
  277. data/spec/models/user_notification_details_dto_spec.rb +7 -1
  278. data/spec/models/user_notification_dto_spec.rb +7 -1
  279. data/spec/models/user_property_dto_spec.rb +1 -1
  280. data/spec/models/user_topic_dto_spec.rb +1 -1
  281. data/spec/models/web_push_subscription_dto_spec.rb +40 -0
  282. data/spec/spec_helper.rb +1 -1
  283. metadata +27 -7
@@ -0,0 +1,212 @@
1
+ =begin
2
+ #Notifo API
3
+
4
+ #No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
5
+
6
+ OpenAPI spec version: 1.0.0
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 3.0.36
10
+ =end
11
+
12
+ require 'date'
13
+
14
+ module Notifo
15
+ class WebPushSubscriptionDto
16
+ # The endpoint.
17
+ attr_accessor :endpoint
18
+
19
+ # Attribute mapping from ruby-style variable name to JSON key.
20
+ def self.attribute_map
21
+ {
22
+ :'endpoint' => :'endpoint'
23
+ }
24
+ end
25
+
26
+ # Attribute type mapping.
27
+ def self.openapi_types
28
+ {
29
+ :'endpoint' => :'Object'
30
+ }
31
+ end
32
+
33
+ # List of attributes with nullable: true
34
+ def self.openapi_nullable
35
+ Set.new([
36
+ ])
37
+ end
38
+
39
+ # Initializes the object
40
+ # @param [Hash] attributes Model attributes in the form of hash
41
+ def initialize(attributes = {})
42
+ if (!attributes.is_a?(Hash))
43
+ fail ArgumentError, "The input argument (attributes) must be a hash in `Notifo::WebPushSubscriptionDto` initialize method"
44
+ end
45
+
46
+ # check to see if the attribute exists and convert string to symbol for hash key
47
+ attributes = attributes.each_with_object({}) { |(k, v), h|
48
+ if (!self.class.attribute_map.key?(k.to_sym))
49
+ fail ArgumentError, "`#{k}` is not a valid attribute in `Notifo::WebPushSubscriptionDto`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
50
+ end
51
+ h[k.to_sym] = v
52
+ }
53
+
54
+ if attributes.key?(:'endpoint')
55
+ self.endpoint = attributes[:'endpoint']
56
+ end
57
+ end
58
+
59
+ # Show invalid properties with the reasons. Usually used together with valid?
60
+ # @return Array for valid properties with the reasons
61
+ def list_invalid_properties
62
+ invalid_properties = Array.new
63
+ if @endpoint.nil?
64
+ invalid_properties.push('invalid value for "endpoint", endpoint cannot be nil.')
65
+ end
66
+
67
+ invalid_properties
68
+ end
69
+
70
+ # Check to see if the all the properties in the model are valid
71
+ # @return true if the model is valid
72
+ def valid?
73
+ return false if @endpoint.nil?
74
+ true
75
+ end
76
+
77
+ # Checks equality by comparing each attribute.
78
+ # @param [Object] Object to be compared
79
+ def ==(o)
80
+ return true if self.equal?(o)
81
+ self.class == o.class &&
82
+ endpoint == o.endpoint
83
+ end
84
+
85
+ # @see the `==` method
86
+ # @param [Object] Object to be compared
87
+ def eql?(o)
88
+ self == o
89
+ end
90
+
91
+ # Calculates hash code according to all attributes.
92
+ # @return [Integer] Hash code
93
+ def hash
94
+ [endpoint].hash
95
+ end
96
+
97
+ # Builds the object from hash
98
+ # @param [Hash] attributes Model attributes in the form of hash
99
+ # @return [Object] Returns the model itself
100
+ def self.build_from_hash(attributes)
101
+ new.build_from_hash(attributes)
102
+ end
103
+
104
+ # Builds the object from hash
105
+ # @param [Hash] attributes Model attributes in the form of hash
106
+ # @return [Object] Returns the model itself
107
+ def build_from_hash(attributes)
108
+ return nil unless attributes.is_a?(Hash)
109
+ self.class.openapi_types.each_pair do |key, type|
110
+ if type =~ /\AArray<(.*)>/i
111
+ # check to ensure the input is an array given that the attribute
112
+ # is documented as an array but the input is not
113
+ if attributes[self.class.attribute_map[key]].is_a?(Array)
114
+ self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
115
+ end
116
+ elsif !attributes[self.class.attribute_map[key]].nil?
117
+ self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
118
+ elsif attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
119
+ self.send("#{key}=", nil)
120
+ end
121
+ end
122
+
123
+ self
124
+ end
125
+
126
+ # Deserializes the data based on type
127
+ # @param string type Data type
128
+ # @param string value Value to be deserialized
129
+ # @return [Object] Deserialized data
130
+ def _deserialize(type, value)
131
+ case type.to_sym
132
+ when :DateTime
133
+ DateTime.parse(value)
134
+ when :Date
135
+ Date.parse(value)
136
+ when :String
137
+ value.to_s
138
+ when :Integer
139
+ value.to_i
140
+ when :Float
141
+ value.to_f
142
+ when :Boolean
143
+ if value.to_s =~ /\A(true|t|yes|y|1)\z/i
144
+ true
145
+ else
146
+ false
147
+ end
148
+ when :Object
149
+ # generic object (usually a Hash), return directly
150
+ value
151
+ when /\AArray<(?<inner_type>.+)>\z/
152
+ inner_type = Regexp.last_match[:inner_type]
153
+ value.map { |v| _deserialize(inner_type, v) }
154
+ when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
155
+ k_type = Regexp.last_match[:k_type]
156
+ v_type = Regexp.last_match[:v_type]
157
+ {}.tap do |hash|
158
+ value.each do |k, v|
159
+ hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
160
+ end
161
+ end
162
+ else # model
163
+ Notifo.const_get(type).build_from_hash(value)
164
+ end
165
+ end
166
+
167
+ # Returns the string representation of the object
168
+ # @return [String] String presentation of the object
169
+ def to_s
170
+ to_hash.to_s
171
+ end
172
+
173
+ # to_body is an alias to to_hash (backward compatibility)
174
+ # @return [Hash] Returns the object in the form of hash
175
+ def to_body
176
+ to_hash
177
+ end
178
+
179
+ # Returns the object in the form of hash
180
+ # @return [Hash] Returns the object in the form of hash
181
+ def to_hash
182
+ hash = {}
183
+ self.class.attribute_map.each_pair do |attr, param|
184
+ value = self.send(attr)
185
+ if value.nil?
186
+ is_nullable = self.class.openapi_nullable.include?(attr)
187
+ next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
188
+ end
189
+
190
+ hash[param] = _to_hash(value)
191
+ end
192
+ hash
193
+ end
194
+
195
+ # Outputs non-array value in the form of hash
196
+ # For object, use to_hash. Otherwise, just return the value
197
+ # @param [Object] value Any valid value
198
+ # @return [Hash] Returns the value in the form of hash
199
+ def _to_hash(value)
200
+ if value.is_a?(Array)
201
+ value.compact.map { |v| _to_hash(v) }
202
+ elsif value.is_a?(Hash)
203
+ {}.tap do |hash|
204
+ value.each { |k, v| hash[k] = _to_hash(v) }
205
+ end
206
+ elsif value.respond_to? :to_hash
207
+ value.to_hash
208
+ else
209
+ value
210
+ end
211
+ end end
212
+ end
@@ -6,7 +6,7 @@
6
6
  OpenAPI spec version: 1.0.0
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 3.0.29
9
+ Swagger Codegen version: 3.0.36
10
10
  =end
11
11
 
12
12
  module Notifo
data/lib/notifo.rb CHANGED
@@ -6,7 +6,7 @@
6
6
  OpenAPI spec version: 1.0.0
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 3.0.29
9
+ Swagger Codegen version: 3.0.36
10
10
  =end
11
11
 
12
12
  # Common files
@@ -18,6 +18,7 @@ require 'notifo/configuration'
18
18
  # Models
19
19
  require 'notifo/models/add_allowed_topic_dto'
20
20
  require 'notifo/models/add_contributor_dto'
21
+ require 'notifo/models/admin_profile_dto'
21
22
  require 'notifo/models/app_contributor_dto'
22
23
  require 'notifo/models/app_details_dto'
23
24
  require 'notifo/models/app_dto'
@@ -46,10 +47,10 @@ require 'notifo/models/email_template_type'
46
47
  require 'notifo/models/error_dto'
47
48
  require 'notifo/models/event_dto'
48
49
  require 'notifo/models/handled_info_dto'
50
+ require 'notifo/models/info_dto'
49
51
  require 'notifo/models/integration_created_dto'
50
52
  require 'notifo/models/integration_definition_dto'
51
53
  require 'notifo/models/integration_property_dto'
52
- require 'notifo/models/integration_property_type'
53
54
  require 'notifo/models/integration_status'
54
55
  require 'notifo/models/iso_day_of_week'
55
56
  require 'notifo/models/list_response_dto_of_channel_template_dto'
@@ -77,12 +78,14 @@ require 'notifo/models/notification_formatting_dto'
77
78
  require 'notifo/models/notification_properties'
78
79
  require 'notifo/models/process_status'
79
80
  require 'notifo/models/profile_dto'
81
+ require 'notifo/models/property_type'
80
82
  require 'notifo/models/publish_dto'
81
83
  require 'notifo/models/publish_many_dto'
82
84
  require 'notifo/models/register_mobile_token_dto'
83
85
  require 'notifo/models/resize_mode'
84
86
  require 'notifo/models/scheduling_dto'
85
87
  require 'notifo/models/scheduling_type'
88
+ require 'notifo/models/send_configuration'
86
89
  require 'notifo/models/sms_template_dto'
87
90
  require 'notifo/models/subscribe_dto'
88
91
  require 'notifo/models/subscribe_many_dto'
@@ -113,10 +116,12 @@ require 'notifo/models/user_notification_details_dto'
113
116
  require 'notifo/models/user_notification_dto'
114
117
  require 'notifo/models/user_property_dto'
115
118
  require 'notifo/models/user_topic_dto'
119
+ require 'notifo/models/web_push_subscription_dto'
116
120
 
117
121
  # APIs
118
122
  require 'notifo/api/apps_api'
119
123
  require 'notifo/api/configs_api'
124
+ require 'notifo/api/diagnostics_api'
120
125
  require 'notifo/api/email_templates_api'
121
126
  require 'notifo/api/events_api'
122
127
  require 'notifo/api/logs_api'
data/notifo.gemspec CHANGED
@@ -12,15 +12,14 @@ Swagger Codegen version: 3.0.29
12
12
  =end
13
13
 
14
14
  $:.push File.expand_path("../lib", __FILE__)
15
- #require "notifo-io/version"
16
15
 
17
16
  Gem::Specification.new do |s|
18
17
  s.name = "notifo-io"
19
- s.version = '1.1.0'
18
+ s.version = '1.2.0'
20
19
  s.platform = Gem::Platform::RUBY
21
20
  s.authors = ["Squidex UG"]
22
21
  s.email = [""]
23
- s.homepage = "https://app.notifo.io"
22
+ s.homepage = "https://notifo.io"
24
23
  s.summary = "Notifo API Ruby Gem"
25
24
  s.description = "Notifo is a multi-channel notification service for collaboration tools, e-commerce, news, magazines and everybody who wants to notify their users."
26
25
  s.license = "Unlicense"
@@ -6,7 +6,7 @@
6
6
  OpenAPI spec version: 1.0.0
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 3.0.29
9
+ Swagger Codegen version: 3.0.36
10
10
  =end
11
11
 
12
12
  require 'spec_helper'
@@ -6,7 +6,7 @@
6
6
  OpenAPI spec version: 1.0.0
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 3.0.29
9
+ Swagger Codegen version: 3.0.36
10
10
  =end
11
11
 
12
12
  require 'spec_helper'
@@ -0,0 +1,54 @@
1
+ =begin
2
+ #Notifo API
3
+
4
+ #No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
5
+
6
+ OpenAPI spec version: 1.0.0
7
+
8
+ Generated by: https://github.com/swagger-api/swagger-codegen.git
9
+ Swagger Codegen version: 3.0.36
10
+ =end
11
+
12
+ require 'spec_helper'
13
+ require 'json'
14
+
15
+ # Unit tests for Notifo::DiagnosticsApi
16
+ # Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
17
+ # Please update as you see appropriate
18
+ describe 'DiagnosticsApi' do
19
+ before do
20
+ # run before each test
21
+ @instance = Notifo::DiagnosticsApi.new
22
+ end
23
+
24
+ after do
25
+ # run after each test
26
+ end
27
+
28
+ describe 'test an instance of DiagnosticsApi' do
29
+ it 'should create an instance of DiagnosticsApi' do
30
+ expect(@instance).to be_instance_of(Notifo::DiagnosticsApi)
31
+ end
32
+ end
33
+
34
+ # unit tests for diagnostics_get_dump
35
+ # Creates a dump and writes it into storage..
36
+ # @param [Hash] opts the optional parameters
37
+ # @return [nil]
38
+ describe 'diagnostics_get_dump test' do
39
+ it 'should work' do
40
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
41
+ end
42
+ end
43
+
44
+ # unit tests for diagnostics_get_gc_dump
45
+ # Creates a gc dump and writes it into storage.
46
+ # @param [Hash] opts the optional parameters
47
+ # @return [nil]
48
+ describe 'diagnostics_get_gc_dump test' do
49
+ it 'should work' do
50
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
51
+ end
52
+ end
53
+
54
+ end
@@ -6,7 +6,7 @@
6
6
  OpenAPI spec version: 1.0.0
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 3.0.29
9
+ Swagger Codegen version: 3.0.36
10
10
  =end
11
11
 
12
12
  require 'spec_helper'
@@ -58,7 +58,7 @@ describe 'EmailTemplatesApi' do
58
58
  # unit tests for email_templates_delete_template
59
59
  # Delete a channel template.
60
60
  # @param app_id The id of the app where the templates belong to.
61
- # @param id The template ID.
61
+ # @param code The template ID.
62
62
  # @param [Hash] opts the optional parameters
63
63
  # @return [nil]
64
64
  describe 'email_templates_delete_template test' do
@@ -70,7 +70,7 @@ describe 'EmailTemplatesApi' do
70
70
  # unit tests for email_templates_delete_template_language
71
71
  # Delete a language channel template.
72
72
  # @param app_id The id of the app where the templates belong to.
73
- # @param id The template ID.
73
+ # @param code The template ID.
74
74
  # @param language The language.
75
75
  # @param [Hash] opts the optional parameters
76
76
  # @return [nil]
@@ -122,7 +122,7 @@ describe 'EmailTemplatesApi' do
122
122
  # Create an app template language.
123
123
  # @param body The request object.
124
124
  # @param app_id The id of the app where the templates belong to.
125
- # @param id The template ID.
125
+ # @param code The template code.
126
126
  # @param [Hash] opts the optional parameters
127
127
  # @return [EmailTemplateDto]
128
128
  describe 'email_templates_post_template_language test' do
@@ -135,7 +135,7 @@ describe 'EmailTemplatesApi' do
135
135
  # Update an app template.
136
136
  # @param body The request object.
137
137
  # @param app_id The id of the app where the templates belong to.
138
- # @param id The template ID.
138
+ # @param code The template code.
139
139
  # @param [Hash] opts the optional parameters
140
140
  # @return [nil]
141
141
  describe 'email_templates_put_template test' do
@@ -148,7 +148,7 @@ describe 'EmailTemplatesApi' do
148
148
  # Update a channel template language.
149
149
  # @param body The request object.
150
150
  # @param app_id The id of the app where the templates belong to.
151
- # @param id The template ID.
151
+ # @param code The template code.
152
152
  # @param language The language.
153
153
  # @param [Hash] opts the optional parameters
154
154
  # @return [nil]
@@ -6,7 +6,7 @@
6
6
  OpenAPI spec version: 1.0.0
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 3.0.29
9
+ Swagger Codegen version: 3.0.36
10
10
  =end
11
11
 
12
12
  require 'spec_helper'
@@ -6,7 +6,7 @@
6
6
  OpenAPI spec version: 1.0.0
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 3.0.29
9
+ Swagger Codegen version: 3.0.36
10
10
  =end
11
11
 
12
12
  require 'spec_helper'
@@ -6,7 +6,7 @@
6
6
  OpenAPI spec version: 1.0.0
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 3.0.29
9
+ Swagger Codegen version: 3.0.36
10
10
  =end
11
11
 
12
12
  require 'spec_helper'
@@ -50,6 +50,7 @@ describe 'MediaApi' do
50
50
  # @param [Hash] opts the optional parameters
51
51
  # @option opts [Integer] :cache The cache duration.
52
52
  # @option opts [Integer] :download Set it to 1 to create a download response.
53
+ # @option opts [String] :bg Optional background color.
53
54
  # @option opts [Integer] :width The target width when an image.
54
55
  # @option opts [Integer] :height The target height when an image.
55
56
  # @option opts [Integer] :quality The target quality when an image.
@@ -58,6 +59,7 @@ describe 'MediaApi' do
58
59
  # @option opts [Float] :focus_x The x position of the focues point.
59
60
  # @option opts [Float] :focus_y The y position of the focues point.
60
61
  # @option opts [BOOLEAN] :force True to resize it and clear the cache.
62
+ # @option opts [BOOLEAN] :empty_on_failure True, to return an empty image on failure.
61
63
  # @return [String]
62
64
  describe 'media_download test' do
63
65
  it 'should work' do
@@ -72,6 +74,7 @@ describe 'MediaApi' do
72
74
  # @param [Hash] opts the optional parameters
73
75
  # @option opts [Integer] :cache The cache duration.
74
76
  # @option opts [Integer] :download Set it to 1 to create a download response.
77
+ # @option opts [String] :bg Optional background color.
75
78
  # @option opts [Integer] :width The target width when an image.
76
79
  # @option opts [Integer] :height The target height when an image.
77
80
  # @option opts [Integer] :quality The target quality when an image.
@@ -80,6 +83,7 @@ describe 'MediaApi' do
80
83
  # @option opts [Float] :focus_x The x position of the focues point.
81
84
  # @option opts [Float] :focus_y The y position of the focues point.
82
85
  # @option opts [BOOLEAN] :force True to resize it and clear the cache.
86
+ # @option opts [BOOLEAN] :empty_on_failure True, to return an empty image on failure.
83
87
  # @return [String]
84
88
  describe 'media_download2 test' do
85
89
  it 'should work' do
@@ -87,6 +91,30 @@ describe 'MediaApi' do
87
91
  end
88
92
  end
89
93
 
94
+ # unit tests for media_download3
95
+ # Download a media object.
96
+ # @param app_id The app id where the media belongs to.
97
+ # @param file_name The name of the media to download.
98
+ # @param [Hash] opts the optional parameters
99
+ # @option opts [Integer] :cache The cache duration.
100
+ # @option opts [Integer] :download Set it to 1 to create a download response.
101
+ # @option opts [String] :bg Optional background color.
102
+ # @option opts [Integer] :width The target width when an image.
103
+ # @option opts [Integer] :height The target height when an image.
104
+ # @option opts [Integer] :quality The target quality when an image.
105
+ # @option opts [String] :preset A preset dimension.
106
+ # @option opts [ResizeMode] :mode The resize mode.
107
+ # @option opts [Float] :focus_x The x position of the focues point.
108
+ # @option opts [Float] :focus_y The y position of the focues point.
109
+ # @option opts [BOOLEAN] :force True to resize it and clear the cache.
110
+ # @option opts [BOOLEAN] :empty_on_failure True, to return an empty image on failure.
111
+ # @return [String]
112
+ describe 'media_download3 test' do
113
+ it 'should work' do
114
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
115
+ end
116
+ end
117
+
90
118
  # unit tests for media_get_medias
91
119
  # Query media items.
92
120
  # @param app_id The app where the media belongs to.
@@ -101,6 +129,29 @@ describe 'MediaApi' do
101
129
  end
102
130
  end
103
131
 
132
+ # unit tests for media_proxy_proxy_image
133
+ # Download a media object.
134
+ # @param [Hash] opts the optional parameters
135
+ # @option opts [String] :url The app id where the media belongs to.
136
+ # @option opts [Integer] :cache The cache duration.
137
+ # @option opts [Integer] :download Set it to 1 to create a download response.
138
+ # @option opts [String] :bg Optional background color.
139
+ # @option opts [Integer] :width The target width when an image.
140
+ # @option opts [Integer] :height The target height when an image.
141
+ # @option opts [Integer] :quality The target quality when an image.
142
+ # @option opts [String] :preset A preset dimension.
143
+ # @option opts [ResizeMode] :mode The resize mode.
144
+ # @option opts [Float] :focus_x The x position of the focues point.
145
+ # @option opts [Float] :focus_y The y position of the focues point.
146
+ # @option opts [BOOLEAN] :force True to resize it and clear the cache.
147
+ # @option opts [BOOLEAN] :empty_on_failure True, to return an empty image on failure.
148
+ # @return [String]
149
+ describe 'media_proxy_proxy_image test' do
150
+ it 'should work' do
151
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
152
+ end
153
+ end
154
+
104
155
  # unit tests for media_upload
105
156
  # Upload a media object.
106
157
  # @param app_id The app id where the media belongs to.
@@ -6,7 +6,7 @@
6
6
  OpenAPI spec version: 1.0.0
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 3.0.29
9
+ Swagger Codegen version: 3.0.36
10
10
  =end
11
11
 
12
12
  require 'spec_helper'
@@ -34,7 +34,7 @@ describe 'MessagingTemplatesApi' do
34
34
  # unit tests for messaging_templates_delete_template
35
35
  # Delete a channel template.
36
36
  # @param app_id The id of the app where the templates belong to.
37
- # @param id The template ID.
37
+ # @param code The template ID.
38
38
  # @param [Hash] opts the optional parameters
39
39
  # @return [nil]
40
40
  describe 'messaging_templates_delete_template test' do
@@ -46,7 +46,7 @@ describe 'MessagingTemplatesApi' do
46
46
  # unit tests for messaging_templates_delete_template_language
47
47
  # Delete a language channel template.
48
48
  # @param app_id The id of the app where the templates belong to.
49
- # @param id The template ID.
49
+ # @param code The template ID.
50
50
  # @param language The language.
51
51
  # @param [Hash] opts the optional parameters
52
52
  # @return [nil]
@@ -98,7 +98,7 @@ describe 'MessagingTemplatesApi' do
98
98
  # Create an app template language.
99
99
  # @param body The request object.
100
100
  # @param app_id The id of the app where the templates belong to.
101
- # @param id The template ID.
101
+ # @param code The template code.
102
102
  # @param [Hash] opts the optional parameters
103
103
  # @return [MessagingTemplateDto]
104
104
  describe 'messaging_templates_post_template_language test' do
@@ -111,7 +111,7 @@ describe 'MessagingTemplatesApi' do
111
111
  # Update an app template.
112
112
  # @param body The request object.
113
113
  # @param app_id The id of the app where the templates belong to.
114
- # @param id The template ID.
114
+ # @param code The template code.
115
115
  # @param [Hash] opts the optional parameters
116
116
  # @return [nil]
117
117
  describe 'messaging_templates_put_template test' do
@@ -124,7 +124,7 @@ describe 'MessagingTemplatesApi' do
124
124
  # Update a channel template language.
125
125
  # @param body The request object.
126
126
  # @param app_id The id of the app where the templates belong to.
127
- # @param id The template ID.
127
+ # @param code The template code.
128
128
  # @param language The language.
129
129
  # @param [Hash] opts the optional parameters
130
130
  # @return [nil]
@@ -6,7 +6,7 @@
6
6
  OpenAPI spec version: 1.0.0
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 3.0.29
9
+ Swagger Codegen version: 3.0.36
10
10
  =end
11
11
 
12
12
  require 'spec_helper'
@@ -6,7 +6,7 @@
6
6
  OpenAPI spec version: 1.0.0
7
7
 
8
8
  Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: 3.0.29
9
+ Swagger Codegen version: 3.0.36
10
10
  =end
11
11
 
12
12
  require 'spec_helper'
@@ -42,9 +42,27 @@ describe 'NotificationsApi' do
42
42
  end
43
43
  end
44
44
 
45
+ # unit tests for notifications_get_all_notifications
46
+ # Query notifications.
47
+ # @param app_id The app where the user belongs to.
48
+ # @param [Hash] opts the optional parameters
49
+ # @option opts [Array<String>] :channels The active channels.
50
+ # @option opts [String] :channel The source channel.
51
+ # @option opts [String] :correlation_id The correlation ID, that can be used to query notifications.
52
+ # @option opts [String] :query The optional query to search for items.
53
+ # @option opts [Integer] :take The number of items to return.
54
+ # @option opts [Integer] :skip The number of items to skip.
55
+ # @return [ListResponseDtoOfUserNotificationDetailsDto]
56
+ describe 'notifications_get_all_notifications test' do
57
+ it 'should work' do
58
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
59
+ end
60
+ end
61
+
45
62
  # unit tests for notifications_get_my_archive
46
- # Query archhived user notifications of the current user.
63
+ # Query archived user notifications of the current user.
47
64
  # @param [Hash] opts the optional parameters
65
+ # @option opts [String] :channel The tracking channel.
48
66
  # @return [ListResponseDtoOfUserNotificationDto]
49
67
  describe 'notifications_get_my_archive test' do
50
68
  it 'should work' do
@@ -52,10 +70,26 @@ describe 'NotificationsApi' do
52
70
  end
53
71
  end
54
72
 
73
+ # unit tests for notifications_get_my_device_notifications
74
+ # Query user notifications of the current user for a specific device.
75
+ # @param [Hash] opts the optional parameters
76
+ # @option opts [String] :device_identifier The device identifier (aka mobile push token).
77
+ # @option opts [DateTime] :after The max age of the notifications.
78
+ # @option opts [BOOLEAN] :include_unseen True to also include unseen notifications.
79
+ # @option opts [Integer] :take The number of notifications to query.
80
+ # @return [ListResponseDtoOfUserNotificationDto]
81
+ describe 'notifications_get_my_device_notifications test' do
82
+ it 'should work' do
83
+ # assertion here. ref: https://www.relishapp.com/rspec/rspec-expectations/docs/built-in-matchers
84
+ end
85
+ end
86
+
55
87
  # unit tests for notifications_get_my_notifications
56
88
  # Query user notifications of the current user.
57
89
  # @param [Hash] opts the optional parameters
58
90
  # @option opts [Array<String>] :channels The active channels.
91
+ # @option opts [String] :channel The source channel.
92
+ # @option opts [String] :correlation_id The correlation ID, that can be used to query notifications.
59
93
  # @option opts [String] :query The optional query to search for items.
60
94
  # @option opts [Integer] :take The number of items to return.
61
95
  # @option opts [Integer] :skip The number of items to skip.
@@ -72,6 +106,8 @@ describe 'NotificationsApi' do
72
106
  # @param id The user id.
73
107
  # @param [Hash] opts the optional parameters
74
108
  # @option opts [Array<String>] :channels The active channels.
109
+ # @option opts [String] :channel The source channel.
110
+ # @option opts [String] :correlation_id The correlation ID, that can be used to query notifications.
75
111
  # @option opts [String] :query The optional query to search for items.
76
112
  # @option opts [Integer] :take The number of items to return.
77
113
  # @option opts [Integer] :skip The number of items to skip.