api-sdk-rb 1.11.66

data/docs/DeleteCompositionDataSourceResponseData.md

@@ -0,0 +1,18 @@
+# ApiSdkRb::DeleteCompositionDataSourceResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **removed** | **Boolean** | True whenever the call succeeded, also when there was no binding to remove |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::DeleteCompositionDataSourceResponseData.new(
+  removed: true
+)
+```
+

data/docs/DeleteManagedUser200Response.md

@@ -0,0 +1,22 @@
+# ApiSdkRb::DeleteManagedUser200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Boolean** |  |  |
+| **data** | [**ManagedUserRemoval**](ManagedUserRemoval.md) |  |  |
+| **meta** | [**ResponseMeta**](ResponseMeta.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::DeleteManagedUser200Response.new(
+  success: null,
+  data: null,
+  meta: null
+)
+```
+

data/docs/DeletePersonalWorkspaceDomainResponse.md

@@ -0,0 +1,22 @@
+# ApiSdkRb::DeletePersonalWorkspaceDomainResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Boolean** | Always `true` on a success. |  |
+| **data** | [**DeletePersonalWorkspaceDomainResponseData**](DeletePersonalWorkspaceDomainResponseData.md) |  |  |
+| **meta** | [**ResponseMeta**](ResponseMeta.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::DeletePersonalWorkspaceDomainResponse.new(
+  success: true,
+  data: null,
+  meta: null
+)
+```
+

data/docs/DeletePersonalWorkspaceDomainResponseData.md

@@ -0,0 +1,18 @@
+# ApiSdkRb::DeletePersonalWorkspaceDomainResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::DeletePersonalWorkspaceDomainResponseData.new(
+  message: Domain deleted successfully
+)
+```
+

data/docs/DeleteUserApiKeyResponse.md

@@ -0,0 +1,22 @@
+# ApiSdkRb::DeleteUserApiKeyResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Boolean** | Always `true` on a success. |  |
+| **data** | [**DeleteUserApiKeyResponseData**](DeleteUserApiKeyResponseData.md) |  |  |
+| **meta** | [**ResponseMeta**](ResponseMeta.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::DeleteUserApiKeyResponse.new(
+  success: true,
+  data: null,
+  meta: null
+)
+```
+

data/docs/DeleteUserApiKeyResponseData.md

@@ -0,0 +1,18 @@
+# ApiSdkRb::DeleteUserApiKeyResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **message** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::DeleteUserApiKeyResponseData.new(
+  message: API key deleted successfully
+)
+```
+

data/docs/DesignDefaults.md

@@ -0,0 +1,18 @@
+# ApiSdkRb::DesignDefaults
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **design** | **Hash<String, Object>** | The stored design document, or null when none is set. |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::DesignDefaults.new(
+  design: null
+)
+```
+

data/docs/DuplicateComposition202Response.md

@@ -0,0 +1,22 @@
+# ApiSdkRb::DuplicateComposition202Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Boolean** |  |  |
+| **data** | [**DuplicateComposition202ResponseData**](DuplicateComposition202ResponseData.md) |  |  |
+| **meta** | [**ResponseMeta**](ResponseMeta.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::DuplicateComposition202Response.new(
+  success: true,
+  data: null,
+  meta: null
+)
+```
+

data/docs/DuplicateComposition202ResponseData.md

@@ -0,0 +1,18 @@
+# ApiSdkRb::DuplicateComposition202ResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **operation_id** | **String** | ID of the operation tracking the duplication process | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::DuplicateComposition202ResponseData.new(
+  operation_id: 123e4567-e89b-12d3-a456-426614174000
+)
+```
+

data/docs/DuplicateCompositionRequest.md

@@ -0,0 +1,20 @@
+# ApiSdkRb::DuplicateCompositionRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Optional new name for the duplicate (defaults to \"Copy of [original name]\") | [optional] |
+| **include_database** | **Boolean** | Whether the duplicate gets the tables the original declares (`databaseSchema`), empty and in a schema of their own (default false). What visitors left in the original is never copied, and the duplicate never shares the original's data.  | [optional][default to false] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::DuplicateCompositionRequest.new(
+  name: My Duplicated Composition,
+  include_database: null
+)
+```
+

data/docs/EditorSession.md

@@ -0,0 +1,34 @@
+# ApiSdkRb::EditorSession
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **token** | **String** | The credential the browser sends as `Authorization: Bearer <token>`. It starts with `wgt_ses_`. It works only for the calls of the session's surfaces, only for this managed user's content, and only until `expiresAt`.  |  |
+| **session_id** | **String** | Identifies the session, so you can end it (`revokeManagedUserEditorSession`). It is not a credential. |  |
+| **managed_user_id** | **String** |  |  |
+| **managed_user_external_id** | **String** | Your own identifier for the managed user |  |
+| **surfaces** | **Array<String>** |  |  |
+| **allowed_origin** | **String** | The web page origin the session is bound to, or null when it is not bound | [optional] |
+| **max_credits** | **Integer** | The most credits the session may spend on Widgetic's AI (`max_credits`), or null when it has no limit of its own | [optional] |
+| **expires_at** | **Time** |  |  |
+| **created_at** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::EditorSession.new(
+  token: wgt_ses_3q2-7wA9vJm5cH1xT0uY8pZkR4nLd6BfGeSoVi2tMqE,
+  session_id: null,
+  managed_user_id: null,
+  managed_user_external_id: null,
+  surfaces: null,
+  allowed_origin: null,
+  max_credits: null,
+  expires_at: null,
+  created_at: null
+)
+```
+

data/docs/EditorSessionResponse.md

@@ -0,0 +1,22 @@
+# ApiSdkRb::EditorSessionResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Boolean** | Always `true` on a success. |  |
+| **data** | [**EditorSession**](EditorSession.md) |  |  |
+| **meta** | [**ResponseMeta**](ResponseMeta.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::EditorSessionResponse.new(
+  success: true,
+  data: null,
+  meta: null
+)
+```
+

data/docs/Entitlement.md

@@ -0,0 +1,38 @@
+# ApiSdkRb::Entitlement
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique identifier for the entitlement | [optional] |
+| **user_id** | **String** | ID of the user (if user-level entitlement) | [optional] |
+| **partner_id** | **String** | ID of the partner (if partner-level entitlement) | [optional] |
+| **managed_user_id** | **String** | ID of the managed user (if managed user-level entitlement) | [optional] |
+| **feature** | **String** | Feature identifier that this entitlement grants access to | [optional] |
+| **value** | **String** | Value or limit for this feature | [optional] |
+| **expires_at** | **Time** | When this entitlement expires (null for permanent) | [optional] |
+| **source** | **String** | Source of the entitlement | [optional] |
+| **source_id** | **String** | ID of the source object that granted this entitlement | [optional] |
+| **created_at** | **Time** | When the entitlement was created | [optional] |
+| **updated_at** | **Time** | When the entitlement was last updated | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::Entitlement.new(
+  id: 123e4567-e89b-12d3-a456-426614174000,
+  user_id: 123e4567-e89b-12d3-a456-426614174001,
+  partner_id: 123e4567-e89b-12d3-a456-426614174002,
+  managed_user_id: 123e4567-e89b-12d3-a456-426614174003,
+  feature: plan.solo,
+  value: 100,
+  expires_at: 2024-01-01T00:00Z,
+  source: subscription,
+  source_id: 123e4567-e89b-12d3-a456-426614174004,
+  created_at: 2023-01-01T00:00Z,
+  updated_at: 2023-01-02T00:00Z
+)
+```
+

data/docs/EntitlementsApi.md

@@ -0,0 +1,163 @@
+# ApiSdkRb::EntitlementsApi
+
+All URIs are relative to *https://api.widgetic.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_managed_user_entitlements_0**](EntitlementsApi.md#get_managed_user_entitlements_0) | **GET** /entitlements/managed-users/{managedUserId} | Get managed user entitlements |
+| [**get_partner_entitlements_0**](EntitlementsApi.md#get_partner_entitlements_0) | **GET** /entitlements/partners/{partnerId} | Get partner entitlements |
+
+
+## get_managed_user_entitlements_0
+
+> <GetManagedUserEntitlementsResponse> get_managed_user_entitlements_0(managed_user_id, opts)
+
+Get managed user entitlements
+
+Retrieves all entitlements for a managed user (admin or partner access).
+
+### Examples
+
+```ruby
+require 'time'
+require 'api-sdk-rb'
+# setup authorization
+ApiSdkRb.configure do |config|
+  # Configure Bearer authorization (JWT): apiKeyAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = ApiSdkRb::EntitlementsApi.new
+managed_user_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Managed user ID
+opts = {
+  include_expired: true, # Boolean | Include expired entitlements in results
+  feature: 'feature_example', # String | Filter by specific feature
+  source: 'source_example' # String | Filter by entitlement source
+}
+
+begin
+  # Get managed user entitlements
+  result = api_instance.get_managed_user_entitlements_0(managed_user_id, opts)
+  p result
+rescue ApiSdkRb::ApiError => e
+  puts "Error when calling EntitlementsApi->get_managed_user_entitlements_0: #{e}"
+end
+```
+
+#### Using the get_managed_user_entitlements_0_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetManagedUserEntitlementsResponse>, Integer, Hash)> get_managed_user_entitlements_0_with_http_info(managed_user_id, opts)
+
+```ruby
+begin
+  # Get managed user entitlements
+  data, status_code, headers = api_instance.get_managed_user_entitlements_0_with_http_info(managed_user_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetManagedUserEntitlementsResponse>
+rescue ApiSdkRb::ApiError => e
+  puts "Error when calling EntitlementsApi->get_managed_user_entitlements_0_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **managed_user_id** | **String** | Managed user ID |  |
+| **include_expired** | **Boolean** | Include expired entitlements in results | [optional] |
+| **feature** | **String** | Filter by specific feature | [optional] |
+| **source** | **String** | Filter by entitlement source | [optional] |
+
+### Return type
+
+[**GetManagedUserEntitlementsResponse**](GetManagedUserEntitlementsResponse.md)
+
+### Authorization
+
+[apiKeyAuth](../README.md#apiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_partner_entitlements_0
+
+> <GetPartnerEntitlementsResponse> get_partner_entitlements_0(partner_id, opts)
+
+Get partner entitlements
+
+Retrieves all entitlements for a partner (admin or partner access).
+
+### Examples
+
+```ruby
+require 'time'
+require 'api-sdk-rb'
+# setup authorization
+ApiSdkRb.configure do |config|
+  # Configure Bearer authorization (JWT): apiKeyAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = ApiSdkRb::EntitlementsApi.new
+partner_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | Partner ID
+opts = {
+  include_expired: true, # Boolean | Include expired entitlements in results
+  feature: 'feature_example', # String | Filter by specific feature
+  source: 'source_example' # String | Filter by entitlement source
+}
+
+begin
+  # Get partner entitlements
+  result = api_instance.get_partner_entitlements_0(partner_id, opts)
+  p result
+rescue ApiSdkRb::ApiError => e
+  puts "Error when calling EntitlementsApi->get_partner_entitlements_0: #{e}"
+end
+```
+
+#### Using the get_partner_entitlements_0_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetPartnerEntitlementsResponse>, Integer, Hash)> get_partner_entitlements_0_with_http_info(partner_id, opts)
+
+```ruby
+begin
+  # Get partner entitlements
+  data, status_code, headers = api_instance.get_partner_entitlements_0_with_http_info(partner_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetPartnerEntitlementsResponse>
+rescue ApiSdkRb::ApiError => e
+  puts "Error when calling EntitlementsApi->get_partner_entitlements_0_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **partner_id** | **String** | Partner ID |  |
+| **include_expired** | **Boolean** | Include expired entitlements in results | [optional] |
+| **feature** | **String** | Filter by specific feature | [optional] |
+| **source** | **String** | Filter by entitlement source | [optional] |
+
+### Return type
+
+[**GetPartnerEntitlementsResponse**](GetPartnerEntitlementsResponse.md)
+
+### Authorization
+
+[apiKeyAuth](../README.md#apiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/ErrorDetail.md

@@ -0,0 +1,34 @@
+# ApiSdkRb::ErrorDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **code** | **String** | Machine-readable error code. |  |
+| **message** | **String** | Human-readable explanation. |  |
+| **param** | **String** | The field that caused the error, when one did. | [optional] |
+| **doc_url** | **String** | Where this error is explained. | [optional] |
+| **suggested_action** | **String** | What to do about it. | [optional] |
+| **retry_after** | **Integer** | Seconds to wait before trying again (rate limits). The same number is in the `Retry-After` header. | [optional] |
+| **details** | **Hash<String, Object>** | More about the error: the fields that failed, a limit that was reached. | [optional] |
+| **correlation_id** | **String** | Quote this when you ask support about the call. | [optional] |
+| **timestamp** | **Time** |  |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::ErrorDetail.new(
+  code: RESOURCE_NOT_FOUND,
+  message: Composition not found,
+  param: name,
+  doc_url: null,
+  suggested_action: null,
+  retry_after: 60,
+  details: null,
+  correlation_id: req_123e4567-e89b-12d3-a456-426614174000,
+  timestamp: 2026-10-15T10:00Z
+)
+```
+

data/docs/ErrorResponse.md

@@ -0,0 +1,22 @@
+# ApiSdkRb::ErrorResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Boolean** | Always `false` on a failure. |  |
+| **message** | **String** | The same text as `error.message`, for a caller that reads one line. |  |
+| **error** | [**ErrorDetail**](ErrorDetail.md) |  |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::ErrorResponse.new(
+  success: false,
+  message: null,
+  error: null
+)
+```
+

data/docs/ExportCompositionEntryItems200Response.md

@@ -0,0 +1,22 @@
+# ApiSdkRb::ExportCompositionEntryItems200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Boolean** |  |  |
+| **data** | [**Array<CompositionEntryItem>**](CompositionEntryItem.md) |  |  |
+| **meta** | [**ExportCompositionEntryItems200ResponseMeta**](ExportCompositionEntryItems200ResponseMeta.md) |  |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::ExportCompositionEntryItems200Response.new(
+  success: null,
+  data: null,
+  meta: null
+)
+```
+

data/docs/ExportCompositionEntryItems200ResponseMeta.md

@@ -0,0 +1,20 @@
+# ApiSdkRb::ExportCompositionEntryItems200ResponseMeta
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **total** | **Integer** |  |  |
+| **exported** | **Integer** |  |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::ExportCompositionEntryItems200ResponseMeta.new(
+  total: null,
+  exported: null
+)
+```
+

data/docs/GetAiAnswersKnowledge200Response.md

@@ -0,0 +1,22 @@
+# ApiSdkRb::GetAiAnswersKnowledge200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Boolean** |  |  |
+| **data** | [**AiAnswersKnowledge**](AiAnswersKnowledge.md) |  |  |
+| **meta** | [**ResponseMeta**](ResponseMeta.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::GetAiAnswersKnowledge200Response.new(
+  success: null,
+  data: null,
+  meta: null
+)
+```
+

data/docs/GetAllCanvasesResponse.md

@@ -0,0 +1,22 @@
+# ApiSdkRb::GetAllCanvasesResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Boolean** | Always `true` on a success. |  |
+| **data** | [**GetAllCanvasesResponseData**](GetAllCanvasesResponseData.md) |  |  |
+| **meta** | [**ResponseMeta**](ResponseMeta.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::GetAllCanvasesResponse.new(
+  success: true,
+  data: null,
+  meta: null
+)
+```
+

data/docs/GetAllCanvasesResponseData.md

@@ -0,0 +1,24 @@
+# ApiSdkRb::GetAllCanvasesResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **data** | [**Array<Canvas>**](Canvas.md) |  | [optional] |
+| **page** | **Integer** |  | [optional] |
+| **size** | **Integer** |  | [optional] |
+| **total** | **Integer** | Total number of canvases matching the criteria | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::GetAllCanvasesResponseData.new(
+  data: null,
+  page: 1,
+  size: 20,
+  total: 50
+)
+```
+

data/docs/GetAllCompositions200Response.md

@@ -0,0 +1,22 @@
+# ApiSdkRb::GetAllCompositions200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Boolean** |  |  |
+| **data** | [**Array<Composition>**](Composition.md) |  |  |
+| **meta** | [**ResponseMeta**](ResponseMeta.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::GetAllCompositions200Response.new(
+  success: null,
+  data: null,
+  meta: null
+)
+```
+