lockally 0.1.0

data/docs/CreateMigrationCredentialRequest.md

@@ -0,0 +1,22 @@
+# Lockally::CreateMigrationCredentialRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **provider** | **String** |  |  |
+| **label** | **String** |  | [optional] |
+| **credentials** | [**CreateMigrationCredentialRequestCredentials**](CreateMigrationCredentialRequestCredentials.md) |  |  |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::CreateMigrationCredentialRequest.new(
+  provider: null,
+  label: null,
+  credentials: null
+)
+```
+

data/docs/CreateMigrationCredentialRequestCredentials.md

@@ -0,0 +1,26 @@
+# Lockally::CreateMigrationCredentialRequestCredentials
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **host** | **String** |  |  |
+| **port** | **Integer** |  |  |
+| **username** | **String** |  | [optional] |
+| **password** | **String** |  | [optional] |
+| **oauth_token** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::CreateMigrationCredentialRequestCredentials.new(
+  host: null,
+  port: null,
+  username: null,
+  password: null,
+  oauth_token: null
+)
+```
+

data/docs/CreateMigrationRequest.md

@@ -0,0 +1,24 @@
+# Lockally::CreateMigrationRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **credential_id** | **String** |  |  |
+| **source_provider** | **String** |  |  |
+| **settings** | [**MigrationSettings**](MigrationSettings.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::CreateMigrationRequest.new(
+  name: null,
+  credential_id: null,
+  source_provider: null,
+  settings: null
+)
+```
+

data/docs/CreateResourceRequest.md

@@ -0,0 +1,22 @@
+# Lockally::CreateResourceRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **type** | **String** |  | [optional][default to 'meeting_room'] |
+| **capacity** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::CreateResourceRequest.new(
+  name: null,
+  type: null,
+  capacity: null
+)
+```
+

data/docs/CreateUnitsCheckout200Response.md

@@ -0,0 +1,22 @@
+# Lockally::CreateUnitsCheckout200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **authorization_url** | **String** |  |  |
+| **reference** | **String** |  |  |
+| **units** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::CreateUnitsCheckout200Response.new(
+  authorization_url: null,
+  reference: null,
+  units: null
+)
+```
+

data/docs/CreateUnitsCheckoutRequest.md

@@ -0,0 +1,18 @@
+# Lockally::CreateUnitsCheckoutRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **bundle** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::CreateUnitsCheckoutRequest.new(
+  bundle: null
+)
+```
+

data/docs/CreateUserRequest.md

@@ -0,0 +1,26 @@
+# Lockally::CreateUserRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** |  |  |
+| **first_name** | **String** |  |  |
+| **last_name** | **String** |  |  |
+| **title** | **String** |  | [optional] |
+| **department** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::CreateUserRequest.new(
+  email: null,
+  first_name: null,
+  last_name: null,
+  title: null,
+  department: null
+)
+```
+

data/docs/DNSRecord.md

@@ -0,0 +1,28 @@
+# Lockally::DNSRecord
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  |  |
+| **name** | **String** |  |  |
+| **value** | **String** |  |  |
+| **ttl** | **Integer** |  |  |
+| **priority** | **Integer** | MX records only. | [optional] |
+| **purpose** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::DNSRecord.new(
+  type: null,
+  name: null,
+  value: null,
+  ttl: 300,
+  priority: null,
+  purpose: null
+)
+```
+

data/docs/DashboardApi.md

@@ -0,0 +1,462 @@
+# Lockally::DashboardApi
+
+All URIs are relative to *https://api.lockally.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_audit_summary**](DashboardApi.md#get_audit_summary) | **GET** /v1/audit-summary | Audit summary for the dashboard |
+| [**get_domains_status**](DashboardApi.md#get_domains_status) | **GET** /v1/domains/status | Domain health status for the dashboard |
+| [**get_integrations_summary**](DashboardApi.md#get_integrations_summary) | **GET** /v1/integrations-summary | Integrations summary for the dashboard |
+| [**get_security**](DashboardApi.md#get_security) | **GET** /v1/security | Security overview for the dashboard |
+| [**get_storage**](DashboardApi.md#get_storage) | **GET** /v1/storage | Storage usage for the dashboard |
+| [**get_tenant_health**](DashboardApi.md#get_tenant_health) | **GET** /v1/health | Full tenant health report |
+| [**get_user_insights**](DashboardApi.md#get_user_insights) | **GET** /v1/user-insights | User insights for the dashboard |
+
+
+## get_audit_summary
+
+> <GetAuditSummary200Response> get_audit_summary
+
+Audit summary for the dashboard
+
+### Examples
+
+```ruby
+require 'time'
+require 'lockally'
+# setup authorization
+Lockally.configure do |config|
+  # Configure Bearer authorization (lk_live_<prefix>_<secret>): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Lockally::DashboardApi.new
+
+begin
+  # Audit summary for the dashboard
+  result = api_instance.get_audit_summary
+  p result
+rescue Lockally::ApiError => e
+  puts "Error when calling DashboardApi->get_audit_summary: #{e}"
+end
+```
+
+#### Using the get_audit_summary_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetAuditSummary200Response>, Integer, Hash)> get_audit_summary_with_http_info
+
+```ruby
+begin
+  # Audit summary for the dashboard
+  data, status_code, headers = api_instance.get_audit_summary_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetAuditSummary200Response>
+rescue Lockally::ApiError => e
+  puts "Error when calling DashboardApi->get_audit_summary_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetAuditSummary200Response**](GetAuditSummary200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+
+
+## get_domains_status
+
+> <GetDomainsStatus200Response> get_domains_status
+
+Domain health status for the dashboard
+
+### Examples
+
+```ruby
+require 'time'
+require 'lockally'
+# setup authorization
+Lockally.configure do |config|
+  # Configure Bearer authorization (lk_live_<prefix>_<secret>): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Lockally::DashboardApi.new
+
+begin
+  # Domain health status for the dashboard
+  result = api_instance.get_domains_status
+  p result
+rescue Lockally::ApiError => e
+  puts "Error when calling DashboardApi->get_domains_status: #{e}"
+end
+```
+
+#### Using the get_domains_status_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetDomainsStatus200Response>, Integer, Hash)> get_domains_status_with_http_info
+
+```ruby
+begin
+  # Domain health status for the dashboard
+  data, status_code, headers = api_instance.get_domains_status_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetDomainsStatus200Response>
+rescue Lockally::ApiError => e
+  puts "Error when calling DashboardApi->get_domains_status_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetDomainsStatus200Response**](GetDomainsStatus200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+
+
+## get_integrations_summary
+
+> <GetIntegrationsSummary200Response> get_integrations_summary
+
+Integrations summary for the dashboard
+
+### Examples
+
+```ruby
+require 'time'
+require 'lockally'
+# setup authorization
+Lockally.configure do |config|
+  # Configure Bearer authorization (lk_live_<prefix>_<secret>): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Lockally::DashboardApi.new
+
+begin
+  # Integrations summary for the dashboard
+  result = api_instance.get_integrations_summary
+  p result
+rescue Lockally::ApiError => e
+  puts "Error when calling DashboardApi->get_integrations_summary: #{e}"
+end
+```
+
+#### Using the get_integrations_summary_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetIntegrationsSummary200Response>, Integer, Hash)> get_integrations_summary_with_http_info
+
+```ruby
+begin
+  # Integrations summary for the dashboard
+  data, status_code, headers = api_instance.get_integrations_summary_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetIntegrationsSummary200Response>
+rescue Lockally::ApiError => e
+  puts "Error when calling DashboardApi->get_integrations_summary_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetIntegrationsSummary200Response**](GetIntegrationsSummary200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+
+
+## get_security
+
+> <GetSecurity200Response> get_security
+
+Security overview for the dashboard
+
+### Examples
+
+```ruby
+require 'time'
+require 'lockally'
+# setup authorization
+Lockally.configure do |config|
+  # Configure Bearer authorization (lk_live_<prefix>_<secret>): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Lockally::DashboardApi.new
+
+begin
+  # Security overview for the dashboard
+  result = api_instance.get_security
+  p result
+rescue Lockally::ApiError => e
+  puts "Error when calling DashboardApi->get_security: #{e}"
+end
+```
+
+#### Using the get_security_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetSecurity200Response>, Integer, Hash)> get_security_with_http_info
+
+```ruby
+begin
+  # Security overview for the dashboard
+  data, status_code, headers = api_instance.get_security_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetSecurity200Response>
+rescue Lockally::ApiError => e
+  puts "Error when calling DashboardApi->get_security_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetSecurity200Response**](GetSecurity200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+
+
+## get_storage
+
+> <GetStorage200Response> get_storage
+
+Storage usage for the dashboard
+
+### Examples
+
+```ruby
+require 'time'
+require 'lockally'
+# setup authorization
+Lockally.configure do |config|
+  # Configure Bearer authorization (lk_live_<prefix>_<secret>): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Lockally::DashboardApi.new
+
+begin
+  # Storage usage for the dashboard
+  result = api_instance.get_storage
+  p result
+rescue Lockally::ApiError => e
+  puts "Error when calling DashboardApi->get_storage: #{e}"
+end
+```
+
+#### Using the get_storage_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetStorage200Response>, Integer, Hash)> get_storage_with_http_info
+
+```ruby
+begin
+  # Storage usage for the dashboard
+  data, status_code, headers = api_instance.get_storage_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetStorage200Response>
+rescue Lockally::ApiError => e
+  puts "Error when calling DashboardApi->get_storage_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetStorage200Response**](GetStorage200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+
+
+## get_tenant_health
+
+> Object get_tenant_health
+
+Full tenant health report
+
+### Examples
+
+```ruby
+require 'time'
+require 'lockally'
+# setup authorization
+Lockally.configure do |config|
+  # Configure Bearer authorization (lk_live_<prefix>_<secret>): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Lockally::DashboardApi.new
+
+begin
+  # Full tenant health report
+  result = api_instance.get_tenant_health
+  p result
+rescue Lockally::ApiError => e
+  puts "Error when calling DashboardApi->get_tenant_health: #{e}"
+end
+```
+
+#### Using the get_tenant_health_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> get_tenant_health_with_http_info
+
+```ruby
+begin
+  # Full tenant health report
+  data, status_code, headers = api_instance.get_tenant_health_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue Lockally::ApiError => e
+  puts "Error when calling DashboardApi->get_tenant_health_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+
+
+## get_user_insights
+
+> <GetUserInsights200Response> get_user_insights
+
+User insights for the dashboard
+
+### Examples
+
+```ruby
+require 'time'
+require 'lockally'
+# setup authorization
+Lockally.configure do |config|
+  # Configure Bearer authorization (lk_live_<prefix>_<secret>): bearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Lockally::DashboardApi.new
+
+begin
+  # User insights for the dashboard
+  result = api_instance.get_user_insights
+  p result
+rescue Lockally::ApiError => e
+  puts "Error when calling DashboardApi->get_user_insights: #{e}"
+end
+```
+
+#### Using the get_user_insights_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetUserInsights200Response>, Integer, Hash)> get_user_insights_with_http_info
+
+```ruby
+begin
+  # User insights for the dashboard
+  data, status_code, headers = api_instance.get_user_insights_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetUserInsights200Response>
+rescue Lockally::ApiError => e
+  puts "Error when calling DashboardApi->get_user_insights_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetUserInsights200Response**](GetUserInsights200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+

data/docs/DedicatedIPRequest.md

@@ -0,0 +1,30 @@
+# Lockally::DedicatedIPRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **tenant_id** | **String** |  |  |
+| **status** | **String** |  |  |
+| **note** | **String** |  | [optional] |
+| **admin_note** | **String** |  | [optional] |
+| **created_at** | **Time** |  |  |
+| **resolved_at** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::DedicatedIPRequest.new(
+  id: null,
+  tenant_id: null,
+  status: null,
+  note: null,
+  admin_note: null,
+  created_at: null,
+  resolved_at: null
+)
+```
+