togai_client 1.0.0

data/docs/GetMetricsResponse.md

@@ -0,0 +1,18 @@
+# TogaiClient::GetMetricsResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **results** | [**Array<MetricQueryResponse>**](MetricQueryResponse.md) |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::GetMetricsResponse.new(
+  results: null
+)
+```
+

data/docs/IngestBatchEventRequest.md

@@ -0,0 +1,18 @@
+# TogaiClient::IngestBatchEventRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **events** | [**Array<Event>**](Event.md) |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::IngestBatchEventRequest.new(
+  events: null
+)
+```
+

data/docs/IngestBatchEventResponse.md

@@ -0,0 +1,18 @@
+# TogaiClient::IngestBatchEventResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **errors** | [**Array<IngestError>**](IngestError.md) |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::IngestBatchEventResponse.new(
+  errors: null
+)
+```
+

data/docs/IngestError.md

@@ -0,0 +1,20 @@
+# TogaiClient::IngestError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** |  | [optional] |
+| **event_payload** | [**Event**](Event.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::IngestError.new(
+  message: null,
+  event_payload: null
+)
+```
+

data/docs/IngestEventRequest.md

@@ -0,0 +1,18 @@
+# TogaiClient::IngestEventRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event** | [**Event**](Event.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::IngestEventRequest.new(
+  event: null
+)
+```
+

data/docs/IngestEventResponse.md

@@ -0,0 +1,18 @@
+# TogaiClient::IngestEventResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **ingestion_request_id** | **String** | On successful ingestion acceptance request, ingestion request id will be returned. This ingestion id can be used by clients to query the status of ingestion (IN_PROGRESS, COMPLETED). |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::IngestEventResponse.new(
+  ingestion_request_id: null
+)
+```
+

data/docs/IngestionStatus.md

@@ -0,0 +1,20 @@
+# TogaiClient::IngestionStatus
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** | Ingestion status |  |
+| **status_description** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::IngestionStatus.new(
+  status: INGESTION_COMPLETED,
+  status_description: Ingestion Completed successfully
+)
+```
+

data/docs/MetricDataPoints.md

@@ -0,0 +1,22 @@
+# TogaiClient::MetricDataPoints
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **grouped_by** | [**MetricDataPointsGroupedBy**](MetricDataPointsGroupedBy.md) |  | [optional] |
+| **timestamps** | **Array<Time>** |  |  |
+| **metric_values** | **Array<Float>** |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::MetricDataPoints.new(
+  grouped_by: null,
+  timestamps: null,
+  metric_values: null
+)
+```
+

data/docs/MetricDataPointsGroupedBy.md

@@ -0,0 +1,20 @@
+# TogaiClient::MetricDataPointsGroupedBy
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **field_name** | **String** |  |  |
+| **field_value** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::MetricDataPointsGroupedBy.new(
+  field_name: null,
+  field_value: null
+)
+```
+

data/docs/MetricName.md

@@ -0,0 +1,15 @@
+# TogaiClient::MetricName
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::MetricName.new()
+```
+

data/docs/MetricQuery.md

@@ -0,0 +1,26 @@
+# TogaiClient::MetricQuery
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **name** | [**MetricName**](MetricName.md) |  |  |
+| **aggregation_period** | **String** |  |  |
+| **group_by** | **String** |  | [optional] |
+| **filters** | [**Array<MetricQueryFilterEntry>**](MetricQueryFilterEntry.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::MetricQuery.new(
+  id: null,
+  name: null,
+  aggregation_period: null,
+  group_by: null,
+  filters: null
+)
+```
+

data/docs/MetricQueryFilterEntry.md

@@ -0,0 +1,20 @@
+# TogaiClient::MetricQueryFilterEntry
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **field_name** | **String** |  |  |
+| **field_values** | **Array<String>** |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::MetricQueryFilterEntry.new(
+  field_name: null,
+  field_values: null
+)
+```
+

data/docs/MetricQueryResponse.md

@@ -0,0 +1,22 @@
+# TogaiClient::MetricQueryResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **name** | [**MetricName**](MetricName.md) |  |  |
+| **data** | [**Array<MetricDataPoints>**](MetricDataPoints.md) |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::MetricQueryResponse.new(
+  id: null,
+  name: null,
+  data: null
+)
+```
+

data/docs/MetricsApi.md

@@ -0,0 +1,79 @@
+# TogaiClient::MetricsApi
+
+All URIs are relative to *https://sandbox-api.togai.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_metrics**](MetricsApi.md#get_metrics) | **POST** /metrics | Get togai metrics. |
+
+
+## get_metrics
+
+> <GetMetricsResponse> get_metrics(opts)
+
+Get togai metrics.
+
+To get the metrics, you make a POST request to the /metrics resource. You can query up to five metrics in a single request. Single response dataset can contain a maximum of 100 data points.
+
+### Examples
+
+```ruby
+require 'time'
+require 'togai_client'
+# setup authorization
+TogaiClient.configure do |config|
+  # Configure Bearer authorization (Bearer <credential>): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = TogaiClient::MetricsApi.new
+opts = {
+  get_metrics_request: TogaiClient::GetMetricsRequest.new({start_time: Time.now, end_time: Time.now, metric_queries: [TogaiClient::MetricQuery.new({id: 'id_example', name: TogaiClient::MetricName::EVENTS, aggregation_period: 'DAY'})]}) # GetMetricsRequest | 
+}
+
+begin
+  # Get togai metrics.
+  result = api_instance.get_metrics(opts)
+  p result
+rescue TogaiClient::ApiError => e
+  puts "Error when calling MetricsApi->get_metrics: #{e}"
+end
+```
+
+#### Using the get_metrics_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetMetricsResponse>, Integer, Hash)> get_metrics_with_http_info(opts)
+
+```ruby
+begin
+  # Get togai metrics.
+  data, status_code, headers = api_instance.get_metrics_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetMetricsResponse>
+rescue TogaiClient::ApiError => e
+  puts "Error when calling MetricsApi->get_metrics_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **get_metrics_request** | [**GetMetricsRequest**](GetMetricsRequest.md) |  | [optional] |
+
+### Return type
+
+[**GetMetricsResponse**](GetMetricsResponse.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/PaginationOptions.md

@@ -0,0 +1,20 @@
+# TogaiClient::PaginationOptions
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page_size** | **Integer** |  | [optional] |
+| **sort_order** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::PaginationOptions.new(
+  page_size: null,
+  sort_order: null
+)
+```
+

data/docs/PlanOverride.md

@@ -0,0 +1,24 @@
+# TogaiClient::PlanOverride
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **price_plan_name** | **String** |  |  |
+| **override** | [**RateCard**](RateCard.md) |  | [optional] |
+| **start_date** | **Time** |  |  |
+| **end_date** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::PlanOverride.new(
+  price_plan_name: null,
+  override: null,
+  start_date: null,
+  end_date: null
+)
+```
+

data/docs/PricePlan.md

@@ -0,0 +1,26 @@
+# TogaiClient::PricePlan
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name of the price plan |  |
+| **description** | **String** | Description of price plan | [optional] |
+| **status** | **String** | Status of Price plan |  |
+| **pricing_cycle** | [**PricingCycle**](PricingCycle.md) |  |  |
+| **pricing_schedule** | [**Array<PricingSchedule>**](PricingSchedule.md) |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::PricePlan.new(
+  name: null,
+  description: null,
+  status: null,
+  pricing_cycle: null,
+  pricing_schedule: null
+)
+```
+

data/docs/PricePlanListData.md

@@ -0,0 +1,32 @@
+# TogaiClient::PricePlanListData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Name of the price plan |  |
+| **description** | **String** | Description of price plan | [optional] |
+| **status** | **String** | Status of Price plan |  |
+| **pricing_cycle** | [**PricingCycle**](PricingCycle.md) |  |  |
+| **usage_meters** | **Array<String>** | Usage meters name linked to the price plan |  |
+| **pricing_type** | **String** | Pricing type of the price plan |  |
+| **created_at** | **Time** |  |  |
+| **updated_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::PricePlanListData.new(
+  name: null,
+  description: null,
+  status: null,
+  pricing_cycle: null,
+  usage_meters: null,
+  pricing_type: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/PricePlanPaginatedResponse.md

@@ -0,0 +1,22 @@
+# TogaiClient::PricePlanPaginatedResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<PricePlanListData>**](PricePlanListData.md) |  | [optional] |
+| **next_token** | **String** |  | [optional] |
+| **context** | [**PaginationOptions**](PaginationOptions.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'togai_client'
+
+instance = TogaiClient::PricePlanPaginatedResponse.new(
+  data: null,
+  next_token: null,
+  context: null
+)
+```
+