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::AppsResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
| Name | Type | Description | Notes |
|
5
|
+
| ----------- | --------------------------------------------- | ----------- | ---------- |
|
6
|
+
| **data** | [**AppsResponseEntry**](AppsResponseEntry.md) | | [optional] |
|
7
|
+
| **errors** | [**Array<Error>**](Error.md) | | [optional] |
|
8
|
+
| **message** | **String** | | [optional] |
|
9
|
+
| **success** | **BOOLEAN** | | [optional] |
|
@@ -1,14 +1,13 @@
|
|
1
|
-
#
|
1
|
+
# stcloud::AwsSettingsControllerApi
|
2
2
|
|
3
|
-
All URIs are relative to
|
3
|
+
All URIs are relative to */*
|
4
4
|
|
5
|
-
Method
|
6
|
-
|
7
|
-
[**
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ---------------------------------------------------------------------- | ------------------------------------------ | ----------------------------------------- |
|
7
|
+
| [**update_using_put1**](AwsSettingsControllerApi.md#update_using_put1) | **PUT** /users-web/api/v3/apps/{appId}/aws | Update App's AWS CloudWatch settings |
|
8
8
|
|
9
|
-
|
10
|
-
|
11
|
-
> GenericApiResponse update_using_put(app_id, dto)
|
9
|
+
# **update_using_put1**
|
10
|
+
> CloudWatchSettingsResponse update_using_put1(bodyapp_id)
|
12
11
|
|
13
12
|
Update App's AWS CloudWatch settings
|
14
13
|
|
@@ -17,41 +16,39 @@ Applicable only for AWS Apps
|
|
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::AwsSettingsControllerApi.new
|
29
|
+
body = stcloud::CloudWatchSettings.new # CloudWatchSettings | dto
|
31
30
|
app_id = 789 # Integer | appId
|
32
31
|
|
33
|
-
dto = SematextCloud::CloudWatchSettings.new # CloudWatchSettings | dto
|
34
|
-
|
35
32
|
|
36
33
|
begin
|
37
34
|
#Update App's AWS CloudWatch settings
|
38
|
-
result = api_instance.
|
35
|
+
result = api_instance.update_using_put1(bodyapp_id)
|
39
36
|
p result
|
40
|
-
rescue
|
41
|
-
puts "Exception when calling AwsSettingsControllerApi->
|
37
|
+
rescue stcloud::ApiError => e
|
38
|
+
puts "Exception when calling AwsSettingsControllerApi->update_using_put1: #{e}"
|
42
39
|
end
|
43
40
|
```
|
44
41
|
|
45
42
|
### Parameters
|
46
43
|
|
47
|
-
Name
|
48
|
-
|
49
|
-
**
|
50
|
-
**
|
44
|
+
| Name | Type | Description | Notes |
|
45
|
+
| ---------- | ----------------------------------------------- | ----------- | ----- |
|
46
|
+
| **body** | [**CloudWatchSettings**](CloudWatchSettings.md) | dto |
|
47
|
+
| **app_id** | **Integer** | appId |
|
51
48
|
|
52
49
|
### Return type
|
53
50
|
|
54
|
-
[**
|
51
|
+
[**CloudWatchSettingsResponse**](CloudWatchSettingsResponse.md)
|
55
52
|
|
56
53
|
### Authorization
|
57
54
|
|
data/docs/BasicAuthMethodDto.md
CHANGED
@@ -1,7 +1,7 @@
|
|
1
|
-
#
|
1
|
+
# stcloud::BasicAuthMethodDto
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
Name
|
5
|
-
|
6
|
-
**auth_type** | **String** |
|
7
|
-
**uuid**
|
4
|
+
| Name | Type | Description | Notes |
|
5
|
+
| ------------- | ---------- | ----------- | ---------- |
|
6
|
+
| **auth_type** | **String** | | [optional] |
|
7
|
+
| **uuid** | **String** | | [optional] |
|
@@ -1,9 +1,9 @@
|
|
1
|
-
#
|
1
|
+
# stcloud::BasicOrganizationDto
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
Name
|
5
|
-
|
6
|
-
**auth_methods** | [**Array<BasicAuthMethodDto>**](BasicAuthMethodDto.md) |
|
7
|
-
**name**
|
8
|
-
**status**
|
9
|
-
**uuid**
|
4
|
+
| Name | Type | Description | Notes |
|
5
|
+
| ---------------- | ------------------------------------------------------------ | ----------- | ---------- |
|
6
|
+
| **auth_methods** | [**Array<BasicAuthMethodDto>**](BasicAuthMethodDto.md) | | [optional] |
|
7
|
+
| **name** | **String** | | [optional] |
|
8
|
+
| **status** | **String** | | [optional] |
|
9
|
+
| **uuid** | **String** | | [optional] |
|
data/docs/BillingApi.md
CHANGED
@@ -1,37 +1,33 @@
|
|
1
|
-
#
|
1
|
+
# stcloud::BillingApi
|
2
2
|
|
3
|
-
All URIs are relative to
|
4
|
-
|
5
|
-
Method | HTTP request | Description
|
6
|
-
------------- | ------------- | -------------
|
7
|
-
[**get_detailed_invoice_using_get**](BillingApi.md#get_detailed_invoice_using_get) | **GET** /users-web/api/v3/billing/invoice/{service}/{year}/{month} | Get invoice details
|
8
|
-
[**list_available_plans_using_get**](BillingApi.md#list_available_plans_using_get) | **GET** /users-web/api/v3/billing/availablePlans | Get available plans
|
9
|
-
[**update_plan_using_put**](BillingApi.md#update_plan_using_put) | **PUT** /users-web/api/v3/billing/info/{appId} | Update plan for an app
|
3
|
+
All URIs are relative to */*
|
10
4
|
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------ | ---------------------- |
|
7
|
+
| [**get_detailed_invoice_using_get**](BillingApi.md#get_detailed_invoice_using_get) | **GET** /users-web/api/v3/billing/invoice/{service}/{year}/{month} | Get invoice details |
|
8
|
+
| [**list_available_plans_using_get1**](BillingApi.md#list_available_plans_using_get1) | **GET** /users-web/api/v3/billing/availablePlans | Get available plans |
|
9
|
+
| [**update_plan_using_put1**](BillingApi.md#update_plan_using_put1) | **PUT** /users-web/api/v3/billing/info/{appId} | Update plan for an app |
|
11
10
|
|
12
11
|
# **get_detailed_invoice_using_get**
|
13
|
-
>
|
12
|
+
> InvoiceResponse get_detailed_invoice_using_get(service, year, month)
|
14
13
|
|
15
14
|
Get invoice details
|
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::BillingApi.new
|
31
29
|
service = 'service_example' # String | service
|
32
|
-
|
33
30
|
year = 56 # Integer | year
|
34
|
-
|
35
31
|
month = 56 # Integer | month
|
36
32
|
|
37
33
|
|
@@ -39,22 +35,22 @@ begin
|
|
39
35
|
#Get invoice details
|
40
36
|
result = api_instance.get_detailed_invoice_using_get(service, year, month)
|
41
37
|
p result
|
42
|
-
rescue
|
38
|
+
rescue stcloud::ApiError => e
|
43
39
|
puts "Exception when calling BillingApi->get_detailed_invoice_using_get: #{e}"
|
44
40
|
end
|
45
41
|
```
|
46
42
|
|
47
43
|
### Parameters
|
48
44
|
|
49
|
-
Name
|
50
|
-
|
51
|
-
**service** | **String
|
52
|
-
**year**
|
53
|
-
**month**
|
45
|
+
| Name | Type | Description | Notes |
|
46
|
+
| ----------- | ----------- | ----------- | ----- |
|
47
|
+
| **service** | **String** | service |
|
48
|
+
| **year** | **Integer** | year |
|
49
|
+
| **month** | **Integer** | month |
|
54
50
|
|
55
51
|
### Return type
|
56
52
|
|
57
|
-
[**
|
53
|
+
[**InvoiceResponse**](InvoiceResponse.md)
|
58
54
|
|
59
55
|
### Authorization
|
60
56
|
|
@@ -62,30 +58,29 @@ Name | Type | Description | Notes
|
|
62
58
|
|
63
59
|
### HTTP request headers
|
64
60
|
|
65
|
-
- **Content-Type**:
|
61
|
+
- **Content-Type**: Not defined
|
66
62
|
- **Accept**: application/json
|
67
63
|
|
68
64
|
|
69
65
|
|
70
|
-
# **
|
71
|
-
>
|
66
|
+
# **list_available_plans_using_get1**
|
67
|
+
> PlansResponse list_available_plans_using_get1(opts)
|
72
68
|
|
73
69
|
Get available plans
|
74
70
|
|
75
71
|
### Example
|
76
72
|
```ruby
|
77
73
|
# load the gem
|
78
|
-
require '
|
74
|
+
require 'stcloud'
|
79
75
|
# setup authorization
|
80
|
-
|
76
|
+
stcloud.configure do |config|
|
81
77
|
# Configure API key authorization: api_key
|
82
78
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
83
79
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
84
80
|
#config.api_key_prefix['Authorization'] = 'Bearer'
|
85
81
|
end
|
86
82
|
|
87
|
-
api_instance =
|
88
|
-
|
83
|
+
api_instance = stcloud::BillingApi.new
|
89
84
|
opts = {
|
90
85
|
integration_id: 789, # Integer | integrationId
|
91
86
|
app_type: 'app_type_example' # String | appType
|
@@ -93,23 +88,23 @@ opts = {
|
|
93
88
|
|
94
89
|
begin
|
95
90
|
#Get available plans
|
96
|
-
result = api_instance.
|
91
|
+
result = api_instance.list_available_plans_using_get1(opts)
|
97
92
|
p result
|
98
|
-
rescue
|
99
|
-
puts "Exception when calling BillingApi->
|
93
|
+
rescue stcloud::ApiError => e
|
94
|
+
puts "Exception when calling BillingApi->list_available_plans_using_get1: #{e}"
|
100
95
|
end
|
101
96
|
```
|
102
97
|
|
103
98
|
### Parameters
|
104
99
|
|
105
|
-
Name
|
106
|
-
|
107
|
-
**integration_id** | **Integer
|
108
|
-
**app_type**
|
100
|
+
| Name | Type | Description | Notes |
|
101
|
+
| ------------------ | ----------- | ------------- | ---------- |
|
102
|
+
| **integration_id** | **Integer** | integrationId | [optional] |
|
103
|
+
| **app_type** | **String** | appType | [optional] |
|
109
104
|
|
110
105
|
### Return type
|
111
106
|
|
112
|
-
[**
|
107
|
+
[**PlansResponse**](PlansResponse.md)
|
113
108
|
|
114
109
|
### Authorization
|
115
110
|
|
@@ -117,54 +112,52 @@ Name | Type | Description | Notes
|
|
117
112
|
|
118
113
|
### HTTP request headers
|
119
114
|
|
120
|
-
- **Content-Type**:
|
115
|
+
- **Content-Type**: Not defined
|
121
116
|
- **Accept**: application/json
|
122
117
|
|
123
118
|
|
124
119
|
|
125
|
-
# **
|
126
|
-
>
|
120
|
+
# **update_plan_using_put1**
|
121
|
+
> UpdatePlanResponse update_plan_using_put1(bodyapp_id)
|
127
122
|
|
128
123
|
Update plan for an app
|
129
124
|
|
130
125
|
### Example
|
131
126
|
```ruby
|
132
127
|
# load the gem
|
133
|
-
require '
|
128
|
+
require 'stcloud'
|
134
129
|
# setup authorization
|
135
|
-
|
130
|
+
stcloud.configure do |config|
|
136
131
|
# Configure API key authorization: api_key
|
137
132
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
138
133
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
139
134
|
#config.api_key_prefix['Authorization'] = 'Bearer'
|
140
135
|
end
|
141
136
|
|
142
|
-
api_instance =
|
143
|
-
|
137
|
+
api_instance = stcloud::BillingApi.new
|
138
|
+
body = stcloud::BillingInfo.new # BillingInfo | dto
|
144
139
|
app_id = 789 # Integer | appId
|
145
140
|
|
146
|
-
dto = SematextCloud::BillingInfo.new # BillingInfo | dto
|
147
|
-
|
148
141
|
|
149
142
|
begin
|
150
143
|
#Update plan for an app
|
151
|
-
result = api_instance.
|
144
|
+
result = api_instance.update_plan_using_put1(bodyapp_id)
|
152
145
|
p result
|
153
|
-
rescue
|
154
|
-
puts "Exception when calling BillingApi->
|
146
|
+
rescue stcloud::ApiError => e
|
147
|
+
puts "Exception when calling BillingApi->update_plan_using_put1: #{e}"
|
155
148
|
end
|
156
149
|
```
|
157
150
|
|
158
151
|
### Parameters
|
159
152
|
|
160
|
-
Name
|
161
|
-
|
162
|
-
**
|
163
|
-
**
|
153
|
+
| Name | Type | Description | Notes |
|
154
|
+
| ---------- | --------------------------------- | ----------- | ----- |
|
155
|
+
| **body** | [**BillingInfo**](BillingInfo.md) | dto |
|
156
|
+
| **app_id** | **Integer** | appId |
|
164
157
|
|
165
158
|
### Return type
|
166
159
|
|
167
|
-
[**
|
160
|
+
[**UpdatePlanResponse**](UpdatePlanResponse.md)
|
168
161
|
|
169
162
|
### Authorization
|
170
163
|
|
data/docs/BillingInfo.md
CHANGED
@@ -1,8 +1,8 @@
|
|
1
|
-
#
|
1
|
+
# stcloud::BillingInfo
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
Name
|
5
|
-
|
6
|
-
**credit_card_id** | **Integer** |
|
7
|
-
**payment_method** | **String**
|
8
|
-
**plan_id**
|
4
|
+
| Name | Type | Description | Notes |
|
5
|
+
| ------------------ | ----------- | ----------- | ---------- |
|
6
|
+
| **credit_card_id** | **Integer** | | [optional] |
|
7
|
+
| **payment_method** | **String** | | [optional] |
|
8
|
+
| **plan_id** | **Integer** | | [optional] |
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# stcloud::ChargesDetailsResponseDto
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
| Name | Type | Description | Notes |
|
5
|
+
| ---------------------- | ------------------------------------------------------------ | ----------- | ---------- |
|
6
|
+
| **app** | [**App**](App.md) | | [optional] |
|
7
|
+
| **charge_base** | **String** | | [optional] |
|
8
|
+
| **day_usage_data** | [**Array<DayUsageData>**](DayUsageData.md) | | [optional] |
|
9
|
+
| **monthly_fee_amount** | [**BigDecimal**](BigDecimal.md) | | [optional] |
|
10
|
+
| **period_fee_periods** | [**Array<MinPeriodFeePeriod>**](MinPeriodFeePeriod.md) | | [optional] |
|
11
|
+
| **total_amount** | [**BigDecimal**](BigDecimal.md) | | [optional] |
|
12
|
+
| **usage_amount** | [**BigDecimal**](BigDecimal.md) | | [optional] |
|
data/docs/CloudWatchSettings.md
CHANGED
@@ -1,9 +1,9 @@
|
|
1
|
-
#
|
1
|
+
# stcloud::CloudWatchSettings
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
Name
|
5
|
-
|
6
|
-
**access_key**
|
7
|
-
**fetch_frequency** | **String** |
|
8
|
-
**region**
|
9
|
-
**secret_key**
|
4
|
+
| Name | Type | Description | Notes |
|
5
|
+
| ------------------- | ---------- | ----------- | ---------- |
|
6
|
+
| **access_key** | **String** | | [optional] |
|
7
|
+
| **fetch_frequency** | **String** | | [optional] |
|
8
|
+
| **region** | **String** | | [optional] |
|
9
|
+
| **secret_key** | **String** | | [optional] |
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# stcloud::CloudWatchSettingsResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
| Name | Type | Description | Notes |
|
5
|
+
| ----------- | ------------------------------------------------------------------------- | ----------- | ---------- |
|
6
|
+
| **data** | [**CloudWatchSettingsResponseEntry**](CloudWatchSettingsResponseEntry.md) | | [optional] |
|
7
|
+
| **errors** | [**Array<Error>**](Error.md) | | [optional] |
|
8
|
+
| **message** | **String** | | [optional] |
|
9
|
+
| **success** | **BOOLEAN** | | [optional] |
|
@@ -0,0 +1,6 @@
|
|
1
|
+
# stcloud::CloudWatchSettingsResponseEntry
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
| Name | Type | Description | Notes |
|
5
|
+
| ------- | ----------------------------------------------- | ----------- | ---------- |
|
6
|
+
| **aws** | [**CloudWatchSettings**](CloudWatchSettings.md) | | [optional] |
|
data/docs/CreateAppInfo.md
CHANGED
@@ -1,10 +1,10 @@
|
|
1
|
-
#
|
1
|
+
# stcloud::CreateAppInfo
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
Name
|
5
|
-
|
6
|
-
**app_type**
|
7
|
-
**discount_code**
|
8
|
-
**initial_plan_id** | **Integer**
|
9
|
-
**meta_data**
|
10
|
-
**name**
|
4
|
+
| Name | Type | Description | Notes |
|
5
|
+
| ------------------- | --------------------------------- | ----------- | ---------- |
|
6
|
+
| **app_type** | **String** | | [optional] |
|
7
|
+
| **discount_code** | **String** | | [optional] |
|
8
|
+
| **initial_plan_id** | **Integer** | | [optional] |
|
9
|
+
| **meta_data** | [**AppMetadata**](AppMetadata.md) | | [optional] |
|
10
|
+
| **name** | **String** | | [optional] |
|
@@ -0,0 +1,8 @@
|
|
1
|
+
# stcloud::CreateTokenDto
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
| Name | Type | Description | Notes |
|
5
|
+
| ------------- | ----------- | ----------- | ---------- |
|
6
|
+
| **name** | **String** | | [optional] |
|
7
|
+
| **readable** | **BOOLEAN** | | [optional] |
|
8
|
+
| **writeable** | **BOOLEAN** | | [optional] |
|
data/docs/DailyDto.md
ADDED
@@ -0,0 +1,9 @@
|
|
1
|
+
# stcloud::DailyDto
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
| Name | Type | Description | Notes |
|
5
|
+
| ----------- | ----------- | ----------- | ---------- |
|
6
|
+
| **day** | **Integer** | | [optional] |
|
7
|
+
| **failed** | **Integer** | | [optional] |
|
8
|
+
| **indexed** | **Integer** | | [optional] |
|
9
|
+
| **volume** | **Integer** | | [optional] |
|