solifyn 1.0.0

data/docs/LicenseKeysClientApi.md

@@ -0,0 +1,289 @@
+# Solifyn::LicenseKeysClientApi
+
+All URIs are relative to *http://localhost:8000*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**licenses_activate**](LicenseKeysClientApi.md#licenses_activate) | **POST** /v1/licenses/activate | Activate License Key |
+| [**licenses_deactivate**](LicenseKeysClientApi.md#licenses_deactivate) | **POST** /v1/licenses/deactivate/{instanceId} | Deactivate Instance |
+| [**licenses_instances**](LicenseKeysClientApi.md#licenses_instances) | **GET** /v1/licenses/instances/{licenseId} | Get Active Instances |
+| [**licenses_verify**](LicenseKeysClientApi.md#licenses_verify) | **POST** /v1/licenses/verify | Validate License Key |
+
+
+## licenses_activate
+
+> <Instance> licenses_activate(licenses_activate_request)
+
+Activate License Key
+
+Register and activate a device or instance for a specific license key.
+
+### Examples
+
+```ruby
+require 'time'
+require 'solifyn'
+# setup authorization
+Solifyn.configure do |config|
+  # Configure Bearer authorization (API Key): ApiKeyAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Solifyn::LicenseKeysClientApi.new
+licenses_activate_request = Solifyn::LicensesActivateRequest.new({key: 'key_example', device_identifier: 'device_identifier_example', name: 'name_example'}) # LicensesActivateRequest | 
+
+begin
+  # Activate License Key
+  result = api_instance.licenses_activate(licenses_activate_request)
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling LicenseKeysClientApi->licenses_activate: #{e}"
+end
+```
+
+#### Using the licenses_activate_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Instance>, Integer, Hash)> licenses_activate_with_http_info(licenses_activate_request)
+
+```ruby
+begin
+  # Activate License Key
+  data, status_code, headers = api_instance.licenses_activate_with_http_info(licenses_activate_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Instance>
+rescue Solifyn::ApiError => e
+  puts "Error when calling LicenseKeysClientApi->licenses_activate_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **licenses_activate_request** | [**LicensesActivateRequest**](LicensesActivateRequest.md) |  |  |
+
+### Return type
+
+[**Instance**](Instance.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## licenses_deactivate
+
+> <LicensesDeactivate200Response> licenses_deactivate(instance_id, licenses_deactivate_request)
+
+Deactivate Instance
+
+Deactivate or unregister an active device instance from a license key.
+
+### Examples
+
+```ruby
+require 'time'
+require 'solifyn'
+# setup authorization
+Solifyn.configure do |config|
+  # Configure Bearer authorization (API Key): ApiKeyAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Solifyn::LicenseKeysClientApi.new
+instance_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The unique device instance ID.
+licenses_deactivate_request = Solifyn::LicensesDeactivateRequest.new({key: 'key_example'}) # LicensesDeactivateRequest | 
+
+begin
+  # Deactivate Instance
+  result = api_instance.licenses_deactivate(instance_id, licenses_deactivate_request)
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling LicenseKeysClientApi->licenses_deactivate: #{e}"
+end
+```
+
+#### Using the licenses_deactivate_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<LicensesDeactivate200Response>, Integer, Hash)> licenses_deactivate_with_http_info(instance_id, licenses_deactivate_request)
+
+```ruby
+begin
+  # Deactivate Instance
+  data, status_code, headers = api_instance.licenses_deactivate_with_http_info(instance_id, licenses_deactivate_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <LicensesDeactivate200Response>
+rescue Solifyn::ApiError => e
+  puts "Error when calling LicenseKeysClientApi->licenses_deactivate_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **instance_id** | **String** | The unique device instance ID. |  |
+| **licenses_deactivate_request** | [**LicensesDeactivateRequest**](LicensesDeactivateRequest.md) |  |  |
+
+### Return type
+
+[**LicensesDeactivate200Response**](LicensesDeactivate200Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## licenses_instances
+
+> <Array<Instance>> licenses_instances(license_id)
+
+Get Active Instances
+
+List all active devices or server instances linked to a specific license key.
+
+### Examples
+
+```ruby
+require 'time'
+require 'solifyn'
+# setup authorization
+Solifyn.configure do |config|
+  # Configure Bearer authorization (API Key): ApiKeyAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Solifyn::LicenseKeysClientApi.new
+license_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The unique license key ID.
+
+begin
+  # Get Active Instances
+  result = api_instance.licenses_instances(license_id)
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling LicenseKeysClientApi->licenses_instances: #{e}"
+end
+```
+
+#### Using the licenses_instances_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Instance>>, Integer, Hash)> licenses_instances_with_http_info(license_id)
+
+```ruby
+begin
+  # Get Active Instances
+  data, status_code, headers = api_instance.licenses_instances_with_http_info(license_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Instance>>
+rescue Solifyn::ApiError => e
+  puts "Error when calling LicenseKeysClientApi->licenses_instances_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **license_id** | **String** | The unique license key ID. |  |
+
+### Return type
+
+[**Array&lt;Instance&gt;**](Instance.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## licenses_verify
+
+> <LicenseValidationResponse> licenses_verify(licenses_verify_request)
+
+Validate License Key
+
+Verify if a software license key is valid, active, and has not exceeded its limits.
+
+### Examples
+
+```ruby
+require 'time'
+require 'solifyn'
+# setup authorization
+Solifyn.configure do |config|
+  # Configure Bearer authorization (API Key): ApiKeyAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = Solifyn::LicenseKeysClientApi.new
+licenses_verify_request = Solifyn::LicensesVerifyRequest.new({key: 'key_example', product_id: 'product_id_example'}) # LicensesVerifyRequest | 
+
+begin
+  # Validate License Key
+  result = api_instance.licenses_verify(licenses_verify_request)
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling LicenseKeysClientApi->licenses_verify: #{e}"
+end
+```
+
+#### Using the licenses_verify_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<LicenseValidationResponse>, Integer, Hash)> licenses_verify_with_http_info(licenses_verify_request)
+
+```ruby
+begin
+  # Validate License Key
+  data, status_code, headers = api_instance.licenses_verify_with_http_info(licenses_verify_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <LicenseValidationResponse>
+rescue Solifyn::ApiError => e
+  puts "Error when calling LicenseKeysClientApi->licenses_verify_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **licenses_verify_request** | [**LicensesVerifyRequest**](LicensesVerifyRequest.md) |  |  |
+
+### Return type
+
+[**LicenseValidationResponse**](LicenseValidationResponse.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/LicenseSubDto.md

@@ -0,0 +1,30 @@
+# Solifyn::LicenseSubDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **key** | **String** |  |  |
+| **status** | **String** |  |  |
+| **activation_limit** | **Float** |  |  |
+| **activation_message** | **String** |  |  |
+| **expires_at** | **String** |  |  |
+| **product** | [**ProductSubDto**](ProductSubDto.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::LicenseSubDto.new(
+  id: null,
+  key: null,
+  status: null,
+  activation_limit: null,
+  activation_message: null,
+  expires_at: null,
+  product: null
+)
+```
+

data/docs/LicenseValidationResponse.md

@@ -0,0 +1,22 @@
+# Solifyn::LicenseValidationResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Boolean** |  |  |
+| **valid** | **Boolean** |  |  |
+| **license** | [**LicenseSubDto**](LicenseSubDto.md) |  |  |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::LicenseValidationResponse.new(
+  success: null,
+  valid: null,
+  license: null
+)
+```
+

data/docs/LicensesActivateRequest.md

@@ -0,0 +1,22 @@
+# Solifyn::LicensesActivateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** | The license key. |  |
+| **device_identifier** | **String** | Unique identifier of the device/machine being activated. |  |
+| **name** | **String** | A user-friendly label/name for the instance. |  |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::LicensesActivateRequest.new(
+  key: null,
+  device_identifier: null,
+  name: null
+)
+```
+

data/docs/LicensesCreateRequest.md

@@ -0,0 +1,26 @@
+# Solifyn::LicensesCreateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **product_id** | **String** | The unique product identifier (internal product ID or ID) for which the license key will be issued. |  |
+| **customer_id** | **String** | The unique customer identifier (internal customer ID or ID) who will own this license key. |  |
+| **activation_limit** | **Integer** | The maximum number of concurrent device or server activations allowed for this license key. | [optional] |
+| **expiry_hours** | **Integer** | Relative validity period of the license in hours starting from the time of creation. | [optional] |
+| **key** | **String** | Optional custom license key string. If not provided, a random uppercase cryptographic serial key (e.g., ABCD-EFGH) will be generated automatically. | [optional] |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::LicensesCreateRequest.new(
+  product_id: null,
+  customer_id: null,
+  activation_limit: null,
+  expiry_hours: null,
+  key: null
+)
+```
+

data/docs/LicensesDeactivate200Response.md

@@ -0,0 +1,18 @@
+# Solifyn::LicensesDeactivate200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::LicensesDeactivate200Response.new(
+  success: null
+)
+```
+

data/docs/LicensesDeactivateRequest.md

@@ -0,0 +1,18 @@
+# Solifyn::LicensesDeactivateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** | The license key. |  |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::LicensesDeactivateRequest.new(
+  key: null
+)
+```
+

data/docs/LicensesUpdateInstancePostRequest.md

@@ -0,0 +1,20 @@
+# Solifyn::LicensesUpdateInstancePostRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **instance_name** | **String** | A new human-readable display name for this instance. | [optional] |
+| **ip_address** | **String** | A new IP address to record for this instance. | [optional] |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::LicensesUpdateInstancePostRequest.new(
+  instance_name: MacBook Pro 16",
+  ip_address: 203.0.113.42
+)
+```
+

data/docs/LicensesUpdateRequest.md

@@ -0,0 +1,22 @@
+# Solifyn::LicensesUpdateRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** |  | [optional] |
+| **activation_limit** | **Integer** |  | [optional] |
+| **expires_at** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::LicensesUpdateRequest.new(
+  status: null,
+  activation_limit: null,
+  expires_at: null
+)
+```
+

data/docs/LicensesVerifyRequest.md

@@ -0,0 +1,20 @@
+# Solifyn::LicensesVerifyRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **key** | **String** | The license key to validate. |  |
+| **product_id** | **String** | The product ID associated with the license. |  |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::LicensesVerifyRequest.new(
+  key: null,
+  product_id: null
+)
+```
+

data/docs/MeterDetailResponseDto.md

@@ -0,0 +1,44 @@
+# Solifyn::MeterDetailResponseDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The unique meter ID. |  |
+| **business_id** | **String** | The business ID that owns this meter. |  |
+| **name** | **String** | Meter display name. |  |
+| **description** | **Object** | Meter description. | [optional] |
+| **event_name** | **String** | The event name tracked by this meter. |  |
+| **aggregation_type** | **String** | Aggregation strategy for usage events. |  |
+| **aggregation_key** | **Object** | Metadata key used for aggregation. | [optional] |
+| **unit** | **Object** | Measurement unit label. | [optional] |
+| **filters** | **Hash<String, Object>** | Optional filter definition for advanced matching. | [optional] |
+| **archived** | **Boolean** | Whether the meter is archived. |  |
+| **created_at** | **Time** | Creation timestamp. |  |
+| **updated_at** | **Time** | Last update timestamp. |  |
+| **usage_events** | [**Array<MeterUsageEventDto>**](MeterUsageEventDto.md) | Most recent usage events recorded for the meter. |  |
+| **total_usage_events** | **Float** | Total usage event count for the meter. |  |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::MeterDetailResponseDto.new(
+  id: mtr_8Z1aB2cD3eF4gH5iJ6kL7m,
+  business_id: biz_4r5t6y7u8i9o,
+  name: API Request Count,
+  description: Counts successful API requests for usage-based billing.,
+  event_name: api.request,
+  aggregation_type: COUNT,
+  aggregation_key: tokens,
+  unit: requests,
+  filters: {event_type=premium, region=asia},
+  archived: false,
+  created_at: 2026-05-23T10:00:00.000Z,
+  updated_at: 2026-05-23T10:00:00.000Z,
+  usage_events: null,
+  total_usage_events: 1284
+)
+```
+

data/docs/MeterEventsResponseDto.md

@@ -0,0 +1,22 @@
+# Solifyn::MeterEventsResponseDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **meter_id** | **String** | The unique meter ID. |  |
+| **items** | [**Array<MeterUsageEventDto>**](MeterUsageEventDto.md) | List of recent usage events. |  |
+| **count** | **Float** | Number of returned usage events. |  |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::MeterEventsResponseDto.new(
+  meter_id: mtr_8Z1aB2cD3eF4gH5iJ6kL7m,
+  items: null,
+  count: 100
+)
+```
+

data/docs/MeterIngestEventDto.md

@@ -0,0 +1,28 @@
+# Solifyn::MeterIngestEventDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **event_id** | **String** | Unique usage event ID for idempotency. |  |
+| **customer_id** | **String** | Unique customer ID associated with the event. |  |
+| **event_name** | **String** | Event name that should match a meter eventName. |  |
+| **value** | **Float** | Event quantity value. | [optional][default to 1] |
+| **metadata** | **Hash<String, Object>** | Metadata attached to the usage event. | [optional] |
+| **timestamp** | **String** | Timestamp of the event in ISO 8601 format. | [optional] |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::MeterIngestEventDto.new(
+  event_id: evt_9Y3kP4qR7tU1vW2xZ5aB6c,
+  customer_id: cus_8n7m6l5k4j3h2g1f0e9d8c,
+  event_name: api.request,
+  value: 1,
+  metadata: {plan=enterprise, region=asia-southeast-1},
+  timestamp: 2026-05-23T10:00:00.000Z
+)
+```
+

data/docs/MeterIngestRequestDto.md

@@ -0,0 +1,18 @@
+# Solifyn::MeterIngestRequestDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **events** | [**Array<MeterIngestEventDto>**](MeterIngestEventDto.md) | List of usage events to ingest. |  |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::MeterIngestRequestDto.new(
+  events: null
+)
+```
+

data/docs/MeterIngestResponseDto.md

@@ -0,0 +1,22 @@
+# Solifyn::MeterIngestResponseDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **processed** | **Float** | Number of successfully processed events. |  |
+| **failed** | **Float** | Number of failed events. |  |
+| **errors** | **Array<Object>** | List of errors encountered during ingestion. |  |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::MeterIngestResponseDto.new(
+  processed: 5,
+  failed: 1,
+  errors: [{event=evt_9Y3kP4qR7tU1vW2xZ5aB6c, error=Meter not found}]
+)
+```
+

data/docs/MeterQuantitiesCostDto.md

@@ -0,0 +1,26 @@
+# Solifyn::MeterQuantitiesCostDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **product_id** | **String** | The product ID attached to the meter. |  |
+| **total_usage** | **Float** | Total usage in the requested date range. |  |
+| **billable_usage** | **Float** | Billable usage after free threshold is applied. |  |
+| **cost** | **Float** | Calculated cost for this product. |  |
+| **currency** | **String** | Currency used for the cost calculation. |  |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::MeterQuantitiesCostDto.new(
+  product_id: prod_9z8x7c6v5b4n,
+  total_usage: 1540,
+  billable_usage: 1500,
+  cost: 19.5,
+  currency: USD
+)
+```
+

data/docs/MeterQuantitiesResponseDto.md

@@ -0,0 +1,24 @@
+# Solifyn::MeterQuantitiesResponseDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **meter_id** | **String** | The unique meter ID. |  |
+| **name** | **String** | Meter display name. |  |
+| **total_usage** | **Float** | Total usage within the selected time range. |  |
+| **costs** | [**Array<MeterQuantitiesCostDto>**](MeterQuantitiesCostDto.md) | Cost breakdown for products attached to the meter. |  |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::MeterQuantitiesResponseDto.new(
+  meter_id: mtr_8Z1aB2cD3eF4gH5iJ6kL7m,
+  name: API Request Count,
+  total_usage: 1540,
+  costs: null
+)
+```
+