@vantage-sh/vantage-client 0.1.0 → 2.0.0

package/docs/CostsApi.md

@@ -1,168 +0,0 @@
-# Vantage.CostsApi
-
-All URIs are relative to *https://api.vantage.sh*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**getCosts**](CostsApi.md#getCosts) | **GET** /v1/reports/{report_id}/costs | 
-[**getReport**](CostsApi.md#getReport) | **GET** /v1/reports/{report_id} | 
-[**getReports**](CostsApi.md#getReports) | **GET** /v1/reports | 
-
-
-<a name="getCosts"></a>
-# **getCosts**
-> Costs getCosts(reportId, opts)
-
-
-
-Return available Costs for the specified Cost Report and optional time period. If no time period is specified it will return all available costs for the report.
-
-### Example
-```javascript
-import {Vantage} from 'vantage';
-let defaultClient = Vantage.ApiClient.instance;
-
-// Configure OAuth2 access token for authorization: oauth2
-let oauth2 = defaultClient.authentications['oauth2'];
-oauth2.accessToken = 'YOUR ACCESS TOKEN';
-
-let apiInstance = new Vantage.CostsApi();
-
-let reportId = "reportId_example"; // String | 
-
-let opts = { 
-  'startDate': "startDate_example", // String | Query costs by the first date you would like to filter from. ISO 8601 Formatted - 2021-07-15 or 2021-07-15T19:20:48+00:00.
-  'endDate': "endDate_example", // String | Query costs by the last date you would like to filter to. ISO 8601 Formatted - 2021-07-15 or 2021-07-15T19:20:48+00:00.
-  'page': 2, // Number | The page of results to return.
-  'limit': 500 // Number | The amount of results to return. The maximum is 1000
-};
-apiInstance.getCosts(reportId, opts).then((data) => {
-  console.log('API called successfully. Returned data: ' + data);
-}, (error) => {
-  console.error(error);
-});
-
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **reportId** | **String**|  | 
- **startDate** | **String**| Query costs by the first date you would like to filter from. ISO 8601 Formatted - 2021-07-15 or 2021-07-15T19:20:48+00:00. | [optional] 
- **endDate** | **String**| Query costs by the last date you would like to filter to. ISO 8601 Formatted - 2021-07-15 or 2021-07-15T19:20:48+00:00. | [optional] 
- **page** | **Number**| The page of results to return. | [optional] 
- **limit** | **Number**| The amount of results to return. The maximum is 1000 | [optional] 
-
-### Return type
-
-[**Costs**](Costs.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-<a name="getReport"></a>
-# **getReport**
-> Report getReport(reportId)
-
-
-
-Return a Cost Report.
-
-### Example
-```javascript
-import {Vantage} from 'vantage';
-let defaultClient = Vantage.ApiClient.instance;
-
-// Configure OAuth2 access token for authorization: oauth2
-let oauth2 = defaultClient.authentications['oauth2'];
-oauth2.accessToken = 'YOUR ACCESS TOKEN';
-
-let apiInstance = new Vantage.CostsApi();
-
-let reportId = "reportId_example"; // String | 
-
-apiInstance.getReport(reportId).then((data) => {
-  console.log('API called successfully. Returned data: ' + data);
-}, (error) => {
-  console.error(error);
-});
-
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **reportId** | **String**|  | 
-
-### Return type
-
-[**Report**](Report.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-<a name="getReports"></a>
-# **getReports**
-> Reports getReports(opts)
-
-
-
-Return all Cost Reports.
-
-### Example
-```javascript
-import {Vantage} from 'vantage';
-let defaultClient = Vantage.ApiClient.instance;
-
-// Configure OAuth2 access token for authorization: oauth2
-let oauth2 = defaultClient.authentications['oauth2'];
-oauth2.accessToken = 'YOUR ACCESS TOKEN';
-
-let apiInstance = new Vantage.CostsApi();
-
-let opts = { 
-  'page': 56, // Number | The page of results to return.
-  'limit': 56 // Number | The amount of results to return. The maximum is 1000
-};
-apiInstance.getReports(opts).then((data) => {
-  console.log('API called successfully. Returned data: ' + data);
-}, (error) => {
-  console.error(error);
-});
-
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **page** | **Number**| The page of results to return. | [optional] 
- **limit** | **Number**| The amount of results to return. The maximum is 1000 | [optional] 
-
-### Return type
-
-[**Reports**](Reports.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-

package/docs/PingApi.md

@@ -1,51 +0,0 @@
-# Vantage.PingApi
-
-All URIs are relative to *https://api.vantage.sh*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**ping**](PingApi.md#ping) | **GET** /v1/ping | 
-
-
-<a name="ping"></a>
-# **ping**
-> Object ping()
-
-
-
-This is a health check endpoint that can be used to determine Vantage API healthiness. It will return 200 if everything is running smoothly.
-
-### Example
-```javascript
-import {Vantage} from 'vantage';
-let defaultClient = Vantage.ApiClient.instance;
-
-// Configure OAuth2 access token for authorization: oauth2
-let oauth2 = defaultClient.authentications['oauth2'];
-oauth2.accessToken = 'YOUR ACCESS TOKEN';
-
-let apiInstance = new Vantage.PingApi();
-apiInstance.ping().then((data) => {
-  console.log('API called successfully. Returned data: ' + data);
-}, (error) => {
-  console.error(error);
-});
-
-```
-
-### Parameters
-This endpoint does not need any parameter.
-
-### Return type
-
-**Object**
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-

package/docs/Price.md

@@ -1,14 +0,0 @@
-# Vantage.Price
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** |  | [optional] 
-**unit** | **String** | The unit in which the amount is billed. | [optional] 
-**region** | **String** | The region the price is specific to. | [optional] 
-**rateType** | **String** | The part of the product the price applies to. (compute, transfer, etc..) | [optional] 
-**currency** | **String** | The currency of the amount. | [optional] 
-**amount** | **Number** | The amount of money this specific product price costs. | [optional] 
-**details** | **Object** | Service specific metadata. | [optional] 
-
-

package/docs/Prices.md

@@ -1,9 +0,0 @@
-# Vantage.Prices
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**links** | **Object** |  | [optional] 
-**prices** | [**[Price]**](Price.md) |  | [optional] 
-
-

package/docs/PricesApi.md

@@ -1,328 +0,0 @@
-# Vantage.PricesApi
-
-All URIs are relative to *https://api.vantage.sh*
-
-Method | HTTP request | Description
-------------- | ------------- | -------------
-[**getPrice**](PricesApi.md#getPrice) | **GET** /v1/products/{product_id}/prices/{id} | 
-[**getPrices**](PricesApi.md#getPrices) | **GET** /v1/products/{product_id}/prices | 
-[**getProduct**](PricesApi.md#getProduct) | **GET** /v1/products/{id} | 
-[**getProducts**](PricesApi.md#getProducts) | **GET** /v1/products | 
-[**getProviders**](PricesApi.md#getProviders) | **GET** /v1/providers | 
-[**getServices**](PricesApi.md#getServices) | **GET** /v1/services | 
-
-
-<a name="getPrice"></a>
-# **getPrice**
-> Price getPrice(productId, id)
-
-
-
-Returns a price
-
-### Example
-```javascript
-import {Vantage} from 'vantage';
-let defaultClient = Vantage.ApiClient.instance;
-
-// Configure OAuth2 access token for authorization: oauth2
-let oauth2 = defaultClient.authentications['oauth2'];
-oauth2.accessToken = 'YOUR ACCESS TOKEN';
-
-let apiInstance = new Vantage.PricesApi();
-
-let productId = "productId_example"; // String | 
-
-let id = "id_example"; // String | 
-
-apiInstance.getPrice(productId, id).then((data) => {
-  console.log('API called successfully. Returned data: ' + data);
-}, (error) => {
-  console.error(error);
-});
-
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **productId** | **String**|  | 
- **id** | **String**|  | 
-
-### Return type
-
-[**Price**](Price.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-<a name="getPrices"></a>
-# **getPrices**
-> Prices getPrices(productId, opts)
-
-
-
-Return available Prices across all Regions for a Product.
-
-### Example
-```javascript
-import {Vantage} from 'vantage';
-let defaultClient = Vantage.ApiClient.instance;
-
-// Configure OAuth2 access token for authorization: oauth2
-let oauth2 = defaultClient.authentications['oauth2'];
-oauth2.accessToken = 'YOUR ACCESS TOKEN';
-
-let apiInstance = new Vantage.PricesApi();
-
-let productId = "productId_example"; // String | 
-
-let opts = { 
-  'page': 2, // Number | The page of results to return.
-  'limit': 500 // Number | The amount of results to return. The maximum is 1000
-};
-apiInstance.getPrices(productId, opts).then((data) => {
-  console.log('API called successfully. Returned data: ' + data);
-}, (error) => {
-  console.error(error);
-});
-
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **productId** | **String**|  | 
- **page** | **Number**| The page of results to return. | [optional] 
- **limit** | **Number**| The amount of results to return. The maximum is 1000 | [optional] 
-
-### Return type
-
-[**Prices**](Prices.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-<a name="getProduct"></a>
-# **getProduct**
-> Product getProduct(id)
-
-
-
-Return a product
-
-### Example
-```javascript
-import {Vantage} from 'vantage';
-let defaultClient = Vantage.ApiClient.instance;
-
-// Configure OAuth2 access token for authorization: oauth2
-let oauth2 = defaultClient.authentications['oauth2'];
-oauth2.accessToken = 'YOUR ACCESS TOKEN';
-
-let apiInstance = new Vantage.PricesApi();
-
-let id = "id_example"; // String | 
-
-apiInstance.getProduct(id).then((data) => {
-  console.log('API called successfully. Returned data: ' + data);
-}, (error) => {
-  console.error(error);
-});
-
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **id** | **String**|  | 
-
-### Return type
-
-[**Product**](Product.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-<a name="getProducts"></a>
-# **getProducts**
-> Products getProducts(opts)
-
-
-
-Return available Products for a Service. For example, with a Provider of AWS and a Service of EC2, Products will be a list of all EC2 Instances. By default, this endpoint returns all Products across all Services and Providers but has optional query parameters for filtering listed below.
-
-### Example
-```javascript
-import {Vantage} from 'vantage';
-let defaultClient = Vantage.ApiClient.instance;
-
-// Configure OAuth2 access token for authorization: oauth2
-let oauth2 = defaultClient.authentications['oauth2'];
-oauth2.accessToken = 'YOUR ACCESS TOKEN';
-
-let apiInstance = new Vantage.PricesApi();
-
-let opts = { 
-  'providerId': "providerId_example", // String | Query by Provider to list all Products across all Services for a Provider. e.g. aws
-  'serviceId': "serviceId_example", // String | Query by Service to list all Products for a specific provider service. e.g. aws-ec2
-  'name': "name_example", // String | Query by name of the Product to see a list of products which match that name. e.g. m5a.16xlarge
-  'page': 2, // Number | The page of results to return.
-  'limit': 500 // Number | The amount of results to return. The maximum is 1000
-};
-apiInstance.getProducts(opts).then((data) => {
-  console.log('API called successfully. Returned data: ' + data);
-}, (error) => {
-  console.error(error);
-});
-
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **providerId** | **String**| Query by Provider to list all Products across all Services for a Provider. e.g. aws | [optional] 
- **serviceId** | **String**| Query by Service to list all Products for a specific provider service. e.g. aws-ec2 | [optional] 
- **name** | **String**| Query by name of the Product to see a list of products which match that name. e.g. m5a.16xlarge | [optional] 
- **page** | **Number**| The page of results to return. | [optional] 
- **limit** | **Number**| The amount of results to return. The maximum is 1000 | [optional] 
-
-### Return type
-
-[**Products**](Products.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-<a name="getProviders"></a>
-# **getProviders**
-> Providers getProviders(opts)
-
-
-
-Providers are cloud infrastructure and service providers from which all cloud prices are derived. You can think of example Providers as being AWS, GCP, Cloudflare or Datadog. Currently, Vantage only supports a single provider of AWS but over time more will be added. Use this endpoint to retrieve a provider id for other API calls.
-
-### Example
-```javascript
-import {Vantage} from 'vantage';
-let defaultClient = Vantage.ApiClient.instance;
-
-// Configure OAuth2 access token for authorization: oauth2
-let oauth2 = defaultClient.authentications['oauth2'];
-oauth2.accessToken = 'YOUR ACCESS TOKEN';
-
-let apiInstance = new Vantage.PricesApi();
-
-let opts = { 
-  'page': 2, // Number | The page of results to return.
-  'limit': 500 // Number | The amount of results to return. The maximum is 1000
-};
-apiInstance.getProviders(opts).then((data) => {
-  console.log('API called successfully. Returned data: ' + data);
-}, (error) => {
-  console.error(error);
-});
-
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **page** | **Number**| The page of results to return. | [optional] 
- **limit** | **Number**| The amount of results to return. The maximum is 1000 | [optional] 
-
-### Return type
-
-[**Providers**](Providers.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-<a name="getServices"></a>
-# **getServices**
-> Services getServices(opts)
-
-
-
-Return all Services. Examples of Services are EC2 for AWS. This endpoint will return all Services by default but you have the ability to filter Services by Provider using the optional query parameter documented below.
-
-### Example
-```javascript
-import {Vantage} from 'vantage';
-let defaultClient = Vantage.ApiClient.instance;
-
-// Configure OAuth2 access token for authorization: oauth2
-let oauth2 = defaultClient.authentications['oauth2'];
-oauth2.accessToken = 'YOUR ACCESS TOKEN';
-
-let apiInstance = new Vantage.PricesApi();
-
-let opts = { 
-  'providerId': "providerId_example", // String | Query services for a specific provider. e.g. aws
-  'page': 2, // Number | The page of results to return.
-  'limit': 500 // Number | The amount of results to return. The maximum is 1000
-};
-apiInstance.getServices(opts).then((data) => {
-  console.log('API called successfully. Returned data: ' + data);
-}, (error) => {
-  console.error(error);
-});
-
-```
-
-### Parameters
-
-Name | Type | Description  | Notes
-------------- | ------------- | ------------- | -------------
- **providerId** | **String**| Query services for a specific provider. e.g. aws | [optional] 
- **page** | **Number**| The page of results to return. | [optional] 
- **limit** | **Number**| The amount of results to return. The maximum is 1000 | [optional] 
-
-### Return type
-
-[**Services**](Services.md)
-
-### Authorization
-
-[oauth2](../README.md#oauth2)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-

package/docs/Product.md

@@ -1,13 +0,0 @@
-# Vantage.Product
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** |  | [optional] 
-**category** | **String** | The category of the cloud product | [optional] 
-**name** | **String** | The common name of the product. | [optional] 
-**serviceId** | **String** | A unique slug for the service the product belongs to. | [optional] 
-**providerId** | **String** | A unique slug for the provider the product belongs to. | [optional] 
-**details** | **Object** | An object of metadata about the product. | [optional] 
-
-

package/docs/Products.md

@@ -1,9 +0,0 @@
-# Vantage.Products
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**links** | **Object** |  | [optional] 
-**products** | [**[Product]**](Product.md) |  | [optional] 
-
-

package/docs/Provider.md

@@ -1,10 +0,0 @@
-# Vantage.Provider
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** |  | [optional] 
-**name** | **String** | The common name of the provider. | [optional] 
-**description** | **String** | The full descriptive name of the provider. | [optional] 
-
-

package/docs/Providers.md

@@ -1,9 +0,0 @@
-# Vantage.Providers
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**links** | **Object** |  | [optional] 
-**providers** | [**[Provider]**](Provider.md) |  | [optional] 
-
-

package/docs/Report.md

@@ -1,13 +0,0 @@
-# Vantage.Report
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** |  | [optional] 
-**title** | **String** | The title of the cost report. | [optional] 
-**earliestCostDate** | **String** | The date and time, in UTC, the report was created. ISO 8601 Formatted - 2021-01-01 or 2021-01-01T00:00:00Z. | [optional] 
-**latestCostDate** | **String** | The date and time, in UTC, the report was created. ISO 8601 Formatted - 2021-07-31 or 2021-07-31T00:00:00Z. | [optional] 
-**createdAt** | **String** | The date and time, in UTC, the report was created. ISO 8601 Formatted - 2021-07-15 or 2021-07-15T00:00:00Z. | [optional] 
-**workspace** | **String** | The name of the workspace the report is a part of. | [optional] 
-
-

package/docs/Reports.md

@@ -1,9 +0,0 @@
-# Vantage.Reports
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**links** | **Object** |  | [optional] 
-**reports** | [**[Report]**](Report.md) |  | [optional] 
-
-

package/docs/Service.md

@@ -1,11 +0,0 @@
-# Vantage.Service
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**id** | **String** |  | [optional] 
-**category** | **String** | The type of cloud service. | [optional] 
-**name** | **String** | The common name of the service. Usually an abbreviation. | [optional] 
-**description** | **String** | The full name of the service. | [optional] 
-
-

package/docs/Services.md

@@ -1,9 +0,0 @@
-# Vantage.Services
-
-## Properties
-Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
-**links** | **Object** |  | [optional] 
-**services** | [**[Service]**](Service.md) |  | [optional] 
-
-