solifyn 1.0.0

data/docs/ProductAddOnsApi.md

@@ -0,0 +1,433 @@
+# Solifyn::ProductAddOnsApi
+
+All URIs are relative to *http://localhost:8000*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**products_create_addon**](ProductAddOnsApi.md#products_create_addon) | **POST** /v1/products/{id}/addons | Create Product Add-on |
+| [**products_delete_addon**](ProductAddOnsApi.md#products_delete_addon) | **DELETE** /v1/products/{id}/addons/{addonId} | Delete Product Add-on |
+| [**products_get_addon**](ProductAddOnsApi.md#products_get_addon) | **GET** /v1/products/{id}/addons/{addonId} | Retrieve Product Add-on |
+| [**products_list_addons**](ProductAddOnsApi.md#products_list_addons) | **GET** /v1/products/{id}/addons | List Product Add-ons |
+| [**products_list_all_addons**](ProductAddOnsApi.md#products_list_all_addons) | **GET** /v1/products/all-addons/list | List All Add-ons |
+| [**products_update_addon**](ProductAddOnsApi.md#products_update_addon) | **PATCH** /v1/products/{id}/addons/{addonId} | Update Product Add-on |
+
+
+## products_create_addon
+
+> <Addon> products_create_addon(id, addon_create)
+
+Create Product Add-on
+
+Attach a new add-on configuration to a product.
+
+### 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::ProductAddOnsApi.new
+id = 'prod_parent_123' # String | The parent product ID.
+addon_create = Solifyn::AddonCreate.new({product_id: 'prod_addon_123', min_quantity: 0, is_seat_addon: true}) # AddonCreate | 
+
+begin
+  # Create Product Add-on
+  result = api_instance.products_create_addon(id, addon_create)
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling ProductAddOnsApi->products_create_addon: #{e}"
+end
+```
+
+#### Using the products_create_addon_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Addon>, Integer, Hash)> products_create_addon_with_http_info(id, addon_create)
+
+```ruby
+begin
+  # Create Product Add-on
+  data, status_code, headers = api_instance.products_create_addon_with_http_info(id, addon_create)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Addon>
+rescue Solifyn::ApiError => e
+  puts "Error when calling ProductAddOnsApi->products_create_addon_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The parent product ID. |  |
+| **addon_create** | [**AddonCreate**](AddonCreate.md) |  |  |
+
+### Return type
+
+[**Addon**](Addon.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## products_delete_addon
+
+> <ProductMessageResponseDto> products_delete_addon(id, addon_id)
+
+Delete Product Add-on
+
+Remove an add-on configuration from a product.
+
+### 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::ProductAddOnsApi.new
+id = 'prod_parent_123' # String | The parent product ID.
+addon_id = 'prod_addon_123' # String | The add-on product ID to remove.
+
+begin
+  # Delete Product Add-on
+  result = api_instance.products_delete_addon(id, addon_id)
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling ProductAddOnsApi->products_delete_addon: #{e}"
+end
+```
+
+#### Using the products_delete_addon_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ProductMessageResponseDto>, Integer, Hash)> products_delete_addon_with_http_info(id, addon_id)
+
+```ruby
+begin
+  # Delete Product Add-on
+  data, status_code, headers = api_instance.products_delete_addon_with_http_info(id, addon_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ProductMessageResponseDto>
+rescue Solifyn::ApiError => e
+  puts "Error when calling ProductAddOnsApi->products_delete_addon_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The parent product ID. |  |
+| **addon_id** | **String** | The add-on product ID to remove. |  |
+
+### Return type
+
+[**ProductMessageResponseDto**](ProductMessageResponseDto.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## products_get_addon
+
+> <Addon> products_get_addon(id, addon_id)
+
+Retrieve Product Add-on
+
+Retrieve a specific add-on configuration of a product.
+
+### 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::ProductAddOnsApi.new
+id = 'prod_parent_123' # String | The parent product ID.
+addon_id = 'prod_addon_123' # String | The add-on product ID.
+
+begin
+  # Retrieve Product Add-on
+  result = api_instance.products_get_addon(id, addon_id)
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling ProductAddOnsApi->products_get_addon: #{e}"
+end
+```
+
+#### Using the products_get_addon_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Addon>, Integer, Hash)> products_get_addon_with_http_info(id, addon_id)
+
+```ruby
+begin
+  # Retrieve Product Add-on
+  data, status_code, headers = api_instance.products_get_addon_with_http_info(id, addon_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Addon>
+rescue Solifyn::ApiError => e
+  puts "Error when calling ProductAddOnsApi->products_get_addon_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The parent product ID. |  |
+| **addon_id** | **String** | The add-on product ID. |  |
+
+### Return type
+
+[**Addon**](Addon.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## products_list_addons
+
+> <Array<Addon>> products_list_addons(id)
+
+List Product Add-ons
+
+Retrieve all add-on configurations attached to a product.
+
+### 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::ProductAddOnsApi.new
+id = 'prod_parent_123' # String | The parent product ID.
+
+begin
+  # List Product Add-ons
+  result = api_instance.products_list_addons(id)
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling ProductAddOnsApi->products_list_addons: #{e}"
+end
+```
+
+#### Using the products_list_addons_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Addon>>, Integer, Hash)> products_list_addons_with_http_info(id)
+
+```ruby
+begin
+  # List Product Add-ons
+  data, status_code, headers = api_instance.products_list_addons_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Addon>>
+rescue Solifyn::ApiError => e
+  puts "Error when calling ProductAddOnsApi->products_list_addons_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The parent product ID. |  |
+
+### Return type
+
+[**Array&lt;Addon&gt;**](Addon.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## products_list_all_addons
+
+> products_list_all_addons
+
+List All Add-ons
+
+Retrieve all configured add-on configurations for 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::ProductAddOnsApi.new
+
+begin
+  # List All Add-ons
+  api_instance.products_list_all_addons
+rescue Solifyn::ApiError => e
+  puts "Error when calling ProductAddOnsApi->products_list_all_addons: #{e}"
+end
+```
+
+#### Using the products_list_all_addons_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)> products_list_all_addons_with_http_info
+
+```ruby
+begin
+  # List All Add-ons
+  data, status_code, headers = api_instance.products_list_all_addons_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Solifyn::ApiError => e
+  puts "Error when calling ProductAddOnsApi->products_list_all_addons_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## products_update_addon
+
+> <Addon> products_update_addon(id, addon_id, addon_update)
+
+Update Product Add-on
+
+Update an existing add-on configuration for a product.
+
+### 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::ProductAddOnsApi.new
+id = 'prod_parent_123' # String | The parent product ID.
+addon_id = 'prod_addon_123' # String | The add-on product ID.
+addon_update = Solifyn::AddonUpdate.new # AddonUpdate | 
+
+begin
+  # Update Product Add-on
+  result = api_instance.products_update_addon(id, addon_id, addon_update)
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling ProductAddOnsApi->products_update_addon: #{e}"
+end
+```
+
+#### Using the products_update_addon_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Addon>, Integer, Hash)> products_update_addon_with_http_info(id, addon_id, addon_update)
+
+```ruby
+begin
+  # Update Product Add-on
+  data, status_code, headers = api_instance.products_update_addon_with_http_info(id, addon_id, addon_update)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Addon>
+rescue Solifyn::ApiError => e
+  puts "Error when calling ProductAddOnsApi->products_update_addon_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The parent product ID. |  |
+| **addon_id** | **String** | The add-on product ID. |  |
+| **addon_update** | [**AddonUpdate**](AddonUpdate.md) |  |  |
+
+### Return type
+
+[**Addon**](Addon.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/ProductCreate.md

@@ -0,0 +1,62 @@
+# Solifyn::ProductCreate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Product display name. |  |
+| **description** | **String** | A description of the product. | [optional] |
+| **price** | **Float** | Price value. |  |
+| **currency** | **String** | Product pricing currency. | [default to 'USD'] |
+| **image_url** | **String** | URL of the product cover image. | [optional] |
+| **tax_category** | **String** | Tax classification. |  |
+| **discount** | **Float** | Percentage or flat rate discount. | [optional] |
+| **has_license_key** | **Boolean** | Whether to automatically issue license keys upon successful orders. | [optional][default to false] |
+| **has_digital_delivery** | **Boolean** | Whether the purchase includes downloadable files. | [optional][default to false] |
+| **is_tax_inclusive** | **Boolean** | Whether tax is included in the base price. | [optional][default to false] |
+| **activation_limit** | **Integer** | Maximum concurrent activated instances allowed per license key. | [optional] |
+| **brand_id** | **String** | Brand id for the product, if not provided will default to primary brand. | [optional] |
+| **billing_period** | **Integer** | Billing period in days (for Subscription products). | [optional] |
+| **trial_period_days** | **Integer** | Trial duration in days. | [optional] |
+| **expiration_days** | **Integer** | Subscription expiration duration in days. | [optional] |
+| **statement_descriptor** | **String** | Custom billing descriptor. | [optional] |
+| **pay_what_you_want** | **Boolean** | Allow pay-what-you-want pricing. | [optional][default to false] |
+| **metadata** | **Hash<String, String>** | Developer key-value metadata pairs. | [optional] |
+| **custom_fields** | [**Array<ProductCreateCustomFieldsInner>**](ProductCreateCustomFieldsInner.md) | Form field configurations to gather during checkout. | [optional] |
+| **stock** | **Integer** | Initial stock quantity limit. | [optional] |
+| **is_listed** | **Boolean** | Whether the product is publicly visible. | [optional][default to true] |
+| **is_free** | **Boolean** | Whether the product is free of charge. | [optional][default to false] |
+| **addons** | [**Array<ProductCreateAddonsInner>**](ProductCreateAddonsInner.md) | Product addons configurations. | [optional] |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::ProductCreate.new(
+  name: Enterprise SaaS Plan,
+  description: Unlock premium API integration, custom webhooks, dedicated server bandwidth, and priority 24/7 business-critical support tiers.,
+  price: 99,
+  currency: USD,
+  image_url: https://assets.solifyn.com/images/products/saas-enterprise.png,
+  tax_category: saas,
+  discount: 0,
+  has_license_key: false,
+  has_digital_delivery: false,
+  is_tax_inclusive: false,
+  activation_limit: null,
+  brand_id: brd_4e29285b8sdf34ff51e07d4,
+  billing_period: 30,
+  trial_period_days: 7,
+  expiration_days: null,
+  statement_descriptor: SOLIFYN*SAAS,
+  pay_what_you_want: false,
+  metadata: {internal_id=12345, campaign=summer_sale},
+  custom_fields: [{id=57aa2241-eae4-43dc-b9ae-36069b84b2da, name=Discord Username, order=0, required=true, field_type=text, placeholder=e.g. your_discord#1234}, {id=c86da32a-a967-457c-815b-c3440294d70b, name=Company Name, order=1, required=false, field_type=text, placeholder=e.g. Acme Corp (Optional)}],
+  stock: 100,
+  is_listed: true,
+  is_free: false,
+  addons: null
+)
+```
+

data/docs/ProductCreateAddonsInner.md

@@ -0,0 +1,26 @@
+# Solifyn::ProductCreateAddonsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **product_id** | **String** |  | [optional] |
+| **min_quantity** | **Integer** |  | [optional] |
+| **max_quantity** | **Integer** |  | [optional] |
+| **price_override** | **Float** |  | [optional] |
+| **is_seat_addon** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::ProductCreateAddonsInner.new(
+  product_id: null,
+  min_quantity: null,
+  max_quantity: null,
+  price_override: null,
+  is_seat_addon: null
+)
+```
+

data/docs/ProductCreateCustomFieldsInner.md

@@ -0,0 +1,24 @@
+# Solifyn::ProductCreateCustomFieldsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **required** | **Boolean** |  | [optional] |
+| **field_type** | **String** |  | [optional] |
+| **placeholder** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::ProductCreateCustomFieldsInner.new(
+  name: null,
+  required: null,
+  field_type: null,
+  placeholder: null
+)
+```
+

data/docs/ProductMessageResponseDto.md

@@ -0,0 +1,18 @@
+# Solifyn::ProductMessageResponseDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** | Response message indicating the outcome of the action. |  |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::ProductMessageResponseDto.new(
+  message: Product archived successfully
+)
+```
+

data/docs/ProductSubDto.md

@@ -0,0 +1,22 @@
+# Solifyn::ProductSubDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **name** | **String** |  |  |
+| **digital_link** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::ProductSubDto.new(
+  id: null,
+  name: null,
+  digital_link: null
+)
+```
+

data/docs/ProductUpdate.md

@@ -0,0 +1,62 @@
+# Solifyn::ProductUpdate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Product display name. | [optional] |
+| **description** | **String** | A description of the product. | [optional] |
+| **price** | **Float** | Price value. | [optional] |
+| **currency** | **String** | Product pricing currency. | [optional][default to 'USD'] |
+| **image_url** | **String** | URL of the product cover image. | [optional] |
+| **tax_category** | **String** | Tax classification. | [optional] |
+| **discount** | **Float** | Percentage or flat rate discount. | [optional] |
+| **has_license_key** | **Boolean** | Whether to automatically issue license keys upon successful orders. | [optional][default to false] |
+| **has_digital_delivery** | **Boolean** | Whether the purchase includes downloadable files. | [optional][default to false] |
+| **is_tax_inclusive** | **Boolean** | Whether tax is included in the base price. | [optional][default to false] |
+| **activation_limit** | **Integer** | Maximum concurrent activated instances allowed per license key. | [optional] |
+| **brand_id** | **String** | Brand id for the product, if not provided will default to primary brand. | [optional] |
+| **billing_period** | **Integer** | Billing period in days (for Subscription products). | [optional] |
+| **trial_period_days** | **Integer** | Trial duration in days. | [optional] |
+| **expiration_days** | **Integer** | Subscription expiration duration in days. | [optional] |
+| **statement_descriptor** | **String** | Custom billing descriptor. | [optional] |
+| **pay_what_you_want** | **Boolean** | Allow pay-what-you-want pricing. | [optional][default to false] |
+| **metadata** | **Hash<String, String>** | Developer key-value metadata pairs. | [optional] |
+| **custom_fields** | [**Array<ProductCreateCustomFieldsInner>**](ProductCreateCustomFieldsInner.md) | Form field configurations to gather during checkout. | [optional] |
+| **stock** | **Integer** | Initial stock quantity limit. | [optional] |
+| **is_listed** | **Boolean** | Whether the product is publicly visible. | [optional][default to true] |
+| **is_free** | **Boolean** | Whether the product is free of charge. | [optional][default to false] |
+| **addons** | [**Array<ProductCreateAddonsInner>**](ProductCreateAddonsInner.md) | Product addons configurations. | [optional] |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::ProductUpdate.new(
+  name: Enterprise SaaS Plan,
+  description: Unlock premium API integration, custom webhooks, dedicated server bandwidth, and priority 24/7 business-critical support tiers.,
+  price: 99,
+  currency: USD,
+  image_url: https://assets.solifyn.com/images/products/saas-enterprise.png,
+  tax_category: saas,
+  discount: 0,
+  has_license_key: false,
+  has_digital_delivery: false,
+  is_tax_inclusive: false,
+  activation_limit: null,
+  brand_id: brd_4e29285b8sdf34ff51e07d4,
+  billing_period: 30,
+  trial_period_days: 7,
+  expiration_days: null,
+  statement_descriptor: SOLIFYN*SAAS,
+  pay_what_you_want: false,
+  metadata: {internal_id=12345, campaign=summer_sale},
+  custom_fields: [{id=57aa2241-eae4-43dc-b9ae-36069b84b2da, name=Discord Username, order=0, required=true, field_type=text, placeholder=e.g. your_discord#1234}, {id=c86da32a-a967-457c-815b-c3440294d70b, name=Company Name, order=1, required=false, field_type=text, placeholder=e.g. Acme Corp (Optional)}],
+  stock: 100,
+  is_listed: true,
+  is_free: false,
+  addons: null
+)
+```
+