solifyn 1.0.5 → 1.0.7

data/docs/BillingApi.md

@@ -0,0 +1,68 @@
+# Solifyn::BillingApi
+
+All URIs are relative to *http://localhost:8000*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**billing_get_plans**](BillingApi.md#billing_get_plans) | **GET** /v1/billing/plans | Get Platform Plans |
+
+
+## billing_get_plans
+
+> billing_get_plans
+
+Get Platform Plans
+
+Returns all available platform subscription plans with fees and features.
+
+### Examples
+
+```ruby
+require 'time'
+require 'solifyn'
+
+api_instance = Solifyn::BillingApi.new
+
+begin
+  # Get Platform Plans
+  api_instance.billing_get_plans
+rescue Solifyn::ApiError => e
+  puts "Error when calling BillingApi->billing_get_plans: #{e}"
+end
+```
+
+#### Using the billing_get_plans_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)> billing_get_plans_with_http_info
+
+```ruby
+begin
+  # Get Platform Plans
+  data, status_code, headers = api_instance.billing_get_plans_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Solifyn::ApiError => e
+  puts "Error when calling BillingApi->billing_get_plans_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+

data/docs/BrandsApi.md

@@ -0,0 +1,286 @@
+# Solifyn::BrandsApi
+
+All URIs are relative to *http://localhost:8000*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**brands_create**](BrandsApi.md#brands_create) | **POST** /v1/user/brand | Create Brand |
+| [**brands_get**](BrandsApi.md#brands_get) | **GET** /v1/user/brand/{id} | Retrieve Brand |
+| [**brands_list**](BrandsApi.md#brands_list) | **GET** /v1/user/brands | List Brands |
+| [**brands_update**](BrandsApi.md#brands_update) | **PATCH** /v1/user/brand/{id} | Update Brand |
+
+
+## brands_create
+
+> <Brand> brands_create(brand_create)
+
+Create Brand
+
+Add a new brand identity under the current 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::BrandsApi.new
+brand_create = Solifyn::BrandCreate.new({name: 'Acme Corp'}) # BrandCreate | 
+
+begin
+  # Create Brand
+  result = api_instance.brands_create(brand_create)
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling BrandsApi->brands_create: #{e}"
+end
+```
+
+#### Using the brands_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Brand>, Integer, Hash)> brands_create_with_http_info(brand_create)
+
+```ruby
+begin
+  # Create Brand
+  data, status_code, headers = api_instance.brands_create_with_http_info(brand_create)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Brand>
+rescue Solifyn::ApiError => e
+  puts "Error when calling BrandsApi->brands_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **brand_create** | [**BrandCreate**](BrandCreate.md) |  |  |
+
+### Return type
+
+[**Brand**](Brand.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## brands_get
+
+> <Brand> brands_get(id)
+
+Retrieve Brand
+
+Retrieve details of a brand identity 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::BrandsApi.new
+id = 'brd_123' # String | The brand ID to retrieve
+
+begin
+  # Retrieve Brand
+  result = api_instance.brands_get(id)
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling BrandsApi->brands_get: #{e}"
+end
+```
+
+#### Using the brands_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Brand>, Integer, Hash)> brands_get_with_http_info(id)
+
+```ruby
+begin
+  # Retrieve Brand
+  data, status_code, headers = api_instance.brands_get_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Brand>
+rescue Solifyn::ApiError => e
+  puts "Error when calling BrandsApi->brands_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The brand ID to retrieve |  |
+
+### Return type
+
+[**Brand**](Brand.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## brands_list
+
+> <Array<Brand>> brands_list
+
+List Brands
+
+Retrieve all brands associated with the current business context.
+
+### 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::BrandsApi.new
+
+begin
+  # List Brands
+  result = api_instance.brands_list
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling BrandsApi->brands_list: #{e}"
+end
+```
+
+#### Using the brands_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Brand>>, Integer, Hash)> brands_list_with_http_info
+
+```ruby
+begin
+  # List Brands
+  data, status_code, headers = api_instance.brands_list_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Brand>>
+rescue Solifyn::ApiError => e
+  puts "Error when calling BrandsApi->brands_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array&lt;Brand&gt;**](Brand.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## brands_update
+
+> <Brand> brands_update(id, brand_update)
+
+Update Brand
+
+Update website, logo, description, or statement descriptors of a brand.
+
+### 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::BrandsApi.new
+id = 'brd_123' # String | The brand ID to update
+brand_update = Solifyn::BrandUpdate.new # BrandUpdate | 
+
+begin
+  # Update Brand
+  result = api_instance.brands_update(id, brand_update)
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling BrandsApi->brands_update: #{e}"
+end
+```
+
+#### Using the brands_update_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Brand>, Integer, Hash)> brands_update_with_http_info(id, brand_update)
+
+```ruby
+begin
+  # Update Brand
+  data, status_code, headers = api_instance.brands_update_with_http_info(id, brand_update)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Brand>
+rescue Solifyn::ApiError => e
+  puts "Error when calling BrandsApi->brands_update_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The brand ID to update |  |
+| **brand_update** | [**BrandUpdate**](BrandUpdate.md) |  |  |
+
+### Return type
+
+[**Brand**](Brand.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/Business.md

@@ -0,0 +1,56 @@
+# Solifyn::Business
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The unique business ID |  |
+| **title** | **String** | Title or name of the business |  |
+| **description** | **String** | A description explaining what the business does | [optional] |
+| **whop_id** | **String** | The Whop Company ID |  |
+| **merchant_id** | **String** | The merchant owner ID |  |
+| **verified** | **Boolean** | Whether the business has been KYC-verified on Whop |  |
+| **send_customer_emails** | **Boolean** | Whether auto-emails are enabled for customers |  |
+| **member_count** | **Float** | Total members/customers under this business |  |
+| **route** | **String** | Whop friendly URL path route | [optional] |
+| **default_currency** | **String** | The default currency of the business |  |
+| **published_reviews_count** | **Float** | Number of published user reviews on Whop |  |
+| **metadata** | **Object** | Custom key-value metadata | [optional] |
+| **target_audience** | **String** | The target audience description | [optional] |
+| **social_links** | **Object** | Social links setup | [optional] |
+| **affiliate_instructions** | **String** | Markdown instructions for affiliates | [optional] |
+| **whop_created_at** | **Time** | Whop account creation timestamp | [optional] |
+| **whop_updated_at** | **Time** | Whop account last updated timestamp | [optional] |
+| **created_at** | **Time** | Timestamp when the business record was created |  |
+| **updated_at** | **Time** | Timestamp when the business record was last updated |  |
+| **logo_url** | **String** | Brand logo image URL resolved from primary brand | [optional] |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::Business.new(
+  id: biz_123,
+  title: Acme Inc,
+  description: Premium tools and subscriptions,
+  whop_id: comp_123,
+  merchant_id: mer_123,
+  verified: true,
+  send_customer_emails: true,
+  member_count: 100,
+  route: acme,
+  default_currency: USD,
+  published_reviews_count: 15,
+  metadata: null,
+  target_audience: Developers and creators,
+  social_links: null,
+  affiliate_instructions: Promote our tools and earn 30% commission.,
+  whop_created_at: 2025-01-01T12:00:00Z,
+  whop_updated_at: 2025-01-01T12:00:00Z,
+  created_at: 2025-01-01T12:00:00Z,
+  updated_at: 2025-01-01T12:00:00Z,
+  logo_url: https://acme.com/logo.png
+)
+```
+

data/docs/BusinessCreate.md

@@ -0,0 +1,18 @@
+# Solifyn::BusinessCreate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **title** | **String** | The title/name of the business |  |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::BusinessCreate.new(
+  title: Acme Inc
+)
+```
+

data/docs/BusinessFullCreate.md

@@ -0,0 +1,26 @@
+# Solifyn::BusinessFullCreate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **title** | **String** | The title/name of the business |  |
+| **website_url** | **String** | The primary website URL for the business | [optional] |
+| **country** | **String** | Country name of the business registration |  |
+| **category** | **String** | The business market category (e.g. software, media) | [optional] |
+| **referred_by_code** | **String** | Optional partner referral code used during signup | [optional] |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::BusinessFullCreate.new(
+  title: Acme LLC,
+  website_url: https://acme.com,
+  country: Vietnam,
+  category: software,
+  referred_by_code: partner_abc123
+)
+```
+

data/docs/BusinessFullCreateResponse.md

@@ -0,0 +1,20 @@
+# Solifyn::BusinessFullCreateResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Boolean** | Indicates if creation was successful |  |
+| **business_id** | **String** | The newly created business ID |  |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::BusinessFullCreateResponse.new(
+  success: true,
+  business_id: biz_123
+)
+```
+