solifyn

Solifyn - the Ruby gem for the Solifyn API

Welcome to the Solifyn API Reference. Leverage our secure endpoints to manage products and issue, validate, and manage software license keys programmatically.

This SDK is automatically generated by the OpenAPI Generator project:

API version: 1.0.0
Package version: 1.0.0
Generator version: 7.10.0
Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build solifyn.gemspec

Then either install the gem locally:

gem install ./solifyn-1.0.0.gem

(for development, run gem install --dev ./solifyn-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'solifyn', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'solifyn', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'solifyn'

api_instance = Solifyn::BalanceApi.new

begin
  api_instance.balance_controller_find_all
rescue Solifyn::ApiError => e
  puts "Exception when calling BalanceApi->balance_controller_find_all: #{e}"
end

Documentation for API Endpoints

All URIs are relative to http://localhost:8000

Class	Method	HTTP request	Description
Solifyn::BalanceApi	balance_controller_find_all	GET /v1/balances
Solifyn::BalanceApi	balance_controller_generate_report	GET /v1/balances/report
Solifyn::BalanceApi	balance_controller_get_summary	GET /v1/balances/summary
Solifyn::CheckoutApi	checkout_create	POST /v1/checkout/create	Create Checkout Session
Solifyn::CheckoutApi	checkout_create_collection	POST /v1/checkout/collection/create	Create Collection Checkout Session
Solifyn::CheckoutApi	checkout_create_setup	POST /v1/checkout/setup-configuration	Create Setup Checkout Configuration
Solifyn::CheckoutApi	checkout_get_session	GET /v1/checkout/session/id	Get Checkout Session Details
Solifyn::CheckoutApi	checkout_price_preview	GET /v1/checkout/price-preview	Get Converted Price Preview
Solifyn::CheckoutApi	checkout_supported_currencies	GET /v1/checkout/supported-currencies	Get Supported Currencies
Solifyn::CheckoutLinksApi	checkout_links_create	POST /v1/checkout-links	Create Checkout Link
Solifyn::CheckoutLinksApi	checkout_links_delete	DELETE /v1/checkout-links/id	Delete Checkout Link
Solifyn::CheckoutLinksApi	checkout_links_get	GET /v1/checkout-links/id	Retrieve Checkout Link Details
Solifyn::CheckoutLinksApi	checkout_links_list	GET /v1/checkout-links	List Checkout Links
Solifyn::CheckoutLinksApi	checkout_links_update	PATCH /v1/checkout-links/id	Update Checkout Link
Solifyn::CollectionsApi	collections_add_products	POST /v1/collections/id/products	Add Products to Collection
Solifyn::CollectionsApi	collections_archive	DELETE /v1/collections/id	Archive Collection
Solifyn::CollectionsApi	collections_create	POST /v1/collections	Create Collection
Solifyn::CollectionsApi	collections_delete_product	DELETE /v1/collections/id/products/productId	Remove Product from Collection
Solifyn::CollectionsApi	collections_get	GET /v1/collections/id	Retrieve Collection
Solifyn::CollectionsApi	collections_list	GET /v1/collections	List Collections
Solifyn::CollectionsApi	collections_list_archived	GET /v1/collections/archived	List Archived Collections
Solifyn::CollectionsApi	collections_unarchive	POST /v1/collections/id/unarchive	Unarchive Collection
Solifyn::CollectionsApi	collections_update	PATCH /v1/collections/id	Update Collection
Solifyn::CollectionsApi	collections_update_product	PATCH /v1/collections/id/products/productId	Update Collection Product
Solifyn::CustomersApi	customers_create	POST /v1/customers	Create Customer
Solifyn::CustomersApi	customers_generate_invite	POST /v1/customers/id/share	Generate Shared Invite
Solifyn::CustomersApi	customers_get	GET /v1/customers/id	Retrieve Customer
Solifyn::CustomersApi	customers_list	GET /v1/customers	List Customers
Solifyn::CustomersApi	customers_update	PATCH /v1/customers/id	Update Customer
Solifyn::DeveloperApi	developer_create_api_key	POST /v1/developer/api-keys	Create Developer API Key
Solifyn::DeveloperApi	developer_create_webhook	POST /v1/developer/webhooks	Create Webhook Endpoint
Solifyn::DeveloperApi	developer_delete_webhook	DELETE /v1/developer/webhooks/id	Delete Webhook Endpoint
Solifyn::DeveloperApi	developer_get_app_portal	GET /v1/developer/webhooks/app-portal	Retrieve Hosted Webhooks Portal URL
Solifyn::DeveloperApi	developer_get_webhook	GET /v1/developer/webhooks/id	Retrieve Webhook Endpoint Details
Solifyn::DeveloperApi	developer_list_api_keys	GET /v1/developer/api-keys	List Developer API Keys
Solifyn::DeveloperApi	developer_list_webhook_deliveries	GET /v1/developer/webhooks/id/deliveries	Retrieve Webhook Delivery Logs
Solifyn::DeveloperApi	developer_list_webhooks	GET /v1/developer/webhooks	List Webhook Endpoints
Solifyn::DeveloperApi	developer_revoke_api_key	DELETE /v1/developer/api-keys/id	Revoke API Key
Solifyn::DeveloperApi	developer_update_webhook	PATCH /v1/developer/webhooks/id	Update Webhook Endpoint
Solifyn::DigitalFileApi	digital_file_controller_create	POST /v1/digital-files
Solifyn::DigitalFileApi	digital_file_controller_find_all	GET /v1/digital-files
Solifyn::DigitalFileApi	digital_file_controller_remove	DELETE /v1/digital-files/id
Solifyn::DiscountsApi	discounts_create	POST /v1/discounts	Create Discount
Solifyn::DiscountsApi	discounts_delete	DELETE /v1/discounts/id	Delete Discount
Solifyn::DiscountsApi	discounts_get	GET /v1/discounts/id	Retrieve Discount
Solifyn::DiscountsApi	discounts_list	GET /v1/discounts	List Discounts
Solifyn::DiscountsApi	discounts_update	PATCH /v1/discounts/id	Update Discount
Solifyn::DiscountsApi	discounts_validate	GET /v1/discounts/validate	Validate Code
Solifyn::DisputesApi	disputes_generate_report	GET /v1/transactions/disputes/report	Generate Dispute CSV Report
Solifyn::DisputesApi	disputes_get	GET /v1/transactions/disputes/id	Retrieve Dispute
Solifyn::DisputesApi	disputes_list	GET /v1/transactions/disputes	List Disputes
Solifyn::DisputesApi	disputes_submit_evidence	POST /v1/transactions/disputes/id/submit	Submit Dispute Evidence
Solifyn::DisputesApi	disputes_update_evidence	PATCH /v1/transactions/disputes/id/evidence	Update Dispute Evidence
Solifyn::DisputesApi	disputes_upload_evidence_file	POST /v1/transactions/disputes/upload	Upload Evidence File
Solifyn::LicenseApi	licenses_create	POST /v1/licenses	Create License Key
Solifyn::LicenseApi	licenses_delete_instance	DELETE /v1/licenses/instances/instanceId	Force Delete Instance
Solifyn::LicenseApi	licenses_get	GET /v1/licenses/id	Get License Key
Solifyn::LicenseApi	licenses_get_instance	GET /v1/licenses/id/instances/instanceId	Get License Key Instance
Solifyn::LicenseApi	licenses_get_instances	GET /v1/licenses/id/instances	Get License Key Instances
Solifyn::LicenseApi	licenses_list	GET /v1/licenses	List License Keys
Solifyn::LicenseApi	licenses_toggle	POST /v1/licenses/id/toggle	Toggle License Status
Solifyn::LicenseApi	licenses_update	PATCH /v1/licenses/id	Update License Key
Solifyn::LicenseApi	licenses_update_instance	PATCH /v1/licenses/id/instances/instanceId	Update License Key Instance
Solifyn::LicenseApi	licenses_update_instance_post	POST /v1/licenses/id/instances/instanceId	Update License Key Instance (POST)
Solifyn::LicenseKeysApi	licenses_create	POST /v1/licenses	Create License Key
Solifyn::LicenseKeysApi	licenses_delete_instance	DELETE /v1/licenses/instances/instanceId	Force Delete Instance
Solifyn::LicenseKeysApi	licenses_get	GET /v1/licenses/id	Get License Key
Solifyn::LicenseKeysApi	licenses_get_instance	GET /v1/licenses/id/instances/instanceId	Get License Key Instance
Solifyn::LicenseKeysApi	licenses_get_instances	GET /v1/licenses/id/instances	Get License Key Instances
Solifyn::LicenseKeysApi	licenses_list	GET /v1/licenses	List License Keys
Solifyn::LicenseKeysApi	licenses_toggle	POST /v1/licenses/id/toggle	Toggle License Status
Solifyn::LicenseKeysApi	licenses_update	PATCH /v1/licenses/id	Update License Key
Solifyn::LicenseKeysApi	licenses_update_instance	PATCH /v1/licenses/id/instances/instanceId	Update License Key Instance
Solifyn::LicenseKeysApi	licenses_update_instance_post	POST /v1/licenses/id/instances/instanceId	Update License Key Instance (POST)
Solifyn::LicenseKeysClientApi	licenses_activate	POST /v1/licenses/activate	Activate License Key
Solifyn::LicenseKeysClientApi	licenses_deactivate	POST /v1/licenses/deactivate/instanceId	Deactivate Instance
Solifyn::LicenseKeysClientApi	licenses_instances	GET /v1/licenses/instances/licenseId	Get Active Instances
Solifyn::LicenseKeysClientApi	licenses_verify	POST /v1/licenses/verify	Validate License Key
Solifyn::MetersApi	events_ingest	POST /v1/meters/ingest	Ingest Events
Solifyn::MetersApi	meters_create	POST /v1/meters	Create Meter
Solifyn::MetersApi	meters_get	GET /v1/meters/id	Retrieve Meter
Solifyn::MetersApi	meters_get_events	GET /v1/meters/id/events	List Meter Events
Solifyn::MetersApi	meters_get_quantities	GET /v1/meters/id/quantities	Get Meter Quantities
Solifyn::MetersApi	meters_list	GET /v1/meters	List Meters
Solifyn::MetersApi	meters_update	PATCH /v1/meters/id	Update Meter
Solifyn::OrdersApi	orders_get	GET /v1/orders/id	Retrieve Order
Solifyn::OrdersApi	orders_get_invoice	GET /v1/orders/id/invoice	Get Order Invoice
Solifyn::OrdersApi	orders_list	GET /v1/orders	List Orders
Solifyn::OrdersApi	orders_update	PATCH /v1/orders/id	Update Order Billing Address
Solifyn::OrdersApi	refunds_create	POST /v1/orders/id/refund	Create Refund
Solifyn::ProductAddOnsApi	products_create_addon	POST /v1/products/id/addons	Create Product Add-on
Solifyn::ProductAddOnsApi	products_delete_addon	DELETE /v1/products/id/addons/addonId	Delete Product Add-on
Solifyn::ProductAddOnsApi	products_get_addon	GET /v1/products/id/addons/addonId	Retrieve Product Add-on
Solifyn::ProductAddOnsApi	products_list_addons	GET /v1/products/id/addons	List Product Add-ons
Solifyn::ProductAddOnsApi	products_list_all_addons	GET /v1/products/all-addons/list	List All Add-ons
Solifyn::ProductAddOnsApi	products_update_addon	PATCH /v1/products/id/addons/addonId	Update Product Add-on
Solifyn::ProductsApi	products_archive	DELETE /v1/products/id	Archive Product
Solifyn::ProductsApi	products_create	POST /v1/products	Create Product
Solifyn::ProductsApi	products_get	GET /v1/products/id	Retrieve Product
Solifyn::ProductsApi	products_list	GET /v1/products	List Products
Solifyn::ProductsApi	products_unarchive	POST /v1/products/id/unarchive	Unarchive Product
Solifyn::ProductsApi	products_update	PATCH /v1/products/id	Update Product
Solifyn::RefundRequestsApi	refund_requests_list	GET /v1/refund-requests	List Refund Requests (Merchant)
Solifyn::RefundRequestsApi	refund_requests_list_messages	GET /v1/refund-requests/id/messages	List Messages for Refund Request (Merchant)
Solifyn::RefundRequestsApi	refund_requests_send_message	POST /v1/refund-requests/id/messages	Send Refund Request Message (Merchant)
Solifyn::RefundRequestsApi	refund_requests_update_status	PATCH /v1/refund-requests/id/status	Update Refund Request Status (Merchant)
Solifyn::RefundRequestsApi	refund_requests_upload_evidence	POST /v1/refund-requests/upload-evidence	Upload Dispute Evidence File (Merchant)
Solifyn::RefundsChargebacksApi	refunds_create	POST /v1/orders/id/refund	Create Refund
Solifyn::RefundsChargebacksApi	refunds_get	GET /v1/refunds/id	Retrieve Refund details
Solifyn::RefundsChargebacksApi	refunds_list	GET /v1/refunds	List Refunds
Solifyn::SubscriptionsApi	subscriptions_action	POST /v1/subscriptions/subscriptionId/action	Subscription Action
Solifyn::SubscriptionsApi	subscriptions_get	GET /v1/subscriptions/id	Retrieve Subscription Details
Solifyn::SubscriptionsApi	subscriptions_list	GET /v1/subscriptions	List Subscriptions
Solifyn::WebhookApi	webhook_controller_handle_svix_webhook	POST /v1/webhook/svix
Solifyn::WebhookApi	webhook_controller_handle_webhook	POST /v1/webhook
Solifyn::WebhookEndpointApi	operational_webhook_controller_create	POST /v1/operational-webhook/endpoint	Create Operational Webhook Endpoint
Solifyn::WebhookEndpointApi	operational_webhook_controller_delete	DELETE /v1/operational-webhook/endpoint/id	Delete Operational Webhook Endpoint
Solifyn::WebhookEndpointApi	operational_webhook_controller_get	GET /v1/operational-webhook/endpoint/id	Get Operational Webhook Endpoint
Solifyn::WebhookEndpointApi	operational_webhook_controller_get_headers	GET /v1/operational-webhook/endpoint/id/headers	Get Operational Webhook Endpoint Headers
Solifyn::WebhookEndpointApi	operational_webhook_controller_get_secret	GET /v1/operational-webhook/endpoint/id/secret	Get Operational Webhook Endpoint Secret
Solifyn::WebhookEndpointApi	operational_webhook_controller_list	GET /v1/operational-webhook/endpoint	List Operational Webhook Endpoints
Solifyn::WebhookEndpointApi	operational_webhook_controller_rotate_secret	POST /v1/operational-webhook/endpoint/id/secret/rotate	Rotate Operational Webhook Endpoint Secret
Solifyn::WebhookEndpointApi	operational_webhook_controller_update	PUT /v1/operational-webhook/endpoint/id	Update Operational Webhook Endpoint
Solifyn::WebhookEndpointApi	operational_webhook_controller_update_headers	PUT /v1/operational-webhook/endpoint/id/headers	Set Operational Webhook Endpoint Headers