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
data/docs/AppDescription.md
CHANGED
@@ -1,6 +1,6 @@
|
|
1
|
-
#
|
1
|
+
# stcloud::AppDescription
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
Name
|
5
|
-
|
6
|
-
**description** | **String** |
|
4
|
+
| Name | Type | Description | Notes |
|
5
|
+
| --------------- | ---------- | ----------- | ---------- |
|
6
|
+
| **description** | **String** | | [optional] |
|
data/docs/AppMetadata.md
CHANGED
@@ -1,10 +1,10 @@
|
|
1
|
-
#
|
1
|
+
# stcloud::AppMetadata
|
2
2
|
|
3
3
|
## Properties
|
4
|
-
Name
|
5
|
-
|
6
|
-
**aws_cloud_watch_access_key** | **String**
|
7
|
-
**aws_cloud_watch_secret_key** | **String**
|
8
|
-
**aws_fetch_frequency**
|
9
|
-
**aws_region**
|
10
|
-
**sub_types**
|
4
|
+
| Name | Type | Description | Notes |
|
5
|
+
| ------------------------------ | ----------------------- | ---------------------------------------------------------- | ---------- |
|
6
|
+
| **aws_cloud_watch_access_key** | **String** | | [optional] |
|
7
|
+
| **aws_cloud_watch_secret_key** | **String** | | [optional] |
|
8
|
+
| **aws_fetch_frequency** | **String** | | [optional] |
|
9
|
+
| **aws_region** | **String** | | [optional] |
|
10
|
+
| **sub_types** | **Array<String>** | Comma separated list of AWS types monitored by created app | [optional] |
|
data/docs/AppResponse.md
ADDED
@@ -0,0 +1,9 @@
|
|
1
|
+
# stcloud::AppResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
| Name | Type | Description | Notes |
|
5
|
+
| ----------- | ------------------------------------------- | ----------- | ---------- |
|
6
|
+
| **data** | [**AppResponseEntry**](AppResponseEntry.md) | | [optional] |
|
7
|
+
| **errors** | [**Array<Error>**](Error.md) | | [optional] |
|
8
|
+
| **message** | **String** | | [optional] |
|
9
|
+
| **success** | **BOOLEAN** | | [optional] |
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# stcloud::AppTypesResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
| Name | Type | Description | Notes |
|
5
|
+
| ----------- | ----------------------------------------------------- | ----------- | ---------- |
|
6
|
+
| **data** | [**AppTypesResponseEntry**](AppTypesResponseEntry.md) | | [optional] |
|
7
|
+
| **errors** | [**Array<Error>**](Error.md) | | [optional] |
|
8
|
+
| **message** | **String** | | [optional] |
|
9
|
+
| **success** | **BOOLEAN** | | [optional] |
|
data/docs/AppsApi.md
CHANGED
@@ -1,42 +1,93 @@
|
|
1
|
-
#
|
1
|
+
# stcloud::AppsApi
|
2
2
|
|
3
|
-
All URIs are relative to
|
3
|
+
All URIs are relative to */*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ----------------------------------------------------------------------------- | ---------------------------------------------------------- | ------------------------------------------------------------------ |
|
7
|
+
| [**delete_using_delete1**](AppsApi.md#delete_using_delete1) | **DELETE** /users-web/api/v3/apps/{anyStateAppId} | delete |
|
8
|
+
| [**get_app_types_using_get**](AppsApi.md#get_app_types_using_get) | **GET** /users-web/api/v3/apps/types | Get all App types supported for the account identified with apiKey |
|
9
|
+
| [**get_using_get**](AppsApi.md#get_using_get) | **GET** /users-web/api/v3/apps/{anyStateAppId} | Gets defails for one particular App |
|
10
|
+
| [**invite_app_guests_using_post**](AppsApi.md#invite_app_guests_using_post) | **POST** /users-web/api/v3/apps/guests | Invite guests to an app |
|
11
|
+
| [**list_apps_users_using_get1**](AppsApi.md#list_apps_users_using_get1) | **GET** /users-web/api/v3/apps/users | Get all users of apps accessible to this account |
|
12
|
+
| [**list_using_get**](AppsApi.md#list_using_get) | **GET** /users-web/api/v3/apps | Get all apps accessible by account identified with apiKey |
|
13
|
+
| [**update_description_using_put1**](AppsApi.md#update_description_using_put1) | **PUT** /users-web/api/v3/apps/{anyStateAppId}/description | Update description of the app |
|
14
|
+
| [**update_using_put3**](AppsApi.md#update_using_put3) | **PUT** /users-web/api/v3/apps/{anyStateAppId} | Update app |
|
15
|
+
|
16
|
+
# **delete_using_delete1**
|
17
|
+
> GenericMapBasedApiResponse delete_using_delete1(any_state_app_id)
|
18
|
+
|
19
|
+
delete
|
20
|
+
|
21
|
+
### Example
|
22
|
+
```ruby
|
23
|
+
# load the gem
|
24
|
+
require 'stcloud'
|
25
|
+
# setup authorization
|
26
|
+
stcloud.configure do |config|
|
27
|
+
# Configure API key authorization: api_key
|
28
|
+
config.api_key['Authorization'] = 'YOUR API KEY'
|
29
|
+
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
30
|
+
#config.api_key_prefix['Authorization'] = 'Bearer'
|
31
|
+
end
|
32
|
+
|
33
|
+
api_instance = stcloud::AppsApi.new
|
34
|
+
any_state_app_id = 789 # Integer | anyStateAppId
|
35
|
+
|
36
|
+
|
37
|
+
begin
|
38
|
+
#delete
|
39
|
+
result = api_instance.delete_using_delete1(any_state_app_id)
|
40
|
+
p result
|
41
|
+
rescue stcloud::ApiError => e
|
42
|
+
puts "Exception when calling AppsApi->delete_using_delete1: #{e}"
|
43
|
+
end
|
44
|
+
```
|
45
|
+
|
46
|
+
### Parameters
|
47
|
+
|
48
|
+
| Name | Type | Description | Notes |
|
49
|
+
| -------------------- | ----------- | ------------- | ----- |
|
50
|
+
| **any_state_app_id** | **Integer** | anyStateAppId |
|
51
|
+
|
52
|
+
### Return type
|
53
|
+
|
54
|
+
[**GenericMapBasedApiResponse**](GenericMapBasedApiResponse.md)
|
55
|
+
|
56
|
+
### Authorization
|
57
|
+
|
58
|
+
[api_key](../README.md#api_key)
|
59
|
+
|
60
|
+
### HTTP request headers
|
61
|
+
|
62
|
+
- **Content-Type**: Not defined
|
63
|
+
- **Accept**: application/json
|
4
64
|
|
5
|
-
Method | HTTP request | Description
|
6
|
-
------------- | ------------- | -------------
|
7
|
-
[**get_app_types_using_get**](AppsApi.md#get_app_types_using_get) | **GET** /users-web/api/v3/apps/types | Get all App types supported for the account identified with apiKey
|
8
|
-
[**get_using_get**](AppsApi.md#get_using_get) | **GET** /users-web/api/v3/apps/{anyStateAppId} | Gets defails for one particular App
|
9
|
-
[**invite_app_guests_using_post**](AppsApi.md#invite_app_guests_using_post) | **POST** /users-web/api/v3/apps/guests | Invite guests to an app
|
10
|
-
[**list_apps_users_using_get**](AppsApi.md#list_apps_users_using_get) | **GET** /users-web/api/v3/apps/users | Get all users of apps accessible to this account
|
11
|
-
[**list_using_get**](AppsApi.md#list_using_get) | **GET** /users-web/api/v3/apps | Get all apps accessible by account identified with apiKey
|
12
|
-
[**update_description_using_put**](AppsApi.md#update_description_using_put) | **PUT** /users-web/api/v3/apps/{anyStateAppId}/description | Update description of the app
|
13
|
-
[**update_using_put1**](AppsApi.md#update_using_put1) | **PUT** /users-web/api/v3/apps/{anyStateAppId} | Update app
|
14
65
|
|
15
66
|
|
16
67
|
# **get_app_types_using_get**
|
17
|
-
>
|
68
|
+
> AppTypesResponse get_app_types_using_get
|
18
69
|
|
19
70
|
Get all App types supported for the account identified with apiKey
|
20
71
|
|
21
72
|
### Example
|
22
73
|
```ruby
|
23
74
|
# load the gem
|
24
|
-
require '
|
75
|
+
require 'stcloud'
|
25
76
|
# setup authorization
|
26
|
-
|
77
|
+
stcloud.configure do |config|
|
27
78
|
# Configure API key authorization: api_key
|
28
79
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
29
80
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
30
81
|
#config.api_key_prefix['Authorization'] = 'Bearer'
|
31
82
|
end
|
32
83
|
|
33
|
-
api_instance =
|
84
|
+
api_instance = stcloud::AppsApi.new
|
34
85
|
|
35
86
|
begin
|
36
87
|
#Get all App types supported for the account identified with apiKey
|
37
88
|
result = api_instance.get_app_types_using_get
|
38
89
|
p result
|
39
|
-
rescue
|
90
|
+
rescue stcloud::ApiError => e
|
40
91
|
puts "Exception when calling AppsApi->get_app_types_using_get: #{e}"
|
41
92
|
end
|
42
93
|
```
|
@@ -46,7 +97,7 @@ This endpoint does not need any parameter.
|
|
46
97
|
|
47
98
|
### Return type
|
48
99
|
|
49
|
-
[**
|
100
|
+
[**AppTypesResponse**](AppTypesResponse.md)
|
50
101
|
|
51
102
|
### Authorization
|
52
103
|
|
@@ -54,30 +105,29 @@ This endpoint does not need any parameter.
|
|
54
105
|
|
55
106
|
### HTTP request headers
|
56
107
|
|
57
|
-
- **Content-Type**:
|
108
|
+
- **Content-Type**: Not defined
|
58
109
|
- **Accept**: application/json
|
59
110
|
|
60
111
|
|
61
112
|
|
62
113
|
# **get_using_get**
|
63
|
-
>
|
114
|
+
> AppResponse get_using_get(any_state_app_id)
|
64
115
|
|
65
116
|
Gets defails for one particular App
|
66
117
|
|
67
118
|
### Example
|
68
119
|
```ruby
|
69
120
|
# load the gem
|
70
|
-
require '
|
121
|
+
require 'stcloud'
|
71
122
|
# setup authorization
|
72
|
-
|
123
|
+
stcloud.configure do |config|
|
73
124
|
# Configure API key authorization: api_key
|
74
125
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
75
126
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
76
127
|
#config.api_key_prefix['Authorization'] = 'Bearer'
|
77
128
|
end
|
78
129
|
|
79
|
-
api_instance =
|
80
|
-
|
130
|
+
api_instance = stcloud::AppsApi.new
|
81
131
|
any_state_app_id = 789 # Integer | anyStateAppId
|
82
132
|
|
83
133
|
|
@@ -85,20 +135,20 @@ begin
|
|
85
135
|
#Gets defails for one particular App
|
86
136
|
result = api_instance.get_using_get(any_state_app_id)
|
87
137
|
p result
|
88
|
-
rescue
|
138
|
+
rescue stcloud::ApiError => e
|
89
139
|
puts "Exception when calling AppsApi->get_using_get: #{e}"
|
90
140
|
end
|
91
141
|
```
|
92
142
|
|
93
143
|
### Parameters
|
94
144
|
|
95
|
-
Name
|
96
|
-
|
97
|
-
**any_state_app_id** | **Integer
|
145
|
+
| Name | Type | Description | Notes |
|
146
|
+
| -------------------- | ----------- | ------------- | ----- |
|
147
|
+
| **any_state_app_id** | **Integer** | anyStateAppId |
|
98
148
|
|
99
149
|
### Return type
|
100
150
|
|
101
|
-
[**
|
151
|
+
[**AppResponse**](AppResponse.md)
|
102
152
|
|
103
153
|
### Authorization
|
104
154
|
|
@@ -106,51 +156,50 @@ Name | Type | Description | Notes
|
|
106
156
|
|
107
157
|
### HTTP request headers
|
108
158
|
|
109
|
-
- **Content-Type**:
|
159
|
+
- **Content-Type**: Not defined
|
110
160
|
- **Accept**: application/json
|
111
161
|
|
112
162
|
|
113
163
|
|
114
164
|
# **invite_app_guests_using_post**
|
115
|
-
>
|
165
|
+
> GenericMapBasedApiResponse invite_app_guests_using_post(body)
|
116
166
|
|
117
167
|
Invite guests to an app
|
118
168
|
|
119
169
|
### Example
|
120
170
|
```ruby
|
121
171
|
# load the gem
|
122
|
-
require '
|
172
|
+
require 'stcloud'
|
123
173
|
# setup authorization
|
124
|
-
|
174
|
+
stcloud.configure do |config|
|
125
175
|
# Configure API key authorization: api_key
|
126
176
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
127
177
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
128
178
|
#config.api_key_prefix['Authorization'] = 'Bearer'
|
129
179
|
end
|
130
180
|
|
131
|
-
api_instance =
|
132
|
-
|
133
|
-
invitation = SematextCloud::Invitation.new # Invitation | For `app` and `apps` fields only `id` needs to be populated.Other fields can be left empty or with default values
|
181
|
+
api_instance = stcloud::AppsApi.new
|
182
|
+
body = stcloud::Invitation.new # Invitation | For `app` and `apps` fields only `id` needs to be populated.Other fields can be left empty or with default values
|
134
183
|
|
135
184
|
|
136
185
|
begin
|
137
186
|
#Invite guests to an app
|
138
|
-
result = api_instance.invite_app_guests_using_post(
|
187
|
+
result = api_instance.invite_app_guests_using_post(body)
|
139
188
|
p result
|
140
|
-
rescue
|
189
|
+
rescue stcloud::ApiError => e
|
141
190
|
puts "Exception when calling AppsApi->invite_app_guests_using_post: #{e}"
|
142
191
|
end
|
143
192
|
```
|
144
193
|
|
145
194
|
### Parameters
|
146
195
|
|
147
|
-
Name
|
148
|
-
|
149
|
-
**
|
196
|
+
| Name | Type | Description | Notes |
|
197
|
+
| -------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----- |
|
198
|
+
| **body** | [**Invitation**](Invitation.md) | For `app` and `apps` fields only `id` needs to be populated.Other fields can be left empty or with default values |
|
150
199
|
|
151
200
|
### Return type
|
152
201
|
|
153
|
-
[**
|
202
|
+
[**GenericMapBasedApiResponse**](GenericMapBasedApiResponse.md)
|
154
203
|
|
155
204
|
### Authorization
|
156
205
|
|
@@ -163,31 +212,31 @@ Name | Type | Description | Notes
|
|
163
212
|
|
164
213
|
|
165
214
|
|
166
|
-
# **
|
167
|
-
>
|
215
|
+
# **list_apps_users_using_get1**
|
216
|
+
> AppsResponse list_apps_users_using_get1
|
168
217
|
|
169
218
|
Get all users of apps accessible to this account
|
170
219
|
|
171
220
|
### Example
|
172
221
|
```ruby
|
173
222
|
# load the gem
|
174
|
-
require '
|
223
|
+
require 'stcloud'
|
175
224
|
# setup authorization
|
176
|
-
|
225
|
+
stcloud.configure do |config|
|
177
226
|
# Configure API key authorization: api_key
|
178
227
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
179
228
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
180
229
|
#config.api_key_prefix['Authorization'] = 'Bearer'
|
181
230
|
end
|
182
231
|
|
183
|
-
api_instance =
|
232
|
+
api_instance = stcloud::AppsApi.new
|
184
233
|
|
185
234
|
begin
|
186
235
|
#Get all users of apps accessible to this account
|
187
|
-
result = api_instance.
|
236
|
+
result = api_instance.list_apps_users_using_get1
|
188
237
|
p result
|
189
|
-
rescue
|
190
|
-
puts "Exception when calling AppsApi->
|
238
|
+
rescue stcloud::ApiError => e
|
239
|
+
puts "Exception when calling AppsApi->list_apps_users_using_get1: #{e}"
|
191
240
|
end
|
192
241
|
```
|
193
242
|
|
@@ -196,7 +245,7 @@ This endpoint does not need any parameter.
|
|
196
245
|
|
197
246
|
### Return type
|
198
247
|
|
199
|
-
[**
|
248
|
+
[**AppsResponse**](AppsResponse.md)
|
200
249
|
|
201
250
|
### Authorization
|
202
251
|
|
@@ -204,35 +253,35 @@ This endpoint does not need any parameter.
|
|
204
253
|
|
205
254
|
### HTTP request headers
|
206
255
|
|
207
|
-
- **Content-Type**:
|
256
|
+
- **Content-Type**: Not defined
|
208
257
|
- **Accept**: application/json
|
209
258
|
|
210
259
|
|
211
260
|
|
212
261
|
# **list_using_get**
|
213
|
-
>
|
262
|
+
> AppsResponse list_using_get
|
214
263
|
|
215
264
|
Get all apps accessible by account identified with apiKey
|
216
265
|
|
217
266
|
### Example
|
218
267
|
```ruby
|
219
268
|
# load the gem
|
220
|
-
require '
|
269
|
+
require 'stcloud'
|
221
270
|
# setup authorization
|
222
|
-
|
271
|
+
stcloud.configure do |config|
|
223
272
|
# Configure API key authorization: api_key
|
224
273
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
225
274
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
226
275
|
#config.api_key_prefix['Authorization'] = 'Bearer'
|
227
276
|
end
|
228
277
|
|
229
|
-
api_instance =
|
278
|
+
api_instance = stcloud::AppsApi.new
|
230
279
|
|
231
280
|
begin
|
232
281
|
#Get all apps accessible by account identified with apiKey
|
233
282
|
result = api_instance.list_using_get
|
234
283
|
p result
|
235
|
-
rescue
|
284
|
+
rescue stcloud::ApiError => e
|
236
285
|
puts "Exception when calling AppsApi->list_using_get: #{e}"
|
237
286
|
end
|
238
287
|
```
|
@@ -242,7 +291,7 @@ This endpoint does not need any parameter.
|
|
242
291
|
|
243
292
|
### Return type
|
244
293
|
|
245
|
-
[**
|
294
|
+
[**AppsResponse**](AppsResponse.md)
|
246
295
|
|
247
296
|
### Authorization
|
248
297
|
|
@@ -250,13 +299,13 @@ This endpoint does not need any parameter.
|
|
250
299
|
|
251
300
|
### HTTP request headers
|
252
301
|
|
253
|
-
- **Content-Type**:
|
302
|
+
- **Content-Type**: Not defined
|
254
303
|
- **Accept**: application/json
|
255
304
|
|
256
305
|
|
257
306
|
|
258
|
-
# **
|
259
|
-
>
|
307
|
+
# **update_description_using_put1**
|
308
|
+
> AppResponse update_description_using_put1(any_state_app_id, opts)
|
260
309
|
|
261
310
|
Update description of the app
|
262
311
|
|
@@ -265,42 +314,40 @@ App can be in any state
|
|
265
314
|
### Example
|
266
315
|
```ruby
|
267
316
|
# load the gem
|
268
|
-
require '
|
317
|
+
require 'stcloud'
|
269
318
|
# setup authorization
|
270
|
-
|
319
|
+
stcloud.configure do |config|
|
271
320
|
# Configure API key authorization: api_key
|
272
321
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
273
322
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
274
323
|
#config.api_key_prefix['Authorization'] = 'Bearer'
|
275
324
|
end
|
276
325
|
|
277
|
-
api_instance =
|
278
|
-
|
326
|
+
api_instance = stcloud::AppsApi.new
|
279
327
|
any_state_app_id = 789 # Integer | App Id
|
280
|
-
|
281
328
|
opts = {
|
282
|
-
|
329
|
+
body: stcloud::AppDescription.new # AppDescription | Update Details
|
283
330
|
}
|
284
331
|
|
285
332
|
begin
|
286
333
|
#Update description of the app
|
287
|
-
result = api_instance.
|
334
|
+
result = api_instance.update_description_using_put1(any_state_app_id, opts)
|
288
335
|
p result
|
289
|
-
rescue
|
290
|
-
puts "Exception when calling AppsApi->
|
336
|
+
rescue stcloud::ApiError => e
|
337
|
+
puts "Exception when calling AppsApi->update_description_using_put1: #{e}"
|
291
338
|
end
|
292
339
|
```
|
293
340
|
|
294
341
|
### Parameters
|
295
342
|
|
296
|
-
Name
|
297
|
-
|
298
|
-
**any_state_app_id** | **Integer
|
299
|
-
**
|
343
|
+
| Name | Type | Description | Notes |
|
344
|
+
| -------------------- | --------------------------------------- | -------------- | ---------- |
|
345
|
+
| **any_state_app_id** | **Integer** | App Id |
|
346
|
+
| **body** | [**AppDescription**](AppDescription.md) | Update Details | [optional] |
|
300
347
|
|
301
348
|
### Return type
|
302
349
|
|
303
|
-
[**
|
350
|
+
[**AppResponse**](AppResponse.md)
|
304
351
|
|
305
352
|
### Authorization
|
306
353
|
|
@@ -313,8 +360,8 @@ Name | Type | Description | Notes
|
|
313
360
|
|
314
361
|
|
315
362
|
|
316
|
-
# **
|
317
|
-
>
|
363
|
+
# **update_using_put3**
|
364
|
+
> AppResponse update_using_put3(bodyany_state_app_id)
|
318
365
|
|
319
366
|
Update app
|
320
367
|
|
@@ -323,41 +370,39 @@ App can be in any state
|
|
323
370
|
### Example
|
324
371
|
```ruby
|
325
372
|
# load the gem
|
326
|
-
require '
|
373
|
+
require 'stcloud'
|
327
374
|
# setup authorization
|
328
|
-
|
375
|
+
stcloud.configure do |config|
|
329
376
|
# Configure API key authorization: api_key
|
330
377
|
config.api_key['Authorization'] = 'YOUR API KEY'
|
331
378
|
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
332
379
|
#config.api_key_prefix['Authorization'] = 'Bearer'
|
333
380
|
end
|
334
381
|
|
335
|
-
api_instance =
|
336
|
-
|
337
|
-
dto = SematextCloud::UpdateAppInfo.new # UpdateAppInfo | dto
|
338
|
-
|
382
|
+
api_instance = stcloud::AppsApi.new
|
383
|
+
body = stcloud::UpdateAppInfo.new # UpdateAppInfo | dto
|
339
384
|
any_state_app_id = 789 # Integer | App Id
|
340
385
|
|
341
386
|
|
342
387
|
begin
|
343
388
|
#Update app
|
344
|
-
result = api_instance.
|
389
|
+
result = api_instance.update_using_put3(bodyany_state_app_id)
|
345
390
|
p result
|
346
|
-
rescue
|
347
|
-
puts "Exception when calling AppsApi->
|
391
|
+
rescue stcloud::ApiError => e
|
392
|
+
puts "Exception when calling AppsApi->update_using_put3: #{e}"
|
348
393
|
end
|
349
394
|
```
|
350
395
|
|
351
396
|
### Parameters
|
352
397
|
|
353
|
-
Name
|
354
|
-
|
355
|
-
**
|
356
|
-
**any_state_app_id** | **Integer
|
398
|
+
| Name | Type | Description | Notes |
|
399
|
+
| -------------------- | ------------------------------------- | ----------- | ----- |
|
400
|
+
| **body** | [**UpdateAppInfo**](UpdateAppInfo.md) | dto |
|
401
|
+
| **any_state_app_id** | **Integer** | App Id |
|
357
402
|
|
358
403
|
### Return type
|
359
404
|
|
360
|
-
[**
|
405
|
+
[**AppResponse**](AppResponse.md)
|
361
406
|
|
362
407
|
### Authorization
|
363
408
|
|