solifyn 1.0.0

data/docs/DisputesApi.md

@@ -0,0 +1,442 @@
+# Solifyn::DisputesApi
+
+All URIs are relative to *http://localhost:8000*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**disputes_generate_report**](DisputesApi.md#disputes_generate_report) | **GET** /v1/transactions/disputes/report | Generate Dispute CSV Report |
+| [**disputes_get**](DisputesApi.md#disputes_get) | **GET** /v1/transactions/disputes/{id} | Retrieve Dispute |
+| [**disputes_list**](DisputesApi.md#disputes_list) | **GET** /v1/transactions/disputes | List Disputes |
+| [**disputes_submit_evidence**](DisputesApi.md#disputes_submit_evidence) | **POST** /v1/transactions/disputes/{id}/submit | Submit Dispute Evidence |
+| [**disputes_update_evidence**](DisputesApi.md#disputes_update_evidence) | **PATCH** /v1/transactions/disputes/{id}/evidence | Update Dispute Evidence |
+| [**disputes_upload_evidence_file**](DisputesApi.md#disputes_upload_evidence_file) | **POST** /v1/transactions/disputes/upload | Upload Evidence File |
+
+
+## disputes_generate_report
+
+> disputes_generate_report(opts)
+
+Generate Dispute CSV Report
+
+Generates a downloadable CSV report of disputes matching the filters.
+
+### 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::DisputesApi.new
+opts = {
+  created_at_gte: 'created_at_gte_example', # String | Filter disputes created after this ISO date-time string
+  created_at_lte: 'created_at_lte_example', # String | Filter disputes created before this ISO date-time string
+  status: 'status_example' # String | Filter disputes by status
+}
+
+begin
+  # Generate Dispute CSV Report
+  api_instance.disputes_generate_report(opts)
+rescue Solifyn::ApiError => e
+  puts "Error when calling DisputesApi->disputes_generate_report: #{e}"
+end
+```
+
+#### Using the disputes_generate_report_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)> disputes_generate_report_with_http_info(opts)
+
+```ruby
+begin
+  # Generate Dispute CSV Report
+  data, status_code, headers = api_instance.disputes_generate_report_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Solifyn::ApiError => e
+  puts "Error when calling DisputesApi->disputes_generate_report_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **created_at_gte** | **String** | Filter disputes created after this ISO date-time string | [optional] |
+| **created_at_lte** | **String** | Filter disputes created before this ISO date-time string | [optional] |
+| **status** | **String** | Filter disputes by status | [optional] |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## disputes_get
+
+> <Dispute> disputes_get(id)
+
+Retrieve Dispute
+
+Retrieve details of a specific dispute by ID.
+
+### 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::DisputesApi.new
+id = 'dsp_123' # String | The dispute ID
+
+begin
+  # Retrieve Dispute
+  result = api_instance.disputes_get(id)
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling DisputesApi->disputes_get: #{e}"
+end
+```
+
+#### Using the disputes_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Dispute>, Integer, Hash)> disputes_get_with_http_info(id)
+
+```ruby
+begin
+  # Retrieve Dispute
+  data, status_code, headers = api_instance.disputes_get_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Dispute>
+rescue Solifyn::ApiError => e
+  puts "Error when calling DisputesApi->disputes_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The dispute ID |  |
+
+### Return type
+
+[**Dispute**](Dispute.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## disputes_list
+
+> <DisputeList> disputes_list(opts)
+
+List Disputes
+
+Retrieve disputes associated with the active business.
+
+### 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::DisputesApi.new
+opts = {
+  page: '1', # String | Page number for pagination
+  limit: '10', # String | Page size limit for pagination
+  status: 'status_example', # String | Filter disputes by status
+  type: 'type_example' # String | Filter by type: dispute or alert
+}
+
+begin
+  # List Disputes
+  result = api_instance.disputes_list(opts)
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling DisputesApi->disputes_list: #{e}"
+end
+```
+
+#### Using the disputes_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DisputeList>, Integer, Hash)> disputes_list_with_http_info(opts)
+
+```ruby
+begin
+  # List Disputes
+  data, status_code, headers = api_instance.disputes_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DisputeList>
+rescue Solifyn::ApiError => e
+  puts "Error when calling DisputesApi->disputes_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **String** | Page number for pagination | [optional] |
+| **limit** | **String** | Page size limit for pagination | [optional] |
+| **status** | **String** | Filter disputes by status | [optional] |
+| **type** | **String** | Filter by type: dispute or alert | [optional] |
+
+### Return type
+
+[**DisputeList**](DisputeList.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## disputes_submit_evidence
+
+> <Dispute> disputes_submit_evidence(id)
+
+Submit Dispute Evidence
+
+Finalize and submit the uploaded evidence for review.
+
+### 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::DisputesApi.new
+id = 'dsp_123' # String | The dispute ID
+
+begin
+  # Submit Dispute Evidence
+  result = api_instance.disputes_submit_evidence(id)
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling DisputesApi->disputes_submit_evidence: #{e}"
+end
+```
+
+#### Using the disputes_submit_evidence_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Dispute>, Integer, Hash)> disputes_submit_evidence_with_http_info(id)
+
+```ruby
+begin
+  # Submit Dispute Evidence
+  data, status_code, headers = api_instance.disputes_submit_evidence_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Dispute>
+rescue Solifyn::ApiError => e
+  puts "Error when calling DisputesApi->disputes_submit_evidence_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The dispute ID |  |
+
+### Return type
+
+[**Dispute**](Dispute.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## disputes_update_evidence
+
+> <Dispute> disputes_update_evidence(id, dispute_evidence_update)
+
+Update Dispute Evidence
+
+Upload and update evidence attachments for a dispute.
+
+### 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::DisputesApi.new
+id = 'dsp_123' # String | The dispute ID
+dispute_evidence_update = Solifyn::DisputeEvidenceUpdate.new # DisputeEvidenceUpdate | 
+
+begin
+  # Update Dispute Evidence
+  result = api_instance.disputes_update_evidence(id, dispute_evidence_update)
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling DisputesApi->disputes_update_evidence: #{e}"
+end
+```
+
+#### Using the disputes_update_evidence_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Dispute>, Integer, Hash)> disputes_update_evidence_with_http_info(id, dispute_evidence_update)
+
+```ruby
+begin
+  # Update Dispute Evidence
+  data, status_code, headers = api_instance.disputes_update_evidence_with_http_info(id, dispute_evidence_update)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Dispute>
+rescue Solifyn::ApiError => e
+  puts "Error when calling DisputesApi->disputes_update_evidence_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The dispute ID |  |
+| **dispute_evidence_update** | [**DisputeEvidenceUpdate**](DisputeEvidenceUpdate.md) |  |  |
+
+### Return type
+
+[**Dispute**](Dispute.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## disputes_upload_evidence_file
+
+> <DisputeFileUpload> disputes_upload_evidence_file(file)
+
+Upload Evidence File
+
+Upload a support file (image, PDF, video) to use as dispute evidence.
+
+### 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::DisputesApi.new
+file = File.new('/path/to/some/file') # File | The evidence file to upload (Max 25MB: JPEG, PNG, GIF, WEBP, PDF, MP4, WEBM, QuickTime)
+
+begin
+  # Upload Evidence File
+  result = api_instance.disputes_upload_evidence_file(file)
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling DisputesApi->disputes_upload_evidence_file: #{e}"
+end
+```
+
+#### Using the disputes_upload_evidence_file_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<DisputeFileUpload>, Integer, Hash)> disputes_upload_evidence_file_with_http_info(file)
+
+```ruby
+begin
+  # Upload Evidence File
+  data, status_code, headers = api_instance.disputes_upload_evidence_file_with_http_info(file)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <DisputeFileUpload>
+rescue Solifyn::ApiError => e
+  puts "Error when calling DisputesApi->disputes_upload_evidence_file_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **file** | **File** | The evidence file to upload (Max 25MB: JPEG, PNG, GIF, WEBP, PDF, MP4, WEBM, QuickTime) |  |
+
+### Return type
+
+[**DisputeFileUpload**](DisputeFileUpload.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: multipart/form-data
+- **Accept**: application/json
+

data/docs/Instance.md

@@ -0,0 +1,30 @@
+# Solifyn::Instance
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The unique database identifier of this instance record. |  |
+| **license_id** | **String** | The internal ID of the parent license key this instance belongs to. |  |
+| **instance_id** | **String** | The unique hardware hash or client-generated identifier of the activated device/machine. |  |
+| **instance_name** | **String** | A human-readable display name for this instance, assigned by the client application. |  |
+| **ip_address** | **String** | The IP address recorded at the time of activation. |  |
+| **activated_at** | **String** | Timestamp when this device instance was first activated. |  |
+| **last_seen_at** | **String** | Timestamp of the most recent activation heartbeat or re-activation check from this device. |  |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::Instance.new(
+  id: 7f3a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c,
+  license_id: lic_hyQQhhNzfEuvv,
+  instance_id: machine-ID-abc123,
+  instance_name: MacBook Pro 16",
+  ip_address: 203.0.113.42,
+  activated_at: 2026-05-15T10:30:00.000Z,
+  last_seen_at: 2026-05-18T08:00:00.000Z
+)
+```
+

data/docs/Invoice.md

@@ -0,0 +1,26 @@
+# Solifyn::Invoice
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique invoice identifier. |  |
+| **order_id** | **String** | Associated order ID. |  |
+| **url** | **String** | Invoice URL for downloading or viewing PDF. |  |
+| **status** | **String** | Status of invoice. |  |
+| **created_at** | **Time** | Invoice creation date. |  |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::Invoice.new(
+  id: inv_123,
+  order_id: pay_123,
+  url: https://api.solifyn.com/v1/orders/pay_123/invoice/pdf,
+  status: paid,
+  created_at: 2026-05-22T08:00:00Z
+)
+```
+

data/docs/License.md

@@ -0,0 +1,48 @@
+# Solifyn::License
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The unique prefix-based identifier of the license key. |  |
+| **key** | **String** | The cryptographically generated license key string delivered to the customer. |  |
+| **status** | **String** | Lifecycle status of the license. ACTIVE = active. DISABLED = suspended. REVOKED = hard-revoked. |  |
+| **business_id** | **String** | The unique identifier associated with the business this license belongs to. |  |
+| **product_id** | **String** | The unique ID of the product this license key is associated with. |  |
+| **payment_id** | **String** | The unique payment identifier that triggered the issuance of this license key. |  |
+| **customer_id** | **String** | The unique customer identifier (ID) who received this license key. |  |
+| **activation_limit** | **Float** | Maximum number of simultaneous active device instances allowed for this license. Null means unlimited. |  |
+| **activation_message** | **String** | Optional message displayed to the customer upon successful activation. |  |
+| **instances_count** | **Float** | Running count of how many times this license key has been activated. |  |
+| **expiry_hours** | **Float** | Relative expiry duration in hours from the time of issuance. |  |
+| **expires_at** | **String** | Absolute expiration timestamp. The license becomes invalid after this point. |  |
+| **filters** | **Object** | Optional custom metadata filters associated with the license. |  |
+| **archived** | **Boolean** | Indicates if the license key is archived. |  |
+| **created_at** | **String** | Timestamp indicating exactly when the license key was issued. |  |
+| **updated_at** | **String** | Timestamp indicating when the license key was last modified. |  |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::License.new(
+  id: lic_hyQQhhNzfEuvv,
+  key: A184-99C2-8CBE,
+  status: ACTIVE,
+  business_id: biz_345TUESrCDPvrb,
+  product_id: prod_hyQQhhNzfEuvv,
+  payment_id: pay_3r2FgHXp9,
+  customer_id: cust_3r2FgHXp9,
+  activation_limit: 3,
+  activation_message: Thank you! Your license is now active.,
+  instances_count: 1,
+  expiry_hours: 720,
+  expires_at: 2027-01-01T00:00:00.000Z,
+  filters: null,
+  archived: false,
+  created_at: 2026-05-11T01:12:25.764Z,
+  updated_at: 2026-05-18T09:45:37.166Z
+)
+```
+