lockally 0.1.0

data/docs/IpPoolsApi.md

@@ -0,0 +1,205 @@
+# Lockally::IpPoolsApi
+
+All URIs are relative to *https://api.lockally.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_dedicated_ip_request**](IpPoolsApi.md#create_dedicated_ip_request) | **POST** /v1/dedicated-ip-requests | Request a dedicated IP |
+| [**get_ip_assignment**](IpPoolsApi.md#get_ip_assignment) | **GET** /v1/ip-assignment | Get current IP assignment |
+| [**list_dedicated_ip_requests**](IpPoolsApi.md#list_dedicated_ip_requests) | **GET** /v1/dedicated-ip-requests | List dedicated IP requests |
+
+
+## create_dedicated_ip_request
+
+> <DedicatedIPRequest> create_dedicated_ip_request(create_dedicated_ip_request_request)
+
+Request a dedicated IP
+
+### 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::IpPoolsApi.new
+create_dedicated_ip_request_request = Lockally::CreateDedicatedIPRequestRequest.new({note: 'note_example'}) # CreateDedicatedIPRequestRequest | 
+
+begin
+  # Request a dedicated IP
+  result = api_instance.create_dedicated_ip_request(create_dedicated_ip_request_request)
+  p result
+rescue Lockally::ApiError => e
+  puts "Error when calling IpPoolsApi->create_dedicated_ip_request: #{e}"
+end
+```
+
+#### Using the create_dedicated_ip_request_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DedicatedIPRequest>, Integer, Hash)> create_dedicated_ip_request_with_http_info(create_dedicated_ip_request_request)
+
+```ruby
+begin
+  # Request a dedicated IP
+  data, status_code, headers = api_instance.create_dedicated_ip_request_with_http_info(create_dedicated_ip_request_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DedicatedIPRequest>
+rescue Lockally::ApiError => e
+  puts "Error when calling IpPoolsApi->create_dedicated_ip_request_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_dedicated_ip_request_request** | [**CreateDedicatedIPRequestRequest**](CreateDedicatedIPRequestRequest.md) |  |  |
+
+### Return type
+
+[**DedicatedIPRequest**](DedicatedIPRequest.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json, application/problem+json
+
+
+## get_ip_assignment
+
+> <GetIPAssignment200Response> get_ip_assignment
+
+Get current IP assignment
+
+### 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::IpPoolsApi.new
+
+begin
+  # Get current IP assignment
+  result = api_instance.get_ip_assignment
+  p result
+rescue Lockally::ApiError => e
+  puts "Error when calling IpPoolsApi->get_ip_assignment: #{e}"
+end
+```
+
+#### Using the get_ip_assignment_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetIPAssignment200Response>, Integer, Hash)> get_ip_assignment_with_http_info
+
+```ruby
+begin
+  # Get current IP assignment
+  data, status_code, headers = api_instance.get_ip_assignment_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetIPAssignment200Response>
+rescue Lockally::ApiError => e
+  puts "Error when calling IpPoolsApi->get_ip_assignment_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetIPAssignment200Response**](GetIPAssignment200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+
+
+## list_dedicated_ip_requests
+
+> <ListDedicatedIPRequests200Response> list_dedicated_ip_requests
+
+List dedicated IP requests
+
+### 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::IpPoolsApi.new
+
+begin
+  # List dedicated IP requests
+  result = api_instance.list_dedicated_ip_requests
+  p result
+rescue Lockally::ApiError => e
+  puts "Error when calling IpPoolsApi->list_dedicated_ip_requests: #{e}"
+end
+```
+
+#### Using the list_dedicated_ip_requests_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ListDedicatedIPRequests200Response>, Integer, Hash)> list_dedicated_ip_requests_with_http_info
+
+```ruby
+begin
+  # List dedicated IP requests
+  data, status_code, headers = api_instance.list_dedicated_ip_requests_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ListDedicatedIPRequests200Response>
+rescue Lockally::ApiError => e
+  puts "Error when calling IpPoolsApi->list_dedicated_ip_requests_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ListDedicatedIPRequests200Response**](ListDedicatedIPRequests200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+

data/docs/ListAddOns200Response.md

@@ -0,0 +1,18 @@
+# Lockally::ListAddOns200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **add_ons** | [**Array<AddOn>**](AddOn.md) |  |  |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::ListAddOns200Response.new(
+  add_ons: null
+)
+```
+

data/docs/ListCalendarEvents200Response.md

@@ -0,0 +1,18 @@
+# Lockally::ListCalendarEvents200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<CalendarEvent>**](CalendarEvent.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::ListCalendarEvents200Response.new(
+  data: null
+)
+```
+

data/docs/ListCalendarIntegrations200Response.md

@@ -0,0 +1,18 @@
+# Lockally::ListCalendarIntegrations200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<CalendarIntegration>**](CalendarIntegration.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::ListCalendarIntegrations200Response.new(
+  data: null
+)
+```
+

data/docs/ListCalendarMembers200Response.md

@@ -0,0 +1,18 @@
+# Lockally::ListCalendarMembers200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<CalendarMember>**](CalendarMember.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::ListCalendarMembers200Response.new(
+  data: null
+)
+```
+

data/docs/ListCalendars200Response.md

@@ -0,0 +1,18 @@
+# Lockally::ListCalendars200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<Calendar>**](Calendar.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::ListCalendars200Response.new(
+  data: null
+)
+```
+

data/docs/ListContactLists200Response.md

@@ -0,0 +1,18 @@
+# Lockally::ListContactLists200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<ContactList>**](ContactList.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::ListContactLists200Response.new(
+  data: null
+)
+```
+

data/docs/ListContacts200Response.md

@@ -0,0 +1,18 @@
+# Lockally::ListContacts200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<Contact>**](Contact.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::ListContacts200Response.new(
+  data: null
+)
+```
+

data/docs/ListDedicatedIPRequests200Response.md

@@ -0,0 +1,18 @@
+# Lockally::ListDedicatedIPRequests200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<DedicatedIPRequest>**](DedicatedIPRequest.md) |  |  |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::ListDedicatedIPRequests200Response.new(
+  data: null
+)
+```
+

data/docs/ListDistributionLists200Response.md

@@ -0,0 +1,18 @@
+# Lockally::ListDistributionLists200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<DistributionListSummary>**](DistributionListSummary.md) |  |  |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::ListDistributionLists200Response.new(
+  data: null
+)
+```
+

data/docs/ListMigrationCredentials200Response.md

@@ -0,0 +1,18 @@
+# Lockally::ListMigrationCredentials200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<MigrationCredential>**](MigrationCredential.md) |  |  |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::ListMigrationCredentials200Response.new(
+  data: null
+)
+```
+

data/docs/ListMigrationEvents200Response.md

@@ -0,0 +1,18 @@
+# Lockally::ListMigrationEvents200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<MigrationEvent>**](MigrationEvent.md) |  |  |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::ListMigrationEvents200Response.new(
+  data: null
+)
+```
+

data/docs/ListMigrationMailboxes200Response.md

@@ -0,0 +1,18 @@
+# Lockally::ListMigrationMailboxes200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<MigrationMailbox>**](MigrationMailbox.md) |  |  |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::ListMigrationMailboxes200Response.new(
+  data: null
+)
+```
+

data/docs/ListMigrations200Response.md

@@ -0,0 +1,18 @@
+# Lockally::ListMigrations200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<Migration>**](Migration.md) |  |  |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::ListMigrations200Response.new(
+  data: null
+)
+```
+

data/docs/ListResources200Response.md

@@ -0,0 +1,18 @@
+# Lockally::ListResources200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<Resource>**](Resource.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::ListResources200Response.new(
+  data: null
+)
+```
+

data/docs/ListSharedMembers200Response.md

@@ -0,0 +1,18 @@
+# Lockally::ListSharedMembers200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<SharedMember>**](SharedMember.md) |  |  |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::ListSharedMembers200Response.new(
+  data: null
+)
+```
+

data/docs/ListUsers200Response.md

@@ -0,0 +1,20 @@
+# Lockally::ListUsers200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<User>**](User.md) |  |  |
+| **limit** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::ListUsers200Response.new(
+  data: null,
+  limit: null
+)
+```
+

data/docs/Mailbox.md

@@ -0,0 +1,38 @@
+# Lockally::Mailbox
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **tenant_id** | **String** |  |  |
+| **domain_id** | **String** |  |  |
+| **email** | **String** |  |  |
+| **quota_bytes** | **Integer** |  |  |
+| **disabled** | **Boolean** |  |  |
+| **disabled_at** | **Time** |  | [optional] |
+| **soft_deleted_at** | **Time** |  | [optional] |
+| **hard_delete_after** | **Time** |  | [optional] |
+| **created_at** | **Time** |  |  |
+| **password** | **String** | ONLY present on POST response when lockally generated the password. Shown once. | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::Mailbox.new(
+  id: null,
+  tenant_id: null,
+  domain_id: null,
+  email: null,
+  quota_bytes: null,
+  disabled: null,
+  disabled_at: null,
+  soft_deleted_at: null,
+  hard_delete_after: null,
+  created_at: null,
+  password: null
+)
+```
+