license_manager 0.1.0

data/docs/EventMachine.md

@@ -0,0 +1,22 @@
+# LicenseManager::EventMachine
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **name** | **String** |  |  |
+| **fingerprint** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'license_manager'
+
+instance = LicenseManager::EventMachine.new(
+  id: m9Tq3VhD,
+  name: Jane's MacBook,
+  fingerprint: 4c:32:75:8f:9a:1e
+)
+```
+

data/docs/EventType.md

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

data/docs/EventsApi.md

@@ -0,0 +1,173 @@
+# LicenseManager::EventsApi
+
+All URIs are relative to *https://api.licensemanager.dev*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**list_license_events**](EventsApi.md#list_license_events) | **GET** /v1/licenses/{id}/events | List the events of a license |
+| [**list_policy_events**](EventsApi.md#list_policy_events) | **GET** /v1/policies/{id}/events | List the events of a policy |
+
+
+## list_license_events
+
+> <EventList> list_license_events(id, opts)
+
+List the events of a license
+
+Includes the validations of the license on each of its machines. Doesn't accept tokens: only API keys and sessions.
+
+### Examples
+
+```ruby
+require 'time'
+require 'license_manager'
+# setup authorization
+LicenseManager.configure do |config|
+  # Configure API key authorization: apiKey
+  config.api_key['x-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['x-api-key'] = 'Bearer'
+end
+
+api_instance = LicenseManager::EventsApi.new
+id = 'l3Nv8KwB' # String | 
+opts = {
+  page: 1, # Integer | Page to return. Pages are numbered from 1: `1` is the first page. A page past the last one returns an empty `data`, not an error. Defaults to `1`.
+  page_size: 20, # Integer | Maximum number of items per page, from 1 to 100. Every page holds this many items except the last one, which can hold fewer. Defaults to `20`.
+  sort: 'createdAt', # String | Field to sort by, prefixed with `-` for descending order. Defaults to `-createdAt`.
+  type: LicenseManager::ListPolicyEventsTypeParameter.new, # ListPolicyEventsTypeParameter | Only returns the events of this type. Repeat it to return the events of any of these types.
+  machine_id: 'm9Tq3VhD' # String | Only returns the events of this machine of the license.
+}
+
+begin
+  # List the events of a license
+  result = api_instance.list_license_events(id, opts)
+  p result
+rescue LicenseManager::ApiError => e
+  puts "Error when calling EventsApi->list_license_events: #{e}"
+end
+```
+
+#### Using the list_license_events_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<EventList>, Integer, Hash)> list_license_events_with_http_info(id, opts)
+
+```ruby
+begin
+  # List the events of a license
+  data, status_code, headers = api_instance.list_license_events_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EventList>
+rescue LicenseManager::ApiError => e
+  puts "Error when calling EventsApi->list_license_events_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **page** | **Integer** | Page to return. Pages are numbered from 1: &#x60;1&#x60; is the first page. A page past the last one returns an empty &#x60;data&#x60;, not an error. Defaults to &#x60;1&#x60;. | [optional][default to 1] |
+| **page_size** | **Integer** | Maximum number of items per page, from 1 to 100. Every page holds this many items except the last one, which can hold fewer. Defaults to &#x60;20&#x60;. | [optional][default to 20] |
+| **sort** | **String** | Field to sort by, prefixed with &#x60;-&#x60; for descending order. Defaults to &#x60;-createdAt&#x60;. | [optional][default to &#39;-createdAt&#39;] |
+| **type** | [**ListPolicyEventsTypeParameter**](.md) | Only returns the events of this type. Repeat it to return the events of any of these types. | [optional] |
+| **machine_id** | **String** | Only returns the events of this machine of the license. | [optional] |
+
+### Return type
+
+[**EventList**](EventList.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_policy_events
+
+> <EventList> list_policy_events(id, opts)
+
+List the events of a policy
+
+Doesn't accept tokens: only API keys and sessions.
+
+### Examples
+
+```ruby
+require 'time'
+require 'license_manager'
+# setup authorization
+LicenseManager.configure do |config|
+  # Configure API key authorization: apiKey
+  config.api_key['x-api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['x-api-key'] = 'Bearer'
+end
+
+api_instance = LicenseManager::EventsApi.new
+id = 'l3Nv8KwB' # String | 
+opts = {
+  page: 1, # Integer | Page to return. Pages are numbered from 1: `1` is the first page. A page past the last one returns an empty `data`, not an error. Defaults to `1`.
+  page_size: 20, # Integer | Maximum number of items per page, from 1 to 100. Every page holds this many items except the last one, which can hold fewer. Defaults to `20`.
+  sort: 'createdAt', # String | Field to sort by, prefixed with `-` for descending order. Defaults to `-createdAt`.
+  type: LicenseManager::ListPolicyEventsTypeParameter.new # ListPolicyEventsTypeParameter | Only returns the events of this type. Repeat it to return the events of any of these types.
+}
+
+begin
+  # List the events of a policy
+  result = api_instance.list_policy_events(id, opts)
+  p result
+rescue LicenseManager::ApiError => e
+  puts "Error when calling EventsApi->list_policy_events: #{e}"
+end
+```
+
+#### Using the list_policy_events_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<EventList>, Integer, Hash)> list_policy_events_with_http_info(id, opts)
+
+```ruby
+begin
+  # List the events of a policy
+  data, status_code, headers = api_instance.list_policy_events_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <EventList>
+rescue LicenseManager::ApiError => e
+  puts "Error when calling EventsApi->list_policy_events_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **page** | **Integer** | Page to return. Pages are numbered from 1: &#x60;1&#x60; is the first page. A page past the last one returns an empty &#x60;data&#x60;, not an error. Defaults to &#x60;1&#x60;. | [optional][default to 1] |
+| **page_size** | **Integer** | Maximum number of items per page, from 1 to 100. Every page holds this many items except the last one, which can hold fewer. Defaults to &#x60;20&#x60;. | [optional][default to 20] |
+| **sort** | **String** | Field to sort by, prefixed with &#x60;-&#x60; for descending order. Defaults to &#x60;-createdAt&#x60;. | [optional][default to &#39;-createdAt&#39;] |
+| **type** | [**ListPolicyEventsTypeParameter**](.md) | Only returns the events of this type. Repeat it to return the events of any of these types. | [optional] |
+
+### Return type
+
+[**EventList**](EventList.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/FixedMaxVersion.md

@@ -0,0 +1,20 @@
+# LicenseManager::FixedMaxVersion
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **type** | **String** |  |  |
+| **version** | **String** | `\"2\"` allows every 2.y.z version: the minor versions and bug fixes of version 2. `\"2.3\"` allows every 2.3.z version: the bug fixes of version 2.3. Bug fixes can't be locked, so patch numbers like `\"2.3.1\"` are rejected. |  |
+
+## Example
+
+```ruby
+require 'license_manager'
+
+instance = LicenseManager::FixedMaxVersion.new(
+  type: null,
+  version: 2.3
+)
+```
+

data/docs/Integration.md

@@ -0,0 +1,38 @@
+# LicenseManager::Integration
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **provider** | **String** |  |  |
+| **livemode** | **Boolean** | Whether it's connected in live mode, for the live products, or in test mode, for the test products. |  |
+| **account_name** | **String** | Name of the Stripe account, `null` when the API key can't read it. |  |
+| **api_key_hint** | **String** | Start and end of the API key, to recognize it. |  |
+| **webhook_url** | **String** | URL of the webhook endpoint created on the Stripe account. |  |
+| **status** | [**IntegrationStatus**](IntegrationStatus.md) |  |  |
+| **status_reason** | **String** | Why the integration isn't `active`, `null` when it is. |  |
+| **last_checked_at** | **Time** | Last time its health was checked, done every day. |  |
+| **last_event_at** | **Time** | Last time it received an event from the provider. |  |
+| **created_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'license_manager'
+
+instance = LicenseManager::Integration.new(
+  id: i8Fz4QnRt,
+  provider: null,
+  livemode: null,
+  account_name: Acme Inc.,
+  api_key_hint: rk_live_…Ab3d,
+  webhook_url: https://api.example.com/v1/webhooks/stripe/i8Fz4QnRt,
+  status: null,
+  status_reason: The API key can't manage webhook endpoints: give it the Webhook Endpoints: Write permission,
+  last_checked_at: null,
+  last_event_at: null,
+  created_at: null
+)
+```
+

data/docs/IntegrationMapping.md

@@ -0,0 +1,38 @@
+# LicenseManager::IntegrationMapping
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **integration_id** | **String** |  |  |
+| **product_id** | **String** |  |  |
+| **policy_id** | **String** |  |  |
+| **stripe_product_id** | **String** |  |  |
+| **stripe_price_id** | **String** |  |  |
+| **product_name** | **String** | Name of the Stripe product when it was mapped. |  |
+| **price** | [**Price**](Price.md) |  |  |
+| **status** | **String** | `error` when the price can no longer be paid, explained by `statusReason`. |  |
+| **status_reason** | **String** |  |  |
+| **created_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'license_manager'
+
+instance = LicenseManager::IntegrationMapping.new(
+  id: g2Lk7RwPa,
+  integration_id: i8Fz4QnRt,
+  product_id: x7Kp2QaZ,
+  policy_id: p4Rt8LmQ,
+  stripe_product_id: prod_NWjs8kKbJWmuuc,
+  stripe_price_id: price_1MoBy5LkdIwHu7ix,
+  product_name: Acme Pro,
+  price: null,
+  status: null,
+  status_reason: The price is archived in Stripe,
+  created_at: null
+)
+```
+

data/docs/IntegrationStatus.md

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