api-sdk-rb 1.11.66

data/docs/SetAdapterConnectionRequest.md

@@ -0,0 +1,18 @@
+# ApiSdkRb::SetAdapterConnectionRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **credential** | **String** | The key exactly as its provider gave it: one line of text, at most 2048 characters. It is stored encrypted and is never returned or logged. |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::SetAdapterConnectionRequest.new(
+  credential: YOUR_PROVIDER_KEY
+)
+```
+

data/docs/SetCompositionDataSourceRequest.md

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

data/docs/SetDynamicContentRequest.md

@@ -0,0 +1,26 @@
+# ApiSdkRb::SetDynamicContentRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **content** | **Object** | Content data to set |  |
+| **validate** | **Boolean** | Whether to validate content against widget schema | [optional][default to true] |
+| **partial** | **Boolean** | Whether to merge with existing content (true) or replace entirely (false) | [optional][default to false] |
+| **version** | **String** | Optional version identifier for the content | [optional] |
+| **source** | **String** | Source of the update for tracking purposes | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::SetDynamicContentRequest.new(
+  content: null,
+  validate: null,
+  partial: null,
+  version: null,
+  source: null
+)
+```
+

data/docs/SetDynamicContentResponse.md

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

data/docs/SetDynamicContentResponseData.md

@@ -0,0 +1,26 @@
+# ApiSdkRb::SetDynamicContentResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Boolean** |  | [optional] |
+| **content_version** | **Integer** | Monotonic content version after the write | [optional] |
+| **validation_result** | [**SetDynamicContentResponseDataValidationResult**](SetDynamicContentResponseDataValidationResult.md) |  | [optional] |
+| **composition_updated** | **Boolean** |  | [optional] |
+| **realtime_update_sent** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::SetDynamicContentResponseData.new(
+  success: null,
+  content_version: null,
+  validation_result: null,
+  composition_updated: null,
+  realtime_update_sent: null
+)
+```
+

data/docs/SetDynamicContentResponseDataValidationResult.md

@@ -0,0 +1,22 @@
+# ApiSdkRb::SetDynamicContentResponseDataValidationResult
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **valid** | **Boolean** |  | [optional] |
+| **errors** | **Array<Object>** |  | [optional] |
+| **warnings** | **Array<Object>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::SetDynamicContentResponseDataValidationResult.new(
+  valid: null,
+  errors: null,
+  warnings: null
+)
+```
+

data/docs/SetManagedUserLimitsRequest.md

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

data/docs/SetPartnerDataDatabaseRequest.md

@@ -0,0 +1,18 @@
+# ApiSdkRb::SetPartnerDataDatabaseRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **connection_string** | **String** | The connection string of a Neon database and role you made for this, as Neon shows it under Connect: `postgresql://<role>:<password>@ep-<name>.<region>.aws.neon.tech/<database>`. Either the direct or the pooled host works. Everything after the database name (`?sslmode=...`) is ignored. It is stored encrypted and is never returned or logged. |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::SetPartnerDataDatabaseRequest.new(
+  connection_string: postgresql://widgetic_data:YOUR_PASSWORD@ep-cool-name-123456.eu-central-1.aws.neon.tech/neondb
+)
+```
+

data/docs/SetPartnerDesignDefaultsRequest.md

@@ -0,0 +1,18 @@
+# ApiSdkRb::SetPartnerDesignDefaultsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **design** | **Object** |  |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::SetPartnerDesignDefaultsRequest.new(
+  design: null
+)
+```
+

data/docs/SetPartnerPresetRequest.md

@@ -0,0 +1,24 @@
+# ApiSdkRb::SetPartnerPresetRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **widget_id** | **String** | One of the partner's own widgets. A widget is a preset under at most one key. |  |
+| **title** | **String** | What your picker shows. Leave it out to show the widget's own name. | [optional] |
+| **description** | **String** |  | [optional] |
+| **position** | **Integer** | Where the preset sits in the list. Smallest first; presets with the same position are ordered by key. | [optional][default to 0] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::SetPartnerPresetRequest.new(
+  widget_id: null,
+  title: null,
+  description: null,
+  position: null
+)
+```
+

data/docs/SetPartnerStorageDestinationRequest.md

@@ -0,0 +1,32 @@
+# ApiSdkRb::SetPartnerStorageDestinationRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **endpoint** | **String** | The HTTPS address of the S3-compatible service, scheme and host only (no path, port or credentials). It must be a host name, not an IP address, and must resolve to the public internet.  |  |
+| **region** | **String** | The region the service signs requests for. Use auto where the service says so (such as Cloudflare R2). |  |
+| **bucket** | **String** |  |  |
+| **key_prefix** | **String** | A folder inside the bucket to write every file under, for example widgetic/uploads. Folders are made of letters, digits, dots, hyphens and underscores. Leave it out to write at the root of the bucket.  | [optional][default to ''] |
+| **public_base_url** | **String** | Where the stored files are served from: the bucket's public address, or a CDN in front of it. The address of a file is this value, a slash and the file's key in the bucket, which starts with the key prefix. A path is allowed (https://media.example.com/files/acme-widget-media).  |  |
+| **force_path_style** | **Boolean** | Put the bucket name in the path of a request. Every S3-compatible service supports this; set it to false only for a service that needs the bucket name in the host name.  | [optional][default to true] |
+| **access_key_id** | **String** | The id of an access key that may put objects into the bucket |  |
+| **secret_access_key** | **String** | The secret of that access key. It is stored encrypted and is never returned. |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::SetPartnerStorageDestinationRequest.new(
+  endpoint: https://abc123.r2.cloudflarestorage.com,
+  region: auto,
+  bucket: acme-widget-media,
+  key_prefix: widgetic/,
+  public_base_url: https://media.example.com,
+  force_path_style: null,
+  access_key_id: null,
+  secret_access_key: null
+)
+```
+

data/docs/SetUserAdapterConnection200Response.md

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

data/docs/SuccessResponse.md

@@ -0,0 +1,22 @@
+# ApiSdkRb::SuccessResponse
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **success** | **Boolean** | Always `true` on a success. |  |
+| **data** | **Hash<String, Object>** | The result of the call. Its fields are not described for this operation yet. |  |
+| **meta** | [**ResponseMeta**](ResponseMeta.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::SuccessResponse.new(
+  success: true,
+  data: null,
+  meta: null
+)
+```
+

data/docs/TokensApi.md

@@ -0,0 +1,77 @@
+# ApiSdkRb::TokensApi
+
+All URIs are relative to *https://api.widgetic.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**validate_token_0**](TokensApi.md#validate_token_0) | **GET** /tokens/validate | Validate current authentication token |
+
+
+## validate_token_0
+
+> <ValidateToken200Response> validate_token_0
+
+Validate current authentication token
+
+### Examples
+
+```ruby
+require 'time'
+require 'api-sdk-rb'
+# setup authorization
+ApiSdkRb.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  # config.api_key_prefix['Authorization'] = 'Bearer'
+
+  # Configure Bearer authorization (JWT): BearerAuth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = ApiSdkRb::TokensApi.new
+
+begin
+  # Validate current authentication token
+  result = api_instance.validate_token_0
+  p result
+rescue ApiSdkRb::ApiError => e
+  puts "Error when calling TokensApi->validate_token_0: #{e}"
+end
+```
+
+#### Using the validate_token_0_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ValidateToken200Response>, Integer, Hash)> validate_token_0_with_http_info
+
+```ruby
+begin
+  # Validate current authentication token
+  data, status_code, headers = api_instance.validate_token_0_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ValidateToken200Response>
+rescue ApiSdkRb::ApiError => e
+  puts "Error when calling TokensApi->validate_token_0_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**ValidateToken200Response**](ValidateToken200Response.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth), [BearerAuth](../README.md#BearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/UpdateCanvasRequest.md

@@ -0,0 +1,22 @@
+# ApiSdkRb::UpdateCanvasRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **persistence_key** | **String** | Updated key used for persistent storage and reference | [optional] |
+| **canvas_content** | **Object** | Updated JSON content of the canvas | [optional] |
+| **primary_widget_id** | **String** | Primary widget for list/deep-link; omit to leave unchanged | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::UpdateCanvasRequest.new(
+  persistence_key: updated_canvas_xyz123,
+  canvas_content: {"version":2,"elements":[{"id":"elem1"}],"settings":{"theme":"dark"}},
+  primary_widget_id: null
+)
+```
+

data/docs/UpdateComposition.md

@@ -0,0 +1,32 @@
+# ApiSdkRb::UpdateComposition
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | Updated name of the composition | [optional] |
+| **widget_id** | **String** | Updated widget ID | [optional] |
+| **content** | **Object** | Updated content data | [optional] |
+| **status** | **String** | Updated status | [optional] |
+| **embed_settings** | **Object** | Updated embed settings | [optional] |
+| **design** | **Object** | Updated design settings | [optional] |
+| **database_schema** | **Object** | Tables to make for the composition, in the shape `createComposition` takes (`{ \"tables\": [ ... ] }`, with the same names, types, defaults and limits). Only the tables that are missing are made. A table that already exists is never changed or dropped: it keeps its columns, so a column added to the declaration is not added to it. A declaration that cannot be used is refused with `400` and `INVALID_DATABASE_SCHEMA`. When the composition is saved but its tables cannot be made just now, `meta.warnings` says so: send the same `databaseSchema` again to retry.  | [optional] |
+| **project_id** | **String** | Updated project ID | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::UpdateComposition.new(
+  name: Updated Composition Name,
+  widget_id: 123e4567-e89b-12d3-a456-426614174002,
+  content: {"key":"new value"},
+  status: published,
+  embed_settings: {"width":"100%","height":"600px"},
+  design: {"theme":"dark","colors":{"primary":"#0044cc"}},
+  database_schema: null,
+  project_id: 123e4567-e89b-12d3-a456-426614174004
+)
+```
+

data/docs/UpdateCompositionStatusRequest.md

@@ -0,0 +1,18 @@
+# ApiSdkRb::UpdateCompositionStatusRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** | New status to set |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::UpdateCompositionStatusRequest.new(
+  status: null
+)
+```
+

data/docs/UpdateDomainRequest.md

@@ -0,0 +1,18 @@
+# ApiSdkRb::UpdateDomainRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **domain** | **String** | The website name to keep instead, such as `example.com`, or `*.example.com` for a website and all of its subdomains |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::UpdateDomainRequest.new(
+  domain: example.com
+)
+```
+

data/docs/UpdateManagedUser.md

@@ -0,0 +1,22 @@
+# ApiSdkRb::UpdateManagedUser
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **external_id** | **String** | Updated external identifier for the managed user. Must be unique among the managed users you manage (409 otherwise). | [optional] |
+| **metadata** | **Object** | Updated additional metadata for the managed user | [optional] |
+| **is_active** | **Boolean** | Switch the managed user off (`false`) or back on (`true`). A managed user that is off keeps everything already filed under it, and that content can still be listed, but nothing new can be filed under it (`409 MANAGED_USER_INACTIVE`). Send a real boolean, not the text \"false\". Switching a managed user off also ends all of its editor sessions.  | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::UpdateManagedUser.new(
+  external_id: updated-external-user-123,
+  metadata: {"firstName":"John","lastName":"Smith","role":"admin"},
+  is_active: false
+)
+```
+

data/docs/UpdatePartnerEntryContextSigningRequest.md

@@ -0,0 +1,18 @@
+# ApiSdkRb::UpdatePartnerEntryContextSigningRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **required** | **Boolean** | True to refuse every entry whose context carries no valid signature. False to check the signature of the entries that carry one and accept the others, as before. |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::UpdatePartnerEntryContextSigningRequest.new(
+  required: null
+)
+```
+

data/docs/UpdatePartnerNotificationSettingsRequest.md

@@ -0,0 +1,24 @@
+# ApiSdkRb::UpdatePartnerNotificationSettingsRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **email_recipients** | **Array<String>** | The addresses the emails go to, at most five. An empty list goes back to the defaults. | [optional] |
+| **email_events** | [**Array<PartnerNotificationEventType>**](PartnerNotificationEventType.md) | The events you want by email. Null for every event. | [optional] |
+| **webhook_events** | [**Array<PartnerNotificationEventType>**](PartnerNotificationEventType.md) | The events to send to your webhook. Null for every event. | [optional] |
+| **webhook_url** | **String** | Where to send the signed calls. It must be an https address on the standard port, on a public site, and it must not redirect. Null or an empty text switches the webhook off. Setting an address when you have no secret yet makes one. | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::UpdatePartnerNotificationSettingsRequest.new(
+  email_recipients: null,
+  email_events: null,
+  webhook_events: null,
+  webhook_url: null
+)
+```
+

data/docs/UpdateUserApiKeyRequest.md

@@ -0,0 +1,20 @@
+# ApiSdkRb::UpdateUserApiKeyRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | A new name. It cannot be one that another key of the account already has | [optional] |
+| **is_active** | **Boolean** | false switches the key off, true switches it on again. A key that is switched off stops working within a minute at the latest, and at once on the server that took the request | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::UpdateUserApiKeyRequest.new(
+  name: null,
+  is_active: null
+)
+```
+

data/docs/Upload.md

@@ -0,0 +1,44 @@
+# ApiSdkRb::Upload
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **url** | **String** | The public address of the stored file |  |
+| **mime_type** | **String** | The type of the stored file. A HEIC or HEIF photo is stored as `image/jpeg`. |  |
+| **file_name** | **String** |  |  |
+| **file_size** | **Integer** | Size of the stored file, in bytes |  |
+| **width** | **Integer** | Width in pixels, for images | [optional] |
+| **height** | **Integer** | Height in pixels, for images | [optional] |
+| **storage_key** | **String** | Where the file sits in its storage bucket |  |
+| **context_type** | **String** | What the file was uploaded for. Media for widget content is `content-property`. |  |
+| **source** | **String** | Which part of the product, or which client, uploaded the file. `widget-visitor-upload` is a file a visitor sent through a widget's upload adapter; it cannot be asked for when uploading. |  |
+| **widget_id** | **String** |  | [optional] |
+| **conversation_id** | **String** |  | [optional] |
+| **managed_user_id** | **String** | The managed user the file was uploaded for, or null when it is the account's own. List one managed user's files with the `managed_user_id` or `managed_user_external_id` query parameter of `uploadsGet`. | [optional] |
+| **purpose** | **String** | Where in the product the partner uses the file, or null when unknown | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::Upload.new(
+  id: null,
+  url: null,
+  mime_type: image/png,
+  file_name: null,
+  file_size: null,
+  width: null,
+  height: null,
+  storage_key: null,
+  context_type: null,
+  source: null,
+  widget_id: null,
+  conversation_id: null,
+  managed_user_id: null,
+  purpose: null
+)
+```
+

data/docs/UploadLimits.md

@@ -0,0 +1,28 @@
+# ApiSdkRb::UploadLimits
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **multipart_max_bytes** | **Integer** | The largest file `uploadsPost` takes in one request, in bytes. The same for every account. | [optional] |
+| **multipart_mime_types** | **Array<String>** | The file types `uploadsPost` takes for media (`content-property` uploads) | [optional] |
+| **tus_enabled** | **Boolean** | Whether resumable uploads are switched on. They need a signed-in session; an API key uses `uploadsPost`. | [optional] |
+| **tus_max_bytes** | **Integer** | The largest file a resumable upload takes, in bytes (250 MB by default). The same for every account, whatever its plan. A file over `multipart_max_bytes` goes through a resumable upload. | [optional] |
+| **tus_chunk_size_bytes** | **Integer** | The chunk size resumable uploads are tuned for, in bytes. A client may send smaller or larger chunks. | [optional] |
+| **tus_mime_types** | **Array<String>** |  | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::UploadLimits.new(
+  multipart_max_bytes: null,
+  multipart_mime_types: null,
+  tus_enabled: null,
+  tus_max_bytes: null,
+  tus_chunk_size_bytes: null,
+  tus_mime_types: null
+)
+```
+

data/docs/UploadLimitsResponse.md

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