license_manager 0.1.0

data/docs/PortalApi.md

@@ -0,0 +1,289 @@
+# LicenseManager::PortalApi
+
+All URIs are relative to *https://api.licensemanager.dev*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_portal_link**](PortalApi.md#create_portal_link) | **POST** /v1/customers/{id}/portal-links | Create a link to the customer portal |
+| [**get_portal**](PortalApi.md#get_portal) | **GET** /v1/portal/{productId} | Get the customer portal of a product |
+| [**request_portal_link**](PortalApi.md#request_portal_link) | **POST** /v1/portal/{productId}/request-link | Email a link to the customer portal |
+| [**send_portal_link**](PortalApi.md#send_portal_link) | **POST** /v1/customers/{id}/portal-links/send | Email a link to the customer portal to the customer |
+
+
+## create_portal_link
+
+> <PortalLink> create_portal_link(id, create_portal_link)
+
+Create a link to the customer portal
+
+Link letting the customer see their licenses and deactivate their machines in the customer portal, without signing in. Anyone with the link can, until it expires or the customer is deleted: it can't be revoked otherwise. The token also works with the API endpoints that accept customer tokens.  Links can be created while the product's customer portal is disabled, but the portal answers `404` until it's enabled, and `sendPortalLink` refuses to email them.  **Required role permission**: `portalLink: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::PortalApi.new
+id = 'c9Wd3RtE' # String | 
+create_portal_link = LicenseManager::CreatePortalLink.new({expires_in_seconds: 604800}) # CreatePortalLink | 
+
+begin
+  # Create a link to the customer portal
+  result = api_instance.create_portal_link(id, create_portal_link)
+  p result
+rescue LicenseManager::ApiError => e
+  puts "Error when calling PortalApi->create_portal_link: #{e}"
+end
+```
+
+#### Using the create_portal_link_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PortalLink>, Integer, Hash)> create_portal_link_with_http_info(id, create_portal_link)
+
+```ruby
+begin
+  # Create a link to the customer portal
+  data, status_code, headers = api_instance.create_portal_link_with_http_info(id, create_portal_link)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PortalLink>
+rescue LicenseManager::ApiError => e
+  puts "Error when calling PortalApi->create_portal_link_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **create_portal_link** | [**CreatePortalLink**](CreatePortalLink.md) |  |  |
+
+### Return type
+
+[**PortalLink**](PortalLink.md)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_portal
+
+> <Portal> get_portal(product_id, opts)
+
+Get the customer portal of a product
+
+Names of the product and of its organization, colors of the customer portal, and link back to the product's website. Answers `404` when the product's customer portal is disabled: with the `portal_disabled` code and the slugs of the product and its organization when signed in as a member of the organization, so they can enable it. Doesn't need authentication.
+
+### Examples
+
+```ruby
+require 'time'
+require 'license_manager'
+
+api_instance = LicenseManager::PortalApi.new
+product_id = 'x7Kp2QaZ' # String | 
+opts = {
+  return_url: 'https://example.com/account' # String | Link back to your website to show, used when its domain is one of the product's `returnDomains`.
+}
+
+begin
+  # Get the customer portal of a product
+  result = api_instance.get_portal(product_id, opts)
+  p result
+rescue LicenseManager::ApiError => e
+  puts "Error when calling PortalApi->get_portal: #{e}"
+end
+```
+
+#### Using the get_portal_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Portal>, Integer, Hash)> get_portal_with_http_info(product_id, opts)
+
+```ruby
+begin
+  # Get the customer portal of a product
+  data, status_code, headers = api_instance.get_portal_with_http_info(product_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Portal>
+rescue LicenseManager::ApiError => e
+  puts "Error when calling PortalApi->get_portal_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **product_id** | **String** |  |  |
+| **return_url** | **String** | Link back to your website to show, used when its domain is one of the product&#39;s &#x60;returnDomains&#x60;. | [optional] |
+
+### Return type
+
+[**Portal**](Portal.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## request_portal_link
+
+> request_portal_link(product_id, request_portal_link)
+
+Email a link to the customer portal
+
+Emails the customer of the product with this email a link to the customer portal, working for 1 hour. Answers `404` when the product's customer portal is disabled. Answers the same whether the customer exists or not, so the API doesn't tell which emails are customers. Test products only email the members of the organization: the link isn't sent to other customers, with the same answer. Doesn't need authentication.
+
+### Examples
+
+```ruby
+require 'time'
+require 'license_manager'
+
+api_instance = LicenseManager::PortalApi.new
+product_id = 'x7Kp2QaZ' # String | 
+request_portal_link = LicenseManager::RequestPortalLink.new({email: 'jane@example.com'}) # RequestPortalLink | 
+
+begin
+  # Email a link to the customer portal
+  api_instance.request_portal_link(product_id, request_portal_link)
+rescue LicenseManager::ApiError => e
+  puts "Error when calling PortalApi->request_portal_link: #{e}"
+end
+```
+
+#### Using the request_portal_link_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)> request_portal_link_with_http_info(product_id, request_portal_link)
+
+```ruby
+begin
+  # Email a link to the customer portal
+  data, status_code, headers = api_instance.request_portal_link_with_http_info(product_id, request_portal_link)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue LicenseManager::ApiError => e
+  puts "Error when calling PortalApi->request_portal_link_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **product_id** | **String** |  |  |
+| **request_portal_link** | [**RequestPortalLink**](RequestPortalLink.md) |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## send_portal_link
+
+> send_portal_link(id, send_portal_link)
+
+Email a link to the customer portal to the customer
+
+Emails a link created with `createPortalLink` to the customer's email. Fails while the product's customer portal is disabled, and, in test products, when the customer's email isn't a member's of the organization: test products only email members, so testing never emails real customers.  **Required role permission**: `portalLink: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::PortalApi.new
+id = 'c9Wd3RtE' # String | 
+send_portal_link = LicenseManager::SendPortalLink.new({token: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9…'}) # SendPortalLink | 
+
+begin
+  # Email a link to the customer portal to the customer
+  api_instance.send_portal_link(id, send_portal_link)
+rescue LicenseManager::ApiError => e
+  puts "Error when calling PortalApi->send_portal_link: #{e}"
+end
+```
+
+#### Using the send_portal_link_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)> send_portal_link_with_http_info(id, send_portal_link)
+
+```ruby
+begin
+  # Email a link to the customer portal to the customer
+  data, status_code, headers = api_instance.send_portal_link_with_http_info(id, send_portal_link)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue LicenseManager::ApiError => e
+  puts "Error when calling PortalApi->send_portal_link_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **send_portal_link** | [**SendPortalLink**](SendPortalLink.md) |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/PortalLink.md

@@ -0,0 +1,22 @@
+# LicenseManager::PortalLink
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** | Link to the customer portal, holding the token. |  |
+| **token** | **String** | Customer token in the link, with the `customer:read`, `license:read` and `machine:write` permissions. |  |
+| **expires_at** | **Time** | When the link stops working. |  |
+
+## Example
+
+```ruby
+require 'license_manager'
+
+instance = LicenseManager::PortalLink.new(
+  url: https://app.example.com/portal/x7Kp2QaZ?token=eyJhbGciOi…,
+  token: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9…,
+  expires_at: 2026-01-22T09:30:00.000Z
+)
+```
+

data/docs/PortalNotFound.md

@@ -0,0 +1,22 @@
+# LicenseManager::PortalNotFound
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **error** | [**ErrorError**](ErrorError.md) |  |  |
+| **organization_slug** | **String** | Slug of the product's organization. Present on `portal_disabled` errors. | [optional] |
+| **product_slug** | **String** | Slug of the product. Present on `portal_disabled` errors. | [optional] |
+
+## Example
+
+```ruby
+require 'license_manager'
+
+instance = LicenseManager::PortalNotFound.new(
+  error: null,
+  organization_slug: acme,
+  product_slug: acme-pro
+)
+```
+

data/docs/PortalSettings.md

@@ -0,0 +1,26 @@
+# LicenseManager::PortalSettings
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **enabled** | **Boolean** | Whether customers can use the customer portal. When disabled, it answers `404`. |  |
+| **brand_color** | **String** | Background of the portal's side panel, as `#rrggbb`, stored lower cased. `null` for the default color. |  |
+| **accent_color** | **String** | Color of the portal's inputs and buttons, as `#rrggbb`, stored lower cased. `null` for the default color. |  |
+| **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. |  |
+| **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`. |  |
+
+## Example
+
+```ruby
+require 'license_manager'
+
+instance = LicenseManager::PortalSettings.new(
+  enabled: true,
+  brand_color: #1e3a8a,
+  accent_color: #2563eb,
+  return_url: https://example.com/account,
+  return_domains: [example.com]
+)
+```
+

data/docs/Price.md

@@ -0,0 +1,20 @@
+# LicenseManager::Price
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Float** | Amount in major units of the currency: `49.99` for $49.99, `5000` for ¥5,000. `0` for a free license. |  |
+| **currency** | **String** | ISO 4217 code of the currency, in upper case. |  |
+
+## Example
+
+```ruby
+require 'license_manager'
+
+instance = LicenseManager::Price.new(
+  amount: 49.99,
+  currency: USD
+)
+```
+

data/docs/PriceInput.md

@@ -0,0 +1,20 @@
+# LicenseManager::PriceInput
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **amount** | **Float** | Amount in major units of the currency: `49.99` for $49.99, `5000` for ¥5,000. `0` for a free license. At most as many decimals as the currency's minor unit: 2 for USD, 0 for JPY. |  |
+| **currency** | **String** | ISO 4217 code of the currency, in upper case. |  |
+
+## Example
+
+```ruby
+require 'license_manager'
+
+instance = LicenseManager::PriceInput.new(
+  amount: 49.99,
+  currency: USD
+)
+```
+

data/docs/Product.md

@@ -0,0 +1,32 @@
+# LicenseManager::Product
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **slug** | **String** |  |  |
+| **name** | **String** |  |  |
+| **is_test_from_product_id** | **String** | For test products, id of the live product they're a sandbox of. `null` for live products. |  |
+| **logo_url** | **String** | Public URL of the product's logo, shown in the web app and the customer portal. `null` without a logo. |  |
+| **portal** | [**PortalSettings**](PortalSettings.md) |  |  |
+| **created_at** | **Time** |  |  |
+| **updated_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'license_manager'
+
+instance = LicenseManager::Product.new(
+  id: x7Kp2QaZ,
+  slug: acme-pro,
+  name: Acme Pro,
+  is_test_from_product_id: null,
+  logo_url: https://cdn.example.com/logos/x7Kp2QaZ/k3f9a2LpQ7xw.webp,
+  portal: null,
+  created_at: 2026-01-15T09:30:00.000Z,
+  updated_at: 2026-01-15T09:30:00.000Z
+)
+```
+

data/docs/ProductList.md

@@ -0,0 +1,20 @@
+# LicenseManager::ProductList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<Product>**](Product.md) | Items of the page, in the requested order. Empty past the last page. |  |
+| **pagination** | [**Pagination**](Pagination.md) |  |  |
+
+## Example
+
+```ruby
+require 'license_manager'
+
+instance = LicenseManager::ProductList.new(
+  data: null,
+  pagination: null
+)
+```
+

data/docs/ProductStats.md

@@ -0,0 +1,54 @@
+# LicenseManager::ProductStats
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **license_count** | **Integer** | Number of licenses of the product. |  |
+| **active_license_count** | **Integer** | Number of licenses that haven't expired, and that a machine validated in the last 90 days. |  |
+| **new_license_count** | **Integer** | Number of licenses created in the last 30 days, today included, in UTC. |  |
+| **expiring_license_count** | **Integer** | Number of licenses expiring in the next 30 days. |  |
+| **expired_license_count** | **Integer** | Number of licenses that expired in the last 30 days. |  |
+| **active_machine_count** | **Integer** | Number of active machines of the licenses of the product. |  |
+| **in_use_license_count** | **Integer** | Number of licenses with at least one active machine. |  |
+| **seat_count** | **Integer** | Sum of the maximum numbers of machines of the licenses that haven't expired. Licenses without a maximum are left out. |  |
+| **used_seat_count** | **Integer** | Number of active machines of the licenses counted in `seatCount`, at most their maximum number of machines each. |  |
+| **full_license_count** | **Integer** | Number of licenses counted in `seatCount` active on their maximum number of machines. |  |
+| **days** | **Array<Date>** | The 30 days covered by the daily stats, from the oldest one, in UTC. |  |
+| **months** | **Array<String>** | The 12 months covered by the monthly stats, from the oldest one, in UTC. |  |
+| **new_licenses_by_day** | **Array<Integer>** | Number of licenses created each day, aligned on `days`. |  |
+| **new_licenses_by_month** | **Array<Integer>** | Number of licenses created each month, aligned on `months`. |  |
+| **new_licenses_by_policy** | [**Array<ProductStatsNewLicensesByPolicyInner>**](ProductStatsNewLicensesByPolicyInner.md) | Number of licenses of each policy created each day and each month, for the policies with licenses created over the covered months. |  |
+| **revenue** | [**Array<Revenue>**](Revenue.md) | Revenue in each currency licenses were sold in, from the one with the most licenses sold. Amounts aren't converted between currencies. |  |
+| **activations_by_version** | [**Array<ProductStatsActivationsByVersionInner>**](ProductStatsActivationsByVersionInner.md) | Successful activations of the licenses of the product each day, per version of the application, from the most recent one. |  |
+| **active_machines_by_version** | [**Array<ProductStatsActiveMachinesByVersionInner>**](ProductStatsActiveMachinesByVersionInner.md) | Number of active machines running each version of the application, from the most recent one. |  |
+| **active_machines_by_platform** | [**Array<ProductStatsActiveMachinesByPlatformInner>**](ProductStatsActiveMachinesByPlatformInner.md) | Number of active machines on each platform, from the one with the most machines. |  |
+
+## Example
+
+```ruby
+require 'license_manager'
+
+instance = LicenseManager::ProductStats.new(
+  license_count: 120,
+  active_license_count: 87,
+  new_license_count: 14,
+  expiring_license_count: 3,
+  expired_license_count: 2,
+  active_machine_count: 154,
+  in_use_license_count: 80,
+  seat_count: 200,
+  used_seat_count: 130,
+  full_license_count: 12,
+  days: null,
+  months: null,
+  new_licenses_by_day: [0, 2, 1],
+  new_licenses_by_month: [4, 9, 12],
+  new_licenses_by_policy: null,
+  revenue: null,
+  activations_by_version: null,
+  active_machines_by_version: null,
+  active_machines_by_platform: null
+)
+```
+

data/docs/ProductStatsActivationsByVersionInner.md

@@ -0,0 +1,20 @@
+# LicenseManager::ProductStatsActivationsByVersionInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **version** | **String** | `null` for the activations that didn't send a version. |  |
+| **counts** | **Array<Integer>** | Number of successful activations each day, aligned on `days`. |  |
+
+## Example
+
+```ruby
+require 'license_manager'
+
+instance = LicenseManager::ProductStatsActivationsByVersionInner.new(
+  version: 1.10.0,
+  counts: [0, 3, 1]
+)
+```
+

data/docs/ProductStatsActiveMachinesByPlatformInner.md

@@ -0,0 +1,20 @@
+# LicenseManager::ProductStatsActiveMachinesByPlatformInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **platform** | **String** | `null` for the machines that didn't send a platform. |  |
+| **count** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'license_manager'
+
+instance = LicenseManager::ProductStatsActiveMachinesByPlatformInner.new(
+  platform: macOS,
+  count: 42
+)
+```
+

data/docs/ProductStatsActiveMachinesByVersionInner.md

@@ -0,0 +1,20 @@
+# LicenseManager::ProductStatsActiveMachinesByVersionInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **version** | **String** | `null` for the machines that didn't send a version. |  |
+| **count** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'license_manager'
+
+instance = LicenseManager::ProductStatsActiveMachinesByVersionInner.new(
+  version: 1.10.0,
+  count: 42
+)
+```
+

data/docs/ProductStatsNewLicensesByPolicyInner.md

@@ -0,0 +1,22 @@
+# LicenseManager::ProductStatsNewLicensesByPolicyInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **policy_id** | **String** |  |  |
+| **by_day** | **Array<Float>** | Value each day, aligned on `days`. |  |
+| **by_month** | **Array<Float>** | Value each month, aligned on `months`. |  |
+
+## Example
+
+```ruby
+require 'license_manager'
+
+instance = LicenseManager::ProductStatsNewLicensesByPolicyInner.new(
+  policy_id: p4Rt8LmQ,
+  by_day: [0, 2, 1],
+  by_month: [4, 9, 12]
+)
+```
+