solifyn 1.0.0

data/docs/MeterResponseDto.md

@@ -0,0 +1,40 @@
+# Solifyn::MeterResponseDto
+
+## 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. |  |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::MeterResponseDto.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
+)
+```
+

data/docs/MeterUsageEventDto.md

@@ -0,0 +1,30 @@
+# Solifyn::MeterUsageEventDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The unique usage event ID. |  |
+| **meter_id** | **String** | The meter ID this event belongs to. |  |
+| **customer_id** | **String** | The customer ID associated with the usage event. |  |
+| **value** | **Float** | Numeric usage value recorded for the event. |  |
+| **metadata** | **Hash<String, Object>** | Optional event metadata. | [optional] |
+| **timestamp** | **Time** | Timestamp when the usage event occurred. |  |
+| **processed_at** | **Time** | Timestamp when the usage event was processed. |  |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::MeterUsageEventDto.new(
+  id: evt_9Y3kP4qR7tU1vW2xZ5aB6c,
+  meter_id: mtr_8Z1aB2cD3eF4gH5iJ6kL7m,
+  customer_id: cus_8n7m6l5k4j3h2g1f0e9d8c,
+  value: 1,
+  metadata: {plan=enterprise, region=asia-southeast-1},
+  timestamp: 2026-05-23T10:00:00.000Z,
+  processed_at: 2026-05-23T10:00:01.000Z
+)
+```
+

data/docs/MetersApi.md

@@ -0,0 +1,515 @@
+# Solifyn::MetersApi
+
+All URIs are relative to *http://localhost:8000*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**events_ingest**](MetersApi.md#events_ingest) | **POST** /v1/meters/ingest | Ingest Events |
+| [**meters_create**](MetersApi.md#meters_create) | **POST** /v1/meters | Create Meter |
+| [**meters_get**](MetersApi.md#meters_get) | **GET** /v1/meters/{id} | Retrieve Meter |
+| [**meters_get_events**](MetersApi.md#meters_get_events) | **GET** /v1/meters/{id}/events | List Meter Events |
+| [**meters_get_quantities**](MetersApi.md#meters_get_quantities) | **GET** /v1/meters/{id}/quantities | Get Meter Quantities |
+| [**meters_list**](MetersApi.md#meters_list) | **GET** /v1/meters | List Meters |
+| [**meters_update**](MetersApi.md#meters_update) | **PATCH** /v1/meters/{id} | Update Meter |
+
+
+## events_ingest
+
+> <MeterIngestResponseDto> events_ingest(meter_ingest_request_dto)
+
+Ingest Events
+
+Ingest usage events for meters.
+
+### 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::MetersApi.new
+meter_ingest_request_dto = Solifyn::MeterIngestRequestDto.new({events: [Solifyn::MeterIngestEventDto.new({event_id: 'evt_9Y3kP4qR7tU1vW2xZ5aB6c', customer_id: 'cus_8n7m6l5k4j3h2g1f0e9d8c', event_name: 'api.request'})]}) # MeterIngestRequestDto | 
+
+begin
+  # Ingest Events
+  result = api_instance.events_ingest(meter_ingest_request_dto)
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling MetersApi->events_ingest: #{e}"
+end
+```
+
+#### Using the events_ingest_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MeterIngestResponseDto>, Integer, Hash)> events_ingest_with_http_info(meter_ingest_request_dto)
+
+```ruby
+begin
+  # Ingest Events
+  data, status_code, headers = api_instance.events_ingest_with_http_info(meter_ingest_request_dto)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MeterIngestResponseDto>
+rescue Solifyn::ApiError => e
+  puts "Error when calling MetersApi->events_ingest_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **meter_ingest_request_dto** | [**MeterIngestRequestDto**](MeterIngestRequestDto.md) |  |  |
+
+### Return type
+
+[**MeterIngestResponseDto**](MeterIngestResponseDto.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## meters_create
+
+> <MeterResponseDto> meters_create(create_meter_dto)
+
+Create Meter
+
+Create a new usage meter for event-based billing and usage tracking.
+
+### 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::MetersApi.new
+create_meter_dto = Solifyn::CreateMeterDto.new({name: 'API Request Count', event_name: 'api.request', aggregation_type: 'COUNT'}) # CreateMeterDto | 
+
+begin
+  # Create Meter
+  result = api_instance.meters_create(create_meter_dto)
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling MetersApi->meters_create: #{e}"
+end
+```
+
+#### Using the meters_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MeterResponseDto>, Integer, Hash)> meters_create_with_http_info(create_meter_dto)
+
+```ruby
+begin
+  # Create Meter
+  data, status_code, headers = api_instance.meters_create_with_http_info(create_meter_dto)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MeterResponseDto>
+rescue Solifyn::ApiError => e
+  puts "Error when calling MetersApi->meters_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_meter_dto** | [**CreateMeterDto**](CreateMeterDto.md) |  |  |
+
+### Return type
+
+[**MeterResponseDto**](MeterResponseDto.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## meters_get
+
+> <MeterDetailResponseDto> meters_get(id, start_date, end_date)
+
+Retrieve Meter
+
+Retrieve a meter and its most recent usage events.
+
+### 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::MetersApi.new
+id = 'mtr_8Z1aB2cD3eF4gH5iJ6kL7m' # String | The unique meter ID.
+start_date = 'start_date_example' # String | 
+end_date = 'end_date_example' # String | 
+
+begin
+  # Retrieve Meter
+  result = api_instance.meters_get(id, start_date, end_date)
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling MetersApi->meters_get: #{e}"
+end
+```
+
+#### Using the meters_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MeterDetailResponseDto>, Integer, Hash)> meters_get_with_http_info(id, start_date, end_date)
+
+```ruby
+begin
+  # Retrieve Meter
+  data, status_code, headers = api_instance.meters_get_with_http_info(id, start_date, end_date)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MeterDetailResponseDto>
+rescue Solifyn::ApiError => e
+  puts "Error when calling MetersApi->meters_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The unique meter ID. |  |
+| **start_date** | **String** |  |  |
+| **end_date** | **String** |  |  |
+
+### Return type
+
+[**MeterDetailResponseDto**](MeterDetailResponseDto.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## meters_get_events
+
+> <MeterEventsResponseDto> meters_get_events(id, opts)
+
+List Meter Events
+
+List recent usage events recorded for a meter.
+
+### 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::MetersApi.new
+id = 'mtr_8Z1aB2cD3eF4gH5iJ6kL7m' # String | The unique meter ID.
+opts = {
+  limit: 8.14 # Float | Maximum number of usage events to return.
+}
+
+begin
+  # List Meter Events
+  result = api_instance.meters_get_events(id, opts)
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling MetersApi->meters_get_events: #{e}"
+end
+```
+
+#### Using the meters_get_events_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MeterEventsResponseDto>, Integer, Hash)> meters_get_events_with_http_info(id, opts)
+
+```ruby
+begin
+  # List Meter Events
+  data, status_code, headers = api_instance.meters_get_events_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MeterEventsResponseDto>
+rescue Solifyn::ApiError => e
+  puts "Error when calling MetersApi->meters_get_events_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The unique meter ID. |  |
+| **limit** | **Float** | Maximum number of usage events to return. | [optional][default to 100] |
+
+### Return type
+
+[**MeterEventsResponseDto**](MeterEventsResponseDto.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## meters_get_quantities
+
+> <MeterQuantitiesResponseDto> meters_get_quantities(id, opts)
+
+Get Meter Quantities
+
+Get aggregated usage quantities for a meter within an optional date range.
+
+### 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::MetersApi.new
+id = 'mtr_8Z1aB2cD3eF4gH5iJ6kL7m' # String | The unique meter ID.
+opts = {
+  start_date: 'start_date_example', # String | Inclusive start date in ISO 8601 format.
+  end_date: 'end_date_example' # String | Inclusive end date in ISO 8601 format.
+}
+
+begin
+  # Get Meter Quantities
+  result = api_instance.meters_get_quantities(id, opts)
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling MetersApi->meters_get_quantities: #{e}"
+end
+```
+
+#### Using the meters_get_quantities_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MeterQuantitiesResponseDto>, Integer, Hash)> meters_get_quantities_with_http_info(id, opts)
+
+```ruby
+begin
+  # Get Meter Quantities
+  data, status_code, headers = api_instance.meters_get_quantities_with_http_info(id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MeterQuantitiesResponseDto>
+rescue Solifyn::ApiError => e
+  puts "Error when calling MetersApi->meters_get_quantities_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The unique meter ID. |  |
+| **start_date** | **String** | Inclusive start date in ISO 8601 format. | [optional] |
+| **end_date** | **String** | Inclusive end date in ISO 8601 format. | [optional] |
+
+### Return type
+
+[**MeterQuantitiesResponseDto**](MeterQuantitiesResponseDto.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## meters_list
+
+> <Array<MeterResponseDto>> meters_list(opts)
+
+List Meters
+
+List meters belonging to your active business. You can filter by archived status.
+
+### 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::MetersApi.new
+opts = {
+  status: 'active' # String | Filter by meter status.
+}
+
+begin
+  # List Meters
+  result = api_instance.meters_list(opts)
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling MetersApi->meters_list: #{e}"
+end
+```
+
+#### Using the meters_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<MeterResponseDto>>, Integer, Hash)> meters_list_with_http_info(opts)
+
+```ruby
+begin
+  # List Meters
+  data, status_code, headers = api_instance.meters_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<MeterResponseDto>>
+rescue Solifyn::ApiError => e
+  puts "Error when calling MetersApi->meters_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** | Filter by meter status. | [optional] |
+
+### Return type
+
+[**Array&lt;MeterResponseDto&gt;**](MeterResponseDto.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## meters_update
+
+> <MeterResponseDto> meters_update(id, update_meter_dto)
+
+Update Meter
+
+Update an existing meter definition.
+
+### 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::MetersApi.new
+id = 'mtr_8Z1aB2cD3eF4gH5iJ6kL7m' # String | The unique meter ID.
+update_meter_dto = Solifyn::UpdateMeterDto.new # UpdateMeterDto | 
+
+begin
+  # Update Meter
+  result = api_instance.meters_update(id, update_meter_dto)
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling MetersApi->meters_update: #{e}"
+end
+```
+
+#### Using the meters_update_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<MeterResponseDto>, Integer, Hash)> meters_update_with_http_info(id, update_meter_dto)
+
+```ruby
+begin
+  # Update Meter
+  data, status_code, headers = api_instance.meters_update_with_http_info(id, update_meter_dto)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <MeterResponseDto>
+rescue Solifyn::ApiError => e
+  puts "Error when calling MetersApi->meters_update_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The unique meter ID. |  |
+| **update_meter_dto** | [**UpdateMeterDto**](UpdateMeterDto.md) |  |  |
+
+### Return type
+
+[**MeterResponseDto**](MeterResponseDto.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/OperationalWebhookEndpointHeadersInDto.md

@@ -0,0 +1,18 @@
+# Solifyn::OperationalWebhookEndpointHeadersInDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **headers** | **Object** | Custom key-value headers to send with the webhook. |  |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::OperationalWebhookEndpointHeadersInDto.new(
+  headers: {X-Example=123, X-Foobar=Bar}
+)
+```
+

data/docs/OperationalWebhookEndpointHeadersResponseDto.md

@@ -0,0 +1,20 @@
+# Solifyn::OperationalWebhookEndpointHeadersResponseDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **headers** | **Object** | Key-value headers sent with the webhook. |  |
+| **sensitive** | **Array<String>** | List of sensitive header keys (e.g. Authorization) that are masked. |  |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::OperationalWebhookEndpointHeadersResponseDto.new(
+  headers: {X-Example=123, X-Foobar=Bar},
+  sensitive: [Authorization]
+)
+```
+

data/docs/OperationalWebhookEndpointInDto.md

@@ -0,0 +1,32 @@
+# Solifyn::OperationalWebhookEndpointInDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** | The URL to send webhook events to. |  |
+| **description** | **String** | Optional description for the endpoint. | [optional] |
+| **disabled** | **Boolean** | Whether the endpoint is disabled. | [optional][default to false] |
+| **filter_types** | **Array<String>** | The operational event types this endpoint will receive. | [optional] |
+| **metadata** | **Object** | Metadata key-value pairs associated with the endpoint. | [optional] |
+| **secret** | **String** | Optional custom endpoint signing secret (base64 encoded random bytes optionally prefixed with whsec_). If not set, the server will generate one. | [optional] |
+| **throttle_rate** | **Float** | Maximum messages per second to send to this endpoint (outgoing messages will be throttled to this rate). | [optional] |
+| **uid** | **String** | Optional unique user-defined identifier for the endpoint. | [optional] |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::OperationalWebhookEndpointInDto.new(
+  url: https://example.com/webhook/,
+  description: Production monitoring endpoint,
+  disabled: false,
+  filter_types: [message.attempt.failing, message.attempt.exhausted],
+  metadata: {environment=production},
+  secret: whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD,
+  throttle_rate: 5,
+  uid: monitoring-prod-endpoint
+)
+```
+

data/docs/OperationalWebhookEndpointListResponseDto.md

@@ -0,0 +1,24 @@
+# Solifyn::OperationalWebhookEndpointListResponseDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<OperationalWebhookEndpointResponseDto>**](OperationalWebhookEndpointResponseDto.md) |  |  |
+| **done** | **Boolean** |  |  |
+| **iterator** | **Object** |  | [optional] |
+| **prev_iterator** | **Object** |  | [optional] |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::OperationalWebhookEndpointListResponseDto.new(
+  data: null,
+  done: true,
+  iterator: iterator-token-abc,
+  prev_iterator: prev-iterator-token-abc
+)
+```
+