SematextCloud 0.2.0 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (285) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile +3 -1
  3. data/README.md +43 -54
  4. data/SematextCloud.gemspec +0 -6
  5. data/docs/AlertNotification.md +12 -0
  6. data/docs/AlertNotificationRequest.md +1 -1
  7. data/docs/AlertNotificationsApi.md +33 -37
  8. data/docs/AlertRule.md +1 -1
  9. data/docs/AlertRuleResponse.md +9 -0
  10. data/docs/AlertRuleResponseEntry.md +6 -0
  11. data/docs/AlertRuleScheduleTimeRangeDto.md +1 -1
  12. data/docs/AlertRuleScheduleWeekdayDto.md +1 -1
  13. data/docs/AlertRulesResponse.md +9 -0
  14. data/docs/AlertRulesResponseEntry.md +6 -0
  15. data/docs/AlertsApi.md +41 -47
  16. data/docs/App.md +2 -1
  17. data/docs/AppDescription.md +1 -1
  18. data/docs/AppMetadata.md +1 -1
  19. data/docs/AppResponse.md +9 -0
  20. data/docs/AppResponseEntry.md +6 -0
  21. data/docs/AppTypesResponse.md +9 -0
  22. data/docs/AppTypesResponseEntry.md +6 -0
  23. data/docs/AppsApi.md +126 -81
  24. data/docs/AppsResponse.md +9 -0
  25. data/docs/AppsResponseEntry.md +6 -0
  26. data/docs/AwsSettingsControllerApi.md +16 -19
  27. data/docs/BasicAuthMethodDto.md +1 -1
  28. data/docs/BasicOrganizationDto.md +1 -1
  29. data/docs/BillingApi.md +35 -42
  30. data/docs/BillingInfo.md +1 -1
  31. data/docs/ChargesDetailsResponseDto.md +12 -0
  32. data/docs/CloudWatchSettings.md +1 -1
  33. data/docs/CloudWatchSettingsResponse.md +9 -0
  34. data/docs/CloudWatchSettingsResponseEntry.md +6 -0
  35. data/docs/CreateAppInfo.md +8 -8
  36. data/docs/CreateTokenDto.md +1 -0
  37. data/docs/DailyDto.md +9 -0
  38. data/docs/DayUsageData.md +26 -0
  39. data/docs/Dimension.md +7 -0
  40. data/docs/Error.md +1 -1
  41. data/docs/EventDto.md +8 -0
  42. data/docs/FilterValue.md +1 -1
  43. data/docs/GenericApiResponse.md +7 -7
  44. data/docs/GenericMapBasedApiResponse.md +9 -0
  45. data/docs/Invitation.md +2 -2
  46. data/docs/Invoice.md +11 -0
  47. data/docs/InvoiceResponse.md +9 -0
  48. data/docs/InvoiceResponseEntry.md +6 -0
  49. data/docs/LimitChangeEventDTO.md +8 -0
  50. data/docs/LogsAppApi.md +13 -15
  51. data/docs/LogsUsageApiControllerApi.md +60 -0
  52. data/docs/MailReportResponse.md +9 -0
  53. data/docs/MailReportResponseResponseEntry.md +6 -0
  54. data/docs/MinPeriodFeePeriod.md +16 -0
  55. data/docs/MonitoringAppApi.md +13 -15
  56. data/docs/NotificationIntegration.md +1 -1
  57. data/docs/NotificationsResponse.md +9 -0
  58. data/docs/NotificationsResponseEntry.md +8 -0
  59. data/docs/Plan.md +16 -16
  60. data/docs/PlansResponse.md +9 -0
  61. data/docs/PlansResponseEntry.md +6 -0
  62. data/docs/ReportInfo.md +1 -1
  63. data/docs/ResetPasswordApi.md +13 -15
  64. data/docs/ServiceIntegration.md +1 -1
  65. data/docs/Subscription.md +20 -0
  66. data/docs/SubscriptionResponse.md +9 -0
  67. data/docs/SubscriptionResponseEntry.md +6 -0
  68. data/docs/SubscriptionsApi.md +93 -110
  69. data/docs/SubscriptionsResponse.md +9 -0
  70. data/docs/SubscriptionsResponseEntry.md +6 -0
  71. data/docs/TagApiControllerApi.md +30 -39
  72. data/docs/TagNamesResponse.md +6 -0
  73. data/docs/TokenDto.md +12 -0
  74. data/docs/TokenResponse.md +9 -0
  75. data/docs/TokenResponseEntry.md +6 -0
  76. data/docs/TokensApiControllerApi.md +36 -47
  77. data/docs/TokensResponse.md +9 -0
  78. data/docs/TokensResponseEntry.md +6 -0
  79. data/docs/UpdateAppInfo.md +2 -2
  80. data/docs/UpdatePlanResponse.md +9 -0
  81. data/docs/UpdatePlanResponseDto.md +7 -0
  82. data/docs/UpdatePlanResponseEntry.md +6 -0
  83. data/docs/UpdateTokenDto.md +1 -0
  84. data/docs/UsageDto.md +16 -0
  85. data/docs/UsageMultiResponse.md +9 -0
  86. data/docs/UsageMultiResponseEntry.md +6 -0
  87. data/docs/UsageResponse.md +9 -0
  88. data/docs/UsageResponseEntry.md +6 -0
  89. data/docs/UserInfo.md +1 -1
  90. data/docs/UserPermissions.md +1 -1
  91. data/docs/UserRole.md +1 -1
  92. data/lib/SematextCloud/api/tokens_api_controller_api.rb +30 -30
  93. data/lib/SematextCloud/models/create_token_dto.rb +10 -1
  94. data/lib/SematextCloud/models/update_token_dto.rb +13 -4
  95. data/lib/SematextCloud/version.rb +1 -1
  96. data/lib/stcloud.rb +128 -0
  97. data/lib/stcloud/api/alert_notifications_api.rb +142 -0
  98. data/lib/stcloud/api/alerts_api.rb +292 -0
  99. data/lib/stcloud/api/apps_api.rb +452 -0
  100. data/lib/stcloud/api/aws_settings_controller_api.rb +84 -0
  101. data/lib/stcloud/api/billing_api.rb +202 -0
  102. data/lib/stcloud/api/logs_app_api.rb +76 -0
  103. data/lib/stcloud/api/logs_usage_api_controller_api.rb +86 -0
  104. data/lib/stcloud/api/monitoring_app_api.rb +76 -0
  105. data/lib/stcloud/api/reset_password_api.rb +76 -0
  106. data/lib/stcloud/api/subscriptions_api.rb +610 -0
  107. data/lib/stcloud/api/tag_api_controller_api.rb +250 -0
  108. data/lib/stcloud/api/tokens_api_controller_api.rb +324 -0
  109. data/lib/stcloud/api_client.rb +388 -0
  110. data/lib/stcloud/api_error.rb +57 -0
  111. data/lib/stcloud/configuration.rb +205 -0
  112. data/lib/stcloud/models/alert_notification.rb +260 -0
  113. data/lib/stcloud/models/alert_notification_request.rb +235 -0
  114. data/lib/stcloud/models/alert_rule.rb +675 -0
  115. data/lib/stcloud/models/alert_rule_response.rb +235 -0
  116. data/lib/stcloud/models/alert_rule_response_entry.rb +206 -0
  117. data/lib/stcloud/models/alert_rule_schedule_time_range_dto.rb +215 -0
  118. data/lib/stcloud/models/alert_rule_schedule_weekday_dto.rb +244 -0
  119. data/lib/stcloud/models/alert_rules_response.rb +235 -0
  120. data/lib/stcloud/models/alert_rules_response_entry.rb +208 -0
  121. data/lib/stcloud/models/app.rb +489 -0
  122. data/lib/stcloud/models/app_description.rb +206 -0
  123. data/lib/stcloud/models/app_metadata.rb +291 -0
  124. data/lib/stcloud/models/app_response.rb +235 -0
  125. data/lib/stcloud/models/app_response_entry.rb +206 -0
  126. data/lib/stcloud/models/app_types_response.rb +235 -0
  127. data/lib/stcloud/models/app_types_response_entry.rb +208 -0
  128. data/lib/stcloud/models/apps_response.rb +235 -0
  129. data/lib/stcloud/models/apps_response_entry.rb +208 -0
  130. data/lib/stcloud/models/basic_auth_method_dto.rb +249 -0
  131. data/lib/stcloud/models/basic_organization_dto.rb +269 -0
  132. data/lib/stcloud/models/billing_info.rb +224 -0
  133. data/lib/stcloud/models/charges_details_response_dto.rb +298 -0
  134. data/lib/stcloud/models/cloud_watch_settings.rb +279 -0
  135. data/lib/stcloud/models/cloud_watch_settings_response.rb +235 -0
  136. data/lib/stcloud/models/cloud_watch_settings_response_entry.rb +206 -0
  137. data/lib/stcloud/models/create_app_info.rb +242 -0
  138. data/lib/stcloud/models/create_token_dto.rb +224 -0
  139. data/lib/stcloud/models/daily_dto.rb +233 -0
  140. data/lib/stcloud/models/day_usage_data.rb +411 -0
  141. data/lib/stcloud/models/dimension.rb +227 -0
  142. data/lib/stcloud/models/error.rb +215 -0
  143. data/lib/stcloud/models/event_dto.rb +258 -0
  144. data/lib/stcloud/models/filter_value.rb +253 -0
  145. data/lib/stcloud/models/generic_api_response.rb +236 -0
  146. data/lib/stcloud/models/generic_map_based_api_response.rb +236 -0
  147. data/lib/stcloud/models/invitation.rb +348 -0
  148. data/lib/stcloud/models/invoice.rb +253 -0
  149. data/lib/stcloud/models/invoice_response.rb +235 -0
  150. data/lib/stcloud/models/invoice_response_entry.rb +206 -0
  151. data/lib/stcloud/models/limit_change_event_dto.rb +224 -0
  152. data/lib/stcloud/models/mail_report_response.rb +235 -0
  153. data/lib/stcloud/models/mail_report_response_response_entry.rb +206 -0
  154. data/lib/stcloud/models/min_period_fee_period.rb +296 -0
  155. data/lib/stcloud/models/notification_integration.rb +347 -0
  156. data/lib/stcloud/models/notifications_response.rb +235 -0
  157. data/lib/stcloud/models/notifications_response_entry.rb +226 -0
  158. data/lib/stcloud/models/plan.rb +360 -0
  159. data/lib/stcloud/models/plans_response.rb +235 -0
  160. data/lib/stcloud/models/plans_response_entry.rb +208 -0
  161. data/lib/stcloud/models/report_info.rb +270 -0
  162. data/lib/stcloud/models/service_integration.rb +305 -0
  163. data/lib/stcloud/models/subscription.rb +378 -0
  164. data/lib/stcloud/models/subscription_dashboard_dto.rb +342 -0
  165. data/lib/stcloud/models/subscription_dto.rb +351 -0
  166. data/lib/stcloud/models/subscription_response.rb +235 -0
  167. data/lib/stcloud/models/subscription_response_entry.rb +206 -0
  168. data/lib/stcloud/models/subscriptions_response.rb +235 -0
  169. data/lib/stcloud/models/subscriptions_response_entry.rb +208 -0
  170. data/lib/stcloud/models/tag_names_response.rb +213 -0
  171. data/lib/stcloud/models/token_dto.rb +260 -0
  172. data/lib/stcloud/models/token_response.rb +235 -0
  173. data/lib/stcloud/models/token_response_entry.rb +206 -0
  174. data/lib/stcloud/models/tokens_response.rb +235 -0
  175. data/lib/stcloud/models/tokens_response_entry.rb +208 -0
  176. data/lib/stcloud/models/update_app_info.rb +312 -0
  177. data/lib/stcloud/models/update_plan_response.rb +235 -0
  178. data/lib/stcloud/models/update_plan_response_dto.rb +217 -0
  179. data/lib/stcloud/models/update_plan_response_entry.rb +206 -0
  180. data/lib/stcloud/models/update_subscription_dto.rb +206 -0
  181. data/lib/stcloud/models/update_token_dto.rb +215 -0
  182. data/lib/stcloud/models/usage_dto.rb +302 -0
  183. data/lib/stcloud/models/usage_multi_response.rb +235 -0
  184. data/lib/stcloud/models/usage_multi_response_entry.rb +206 -0
  185. data/lib/stcloud/models/usage_response.rb +235 -0
  186. data/lib/stcloud/models/usage_response_entry.rb +206 -0
  187. data/lib/stcloud/models/user_info.rb +206 -0
  188. data/lib/stcloud/models/user_permissions.rb +224 -0
  189. data/lib/stcloud/models/user_role.rb +270 -0
  190. data/lib/stcloud/version.rb +14 -0
  191. data/spec/api/alert_notifications_api_spec.rb +12 -13
  192. data/spec/api/alerts_api_spec.rb +10 -11
  193. data/spec/api/apps_api_spec.rb +31 -21
  194. data/spec/api/aws_settings_controller_api_spec.rb +9 -10
  195. data/spec/api/billing_api_spec.rb +12 -13
  196. data/spec/api/logs_app_api_spec.rb +6 -7
  197. data/spec/api/logs_usage_api_controller_api_spec.rb +47 -0
  198. data/spec/api/monitoring_app_api_spec.rb +6 -7
  199. data/spec/api/reset_password_api_spec.rb +6 -7
  200. data/spec/api/subscriptions_api_spec.rb +106 -14
  201. data/spec/api/tag_api_controller_api_spec.rb +11 -12
  202. data/spec/api/tokens_api_controller_api_spec.rb +15 -16
  203. data/spec/api_client_spec.rb +30 -31
  204. data/spec/base_object_spec.rb +109 -0
  205. data/spec/configuration_spec.rb +7 -8
  206. data/spec/models/alert_notification_request_spec.rb +1 -2
  207. data/spec/models/alert_notification_spec.rb +76 -0
  208. data/spec/models/alert_rule_response_entry_spec.rb +40 -0
  209. data/spec/models/alert_rule_response_spec.rb +58 -0
  210. data/spec/models/alert_rule_schedule_time_range_dto_spec.rb +1 -2
  211. data/spec/models/alert_rule_schedule_weekday_dto_spec.rb +1 -2
  212. data/spec/models/alert_rule_spec.rb +1 -2
  213. data/spec/models/alert_rules_response_entry_spec.rb +40 -0
  214. data/spec/models/alert_rules_response_spec.rb +58 -0
  215. data/spec/models/app_description_spec.rb +1 -2
  216. data/spec/models/app_metadata_spec.rb +1 -2
  217. data/spec/models/app_response_entry_spec.rb +40 -0
  218. data/spec/models/app_response_spec.rb +58 -0
  219. data/spec/models/app_spec.rb +31 -2
  220. data/spec/models/app_types_response_entry_spec.rb +40 -0
  221. data/spec/models/app_types_response_spec.rb +58 -0
  222. data/spec/models/apps_response_entry_spec.rb +40 -0
  223. data/spec/models/apps_response_spec.rb +58 -0
  224. data/spec/models/basic_auth_method_dto_spec.rb +1 -2
  225. data/spec/models/basic_organization_dto_spec.rb +1 -2
  226. data/spec/models/billing_info_spec.rb +1 -2
  227. data/spec/models/charges_details_response_dto_spec.rb +80 -0
  228. data/spec/models/cloud_watch_settings_response_entry_spec.rb +40 -0
  229. data/spec/models/cloud_watch_settings_response_spec.rb +58 -0
  230. data/spec/models/cloud_watch_settings_spec.rb +1 -2
  231. data/spec/models/create_app_info_spec.rb +1 -2
  232. data/spec/models/create_token_dto_spec.rb +7 -2
  233. data/spec/models/daily_dto_spec.rb +58 -0
  234. data/spec/models/day_usage_data_spec.rb +158 -0
  235. data/spec/models/dimension_spec.rb +46 -0
  236. data/spec/models/error_spec.rb +1 -2
  237. data/spec/models/event_dto_spec.rb +56 -0
  238. data/spec/models/filter_value_spec.rb +1 -2
  239. data/spec/models/generic_api_response_spec.rb +1 -2
  240. data/spec/models/generic_map_based_api_response_spec.rb +58 -0
  241. data/spec/models/invitation_spec.rb +1 -2
  242. data/spec/models/invoice_response_entry_spec.rb +40 -0
  243. data/spec/models/invoice_response_spec.rb +58 -0
  244. data/spec/models/invoice_spec.rb +70 -0
  245. data/spec/models/limit_change_event_dto_spec.rb +52 -0
  246. data/spec/models/mail_report_response_response_entry_spec.rb +40 -0
  247. data/spec/models/mail_report_response_spec.rb +58 -0
  248. data/spec/models/min_period_fee_period_spec.rb +100 -0
  249. data/spec/models/notification_integration_spec.rb +1 -2
  250. data/spec/models/notifications_response_entry_spec.rb +52 -0
  251. data/spec/models/notifications_response_spec.rb +58 -0
  252. data/spec/models/plan_spec.rb +2 -3
  253. data/spec/models/plans_response_entry_spec.rb +40 -0
  254. data/spec/models/plans_response_spec.rb +58 -0
  255. data/spec/models/report_info_spec.rb +1 -2
  256. data/spec/models/service_integration_spec.rb +1 -2
  257. data/spec/models/subscription_dashboard_dto_spec.rb +1 -2
  258. data/spec/models/subscription_dto_spec.rb +1 -2
  259. data/spec/models/subscription_response_entry_spec.rb +40 -0
  260. data/spec/models/subscription_response_spec.rb +58 -0
  261. data/spec/models/subscription_spec.rb +132 -0
  262. data/spec/models/subscriptions_response_entry_spec.rb +40 -0
  263. data/spec/models/subscriptions_response_spec.rb +58 -0
  264. data/spec/models/tag_names_response_spec.rb +40 -0
  265. data/spec/models/token_dto_spec.rb +76 -0
  266. data/spec/models/token_response_entry_spec.rb +40 -0
  267. data/spec/models/token_response_spec.rb +58 -0
  268. data/spec/models/tokens_response_entry_spec.rb +40 -0
  269. data/spec/models/tokens_response_spec.rb +58 -0
  270. data/spec/models/update_app_info_spec.rb +1 -2
  271. data/spec/models/update_plan_response_dto_spec.rb +46 -0
  272. data/spec/models/update_plan_response_entry_spec.rb +40 -0
  273. data/spec/models/update_plan_response_spec.rb +58 -0
  274. data/spec/models/update_subscription_dto_spec.rb +1 -2
  275. data/spec/models/update_token_dto_spec.rb +7 -2
  276. data/spec/models/usage_dto_spec.rb +100 -0
  277. data/spec/models/usage_multi_response_entry_spec.rb +40 -0
  278. data/spec/models/usage_multi_response_spec.rb +58 -0
  279. data/spec/models/usage_response_entry_spec.rb +40 -0
  280. data/spec/models/usage_response_spec.rb +58 -0
  281. data/spec/models/user_info_spec.rb +1 -2
  282. data/spec/models/user_permissions_spec.rb +1 -2
  283. data/spec/models/user_role_spec.rb +1 -2
  284. data/spec/spec_helper.rb +2 -3
  285. metadata +281 -154
@@ -1,4 +1,4 @@
1
- # SematextCloud::ServiceIntegration
1
+ # stcloud::ServiceIntegration
2
2
 
3
3
  ## Properties
4
4
  | Name | Type | Description | Notes |
@@ -0,0 +1,20 @@
1
+ # stcloud::Subscription
2
+
3
+ ## Properties
4
+ | Name | Type | Description | Notes |
5
+ | -------------------- | ----------------------------------------- | ----------- | ---------- |
6
+ | **addresses** | **String** | | [optional] |
7
+ | **created_by** | **String** | | [optional] |
8
+ | **dashboard_id** | **Integer** | | [optional] |
9
+ | **dashboard_name** | **String** | | [optional] |
10
+ | **enabled** | **BOOLEAN** | | [optional] |
11
+ | **filters** | **String** | | [optional] |
12
+ | **frequency** | **String** | | [optional] |
13
+ | **id** | **Integer** | | [optional] |
14
+ | **next_send_date** | **DateTime** | | [optional] |
15
+ | **subject** | **String** | | [optional] |
16
+ | **system_id** | **Integer** | | [optional] |
17
+ | **system_name** | **String** | | [optional] |
18
+ | **text** | **String** | | [optional] |
19
+ | **time_range** | **String** | | [optional] |
20
+ | **user_permissions** | [**UserPermissions**](UserPermissions.md) | | [optional] |
@@ -0,0 +1,9 @@
1
+ # stcloud::SubscriptionResponse
2
+
3
+ ## Properties
4
+ | Name | Type | Description | Notes |
5
+ | ----------- | ------------------------------------------------------------- | ----------- | ---------- |
6
+ | **data** | [**SubscriptionResponseEntry**](SubscriptionResponseEntry.md) | | [optional] |
7
+ | **errors** | [**Array<Error>**](Error.md) | | [optional] |
8
+ | **message** | **String** | | [optional] |
9
+ | **success** | **BOOLEAN** | | [optional] |
@@ -0,0 +1,6 @@
1
+ # stcloud::SubscriptionResponseEntry
2
+
3
+ ## Properties
4
+ | Name | Type | Description | Notes |
5
+ | ---------------- | ----------------------------------- | ----------- | ---------- |
6
+ | **subscription** | [**Subscription**](Subscription.md) | | [optional] |
@@ -1,23 +1,22 @@
1
- # SematextCloud::SubscriptionsApi
2
-
3
- All URIs are relative to *https://localhost*
4
-
5
- | Method | HTTP request | Description |
6
- | ------------------------------------------------------------------------------------ | --------------------------------------------------------------------- | --------------------------------------- |
7
- | [**create_for_app_using_post**](SubscriptionsApi.md#create_for_app_using_post) | **POST** /users-web/api/v3/apps/{appId}/subscription | Create App subscription |
8
- | [**create_for_dash_using_post1**](SubscriptionsApi.md#create_for_dash_using_post1) | **POST** /users-web/api/v3/dashboards/{dashId}/subscription | Create dashboard subscription |
9
- | [**delete_using_delete2**](SubscriptionsApi.md#delete_using_delete2) | **DELETE** /users-web/api/v3/subscriptions/{updateableSubscriptionId} | Delete subscription |
10
- | [**list_using_get2**](SubscriptionsApi.md#list_using_get2) | **GET** /users-web/api/v3/apps/{appId}/subscriptions | Get subscriptions for an App |
11
- | [**list_using_get5**](SubscriptionsApi.md#list_using_get5) | **GET** /users-web/api/v3/subscriptions | Get current account's subscriptions |
12
- | [**send_app_report_using_post1**](SubscriptionsApi.md#send_app_report_using_post1) | **POST** /users-web/api/v3/apps/{appId}/report/send | Email an App report |
13
- | [**send_dash_report_using_post1**](SubscriptionsApi.md#send_dash_report_using_post1) | **POST** /users-web/api/v3/dashboards/{dashId}/report/send | Email a dashboard report |
14
- | [**toggle_enabled_using_put1**](SubscriptionsApi.md#toggle_enabled_using_put1) | **PUT** /users-web/api/v3/subscriptions/{updateableSubscriptionId} | Toggle subscription status |
15
- | [**update_for_app_using_put1**](SubscriptionsApi.md#update_for_app_using_put1) | **PUT** /users-web/api/v3/apps/{appId}/subscription | Update App subscription |
16
- | [**update_for_dash_using_put**](SubscriptionsApi.md#update_for_dash_using_put) | **PUT** /users-web/api/v3/dashboards/{dashId}/subscription | Update dashboard subscription |
17
-
18
-
19
- # **create_for_app_using_post**
20
- > GenericApiResponse create_for_app_using_post(app_id, subscription)
1
+ # stcloud::SubscriptionsApi
2
+
3
+ All URIs are relative to */*
4
+
5
+ | Method | HTTP request | Description |
6
+ | ---------------------------------------------------------------------------------- | --------------------------------------------------------------------- | ---------------------------------------- |
7
+ | [**create_for_app_using_post1**](SubscriptionsApi.md#create_for_app_using_post1) | **POST** /users-web/api/v3/apps/{appId}/subscription | Create App subscription |
8
+ | [**create_for_dash_using_post1**](SubscriptionsApi.md#create_for_dash_using_post1) | **POST** /users-web/api/v3/dashboards/{dashId}/subscription | Create dashboard subscription |
9
+ | [**delete_using_delete3**](SubscriptionsApi.md#delete_using_delete3) | **DELETE** /users-web/api/v3/subscriptions/{updateableSubscriptionId} | Delete subscription |
10
+ | [**list_using_get3**](SubscriptionsApi.md#list_using_get3) | **GET** /users-web/api/v3/apps/{appId}/subscriptions | Get subscriptions for an App |
11
+ | [**list_using_get5**](SubscriptionsApi.md#list_using_get5) | **GET** /users-web/api/v3/subscriptions | Get current account's subscriptions |
12
+ | [**send_app_report_using_post**](SubscriptionsApi.md#send_app_report_using_post) | **POST** /users-web/api/v3/apps/{appId}/report/send | Email an App report |
13
+ | [**send_dash_report_using_post**](SubscriptionsApi.md#send_dash_report_using_post) | **POST** /users-web/api/v3/dashboards/{dashId}/report/send | Email a dashboard report |
14
+ | [**toggle_enabled_using_put1**](SubscriptionsApi.md#toggle_enabled_using_put1) | **PUT** /users-web/api/v3/subscriptions/{updateableSubscriptionId} | Toggle subscription status |
15
+ | [**update_for_app_using_put1**](SubscriptionsApi.md#update_for_app_using_put1) | **PUT** /users-web/api/v3/apps/{appId}/subscription | Update App subscription |
16
+ | [**update_for_dash_using_put1**](SubscriptionsApi.md#update_for_dash_using_put1) | **PUT** /users-web/api/v3/dashboards/{dashId}/subscription | Update dashboard subscription |
17
+
18
+ # **create_for_app_using_post1**
19
+ > SubscriptionResponse create_for_app_using_post1(bodyapp_id)
21
20
 
22
21
  Create App subscription
23
22
 
@@ -34,31 +33,29 @@ stcloud.configure do |config|
34
33
  end
35
34
 
36
35
  api_instance = stcloud::SubscriptionsApi.new
37
-
36
+ body = stcloud::SubscriptionDto.new # SubscriptionDto | subscription
38
37
  app_id = 789 # Integer | appId
39
38
 
40
- subscription = stcloud::SubscriptionDto.new # SubscriptionDto | subscription
41
-
42
39
 
43
40
  begin
44
41
  #Create App subscription
45
- result = api_instance.create_for_app_using_post(app_id, subscription)
42
+ result = api_instance.create_for_app_using_post1(bodyapp_id)
46
43
  p result
47
44
  rescue stcloud::ApiError => e
48
- puts "Exception when calling SubscriptionsApi->create_for_app_using_post: #{e}"
45
+ puts "Exception when calling SubscriptionsApi->create_for_app_using_post1: #{e}"
49
46
  end
50
47
  ```
51
48
 
52
49
  ### Parameters
53
50
 
54
- | Name | Type | Description | Notes |
55
- | ---------------- | ----------------------------------------- | ------------ | ----- |
56
- | **app_id** | **Integer** | appId |
57
- | **subscription** | [**SubscriptionDto**](SubscriptionDto.md) | subscription |
51
+ | Name | Type | Description | Notes |
52
+ | ---------- | ----------------------------------------- | ------------ | ----- |
53
+ | **body** | [**SubscriptionDto**](SubscriptionDto.md) | subscription |
54
+ | **app_id** | **Integer** | appId |
58
55
 
59
56
  ### Return type
60
57
 
61
- [**GenericApiResponse**](GenericApiResponse.md)
58
+ [**SubscriptionResponse**](SubscriptionResponse.md)
62
59
 
63
60
  ### Authorization
64
61
 
@@ -72,7 +69,7 @@ end
72
69
 
73
70
 
74
71
  # **create_for_dash_using_post1**
75
- > GenericApiResponse create_for_dash_using_post1(dash_id, subscription)
72
+ > SubscriptionResponse create_for_dash_using_post1(bodydash_id)
76
73
 
77
74
  Create dashboard subscription
78
75
 
@@ -89,15 +86,13 @@ stcloud.configure do |config|
89
86
  end
90
87
 
91
88
  api_instance = stcloud::SubscriptionsApi.new
92
-
89
+ body = stcloud::SubscriptionDashboardDto.new # SubscriptionDashboardDto | subscription
93
90
  dash_id = 789 # Integer | dashId
94
91
 
95
- subscription = stcloud::SubscriptionDashboardDto.new # SubscriptionDashboardDto | subscription
96
-
97
92
 
98
93
  begin
99
94
  #Create dashboard subscription
100
- result = api_instance.create_for_dash_using_post1(dash_id, subscription)
95
+ result = api_instance.create_for_dash_using_post1(bodydash_id)
101
96
  p result
102
97
  rescue stcloud::ApiError => e
103
98
  puts "Exception when calling SubscriptionsApi->create_for_dash_using_post1: #{e}"
@@ -106,14 +101,14 @@ end
106
101
 
107
102
  ### Parameters
108
103
 
109
- | Name | Type | Description | Notes |
110
- | ---------------- | ----------------------------------------------------------- | ------------ | ----- |
111
- | **dash_id** | **Integer** | dashId |
112
- | **subscription** | [**SubscriptionDashboardDto**](SubscriptionDashboardDto.md) | subscription |
104
+ | Name | Type | Description | Notes |
105
+ | ----------- | ----------------------------------------------------------- | ------------ | ----- |
106
+ | **body** | [**SubscriptionDashboardDto**](SubscriptionDashboardDto.md) | subscription |
107
+ | **dash_id** | **Integer** | dashId |
113
108
 
114
109
  ### Return type
115
110
 
116
- [**GenericApiResponse**](GenericApiResponse.md)
111
+ [**SubscriptionResponse**](SubscriptionResponse.md)
117
112
 
118
113
  ### Authorization
119
114
 
@@ -126,8 +121,8 @@ end
126
121
 
127
122
 
128
123
 
129
- # **delete_using_delete2**
130
- > GenericApiResponse delete_using_delete2(updateable_subscription_id)
124
+ # **delete_using_delete3**
125
+ > GenericMapBasedApiResponse delete_using_delete3(updateable_subscription_id)
131
126
 
132
127
  Delete subscription
133
128
 
@@ -144,16 +139,15 @@ stcloud.configure do |config|
144
139
  end
145
140
 
146
141
  api_instance = stcloud::SubscriptionsApi.new
147
-
148
142
  updateable_subscription_id = 789 # Integer | updateableSubscriptionId
149
143
 
150
144
 
151
145
  begin
152
146
  #Delete subscription
153
- result = api_instance.delete_using_delete2(updateable_subscription_id)
147
+ result = api_instance.delete_using_delete3(updateable_subscription_id)
154
148
  p result
155
149
  rescue stcloud::ApiError => e
156
- puts "Exception when calling SubscriptionsApi->delete_using_delete2: #{e}"
150
+ puts "Exception when calling SubscriptionsApi->delete_using_delete3: #{e}"
157
151
  end
158
152
  ```
159
153
 
@@ -165,7 +159,7 @@ end
165
159
 
166
160
  ### Return type
167
161
 
168
- [**GenericApiResponse**](GenericApiResponse.md)
162
+ [**GenericMapBasedApiResponse**](GenericMapBasedApiResponse.md)
169
163
 
170
164
  ### Authorization
171
165
 
@@ -173,13 +167,13 @@ end
173
167
 
174
168
  ### HTTP request headers
175
169
 
176
- - **Content-Type**: application/json
170
+ - **Content-Type**: Not defined
177
171
  - **Accept**: application/json
178
172
 
179
173
 
180
174
 
181
- # **list_using_get2**
182
- > GenericApiResponse list_using_get2(app_id)
175
+ # **list_using_get3**
176
+ > SubscriptionsResponse list_using_get3(app_id)
183
177
 
184
178
  Get subscriptions for an App
185
179
 
@@ -196,16 +190,15 @@ stcloud.configure do |config|
196
190
  end
197
191
 
198
192
  api_instance = stcloud::SubscriptionsApi.new
199
-
200
193
  app_id = 789 # Integer | appId
201
194
 
202
195
 
203
196
  begin
204
197
  #Get subscriptions for an App
205
- result = api_instance.list_using_get2(app_id)
198
+ result = api_instance.list_using_get3(app_id)
206
199
  p result
207
200
  rescue stcloud::ApiError => e
208
- puts "Exception when calling SubscriptionsApi->list_using_get2: #{e}"
201
+ puts "Exception when calling SubscriptionsApi->list_using_get3: #{e}"
209
202
  end
210
203
  ```
211
204
 
@@ -217,7 +210,7 @@ end
217
210
 
218
211
  ### Return type
219
212
 
220
- [**GenericApiResponse**](GenericApiResponse.md)
213
+ [**SubscriptionsResponse**](SubscriptionsResponse.md)
221
214
 
222
215
  ### Authorization
223
216
 
@@ -225,13 +218,13 @@ end
225
218
 
226
219
  ### HTTP request headers
227
220
 
228
- - **Content-Type**: application/json
221
+ - **Content-Type**: Not defined
229
222
  - **Accept**: application/json
230
223
 
231
224
 
232
225
 
233
226
  # **list_using_get5**
234
- > GenericApiResponse list_using_get5
227
+ > SubscriptionsResponse list_using_get5
235
228
 
236
229
  Get current account's subscriptions
237
230
 
@@ -263,7 +256,7 @@ This endpoint does not need any parameter.
263
256
 
264
257
  ### Return type
265
258
 
266
- [**GenericApiResponse**](GenericApiResponse.md)
259
+ [**SubscriptionsResponse**](SubscriptionsResponse.md)
267
260
 
268
261
  ### Authorization
269
262
 
@@ -271,13 +264,13 @@ This endpoint does not need any parameter.
271
264
 
272
265
  ### HTTP request headers
273
266
 
274
- - **Content-Type**: application/json
267
+ - **Content-Type**: Not defined
275
268
  - **Accept**: application/json
276
269
 
277
270
 
278
271
 
279
- # **send_app_report_using_post1**
280
- > GenericApiResponse send_app_report_using_post1(app_id, email_dto)
272
+ # **send_app_report_using_post**
273
+ > MailReportResponse send_app_report_using_post(bodyapp_id)
281
274
 
282
275
  Email an App report
283
276
 
@@ -294,31 +287,29 @@ stcloud.configure do |config|
294
287
  end
295
288
 
296
289
  api_instance = stcloud::SubscriptionsApi.new
297
-
290
+ body = stcloud::ReportInfo.new # ReportInfo | emailDto
298
291
  app_id = 789 # Integer | appId
299
292
 
300
- email_dto = stcloud::ReportInfo.new # ReportInfo | emailDto
301
-
302
293
 
303
294
  begin
304
295
  #Email an App report
305
- result = api_instance.send_app_report_using_post1(app_id, email_dto)
296
+ result = api_instance.send_app_report_using_post(bodyapp_id)
306
297
  p result
307
298
  rescue stcloud::ApiError => e
308
- puts "Exception when calling SubscriptionsApi->send_app_report_using_post1: #{e}"
299
+ puts "Exception when calling SubscriptionsApi->send_app_report_using_post: #{e}"
309
300
  end
310
301
  ```
311
302
 
312
303
  ### Parameters
313
304
 
314
- | Name | Type | Description | Notes |
315
- | ------------- | ------------------------------- | ----------- | ----- |
316
- | **app_id** | **Integer** | appId |
317
- | **email_dto** | [**ReportInfo**](ReportInfo.md) | emailDto |
305
+ | Name | Type | Description | Notes |
306
+ | ---------- | ------------------------------- | ----------- | ----- |
307
+ | **body** | [**ReportInfo**](ReportInfo.md) | emailDto |
308
+ | **app_id** | **Integer** | appId |
318
309
 
319
310
  ### Return type
320
311
 
321
- [**GenericApiResponse**](GenericApiResponse.md)
312
+ [**MailReportResponse**](MailReportResponse.md)
322
313
 
323
314
  ### Authorization
324
315
 
@@ -331,8 +322,8 @@ end
331
322
 
332
323
 
333
324
 
334
- # **send_dash_report_using_post1**
335
- > GenericApiResponse send_dash_report_using_post1(dash_id, email_dto)
325
+ # **send_dash_report_using_post**
326
+ > MailReportResponse send_dash_report_using_post(bodydash_id)
336
327
 
337
328
  Email a dashboard report
338
329
 
@@ -349,31 +340,29 @@ stcloud.configure do |config|
349
340
  end
350
341
 
351
342
  api_instance = stcloud::SubscriptionsApi.new
352
-
343
+ body = stcloud::ReportInfo.new # ReportInfo | emailDto
353
344
  dash_id = 789 # Integer | dashId
354
345
 
355
- email_dto = stcloud::ReportInfo.new # ReportInfo | emailDto
356
-
357
346
 
358
347
  begin
359
348
  #Email a dashboard report
360
- result = api_instance.send_dash_report_using_post1(dash_id, email_dto)
349
+ result = api_instance.send_dash_report_using_post(bodydash_id)
361
350
  p result
362
351
  rescue stcloud::ApiError => e
363
- puts "Exception when calling SubscriptionsApi->send_dash_report_using_post1: #{e}"
352
+ puts "Exception when calling SubscriptionsApi->send_dash_report_using_post: #{e}"
364
353
  end
365
354
  ```
366
355
 
367
356
  ### Parameters
368
357
 
369
- | Name | Type | Description | Notes |
370
- | ------------- | ------------------------------- | ----------- | ----- |
371
- | **dash_id** | **Integer** | dashId |
372
- | **email_dto** | [**ReportInfo**](ReportInfo.md) | emailDto |
358
+ | Name | Type | Description | Notes |
359
+ | ----------- | ------------------------------- | ----------- | ----- |
360
+ | **body** | [**ReportInfo**](ReportInfo.md) | emailDto |
361
+ | **dash_id** | **Integer** | dashId |
373
362
 
374
363
  ### Return type
375
364
 
376
- [**GenericApiResponse**](GenericApiResponse.md)
365
+ [**MailReportResponse**](MailReportResponse.md)
377
366
 
378
367
  ### Authorization
379
368
 
@@ -387,7 +376,7 @@ end
387
376
 
388
377
 
389
378
  # **toggle_enabled_using_put1**
390
- > GenericApiResponse toggle_enabled_using_put1(updateable_subscription_id, dto)
379
+ > SubscriptionResponse toggle_enabled_using_put1(bodyupdateable_subscription_id)
391
380
 
392
381
  Toggle subscription status
393
382
 
@@ -404,15 +393,13 @@ stcloud.configure do |config|
404
393
  end
405
394
 
406
395
  api_instance = stcloud::SubscriptionsApi.new
407
-
396
+ body = stcloud::UpdateSubscriptionDto.new # UpdateSubscriptionDto | dto
408
397
  updateable_subscription_id = 789 # Integer | updateableSubscriptionId
409
398
 
410
- dto = stcloud::UpdateSubscriptionDto.new # UpdateSubscriptionDto | dto
411
-
412
399
 
413
400
  begin
414
401
  #Toggle subscription status
415
- result = api_instance.toggle_enabled_using_put1(updateable_subscription_id, dto)
402
+ result = api_instance.toggle_enabled_using_put1(bodyupdateable_subscription_id)
416
403
  p result
417
404
  rescue stcloud::ApiError => e
418
405
  puts "Exception when calling SubscriptionsApi->toggle_enabled_using_put1: #{e}"
@@ -423,12 +410,12 @@ end
423
410
 
424
411
  | Name | Type | Description | Notes |
425
412
  | ------------------------------ | ----------------------------------------------------- | ------------------------ | ----- |
413
+ | **body** | [**UpdateSubscriptionDto**](UpdateSubscriptionDto.md) | dto |
426
414
  | **updateable_subscription_id** | **Integer** | updateableSubscriptionId |
427
- | **dto** | [**UpdateSubscriptionDto**](UpdateSubscriptionDto.md) | dto |
428
415
 
429
416
  ### Return type
430
417
 
431
- [**GenericApiResponse**](GenericApiResponse.md)
418
+ [**SubscriptionResponse**](SubscriptionResponse.md)
432
419
 
433
420
  ### Authorization
434
421
 
@@ -442,7 +429,7 @@ end
442
429
 
443
430
 
444
431
  # **update_for_app_using_put1**
445
- > GenericApiResponse update_for_app_using_put1(app_id, subscription)
432
+ > SubscriptionResponse update_for_app_using_put1(bodyapp_id)
446
433
 
447
434
  Update App subscription
448
435
 
@@ -459,15 +446,13 @@ stcloud.configure do |config|
459
446
  end
460
447
 
461
448
  api_instance = stcloud::SubscriptionsApi.new
462
-
449
+ body = stcloud::SubscriptionDto.new # SubscriptionDto | subscription
463
450
  app_id = 789 # Integer | appId
464
451
 
465
- subscription = stcloud::SubscriptionDto.new # SubscriptionDto | subscription
466
-
467
452
 
468
453
  begin
469
454
  #Update App subscription
470
- result = api_instance.update_for_app_using_put1(app_id, subscription)
455
+ result = api_instance.update_for_app_using_put1(bodyapp_id)
471
456
  p result
472
457
  rescue stcloud::ApiError => e
473
458
  puts "Exception when calling SubscriptionsApi->update_for_app_using_put1: #{e}"
@@ -476,14 +461,14 @@ end
476
461
 
477
462
  ### Parameters
478
463
 
479
- | Name | Type | Description | Notes |
480
- | ---------------- | ----------------------------------------- | ------------ | ----- |
481
- | **app_id** | **Integer** | appId |
482
- | **subscription** | [**SubscriptionDto**](SubscriptionDto.md) | subscription |
464
+ | Name | Type | Description | Notes |
465
+ | ---------- | ----------------------------------------- | ------------ | ----- |
466
+ | **body** | [**SubscriptionDto**](SubscriptionDto.md) | subscription |
467
+ | **app_id** | **Integer** | appId |
483
468
 
484
469
  ### Return type
485
470
 
486
- [**GenericApiResponse**](GenericApiResponse.md)
471
+ [**SubscriptionResponse**](SubscriptionResponse.md)
487
472
 
488
473
  ### Authorization
489
474
 
@@ -496,8 +481,8 @@ end
496
481
 
497
482
 
498
483
 
499
- # **update_for_dash_using_put**
500
- > GenericApiResponse update_for_dash_using_put(dash_id, subscription)
484
+ # **update_for_dash_using_put1**
485
+ > SubscriptionResponse update_for_dash_using_put1(bodydash_id)
501
486
 
502
487
  Update dashboard subscription
503
488
 
@@ -514,31 +499,29 @@ stcloud.configure do |config|
514
499
  end
515
500
 
516
501
  api_instance = stcloud::SubscriptionsApi.new
517
-
502
+ body = stcloud::SubscriptionDashboardDto.new # SubscriptionDashboardDto | subscription
518
503
  dash_id = 789 # Integer | dashId
519
504
 
520
- subscription = stcloud::SubscriptionDashboardDto.new # SubscriptionDashboardDto | subscription
521
-
522
505
 
523
506
  begin
524
507
  #Update dashboard subscription
525
- result = api_instance.update_for_dash_using_put(dash_id, subscription)
508
+ result = api_instance.update_for_dash_using_put1(bodydash_id)
526
509
  p result
527
510
  rescue stcloud::ApiError => e
528
- puts "Exception when calling SubscriptionsApi->update_for_dash_using_put: #{e}"
511
+ puts "Exception when calling SubscriptionsApi->update_for_dash_using_put1: #{e}"
529
512
  end
530
513
  ```
531
514
 
532
515
  ### Parameters
533
516
 
534
- | Name | Type | Description | Notes |
535
- | ---------------- | ----------------------------------------------------------- | ------------ | ----- |
536
- | **dash_id** | **Integer** | dashId |
537
- | **subscription** | [**SubscriptionDashboardDto**](SubscriptionDashboardDto.md) | subscription |
517
+ | Name | Type | Description | Notes |
518
+ | ----------- | ----------------------------------------------------------- | ------------ | ----- |
519
+ | **body** | [**SubscriptionDashboardDto**](SubscriptionDashboardDto.md) | subscription |
520
+ | **dash_id** | **Integer** | dashId |
538
521
 
539
522
  ### Return type
540
523
 
541
- [**GenericApiResponse**](GenericApiResponse.md)
524
+ [**SubscriptionResponse**](SubscriptionResponse.md)
542
525
 
543
526
  ### Authorization
544
527