solifyn 1.0.0

data/docs/PayoutsApi.md

@@ -0,0 +1,579 @@
+# Solifyn::PayoutsApi
+
+All URIs are relative to *http://localhost:8000*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**payouts_create_withdrawal**](PayoutsApi.md#payouts_create_withdrawal) | **POST** /v1/payouts/withdrawals | Create Withdrawal |
+| [**payouts_get_account**](PayoutsApi.md#payouts_get_account) | **GET** /v1/payouts/account | Retrieve Payout Account |
+| [**payouts_get_account_link**](PayoutsApi.md#payouts_get_account_link) | **GET** /v1/payouts/account-link | Create Account Link |
+| [**payouts_get_token**](PayoutsApi.md#payouts_get_token) | **GET** /v1/payouts/token | Generate Portal Access Token |
+| [**payouts_get_withdrawals**](PayoutsApi.md#payouts_get_withdrawals) | **GET** /v1/payouts/withdrawals | Get Withdrawals List |
+| [**payouts_list_methods**](PayoutsApi.md#payouts_list_methods) | **GET** /v1/payouts/methods | List Payout Methods |
+| [**payouts_list_verifications**](PayoutsApi.md#payouts_list_verifications) | **GET** /v1/payouts/verifications | List Verifications |
+| [**payouts_list_withdrawals**](PayoutsApi.md#payouts_list_withdrawals) | **GET** /v1/payouts | List Withdrawals |
+
+
+## payouts_create_withdrawal
+
+> <Withdrawal> payouts_create_withdrawal(withdrawal_create)
+
+Create Withdrawal
+
+Initiate a balance withdrawal transfer request.
+
+### 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::PayoutsApi.new
+withdrawal_create = Solifyn::WithdrawalCreate.new({amount: 1000, currency: 'usd'}) # WithdrawalCreate | 
+
+begin
+  # Create Withdrawal
+  result = api_instance.payouts_create_withdrawal(withdrawal_create)
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling PayoutsApi->payouts_create_withdrawal: #{e}"
+end
+```
+
+#### Using the payouts_create_withdrawal_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Withdrawal>, Integer, Hash)> payouts_create_withdrawal_with_http_info(withdrawal_create)
+
+```ruby
+begin
+  # Create Withdrawal
+  data, status_code, headers = api_instance.payouts_create_withdrawal_with_http_info(withdrawal_create)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Withdrawal>
+rescue Solifyn::ApiError => e
+  puts "Error when calling PayoutsApi->payouts_create_withdrawal_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **withdrawal_create** | [**WithdrawalCreate**](WithdrawalCreate.md) |  |  |
+
+### Return type
+
+[**Withdrawal**](Withdrawal.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## payouts_get_account
+
+> <PayoutAccount> payouts_get_account
+
+Retrieve Payout Account
+
+Retrieve general status and information of onboarding payout accounts.
+
+### 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::PayoutsApi.new
+
+begin
+  # Retrieve Payout Account
+  result = api_instance.payouts_get_account
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling PayoutsApi->payouts_get_account: #{e}"
+end
+```
+
+#### Using the payouts_get_account_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PayoutAccount>, Integer, Hash)> payouts_get_account_with_http_info
+
+```ruby
+begin
+  # Retrieve Payout Account
+  data, status_code, headers = api_instance.payouts_get_account_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PayoutAccount>
+rescue Solifyn::ApiError => e
+  puts "Error when calling PayoutsApi->payouts_get_account_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**PayoutAccount**](PayoutAccount.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## payouts_get_account_link
+
+> <PayoutAccountLink> payouts_get_account_link(opts)
+
+Create Account Link
+
+Generate temporary links for onboarding or viewing portals.
+
+### 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::PayoutsApi.new
+opts = {
+  use_case: 'account_onboarding' # String | Onboarding link type context
+}
+
+begin
+  # Create Account Link
+  result = api_instance.payouts_get_account_link(opts)
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling PayoutsApi->payouts_get_account_link: #{e}"
+end
+```
+
+#### Using the payouts_get_account_link_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PayoutAccountLink>, Integer, Hash)> payouts_get_account_link_with_http_info(opts)
+
+```ruby
+begin
+  # Create Account Link
+  data, status_code, headers = api_instance.payouts_get_account_link_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PayoutAccountLink>
+rescue Solifyn::ApiError => e
+  puts "Error when calling PayoutsApi->payouts_get_account_link_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **use_case** | **String** | Onboarding link type context | [optional] |
+
+### Return type
+
+[**PayoutAccountLink**](PayoutAccountLink.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## payouts_get_token
+
+> <PayoutAccessToken> payouts_get_token
+
+Generate Portal Access Token
+
+Generate temporary credentials to access the embed portal.
+
+### 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::PayoutsApi.new
+
+begin
+  # Generate Portal Access Token
+  result = api_instance.payouts_get_token
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling PayoutsApi->payouts_get_token: #{e}"
+end
+```
+
+#### Using the payouts_get_token_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PayoutAccessToken>, Integer, Hash)> payouts_get_token_with_http_info
+
+```ruby
+begin
+  # Generate Portal Access Token
+  data, status_code, headers = api_instance.payouts_get_token_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PayoutAccessToken>
+rescue Solifyn::ApiError => e
+  puts "Error when calling PayoutsApi->payouts_get_token_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**PayoutAccessToken**](PayoutAccessToken.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## payouts_get_withdrawals
+
+> <WithdrawalList> payouts_get_withdrawals(opts)
+
+Get Withdrawals List
+
+Retrieve withdrawal records 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::PayoutsApi.new
+opts = {
+  limit: 8.14, # Float | Page size limit
+  page: 8.14 # Float | Page number
+}
+
+begin
+  # Get Withdrawals List
+  result = api_instance.payouts_get_withdrawals(opts)
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling PayoutsApi->payouts_get_withdrawals: #{e}"
+end
+```
+
+#### Using the payouts_get_withdrawals_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<WithdrawalList>, Integer, Hash)> payouts_get_withdrawals_with_http_info(opts)
+
+```ruby
+begin
+  # Get Withdrawals List
+  data, status_code, headers = api_instance.payouts_get_withdrawals_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <WithdrawalList>
+rescue Solifyn::ApiError => e
+  puts "Error when calling PayoutsApi->payouts_get_withdrawals_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Float** | Page size limit | [optional] |
+| **page** | **Float** | Page number | [optional] |
+
+### Return type
+
+[**WithdrawalList**](WithdrawalList.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## payouts_list_methods
+
+> <PayoutMethodList> payouts_list_methods(opts)
+
+List Payout Methods
+
+List saved payout destinations (bank accounts, cards).
+
+### 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::PayoutsApi.new
+opts = {
+  limit: 8.14, # Float | 
+  page: 8.14 # Float | 
+}
+
+begin
+  # List Payout Methods
+  result = api_instance.payouts_list_methods(opts)
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling PayoutsApi->payouts_list_methods: #{e}"
+end
+```
+
+#### Using the payouts_list_methods_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PayoutMethodList>, Integer, Hash)> payouts_list_methods_with_http_info(opts)
+
+```ruby
+begin
+  # List Payout Methods
+  data, status_code, headers = api_instance.payouts_list_methods_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PayoutMethodList>
+rescue Solifyn::ApiError => e
+  puts "Error when calling PayoutsApi->payouts_list_methods_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Float** |  | [optional] |
+| **page** | **Float** |  | [optional] |
+
+### Return type
+
+[**PayoutMethodList**](PayoutMethodList.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## payouts_list_verifications
+
+> <PayoutVerificationList> payouts_list_verifications(opts)
+
+List Verifications
+
+Retrieve pending or completed KYC verification checks.
+
+### 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::PayoutsApi.new
+opts = {
+  limit: 8.14, # Float | 
+  page: 8.14 # Float | 
+}
+
+begin
+  # List Verifications
+  result = api_instance.payouts_list_verifications(opts)
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling PayoutsApi->payouts_list_verifications: #{e}"
+end
+```
+
+#### Using the payouts_list_verifications_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PayoutVerificationList>, Integer, Hash)> payouts_list_verifications_with_http_info(opts)
+
+```ruby
+begin
+  # List Verifications
+  data, status_code, headers = api_instance.payouts_list_verifications_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PayoutVerificationList>
+rescue Solifyn::ApiError => e
+  puts "Error when calling PayoutsApi->payouts_list_verifications_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Float** |  | [optional] |
+| **page** | **Float** |  | [optional] |
+
+### Return type
+
+[**PayoutVerificationList**](PayoutVerificationList.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## payouts_list_withdrawals
+
+> <WithdrawalList> payouts_list_withdrawals(opts)
+
+List Withdrawals
+
+Retrieve a list of past withdrawal history.
+
+### 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::PayoutsApi.new
+opts = {
+  limit: 8.14, # Float | Page size limit
+  page: 8.14 # Float | Page number
+}
+
+begin
+  # List Withdrawals
+  result = api_instance.payouts_list_withdrawals(opts)
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling PayoutsApi->payouts_list_withdrawals: #{e}"
+end
+```
+
+#### Using the payouts_list_withdrawals_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<WithdrawalList>, Integer, Hash)> payouts_list_withdrawals_with_http_info(opts)
+
+```ruby
+begin
+  # List Withdrawals
+  data, status_code, headers = api_instance.payouts_list_withdrawals_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <WithdrawalList>
+rescue Solifyn::ApiError => e
+  puts "Error when calling PayoutsApi->payouts_list_withdrawals_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **limit** | **Float** | Page size limit | [optional] |
+| **page** | **Float** | Page number | [optional] |
+
+### Return type
+
+[**WithdrawalList**](WithdrawalList.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/PricePreviewResponseDto.md

@@ -0,0 +1,24 @@
+# Solifyn::PricePreviewResponseDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **original_price** | **Float** | Original price of the product after discounts |  |
+| **original_currency** | **String** | Original ISO currency code of the product |  |
+| **converted_price** | **Float** | Converted price of the product |  |
+| **converted_currency** | **String** | Converted ISO currency code of the product |  |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::PricePreviewResponseDto.new(
+  original_price: 10,
+  original_currency: USD,
+  converted_price: 250000,
+  converted_currency: VND
+)
+```
+

data/docs/Product.md

@@ -0,0 +1,82 @@
+# Solifyn::Product
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The unique identifier (ID) of the product. |  |
+| **name** | **String** | The display name of the product. |  |
+| **price** | **Float** | The price amount of the product (e.g. 29.00). |  |
+| **currency** | **String** | The three-letter ISO currency code (e.g. USD, VND, EUR). |  |
+| **description** | **String** | A comprehensive rich text description of the product. | [optional] |
+| **status** | **String** | The lifecycle status of the product (e.g. ACTIVE, ARCHIVED). |  |
+| **image_url** | **String** | URL of the product cover image. |  |
+| **tax_category** | **String** | The tax classification for the product. |  |
+| **pricing_type** | **String** | Pricing model of the product. |  |
+| **discount** | **Float** | Discount value as a percentage or fixed amount. |  |
+| **has_license_key** | **Boolean** | Indicates if the product issues a cryptographically secure software license key upon checkout completion. |  |
+| **has_digital_delivery** | **Boolean** | Whether the product includes digital file downloads upon purchase. |  |
+| **is_tax_inclusive** | **Boolean** | Whether the product price already includes applicable sales taxes. |  |
+| **billing_period** | **Integer** | The subscription billing cycle interval in days (for subscription products). |  |
+| **trial_period_days** | **Integer** | Trial duration in days for subscription products. |  |
+| **expiration_days** | **Integer** | Automatic expiration period in days for the subscription entitlement. |  |
+| **statement_descriptor** | **String** | Custom text displayed on customer credit card statements for purchases of this product. |  |
+| **pay_what_you_want** | **Boolean** | Indicates if customers are allowed to enter a custom pricing amount at checkout. |  |
+| **metadata** | **Hash<String, String>** | Custom developer metadata key-value pairs associated with the product. |  |
+| **custom_fields** | **Array<Object>** | Custom form field questions to ask the customer during checkout. |  |
+| **stock** | **Integer** | Available stock quantity, or null for unlimited inventory. |  |
+| **activation_limit** | **Integer** | Maximum number of simultaneous active instances/devices allowed per issued license key (applicable if hasLicenseKey is true). |  |
+| **is_listed** | **Boolean** | Defines if the product is listed publicly on the merchant's storefront template. |  |
+| **is_free** | **Boolean** | Whether the product is free. |  |
+| **created_at** | **Time** | Timestamp indicating exactly when the product was created. |  |
+| **updated_at** | **Time** | Timestamp indicating when the product was last modified. |  |
+| **is_permanently_deleted** | **Boolean** | Indicates if the product has been permanently deleted. |  |
+| **brand_id** | **String** | Optional brand identifier. |  |
+| **digital_link** | **String** | Secure link for digital delivery. |  |
+| **instructions** | **String** | Special instructions provided upon purchase. |  |
+| **activation_message** | **String** | Custom message displayed when a license key is activated. |  |
+| **expiry_hours** | **Integer** | Number of hours until the license key expires. |  |
+| **business_id** | **String** | The unique identifier of the business owning this product. |  |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::Product.new(
+  id: prod_9z8x7c6v5b4n,
+  name: Enterprise SaaS Plan,
+  price: 99,
+  currency: USD,
+  description: Unlock premium API integration, custom webhooks, dedicated server bandwidth, and priority 24/7 business-critical support tiers.,
+  status: ACTIVE,
+  image_url: https://assets.solifyn.com/images/products/saas-enterprise.png,
+  tax_category: saas,
+  pricing_type: one_time,
+  discount: 0,
+  has_license_key: true,
+  has_digital_delivery: false,
+  is_tax_inclusive: false,
+  billing_period: null,
+  trial_period_days: null,
+  expiration_days: null,
+  statement_descriptor: SOLIFYN*SAAS,
+  pay_what_you_want: false,
+  metadata: {tier=enterprise, department=engineering},
+  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: null,
+  activation_limit: 5,
+  is_listed: true,
+  is_free: false,
+  created_at: 2026-05-18T12:00:00.000Z,
+  updated_at: 2026-05-18T12:00:00.000Z,
+  is_permanently_deleted: false,
+  brand_id: brd_4e29285b8sdf34ff51e07d4,
+  digital_link: null,
+  instructions: Log in to your Solifyn developer dashboard and enter your license key to activate the premium SaaS resources.,
+  activation_message: Activation successful. Welcome to the Solifyn Enterprise Plan!,
+  expiry_hours: 8760,
+  business_id: biz_4r5t6y7u8i9o
+)
+```
+