api-sdk-rb 1.11.66

data/docs/CanvasesApi.md

@@ -0,0 +1,377 @@
+# ApiSdkRb::CanvasesApi
+
+All URIs are relative to *https://api.widgetic.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_canvas_0**](CanvasesApi.md#create_canvas_0) | **POST** /canvases | Create Canvas |
+| [**delete_canvas_0**](CanvasesApi.md#delete_canvas_0) | **DELETE** /canvases/{id} | Delete Canvas |
+| [**get_all_canvases_0**](CanvasesApi.md#get_all_canvases_0) | **GET** /canvases | Get All Canvases |
+| [**get_canvas_0**](CanvasesApi.md#get_canvas_0) | **GET** /canvases/{id} | Get Canvas |
+| [**update_canvas_0**](CanvasesApi.md#update_canvas_0) | **PUT** /canvases/{id} | Update Canvas |
+
+
+## create_canvas_0
+
+> <CanvasResponse> create_canvas_0(create_canvas_request)
+
+Create Canvas
+
+Creates a new canvas with the specified properties.  To make the canvas for one of your managed users, send `managedUserId` or `managedUserExternalId`. The canvas stays in your account and is yours to edit; the tag lets you list one user's canvases with `getAllCanvases`. 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. Called with an editor session, the canvas is always made for the session's managed user. 
+
+### 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::CanvasesApi.new
+create_canvas_request = ApiSdkRb::CreateCanvasRequest.new({persistence_key: 'canvas_xyz123'}) # CreateCanvasRequest | 
+
+begin
+  # Create Canvas
+  result = api_instance.create_canvas_0(create_canvas_request)
+  p result
+rescue ApiSdkRb::ApiError => e
+  puts "Error when calling CanvasesApi->create_canvas_0: #{e}"
+end
+```
+
+#### Using the create_canvas_0_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CanvasResponse>, Integer, Hash)> create_canvas_0_with_http_info(create_canvas_request)
+
+```ruby
+begin
+  # Create Canvas
+  data, status_code, headers = api_instance.create_canvas_0_with_http_info(create_canvas_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CanvasResponse>
+rescue ApiSdkRb::ApiError => e
+  puts "Error when calling CanvasesApi->create_canvas_0_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_canvas_request** | [**CreateCanvasRequest**](CreateCanvasRequest.md) |  |  |
+
+### Return type
+
+[**CanvasResponse**](CanvasResponse.md)
+
+### Authorization
+
+[apiKeyAuth](../README.md#apiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_canvas_0
+
+> <CanvasResponse> delete_canvas_0(id)
+
+Delete Canvas
+
+Deletes a canvas together with every widget on it.  Called with an editor session, only a canvas whose widgets were all made for the session's managed user can be deleted; one that also holds somebody else's widgets is refused with 409 and `CANVAS_HAS_OTHER_WIDGETS`, and nothing is deleted. Delete such a canvas with your API key. 
+
+### 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::CanvasesApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | ID of the canvas
+
+begin
+  # Delete Canvas
+  result = api_instance.delete_canvas_0(id)
+  p result
+rescue ApiSdkRb::ApiError => e
+  puts "Error when calling CanvasesApi->delete_canvas_0: #{e}"
+end
+```
+
+#### Using the delete_canvas_0_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CanvasResponse>, Integer, Hash)> delete_canvas_0_with_http_info(id)
+
+```ruby
+begin
+  # Delete Canvas
+  data, status_code, headers = api_instance.delete_canvas_0_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CanvasResponse>
+rescue ApiSdkRb::ApiError => e
+  puts "Error when calling CanvasesApi->delete_canvas_0_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | ID of the canvas |  |
+
+### Return type
+
+[**CanvasResponse**](CanvasResponse.md)
+
+### Authorization
+
+[apiKeyAuth](../README.md#apiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_all_canvases_0
+
+> <GetAllCanvasesResponse> get_all_canvases_0(opts)
+
+Get All Canvases
+
+Retrieves all canvases with pagination support and filtering options.  Pass `managedUserId` (Widgetic's id for one of your managed users) or `managedUserExternalId` (your own identifier for the user) to list only the canvases made for that managed user. The canvases of your other managed users, and your own, are left out. A managed user that is not yours, or does not exist, is answered with 404 and `MANAGED_USER_NOT_FOUND`. Called with an editor session, the list is always the session's managed user's. 
+
+### 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::CanvasesApi.new
+opts = {
+  page: 56, # Integer | Page number for pagination
+  size: 56, # Integer | Number of items per page
+  sort: 'sort_example', # String | Sort field and direction (e.g., \"created_at:desc\")
+  created_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter canvases created after the specified date (ISO 8601 format)
+  created_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter canvases created before the specified date (ISO 8601 format)
+  updated_after: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter canvases updated after the specified date (ISO 8601 format)
+  updated_before: Time.parse('2013-10-20T19:20:30+01:00'), # Time | Filter canvases updated before the specified date (ISO 8601 format)
+  managed_user_id: '38400000-8cf0-11bd-b23e-10b96e4ef00d', # String | List only the canvases 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 canvases made for the managed user you registered with this `externalId` (your own identifier for the user). Send this or `managedUserId`, not both.
+}
+
+begin
+  # Get All Canvases
+  result = api_instance.get_all_canvases_0(opts)
+  p result
+rescue ApiSdkRb::ApiError => e
+  puts "Error when calling CanvasesApi->get_all_canvases_0: #{e}"
+end
+```
+
+#### Using the get_all_canvases_0_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetAllCanvasesResponse>, Integer, Hash)> get_all_canvases_0_with_http_info(opts)
+
+```ruby
+begin
+  # Get All Canvases
+  data, status_code, headers = api_instance.get_all_canvases_0_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetAllCanvasesResponse>
+rescue ApiSdkRb::ApiError => e
+  puts "Error when calling CanvasesApi->get_all_canvases_0_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **page** | **Integer** | Page number for pagination | [optional][default to 1] |
+| **size** | **Integer** | Number of items per page | [optional][default to 20] |
+| **sort** | **String** | Sort field and direction (e.g., \&quot;created_at:desc\&quot;) | [optional][default to &#39;created_at:desc&#39;] |
+| **created_after** | **Time** | Filter canvases created after the specified date (ISO 8601 format) | [optional] |
+| **created_before** | **Time** | Filter canvases created before the specified date (ISO 8601 format) | [optional] |
+| **updated_after** | **Time** | Filter canvases updated after the specified date (ISO 8601 format) | [optional] |
+| **updated_before** | **Time** | Filter canvases updated before the specified date (ISO 8601 format) | [optional] |
+| **managed_user_id** | **String** | List only the canvases 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 canvases 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
+
+[**GetAllCanvasesResponse**](GetAllCanvasesResponse.md)
+
+### Authorization
+
+[apiKeyAuth](../README.md#apiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_canvas_0
+
+> <CanvasResponse> get_canvas_0(id)
+
+Get Canvas
+
+Retrieves a specific canvas by ID.
+
+### 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::CanvasesApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | ID of the canvas
+
+begin
+  # Get Canvas
+  result = api_instance.get_canvas_0(id)
+  p result
+rescue ApiSdkRb::ApiError => e
+  puts "Error when calling CanvasesApi->get_canvas_0: #{e}"
+end
+```
+
+#### Using the get_canvas_0_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CanvasResponse>, Integer, Hash)> get_canvas_0_with_http_info(id)
+
+```ruby
+begin
+  # Get Canvas
+  data, status_code, headers = api_instance.get_canvas_0_with_http_info(id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CanvasResponse>
+rescue ApiSdkRb::ApiError => e
+  puts "Error when calling CanvasesApi->get_canvas_0_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | ID of the canvas |  |
+
+### Return type
+
+[**CanvasResponse**](CanvasResponse.md)
+
+### Authorization
+
+[apiKeyAuth](../README.md#apiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## update_canvas_0
+
+> <CanvasResponse> update_canvas_0(id, update_canvas_request)
+
+Update Canvas
+
+Updates an existing canvas with the specified properties.
+
+### 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::CanvasesApi.new
+id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | ID of the canvas to update
+update_canvas_request = ApiSdkRb::UpdateCanvasRequest.new # UpdateCanvasRequest | 
+
+begin
+  # Update Canvas
+  result = api_instance.update_canvas_0(id, update_canvas_request)
+  p result
+rescue ApiSdkRb::ApiError => e
+  puts "Error when calling CanvasesApi->update_canvas_0: #{e}"
+end
+```
+
+#### Using the update_canvas_0_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<CanvasResponse>, Integer, Hash)> update_canvas_0_with_http_info(id, update_canvas_request)
+
+```ruby
+begin
+  # Update Canvas
+  data, status_code, headers = api_instance.update_canvas_0_with_http_info(id, update_canvas_request)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <CanvasResponse>
+rescue ApiSdkRb::ApiError => e
+  puts "Error when calling CanvasesApi->update_canvas_0_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | ID of the canvas to update |  |
+| **update_canvas_request** | [**UpdateCanvasRequest**](UpdateCanvasRequest.md) |  |  |
+
+### Return type
+
+[**CanvasResponse**](CanvasResponse.md)
+
+### Authorization
+
+[apiKeyAuth](../README.md#apiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/CheckCompositionAccessResponse.md

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

data/docs/CheckCompositionAccessResponseData.md

@@ -0,0 +1,20 @@
+# ApiSdkRb::CheckCompositionAccessResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **can_access** | **Boolean** | Whether the user can access the composition | [optional] |
+| **reason** | **String** | Reason for access decision | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::CheckCompositionAccessResponseData.new(
+  can_access: null,
+  reason: null
+)
+```
+

data/docs/Composition.md

@@ -0,0 +1,46 @@
+# ApiSdkRb::Composition
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique identifier for the composition |  |
+| **creator_id** | **String** | ID of the user who created the composition |  |
+| **widget_id** | **String** | ID of the widget this composition is based on |  |
+| **name** | **String** | Name of the composition |  |
+| **content** | **Object** | Content data for the composition |  |
+| **content_version** | **Integer** | Monotonic content version when the content_version migration is applied | [optional] |
+| **status** | **String** | Current status of the composition |  |
+| **created_at** | **Time** | When the composition was created |  |
+| **updated_at** | **Time** | When the composition was last updated |  |
+| **embed_settings** | **Object** | Settings for embedding the composition | [optional] |
+| **design** | **Object** | Design settings for the composition | [optional] |
+| **database_id** | **String** | Legacy. The id of a Neon database that an earlier version made for this composition. A composition now keeps its tables in a schema of its own (named `comp_` followed by its id) in a database shared with other compositions, so new compositions have none. | [optional] |
+| **project_id** | **String** | ID of the project this composition belongs to | [optional] |
+| **managed_user_id** | **String** | The managed user the composition was made for, or null when it is your own. List one managed user's compositions with the `managedUserId` or `managedUserExternalId` query parameter of `getAllCompositions`. | [optional] |
+| **direct** | **Boolean** | Whether the widget the composition is made from is drawn straight into the page, without a frame (`true`), or inside a frame (`false`). `null` when the widget has no published version yet. It is a fact about the widget's published version, so every composition of one widget answers the same, and it changes when you publish another version. It cannot be set. Only `getCompositionById` returns it: the other calls that return a composition leave it out, and so does that one on the rare occasion the answer could not be worked out just then (ask again).  | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::Composition.new(
+  id: 123e4567-e89b-12d3-a456-426614174000,
+  creator_id: 123e4567-e89b-12d3-a456-426614174001,
+  widget_id: 123e4567-e89b-12d3-a456-426614174002,
+  name: My Composition,
+  content: {"key":"value"},
+  content_version: 3,
+  status: draft,
+  created_at: 2023-01-01T00:00Z,
+  updated_at: 2023-01-02T00:00Z,
+  embed_settings: {"width":"100%","height":"500px"},
+  design: {"theme":"light","colors":{"primary":"#0066ff"}},
+  database_id: 123e4567-e89b-12d3-a456-426614174003,
+  project_id: 123e4567-e89b-12d3-a456-426614174004,
+  managed_user_id: b7c8d9e0-1f2a-4b3c-8d4e-5f6a7b8c9d0e,
+  direct: true
+)
+```
+

data/docs/CompositionDataSource.md

@@ -0,0 +1,20 @@
+# ApiSdkRb::CompositionDataSource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **url** | **String** | The https address as it was saved, after the checks (a public host, never loopback, link-local or a metadata address) |  |
+| **refresh_seconds** | **Integer** | How often the widget reads the address again, in seconds |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::CompositionDataSource.new(
+  url: https://example.com/data/results.json,
+  refresh_seconds: 60
+)
+```
+

data/docs/CompositionDataSourceResponse.md

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

data/docs/CompositionEntriesDescription.md

@@ -0,0 +1,22 @@
+# ApiSdkRb::CompositionEntriesDescription
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **composition_id** | **String** | The composition whose entries these are |  |
+| **has_data** | **Boolean** | False when the composition keeps no entries of its own: its widget only shows content (it has no database), or nothing was set up in the database yet. That is not an error.  |  |
+| **tables** | [**Array<CompositionEntryTable>**](CompositionEntryTable.md) | The tables entries are kept in (up to 20) |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::CompositionEntriesDescription.new(
+  composition_id: null,
+  has_data: null,
+  tables: null
+)
+```
+

data/docs/CompositionEntriesDescriptionResponse.md

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

data/docs/CompositionEntriesReading.md

@@ -0,0 +1,34 @@
+# ApiSdkRb::CompositionEntriesReading
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **composition_id** | **String** | The composition whose entries these are |  |
+| **table** | **String** | The table that was read |  |
+| **total_rows** | **Integer** | How many entries the table holds in all. Not narrowed by `since`, `until` or a filter: only `aggregates` is.  |  |
+| **tallies** | [**Array<CompositionEntryTally>**](CompositionEntryTally.md) | How many entries have each value of the `groupBy` column, largest group first (up to 20 groups), over the whole table. `null` when no `groupBy` was asked for. For the groups of a selection (a time window, a `context` filter) or for more than 20 groups, ask for `aggregate`: `aggregates.tallies` holds up to 200 groups.  |  |
+| **more_groups** | **Boolean** | True when the `groupBy` column has more than the 20 groups `tallies` lists. It speaks of `tallies` only: `aggregates.truncated` is the same signal for `aggregates` (200 groups).  |  |
+| **columns** | **Array<String>** | The name of each value of an entry in `rows`, in order, exactly as the database spells it (and as `describeCompositionEntries` lists it: `created_at` stays `created_at`). Empty when no entries were asked for, or the table has none.  |  |
+| **rows** | **Array<Array<Object>>** | The newest entries, newest first (up to 25). `null` when no entries were asked for. Each entry is a list of values in the order of `columns`. A value is text (cut to 200 characters), a number, a boolean or `null`.  |  |
+| **more_rows** | **Boolean** | True when the table holds more entries than `rows` lists |  |
+| **aggregates** | [**CompositionEntryAggregatesBlock**](CompositionEntryAggregatesBlock.md) | Only present when the read asked for `aggregate`. Unlike `totalRows`, `tallies` and `rows`, it is narrowed by `since`, `until` and the `context` and column filters of the same call: it answers \"the average rating this week\" where `tallies` answer \"how many of each rating, ever\".  | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::CompositionEntriesReading.new(
+  composition_id: null,
+  table: null,
+  total_rows: 212,
+  tallies: null,
+  more_groups: null,
+  columns: ["id","stars","comment","created_at"],
+  rows: [[5,5,"Loved it","2026-10-05T10:00:00Z"]],
+  more_rows: null,
+  aggregates: null
+)
+```
+

data/docs/CompositionEntriesReadingResponse.md

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

data/docs/CompositionEntryAggregateTally.md

@@ -0,0 +1,28 @@
+# ApiSdkRb::CompositionEntryAggregateTally
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **group** | **String** | The value of the `groupBy` column, as text (a number is `\"5\"`); `null` groups the entries that left it empty. Absent when no `groupBy` was asked for.  | [optional] |
+| **count** | **Integer** | How many entries are in the group (or in the selection) | [optional] |
+| **avg** | **Float** | The average of the numeric `column`, rounded to 4 decimals. `null` when no entry matched: there is no average of nothing, and it is not 0.  | [optional] |
+| **min** | **Float** | The smallest value of the numeric `column`. `null` when no entry matched. | [optional] |
+| **max** | **Float** | The largest value of the numeric `column`. `null` when no entry matched. | [optional] |
+| **sum** | **Float** | The sum of the numeric `column`. `null` when no entry matched. | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::CompositionEntryAggregateTally.new(
+  group: 5,
+  count: 87,
+  avg: 4.2874,
+  min: 1,
+  max: 5,
+  sum: 373
+)
+```
+

data/docs/CompositionEntryAggregatesBlock.md

@@ -0,0 +1,22 @@
+# ApiSdkRb::CompositionEntryAggregatesBlock
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **column** | **String** | The numeric column `avg`, `min`, `max` and `sum` were computed over. An empty text when only `count` was asked for.  |  |
+| **tallies** | [**Array<CompositionEntryAggregateTally>**](CompositionEntryAggregateTally.md) | One tally per value of `groupBy`, in the order of that column (a number as a number, `null` last), up to 200 groups; or ONE tally for the whole selection when no `groupBy` was asked for. Empty when `groupBy` was asked for and no entry matched.  |  |
+| **truncated** | **Boolean** | True when more than 200 groups matched, so `tallies` lists the first 200 in that order. Absent otherwise. (Not to be mixed up with `moreGroups` on the reading, which is about the plain `tallies` of the whole table: those are 20 groups, largest first.)  | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::CompositionEntryAggregatesBlock.new(
+  column: stars,
+  tallies: null,
+  truncated: null
+)
+```
+