solifyn 1.0.5 → 1.0.7

data/docs/TicketApi.md

@@ -0,0 +1,318 @@
+# Solifyn::TicketApi
+
+All URIs are relative to *http://localhost:8000*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**ticket_controller_create_ticket**](TicketApi.md#ticket_controller_create_ticket) | **POST** /v1/tickets |  |
+| [**ticket_controller_get_ticket_details**](TicketApi.md#ticket_controller_get_ticket_details) | **GET** /v1/tickets/{id} |  |
+| [**ticket_controller_get_tickets**](TicketApi.md#ticket_controller_get_tickets) | **GET** /v1/tickets |  |
+| [**ticket_controller_reply_ticket**](TicketApi.md#ticket_controller_reply_ticket) | **POST** /v1/tickets/{id}/replies |  |
+| [**ticket_controller_update_ticket**](TicketApi.md#ticket_controller_update_ticket) | **PATCH** /v1/tickets/{id} |  |
+
+
+## ticket_controller_create_ticket
+
+> ticket_controller_create_ticket(body)
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'solifyn'
+
+api_instance = Solifyn::TicketApi.new
+body = { ... } # Object | 
+
+begin
+  
+  api_instance.ticket_controller_create_ticket(body)
+rescue Solifyn::ApiError => e
+  puts "Error when calling TicketApi->ticket_controller_create_ticket: #{e}"
+end
+```
+
+#### Using the ticket_controller_create_ticket_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)> ticket_controller_create_ticket_with_http_info(body)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.ticket_controller_create_ticket_with_http_info(body)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Solifyn::ApiError => e
+  puts "Error when calling TicketApi->ticket_controller_create_ticket_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **body** | **Object** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: Not defined
+
+
+## ticket_controller_get_ticket_details
+
+> ticket_controller_get_ticket_details(id)
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'solifyn'
+
+api_instance = Solifyn::TicketApi.new
+id = 'id_example' # String | 
+
+begin
+  
+  api_instance.ticket_controller_get_ticket_details(id)
+rescue Solifyn::ApiError => e
+  puts "Error when calling TicketApi->ticket_controller_get_ticket_details: #{e}"
+end
+```
+
+#### Using the ticket_controller_get_ticket_details_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)> ticket_controller_get_ticket_details_with_http_info(id)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.ticket_controller_get_ticket_details_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Solifyn::ApiError => e
+  puts "Error when calling TicketApi->ticket_controller_get_ticket_details_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
+
+
+## ticket_controller_get_tickets
+
+> ticket_controller_get_tickets
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'solifyn'
+
+api_instance = Solifyn::TicketApi.new
+
+begin
+  
+  api_instance.ticket_controller_get_tickets
+rescue Solifyn::ApiError => e
+  puts "Error when calling TicketApi->ticket_controller_get_tickets: #{e}"
+end
+```
+
+#### Using the ticket_controller_get_tickets_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)> ticket_controller_get_tickets_with_http_info
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.ticket_controller_get_tickets_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Solifyn::ApiError => e
+  puts "Error when calling TicketApi->ticket_controller_get_tickets_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
+
+
+## ticket_controller_reply_ticket
+
+> ticket_controller_reply_ticket(id, body)
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'solifyn'
+
+api_instance = Solifyn::TicketApi.new
+id = 'id_example' # String | 
+body = { ... } # Object | 
+
+begin
+  
+  api_instance.ticket_controller_reply_ticket(id, body)
+rescue Solifyn::ApiError => e
+  puts "Error when calling TicketApi->ticket_controller_reply_ticket: #{e}"
+end
+```
+
+#### Using the ticket_controller_reply_ticket_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)> ticket_controller_reply_ticket_with_http_info(id, body)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.ticket_controller_reply_ticket_with_http_info(id, body)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Solifyn::ApiError => e
+  puts "Error when calling TicketApi->ticket_controller_reply_ticket_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **body** | **Object** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: Not defined
+
+
+## ticket_controller_update_ticket
+
+> ticket_controller_update_ticket(id, body)
+
+
+
+### Examples
+
+```ruby
+require 'time'
+require 'solifyn'
+
+api_instance = Solifyn::TicketApi.new
+id = 'id_example' # String | 
+body = { ... } # Object | 
+
+begin
+  
+  api_instance.ticket_controller_update_ticket(id, body)
+rescue Solifyn::ApiError => e
+  puts "Error when calling TicketApi->ticket_controller_update_ticket: #{e}"
+end
+```
+
+#### Using the ticket_controller_update_ticket_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)> ticket_controller_update_ticket_with_http_info(id, body)
+
+```ruby
+begin
+  
+  data, status_code, headers = api_instance.ticket_controller_update_ticket_with_http_info(id, body)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Solifyn::ApiError => e
+  puts "Error when calling TicketApi->ticket_controller_update_ticket_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **body** | **Object** |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: Not defined
+

data/docs/UserPage.md

@@ -0,0 +1,26 @@
+# Solifyn::UserPage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Store page record ID |  |
+| **subdomain** | **String** | Unique subdomain |  |
+| **store_name** | **String** | Friendly store name |  |
+| **config** | **Object** | Styling config JSON |  |
+| **business_id** | **String** | Linked business ID |  |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::UserPage.new(
+  id: page_123,
+  subdomain: acme,
+  store_name: Acme Shop,
+  config: {"theme":{"primaryColor":"#0f172a"}},
+  business_id: biz_123
+)
+```
+

data/docs/UserProfileThemesApi.md

@@ -0,0 +1,345 @@
+# Solifyn::UserProfileThemesApi
+
+All URIs are relative to *http://localhost:8000*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**users_get_my_page**](UserProfileThemesApi.md#users_get_my_page) | **GET** /v1/user/my-page | Get My Page details |
+| [**users_get_my_theme**](UserProfileThemesApi.md#users_get_my_theme) | **GET** /v1/user/my-theme | Get My Theme |
+| [**users_get_settings**](UserProfileThemesApi.md#users_get_settings) | **GET** /v1/user/settings | Retrieve User Settings |
+| [**users_get_stats**](UserProfileThemesApi.md#users_get_stats) | **GET** /v1/user/dashboard-stats | Get Dashboard Statistics |
+| [**users_get_theme_by_subdomain**](UserProfileThemesApi.md#users_get_theme_by_subdomain) | **GET** /v1/user/theme/{subdomain} | Get Theme by Subdomain |
+
+
+## users_get_my_page
+
+> <UserPage> users_get_my_page
+
+Get My Page details
+
+Retrieve page settings and custom content configured for the store.
+
+### 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::UserProfileThemesApi.new
+
+begin
+  # Get My Page details
+  result = api_instance.users_get_my_page
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling UserProfileThemesApi->users_get_my_page: #{e}"
+end
+```
+
+#### Using the users_get_my_page_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UserPage>, Integer, Hash)> users_get_my_page_with_http_info
+
+```ruby
+begin
+  # Get My Page details
+  data, status_code, headers = api_instance.users_get_my_page_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UserPage>
+rescue Solifyn::ApiError => e
+  puts "Error when calling UserProfileThemesApi->users_get_my_page_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**UserPage**](UserPage.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## users_get_my_theme
+
+> <UserTheme> users_get_my_theme
+
+Get My Theme
+
+Retrieve theme configurations for the active 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::UserProfileThemesApi.new
+
+begin
+  # Get My Theme
+  result = api_instance.users_get_my_theme
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling UserProfileThemesApi->users_get_my_theme: #{e}"
+end
+```
+
+#### Using the users_get_my_theme_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UserTheme>, Integer, Hash)> users_get_my_theme_with_http_info
+
+```ruby
+begin
+  # Get My Theme
+  data, status_code, headers = api_instance.users_get_my_theme_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UserTheme>
+rescue Solifyn::ApiError => e
+  puts "Error when calling UserProfileThemesApi->users_get_my_theme_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**UserTheme**](UserTheme.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## users_get_settings
+
+> <UserSettings> users_get_settings
+
+Retrieve User Settings
+
+Retrieve profile settings and notification preferences for the user.
+
+### 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::UserProfileThemesApi.new
+
+begin
+  # Retrieve User Settings
+  result = api_instance.users_get_settings
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling UserProfileThemesApi->users_get_settings: #{e}"
+end
+```
+
+#### Using the users_get_settings_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UserSettings>, Integer, Hash)> users_get_settings_with_http_info
+
+```ruby
+begin
+  # Retrieve User Settings
+  data, status_code, headers = api_instance.users_get_settings_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UserSettings>
+rescue Solifyn::ApiError => e
+  puts "Error when calling UserProfileThemesApi->users_get_settings_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**UserSettings**](UserSettings.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## users_get_stats
+
+> <UserStats> users_get_stats
+
+Get Dashboard Statistics
+
+Retrieve general analytics stats (revenue, order counts, etc.) for dashboard graphs.
+
+### 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::UserProfileThemesApi.new
+
+begin
+  # Get Dashboard Statistics
+  result = api_instance.users_get_stats
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling UserProfileThemesApi->users_get_stats: #{e}"
+end
+```
+
+#### Using the users_get_stats_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UserStats>, Integer, Hash)> users_get_stats_with_http_info
+
+```ruby
+begin
+  # Get Dashboard Statistics
+  data, status_code, headers = api_instance.users_get_stats_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UserStats>
+rescue Solifyn::ApiError => e
+  puts "Error when calling UserProfileThemesApi->users_get_stats_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**UserStats**](UserStats.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## users_get_theme_by_subdomain
+
+> <UserTheme> users_get_theme_by_subdomain(subdomain)
+
+Get Theme by Subdomain
+
+Retrieve public theme configuration details by store subdomain.
+
+### 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::UserProfileThemesApi.new
+subdomain = 'acme' # String | The subdomain of the store
+
+begin
+  # Get Theme by Subdomain
+  result = api_instance.users_get_theme_by_subdomain(subdomain)
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling UserProfileThemesApi->users_get_theme_by_subdomain: #{e}"
+end
+```
+
+#### Using the users_get_theme_by_subdomain_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<UserTheme>, Integer, Hash)> users_get_theme_by_subdomain_with_http_info(subdomain)
+
+```ruby
+begin
+  # Get Theme by Subdomain
+  data, status_code, headers = api_instance.users_get_theme_by_subdomain_with_http_info(subdomain)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <UserTheme>
+rescue Solifyn::ApiError => e
+  puts "Error when calling UserProfileThemesApi->users_get_theme_by_subdomain_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **subdomain** | **String** | The subdomain of the store |  |
+
+### Return type
+
+[**UserTheme**](UserTheme.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/UserSettings.md

@@ -0,0 +1,34 @@
+# Solifyn::UserSettings
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | User ID |  |
+| **email** | **String** | Primary email address |  |
+| **first_name** | **String** | First name | [optional] |
+| **last_name** | **String** | Last name | [optional] |
+| **avatar_url** | **String** | Profile avatar image URL | [optional] |
+| **payout_threshold** | **Float** | Auto-payout minimum threshold limit in cents |  |
+| **notify_on_success** | **Boolean** | Auto-email receipt toggled |  |
+| **send_license_key_email** | **Boolean** | Send license keys email automatically |  |
+| **send_digital_file_email** | **Boolean** | Send digital delivery download link emails automatically |  |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::UserSettings.new(
+  id: usr_123,
+  email: contact@acme.com,
+  first_name: John,
+  last_name: Doe,
+  avatar_url: https://acme.com/avatar.png,
+  payout_threshold: 5000,
+  notify_on_success: true,
+  send_license_key_email: true,
+  send_digital_file_email: true
+)
+```
+