solifyn 1.0.0

data/docs/SubscriptionDetail.md

@@ -0,0 +1,24 @@
+# Solifyn::SubscriptionDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **subscription** | [**Subscription**](Subscription.md) | The main subscription details |  |
+| **payments** | [**Array<Order>**](Order.md) | The subscription payments / invoice billing history |  |
+| **purchased_addons** | [**Array<ResolvedAddon>**](ResolvedAddon.md) | List of purchased addons associated with this subscription |  |
+| **product** | [**SubscriptionDetailProduct**](SubscriptionDetailProduct.md) | The core product information associated with this subscription |  |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::SubscriptionDetail.new(
+  subscription: null,
+  payments: null,
+  purchased_addons: null,
+  product: null
+)
+```
+

data/docs/SubscriptionDetailProduct.md

@@ -0,0 +1,28 @@
+# Solifyn::SubscriptionDetailProduct
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The product unique ID |  |
+| **name** | **String** | The product name |  |
+| **price** | **Float** | Product base price |  |
+| **currency** | **String** | Base currency |  |
+| **metadata** | **Object** | Metadata JSON payload | [optional] |
+| **pricing_type** | **String** | Pricing type, e.g. one-time or renewal |  |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::SubscriptionDetailProduct.new(
+  id: prod_123,
+  name: My Pro Product,
+  price: 99,
+  currency: usd,
+  metadata: {},
+  pricing_type: renewal
+)
+```
+

data/docs/SubscriptionList.md

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

data/docs/SubscriptionMemberDto.md

@@ -0,0 +1,18 @@
+# Solifyn::SubscriptionMemberDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The unique ID of the member |  |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::SubscriptionMemberDto.new(
+  id: mber_123
+)
+```
+

data/docs/SubscriptionPlanDto.md

@@ -0,0 +1,20 @@
+# Solifyn::SubscriptionPlanDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The unique ID of the plan |  |
+| **metadata** | **Object** | Additional metadata associated with the plan | [optional] |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::SubscriptionPlanDto.new(
+  id: plan_123,
+  metadata: {}
+)
+```
+

data/docs/SubscriptionProductDto.md

@@ -0,0 +1,22 @@
+# Solifyn::SubscriptionProductDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The unique ID of the product |  |
+| **title** | **String** | The title/name of the product |  |
+| **metadata** | **Object** | Additional metadata associated with the product | [optional] |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::SubscriptionProductDto.new(
+  id: prod_123,
+  title: Product Name,
+  metadata: {}
+)
+```
+

data/docs/SubscriptionSeatAdjustment.md

@@ -0,0 +1,34 @@
+# Solifyn::SubscriptionSeatAdjustment
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Boolean** | Indicates if the seat adjustment was successful |  |
+| **subscription_id** | **String** | The customer subscription ID |  |
+| **addon_product_id** | **String** | The unique ID of the addon product |  |
+| **old_quantity** | **Float** | The previous seat quantity |  |
+| **new_quantity** | **Float** | The new seat quantity after adjustment |  |
+| **quantity_delta** | **Float** | The difference in seat quantity |  |
+| **proration_type** | **String** | The proration strategy type applied |  |
+| **cost_impact** | **Float** | Calculated pro-rata price cost impact in currency unit (charged or credited) |  |
+| **currency** | **String** | Billing currency |  |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::SubscriptionSeatAdjustment.new(
+  success: true,
+  subscription_id: mem_123,
+  addon_product_id: prod_seat_123,
+  old_quantity: 2,
+  new_quantity: 5,
+  quantity_delta: 3,
+  proration_type: do_not_bill,
+  cost_impact: 0,
+  currency: usd
+)
+```
+

data/docs/SubscriptionUserDto.md

@@ -0,0 +1,24 @@
+# Solifyn::SubscriptionUserDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The unique ID of the user |  |
+| **username** | **String** | The username of the user |  |
+| **name** | **String** | The full name of the user |  |
+| **email** | **String** | The email address of the user |  |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::SubscriptionUserDto.new(
+  id: user_123,
+  username: johndoe,
+  name: John Doe,
+  email: john.doe@example.com
+)
+```
+

data/docs/SubscriptionsAction201Response.md

@@ -0,0 +1,49 @@
+# Solifyn::SubscriptionsAction201Response
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'solifyn'
+
+Solifyn::SubscriptionsAction201Response.openapi_one_of
+# =>
+# [
+#   :'Subscription',
+#   :'SubscriptionSeatAdjustment'
+# ]
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'solifyn'
+
+Solifyn::SubscriptionsAction201Response.build(data)
+# => #<Subscription:0x00007fdd4aab02a0>
+
+Solifyn::SubscriptionsAction201Response.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `Subscription`
+- `SubscriptionSeatAdjustment`
+- `nil` (if no type matches)
+

data/docs/SubscriptionsApi.md

@@ -0,0 +1,223 @@
+# Solifyn::SubscriptionsApi
+
+All URIs are relative to *http://localhost:8000*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**subscriptions_action**](SubscriptionsApi.md#subscriptions_action) | **POST** /v1/subscriptions/{subscriptionId}/{action} | Subscription Action |
+| [**subscriptions_get**](SubscriptionsApi.md#subscriptions_get) | **GET** /v1/subscriptions/{id} | Retrieve Subscription Details |
+| [**subscriptions_list**](SubscriptionsApi.md#subscriptions_list) | **GET** /v1/subscriptions | List Subscriptions |
+
+
+## subscriptions_action
+
+> <SubscriptionsAction201Response> subscriptions_action(subscription_id, action, subscription_action)
+
+Subscription Action
+
+Cancel, pause, resume, or add free days to a customer subscription.
+
+### 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::SubscriptionsApi.new
+subscription_id = 'mem_123' # String | The customer subscription ID
+action = 'add_free_days' # String | The subscription task to execute
+subscription_action = Solifyn::SubscriptionAction.new # SubscriptionAction | 
+
+begin
+  # Subscription Action
+  result = api_instance.subscriptions_action(subscription_id, action, subscription_action)
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling SubscriptionsApi->subscriptions_action: #{e}"
+end
+```
+
+#### Using the subscriptions_action_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SubscriptionsAction201Response>, Integer, Hash)> subscriptions_action_with_http_info(subscription_id, action, subscription_action)
+
+```ruby
+begin
+  # Subscription Action
+  data, status_code, headers = api_instance.subscriptions_action_with_http_info(subscription_id, action, subscription_action)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SubscriptionsAction201Response>
+rescue Solifyn::ApiError => e
+  puts "Error when calling SubscriptionsApi->subscriptions_action_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **subscription_id** | **String** | The customer subscription ID |  |
+| **action** | **String** | The subscription task to execute |  |
+| **subscription_action** | [**SubscriptionAction**](SubscriptionAction.md) |  |  |
+
+### Return type
+
+[**SubscriptionsAction201Response**](SubscriptionsAction201Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## subscriptions_get
+
+> <SubscriptionDetail> subscriptions_get(id)
+
+Retrieve Subscription Details
+
+Retrieve detailed information about a subscription and its billing 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::SubscriptionsApi.new
+id = 'mem_123' # String | The customer subscription ID
+
+begin
+  # Retrieve Subscription Details
+  result = api_instance.subscriptions_get(id)
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling SubscriptionsApi->subscriptions_get: #{e}"
+end
+```
+
+#### Using the subscriptions_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SubscriptionDetail>, Integer, Hash)> subscriptions_get_with_http_info(id)
+
+```ruby
+begin
+  # Retrieve Subscription Details
+  data, status_code, headers = api_instance.subscriptions_get_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SubscriptionDetail>
+rescue Solifyn::ApiError => e
+  puts "Error when calling SubscriptionsApi->subscriptions_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The customer subscription ID |  |
+
+### Return type
+
+[**SubscriptionDetail**](SubscriptionDetail.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## subscriptions_list
+
+> <SubscriptionList> subscriptions_list(opts)
+
+List Subscriptions
+
+Retrieve a list of customer subscriptions, optionally filtered by customer 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::SubscriptionsApi.new
+opts = {
+  customer_id: 'customer_id_example' # String | Filter subscriptions by customer ID.
+}
+
+begin
+  # List Subscriptions
+  result = api_instance.subscriptions_list(opts)
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling SubscriptionsApi->subscriptions_list: #{e}"
+end
+```
+
+#### Using the subscriptions_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<SubscriptionList>, Integer, Hash)> subscriptions_list_with_http_info(opts)
+
+```ruby
+begin
+  # List Subscriptions
+  data, status_code, headers = api_instance.subscriptions_list_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <SubscriptionList>
+rescue Solifyn::ApiError => e
+  puts "Error when calling SubscriptionsApi->subscriptions_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **customer_id** | **String** | Filter subscriptions by customer ID. | [optional] |
+
+### Return type
+
+[**SubscriptionList**](SubscriptionList.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/SupportedCurrenciesResponseDto.md

@@ -0,0 +1,20 @@
+# Solifyn::SupportedCurrenciesResponseDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **label** | **String** | The label display name of the currency |  |
+| **value** | **String** | The currency code |  |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::SupportedCurrenciesResponseDto.new(
+  label: US Dollar,
+  value: usd
+)
+```
+