solifyn 1.0.0

data/docs/CreateSetupCheckoutDto.md

@@ -0,0 +1,26 @@
+# Solifyn::CreateSetupCheckoutDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **company_id** | **String** | The Whop/Stripe company ID context |  |
+| **currency** | **String** | Currency for setup mode | [optional][default to 'usd'] |
+| **retry_payment_id** | **String** | Internal or Whop failed payment ID to retry | [optional] |
+| **membership_id** | **String** | Membership ID to link setup checkout to for card updating | [optional] |
+| **plan_id** | **String** | Plan ID to retry or renew | [optional] |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::CreateSetupCheckoutDto.new(
+  company_id: biz_xxxxxxxxxxxxxx,
+  currency: usd,
+  retry_payment_id: pay_xxxxxxxxxxxxxx,
+  membership_id: mem_xxxxxxxxxxxxxx,
+  plan_id: plan_xxxxxxxxxxxxx
+)
+```
+

data/docs/CreateWebhookEndpointDto.md

@@ -0,0 +1,22 @@
+# Solifyn::CreateWebhookEndpointDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** | The URL to send webhook events to. |  |
+| **description** | **String** | Optional description for the webhook endpoint. | [optional] |
+| **events** | **Array<String>** | The list of subscribed event types. |  |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::CreateWebhookEndpointDto.new(
+  url: https://api.example.com/webhooks,
+  description: Primary payment listener,
+  events: [payment.created, payment.succeeded]
+)
+```
+

data/docs/CustomerListResponseDto.md

@@ -0,0 +1,20 @@
+# Solifyn::CustomerListResponseDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **items** | [**Array<CustomerResponseDto>**](CustomerResponseDto.md) | List of customers |  |
+| **total_count** | **Float** | Total count of customers matching the filters |  |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::CustomerListResponseDto.new(
+  items: null,
+  total_count: 1
+)
+```
+

data/docs/CustomerMessageResponseDto.md

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

data/docs/CustomerResponseDto.md

@@ -0,0 +1,38 @@
+# Solifyn::CustomerResponseDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The customer ID |  |
+| **member_id** | **String** | The Membership ID associated with this customer | [optional] |
+| **email** | **String** | The email address of the customer |  |
+| **name** | **String** | The name of the customer | [optional] |
+| **username** | **String** | The username of the customer | [optional] |
+| **phone** | **String** | The phone number of the customer | [optional] |
+| **phone_number** | **String** | The phone number of the customer | [optional] |
+| **metadata** | **Object** | Additional metadata associated with the customer | [optional] |
+| **created_at** | **Time** | Timestamp when the customer was created |  |
+| **updated_at** | **Time** | Timestamp when the customer was last updated |  |
+| **business_id** | **String** | The business ID associated with the customer |  |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::CustomerResponseDto.new(
+  id: user_123,
+  member_id: mem_123,
+  email: customer@example.com,
+  name: John Doe,
+  username: johndoe,
+  phone: +1234567890,
+  phone_number: +1234567890,
+  metadata: {key=value},
+  created_at: 2025-01-01T12:00:00Z,
+  updated_at: 2025-01-01T12:00:00Z,
+  business_id: 537825c3-14d6-4173-b072-33f921416efc
+)
+```
+

data/docs/CustomerSharedInviteResponseDto.md

@@ -0,0 +1,22 @@
+# Solifyn::CustomerSharedInviteResponseDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **token** | **String** | The generated invite token |  |
+| **expires_at** | **Time** | The expiration timestamp of the token |  |
+| **url** | **String** | The self-service shared portal URL | [optional] |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::CustomerSharedInviteResponseDto.new(
+  token: 2jb5bp8bq0jfucv7rtt9a8,
+  expires_at: 2025-01-02T12:00:00Z,
+  url: http://localhost:3000/shared/2jb5bp8bq0jfucv7rtt9a8
+)
+```
+

data/docs/CustomersApi.md

@@ -0,0 +1,356 @@
+# Solifyn::CustomersApi
+
+All URIs are relative to *http://localhost:8000*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**customers_create**](CustomersApi.md#customers_create) | **POST** /v1/customers | Create Customer |
+| [**customers_generate_invite**](CustomersApi.md#customers_generate_invite) | **POST** /v1/customers/{id}/share | Generate Shared Invite |
+| [**customers_get**](CustomersApi.md#customers_get) | **GET** /v1/customers/{id} | Retrieve Customer |
+| [**customers_list**](CustomersApi.md#customers_list) | **GET** /v1/customers | List Customers |
+| [**customers_update**](CustomersApi.md#customers_update) | **PATCH** /v1/customers/{id} | Update Customer |
+
+
+## customers_create
+
+> <CustomerResponseDto> customers_create(create_customer_dto)
+
+Create Customer
+
+Add/upsert a new customer profile under 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::CustomersApi.new
+create_customer_dto = Solifyn::CreateCustomerDto.new({email: 'customer@gmail.com', name: 'John Doe'}) # CreateCustomerDto | 
+
+begin
+  # Create Customer
+  result = api_instance.customers_create(create_customer_dto)
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling CustomersApi->customers_create: #{e}"
+end
+```
+
+#### Using the customers_create_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CustomerResponseDto>, Integer, Hash)> customers_create_with_http_info(create_customer_dto)
+
+```ruby
+begin
+  # Create Customer
+  data, status_code, headers = api_instance.customers_create_with_http_info(create_customer_dto)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CustomerResponseDto>
+rescue Solifyn::ApiError => e
+  puts "Error when calling CustomersApi->customers_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_customer_dto** | [**CreateCustomerDto**](CreateCustomerDto.md) |  |  |
+
+### Return type
+
+[**CustomerResponseDto**](CustomerResponseDto.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## customers_generate_invite
+
+> <CustomerSharedInviteResponseDto> customers_generate_invite(id)
+
+Generate Shared Invite
+
+Generate a short-lived token granting temporary customer self-service billing page access.
+
+### 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::CustomersApi.new
+id = 'user_123' # String | Customer ID
+
+begin
+  # Generate Shared Invite
+  result = api_instance.customers_generate_invite(id)
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling CustomersApi->customers_generate_invite: #{e}"
+end
+```
+
+#### Using the customers_generate_invite_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CustomerSharedInviteResponseDto>, Integer, Hash)> customers_generate_invite_with_http_info(id)
+
+```ruby
+begin
+  # Generate Shared Invite
+  data, status_code, headers = api_instance.customers_generate_invite_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CustomerSharedInviteResponseDto>
+rescue Solifyn::ApiError => e
+  puts "Error when calling CustomersApi->customers_generate_invite_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Customer ID |  |
+
+### Return type
+
+[**CustomerSharedInviteResponseDto**](CustomerSharedInviteResponseDto.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## customers_get
+
+> <CustomerResponseDto> customers_get(id)
+
+Retrieve Customer
+
+Retrieve details of a customer profile 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::CustomersApi.new
+id = 'user_123' # String | Customer ID
+
+begin
+  # Retrieve Customer
+  result = api_instance.customers_get(id)
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling CustomersApi->customers_get: #{e}"
+end
+```
+
+#### Using the customers_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CustomerResponseDto>, Integer, Hash)> customers_get_with_http_info(id)
+
+```ruby
+begin
+  # Retrieve Customer
+  data, status_code, headers = api_instance.customers_get_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CustomerResponseDto>
+rescue Solifyn::ApiError => e
+  puts "Error when calling CustomersApi->customers_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Customer ID |  |
+
+### Return type
+
+[**CustomerResponseDto**](CustomerResponseDto.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## customers_list
+
+> <CustomerListResponseDto> customers_list
+
+List Customers
+
+Retrieve all customers associated with 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::CustomersApi.new
+
+begin
+  # List Customers
+  result = api_instance.customers_list
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling CustomersApi->customers_list: #{e}"
+end
+```
+
+#### Using the customers_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CustomerListResponseDto>, Integer, Hash)> customers_list_with_http_info
+
+```ruby
+begin
+  # List Customers
+  data, status_code, headers = api_instance.customers_list_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CustomerListResponseDto>
+rescue Solifyn::ApiError => e
+  puts "Error when calling CustomersApi->customers_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**CustomerListResponseDto**](CustomerListResponseDto.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## customers_update
+
+> <CustomerMessageResponseDto> customers_update(id, update_customer_dto)
+
+Update Customer
+
+Update name, phone, or metadata of an existing customer profile.
+
+### 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::CustomersApi.new
+id = 'user_123' # String | Customer ID
+update_customer_dto = Solifyn::UpdateCustomerDto.new # UpdateCustomerDto | 
+
+begin
+  # Update Customer
+  result = api_instance.customers_update(id, update_customer_dto)
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling CustomersApi->customers_update: #{e}"
+end
+```
+
+#### Using the customers_update_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CustomerMessageResponseDto>, Integer, Hash)> customers_update_with_http_info(id, update_customer_dto)
+
+```ruby
+begin
+  # Update Customer
+  data, status_code, headers = api_instance.customers_update_with_http_info(id, update_customer_dto)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CustomerMessageResponseDto>
+rescue Solifyn::ApiError => e
+  puts "Error when calling CustomersApi->customers_update_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Customer ID |  |
+| **update_customer_dto** | [**UpdateCustomerDto**](UpdateCustomerDto.md) |  |  |
+
+### Return type
+
+[**CustomerMessageResponseDto**](CustomerMessageResponseDto.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/DashboardStatsDto.md

@@ -0,0 +1,24 @@
+# Solifyn::DashboardStatsDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **revenue** | **Float** | Gross revenue in cents |  |
+| **orders_count** | **Float** | Total payments processed count |  |
+| **refunds_count** | **Float** | Gross amount refunded in cents |  |
+| **active_memberships** | **Float** | Number of active paying customers/memberships |  |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::DashboardStatsDto.new(
+  revenue: 500000,
+  orders_count: 120,
+  refunds_count: 1500,
+  active_memberships: 85
+)
+```
+