solifyn 1.0.0

data/docs/CommunityApi.md

@@ -0,0 +1,497 @@
+# Solifyn::CommunityApi
+
+All URIs are relative to *http://localhost:8000*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**community_controller_create_post**](CommunityApi.md#community_controller_create_post) | **POST** /v1/community/posts |  |
+| [**community_controller_delete_post**](CommunityApi.md#community_controller_delete_post) | **DELETE** /v1/community/posts/{id} |  |
+| [**community_controller_get_posts**](CommunityApi.md#community_controller_get_posts) | **GET** /v1/community/posts |  |
+| [**community_controller_like_post**](CommunityApi.md#community_controller_like_post) | **PATCH** /v1/community/posts/{id}/like |  |
+| [**community_controller_report_post**](CommunityApi.md#community_controller_report_post) | **POST** /v1/community/posts/{id}/report |  |
+| [**community_controller_share_post**](CommunityApi.md#community_controller_share_post) | **PATCH** /v1/community/posts/{id}/share |  |
+| [**community_controller_unlike_post**](CommunityApi.md#community_controller_unlike_post) | **PATCH** /v1/community/posts/{id}/unlike |  |
+| [**community_controller_update_post**](CommunityApi.md#community_controller_update_post) | **PATCH** /v1/community/posts/{id} |  |
+
+
+## community_controller_create_post
+
+> community_controller_create_post
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'solifyn'
+
+api_instance = Solifyn::CommunityApi.new
+
+begin
+  
+  api_instance.community_controller_create_post
+rescue Solifyn::ApiError => e
+  puts "Error when calling CommunityApi->community_controller_create_post: #{e}"
+end
+```
+
+#### Using the community_controller_create_post_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)> community_controller_create_post_with_http_info
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.community_controller_create_post_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Solifyn::ApiError => e
+  puts "Error when calling CommunityApi->community_controller_create_post_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
+
+
+## community_controller_delete_post
+
+> community_controller_delete_post(id)
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'solifyn'
+
+api_instance = Solifyn::CommunityApi.new
+id = 'id_example' # String | 
+
+begin
+  
+  api_instance.community_controller_delete_post(id)
+rescue Solifyn::ApiError => e
+  puts "Error when calling CommunityApi->community_controller_delete_post: #{e}"
+end
+```
+
+#### Using the community_controller_delete_post_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)> community_controller_delete_post_with_http_info(id)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.community_controller_delete_post_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Solifyn::ApiError => e
+  puts "Error when calling CommunityApi->community_controller_delete_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## community_controller_get_posts
+
+> community_controller_get_posts
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'solifyn'
+
+api_instance = Solifyn::CommunityApi.new
+
+begin
+  
+  api_instance.community_controller_get_posts
+rescue Solifyn::ApiError => e
+  puts "Error when calling CommunityApi->community_controller_get_posts: #{e}"
+end
+```
+
+#### Using the community_controller_get_posts_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)> community_controller_get_posts_with_http_info
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.community_controller_get_posts_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Solifyn::ApiError => e
+  puts "Error when calling CommunityApi->community_controller_get_posts_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
+
+
+## community_controller_like_post
+
+> community_controller_like_post(id)
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'solifyn'
+
+api_instance = Solifyn::CommunityApi.new
+id = 'id_example' # String | 
+
+begin
+  
+  api_instance.community_controller_like_post(id)
+rescue Solifyn::ApiError => e
+  puts "Error when calling CommunityApi->community_controller_like_post: #{e}"
+end
+```
+
+#### Using the community_controller_like_post_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)> community_controller_like_post_with_http_info(id)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.community_controller_like_post_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Solifyn::ApiError => e
+  puts "Error when calling CommunityApi->community_controller_like_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## community_controller_report_post
+
+> community_controller_report_post(id)
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'solifyn'
+
+api_instance = Solifyn::CommunityApi.new
+id = 'id_example' # String | 
+
+begin
+  
+  api_instance.community_controller_report_post(id)
+rescue Solifyn::ApiError => e
+  puts "Error when calling CommunityApi->community_controller_report_post: #{e}"
+end
+```
+
+#### Using the community_controller_report_post_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)> community_controller_report_post_with_http_info(id)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.community_controller_report_post_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Solifyn::ApiError => e
+  puts "Error when calling CommunityApi->community_controller_report_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## community_controller_share_post
+
+> community_controller_share_post(id)
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'solifyn'
+
+api_instance = Solifyn::CommunityApi.new
+id = 'id_example' # String | 
+
+begin
+  
+  api_instance.community_controller_share_post(id)
+rescue Solifyn::ApiError => e
+  puts "Error when calling CommunityApi->community_controller_share_post: #{e}"
+end
+```
+
+#### Using the community_controller_share_post_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)> community_controller_share_post_with_http_info(id)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.community_controller_share_post_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Solifyn::ApiError => e
+  puts "Error when calling CommunityApi->community_controller_share_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## community_controller_unlike_post
+
+> community_controller_unlike_post(id)
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'solifyn'
+
+api_instance = Solifyn::CommunityApi.new
+id = 'id_example' # String | 
+
+begin
+  
+  api_instance.community_controller_unlike_post(id)
+rescue Solifyn::ApiError => e
+  puts "Error when calling CommunityApi->community_controller_unlike_post: #{e}"
+end
+```
+
+#### Using the community_controller_unlike_post_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)> community_controller_unlike_post_with_http_info(id)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.community_controller_unlike_post_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Solifyn::ApiError => e
+  puts "Error when calling CommunityApi->community_controller_unlike_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## community_controller_update_post
+
+> community_controller_update_post(id)
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'solifyn'
+
+api_instance = Solifyn::CommunityApi.new
+id = 'id_example' # String | 
+
+begin
+  
+  api_instance.community_controller_update_post(id)
+rescue Solifyn::ApiError => e
+  puts "Error when calling CommunityApi->community_controller_update_post: #{e}"
+end
+```
+
+#### Using the community_controller_update_post_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)> community_controller_update_post_with_http_info(id)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.community_controller_update_post_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Solifyn::ApiError => e
+  puts "Error when calling CommunityApi->community_controller_update_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+

data/docs/CreateApiKeyDto.md

@@ -0,0 +1,20 @@
+# Solifyn::CreateApiKeyDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The user-friendly name of the API key. |  |
+| **allow_write** | **Boolean** | Whether the API key is allowed to make mutating write requests. | [optional][default to true] |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::CreateApiKeyDto.new(
+  name: Production Key,
+  allow_write: true
+)
+```
+

data/docs/CreateCheckoutDto.md

@@ -0,0 +1,36 @@
+# Solifyn::CreateCheckoutDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **product_id** | **String** | The public product identifier (product ID) |  |
+| **currency** | **String** | Three-letter ISO currency code (lowercase) | [optional] |
+| **quantity** | **Float** | The quantity of items to buy | [optional][default to 1] |
+| **discount_code** | **String** | Discount code to apply | [optional] |
+| **custom_price** | **Float** | Custom price paid by customer (for Pay What You Want products) | [optional] |
+| **customer_email** | **String** | Email address of the customer | [optional] |
+| **checkout_data** | **Object** | JSON metadata or checkout custom information | [optional] |
+| **custom_fields** | **Object** | Custom text fields required for the purchase | [optional] |
+| **aff** | **String** | Affiliate partner tracking code | [optional] |
+| **checkout_id** | **String** | The existing checkout database ID to validate / update | [optional] |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::CreateCheckoutDto.new(
+  product_id: prod_XXXXXXXXXXX,
+  currency: usd,
+  quantity: 1,
+  discount_code: PROMO10,
+  custom_price: 15,
+  customer_email: customer@example.com,
+  checkout_data: null,
+  custom_fields: null,
+  aff: partner_abc,
+  checkout_id: 019e56ba-9832-72ae-XXXXXXXXXXX
+)
+```
+

data/docs/CreateCheckoutLinkDto.md

@@ -0,0 +1,44 @@
+# Solifyn::CreateCheckoutLinkDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **title** | **String** | The friendly display title of this checkout link | [optional] |
+| **product_id** | **String** | Product database/Whop ID to sell |  |
+| **collection_id** | **String** | Optional collection database ID to sell | [optional] |
+| **customer_name** | **String** | Prefilled customer name for checkout inputs | [optional] |
+| **customer_email** | **String** | Prefilled customer email for checkout inputs | [optional] |
+| **address_line1** | **String** | Prefilled customer billing address line 1 | [optional] |
+| **city** | **String** | Prefilled customer billing city | [optional] |
+| **state** | **String** | Prefilled customer billing state | [optional] |
+| **postal_code** | **String** | Prefilled customer billing zip/postal code | [optional] |
+| **country** | **String** | Prefilled customer billing country (2-letter ISO) | [optional] |
+| **quantity** | **Object** | Override quantity for checkout session | [optional] |
+| **redirect_url** | **String** | The absolute URL to redirect to upon successful payment completion | [optional] |
+| **cancel_url** | **String** | The absolute URL to redirect to if a customer cancels the payment | [optional] |
+| **show_discounts** | **Boolean** | Whether to display discount input form fields on checkout screen | [optional][default to true] |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::CreateCheckoutLinkDto.new(
+  title: Winter Bundle Checkout,
+  product_id: prod_123,
+  collection_id: col_123,
+  customer_name: John Doe,
+  customer_email: customer@gmail.com,
+  address_line1: 123 Main St,
+  city: San Francisco,
+  state: CA,
+  postal_code: 94111,
+  country: US,
+  quantity: 1,
+  redirect_url: https://mysite.com/success,
+  cancel_url: https://mysite.com/cancel,
+  show_discounts: true
+)
+```
+

data/docs/CreateCollectionCheckoutDto.md

@@ -0,0 +1,26 @@
+# Solifyn::CreateCollectionCheckoutDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **collection_id** | **String** | The database ID of the collection to checkout |  |
+| **quantity** | **Float** | Quantity of collections to buy | [optional][default to 1] |
+| **discount_code** | **String** | Discount code to apply | [optional] |
+| **aff** | **String** | Affiliate tracking code | [optional] |
+| **custom_fields** | **Object** | Custom text fields / selected addons | [optional] |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::CreateCollectionCheckoutDto.new(
+  collection_id: col_123,
+  quantity: 1,
+  discount_code: PROMO10,
+  aff: partner_abc,
+  custom_fields: null
+)
+```
+

data/docs/CreateCollectionDto.md

@@ -0,0 +1,26 @@
+# Solifyn::CreateCollectionDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The friendly name of the collection |  |
+| **description** | **String** | A detailed description of this collection | [optional] |
+| **image_url** | **String** | The display cover image URL for this collection | [optional] |
+| **status** | **String** | The collection status | [optional] |
+| **products** | [**Array<CollectionProductEntry>**](CollectionProductEntry.md) | List of products to include in this collection. At least one product is required. |  |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::CreateCollectionDto.new(
+  name: Winter Course Bundle,
+  description: Get all our premium programming courses at a highly discounted price.,
+  image_url: https://images.unsplash.com/photo-123,
+  status: ACTIVE,
+  products: null
+)
+```
+

data/docs/CreateCustomerDto.md

@@ -0,0 +1,26 @@
+# Solifyn::CreateCustomerDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email** | **String** | The unique email of the customer |  |
+| **name** | **String** | The customer friendly full name |  |
+| **phone** | **String** | The customer telephone/phone number | [optional] |
+| **username** | **String** | The username of the customer (e.g. Discord, Whop) | [optional] |
+| **metadata** | **Object** | Custom key-value metadata associated with the customer | [optional] |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::CreateCustomerDto.new(
+  email: customer@gmail.com,
+  name: John Doe,
+  phone: +1234567890,
+  username: johndoe,
+  metadata: {customKey=customValue}
+)
+```
+

data/docs/CreateMeterDto.md

@@ -0,0 +1,32 @@
+# Solifyn::CreateMeterDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Meter display name. |  |
+| **description** | **String** | Meter description. | [optional] |
+| **event_name** | **String** | The event name tracked by this meter. |  |
+| **aggregation_type** | **String** | Aggregation strategy for usage events. |  |
+| **aggregation_key** | **String** | Metadata key used by SUM, MAX, or LAST aggregation modes. | [optional] |
+| **unit** | **String** | Measurement unit label. | [optional] |
+| **filters** | **Hash<String, Object>** | Optional filter definition for advanced matching. | [optional] |
+| **enable_filtering** | **Boolean** | Enable filtering on usage event ingestion. | [optional][default to false] |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::CreateMeterDto.new(
+  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},
+  enable_filtering: false
+)
+```
+