lockally 0.1.0

data/docs/SuppressionsApi.md

@@ -0,0 +1,284 @@
+# Lockally::SuppressionsApi
+
+All URIs are relative to *https://api.lockally.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**v1_suppressions_email_delete**](SuppressionsApi.md#v1_suppressions_email_delete) | **DELETE** /v1/suppressions/{email} | Remove a suppression |
+| [**v1_suppressions_email_get**](SuppressionsApi.md#v1_suppressions_email_get) | **GET** /v1/suppressions/{email} | Check whether an address is suppressed |
+| [**v1_suppressions_get**](SuppressionsApi.md#v1_suppressions_get) | **GET** /v1/suppressions | List suppressed recipients |
+| [**v1_suppressions_post**](SuppressionsApi.md#v1_suppressions_post) | **POST** /v1/suppressions | Add a suppression |
+
+
+## v1_suppressions_email_delete
+
+> v1_suppressions_email_delete(email)
+
+Remove a suppression
+
+### 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::SuppressionsApi.new
+email = 'email_example' # String | 
+
+begin
+  # Remove a suppression
+  api_instance.v1_suppressions_email_delete(email)
+rescue Lockally::ApiError => e
+  puts "Error when calling SuppressionsApi->v1_suppressions_email_delete: #{e}"
+end
+```
+
+#### Using the v1_suppressions_email_delete_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> v1_suppressions_email_delete_with_http_info(email)
+
+```ruby
+begin
+  # Remove a suppression
+  data, status_code, headers = api_instance.v1_suppressions_email_delete_with_http_info(email)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Lockally::ApiError => e
+  puts "Error when calling SuppressionsApi->v1_suppressions_email_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/problem+json
+
+
+## v1_suppressions_email_get
+
+> <Suppression> v1_suppressions_email_get(email)
+
+Check whether an address is suppressed
+
+### 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::SuppressionsApi.new
+email = 'email_example' # String | 
+
+begin
+  # Check whether an address is suppressed
+  result = api_instance.v1_suppressions_email_get(email)
+  p result
+rescue Lockally::ApiError => e
+  puts "Error when calling SuppressionsApi->v1_suppressions_email_get: #{e}"
+end
+```
+
+#### Using the v1_suppressions_email_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Suppression>, Integer, Hash)> v1_suppressions_email_get_with_http_info(email)
+
+```ruby
+begin
+  # Check whether an address is suppressed
+  data, status_code, headers = api_instance.v1_suppressions_email_get_with_http_info(email)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Suppression>
+rescue Lockally::ApiError => e
+  puts "Error when calling SuppressionsApi->v1_suppressions_email_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** |  |  |
+
+### Return type
+
+[**Suppression**](Suppression.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+
+
+## v1_suppressions_get
+
+> <V1SuppressionsGet200Response> v1_suppressions_get(opts)
+
+List suppressed recipients
+
+### 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::SuppressionsApi.new
+opts = {
+  reason: 'unsubscribe', # String | 
+  cursor: 'cursor_example', # String | 
+  limit: 56 # Integer | 
+}
+
+begin
+  # List suppressed recipients
+  result = api_instance.v1_suppressions_get(opts)
+  p result
+rescue Lockally::ApiError => e
+  puts "Error when calling SuppressionsApi->v1_suppressions_get: #{e}"
+end
+```
+
+#### Using the v1_suppressions_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<V1SuppressionsGet200Response>, Integer, Hash)> v1_suppressions_get_with_http_info(opts)
+
+```ruby
+begin
+  # List suppressed recipients
+  data, status_code, headers = api_instance.v1_suppressions_get_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <V1SuppressionsGet200Response>
+rescue Lockally::ApiError => e
+  puts "Error when calling SuppressionsApi->v1_suppressions_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **reason** | **String** |  | [optional] |
+| **cursor** | **String** |  | [optional] |
+| **limit** | **Integer** |  | [optional][default to 50] |
+
+### Return type
+
+[**V1SuppressionsGet200Response**](V1SuppressionsGet200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+
+
+## v1_suppressions_post
+
+> <Suppression> v1_suppressions_post(v1_suppressions_post_request)
+
+Add a suppression
+
+### 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::SuppressionsApi.new
+v1_suppressions_post_request = Lockally::V1SuppressionsPostRequest.new({email: 'email_example'}) # V1SuppressionsPostRequest | 
+
+begin
+  # Add a suppression
+  result = api_instance.v1_suppressions_post(v1_suppressions_post_request)
+  p result
+rescue Lockally::ApiError => e
+  puts "Error when calling SuppressionsApi->v1_suppressions_post: #{e}"
+end
+```
+
+#### Using the v1_suppressions_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Suppression>, Integer, Hash)> v1_suppressions_post_with_http_info(v1_suppressions_post_request)
+
+```ruby
+begin
+  # Add a suppression
+  data, status_code, headers = api_instance.v1_suppressions_post_with_http_info(v1_suppressions_post_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Suppression>
+rescue Lockally::ApiError => e
+  puts "Error when calling SuppressionsApi->v1_suppressions_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **v1_suppressions_post_request** | [**V1SuppressionsPostRequest**](V1SuppressionsPostRequest.md) |  |  |
+
+### Return type
+
+[**Suppression**](Suppression.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json, application/problem+json
+

data/docs/Template.md

@@ -0,0 +1,30 @@
+# Lockally::Template
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **name** | **String** |  | [optional] |
+| **subject** | **String** |  | [optional] |
+| **html** | **String** |  | [optional] |
+| **text** | **String** |  | [optional] |
+| **created_at** | **Time** |  | [optional] |
+| **updated_at** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::Template.new(
+  id: null,
+  name: null,
+  subject: null,
+  html: null,
+  text: null,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/TemplateInput.md

@@ -0,0 +1,24 @@
+# Lockally::TemplateInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Template name (1–120 chars). |  |
+| **subject** | **String** | May contain {{variable}} placeholders. | [optional] |
+| **html** | **String** | HTML body; {{variable}} values are HTML-escaped. | [optional] |
+| **text** | **String** | Plain-text body. | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::TemplateInput.new(
+  name: null,
+  subject: null,
+  html: null,
+  text: null
+)
+```
+

data/docs/TemplatesApi.md

@@ -0,0 +1,345 @@
+# Lockally::TemplatesApi
+
+All URIs are relative to *https://api.lockally.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**v1_templates_get**](TemplatesApi.md#v1_templates_get) | **GET** /v1/templates | List templates |
+| [**v1_templates_id_delete**](TemplatesApi.md#v1_templates_id_delete) | **DELETE** /v1/templates/{id} | Delete a template |
+| [**v1_templates_id_get**](TemplatesApi.md#v1_templates_id_get) | **GET** /v1/templates/{id} | Get a template |
+| [**v1_templates_id_put**](TemplatesApi.md#v1_templates_id_put) | **PUT** /v1/templates/{id} | Update a template |
+| [**v1_templates_post**](TemplatesApi.md#v1_templates_post) | **POST** /v1/templates | Create a template |
+
+
+## v1_templates_get
+
+> <V1TemplatesGet200Response> v1_templates_get
+
+List templates
+
+### 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::TemplatesApi.new
+
+begin
+  # List templates
+  result = api_instance.v1_templates_get
+  p result
+rescue Lockally::ApiError => e
+  puts "Error when calling TemplatesApi->v1_templates_get: #{e}"
+end
+```
+
+#### Using the v1_templates_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<V1TemplatesGet200Response>, Integer, Hash)> v1_templates_get_with_http_info
+
+```ruby
+begin
+  # List templates
+  data, status_code, headers = api_instance.v1_templates_get_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <V1TemplatesGet200Response>
+rescue Lockally::ApiError => e
+  puts "Error when calling TemplatesApi->v1_templates_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**V1TemplatesGet200Response**](V1TemplatesGet200Response.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+
+
+## v1_templates_id_delete
+
+> v1_templates_id_delete(id)
+
+Delete a template
+
+### 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::TemplatesApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+
+begin
+  # Delete a template
+  api_instance.v1_templates_id_delete(id)
+rescue Lockally::ApiError => e
+  puts "Error when calling TemplatesApi->v1_templates_id_delete: #{e}"
+end
+```
+
+#### Using the v1_templates_id_delete_with_http_info variant
+
+This returns an Array which contains the response data (`nil` in this case), status code and headers.
+
+> <Array(nil, Integer, Hash)> v1_templates_id_delete_with_http_info(id)
+
+```ruby
+begin
+  # Delete a template
+  data, status_code, headers = api_instance.v1_templates_id_delete_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Lockally::ApiError => e
+  puts "Error when calling TemplatesApi->v1_templates_id_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/problem+json
+
+
+## v1_templates_id_get
+
+> <Template> v1_templates_id_get(id)
+
+Get a template
+
+### 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::TemplatesApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+
+begin
+  # Get a template
+  result = api_instance.v1_templates_id_get(id)
+  p result
+rescue Lockally::ApiError => e
+  puts "Error when calling TemplatesApi->v1_templates_id_get: #{e}"
+end
+```
+
+#### Using the v1_templates_id_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Template>, Integer, Hash)> v1_templates_id_get_with_http_info(id)
+
+```ruby
+begin
+  # Get a template
+  data, status_code, headers = api_instance.v1_templates_id_get_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Template>
+rescue Lockally::ApiError => e
+  puts "Error when calling TemplatesApi->v1_templates_id_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+[**Template**](Template.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json, application/problem+json
+
+
+## v1_templates_id_put
+
+> <Template> v1_templates_id_put(id, template_input)
+
+Update a template
+
+### 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::TemplatesApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+template_input = Lockally::TemplateInput.new({name: 'name_example'}) # TemplateInput | 
+
+begin
+  # Update a template
+  result = api_instance.v1_templates_id_put(id, template_input)
+  p result
+rescue Lockally::ApiError => e
+  puts "Error when calling TemplatesApi->v1_templates_id_put: #{e}"
+end
+```
+
+#### Using the v1_templates_id_put_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Template>, Integer, Hash)> v1_templates_id_put_with_http_info(id, template_input)
+
+```ruby
+begin
+  # Update a template
+  data, status_code, headers = api_instance.v1_templates_id_put_with_http_info(id, template_input)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Template>
+rescue Lockally::ApiError => e
+  puts "Error when calling TemplatesApi->v1_templates_id_put_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **template_input** | [**TemplateInput**](TemplateInput.md) |  |  |
+
+### Return type
+
+[**Template**](Template.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json, application/problem+json
+
+
+## v1_templates_post
+
+> <Template> v1_templates_post(template_input)
+
+Create a template
+
+### 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::TemplatesApi.new
+template_input = Lockally::TemplateInput.new({name: 'name_example'}) # TemplateInput | 
+
+begin
+  # Create a template
+  result = api_instance.v1_templates_post(template_input)
+  p result
+rescue Lockally::ApiError => e
+  puts "Error when calling TemplatesApi->v1_templates_post: #{e}"
+end
+```
+
+#### Using the v1_templates_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Template>, Integer, Hash)> v1_templates_post_with_http_info(template_input)
+
+```ruby
+begin
+  # Create a template
+  data, status_code, headers = api_instance.v1_templates_post_with_http_info(template_input)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Template>
+rescue Lockally::ApiError => e
+  puts "Error when calling TemplatesApi->v1_templates_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **template_input** | [**TemplateInput**](TemplateInput.md) |  |  |
+
+### Return type
+
+[**Template**](Template.md)
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json, application/problem+json
+

data/docs/Tenant.md

@@ -0,0 +1,40 @@
+# Lockally::Tenant
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **slug** | **String** |  |  |
+| **display_name** | **String** |  |  |
+| **status** | **String** |  |  |
+| **plan** | **String** |  |  |
+| **rate_cap_per_min** | **Integer** | Per-tenant share of the per-VPS 5/min outbound cap (L6). |  |
+| **daily_msg_quota** | **Integer** |  |  |
+| **admin_email** | **String** |  |  |
+| **created_at** | **Time** |  |  |
+| **suspended_at** | **Time** |  | [optional] |
+| **closed_at** | **Time** |  | [optional] |
+| **hard_delete_after** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'lockally'
+
+instance = Lockally::Tenant.new(
+  id: null,
+  slug: workgrid,
+  display_name: WorkGrid,
+  status: null,
+  plan: starter,
+  rate_cap_per_min: 1,
+  daily_msg_quota: 1000,
+  admin_email: null,
+  created_at: null,
+  suspended_at: null,
+  closed_at: null,
+  hard_delete_after: null
+)
+```
+