license_manager 0.1.0

data/docs/TokensApi.md

@@ -0,0 +1,235 @@
+# LicenseManager::TokensApi
+
+All URIs are relative to *https://api.licensemanager.dev*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_customer_token**](TokensApi.md#create_customer_token) | **POST** /v1/customers/{id}/tokens | Create a customer token |
+| [**create_license_token**](TokensApi.md#create_license_token) | **POST** /v1/licenses/{id}/tokens | Create a license token |
+| [**create_machine_token**](TokensApi.md#create_machine_token) | **POST** /v1/machines/{id}/tokens | Create a machine token |
+
+
+## create_customer_token
+
+> <Token> create_customer_token(id, create_token)
+
+Create a customer token
+
+Creates a token scoped to the customer, with the permissions of `scope`, to hand to your customers: a page of your website can then call the endpoints accepting tokens directly, without your API key. See the `token` security scheme for what a token reaches.  A token can't be revoked: it works until it expires, unless the resource it's scoped to is deleted.  **Required role permission**: `token:create` when called with a session, granted by the member's role. API keys aren't limited by roles.
+
+### 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::TokensApi.new
+id = 'c9Wd3RtE' # String | 
+create_token = LicenseManager::CreateToken.new({scope: [license: read,  machine: write]}) # CreateToken | 
+
+begin
+  # Create a customer token
+  result = api_instance.create_customer_token(id, create_token)
+  p result
+rescue LicenseManager::ApiError => e
+  puts "Error when calling TokensApi->create_customer_token: #{e}"
+end
+```
+
+#### Using the create_customer_token_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Token>, Integer, Hash)> create_customer_token_with_http_info(id, create_token)
+
+```ruby
+begin
+  # Create a customer token
+  data, status_code, headers = api_instance.create_customer_token_with_http_info(id, create_token)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Token>
+rescue LicenseManager::ApiError => e
+  puts "Error when calling TokensApi->create_customer_token_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **create_token** | [**CreateToken**](CreateToken.md) |  |  |
+
+### Return type
+
+[**Token**](Token.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## create_license_token
+
+> <Token> create_license_token(id, create_token)
+
+Create a license token
+
+Creates a token scoped to the license, with the permissions of `scope`, to hand to your customers: a page of your website can then call the endpoints accepting tokens directly, without your API key. See the `token` security scheme for what a token reaches.  A token can't be revoked: it works until it expires, unless the resource it's scoped to is deleted.  **Token access**: customer tokens. A customer token creates tokens for its customer's licenses, with the permissions and at most the expiration it has.  **Required role permission**: `token:create` when called with a session, granted by the member's role. API keys aren't limited by roles.
+
+### 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'
+
+  # Configure Bearer authorization (JWT): token
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = LicenseManager::TokensApi.new
+id = 'c9Wd3RtE' # String | 
+create_token = LicenseManager::CreateToken.new({scope: [license: read,  machine: write]}) # CreateToken | 
+
+begin
+  # Create a license token
+  result = api_instance.create_license_token(id, create_token)
+  p result
+rescue LicenseManager::ApiError => e
+  puts "Error when calling TokensApi->create_license_token: #{e}"
+end
+```
+
+#### Using the create_license_token_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Token>, Integer, Hash)> create_license_token_with_http_info(id, create_token)
+
+```ruby
+begin
+  # Create a license token
+  data, status_code, headers = api_instance.create_license_token_with_http_info(id, create_token)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Token>
+rescue LicenseManager::ApiError => e
+  puts "Error when calling TokensApi->create_license_token_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **create_token** | [**CreateToken**](CreateToken.md) |  |  |
+
+### Return type
+
+[**Token**](Token.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey), [token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## create_machine_token
+
+> <Token> create_machine_token(id, create_token)
+
+Create a machine token
+
+Creates a token scoped to the machine, with the permissions of `scope`, to hand to your customers: a page of your website can then call the endpoints accepting tokens directly, without your API key. See the `token` security scheme for what a token reaches.  A token can't be revoked: it works until it expires, unless the resource it's scoped to is deleted.  **Token access**: customer, license tokens. A customer or license token creates tokens for the machines it reaches, with the permissions and at most the expiration it has.  **Required role permission**: `token:create` when called with a session, granted by the member's role. API keys aren't limited by roles.
+
+### 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'
+
+  # Configure Bearer authorization (JWT): token
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = LicenseManager::TokensApi.new
+id = 'c9Wd3RtE' # String | 
+create_token = LicenseManager::CreateToken.new({scope: [license: read,  machine: write]}) # CreateToken | 
+
+begin
+  # Create a machine token
+  result = api_instance.create_machine_token(id, create_token)
+  p result
+rescue LicenseManager::ApiError => e
+  puts "Error when calling TokensApi->create_machine_token: #{e}"
+end
+```
+
+#### Using the create_machine_token_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Token>, Integer, Hash)> create_machine_token_with_http_info(id, create_token)
+
+```ruby
+begin
+  # Create a machine token
+  data, status_code, headers = api_instance.create_machine_token_with_http_info(id, create_token)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Token>
+rescue LicenseManager::ApiError => e
+  puts "Error when calling TokensApi->create_machine_token_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **create_token** | [**CreateToken**](CreateToken.md) |  |  |
+
+### Return type
+
+[**Token**](Token.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey), [token](../README.md#token)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/UpdateCustomer.md

@@ -0,0 +1,20 @@
+# LicenseManager::UpdateCustomer
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** | Unique within the product, regardless of case. Stored lower cased. | [optional] |
+| **name** | **String** | Display name of the customer. `null` when unknown. Defaults to `null`. | [optional] |
+
+## Example
+
+```ruby
+require 'license_manager'
+
+instance = LicenseManager::UpdateCustomer.new(
+  email: jane@example.com,
+  name: Jane Doe
+)
+```
+

data/docs/UpdateIntegrationMapping.md

@@ -0,0 +1,18 @@
+# LicenseManager::UpdateIntegrationMapping
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **policy_id** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'license_manager'
+
+instance = LicenseManager::UpdateIntegrationMapping.new(
+  policy_id: p4Rt8LmQ
+)
+```
+

data/docs/UpdateLicense.md

@@ -0,0 +1,28 @@
+# LicenseManager::UpdateLicense
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **expires_at** | **Time** | `null` makes the license never expire. | [optional] |
+| **meta** | **Hash<String, Object>** | Free-form JSON object. | [optional] |
+| **max_machines** | **Integer** | Maximum number of active machines the license can be used on. `null` for no limit. | [optional] |
+| **max_offline_duration_seconds** | **Integer** | Longest the applications can run offline with the license, in seconds. At least one hour (`3600`). | [optional] |
+| **max_version** | [**LicenseMaxVersionInput**](LicenseMaxVersionInput.md) | Latest version of the product the license can use. The values left out are kept. | [optional] |
+| **price** | [**PriceInput**](PriceInput.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'license_manager'
+
+instance = LicenseManager::UpdateLicense.new(
+  expires_at: 2027-01-15T09:30:00.000Z,
+  meta: {seats=5},
+  max_machines: 3,
+  max_offline_duration_seconds: 604800,
+  max_version: null,
+  price: null
+)
+```
+

data/docs/UpdatePolicy.md

@@ -0,0 +1,30 @@
+# LicenseManager::UpdatePolicy
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **slug** | **String** | Unique within the product. Defaults to the name, lower cased, without accents and special characters. Starts with `test_` in test products, which is added when missing, and removed in live products. | [optional] |
+| **is_default** | **Boolean** | `true` makes this policy the product's default, in place of the current one. | [optional] |
+| **duration** | [**PolicySettingsDuration**](PolicySettingsDuration.md) |  | [optional] |
+| **max_machines** | **Integer** | Maximum number of active machines of the licenses created with this policy, copied to each of them. `null` for no limit. Defaults to `null`. | [optional] |
+| **max_offline_duration_seconds** | **Integer** | Longest the applications can run offline with the licenses created with this policy, in seconds, copied to each of them. At least one hour (`3600`). Defaults to one week. | [optional] |
+| **max_version** | [**PolicySettingsMaxVersion**](PolicySettingsMaxVersion.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'license_manager'
+
+instance = LicenseManager::UpdatePolicy.new(
+  name: Yearly,
+  slug: yearly,
+  is_default: false,
+  duration: null,
+  max_machines: 3,
+  max_offline_duration_seconds: 604800,
+  max_version: null
+)
+```
+

data/docs/UpdateProduct.md

@@ -0,0 +1,22 @@
+# LicenseManager::UpdateProduct
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **slug** | **String** | Unique within the organization. Defaults to the name, lower cased, without accents and special characters. Starts with `test_` in test products, which is added when missing, and removed in live products. | [optional] |
+| **portal** | [**UpdateProductPortal**](UpdateProductPortal.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'license_manager'
+
+instance = LicenseManager::UpdateProduct.new(
+  name: Acme Pro,
+  slug: acme-pro,
+  portal: null
+)
+```
+

data/docs/UpdateProductPortal.md

@@ -0,0 +1,26 @@
+# LicenseManager::UpdateProductPortal
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **enabled** | **Boolean** | Whether customers can use the customer portal. When disabled, it answers `404`. | [optional] |
+| **brand_color** | **String** | Background of the portal's side panel, as `#rrggbb`, stored lower cased. `null` for the default color. | [optional] |
+| **accent_color** | **String** | Color of the portal's inputs and buttons, as `#rrggbb`, stored lower cased. `null` for the default color. | [optional] |
+| **return_url** | **String** | Link back to your website shown in the portal, when the portal's URL has no allowed `return_url`. `null` for no link. | [optional] |
+| **return_domains** | **Array<String>** | Domains the portal's `return_url` query parameter may point to, their subdomains included. Other return URLs are ignored, in favor of `returnUrl`. | [optional] |
+
+## Example
+
+```ruby
+require 'license_manager'
+
+instance = LicenseManager::UpdateProductPortal.new(
+  enabled: true,
+  brand_color: #1e3a8a,
+  accent_color: #2563eb,
+  return_url: https://example.com/account,
+  return_domains: [example.com]
+)
+```
+

data/docs/UpdateRelease.md

@@ -0,0 +1,20 @@
+# LicenseManager::UpdateRelease
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **version** | **String** | Semantic version, like `\"2.3.1\"` or `\"2.4.0-beta.1\"`, without a `v` prefix. Unique within the product. Each number has at most 9 digits. | [optional] |
+| **released_at** | **Time** | When the version is released, which can be in the future. Defaults to now. | [optional] |
+
+## Example
+
+```ruby
+require 'license_manager'
+
+instance = LicenseManager::UpdateRelease.new(
+  version: 2.3.1,
+  released_at: 2026-03-01T12:00:00.000Z
+)
+```
+

data/docs/ValidateKey.md

@@ -0,0 +1,26 @@
+# LicenseManager::ValidateKey
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** | License key, compared exactly: keys are case sensitive. |  |
+| **fingerprint** | **String** | Identifies the machine. Unique within the license. Compared exactly, case included: a different fingerprint is another machine. |  |
+| **version** | **String** | Version of the application running on the machine, like `\"1.4.2\"`. Its major and minor numbers are checked against the license's `maxVersion.version`: a `v` prefix and a pre-release are accepted, `\"v2.3.0-beta.1\"` counting as 2.3, and a version that doesn't start with a number is refused when the license has a `maxVersion.version`. It doesn't have to be one of the product's releases. |  |
+| **name** | **String** | Name of the machine. Replaces the current one when given. | [optional] |
+| **platform** | **String** | Platform of the machine. Replaces the current one when given. | [optional] |
+
+## Example
+
+```ruby
+require 'license_manager'
+
+instance = LicenseManager::ValidateKey.new(
+  key: 7KQ2M-X9ZPA-H4TRC-WN6EY-B3JDF,
+  fingerprint: 4c:32:75:8f:9a:1e,
+  version: 1.4.2,
+  name: Jane's MacBook,
+  platform: macOS
+)
+```
+

data/docs/ValidateKeyError.md

@@ -0,0 +1,18 @@
+# LicenseManager::ValidateKeyError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**ValidateKeyErrorError**](ValidateKeyErrorError.md) |  |  |
+
+## Example
+
+```ruby
+require 'license_manager'
+
+instance = LicenseManager::ValidateKeyError.new(
+  error: null
+)
+```
+

data/docs/ValidateKeyErrorError.md

@@ -0,0 +1,24 @@
+# LicenseManager::ValidateKeyErrorError
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** |  |  |
+| **message** | **String** |  |  |
+| **issues** | [**Array<ErrorErrorIssuesInner>**](ErrorErrorIssuesInner.md) | Present on `validation_error` errors. | [optional] |
+| **latest_allowed_version** | **String** | On `version_not_allowed` errors: version of the latest stable release of the product the license allows, among the ones already released. `null` when it allows none of them. | [optional] |
+
+## Example
+
+```ruby
+require 'license_manager'
+
+instance = LicenseManager::ValidateKeyErrorError.new(
+  code: not_found,
+  message: Resource not found,
+  issues: null,
+  latest_allowed_version: 2.3.1
+)
+```
+

data/git_push.sh

@@ -0,0 +1,54 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ -z "${git_host}" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \${git_host} to ${git_host}"
+fi
+
+if [ -z "${git_user_id}" ]; then
+    git_user_id="licenseman"
+    echo "[INFO] No command line input provided. Set \${git_user_id} to ${git_user_id}"
+fi
+
+if [ -z "${git_repo_id}" ]; then
+    git_repo_id="licensemanager-ruby"
+    echo "[INFO] No command line input provided. Set \${git_repo_id} to ${git_repo_id}"
+fi
+
+if [ -z "${release_note}" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \${release_note} to ${release_note}"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "${release_note}"
+
+# Sets the new remote
+if [ -z "$(git remote)" ]; then # git remote not defined
+    if [ -z "${GIT_TOKEN:-}" ]; then
+        echo "[INFO] \${GIT_TOKEN} (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin "https://${git_host}/${git_user_id}/${git_repo_id}.git"
+    else
+        git remote add origin "https://${git_user_id}:${GIT_TOKEN}@${git_host}/${git_user_id}/${git_repo_id}.git"
+    fi
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'