api-sdk-rb 1.11.66

data/docs/ValidateCompositionContentResponse.md

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

data/docs/ValidateCompositionContentResponseData.md

@@ -0,0 +1,24 @@
+# ApiSdkRb::ValidateCompositionContentResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **valid** | **Boolean** | False when there is at least one error. Warnings do not change it. |  |
+| **errors** | [**Array<ContentCheckFinding>**](ContentCheckFinding.md) | What is wrong, at most 100. Absent when `valid` is true. | [optional] |
+| **warnings** | [**Array<ContentCheckFinding>**](ContentCheckFinding.md) | What is worth a look but does not stop the content from being saved, at most 100. | [optional] |
+| **sanitized_content** | **Hash<String, Object>** | The body as it was sent; nothing is changed. | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::ValidateCompositionContentResponseData.new(
+  valid: null,
+  errors: null,
+  warnings: null,
+  sanitized_content: null
+)
+```
+

data/docs/ValidateToken200Response.md

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

data/docs/ValidateToken200ResponseData.md

@@ -0,0 +1,26 @@
+# ApiSdkRb::ValidateToken200ResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **valid** | **Boolean** |  | [optional] |
+| **token_type** | **String** |  | [optional] |
+| **scopes** | **Array<String>** |  | [optional] |
+| **user_id** | **String** |  | [optional] |
+| **expires_at** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::ValidateToken200ResponseData.new(
+  valid: true,
+  token_type: api_key,
+  scopes: ["compositions:read","widgets:read"],
+  user_id: user_123,
+  expires_at: 2024-12-31T23:59:59Z
+)
+```
+

data/docs/Widget.md

@@ -0,0 +1,60 @@
+# ApiSdkRb::Widget
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique identifier for the widget. | [optional] |
+| **creator_id** | **String** | ID of the user who created the widget. | [optional] |
+| **name** | **String** | Name of the widget. | [optional] |
+| **description** | **String** | Description of the widget's purpose and functionality. | [optional] |
+| **type** | **String** | Type of widget (e.g., chart, form, gallery). | [optional] |
+| **content** | **Hash<String, Object>** | Content configuration for the widget. | [optional] |
+| **is_public** | **Boolean** | Whether the widget is publicly available. | [optional] |
+| **is_draft** | **Boolean** | Whether the widget is a draft. | [optional] |
+| **share_id** | **String** | Unique ID for sharing the widget publicly. | [optional] |
+| **created_at** | **Time** | When the widget was created. | [optional] |
+| **updated_at** | **Time** | When the widget was last updated. | [optional] |
+| **js_path** | **String** | Path to the JavaScript file for this widget. | [optional] |
+| **canvas_id** | **String** | ID of the canvas associated with this widget. | [optional] |
+| **repo_id** | **String** | Repository identifier for source code. | [optional] |
+| **database_id** | **String** | Legacy. The name of a Neon database that an earlier version made for this widget. A widget has no database now (what the visitors of a composition leave is kept in the tables of that composition), so widgets made now have none. | [optional] |
+| **version** | **Float** | Version number of the widget. | [optional] |
+| **cpg_schema_id** | **String** | ID linking to the widget's code graph schema. | [optional] |
+| **last_cpg_commit_sha** | **String** | Last Git commit SHA analyzed for code graph. | [optional] |
+| **organization_id** | **String** | Organization ID if created in an organization workspace. | [optional] |
+| **project_folder** | **String** | Project folder reference for organization widgets. | [optional] |
+| **workspace_type** | **String** | Workspace type when created. | [optional] |
+| **managed_user_id** | **String** | The managed user the widget was made for, or null when it is your own. List one managed user's widgets with the `managedUserId` or `managedUserExternalId` query parameter of `getWidgets`. | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::Widget.new(
+  id: 3fa85f64-5717-4562-b3fc-2c963f66afa6,
+  creator_id: a4d8b6e9-3c2d-4a1f-8b9c-5e2d3f4a1b6c,
+  name: Chart Widget,
+  description: Interactive chart widget for data visualization,
+  type: chart,
+  content: {"chartType":"bar","dataSource":"api"},
+  is_public: false,
+  is_draft: true,
+  share_id: shwgt_7f1d34acf2,
+  created_at: 2025-09-15T10:23Z,
+  updated_at: 2025-09-16T08:12:45Z,
+  js_path: /widgets/chart/main.js,
+  canvas_id: 9f0c6b54-3e8f-4a2a-8b7d-1c5c6d9e0a1b,
+  repo_id: user/chart-widget,
+  database_id: widget_3fa85f64_5717_4562_b3fc_2c963f66afa6,
+  version: 1,
+  cpg_schema_id: cpg_4b3a2d1f9e8c7b6a,
+  last_cpg_commit_sha: a1b2c3d4e5f6g7h8i9j0,
+  organization_id: 5e2d3f4a-1b6c-4a1f-8b9c-3c2d4e5f6a7b,
+  project_folder: marketing/q4-launch,
+  workspace_type: personal,
+  managed_user_id: b7c8d9e0-1f2a-4b3c-8d4e-5f6a7b8c9d0e
+)
+```
+

data/docs/WidgetsApi.md

@@ -0,0 +1,303 @@
+# ApiSdkRb::WidgetsApi
+
+All URIs are relative to *https://api.widgetic.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_composition_from_widget_0**](WidgetsApi.md#create_composition_from_widget_0) | **POST** /widgets/{id}/composition | Create a composition for a widget in one call |
+| [**create_widget_0**](WidgetsApi.md#create_widget_0) | **POST** /widgets | Create Widget |
+| [**get_widgets_0**](WidgetsApi.md#get_widgets_0) | **GET** /widgets | List Widgets |
+| [**get_widgets_batch_0**](WidgetsApi.md#get_widgets_batch_0) | **POST** /widgets/batch | Get Widgets Batch |
+
+
+## create_composition_from_widget_0
+
+> <CreateCompositionFromWidget201Response> create_composition_from_widget_0(id, idempotency_key, create_composition_from_widget_request)
+
+Create a composition for a widget in one call
+
+After a managed user publishes a widget from the creator, call this with the widget id, the customer's managed user (when the widget is not already filed under one), and optional content, design, embed settings and locale. Every input is validated before a single insert; a failure never leaves a half-made composition.  When the widget is already tagged with a managed user, you may omit `managedUserId`. When you send it, it must match that tag.  A widget that keeps what visitors send (a form, a vote, a rating) declares its tables in its own source (`src/lib/meta/database.json`); they are made for the composition here, in a schema of its own, as the widget was when it was last published. A widget that keeps nothing leaves the composition without tables. If the tables cannot be made just now, or the widget's file cannot be used, the composition is still created (`201`) and `meta.warnings` says why; the tables are made the next time the widget is generated.  The widget must be published. The `Idempotency-Key` header is required. 
+
+### 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::WidgetsApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The widget id
+idempotency_key = '9b2d6f0a-3c41-4e5a-8d77-1f2e3a4b5c6d' # String | Required: a call without it is refused with `400`. A key of your own that names this one request; a UUID is ideal. It is 8 to 50 characters of letters, digits, `-` and `_`. Send the same key again when you retry (after a timeout, a dropped connection or a `5xx`) and the call is carried out once: the retry gets the first answer back, marked `X-Idempotency-Cached: true`. The same key with a different body is refused with `422`, and a retry that arrives while the first call is still running with `409` (see `Retry-After`).
+create_composition_from_widget_request = ApiSdkRb::CreateCompositionFromWidgetRequest.new({name: 'name_example'}) # CreateCompositionFromWidgetRequest | 
+
+begin
+  # Create a composition for a widget in one call
+  result = api_instance.create_composition_from_widget_0(id, idempotency_key, create_composition_from_widget_request)
+  p result
+rescue ApiSdkRb::ApiError => e
+  puts "Error when calling WidgetsApi->create_composition_from_widget_0: #{e}"
+end
+```
+
+#### Using the create_composition_from_widget_0_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateCompositionFromWidget201Response>, Integer, Hash)> create_composition_from_widget_0_with_http_info(id, idempotency_key, create_composition_from_widget_request)
+
+```ruby
+begin
+  # Create a composition for a widget in one call
+  data, status_code, headers = api_instance.create_composition_from_widget_0_with_http_info(id, idempotency_key, create_composition_from_widget_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateCompositionFromWidget201Response>
+rescue ApiSdkRb::ApiError => e
+  puts "Error when calling WidgetsApi->create_composition_from_widget_0_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | The widget id |  |
+| **idempotency_key** | **String** | Required: a call without it is refused with &#x60;400&#x60;. A key of your own that names this one request; a UUID is ideal. It is 8 to 50 characters of letters, digits, &#x60;-&#x60; and &#x60;_&#x60;. Send the same key again when you retry (after a timeout, a dropped connection or a &#x60;5xx&#x60;) and the call is carried out once: the retry gets the first answer back, marked &#x60;X-Idempotency-Cached: true&#x60;. The same key with a different body is refused with &#x60;422&#x60;, and a retry that arrives while the first call is still running with &#x60;409&#x60; (see &#x60;Retry-After&#x60;). |  |
+| **create_composition_from_widget_request** | [**CreateCompositionFromWidgetRequest**](CreateCompositionFromWidgetRequest.md) |  |  |
+
+### Return type
+
+[**CreateCompositionFromWidget201Response**](CreateCompositionFromWidget201Response.md)
+
+### Authorization
+
+[apiKeyAuth](../README.md#apiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## create_widget_0
+
+> <CreateWidget201Response> create_widget_0(idempotency_key, new_widget)
+
+Create Widget
+
+Creates a widget for your account: a named record with a type and some starting content, on a canvas of its own (or one of yours that you name). It costs no credits and has no code yet; the code is generated for it afterwards. The new widget is yours, and you can list it with `getWidgets`. A widget is a draft until you say otherwise (`isDraft: false`).  If a step after the widget was saved does not go through, the widget is still created, and `data.warnings` says what did not. Read it before relying on the widget.  A widget can be placed on one of your canvases (`canvasId`), in a project you can edit (`projectId`) or in an organization where you may create widgets (`organizationId`). Naming anything you cannot use is refused with 403, and the answer is the same whether it exists or not.  To make the widget for one of your managed users, send `managedUserId` or `managedUserExternalId`. The widget stays in your account and is yours to edit; the tag lets you list one user's widgets with `getWidgets`. The managed user must be yours and active: one that is not yours, or does not exist, is answered with 404 and `MANAGED_USER_NOT_FOUND`, and one that is switched off with 409 and `MANAGED_USER_INACTIVE`. The tag is set here and does not change afterwards.  This call has a limit of its own: 120 per minute for each account (ask Widgetic if you need more). Past that the call is answered with 429 and a `Retry-After`. A widget has no database of its own: what the visitors of a composition leave is kept in the tables of that composition, made when the composition is. The `Idempotency-Key` header is required; send the same key when you retry, so one widget is created, not two. 
+
+### 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::WidgetsApi.new
+idempotency_key = 'idempotency_key_example' # String | A unique value (a UUID is fine) that makes a retry of this request safe.
+new_widget = ApiSdkRb::NewWidget.new({name: 'New Chart Widget', type: 'chart', content: { key: 3.56}}) # NewWidget | 
+
+begin
+  # Create Widget
+  result = api_instance.create_widget_0(idempotency_key, new_widget)
+  p result
+rescue ApiSdkRb::ApiError => e
+  puts "Error when calling WidgetsApi->create_widget_0: #{e}"
+end
+```
+
+#### Using the create_widget_0_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CreateWidget201Response>, Integer, Hash)> create_widget_0_with_http_info(idempotency_key, new_widget)
+
+```ruby
+begin
+  # Create Widget
+  data, status_code, headers = api_instance.create_widget_0_with_http_info(idempotency_key, new_widget)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CreateWidget201Response>
+rescue ApiSdkRb::ApiError => e
+  puts "Error when calling WidgetsApi->create_widget_0_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **idempotency_key** | **String** | A unique value (a UUID is fine) that makes a retry of this request safe. |  |
+| **new_widget** | [**NewWidget**](NewWidget.md) |  |  |
+
+### Return type
+
+[**CreateWidget201Response**](CreateWidget201Response.md)
+
+### Authorization
+
+[apiKeyAuth](../README.md#apiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## get_widgets_0
+
+> <GetWidgets200Response> get_widgets_0(opts)
+
+List Widgets
+
+Lists the widgets your account owns, newest first. A widget is the reusable piece a composition is made from; this is your own library, not a catalogue of Widgetic's widgets.  Pass `page` (counting from 1) and `size` (1 to 100, 20 when left out) to read the list one page at a time. `meta` then carries `total`, `hasNextPage` and `hasPreviousPage`, so a client can walk the list to its end. A page past the end is an empty list. Without `page` and `size` the call returns the whole list in one response, which only suits an account with a few widgets.  Pass `canvasId` to list only the widgets on one of your canvases. That list is always returned whole, whatever `page` and `size` say.  Pass `managedUserId` (Widgetic's id for one of your managed users) or `managedUserExternalId` (your own identifier for the user) to list only the widgets made for that managed user. The widgets of your other managed users, and your own, are left out. It combines with `page`, `size` and `canvasId`. A managed user that is not yours, or does not exist, is answered with 404 and `MANAGED_USER_NOT_FOUND`. 
+
+### 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::WidgetsApi.new
+opts = {
+  page: 56, # Integer | Page to return, counting from 1. Giving `page` or `size` turns paging on.
+  size: 56, # Integer | How many widgets a page holds (20 when `page` is given without it). Giving `page` or `size` turns paging on.
+  canvas_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | List only the widgets on this canvas. The list is returned whole.
+  managed_user_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | List only the widgets made for this managed user (Widgetic's id for the user). Send this or `managedUserExternalId`, not both.
+  managed_user_external_id: 'managed_user_external_id_example' # String | List only the widgets made for the managed user you registered with this `externalId` (your own identifier for the user). Send this or `managedUserId`, not both.
+}
+
+begin
+  # List Widgets
+  result = api_instance.get_widgets_0(opts)
+  p result
+rescue ApiSdkRb::ApiError => e
+  puts "Error when calling WidgetsApi->get_widgets_0: #{e}"
+end
+```
+
+#### Using the get_widgets_0_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetWidgets200Response>, Integer, Hash)> get_widgets_0_with_http_info(opts)
+
+```ruby
+begin
+  # List Widgets
+  data, status_code, headers = api_instance.get_widgets_0_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetWidgets200Response>
+rescue ApiSdkRb::ApiError => e
+  puts "Error when calling WidgetsApi->get_widgets_0_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **Integer** | Page to return, counting from 1. Giving &#x60;page&#x60; or &#x60;size&#x60; turns paging on. | [optional] |
+| **size** | **Integer** | How many widgets a page holds (20 when &#x60;page&#x60; is given without it). Giving &#x60;page&#x60; or &#x60;size&#x60; turns paging on. | [optional] |
+| **canvas_id** | **String** | List only the widgets on this canvas. The list is returned whole. | [optional] |
+| **managed_user_id** | **String** | List only the widgets made for this managed user (Widgetic&#39;s id for the user). Send this or &#x60;managedUserExternalId&#x60;, not both. | [optional] |
+| **managed_user_external_id** | **String** | List only the widgets made for the managed user you registered with this &#x60;externalId&#x60; (your own identifier for the user). Send this or &#x60;managedUserId&#x60;, not both. | [optional] |
+
+### Return type
+
+[**GetWidgets200Response**](GetWidgets200Response.md)
+
+### Authorization
+
+[apiKeyAuth](../README.md#apiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_widgets_batch_0
+
+> <GetWidgetsBatchResponse> get_widgets_batch_0(get_widgets_batch_request)
+
+Get Widgets Batch
+
+Retrieves multiple widgets by their IDs in a single request. An id that is not found, or that is not yours, is reported in `errors` exactly like one that does not exist. Called with an editor session, only the widgets made for the session's managed user are returned.
+
+### 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::WidgetsApi.new
+get_widgets_batch_request = ApiSdkRb::GetWidgetsBatchRequest.new({widget_ids: ['widget_ids_example']}) # GetWidgetsBatchRequest | 
+
+begin
+  # Get Widgets Batch
+  result = api_instance.get_widgets_batch_0(get_widgets_batch_request)
+  p result
+rescue ApiSdkRb::ApiError => e
+  puts "Error when calling WidgetsApi->get_widgets_batch_0: #{e}"
+end
+```
+
+#### Using the get_widgets_batch_0_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetWidgetsBatchResponse>, Integer, Hash)> get_widgets_batch_0_with_http_info(get_widgets_batch_request)
+
+```ruby
+begin
+  # Get Widgets Batch
+  data, status_code, headers = api_instance.get_widgets_batch_0_with_http_info(get_widgets_batch_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetWidgetsBatchResponse>
+rescue ApiSdkRb::ApiError => e
+  puts "Error when calling WidgetsApi->get_widgets_batch_0_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **get_widgets_batch_request** | [**GetWidgetsBatchRequest**](GetWidgetsBatchRequest.md) |  |  |
+
+### Return type
+
+[**GetWidgetsBatchResponse**](GetWidgetsBatchResponse.md)
+
+### Authorization
+
+[apiKeyAuth](../README.md#apiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/git_push.sh

@@ -0,0 +1,57 @@
+#!/bin/sh
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+git_host=$4
+
+if [ "$git_host" = "" ]; then
+    git_host="github.com"
+    echo "[INFO] No command line input provided. Set \$git_host to $git_host"
+fi
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=$(git remote)
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'