solifyn 1.1.4 → 1.1.6

data/docs/FramerIntegrationApi.md

@@ -0,0 +1,355 @@
+# Solifyn::FramerIntegrationApi
+
+All URIs are relative to *https://api.solifyn.com*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**framer_create_template**](FramerIntegrationApi.md#framer_create_template) | **POST** /v1/framer/templates | Create Framer Template |
+| [**framer_delete_template**](FramerIntegrationApi.md#framer_delete_template) | **DELETE** /v1/framer/templates/{id} | Delete Framer Template |
+| [**framer_get_template**](FramerIntegrationApi.md#framer_get_template) | **GET** /v1/framer/templates/{id} | Retrieve Framer Template |
+| [**framer_list_templates**](FramerIntegrationApi.md#framer_list_templates) | **GET** /v1/framer/templates | List Framer Templates |
+| [**framer_update_template**](FramerIntegrationApi.md#framer_update_template) | **PUT** /v1/framer/templates/{id} | Update Framer Template |
+
+
+## framer_create_template
+
+> <FramerTemplateResponseDto> framer_create_template(create_framer_template_dto)
+
+Create Framer Template
+
+Registers a new Framer template with its public remix link for the 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::FramerIntegrationApi.new
+create_framer_template_dto = Solifyn::CreateFramerTemplateDto.new({name: 'Portfolio Template', remix_link: 'https://framer.com/projects/xyz'}) # CreateFramerTemplateDto | 
+
+begin
+  # Create Framer Template
+  result = api_instance.framer_create_template(create_framer_template_dto)
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling FramerIntegrationApi->framer_create_template: #{e}"
+end
+```
+
+#### Using the framer_create_template_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<FramerTemplateResponseDto>, Integer, Hash)> framer_create_template_with_http_info(create_framer_template_dto)
+
+```ruby
+begin
+  # Create Framer Template
+  data, status_code, headers = api_instance.framer_create_template_with_http_info(create_framer_template_dto)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FramerTemplateResponseDto>
+rescue Solifyn::ApiError => e
+  puts "Error when calling FramerIntegrationApi->framer_create_template_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_framer_template_dto** | [**CreateFramerTemplateDto**](CreateFramerTemplateDto.md) |  |  |
+
+### Return type
+
+[**FramerTemplateResponseDto**](FramerTemplateResponseDto.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## framer_delete_template
+
+> framer_delete_template(id)
+
+Delete Framer Template
+
+Deletes a registered Framer template for the 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::FramerIntegrationApi.new
+id = 'id_example' # String | The Framer template ID
+
+begin
+  # Delete Framer Template
+  api_instance.framer_delete_template(id)
+rescue Solifyn::ApiError => e
+  puts "Error when calling FramerIntegrationApi->framer_delete_template: #{e}"
+end
+```
+
+#### Using the framer_delete_template_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)> framer_delete_template_with_http_info(id)
+
+```ruby
+begin
+  # Delete Framer Template
+  data, status_code, headers = api_instance.framer_delete_template_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => nil
+rescue Solifyn::ApiError => e
+  puts "Error when calling FramerIntegrationApi->framer_delete_template_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The Framer template ID |  |
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: Not defined
+
+
+## framer_get_template
+
+> <FramerTemplateResponseDto> framer_get_template(id)
+
+Retrieve Framer Template
+
+Retrieves details of a specific registered Framer template.
+
+### 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::FramerIntegrationApi.new
+id = 'id_example' # String | The Framer template ID
+
+begin
+  # Retrieve Framer Template
+  result = api_instance.framer_get_template(id)
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling FramerIntegrationApi->framer_get_template: #{e}"
+end
+```
+
+#### Using the framer_get_template_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<FramerTemplateResponseDto>, Integer, Hash)> framer_get_template_with_http_info(id)
+
+```ruby
+begin
+  # Retrieve Framer Template
+  data, status_code, headers = api_instance.framer_get_template_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FramerTemplateResponseDto>
+rescue Solifyn::ApiError => e
+  puts "Error when calling FramerIntegrationApi->framer_get_template_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The Framer template ID |  |
+
+### Return type
+
+[**FramerTemplateResponseDto**](FramerTemplateResponseDto.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## framer_list_templates
+
+> <Array<FramerTemplateResponseDto>> framer_list_templates
+
+List Framer Templates
+
+Retrieves all registered Framer templates for the 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::FramerIntegrationApi.new
+
+begin
+  # List Framer Templates
+  result = api_instance.framer_list_templates
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling FramerIntegrationApi->framer_list_templates: #{e}"
+end
+```
+
+#### Using the framer_list_templates_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Array<FramerTemplateResponseDto>>, Integer, Hash)> framer_list_templates_with_http_info
+
+```ruby
+begin
+  # List Framer Templates
+  data, status_code, headers = api_instance.framer_list_templates_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Array<FramerTemplateResponseDto>>
+rescue Solifyn::ApiError => e
+  puts "Error when calling FramerIntegrationApi->framer_list_templates_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array&lt;FramerTemplateResponseDto&gt;**](FramerTemplateResponseDto.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## framer_update_template
+
+> <FramerTemplateResponseDto> framer_update_template(id, update_framer_template_dto)
+
+Update Framer Template
+
+Updates a registered Framer template for the 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::FramerIntegrationApi.new
+id = 'id_example' # String | The Framer template ID
+update_framer_template_dto = Solifyn::UpdateFramerTemplateDto.new # UpdateFramerTemplateDto | 
+
+begin
+  # Update Framer Template
+  result = api_instance.framer_update_template(id, update_framer_template_dto)
+  p result
+rescue Solifyn::ApiError => e
+  puts "Error when calling FramerIntegrationApi->framer_update_template: #{e}"
+end
+```
+
+#### Using the framer_update_template_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<FramerTemplateResponseDto>, Integer, Hash)> framer_update_template_with_http_info(id, update_framer_template_dto)
+
+```ruby
+begin
+  # Update Framer Template
+  data, status_code, headers = api_instance.framer_update_template_with_http_info(id, update_framer_template_dto)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <FramerTemplateResponseDto>
+rescue Solifyn::ApiError => e
+  puts "Error when calling FramerIntegrationApi->framer_update_template_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The Framer template ID |  |
+| **update_framer_template_dto** | [**UpdateFramerTemplateDto**](UpdateFramerTemplateDto.md) |  |  |
+
+### Return type
+
+[**FramerTemplateResponseDto**](FramerTemplateResponseDto.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/FramerTemplateResponseDto.md

@@ -0,0 +1,30 @@
+# Solifyn::FramerTemplateResponseDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The unique Framer template ID. |  |
+| **business_id** | **String** | The business ID owning the template. |  |
+| **name** | **String** | The name of the Framer template. |  |
+| **remix_link** | **String** | The public Framer remix link. |  |
+| **description** | **String** | A brief description of the template. | [optional] |
+| **created_at** | **String** | Creation timestamp. |  |
+| **updated_at** | **String** | Modification timestamp. |  |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::FramerTemplateResponseDto.new(
+  id: tmpl_123456,
+  business_id: biz_123456,
+  name: Portfolio Template,
+  remix_link: https://framer.com/projects/xyz,
+  description: Premium dark-mode portfolio.,
+  created_at: null,
+  updated_at: null
+)
+```
+

data/docs/LinkedProductDto.md

@@ -0,0 +1,20 @@
+# Solifyn::LinkedProductDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The unique product ID |  |
+| **name** | **String** | The product name |  |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::LinkedProductDto.new(
+  id: prod_12345,
+  name: Premium Developer Plan
+)
+```
+

data/docs/ProductCreate.md

@@ -19,6 +19,8 @@
 | **has_discord_access** | **Boolean** | Whether the purchase includes Discord server role access. | [optional][default to false] |
 | **discord_guild_id** | **String** | Discord Guild (Server) ID to grant access to. | [optional] |
 | **discord_role_id** | **String** | Discord Role ID to assign to the user. | [optional] |
+| **has_framer_access** | **Boolean** | Whether the purchase includes Framer Template access. | [optional][default to false] |
+| **framer_template_id** | **String** | Framer Template ID to grant access to. | [optional] |
 | **is_tax_inclusive** | **Boolean** | Whether tax is included in the base price. | [optional][default to false] |
 | **activation_limit** | **Integer** | Maximum concurrent activated instances allowed per license key. | [optional] |
 | **brand_id** | **String** | Brand id for the product, if not provided will default to primary brand. | [optional] |
@@ -33,6 +35,7 @@
 | **is_listed** | **Boolean** | Whether the product is publicly visible. | [optional][default to true] |
 | **is_free** | **Boolean** | Whether the product is free of charge. | [optional][default to false] |
 | **addons** | [**Array<ProductCreateAddonsInner>**](ProductCreateAddonsInner.md) | Product addons configurations. | [optional] |
+| **entitlement_ids** | **Array<String>** | Array of independent entitlement IDs to link to this product. | [optional] |
 
 ## Example
 
@@ -55,6 +58,8 @@ instance = Solifyn::ProductCreate.new(
   has_discord_access: false,
   discord_guild_id: 123456789012345678,
   discord_role_id: 876543210987654321,
+  has_framer_access: false,
+  framer_template_id: fmt_8Z1aB2cD3eF4gH5iJ6kL7m,
   is_tax_inclusive: false,
   activation_limit: null,
   brand_id: brd_4e29285b8sdf34ff51e07d4,
@@ -68,7 +73,8 @@ instance = Solifyn::ProductCreate.new(
   stock: 100,
   is_listed: true,
   is_free: false,
-  addons: null
+  addons: null,
+  entitlement_ids: null
 )
 ```
 

data/docs/ProductUpdate.md

@@ -19,6 +19,8 @@
 | **has_discord_access** | **Boolean** | Whether the purchase includes Discord server role access. | [optional][default to false] |
 | **discord_guild_id** | **String** | Discord Guild (Server) ID to grant access to. | [optional] |
 | **discord_role_id** | **String** | Discord Role ID to assign to the user. | [optional] |
+| **has_framer_access** | **Boolean** | Whether the purchase includes Framer Template access. | [optional][default to false] |
+| **framer_template_id** | **String** | Framer Template ID to grant access to. | [optional] |
 | **is_tax_inclusive** | **Boolean** | Whether tax is included in the base price. | [optional][default to false] |
 | **activation_limit** | **Integer** | Maximum concurrent activated instances allowed per license key. | [optional] |
 | **brand_id** | **String** | Brand id for the product, if not provided will default to primary brand. | [optional] |
@@ -33,6 +35,7 @@
 | **is_listed** | **Boolean** | Whether the product is publicly visible. | [optional][default to true] |
 | **is_free** | **Boolean** | Whether the product is free of charge. | [optional][default to false] |
 | **addons** | [**Array<ProductCreateAddonsInner>**](ProductCreateAddonsInner.md) | Product addons configurations. | [optional] |
+| **entitlement_ids** | **Array<String>** | Array of independent entitlement IDs to link to this product. | [optional] |
 
 ## Example
 
@@ -55,6 +58,8 @@ instance = Solifyn::ProductUpdate.new(
   has_discord_access: false,
   discord_guild_id: 123456789012345678,
   discord_role_id: 876543210987654321,
+  has_framer_access: false,
+  framer_template_id: fmt_8Z1aB2cD3eF4gH5iJ6kL7m,
   is_tax_inclusive: false,
   activation_limit: null,
   brand_id: brd_4e29285b8sdf34ff51e07d4,
@@ -68,7 +73,8 @@ instance = Solifyn::ProductUpdate.new(
   stock: 100,
   is_listed: true,
   is_free: false,
-  addons: null
+  addons: null,
+  entitlement_ids: null
 )
 ```
 

data/docs/UpdateEntitlementDto.md

@@ -0,0 +1,42 @@
+# Solifyn::UpdateEntitlementDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The user-friendly name of the entitlement | [optional] |
+| **type** | **String** | The type of access to grant | [optional] |
+| **github_repo** | **String** | The GitHub repository (e.g., owner/repo) | [optional] |
+| **github_permission** | **String** | The GitHub repository permission level | [optional][default to 'pull'] |
+| **discord_guild_id** | **String** | The Discord Guild/Server ID | [optional] |
+| **discord_role_id** | **String** | The Discord Role ID to assign | [optional] |
+| **framer_template_id** | **String** | The associated Framer Template ID | [optional] |
+| **license_key** | **String** | The static License Key (if not dynamically generated) | [optional] |
+| **activation_limit** | **Float** | The maximum activation limit for licenses | [optional] |
+| **activation_message** | **String** | A message shown to the user upon license activation | [optional] |
+| **expiry_hours** | **Float** | The number of hours until the entitlement expires | [optional] |
+| **digital_link** | **String** | The digital download URL or redirect link | [optional] |
+| **instructions** | **String** | Custom setup instructions for the user | [optional] |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::UpdateEntitlementDto.new(
+  name: Premium GitHub Access,
+  type: GITHUB,
+  github_repo: solifyn/premium-repo,
+  github_permission: pull,
+  discord_guild_id: 123456789012345678,
+  discord_role_id: 876543210987654321,
+  framer_template_id: framer_tmpl_123,
+  license_key: whsec_license_key_123,
+  activation_limit: 3,
+  activation_message: Thank you for activating your software license!,
+  expiry_hours: 720,
+  digital_link: https://downloads.solifyn.com/file.zip,
+  instructions: Clone the repository and run npm install.
+)
+```
+

data/docs/UpdateFramerTemplateDto.md

@@ -0,0 +1,22 @@
+# Solifyn::UpdateFramerTemplateDto
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the Framer template. | [optional] |
+| **remix_link** | **String** | The public Framer remix link. | [optional] |
+| **description** | **String** | A brief description of the template. | [optional] |
+
+## Example
+
+```ruby
+require 'solifyn'
+
+instance = Solifyn::UpdateFramerTemplateDto.new(
+  name: Portfolio Template,
+  remix_link: https://framer.com/projects/xyz,
+  description: Premium dark-mode portfolio.
+)
+```
+

data/lib/solifyn/api/entitlement_grants_api.rb

@@ -86,6 +86,8 @@ module Solifyn
     # Retrieve all GitHub repository entitlement grants for the active business.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :status Filter by status (PENDING, DELIVERED, FAILED, REVOKED)
+    # @option opts [String] :entitlement_id Filter by entitlement config ID
+    # @option opts [String] :product_id Filter by product ID
     # @return [Array<EntitlementGrantResponseDto>]
     def entitlement_grants_list(opts = {})
       data, _status_code, _headers = entitlement_grants_list_with_http_info(opts)
@@ -96,6 +98,8 @@ module Solifyn
     # Retrieve all GitHub repository entitlement grants for the active business.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :status Filter by status (PENDING, DELIVERED, FAILED, REVOKED)
+    # @option opts [String] :entitlement_id Filter by entitlement config ID
+    # @option opts [String] :product_id Filter by product ID
     # @return [Array<(Array<EntitlementGrantResponseDto>, Integer, Hash)>] Array<EntitlementGrantResponseDto> data, response status code and response headers
     def entitlement_grants_list_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -107,6 +111,8 @@ module Solifyn
       # query parameters
       query_params = opts[:query_params] || {}
       query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
+      query_params[:'entitlementId'] = opts[:'entitlement_id'] if !opts[:'entitlement_id'].nil?
+      query_params[:'productId'] = opts[:'product_id'] if !opts[:'product_id'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}