SematextCloud 0.1.2 → 0.3.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/Gemfile +3 -1
- data/README.md +80 -69
- data/SematextCloud.gemspec +0 -6
- data/docs/AlertNotification.md +12 -0
- data/docs/AlertNotificationRequest.md +7 -7
- data/docs/AlertNotificationsApi.md +33 -37
- data/docs/AlertRule.md +51 -51
- data/docs/AlertRuleResponse.md +9 -0
- data/docs/AlertRuleResponseEntry.md +6 -0
- data/docs/AlertRuleScheduleTimeRangeDto.md +5 -5
- data/docs/AlertRuleScheduleWeekdayDto.md +8 -8
- data/docs/AlertRulesResponse.md +9 -0
- data/docs/AlertRulesResponseEntry.md +6 -0
- data/docs/AlertsApi.md +60 -66
- data/docs/App.md +35 -30
- data/docs/AppDescription.md +4 -4
- data/docs/AppMetadata.md +8 -8
- data/docs/AppResponse.md +9 -0
- data/docs/AppResponseEntry.md +6 -0
- data/docs/AppTypesResponse.md +9 -0
- data/docs/AppTypesResponseEntry.md +6 -0
- data/docs/AppsApi.md +135 -90
- data/docs/AppsResponse.md +9 -0
- data/docs/AppsResponseEntry.md +6 -0
- data/docs/AwsSettingsControllerApi.md +19 -22
- data/docs/BasicAuthMethodDto.md +5 -5
- data/docs/BasicOrganizationDto.md +7 -7
- data/docs/BillingApi.md +47 -54
- data/docs/BillingInfo.md +6 -6
- data/docs/ChargesDetailsResponseDto.md +12 -0
- data/docs/CloudWatchSettings.md +7 -7
- data/docs/CloudWatchSettingsResponse.md +9 -0
- data/docs/CloudWatchSettingsResponseEntry.md +6 -0
- data/docs/CreateAppInfo.md +8 -8
- data/docs/CreateTokenDto.md +8 -0
- data/docs/DailyDto.md +9 -0
- data/docs/DataSeriesFilter.md +5 -5
- data/docs/DataSeriesRequest.md +9 -9
- data/docs/DayUsageData.md +26 -0
- data/docs/Dimension.md +7 -0
- data/docs/Error.md +5 -5
- data/docs/EventDto.md +8 -0
- data/docs/FilterValue.md +9 -9
- data/docs/GenericApiResponse.md +7 -7
- data/docs/GenericMapBasedApiResponse.md +9 -0
- data/docs/Invitation.md +13 -13
- data/docs/Invoice.md +11 -0
- data/docs/InvoiceResponse.md +9 -0
- data/docs/InvoiceResponseEntry.md +6 -0
- data/docs/LimitChangeEventDTO.md +8 -0
- data/docs/LogsAppApi.md +16 -18
- data/docs/LogsUsageApiControllerApi.md +60 -0
- data/docs/MailReportResponse.md +9 -0
- data/docs/MailReportResponseResponseEntry.md +6 -0
- data/docs/MetricsApi.md +20 -20
- data/docs/MinPeriodFeePeriod.md +16 -0
- data/docs/MonitoringAppApi.md +16 -18
- data/docs/NotificationIntegration.md +13 -13
- data/docs/NotificationsResponse.md +9 -0
- data/docs/NotificationsResponseEntry.md +8 -0
- data/docs/Plan.md +16 -16
- data/docs/PlansResponse.md +9 -0
- data/docs/PlansResponseEntry.md +6 -0
- data/docs/ReportInfo.md +11 -11
- data/docs/ResetPasswordApi.md +16 -18
- data/docs/SavedQueriesApi.md +19 -19
- data/docs/SavedQuery.md +15 -15
- data/docs/ServiceIntegration.md +15 -15
- data/docs/Subscription.md +20 -0
- data/docs/SubscriptionDashboardDto.md +16 -0
- data/docs/SubscriptionDto.md +17 -0
- data/docs/SubscriptionResponse.md +9 -0
- data/docs/SubscriptionResponseEntry.md +6 -0
- data/docs/SubscriptionsApi.md +455 -36
- data/docs/SubscriptionsResponse.md +9 -0
- data/docs/SubscriptionsResponseEntry.md +6 -0
- data/docs/TagApiControllerApi.md +63 -72
- data/docs/TagNamesResponse.md +6 -0
- data/docs/TokenDto.md +12 -0
- data/docs/TokenResponse.md +9 -0
- data/docs/TokenResponseEntry.md +6 -0
- data/docs/TokensApiControllerApi.md +274 -0
- data/docs/TokensResponse.md +9 -0
- data/docs/TokensResponseEntry.md +6 -0
- data/docs/UpdateAppInfo.md +12 -12
- data/docs/UpdatePlanResponse.md +9 -0
- data/docs/UpdatePlanResponseDto.md +7 -0
- data/docs/UpdatePlanResponseEntry.md +6 -0
- data/docs/UpdateSubscriptionDto.md +6 -0
- data/docs/UpdateTokenDto.md +7 -0
- data/docs/UsageDto.md +16 -0
- data/docs/UsageMultiResponse.md +9 -0
- data/docs/UsageMultiResponseEntry.md +6 -0
- data/docs/UsageResponse.md +9 -0
- data/docs/UsageResponseEntry.md +6 -0
- data/docs/UserInfo.md +4 -4
- data/docs/UserPermissions.md +6 -6
- data/docs/UserRole.md +6 -6
- data/lib/SematextCloud/api/apps_api.rb +52 -0
- data/lib/SematextCloud/api/subscriptions_api.rb +463 -17
- data/lib/SematextCloud/api/tokens_api_controller_api.rb +313 -0
- data/lib/SematextCloud/models/create_token_dto.rb +201 -0
- data/lib/SematextCloud/models/subscription_dashboard_dto.rb +319 -0
- data/lib/SematextCloud/models/subscription_dto.rb +328 -0
- data/lib/SematextCloud/models/update_subscription_dto.rb +183 -0
- data/lib/SematextCloud/models/update_token_dto.rb +192 -0
- data/lib/SematextCloud/version.rb +1 -1
- data/lib/stcloud.rb +128 -0
- data/lib/stcloud/api/alert_notifications_api.rb +142 -0
- data/lib/stcloud/api/alerts_api.rb +292 -0
- data/lib/stcloud/api/apps_api.rb +452 -0
- data/lib/stcloud/api/aws_settings_controller_api.rb +84 -0
- data/lib/stcloud/api/billing_api.rb +202 -0
- data/lib/stcloud/api/logs_app_api.rb +76 -0
- data/lib/stcloud/api/logs_usage_api_controller_api.rb +86 -0
- data/lib/stcloud/api/monitoring_app_api.rb +76 -0
- data/lib/stcloud/api/reset_password_api.rb +76 -0
- data/lib/stcloud/api/subscriptions_api.rb +610 -0
- data/lib/stcloud/api/tag_api_controller_api.rb +250 -0
- data/lib/stcloud/api/tokens_api_controller_api.rb +324 -0
- data/lib/stcloud/api_client.rb +388 -0
- data/lib/stcloud/api_error.rb +57 -0
- data/lib/stcloud/configuration.rb +205 -0
- data/lib/stcloud/models/alert_notification.rb +260 -0
- data/lib/stcloud/models/alert_notification_request.rb +235 -0
- data/lib/stcloud/models/alert_rule.rb +675 -0
- data/lib/stcloud/models/alert_rule_response.rb +235 -0
- data/lib/stcloud/models/alert_rule_response_entry.rb +206 -0
- data/lib/stcloud/models/alert_rule_schedule_time_range_dto.rb +215 -0
- data/lib/stcloud/models/alert_rule_schedule_weekday_dto.rb +244 -0
- data/lib/stcloud/models/alert_rules_response.rb +235 -0
- data/lib/stcloud/models/alert_rules_response_entry.rb +208 -0
- data/lib/stcloud/models/app.rb +489 -0
- data/lib/stcloud/models/app_description.rb +206 -0
- data/lib/stcloud/models/app_metadata.rb +291 -0
- data/lib/stcloud/models/app_response.rb +235 -0
- data/lib/stcloud/models/app_response_entry.rb +206 -0
- data/lib/stcloud/models/app_types_response.rb +235 -0
- data/lib/stcloud/models/app_types_response_entry.rb +208 -0
- data/lib/stcloud/models/apps_response.rb +235 -0
- data/lib/stcloud/models/apps_response_entry.rb +208 -0
- data/lib/stcloud/models/basic_auth_method_dto.rb +249 -0
- data/lib/stcloud/models/basic_organization_dto.rb +269 -0
- data/lib/stcloud/models/billing_info.rb +224 -0
- data/lib/stcloud/models/charges_details_response_dto.rb +298 -0
- data/lib/stcloud/models/cloud_watch_settings.rb +279 -0
- data/lib/stcloud/models/cloud_watch_settings_response.rb +235 -0
- data/lib/stcloud/models/cloud_watch_settings_response_entry.rb +206 -0
- data/lib/stcloud/models/create_app_info.rb +242 -0
- data/lib/stcloud/models/create_token_dto.rb +224 -0
- data/lib/stcloud/models/daily_dto.rb +233 -0
- data/lib/stcloud/models/day_usage_data.rb +411 -0
- data/lib/stcloud/models/dimension.rb +227 -0
- data/lib/stcloud/models/error.rb +215 -0
- data/lib/stcloud/models/event_dto.rb +258 -0
- data/lib/stcloud/models/filter_value.rb +253 -0
- data/lib/stcloud/models/generic_api_response.rb +236 -0
- data/lib/stcloud/models/generic_map_based_api_response.rb +236 -0
- data/lib/stcloud/models/invitation.rb +348 -0
- data/lib/stcloud/models/invoice.rb +253 -0
- data/lib/stcloud/models/invoice_response.rb +235 -0
- data/lib/stcloud/models/invoice_response_entry.rb +206 -0
- data/lib/stcloud/models/limit_change_event_dto.rb +224 -0
- data/lib/stcloud/models/mail_report_response.rb +235 -0
- data/lib/stcloud/models/mail_report_response_response_entry.rb +206 -0
- data/lib/stcloud/models/min_period_fee_period.rb +296 -0
- data/lib/stcloud/models/notification_integration.rb +347 -0
- data/lib/stcloud/models/notifications_response.rb +235 -0
- data/lib/stcloud/models/notifications_response_entry.rb +226 -0
- data/lib/stcloud/models/plan.rb +360 -0
- data/lib/stcloud/models/plans_response.rb +235 -0
- data/lib/stcloud/models/plans_response_entry.rb +208 -0
- data/lib/stcloud/models/report_info.rb +270 -0
- data/lib/stcloud/models/service_integration.rb +305 -0
- data/lib/stcloud/models/subscription.rb +378 -0
- data/lib/stcloud/models/subscription_dashboard_dto.rb +342 -0
- data/lib/stcloud/models/subscription_dto.rb +351 -0
- data/lib/stcloud/models/subscription_response.rb +235 -0
- data/lib/stcloud/models/subscription_response_entry.rb +206 -0
- data/lib/stcloud/models/subscriptions_response.rb +235 -0
- data/lib/stcloud/models/subscriptions_response_entry.rb +208 -0
- data/lib/stcloud/models/tag_names_response.rb +213 -0
- data/lib/stcloud/models/token_dto.rb +260 -0
- data/lib/stcloud/models/token_response.rb +235 -0
- data/lib/stcloud/models/token_response_entry.rb +206 -0
- data/lib/stcloud/models/tokens_response.rb +235 -0
- data/lib/stcloud/models/tokens_response_entry.rb +208 -0
- data/lib/stcloud/models/update_app_info.rb +312 -0
- data/lib/stcloud/models/update_plan_response.rb +235 -0
- data/lib/stcloud/models/update_plan_response_dto.rb +217 -0
- data/lib/stcloud/models/update_plan_response_entry.rb +206 -0
- data/lib/stcloud/models/update_subscription_dto.rb +206 -0
- data/lib/stcloud/models/update_token_dto.rb +215 -0
- data/lib/stcloud/models/usage_dto.rb +302 -0
- data/lib/stcloud/models/usage_multi_response.rb +235 -0
- data/lib/stcloud/models/usage_multi_response_entry.rb +206 -0
- data/lib/stcloud/models/usage_response.rb +235 -0
- data/lib/stcloud/models/usage_response_entry.rb +206 -0
- data/lib/stcloud/models/user_info.rb +206 -0
- data/lib/stcloud/models/user_permissions.rb +224 -0
- data/lib/stcloud/models/user_role.rb +270 -0
- data/lib/stcloud/version.rb +14 -0
- data/spec/api/alert_notifications_api_spec.rb +12 -13
- data/spec/api/alerts_api_spec.rb +10 -11
- data/spec/api/apps_api_spec.rb +31 -21
- data/spec/api/aws_settings_controller_api_spec.rb +9 -10
- data/spec/api/billing_api_spec.rb +12 -13
- data/spec/api/logs_app_api_spec.rb +6 -7
- data/spec/api/logs_usage_api_controller_api_spec.rb +47 -0
- data/spec/api/monitoring_app_api_spec.rb +6 -7
- data/spec/api/reset_password_api_spec.rb +6 -7
- data/spec/api/subscriptions_api_spec.rb +106 -14
- data/spec/api/tag_api_controller_api_spec.rb +11 -12
- data/spec/api/tokens_api_controller_api_spec.rb +94 -0
- data/spec/api_client_spec.rb +30 -31
- data/spec/base_object_spec.rb +109 -0
- data/spec/configuration_spec.rb +7 -8
- data/spec/models/alert_notification_request_spec.rb +1 -2
- data/spec/models/alert_notification_spec.rb +76 -0
- data/spec/models/alert_rule_response_entry_spec.rb +40 -0
- data/spec/models/alert_rule_response_spec.rb +58 -0
- data/spec/models/alert_rule_schedule_time_range_dto_spec.rb +1 -2
- data/spec/models/alert_rule_schedule_weekday_dto_spec.rb +1 -2
- data/spec/models/alert_rule_spec.rb +1 -2
- data/spec/models/alert_rules_response_entry_spec.rb +40 -0
- data/spec/models/alert_rules_response_spec.rb +58 -0
- data/spec/models/app_description_spec.rb +1 -2
- data/spec/models/app_metadata_spec.rb +1 -2
- data/spec/models/app_response_entry_spec.rb +40 -0
- data/spec/models/app_response_spec.rb +58 -0
- data/spec/models/app_spec.rb +31 -2
- data/spec/models/app_types_response_entry_spec.rb +40 -0
- data/spec/models/app_types_response_spec.rb +58 -0
- data/spec/models/apps_response_entry_spec.rb +40 -0
- data/spec/models/apps_response_spec.rb +58 -0
- data/spec/models/basic_auth_method_dto_spec.rb +1 -2
- data/spec/models/basic_organization_dto_spec.rb +1 -2
- data/spec/models/billing_info_spec.rb +1 -2
- data/spec/models/charges_details_response_dto_spec.rb +80 -0
- data/spec/models/cloud_watch_settings_response_entry_spec.rb +40 -0
- data/spec/models/cloud_watch_settings_response_spec.rb +58 -0
- data/spec/models/cloud_watch_settings_spec.rb +1 -2
- data/spec/models/create_app_info_spec.rb +1 -2
- data/spec/models/create_token_dto_spec.rb +52 -0
- data/spec/models/daily_dto_spec.rb +58 -0
- data/spec/models/day_usage_data_spec.rb +158 -0
- data/spec/models/dimension_spec.rb +46 -0
- data/spec/models/error_spec.rb +1 -2
- data/spec/models/event_dto_spec.rb +56 -0
- data/spec/models/filter_value_spec.rb +1 -2
- data/spec/models/generic_api_response_spec.rb +1 -2
- data/spec/models/generic_map_based_api_response_spec.rb +58 -0
- data/spec/models/invitation_spec.rb +1 -2
- data/spec/models/invoice_response_entry_spec.rb +40 -0
- data/spec/models/invoice_response_spec.rb +58 -0
- data/spec/models/invoice_spec.rb +70 -0
- data/spec/models/limit_change_event_dto_spec.rb +52 -0
- data/spec/models/mail_report_response_response_entry_spec.rb +40 -0
- data/spec/models/mail_report_response_spec.rb +58 -0
- data/spec/models/min_period_fee_period_spec.rb +100 -0
- data/spec/models/notification_integration_spec.rb +1 -2
- data/spec/models/notifications_response_entry_spec.rb +52 -0
- data/spec/models/notifications_response_spec.rb +58 -0
- data/spec/models/plan_spec.rb +2 -3
- data/spec/models/plans_response_entry_spec.rb +40 -0
- data/spec/models/plans_response_spec.rb +58 -0
- data/spec/models/report_info_spec.rb +1 -2
- data/spec/models/service_integration_spec.rb +1 -2
- data/spec/models/subscription_dashboard_dto_spec.rb +108 -0
- data/spec/models/subscription_dto_spec.rb +114 -0
- data/spec/models/subscription_response_entry_spec.rb +40 -0
- data/spec/models/subscription_response_spec.rb +58 -0
- data/spec/models/subscription_spec.rb +132 -0
- data/spec/models/subscriptions_response_entry_spec.rb +40 -0
- data/spec/models/subscriptions_response_spec.rb +58 -0
- data/spec/models/tag_names_response_spec.rb +40 -0
- data/spec/models/token_dto_spec.rb +76 -0
- data/spec/models/token_response_entry_spec.rb +40 -0
- data/spec/models/token_response_spec.rb +58 -0
- data/spec/models/tokens_response_entry_spec.rb +40 -0
- data/spec/models/tokens_response_spec.rb +58 -0
- data/spec/models/update_app_info_spec.rb +1 -2
- data/spec/models/update_plan_response_dto_spec.rb +46 -0
- data/spec/models/update_plan_response_entry_spec.rb +40 -0
- data/spec/models/update_plan_response_spec.rb +58 -0
- data/spec/models/update_subscription_dto_spec.rb +40 -0
- data/spec/models/update_token_dto_spec.rb +46 -0
- data/spec/models/usage_dto_spec.rb +100 -0
- data/spec/models/usage_multi_response_entry_spec.rb +40 -0
- data/spec/models/usage_multi_response_spec.rb +58 -0
- data/spec/models/usage_response_entry_spec.rb +40 -0
- data/spec/models/usage_response_spec.rb +58 -0
- data/spec/models/user_info_spec.rb +1 -2
- data/spec/models/user_permissions_spec.rb +1 -2
- data/spec/models/user_role_spec.rb +1 -2
- data/spec/spec_helper.rb +2 -3
- metadata +300 -150
- data/assets/octi-blue.png +0 -0
@@ -0,0 +1,9 @@
|
|
1
|
+
# stcloud::SubscriptionsResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
| Name | Type | Description | Notes |
|
5
|
+
| ----------- | --------------------------------------------------------------- | ----------- | ---------- |
|
6
|
+
| **data** | [**SubscriptionsResponseEntry**](SubscriptionsResponseEntry.md) | | [optional] |
|
7
|
+
| **errors** | [**Array<Error>**](Error.md) | | [optional] |
|
8
|
+
| **message** | **String** | | [optional] |
|
9
|
+
| **success** | **BOOLEAN** | | [optional] |
|
@@ -0,0 +1,6 @@
|
|
1
|
+
# stcloud::SubscriptionsResponseEntry
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
| Name | Type | Description | Notes |
|
5
|
+
| ----------------- | ------------------------------------------------ | ----------- | ---------- |
|
6
|
+
| **subscriptions** | [**Array<Subscription>**](Subscription.md) | | [optional] |
|
data/docs/TagApiControllerApi.md
CHANGED
@@ -1,35 +1,32 @@
|
|
1
|
-
#
|
1
|
+
# stcloud::TagApiControllerApi
|
2
2
|
|
3
|
-
All URIs are relative to
|
4
|
-
|
5
|
-
Method | HTTP request | Description
|
6
|
-
------------- | ------------- | -------------
|
7
|
-
[**get_tag_names_using_get**](TagApiControllerApi.md#get_tag_names_using_get) | **GET** /spm-reports/api/v3/apps/{appIds}/tagNames | Gets tag names for the given application identifiers appearing in the given time frame.
|
8
|
-
[**get_using_get1**](TagApiControllerApi.md#get_using_get1) | **GET** /spm-reports/api/v3/apps/{appIds}/tags | Gets values for specified tags for the given application identifiers appearing in the given time frame.
|
9
|
-
[**get_using_get2**](TagApiControllerApi.md#get_using_get2) | **GET** /spm-reports/api/v3/apps/{appIds}/metrics/filters | Gets values for specified tags for the given application identifiers appearing in the given time frame.
|
3
|
+
All URIs are relative to */*
|
10
4
|
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ----------------------------------------------------------------------------- | --------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
|
7
|
+
| [**get_tag_names_using_get**](TagApiControllerApi.md#get_tag_names_using_get) | **GET** /spm-reports/api/v3/apps/{appIds}/tagNames | Gets tag names for the given application identifiers appearing in the given time frame. |
|
8
|
+
| [**get_using_get2**](TagApiControllerApi.md#get_using_get2) | **GET** /spm-reports/api/v3/apps/{appIds}/metrics/filters | Gets values for specified tags for the given application identifiers appearing in the given time frame. |
|
9
|
+
| [**get_using_get3**](TagApiControllerApi.md#get_using_get3) | **GET** /spm-reports/api/v3/apps/{appIds}/tags | Gets values for specified tags for the given application identifiers appearing in the given time frame. |
|
11
10
|
|
12
11
|
# **get_tag_names_using_get**
|
13
|
-
>
|
12
|
+
> TagNamesResponse get_tag_names_using_get(app_ids, opts)
|
14
13
|
|
15
14
|
Gets tag names for the given application identifiers appearing in the given time frame.
|
16
15
|
|
17
16
|
### Example
|
18
17
|
```ruby
|
19
18
|
# load the gem
|
20
|
-
require '
|
19
|
+
require 'stcloud'
|
21
20
|
# setup authorization
|
22
|
-
|
21
|
+
stcloud.configure do |config|
|
23
22
|
# Configure API key authorization: api_key
|
24
23
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
25
24
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
26
25
|
#config.api_key_prefix['Authorization'] = 'Bearer'
|
27
26
|
end
|
28
27
|
|
29
|
-
api_instance =
|
30
|
-
|
28
|
+
api_instance = stcloud::TagApiControllerApi.new
|
31
29
|
app_ids = 'app_ids_example' # String | appIds
|
32
|
-
|
33
30
|
opts = {
|
34
31
|
from: 789, # Integer | from
|
35
32
|
to: 789, # Integer | to
|
@@ -43,26 +40,26 @@ begin
|
|
43
40
|
#Gets tag names for the given application identifiers appearing in the given time frame.
|
44
41
|
result = api_instance.get_tag_names_using_get(app_ids, opts)
|
45
42
|
p result
|
46
|
-
rescue
|
43
|
+
rescue stcloud::ApiError => e
|
47
44
|
puts "Exception when calling TagApiControllerApi->get_tag_names_using_get: #{e}"
|
48
45
|
end
|
49
46
|
```
|
50
47
|
|
51
48
|
### Parameters
|
52
49
|
|
53
|
-
Name
|
54
|
-
|
55
|
-
**app_ids** | **String
|
56
|
-
**from**
|
57
|
-
**to**
|
58
|
-
**metrics** | **BOOLEAN
|
59
|
-
**logs**
|
60
|
-
**events**
|
61
|
-
**rum**
|
50
|
+
| Name | Type | Description | Notes |
|
51
|
+
| ----------- | ----------- | ----------- | ----------------------------- |
|
52
|
+
| **app_ids** | **String** | appIds |
|
53
|
+
| **from** | **Integer** | from | [optional] |
|
54
|
+
| **to** | **Integer** | to | [optional] |
|
55
|
+
| **metrics** | **BOOLEAN** | metrics | [optional] [default to true] |
|
56
|
+
| **logs** | **BOOLEAN** | logs | [optional] [default to true] |
|
57
|
+
| **events** | **BOOLEAN** | events | [optional] [default to false] |
|
58
|
+
| **rum** | **BOOLEAN** | rum | [optional] [default to true] |
|
62
59
|
|
63
60
|
### Return type
|
64
61
|
|
65
|
-
**
|
62
|
+
[**TagNamesResponse**](TagNamesResponse.md)
|
66
63
|
|
67
64
|
### Authorization
|
68
65
|
|
@@ -70,34 +67,31 @@ Name | Type | Description | Notes
|
|
70
67
|
|
71
68
|
### HTTP request headers
|
72
69
|
|
73
|
-
- **Content-Type**:
|
70
|
+
- **Content-Type**: Not defined
|
74
71
|
- **Accept**: application/json
|
75
72
|
|
76
73
|
|
77
74
|
|
78
|
-
# **
|
79
|
-
>
|
75
|
+
# **get_using_get2**
|
76
|
+
> Hash<String, Dimension> get_using_get2(app_ids, tag, opts)
|
80
77
|
|
81
78
|
Gets values for specified tags for the given application identifiers appearing in the given time frame.
|
82
79
|
|
83
80
|
### Example
|
84
81
|
```ruby
|
85
82
|
# load the gem
|
86
|
-
require '
|
83
|
+
require 'stcloud'
|
87
84
|
# setup authorization
|
88
|
-
|
85
|
+
stcloud.configure do |config|
|
89
86
|
# Configure API key authorization: api_key
|
90
87
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
91
88
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
92
89
|
#config.api_key_prefix['Authorization'] = 'Bearer'
|
93
90
|
end
|
94
91
|
|
95
|
-
api_instance =
|
96
|
-
|
92
|
+
api_instance = stcloud::TagApiControllerApi.new
|
97
93
|
app_ids = 'app_ids_example' # String | appIds
|
98
|
-
|
99
94
|
tag = ['tag_example'] # Array<String> | tag
|
100
|
-
|
101
95
|
opts = {
|
102
96
|
from: 789, # Integer | from
|
103
97
|
to: 789, # Integer | to
|
@@ -109,29 +103,29 @@ opts = {
|
|
109
103
|
|
110
104
|
begin
|
111
105
|
#Gets values for specified tags for the given application identifiers appearing in the given time frame.
|
112
|
-
result = api_instance.
|
106
|
+
result = api_instance.get_using_get2(app_ids, tag, opts)
|
113
107
|
p result
|
114
|
-
rescue
|
115
|
-
puts "Exception when calling TagApiControllerApi->
|
108
|
+
rescue stcloud::ApiError => e
|
109
|
+
puts "Exception when calling TagApiControllerApi->get_using_get2: #{e}"
|
116
110
|
end
|
117
111
|
```
|
118
112
|
|
119
113
|
### Parameters
|
120
114
|
|
121
|
-
Name
|
122
|
-
|
123
|
-
**app_ids** | **String
|
124
|
-
**tag**
|
125
|
-
**from**
|
126
|
-
**to**
|
127
|
-
**metrics** | **BOOLEAN
|
128
|
-
**logs**
|
129
|
-
**events**
|
130
|
-
**rum**
|
115
|
+
| Name | Type | Description | Notes |
|
116
|
+
| ----------- | ------------------------------------ | ----------- | ----------------------------- |
|
117
|
+
| **app_ids** | **String** | appIds |
|
118
|
+
| **tag** | [**Array<String>**](String.md) | tag |
|
119
|
+
| **from** | **Integer** | from | [optional] |
|
120
|
+
| **to** | **Integer** | to | [optional] |
|
121
|
+
| **metrics** | **BOOLEAN** | metrics | [optional] [default to true] |
|
122
|
+
| **logs** | **BOOLEAN** | logs | [optional] [default to true] |
|
123
|
+
| **events** | **BOOLEAN** | events | [optional] [default to false] |
|
124
|
+
| **rum** | **BOOLEAN** | rum | [optional] [default to true] |
|
131
125
|
|
132
126
|
### Return type
|
133
127
|
|
134
|
-
**
|
128
|
+
[**Hash<String, Dimension>**](Dimension.md)
|
135
129
|
|
136
130
|
### Authorization
|
137
131
|
|
@@ -139,34 +133,31 @@ Name | Type | Description | Notes
|
|
139
133
|
|
140
134
|
### HTTP request headers
|
141
135
|
|
142
|
-
- **Content-Type**:
|
136
|
+
- **Content-Type**: Not defined
|
143
137
|
- **Accept**: application/json
|
144
138
|
|
145
139
|
|
146
140
|
|
147
|
-
# **
|
148
|
-
>
|
141
|
+
# **get_using_get3**
|
142
|
+
> Hash<String, Dimension> get_using_get3(app_ids, tag, opts)
|
149
143
|
|
150
144
|
Gets values for specified tags for the given application identifiers appearing in the given time frame.
|
151
145
|
|
152
146
|
### Example
|
153
147
|
```ruby
|
154
148
|
# load the gem
|
155
|
-
require '
|
149
|
+
require 'stcloud'
|
156
150
|
# setup authorization
|
157
|
-
|
151
|
+
stcloud.configure do |config|
|
158
152
|
# Configure API key authorization: api_key
|
159
153
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
160
154
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
161
155
|
#config.api_key_prefix['Authorization'] = 'Bearer'
|
162
156
|
end
|
163
157
|
|
164
|
-
api_instance =
|
165
|
-
|
158
|
+
api_instance = stcloud::TagApiControllerApi.new
|
166
159
|
app_ids = 'app_ids_example' # String | appIds
|
167
|
-
|
168
160
|
tag = ['tag_example'] # Array<String> | tag
|
169
|
-
|
170
161
|
opts = {
|
171
162
|
from: 789, # Integer | from
|
172
163
|
to: 789, # Integer | to
|
@@ -178,29 +169,29 @@ opts = {
|
|
178
169
|
|
179
170
|
begin
|
180
171
|
#Gets values for specified tags for the given application identifiers appearing in the given time frame.
|
181
|
-
result = api_instance.
|
172
|
+
result = api_instance.get_using_get3(app_ids, tag, opts)
|
182
173
|
p result
|
183
|
-
rescue
|
184
|
-
puts "Exception when calling TagApiControllerApi->
|
174
|
+
rescue stcloud::ApiError => e
|
175
|
+
puts "Exception when calling TagApiControllerApi->get_using_get3: #{e}"
|
185
176
|
end
|
186
177
|
```
|
187
178
|
|
188
179
|
### Parameters
|
189
180
|
|
190
|
-
Name
|
191
|
-
|
192
|
-
**app_ids** | **String
|
193
|
-
**tag**
|
194
|
-
**from**
|
195
|
-
**to**
|
196
|
-
**metrics** | **BOOLEAN
|
197
|
-
**logs**
|
198
|
-
**events**
|
199
|
-
**rum**
|
181
|
+
| Name | Type | Description | Notes |
|
182
|
+
| ----------- | ------------------------------------ | ----------- | ----------------------------- |
|
183
|
+
| **app_ids** | **String** | appIds |
|
184
|
+
| **tag** | [**Array<String>**](String.md) | tag |
|
185
|
+
| **from** | **Integer** | from | [optional] |
|
186
|
+
| **to** | **Integer** | to | [optional] |
|
187
|
+
| **metrics** | **BOOLEAN** | metrics | [optional] [default to true] |
|
188
|
+
| **logs** | **BOOLEAN** | logs | [optional] [default to true] |
|
189
|
+
| **events** | **BOOLEAN** | events | [optional] [default to false] |
|
190
|
+
| **rum** | **BOOLEAN** | rum | [optional] [default to true] |
|
200
191
|
|
201
192
|
### Return type
|
202
193
|
|
203
|
-
**
|
194
|
+
[**Hash<String, Dimension>**](Dimension.md)
|
204
195
|
|
205
196
|
### Authorization
|
206
197
|
|
@@ -208,5 +199,5 @@ Name | Type | Description | Notes
|
|
208
199
|
|
209
200
|
### HTTP request headers
|
210
201
|
|
211
|
-
- **Content-Type**:
|
202
|
+
- **Content-Type**: Not defined
|
212
203
|
- **Accept**: application/json
|
data/docs/TokenDto.md
ADDED
@@ -0,0 +1,12 @@
|
|
1
|
+
# stcloud::TokenDto
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
| Name | Type | Description | Notes |
|
5
|
+
| -------------- | ------------ | ----------- | ---------- |
|
6
|
+
| **created_at** | **DateTime** | | [optional] |
|
7
|
+
| **enabled** | **BOOLEAN** | | [optional] |
|
8
|
+
| **id** | **Integer** | | [optional] |
|
9
|
+
| **name** | **String** | | [optional] |
|
10
|
+
| **readable** | **BOOLEAN** | | [optional] |
|
11
|
+
| **token** | **String** | | [optional] |
|
12
|
+
| **writeable** | **BOOLEAN** | | [optional] |
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# stcloud::TokenResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
| Name | Type | Description | Notes |
|
5
|
+
| ----------- | ----------------------------------------------- | ----------- | ---------- |
|
6
|
+
| **data** | [**TokenResponseEntry**](TokenResponseEntry.md) | | [optional] |
|
7
|
+
| **errors** | [**Array<Error>**](Error.md) | | [optional] |
|
8
|
+
| **message** | **String** | | [optional] |
|
9
|
+
| **success** | **BOOLEAN** | | [optional] |
|
@@ -0,0 +1,274 @@
|
|
1
|
+
# stcloud::TokensApiControllerApi
|
2
|
+
|
3
|
+
All URIs are relative to */*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| -------------------------------------------------------------------------- | ------------------------------------------------------------------- | ----------------------------------------- |
|
7
|
+
| [**create_app_token1**](TokensApiControllerApi.md#create_app_token1) | **POST** /users-web/api/v3/apps/{appId}/tokens | Create new app token |
|
8
|
+
| [**delete_app_token**](TokensApiControllerApi.md#delete_app_token) | **DELETE** /users-web/api/v3/apps/{appId}/tokens/{tokenId} | Delete app token |
|
9
|
+
| [**get_app_tokens1**](TokensApiControllerApi.md#get_app_tokens1) | **GET** /users-web/api/v3/apps/{appId}/tokens | Get app available tokens |
|
10
|
+
| [**regenerate_app_token**](TokensApiControllerApi.md#regenerate_app_token) | **POST** /users-web/api/v3/apps/{appId}/tokens/{tokenId}/regenerate | Regenerate app token) |
|
11
|
+
| [**update_app_token**](TokensApiControllerApi.md#update_app_token) | **PUT** /users-web/api/v3/apps/{appId}/tokens/{tokenId} | Update app token (enable/disable or name) |
|
12
|
+
|
13
|
+
# **create_app_token1**
|
14
|
+
> TokenResponse create_app_token1(bodyapp_id)
|
15
|
+
|
16
|
+
Create new app token
|
17
|
+
|
18
|
+
### Example
|
19
|
+
```ruby
|
20
|
+
# load the gem
|
21
|
+
require 'stcloud'
|
22
|
+
# setup authorization
|
23
|
+
stcloud.configure do |config|
|
24
|
+
# Configure API key authorization: api_key
|
25
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
26
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
27
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
28
|
+
end
|
29
|
+
|
30
|
+
api_instance = stcloud::TokensApiControllerApi.new
|
31
|
+
body = stcloud::CreateTokenDto.new # CreateTokenDto | dto
|
32
|
+
app_id = 789 # Integer | appId
|
33
|
+
|
34
|
+
|
35
|
+
begin
|
36
|
+
#Create new app token
|
37
|
+
result = api_instance.create_app_token1(bodyapp_id)
|
38
|
+
p result
|
39
|
+
rescue stcloud::ApiError => e
|
40
|
+
puts "Exception when calling TokensApiControllerApi->create_app_token1: #{e}"
|
41
|
+
end
|
42
|
+
```
|
43
|
+
|
44
|
+
### Parameters
|
45
|
+
|
46
|
+
| Name | Type | Description | Notes |
|
47
|
+
| ---------- | --------------------------------------- | ----------- | ----- |
|
48
|
+
| **body** | [**CreateTokenDto**](CreateTokenDto.md) | dto |
|
49
|
+
| **app_id** | **Integer** | appId |
|
50
|
+
|
51
|
+
### Return type
|
52
|
+
|
53
|
+
[**TokenResponse**](TokenResponse.md)
|
54
|
+
|
55
|
+
### Authorization
|
56
|
+
|
57
|
+
[api_key](../README.md#api_key)
|
58
|
+
|
59
|
+
### HTTP request headers
|
60
|
+
|
61
|
+
- **Content-Type**: application/json
|
62
|
+
- **Accept**: application/json
|
63
|
+
|
64
|
+
|
65
|
+
|
66
|
+
# **delete_app_token**
|
67
|
+
> GenericMapBasedApiResponse delete_app_token(app_id, token_id)
|
68
|
+
|
69
|
+
Delete app token
|
70
|
+
|
71
|
+
### Example
|
72
|
+
```ruby
|
73
|
+
# load the gem
|
74
|
+
require 'stcloud'
|
75
|
+
# setup authorization
|
76
|
+
stcloud.configure do |config|
|
77
|
+
# Configure API key authorization: api_key
|
78
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
79
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
80
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
81
|
+
end
|
82
|
+
|
83
|
+
api_instance = stcloud::TokensApiControllerApi.new
|
84
|
+
app_id = 789 # Integer | appId
|
85
|
+
token_id = 789 # Integer | tokenId
|
86
|
+
|
87
|
+
|
88
|
+
begin
|
89
|
+
#Delete app token
|
90
|
+
result = api_instance.delete_app_token(app_id, token_id)
|
91
|
+
p result
|
92
|
+
rescue stcloud::ApiError => e
|
93
|
+
puts "Exception when calling TokensApiControllerApi->delete_app_token: #{e}"
|
94
|
+
end
|
95
|
+
```
|
96
|
+
|
97
|
+
### Parameters
|
98
|
+
|
99
|
+
| Name | Type | Description | Notes |
|
100
|
+
| ------------ | ----------- | ----------- | ----- |
|
101
|
+
| **app_id** | **Integer** | appId |
|
102
|
+
| **token_id** | **Integer** | tokenId |
|
103
|
+
|
104
|
+
### Return type
|
105
|
+
|
106
|
+
[**GenericMapBasedApiResponse**](GenericMapBasedApiResponse.md)
|
107
|
+
|
108
|
+
### Authorization
|
109
|
+
|
110
|
+
[api_key](../README.md#api_key)
|
111
|
+
|
112
|
+
### HTTP request headers
|
113
|
+
|
114
|
+
- **Content-Type**: Not defined
|
115
|
+
- **Accept**: application/json
|
116
|
+
|
117
|
+
|
118
|
+
|
119
|
+
# **get_app_tokens1**
|
120
|
+
> TokensResponse get_app_tokens1(app_id)
|
121
|
+
|
122
|
+
Get app available tokens
|
123
|
+
|
124
|
+
### Example
|
125
|
+
```ruby
|
126
|
+
# load the gem
|
127
|
+
require 'stcloud'
|
128
|
+
# setup authorization
|
129
|
+
stcloud.configure do |config|
|
130
|
+
# Configure API key authorization: api_key
|
131
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
132
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
133
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
134
|
+
end
|
135
|
+
|
136
|
+
api_instance = stcloud::TokensApiControllerApi.new
|
137
|
+
app_id = 789 # Integer | appId
|
138
|
+
|
139
|
+
|
140
|
+
begin
|
141
|
+
#Get app available tokens
|
142
|
+
result = api_instance.get_app_tokens1(app_id)
|
143
|
+
p result
|
144
|
+
rescue stcloud::ApiError => e
|
145
|
+
puts "Exception when calling TokensApiControllerApi->get_app_tokens1: #{e}"
|
146
|
+
end
|
147
|
+
```
|
148
|
+
|
149
|
+
### Parameters
|
150
|
+
|
151
|
+
| Name | Type | Description | Notes |
|
152
|
+
| ---------- | ----------- | ----------- | ----- |
|
153
|
+
| **app_id** | **Integer** | appId |
|
154
|
+
|
155
|
+
### Return type
|
156
|
+
|
157
|
+
[**TokensResponse**](TokensResponse.md)
|
158
|
+
|
159
|
+
### Authorization
|
160
|
+
|
161
|
+
[api_key](../README.md#api_key)
|
162
|
+
|
163
|
+
### HTTP request headers
|
164
|
+
|
165
|
+
- **Content-Type**: Not defined
|
166
|
+
- **Accept**: application/json
|
167
|
+
|
168
|
+
|
169
|
+
|
170
|
+
# **regenerate_app_token**
|
171
|
+
> TokenResponse regenerate_app_token(app_id, token_id)
|
172
|
+
|
173
|
+
Regenerate app token)
|
174
|
+
|
175
|
+
### Example
|
176
|
+
```ruby
|
177
|
+
# load the gem
|
178
|
+
require 'stcloud'
|
179
|
+
# setup authorization
|
180
|
+
stcloud.configure do |config|
|
181
|
+
# Configure API key authorization: api_key
|
182
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
183
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
184
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
185
|
+
end
|
186
|
+
|
187
|
+
api_instance = stcloud::TokensApiControllerApi.new
|
188
|
+
app_id = 789 # Integer | appId
|
189
|
+
token_id = 789 # Integer | tokenId
|
190
|
+
|
191
|
+
|
192
|
+
begin
|
193
|
+
#Regenerate app token)
|
194
|
+
result = api_instance.regenerate_app_token(app_id, token_id)
|
195
|
+
p result
|
196
|
+
rescue stcloud::ApiError => e
|
197
|
+
puts "Exception when calling TokensApiControllerApi->regenerate_app_token: #{e}"
|
198
|
+
end
|
199
|
+
```
|
200
|
+
|
201
|
+
### Parameters
|
202
|
+
|
203
|
+
| Name | Type | Description | Notes |
|
204
|
+
| ------------ | ----------- | ----------- | ----- |
|
205
|
+
| **app_id** | **Integer** | appId |
|
206
|
+
| **token_id** | **Integer** | tokenId |
|
207
|
+
|
208
|
+
### Return type
|
209
|
+
|
210
|
+
[**TokenResponse**](TokenResponse.md)
|
211
|
+
|
212
|
+
### Authorization
|
213
|
+
|
214
|
+
[api_key](../README.md#api_key)
|
215
|
+
|
216
|
+
### HTTP request headers
|
217
|
+
|
218
|
+
- **Content-Type**: Not defined
|
219
|
+
- **Accept**: application/json
|
220
|
+
|
221
|
+
|
222
|
+
|
223
|
+
# **update_app_token**
|
224
|
+
> TokenResponse update_app_token(bodyapp_idtoken_id)
|
225
|
+
|
226
|
+
Update app token (enable/disable or name)
|
227
|
+
|
228
|
+
### Example
|
229
|
+
```ruby
|
230
|
+
# load the gem
|
231
|
+
require 'stcloud'
|
232
|
+
# setup authorization
|
233
|
+
stcloud.configure do |config|
|
234
|
+
# Configure API key authorization: api_key
|
235
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
236
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
237
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
238
|
+
end
|
239
|
+
|
240
|
+
api_instance = stcloud::TokensApiControllerApi.new
|
241
|
+
body = stcloud::UpdateTokenDto.new # UpdateTokenDto | dto
|
242
|
+
app_id = 789 # Integer | appId
|
243
|
+
token_id = 789 # Integer | tokenId
|
244
|
+
|
245
|
+
|
246
|
+
begin
|
247
|
+
#Update app token (enable/disable or name)
|
248
|
+
result = api_instance.update_app_token(bodyapp_idtoken_id)
|
249
|
+
p result
|
250
|
+
rescue stcloud::ApiError => e
|
251
|
+
puts "Exception when calling TokensApiControllerApi->update_app_token: #{e}"
|
252
|
+
end
|
253
|
+
```
|
254
|
+
|
255
|
+
### Parameters
|
256
|
+
|
257
|
+
| Name | Type | Description | Notes |
|
258
|
+
| ------------ | --------------------------------------- | ----------- | ----- |
|
259
|
+
| **body** | [**UpdateTokenDto**](UpdateTokenDto.md) | dto |
|
260
|
+
| **app_id** | **Integer** | appId |
|
261
|
+
| **token_id** | **Integer** | tokenId |
|
262
|
+
|
263
|
+
### Return type
|
264
|
+
|
265
|
+
[**TokenResponse**](TokenResponse.md)
|
266
|
+
|
267
|
+
### Authorization
|
268
|
+
|
269
|
+
[api_key](../README.md#api_key)
|
270
|
+
|
271
|
+
### HTTP request headers
|
272
|
+
|
273
|
+
- **Content-Type**: application/json
|
274
|
+
- **Accept**: application/json
|