notifo-io-easierlife 1.0.0 → 1.0.1.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (193) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +599 -97
  3. data/Rakefile +0 -2
  4. data/docs/AddAllowedTopicDto.md +4 -15
  5. data/docs/AddContributorDto.md +5 -17
  6. data/docs/AppContributorDto.md +6 -19
  7. data/docs/AppDetailsDto.md +19 -45
  8. data/docs/AppDto.md +9 -25
  9. data/docs/AppsApi.md +181 -363
  10. data/docs/Body.md +7 -0
  11. data/docs/ConfigsApi.md +28 -68
  12. data/docs/ConfirmMode.md +3 -12
  13. data/docs/CreateEmailTemplateDto.md +4 -15
  14. data/docs/EmailTemplateDto.md +6 -19
  15. data/docs/EmailTemplatesDto.md +6 -0
  16. data/docs/EmailVerificationStatus.md +3 -12
  17. data/docs/ErrorDto.md +8 -23
  18. data/docs/EventDto.md +15 -37
  19. data/docs/EventProperties.md +6 -0
  20. data/docs/EventsApi.md +43 -80
  21. data/docs/IsoDayOfWeek.md +3 -12
  22. data/docs/ListResponseDtoOfEventDto.md +5 -17
  23. data/docs/ListResponseDtoOfLogEntryDto.md +5 -17
  24. data/docs/ListResponseDtoOfMediaDto.md +5 -17
  25. data/docs/ListResponseDtoOfSubscriptionDto.md +5 -17
  26. data/docs/ListResponseDtoOfTemplateDto.md +5 -17
  27. data/docs/ListResponseDtoOfTopicDto.md +5 -17
  28. data/docs/ListResponseDtoOfUserDto.md +5 -17
  29. data/docs/LocalizedText.md +6 -0
  30. data/docs/LogEntryDto.md +7 -21
  31. data/docs/LogsApi.md +25 -44
  32. data/docs/MediaApi.md +118 -212
  33. data/docs/MediaDto.md +10 -27
  34. data/docs/MediaMetadata.md +6 -0
  35. data/docs/MediaType.md +3 -12
  36. data/docs/NotificationFormattingDto.md +11 -29
  37. data/docs/NotificationSend.md +3 -12
  38. data/docs/NotificationSettingDto.md +5 -17
  39. data/docs/ProfileDto.md +11 -29
  40. data/docs/PublishDto.md +13 -33
  41. data/docs/PublishManyDto.md +4 -15
  42. data/docs/ResizeMode.md +3 -12
  43. data/docs/SchedulingDto.md +7 -21
  44. data/docs/SchedulingType.md +3 -12
  45. data/docs/SubscriptionDto.md +5 -17
  46. data/docs/TemplateDto.md +6 -19
  47. data/docs/TemplatesApi.md +61 -116
  48. data/docs/TopicDto.md +6 -19
  49. data/docs/TopicsApi.md +25 -44
  50. data/docs/UpdateProfileDto.md +9 -25
  51. data/docs/UpsertAppDto.md +13 -33
  52. data/docs/UpsertTemplateDto.md +6 -19
  53. data/docs/UpsertTemplatesDto.md +4 -15
  54. data/docs/UpsertUserDto.md +11 -29
  55. data/docs/UpsertUsersDto.md +4 -15
  56. data/docs/UserApi.md +84 -176
  57. data/docs/UserDto.md +13 -33
  58. data/docs/UsersApi.md +173 -337
  59. data/git_push.sh +7 -10
  60. data/lib/swagger_client.rb +93 -0
  61. data/lib/{notifo → swagger_client}/api/apps_api.rb +131 -203
  62. data/lib/{notifo → swagger_client}/api/configs_api.rb +15 -31
  63. data/lib/{notifo → swagger_client}/api/events_api.rb +30 -46
  64. data/lib/{notifo → swagger_client}/api/logs_api.rb +13 -22
  65. data/lib/{notifo → swagger_client}/api/media_api.rb +61 -98
  66. data/lib/{notifo → swagger_client}/api/templates_api.rb +40 -63
  67. data/lib/{notifo → swagger_client}/api/topics_api.rb +13 -22
  68. data/lib/{notifo → swagger_client}/api/user_api.rb +52 -89
  69. data/lib/{notifo → swagger_client}/api/users_api.rb +122 -187
  70. data/lib/{notifo → swagger_client}/api_client.rb +55 -57
  71. data/lib/{notifo → swagger_client}/api_error.rb +6 -6
  72. data/lib/{notifo → swagger_client}/configuration.rb +12 -84
  73. data/lib/{notifo → swagger_client}/models/add_allowed_topic_dto.rb +16 -47
  74. data/lib/swagger_client/models/add_contributor_dto.rb +227 -0
  75. data/lib/swagger_client/models/app_contributor_dto.rb +242 -0
  76. data/lib/{notifo → swagger_client}/models/app_details_dto.rb +31 -106
  77. data/lib/{notifo → swagger_client}/models/app_dto.rb +21 -90
  78. data/lib/swagger_client/models/body.rb +206 -0
  79. data/lib/swagger_client/models/confirm_mode.rb +29 -0
  80. data/lib/{notifo → swagger_client}/models/create_email_template_dto.rb +16 -47
  81. data/lib/swagger_client/models/email_template_dto.rb +237 -0
  82. data/lib/swagger_client/models/email_templates_dto.rb +201 -0
  83. data/lib/swagger_client/models/email_verification_status.rb +30 -0
  84. data/lib/{notifo → swagger_client}/models/error_dto.rb +20 -36
  85. data/lib/{notifo → swagger_client}/models/event_dto.rb +27 -117
  86. data/lib/swagger_client/models/event_properties.rb +201 -0
  87. data/lib/swagger_client/models/iso_day_of_week.rb +34 -0
  88. data/lib/{notifo/models/list_response_dto_of_subscription_dto.rb → swagger_client/models/list_response_dto_of_event_dto.rb} +18 -30
  89. data/lib/{notifo → swagger_client}/models/list_response_dto_of_log_entry_dto.rb +17 -29
  90. data/lib/{notifo → swagger_client}/models/list_response_dto_of_media_dto.rb +17 -29
  91. data/lib/{notifo/models/list_response_dto_of_event_dto.rb → swagger_client/models/list_response_dto_of_subscription_dto.rb} +18 -30
  92. data/lib/{notifo → swagger_client}/models/list_response_dto_of_template_dto.rb +17 -29
  93. data/lib/{notifo → swagger_client}/models/list_response_dto_of_topic_dto.rb +17 -29
  94. data/lib/{notifo → swagger_client}/models/list_response_dto_of_user_dto.rb +17 -29
  95. data/lib/swagger_client/models/localized_text.rb +201 -0
  96. data/lib/{notifo → swagger_client}/models/log_entry_dto.rb +19 -88
  97. data/lib/{notifo → swagger_client}/models/media_dto.rb +23 -113
  98. data/lib/swagger_client/models/media_metadata.rb +201 -0
  99. data/lib/swagger_client/models/media_type.rb +30 -0
  100. data/lib/{notifo → swagger_client}/models/notification_formatting_dto.rb +30 -56
  101. data/lib/swagger_client/models/notification_send.rb +30 -0
  102. data/lib/{notifo → swagger_client}/models/notification_setting_dto.rb +26 -39
  103. data/lib/{notifo → swagger_client}/models/profile_dto.rb +23 -76
  104. data/lib/{notifo → swagger_client}/models/publish_dto.rb +26 -63
  105. data/lib/{notifo → swagger_client}/models/publish_many_dto.rb +16 -28
  106. data/lib/swagger_client/models/resize_mode.rb +33 -0
  107. data/lib/{notifo → swagger_client}/models/scheduling_dto.rb +19 -32
  108. data/lib/swagger_client/models/scheduling_type.rb +28 -0
  109. data/lib/{notifo → swagger_client}/models/subscription_dto.rb +17 -49
  110. data/lib/{notifo → swagger_client}/models/template_dto.rb +18 -49
  111. data/lib/{notifo → swagger_client}/models/topic_dto.rb +18 -68
  112. data/lib/{notifo → swagger_client}/models/update_profile_dto.rb +21 -39
  113. data/lib/{notifo → swagger_client}/models/upsert_app_dto.rb +25 -47
  114. data/lib/{notifo → swagger_client}/models/upsert_template_dto.rb +18 -50
  115. data/lib/{notifo → swagger_client}/models/upsert_templates_dto.rb +16 -28
  116. data/lib/{notifo → swagger_client}/models/upsert_user_dto.rb +23 -43
  117. data/lib/{notifo → swagger_client}/models/upsert_users_dto.rb +16 -28
  118. data/lib/{notifo → swagger_client}/models/user_dto.rb +25 -80
  119. data/lib/swagger_client/version.rb +14 -0
  120. data/spec/api/apps_api_spec.rb +14 -15
  121. data/spec/api/configs_api_spec.rb +8 -9
  122. data/spec/api/events_api_spec.rb +9 -10
  123. data/spec/api/logs_api_spec.rb +8 -9
  124. data/spec/api/media_api_spec.rb +13 -14
  125. data/spec/api/templates_api_spec.rb +9 -10
  126. data/spec/api/topics_api_spec.rb +8 -9
  127. data/spec/api/user_api_spec.rb +10 -11
  128. data/spec/api/users_api_spec.rb +11 -12
  129. data/spec/api_client_spec.rb +34 -35
  130. data/spec/base_object_spec.rb +109 -0
  131. data/spec/configuration_spec.rb +7 -8
  132. data/spec/models/add_allowed_topic_dto_spec.rb +16 -10
  133. data/spec/models/add_contributor_dto_spec.rb +16 -10
  134. data/spec/models/app_contributor_dto_spec.rb +16 -10
  135. data/spec/models/app_details_dto_spec.rb +16 -10
  136. data/spec/models/app_dto_spec.rb +16 -10
  137. data/spec/models/body_spec.rb +40 -0
  138. data/spec/models/confirm_mode_spec.rb +16 -10
  139. data/spec/models/create_email_template_dto_spec.rb +16 -10
  140. data/spec/models/email_template_dto_spec.rb +16 -10
  141. data/spec/models/email_templates_dto_spec.rb +34 -0
  142. data/spec/models/email_verification_status_spec.rb +16 -10
  143. data/spec/models/error_dto_spec.rb +16 -10
  144. data/spec/models/event_dto_spec.rb +16 -10
  145. data/spec/models/event_properties_spec.rb +34 -0
  146. data/spec/models/iso_day_of_week_spec.rb +16 -10
  147. data/spec/models/list_response_dto_of_event_dto_spec.rb +16 -10
  148. data/spec/models/list_response_dto_of_log_entry_dto_spec.rb +16 -10
  149. data/spec/models/list_response_dto_of_media_dto_spec.rb +16 -10
  150. data/spec/models/list_response_dto_of_subscription_dto_spec.rb +16 -10
  151. data/spec/models/list_response_dto_of_template_dto_spec.rb +16 -10
  152. data/spec/models/list_response_dto_of_topic_dto_spec.rb +16 -10
  153. data/spec/models/list_response_dto_of_user_dto_spec.rb +16 -10
  154. data/spec/models/localized_text_spec.rb +34 -0
  155. data/spec/models/log_entry_dto_spec.rb +16 -10
  156. data/spec/models/media_dto_spec.rb +16 -10
  157. data/spec/models/media_metadata_spec.rb +34 -0
  158. data/spec/models/media_type_spec.rb +16 -10
  159. data/spec/models/notification_formatting_dto_spec.rb +16 -10
  160. data/spec/models/notification_send_spec.rb +16 -10
  161. data/spec/models/notification_setting_dto_spec.rb +17 -11
  162. data/spec/models/profile_dto_spec.rb +16 -10
  163. data/spec/models/publish_dto_spec.rb +16 -10
  164. data/spec/models/publish_many_dto_spec.rb +16 -10
  165. data/spec/models/resize_mode_spec.rb +16 -10
  166. data/spec/models/scheduling_dto_spec.rb +16 -10
  167. data/spec/models/scheduling_type_spec.rb +16 -10
  168. data/spec/models/subscription_dto_spec.rb +16 -10
  169. data/spec/models/template_dto_spec.rb +16 -10
  170. data/spec/models/topic_dto_spec.rb +16 -10
  171. data/spec/models/update_profile_dto_spec.rb +16 -10
  172. data/spec/models/upsert_app_dto_spec.rb +16 -10
  173. data/spec/models/upsert_template_dto_spec.rb +16 -10
  174. data/spec/models/upsert_templates_dto_spec.rb +16 -10
  175. data/spec/models/upsert_user_dto_spec.rb +16 -10
  176. data/spec/models/upsert_users_dto_spec.rb +16 -10
  177. data/spec/models/user_dto_spec.rb +16 -10
  178. data/spec/spec_helper.rb +5 -6
  179. data/{notifo.gemspec → swagger_client.gemspec} +9 -9
  180. metadata +101 -60
  181. data/lib/notifo.rb +0 -89
  182. data/lib/notifo/models/add_contributor_dto.rb +0 -277
  183. data/lib/notifo/models/app_contributor_dto.rb +0 -311
  184. data/lib/notifo/models/confirm_mode.rb +0 -38
  185. data/lib/notifo/models/email_template_dto.rb +0 -288
  186. data/lib/notifo/models/email_verification_status.rb +0 -39
  187. data/lib/notifo/models/iso_day_of_week.rb +0 -43
  188. data/lib/notifo/models/media_type.rb +0 -39
  189. data/lib/notifo/models/notification_send.rb +0 -39
  190. data/lib/notifo/models/resize_mode.rb +0 -42
  191. data/lib/notifo/models/scheduling_type.rb +0 -37
  192. data/lib/notifo/version.rb +0 -15
  193. data/notifo-io-1.0.0.gem +0 -0
data/docs/UserDto.md CHANGED
@@ -1,36 +1,16 @@
1
- # Notifo::UserDto
1
+ # SwaggerClient::UserDto
2
2
 
3
3
  ## Properties
4
-
5
- | Name | Type | Description | Notes |
6
- | ---- | ---- | ----------- | ----- |
7
- | **id** | **String** | The id of the user. | |
8
- | **api_key** | **String** | The unique api key for the user. | |
9
- | **full_name** | **String** | The full name of the user. | [optional] |
10
- | **email_address** | **String** | The email of the user. | [optional] |
11
- | **phone_number** | **String** | The phone number. | [optional] |
12
- | **preferred_language** | **String** | The preferred language of the user. | [optional] |
13
- | **preferred_timezone** | **String** | The timezone of the user. | [optional] |
14
- | **requires_whitelisted_topics** | **Boolean** | True when only whitelisted topic are allowed. | |
15
- | **settings** | [**Hash<String, NotificationSettingDto>**](NotificationSettingDto.md) | Notification settings per channel. | |
16
- | **counters** | **Hash<String, Integer>** | The statistics counters. | |
17
-
18
- ## Example
19
-
20
- ```ruby
21
- require 'notifo'
22
-
23
- instance = Notifo::UserDto.new(
24
- id: null,
25
- api_key: null,
26
- full_name: null,
27
- email_address: null,
28
- phone_number: null,
29
- preferred_language: null,
30
- preferred_timezone: null,
31
- requires_whitelisted_topics: null,
32
- settings: null,
33
- counters: null
34
- )
35
- ```
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **id** | **String** | The id of the user. |
7
+ **api_key** | **String** | The unique api key for the user. |
8
+ **full_name** | **String** | The full name of the user. | [optional]
9
+ **email_address** | **String** | The email of the user. | [optional]
10
+ **phone_number** | **String** | The phone number. | [optional]
11
+ **preferred_language** | **String** | The preferred language of the user. | [optional]
12
+ **preferred_timezone** | **String** | The timezone of the user. | [optional]
13
+ **requires_whitelisted_topics** | **BOOLEAN** | True when only whitelisted topic are allowed. |
14
+ **settings** | [**Hash<String, NotificationSettingDto>**](NotificationSettingDto.md) | Notification settings per channel. |
15
+ **counters** | **Hash<String, Integer>** | The statistics counters. |
36
16
 
data/docs/UsersApi.md CHANGED
@@ -1,70 +1,50 @@
1
- # Notifo::UsersApi
2
-
3
- All URIs are relative to *https://notifo.easierlife.com*
4
-
5
- | Method | HTTP request | Description |
6
- | ------ | ------------ | ----------- |
7
- | [**users_delete_allowed_topic**](UsersApi.md#users_delete_allowed_topic) | **DELETE** /api/apps/{appId}/users/{id}/allowed-topics/{prefix} | Remove an allowed topic. |
8
- | [**users_delete_subscription**](UsersApi.md#users_delete_subscription) | **DELETE** /api/apps/{appId}/users/{id}/subscriptions/{prefix} | Remove a user subscriptions. |
9
- | [**users_delete_user**](UsersApi.md#users_delete_user) | **DELETE** /api/apps/{appId}/users/{id} | Delete a user. |
10
- | [**users_get_subscriptions**](UsersApi.md#users_get_subscriptions) | **GET** /api/apps/{appId}/users/{id}/subscriptions | Query user subscriptions. |
11
- | [**users_get_user**](UsersApi.md#users_get_user) | **GET** /api/apps/{appId}/users/{id} | Get a user. |
12
- | [**users_get_users**](UsersApi.md#users_get_users) | **GET** /api/apps/{appId}/users | Query users. |
13
- | [**users_post_allowed_topic**](UsersApi.md#users_post_allowed_topic) | **POST** /api/apps/{appId}/users/{id}/allowed-topics | Add an allowed topic. |
14
- | [**users_post_subscription**](UsersApi.md#users_post_subscription) | **POST** /api/apps/{appId}/users/{id}/subscriptions | Upsert a user subscriptions. |
15
- | [**users_post_users**](UsersApi.md#users_post_users) | **POST** /api/apps/{appId}/users | Upsert users. |
16
-
17
-
18
- ## users_delete_allowed_topic
19
-
1
+ # SwaggerClient::UsersApi
2
+
3
+ All URIs are relative to *https://app.notifo.io*
4
+
5
+ Method | HTTP request | Description
6
+ ------------- | ------------- | -------------
7
+ [**users_delete_allowed_topic**](UsersApi.md#users_delete_allowed_topic) | **DELETE** /api/apps/{appId}/users/{id}/allowed-topics/{prefix} | Remove an allowed topic.
8
+ [**users_delete_subscription**](UsersApi.md#users_delete_subscription) | **DELETE** /api/apps/{appId}/users/{id}/subscriptions/{prefix} | Remove a user subscriptions.
9
+ [**users_delete_user**](UsersApi.md#users_delete_user) | **DELETE** /api/apps/{appId}/users/{id} | Delete a user.
10
+ [**users_get_subscriptions**](UsersApi.md#users_get_subscriptions) | **GET** /api/apps/{appId}/users/{id}/subscriptions | Query user subscriptions.
11
+ [**users_get_user**](UsersApi.md#users_get_user) | **GET** /api/apps/{appId}/users/{id} | Get a user.
12
+ [**users_get_users**](UsersApi.md#users_get_users) | **GET** /api/apps/{appId}/users | Query users.
13
+ [**users_post_allowed_topic**](UsersApi.md#users_post_allowed_topic) | **POST** /api/apps/{appId}/users/{id}/allowed-topics | Add an allowed topic.
14
+ [**users_post_subscription**](UsersApi.md#users_post_subscription) | **POST** /api/apps/{appId}/users/{id}/subscriptions | Upsert a user subscriptions.
15
+ [**users_post_users**](UsersApi.md#users_post_users) | **POST** /api/apps/{appId}/users | Upsert users.
16
+
17
+ # **users_delete_allowed_topic**
20
18
  > users_delete_allowed_topic(app_id, id, prefix)
21
19
 
22
20
  Remove an allowed topic.
23
21
 
24
- ### Examples
25
-
22
+ ### Example
26
23
  ```ruby
27
- require 'time'
28
- require 'notifo'
24
+ # load the gem
25
+ require 'swagger_client'
29
26
 
30
- api_instance = Notifo::UsersApi.new
27
+ api_instance = SwaggerClient::UsersApi.new
31
28
  app_id = 'app_id_example' # String | The app where the users belong to.
32
29
  id = 'id_example' # String | The user id.
33
30
  prefix = 'prefix_example' # String | The topic prefix.
34
31
 
35
- begin
36
- # Remove an allowed topic.
37
- api_instance.users_delete_allowed_topic(app_id, id, prefix)
38
- rescue Notifo::ApiError => e
39
- puts "Error when calling UsersApi->users_delete_allowed_topic: #{e}"
40
- end
41
- ```
42
-
43
- #### Using the users_delete_allowed_topic_with_http_info variant
44
-
45
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
46
32
 
47
- > <Array(nil, Integer, Hash)> users_delete_allowed_topic_with_http_info(app_id, id, prefix)
48
-
49
- ```ruby
50
33
  begin
51
- # Remove an allowed topic.
52
- data, status_code, headers = api_instance.users_delete_allowed_topic_with_http_info(app_id, id, prefix)
53
- p status_code # => 2xx
54
- p headers # => { ... }
55
- p data # => nil
56
- rescue Notifo::ApiError => e
57
- puts "Error when calling UsersApi->users_delete_allowed_topic_with_http_info: #{e}"
34
+ #Remove an allowed topic.
35
+ api_instance.users_delete_allowed_topic(app_id, id, prefix)
36
+ rescue SwaggerClient::ApiError => e
37
+ puts "Exception when calling UsersApi->users_delete_allowed_topic: #{e}"
58
38
  end
59
39
  ```
60
40
 
61
41
  ### Parameters
62
42
 
63
- | Name | Type | Description | Notes |
64
- | ---- | ---- | ----------- | ----- |
65
- | **app_id** | **String** | The app where the users belong to. | |
66
- | **id** | **String** | The user id. | |
67
- | **prefix** | **String** | The topic prefix. | |
43
+ Name | Type | Description | Notes
44
+ ------------- | ------------- | ------------- | -------------
45
+ **app_id** | **String**| The app where the users belong to. |
46
+ **id** | **String**| The user id. |
47
+ **prefix** | **String**| The topic prefix. |
68
48
 
69
49
  ### Return type
70
50
 
@@ -76,60 +56,42 @@ No authorization required
76
56
 
77
57
  ### HTTP request headers
78
58
 
79
- - **Content-Type**: Not defined
80
- - **Accept**: application/json
59
+ - **Content-Type**: Not defined
60
+ - **Accept**: application/json
81
61
 
82
62
 
83
- ## users_delete_subscription
84
63
 
64
+ # **users_delete_subscription**
85
65
  > users_delete_subscription(app_id, id, prefix)
86
66
 
87
67
  Remove a user subscriptions.
88
68
 
89
- ### Examples
90
-
69
+ ### Example
91
70
  ```ruby
92
- require 'time'
93
- require 'notifo'
71
+ # load the gem
72
+ require 'swagger_client'
94
73
 
95
- api_instance = Notifo::UsersApi.new
74
+ api_instance = SwaggerClient::UsersApi.new
96
75
  app_id = 'app_id_example' # String | The app where the user belongs to.
97
76
  id = 'id_example' # String | The user id.
98
77
  prefix = 'prefix_example' # String | The topic prefix.
99
78
 
100
- begin
101
- # Remove a user subscriptions.
102
- api_instance.users_delete_subscription(app_id, id, prefix)
103
- rescue Notifo::ApiError => e
104
- puts "Error when calling UsersApi->users_delete_subscription: #{e}"
105
- end
106
- ```
107
-
108
- #### Using the users_delete_subscription_with_http_info variant
109
-
110
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
111
-
112
- > <Array(nil, Integer, Hash)> users_delete_subscription_with_http_info(app_id, id, prefix)
113
79
 
114
- ```ruby
115
80
  begin
116
- # Remove a user subscriptions.
117
- data, status_code, headers = api_instance.users_delete_subscription_with_http_info(app_id, id, prefix)
118
- p status_code # => 2xx
119
- p headers # => { ... }
120
- p data # => nil
121
- rescue Notifo::ApiError => e
122
- puts "Error when calling UsersApi->users_delete_subscription_with_http_info: #{e}"
81
+ #Remove a user subscriptions.
82
+ api_instance.users_delete_subscription(app_id, id, prefix)
83
+ rescue SwaggerClient::ApiError => e
84
+ puts "Exception when calling UsersApi->users_delete_subscription: #{e}"
123
85
  end
124
86
  ```
125
87
 
126
88
  ### Parameters
127
89
 
128
- | Name | Type | Description | Notes |
129
- | ---- | ---- | ----------- | ----- |
130
- | **app_id** | **String** | The app where the user belongs to. | |
131
- | **id** | **String** | The user id. | |
132
- | **prefix** | **String** | The topic prefix. | |
90
+ Name | Type | Description | Notes
91
+ ------------- | ------------- | ------------- | -------------
92
+ **app_id** | **String**| The app where the user belongs to. |
93
+ **id** | **String**| The user id. |
94
+ **prefix** | **String**| The topic prefix. |
133
95
 
134
96
  ### Return type
135
97
 
@@ -141,59 +103,41 @@ No authorization required
141
103
 
142
104
  ### HTTP request headers
143
105
 
144
- - **Content-Type**: Not defined
145
- - **Accept**: application/json
106
+ - **Content-Type**: Not defined
107
+ - **Accept**: application/json
146
108
 
147
109
 
148
- ## users_delete_user
149
110
 
150
- > <ListResponseDtoOfUserDto> users_delete_user(app_id, id)
111
+ # **users_delete_user**
112
+ > ListResponseDtoOfUserDto users_delete_user(app_id, id)
151
113
 
152
114
  Delete a user.
153
115
 
154
- ### Examples
155
-
116
+ ### Example
156
117
  ```ruby
157
- require 'time'
158
- require 'notifo'
118
+ # load the gem
119
+ require 'swagger_client'
159
120
 
160
- api_instance = Notifo::UsersApi.new
121
+ api_instance = SwaggerClient::UsersApi.new
161
122
  app_id = 'app_id_example' # String | The app where the users belongs to.
162
123
  id = 'id_example' # String | The user id to delete.
163
124
 
125
+
164
126
  begin
165
- # Delete a user.
127
+ #Delete a user.
166
128
  result = api_instance.users_delete_user(app_id, id)
167
129
  p result
168
- rescue Notifo::ApiError => e
169
- puts "Error when calling UsersApi->users_delete_user: #{e}"
170
- end
171
- ```
172
-
173
- #### Using the users_delete_user_with_http_info variant
174
-
175
- This returns an Array which contains the response data, status code and headers.
176
-
177
- > <Array(<ListResponseDtoOfUserDto>, Integer, Hash)> users_delete_user_with_http_info(app_id, id)
178
-
179
- ```ruby
180
- begin
181
- # Delete a user.
182
- data, status_code, headers = api_instance.users_delete_user_with_http_info(app_id, id)
183
- p status_code # => 2xx
184
- p headers # => { ... }
185
- p data # => <ListResponseDtoOfUserDto>
186
- rescue Notifo::ApiError => e
187
- puts "Error when calling UsersApi->users_delete_user_with_http_info: #{e}"
130
+ rescue SwaggerClient::ApiError => e
131
+ puts "Exception when calling UsersApi->users_delete_user: #{e}"
188
132
  end
189
133
  ```
190
134
 
191
135
  ### Parameters
192
136
 
193
- | Name | Type | Description | Notes |
194
- | ---- | ---- | ----------- | ----- |
195
- | **app_id** | **String** | The app where the users belongs to. | |
196
- | **id** | **String** | The user id to delete. | |
137
+ Name | Type | Description | Notes
138
+ ------------- | ------------- | ------------- | -------------
139
+ **app_id** | **String**| The app where the users belongs to. |
140
+ **id** | **String**| The user id to delete. |
197
141
 
198
142
  ### Return type
199
143
 
@@ -205,67 +149,48 @@ No authorization required
205
149
 
206
150
  ### HTTP request headers
207
151
 
208
- - **Content-Type**: Not defined
209
- - **Accept**: application/json
152
+ - **Content-Type**: Not defined
153
+ - **Accept**: application/json
210
154
 
211
155
 
212
- ## users_get_subscriptions
213
156
 
214
- > <ListResponseDtoOfSubscriptionDto> users_get_subscriptions(app_id, id, opts)
157
+ # **users_get_subscriptions**
158
+ > ListResponseDtoOfSubscriptionDto users_get_subscriptions(app_id, id, opts)
215
159
 
216
160
  Query user subscriptions.
217
161
 
218
- ### Examples
219
-
162
+ ### Example
220
163
  ```ruby
221
- require 'time'
222
- require 'notifo'
164
+ # load the gem
165
+ require 'swagger_client'
223
166
 
224
- api_instance = Notifo::UsersApi.new
167
+ api_instance = SwaggerClient::UsersApi.new
225
168
  app_id = 'app_id_example' # String | The app where the user belongs to.
226
169
  id = 'id_example' # String | The user id.
227
- opts = {
170
+ opts = {
228
171
  query: 'query_example', # String | The optional query to search for items.
229
172
  take: 56, # Integer | The number of items to return.
230
173
  skip: 56 # Integer | The number of items to skip.
231
174
  }
232
175
 
233
176
  begin
234
- # Query user subscriptions.
177
+ #Query user subscriptions.
235
178
  result = api_instance.users_get_subscriptions(app_id, id, opts)
236
179
  p result
237
- rescue Notifo::ApiError => e
238
- puts "Error when calling UsersApi->users_get_subscriptions: #{e}"
239
- end
240
- ```
241
-
242
- #### Using the users_get_subscriptions_with_http_info variant
243
-
244
- This returns an Array which contains the response data, status code and headers.
245
-
246
- > <Array(<ListResponseDtoOfSubscriptionDto>, Integer, Hash)> users_get_subscriptions_with_http_info(app_id, id, opts)
247
-
248
- ```ruby
249
- begin
250
- # Query user subscriptions.
251
- data, status_code, headers = api_instance.users_get_subscriptions_with_http_info(app_id, id, opts)
252
- p status_code # => 2xx
253
- p headers # => { ... }
254
- p data # => <ListResponseDtoOfSubscriptionDto>
255
- rescue Notifo::ApiError => e
256
- puts "Error when calling UsersApi->users_get_subscriptions_with_http_info: #{e}"
180
+ rescue SwaggerClient::ApiError => e
181
+ puts "Exception when calling UsersApi->users_get_subscriptions: #{e}"
257
182
  end
258
183
  ```
259
184
 
260
185
  ### Parameters
261
186
 
262
- | Name | Type | Description | Notes |
263
- | ---- | ---- | ----------- | ----- |
264
- | **app_id** | **String** | The app where the user belongs to. | |
265
- | **id** | **String** | The user id. | |
266
- | **query** | **String** | The optional query to search for items. | [optional] |
267
- | **take** | **Integer** | The number of items to return. | [optional] |
268
- | **skip** | **Integer** | The number of items to skip. | [optional] |
187
+ Name | Type | Description | Notes
188
+ ------------- | ------------- | ------------- | -------------
189
+ **app_id** | **String**| The app where the user belongs to. |
190
+ **id** | **String**| The user id. |
191
+ **query** | **String**| The optional query to search for items. | [optional]
192
+ **take** | **Integer**| The number of items to return. | [optional]
193
+ **skip** | **Integer**| The number of items to skip. | [optional]
269
194
 
270
195
  ### Return type
271
196
 
@@ -277,59 +202,41 @@ No authorization required
277
202
 
278
203
  ### HTTP request headers
279
204
 
280
- - **Content-Type**: Not defined
281
- - **Accept**: application/json
205
+ - **Content-Type**: Not defined
206
+ - **Accept**: application/json
282
207
 
283
208
 
284
- ## users_get_user
285
209
 
286
- > <ListResponseDtoOfUserDto> users_get_user(app_id, id)
210
+ # **users_get_user**
211
+ > ListResponseDtoOfUserDto users_get_user(app_id, id)
287
212
 
288
213
  Get a user.
289
214
 
290
- ### Examples
291
-
215
+ ### Example
292
216
  ```ruby
293
- require 'time'
294
- require 'notifo'
217
+ # load the gem
218
+ require 'swagger_client'
295
219
 
296
- api_instance = Notifo::UsersApi.new
220
+ api_instance = SwaggerClient::UsersApi.new
297
221
  app_id = 'app_id_example' # String | The app where the user belongs to.
298
222
  id = 'id_example' # String | The user id.
299
223
 
224
+
300
225
  begin
301
- # Get a user.
226
+ #Get a user.
302
227
  result = api_instance.users_get_user(app_id, id)
303
228
  p result
304
- rescue Notifo::ApiError => e
305
- puts "Error when calling UsersApi->users_get_user: #{e}"
306
- end
307
- ```
308
-
309
- #### Using the users_get_user_with_http_info variant
310
-
311
- This returns an Array which contains the response data, status code and headers.
312
-
313
- > <Array(<ListResponseDtoOfUserDto>, Integer, Hash)> users_get_user_with_http_info(app_id, id)
314
-
315
- ```ruby
316
- begin
317
- # Get a user.
318
- data, status_code, headers = api_instance.users_get_user_with_http_info(app_id, id)
319
- p status_code # => 2xx
320
- p headers # => { ... }
321
- p data # => <ListResponseDtoOfUserDto>
322
- rescue Notifo::ApiError => e
323
- puts "Error when calling UsersApi->users_get_user_with_http_info: #{e}"
229
+ rescue SwaggerClient::ApiError => e
230
+ puts "Exception when calling UsersApi->users_get_user: #{e}"
324
231
  end
325
232
  ```
326
233
 
327
234
  ### Parameters
328
235
 
329
- | Name | Type | Description | Notes |
330
- | ---- | ---- | ----------- | ----- |
331
- | **app_id** | **String** | The app where the user belongs to. | |
332
- | **id** | **String** | The user id. | |
236
+ Name | Type | Description | Notes
237
+ ------------- | ------------- | ------------- | -------------
238
+ **app_id** | **String**| The app where the user belongs to. |
239
+ **id** | **String**| The user id. |
333
240
 
334
241
  ### Return type
335
242
 
@@ -341,65 +248,46 @@ No authorization required
341
248
 
342
249
  ### HTTP request headers
343
250
 
344
- - **Content-Type**: Not defined
345
- - **Accept**: application/json
251
+ - **Content-Type**: Not defined
252
+ - **Accept**: application/json
346
253
 
347
254
 
348
- ## users_get_users
349
255
 
350
- > <ListResponseDtoOfUserDto> users_get_users(app_id, opts)
256
+ # **users_get_users**
257
+ > ListResponseDtoOfUserDto users_get_users(app_id, opts)
351
258
 
352
259
  Query users.
353
260
 
354
- ### Examples
355
-
261
+ ### Example
356
262
  ```ruby
357
- require 'time'
358
- require 'notifo'
263
+ # load the gem
264
+ require 'swagger_client'
359
265
 
360
- api_instance = Notifo::UsersApi.new
266
+ api_instance = SwaggerClient::UsersApi.new
361
267
  app_id = 'app_id_example' # String | The app where the users belongs to.
362
- opts = {
268
+ opts = {
363
269
  query: 'query_example', # String | The optional query to search for items.
364
270
  take: 56, # Integer | The number of items to return.
365
271
  skip: 56 # Integer | The number of items to skip.
366
272
  }
367
273
 
368
274
  begin
369
- # Query users.
275
+ #Query users.
370
276
  result = api_instance.users_get_users(app_id, opts)
371
277
  p result
372
- rescue Notifo::ApiError => e
373
- puts "Error when calling UsersApi->users_get_users: #{e}"
374
- end
375
- ```
376
-
377
- #### Using the users_get_users_with_http_info variant
378
-
379
- This returns an Array which contains the response data, status code and headers.
380
-
381
- > <Array(<ListResponseDtoOfUserDto>, Integer, Hash)> users_get_users_with_http_info(app_id, opts)
382
-
383
- ```ruby
384
- begin
385
- # Query users.
386
- data, status_code, headers = api_instance.users_get_users_with_http_info(app_id, opts)
387
- p status_code # => 2xx
388
- p headers # => { ... }
389
- p data # => <ListResponseDtoOfUserDto>
390
- rescue Notifo::ApiError => e
391
- puts "Error when calling UsersApi->users_get_users_with_http_info: #{e}"
278
+ rescue SwaggerClient::ApiError => e
279
+ puts "Exception when calling UsersApi->users_get_users: #{e}"
392
280
  end
393
281
  ```
394
282
 
395
283
  ### Parameters
396
284
 
397
- | Name | Type | Description | Notes |
398
- | ---- | ---- | ----------- | ----- |
399
- | **app_id** | **String** | The app where the users belongs to. | |
400
- | **query** | **String** | The optional query to search for items. | [optional] |
401
- | **take** | **Integer** | The number of items to return. | [optional] |
402
- | **skip** | **Integer** | The number of items to skip. | [optional] |
285
+ Name | Type | Description | Notes
286
+ ------------- | ------------- | ------------- | -------------
287
+ **app_id** | **String**| The app where the users belongs to. |
288
+ **query** | **String**| The optional query to search for items. | [optional]
289
+ **take** | **Integer**| The number of items to return. | [optional]
290
+ **skip** | **Integer**| The number of items to skip. | [optional]
403
291
 
404
292
  ### Return type
405
293
 
@@ -411,60 +299,42 @@ No authorization required
411
299
 
412
300
  ### HTTP request headers
413
301
 
414
- - **Content-Type**: Not defined
415
- - **Accept**: application/json
302
+ - **Content-Type**: Not defined
303
+ - **Accept**: application/json
416
304
 
417
305
 
418
- ## users_post_allowed_topic
419
306
 
420
- > users_post_allowed_topic(app_id, id, add_allowed_topic_dto)
307
+ # **users_post_allowed_topic**
308
+ > users_post_allowed_topic(bodyapp_idid)
421
309
 
422
310
  Add an allowed topic.
423
311
 
424
- ### Examples
425
-
312
+ ### Example
426
313
  ```ruby
427
- require 'time'
428
- require 'notifo'
314
+ # load the gem
315
+ require 'swagger_client'
429
316
 
430
- api_instance = Notifo::UsersApi.new
317
+ api_instance = SwaggerClient::UsersApi.new
318
+ body = SwaggerClient::AddAllowedTopicDto.new # AddAllowedTopicDto | The upsert request.
431
319
  app_id = 'app_id_example' # String | The app where the users belong to.
432
320
  id = 'id_example' # String | The user id.
433
- add_allowed_topic_dto = Notifo::AddAllowedTopicDto.new({prefix: 'prefix_example'}) # AddAllowedTopicDto | The upsert request.
434
-
435
- begin
436
- # Add an allowed topic.
437
- api_instance.users_post_allowed_topic(app_id, id, add_allowed_topic_dto)
438
- rescue Notifo::ApiError => e
439
- puts "Error when calling UsersApi->users_post_allowed_topic: #{e}"
440
- end
441
- ```
442
-
443
- #### Using the users_post_allowed_topic_with_http_info variant
444
321
 
445
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
446
322
 
447
- > <Array(nil, Integer, Hash)> users_post_allowed_topic_with_http_info(app_id, id, add_allowed_topic_dto)
448
-
449
- ```ruby
450
323
  begin
451
- # Add an allowed topic.
452
- data, status_code, headers = api_instance.users_post_allowed_topic_with_http_info(app_id, id, add_allowed_topic_dto)
453
- p status_code # => 2xx
454
- p headers # => { ... }
455
- p data # => nil
456
- rescue Notifo::ApiError => e
457
- puts "Error when calling UsersApi->users_post_allowed_topic_with_http_info: #{e}"
324
+ #Add an allowed topic.
325
+ api_instance.users_post_allowed_topic(bodyapp_idid)
326
+ rescue SwaggerClient::ApiError => e
327
+ puts "Exception when calling UsersApi->users_post_allowed_topic: #{e}"
458
328
  end
459
329
  ```
460
330
 
461
331
  ### Parameters
462
332
 
463
- | Name | Type | Description | Notes |
464
- | ---- | ---- | ----------- | ----- |
465
- | **app_id** | **String** | The app where the users belong to. | |
466
- | **id** | **String** | The user id. | |
467
- | **add_allowed_topic_dto** | [**AddAllowedTopicDto**](AddAllowedTopicDto.md) | The upsert request. | |
333
+ Name | Type | Description | Notes
334
+ ------------- | ------------- | ------------- | -------------
335
+ **body** | [**AddAllowedTopicDto**](AddAllowedTopicDto.md)| The upsert request. |
336
+ **app_id** | **String**| The app where the users belong to. |
337
+ **id** | **String**| The user id. |
468
338
 
469
339
  ### Return type
470
340
 
@@ -476,60 +346,42 @@ No authorization required
476
346
 
477
347
  ### HTTP request headers
478
348
 
479
- - **Content-Type**: application/json
480
- - **Accept**: application/json
349
+ - **Content-Type**: application/json
350
+ - **Accept**: application/json
481
351
 
482
352
 
483
- ## users_post_subscription
484
353
 
485
- > users_post_subscription(app_id, id, subscription_dto)
354
+ # **users_post_subscription**
355
+ > users_post_subscription(bodyapp_idid)
486
356
 
487
357
  Upsert a user subscriptions.
488
358
 
489
- ### Examples
490
-
359
+ ### Example
491
360
  ```ruby
492
- require 'time'
493
- require 'notifo'
361
+ # load the gem
362
+ require 'swagger_client'
494
363
 
495
- api_instance = Notifo::UsersApi.new
364
+ api_instance = SwaggerClient::UsersApi.new
365
+ body = SwaggerClient::SubscriptionDto.new # SubscriptionDto | The subscription object.
496
366
  app_id = 'app_id_example' # String | The app where the user belongs to.
497
367
  id = 'id_example' # String | The user id.
498
- subscription_dto = Notifo::SubscriptionDto.new({topic_prefix: 'topic_prefix_example'}) # SubscriptionDto | The subscription object.
499
368
 
500
- begin
501
- # Upsert a user subscriptions.
502
- api_instance.users_post_subscription(app_id, id, subscription_dto)
503
- rescue Notifo::ApiError => e
504
- puts "Error when calling UsersApi->users_post_subscription: #{e}"
505
- end
506
- ```
507
369
 
508
- #### Using the users_post_subscription_with_http_info variant
509
-
510
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
511
-
512
- > <Array(nil, Integer, Hash)> users_post_subscription_with_http_info(app_id, id, subscription_dto)
513
-
514
- ```ruby
515
370
  begin
516
- # Upsert a user subscriptions.
517
- data, status_code, headers = api_instance.users_post_subscription_with_http_info(app_id, id, subscription_dto)
518
- p status_code # => 2xx
519
- p headers # => { ... }
520
- p data # => nil
521
- rescue Notifo::ApiError => e
522
- puts "Error when calling UsersApi->users_post_subscription_with_http_info: #{e}"
371
+ #Upsert a user subscriptions.
372
+ api_instance.users_post_subscription(bodyapp_idid)
373
+ rescue SwaggerClient::ApiError => e
374
+ puts "Exception when calling UsersApi->users_post_subscription: #{e}"
523
375
  end
524
376
  ```
525
377
 
526
378
  ### Parameters
527
379
 
528
- | Name | Type | Description | Notes |
529
- | ---- | ---- | ----------- | ----- |
530
- | **app_id** | **String** | The app where the user belongs to. | |
531
- | **id** | **String** | The user id. | |
532
- | **subscription_dto** | [**SubscriptionDto**](SubscriptionDto.md) | The subscription object. | |
380
+ Name | Type | Description | Notes
381
+ ------------- | ------------- | ------------- | -------------
382
+ **body** | [**SubscriptionDto**](SubscriptionDto.md)| The subscription object. |
383
+ **app_id** | **String**| The app where the user belongs to. |
384
+ **id** | **String**| The user id. |
533
385
 
534
386
  ### Return type
535
387
 
@@ -541,59 +393,41 @@ No authorization required
541
393
 
542
394
  ### HTTP request headers
543
395
 
544
- - **Content-Type**: application/json
545
- - **Accept**: application/json
396
+ - **Content-Type**: application/json
397
+ - **Accept**: application/json
546
398
 
547
399
 
548
- ## users_post_users
549
400
 
550
- > <Array<UserDto>> users_post_users(app_id, upsert_users_dto)
401
+ # **users_post_users**
402
+ > Array&lt;UserDto&gt; users_post_users(bodyapp_id)
551
403
 
552
404
  Upsert users.
553
405
 
554
- ### Examples
555
-
406
+ ### Example
556
407
  ```ruby
557
- require 'time'
558
- require 'notifo'
408
+ # load the gem
409
+ require 'swagger_client'
559
410
 
560
- api_instance = Notifo::UsersApi.new
411
+ api_instance = SwaggerClient::UsersApi.new
412
+ body = SwaggerClient::UpsertUsersDto.new # UpsertUsersDto | The upsert request.
561
413
  app_id = 'app_id_example' # String | The app where the users belong to.
562
- upsert_users_dto = Notifo::UpsertUsersDto.new({requests: [Notifo::UpsertUserDto.new]}) # UpsertUsersDto | The upsert request.
563
414
 
564
- begin
565
- # Upsert users.
566
- result = api_instance.users_post_users(app_id, upsert_users_dto)
567
- p result
568
- rescue Notifo::ApiError => e
569
- puts "Error when calling UsersApi->users_post_users: #{e}"
570
- end
571
- ```
572
-
573
- #### Using the users_post_users_with_http_info variant
574
-
575
- This returns an Array which contains the response data, status code and headers.
576
415
 
577
- > <Array(<Array<UserDto>>, Integer, Hash)> users_post_users_with_http_info(app_id, upsert_users_dto)
578
-
579
- ```ruby
580
416
  begin
581
- # Upsert users.
582
- data, status_code, headers = api_instance.users_post_users_with_http_info(app_id, upsert_users_dto)
583
- p status_code # => 2xx
584
- p headers # => { ... }
585
- p data # => <Array<UserDto>>
586
- rescue Notifo::ApiError => e
587
- puts "Error when calling UsersApi->users_post_users_with_http_info: #{e}"
417
+ #Upsert users.
418
+ result = api_instance.users_post_users(bodyapp_id)
419
+ p result
420
+ rescue SwaggerClient::ApiError => e
421
+ puts "Exception when calling UsersApi->users_post_users: #{e}"
588
422
  end
589
423
  ```
590
424
 
591
425
  ### Parameters
592
426
 
593
- | Name | Type | Description | Notes |
594
- | ---- | ---- | ----------- | ----- |
595
- | **app_id** | **String** | The app where the users belong to. | |
596
- | **upsert_users_dto** | [**UpsertUsersDto**](UpsertUsersDto.md) | The upsert request. | |
427
+ Name | Type | Description | Notes
428
+ ------------- | ------------- | ------------- | -------------
429
+ **body** | [**UpsertUsersDto**](UpsertUsersDto.md)| The upsert request. |
430
+ **app_id** | **String**| The app where the users belong to. |
597
431
 
598
432
  ### Return type
599
433
 
@@ -605,6 +439,8 @@ No authorization required
605
439
 
606
440
  ### HTTP request headers
607
441
 
608
- - **Content-Type**: application/json
609
- - **Accept**: application/json
442
+ - **Content-Type**: application/json
443
+ - **Accept**: application/json
444
+
445
+
610
446