solifyn 1.0.0

data/docs/RefundRequestsApi.md

@@ -0,0 +1,311 @@
+# Solifyn::RefundRequestsApi
+
+All URIs are relative to *http://localhost:8000*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**refund_requests_list**](RefundRequestsApi.md#refund_requests_list) | **GET** /v1/refund-requests | List Refund Requests (Merchant) |
+| [**refund_requests_list_messages**](RefundRequestsApi.md#refund_requests_list_messages) | **GET** /v1/refund-requests/{id}/messages | List Messages for Refund Request (Merchant) |
+| [**refund_requests_send_message**](RefundRequestsApi.md#refund_requests_send_message) | **POST** /v1/refund-requests/{id}/messages | Send Refund Request Message (Merchant) |
+| [**refund_requests_update_status**](RefundRequestsApi.md#refund_requests_update_status) | **PATCH** /v1/refund-requests/{id}/status | Update Refund Request Status (Merchant) |
+| [**refund_requests_upload_evidence**](RefundRequestsApi.md#refund_requests_upload_evidence) | **POST** /v1/refund-requests/upload-evidence | Upload Dispute Evidence File (Merchant) |
+
+
+## refund_requests_list
+
+> refund_requests_list
+
+List Refund Requests (Merchant)
+
+### Examples
+
+```ruby
+require 'time'
+require 'solifyn'
+
+api_instance = Solifyn::RefundRequestsApi.new
+
+begin
+  # List Refund Requests (Merchant)
+  api_instance.refund_requests_list
+rescue Solifyn::ApiError => e
+  puts "Error when calling RefundRequestsApi->refund_requests_list: #{e}"
+end
+```
+
+#### Using the refund_requests_list_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)> refund_requests_list_with_http_info
+
+```ruby
+begin
+  # List Refund Requests (Merchant)
+  data, status_code, headers = api_instance.refund_requests_list_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Solifyn::ApiError => e
+  puts "Error when calling RefundRequestsApi->refund_requests_list_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
+
+
+## refund_requests_list_messages
+
+> refund_requests_list_messages(id)
+
+List Messages for Refund Request (Merchant)
+
+### Examples
+
+```ruby
+require 'time'
+require 'solifyn'
+
+api_instance = Solifyn::RefundRequestsApi.new
+id = 'id_example' # String | 
+
+begin
+  # List Messages for Refund Request (Merchant)
+  api_instance.refund_requests_list_messages(id)
+rescue Solifyn::ApiError => e
+  puts "Error when calling RefundRequestsApi->refund_requests_list_messages: #{e}"
+end
+```
+
+#### Using the refund_requests_list_messages_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)> refund_requests_list_messages_with_http_info(id)
+
+```ruby
+begin
+  # List Messages for Refund Request (Merchant)
+  data, status_code, headers = api_instance.refund_requests_list_messages_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Solifyn::ApiError => e
+  puts "Error when calling RefundRequestsApi->refund_requests_list_messages_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
+
+
+## refund_requests_send_message
+
+> refund_requests_send_message(id)
+
+Send Refund Request Message (Merchant)
+
+### Examples
+
+```ruby
+require 'time'
+require 'solifyn'
+
+api_instance = Solifyn::RefundRequestsApi.new
+id = 'id_example' # String | 
+
+begin
+  # Send Refund Request Message (Merchant)
+  api_instance.refund_requests_send_message(id)
+rescue Solifyn::ApiError => e
+  puts "Error when calling RefundRequestsApi->refund_requests_send_message: #{e}"
+end
+```
+
+#### Using the refund_requests_send_message_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)> refund_requests_send_message_with_http_info(id)
+
+```ruby
+begin
+  # Send Refund Request Message (Merchant)
+  data, status_code, headers = api_instance.refund_requests_send_message_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Solifyn::ApiError => e
+  puts "Error when calling RefundRequestsApi->refund_requests_send_message_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
+
+
+## refund_requests_update_status
+
+> refund_requests_update_status(id)
+
+Update Refund Request Status (Merchant)
+
+### Examples
+
+```ruby
+require 'time'
+require 'solifyn'
+
+api_instance = Solifyn::RefundRequestsApi.new
+id = 'id_example' # String | 
+
+begin
+  # Update Refund Request Status (Merchant)
+  api_instance.refund_requests_update_status(id)
+rescue Solifyn::ApiError => e
+  puts "Error when calling RefundRequestsApi->refund_requests_update_status: #{e}"
+end
+```
+
+#### Using the refund_requests_update_status_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)> refund_requests_update_status_with_http_info(id)
+
+```ruby
+begin
+  # Update Refund Request Status (Merchant)
+  data, status_code, headers = api_instance.refund_requests_update_status_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Solifyn::ApiError => e
+  puts "Error when calling RefundRequestsApi->refund_requests_update_status_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
+
+
+## refund_requests_upload_evidence
+
+> refund_requests_upload_evidence
+
+Upload Dispute Evidence File (Merchant)
+
+### Examples
+
+```ruby
+require 'time'
+require 'solifyn'
+
+api_instance = Solifyn::RefundRequestsApi.new
+
+begin
+  # Upload Dispute Evidence File (Merchant)
+  api_instance.refund_requests_upload_evidence
+rescue Solifyn::ApiError => e
+  puts "Error when calling RefundRequestsApi->refund_requests_upload_evidence: #{e}"
+end
+```
+
+#### Using the refund_requests_upload_evidence_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)> refund_requests_upload_evidence_with_http_info
+
+```ruby
+begin
+  # Upload Dispute Evidence File (Merchant)
+  data, status_code, headers = api_instance.refund_requests_upload_evidence_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Solifyn::ApiError => e
+  puts "Error when calling RefundRequestsApi->refund_requests_upload_evidence_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/RefundsChargebacksApi.md

@@ -0,0 +1,215 @@
+# Solifyn::RefundsChargebacksApi
+
+All URIs are relative to *http://localhost:8000*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**refunds_create**](RefundsChargebacksApi.md#refunds_create) | **POST** /v1/orders/{id}/refund | Create Refund |
+| [**refunds_get**](RefundsChargebacksApi.md#refunds_get) | **GET** /v1/refunds/{id} | Retrieve Refund details |
+| [**refunds_list**](RefundsChargebacksApi.md#refunds_list) | **GET** /v1/refunds | List Refunds |
+
+
+## refunds_create
+
+> refunds_create(id, order_refund_create)
+
+Create Refund
+
+Initiate a full or partial refund for a specific payment/order.
+
+### 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::RefundsChargebacksApi.new
+id = 'pay_123' # String | The unique order/payment ID.
+order_refund_create = Solifyn::OrderRefundCreate.new({amount: 1000, is_full_refund: true, idempotency_key: 'ref_idem_98sdufhskjfsd'}) # OrderRefundCreate | 
+
+begin
+  # Create Refund
+  api_instance.refunds_create(id, order_refund_create)
+rescue Solifyn::ApiError => e
+  puts "Error when calling RefundsChargebacksApi->refunds_create: #{e}"
+end
+```
+
+#### Using the refunds_create_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)> refunds_create_with_http_info(id, order_refund_create)
+
+```ruby
+begin
+  # Create Refund
+  data, status_code, headers = api_instance.refunds_create_with_http_info(id, order_refund_create)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Solifyn::ApiError => e
+  puts "Error when calling RefundsChargebacksApi->refunds_create_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The unique order/payment ID. |  |
+| **order_refund_create** | [**OrderRefundCreate**](OrderRefundCreate.md) |  |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: Not defined
+
+
+## refunds_get
+
+> <Refund> refunds_get(id)
+
+Retrieve Refund details
+
+Get parameters of a specific processed refund by database 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::RefundsChargebacksApi.new
+id = 'ref_123' # String | Refund ID
+
+begin
+  # Retrieve Refund details
+  result = api_instance.refunds_get(id)
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling RefundsChargebacksApi->refunds_get: #{e}"
+end
+```
+
+#### Using the refunds_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Refund>, Integer, Hash)> refunds_get_with_http_info(id)
+
+```ruby
+begin
+  # Retrieve Refund details
+  data, status_code, headers = api_instance.refunds_get_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Refund>
+rescue Solifyn::ApiError => e
+  puts "Error when calling RefundsChargebacksApi->refunds_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Refund ID |  |
+
+### Return type
+
+[**Refund**](Refund.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## refunds_list
+
+> <Array<Refund>> refunds_list
+
+List Refunds
+
+Retrieve a list of processed refunds and chargeback transactions.
+
+### 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::RefundsChargebacksApi.new
+
+begin
+  # List Refunds
+  result = api_instance.refunds_list
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling RefundsChargebacksApi->refunds_list: #{e}"
+end
+```
+
+#### Using the refunds_list_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<Refund>>, Integer, Hash)> refunds_list_with_http_info
+
+```ruby
+begin
+  # List Refunds
+  data, status_code, headers = api_instance.refunds_list_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<Refund>>
+rescue Solifyn::ApiError => e
+  puts "Error when calling RefundsChargebacksApi->refunds_list_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array&lt;Refund&gt;**](Refund.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/ResolvedAddon.md

@@ -0,0 +1,24 @@
+# Solifyn::ResolvedAddon
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **product_id** | **String** | Unique product ID of the addon |  |
+| **name** | **String** | Display name of the addon |  |
+| **image_url** | **Object** | URL of the addon image |  |
+| **quantity** | **Float** | The purchased quantity of the addon |  |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::ResolvedAddon.new(
+  product_id: prod_addon_123,
+  name: Extra Seats add-on,
+  image_url: null,
+  quantity: 3
+)
+```
+

data/docs/RevokeSeatDto.md

@@ -0,0 +1,20 @@
+# Solifyn::RevokeSeatDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **product_id** | **String** | The product ID of the addon (Whop Product ID or local ID). |  |
+| **quantity** | **Integer** | The number of seats to revoke/deduct. |  |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::RevokeSeatDto.new(
+  product_id: prod_lBrPxQcGN8dBM,
+  quantity: 1
+)
+```
+

data/docs/Subscription.md

@@ -0,0 +1,68 @@
+# Solifyn::Subscription
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The unique ID of the subscription |  |
+| **status** | **String** | The status of the subscription (e.g. completed, active, trialing, past_due, canceled) |  |
+| **created_at** | **Time** | Timestamp when the subscription was created |  |
+| **joined_at** | **Time** | Timestamp when the member joined |  |
+| **updated_at** | **Time** | Timestamp when the subscription was last updated |  |
+| **manage_url** | **String** | The management URL for the billing/subscription |  |
+| **member** | [**SubscriptionMemberDto**](SubscriptionMemberDto.md) | The member details |  |
+| **user** | [**SubscriptionUserDto**](SubscriptionUserDto.md) | The user details |  |
+| **renewal_period_start** | **Object** | Start timestamp of the current renewal period |  |
+| **renewal_period_end** | **Object** | End timestamp of the current renewal period |  |
+| **cancel_at_period_end** | **Boolean** | Whether the subscription is set to cancel at the end of the billing period |  |
+| **cancel_option** | **Object** | The cancel option details |  |
+| **cancellation_reason** | **Object** | The reason for cancellation |  |
+| **canceled_at** | **Object** | Timestamp when the subscription was canceled |  |
+| **currency** | **String** | The currency used for payments |  |
+| **company** | [**SubscriptionCompanyDto**](SubscriptionCompanyDto.md) | The company context details |  |
+| **plan** | [**SubscriptionPlanDto**](SubscriptionPlanDto.md) | The plan associated with this subscription |  |
+| **promo_code** | **Object** | The promo code applied to the subscription |  |
+| **product** | [**SubscriptionProductDto**](SubscriptionProductDto.md) | The product associated with the subscription |  |
+| **license_key** | **Object** | The license key associated with this subscription |  |
+| **metadata** | **Object** | Additional metadata for the subscription |  |
+| **payment_collection_paused** | **Boolean** | Whether the payment collection is currently paused |  |
+| **checkout_configuration_id** | **String** | The checkout configuration ID used |  |
+| **price** | **Object** | The price/amount of the membership | [optional] |
+| **type** | **Object** | The type of the membership plan | [optional] |
+| **customer_id** | **Object** | The business customer ID | [optional] |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::Subscription.new(
+  id: mem_123,
+  status: active,
+  created_at: 2025-01-01T12:00:00.000Z,
+  joined_at: 2025-01-01T12:00:00.000Z,
+  updated_at: 2025-01-01T12:00:00.000Z,
+  manage_url: https://example.com/billing/manage/mber_123,
+  member: null,
+  user: null,
+  renewal_period_start: null,
+  renewal_period_end: null,
+  cancel_at_period_end: false,
+  cancel_option: null,
+  cancellation_reason: null,
+  canceled_at: null,
+  currency: usd,
+  company: null,
+  plan: null,
+  promo_code: null,
+  product: null,
+  license_key: null,
+  metadata: {is_usage_based=false},
+  payment_collection_paused: false,
+  checkout_configuration_id: ch_123,
+  price: 99,
+  type: renewal,
+  customer_id: cust_123
+)
+```
+

data/docs/SubscriptionAction.md

@@ -0,0 +1,30 @@
+# Solifyn::SubscriptionAction
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **free_days** | **Float** | Number of free days to add (used with action: add_free_days) | [optional] |
+| **cancellation_mode** | **String** | Cancellation mode (used with action: cancel) | [optional] |
+| **void_payments** | **Boolean** | Whether to void subsequent payments (used with action: pause) | [optional] |
+| **addon_product_id** | **String** | ID of the addon product to adjust seats for (used with action: adjust_seats) | [optional] |
+| **new_quantity** | **Float** | The new seat quantity (used with action: adjust_seats) | [optional] |
+| **proration_type** | **String** | Proration strategy mode (used with action: adjust_seats) | [optional] |
+| **idempotency_key** | **String** | A unique idempotency key to prevent duplicate mutative actions for network transient retries. | [optional] |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::SubscriptionAction.new(
+  free_days: 30,
+  cancellation_mode: immediate,
+  void_payments: true,
+  addon_product_id: prod_seat_123,
+  new_quantity: 5,
+  proration_type: do_not_bill,
+  idempotency_key: sub_action_idem_123
+)
+```
+

data/docs/SubscriptionCompanyDto.md

@@ -0,0 +1,20 @@
+# Solifyn::SubscriptionCompanyDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The unique ID of the company |  |
+| **title** | **String** | The title/name of the company |  |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::SubscriptionCompanyDto.new(
+  id: biz_123,
+  title: Company Name
+)
+```
+