api-sdk-rb 1.11.66

data/docs/GetPartnerCreditTransactions200Response.md

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

data/docs/GetPartnerDesignDefaults200Response.md

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

data/docs/GetPartnerEntitlementsResponse.md

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

data/docs/GetPartnerEntitlementsResponseData.md

@@ -0,0 +1,20 @@
+# ApiSdkRb::GetPartnerEntitlementsResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **partner_id** | **String** |  | [optional] |
+| **entitlements** | [**Array<Entitlement>**](Entitlement.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::GetPartnerEntitlementsResponseData.new(
+  partner_id: 123e4567-e89b-12d3-a456-426614174002,
+  entitlements: null
+)
+```
+

data/docs/GetPersonalWorkspaceDomains200Response.md

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

data/docs/GetPublicCompositionEmbed200Response.md

@@ -0,0 +1,46 @@
+# ApiSdkRb::GetPublicCompositionEmbed200Response
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **composition_id** | **String** |  | [optional] |
+| **widget_id** | **String** |  | [optional] |
+| **version** | **Integer** |  | [optional] |
+| **widget_version** | **Integer** | Published widget version on the CDN artifact this composition uses. | [optional] |
+| **player_version** | **Integer** | Version of the player: the gateway frame wrapper that shows the widget, and the host bridge it speaks with the embedding page and the widget (currently 4). Raised when the messages between page, frame, and widget change in a way a widget could notice, such as a new `widgetic:host` field or a new forwarded event (2 added `entries`, 3 added `adapters`, 4 added `entries.writeToken`). It is not `widgetVersion` (the version of the published widget) and not the `version` inside a `widgetic:host` message. | [optional] |
+| **data_source** | [**GetPublicCompositionEmbed200ResponseDataSource**](GetPublicCompositionEmbed200ResponseDataSource.md) |  | [optional] |
+| **embed_url** | **String** |  | [optional] |
+| **entry_write_token** | **String** | Signed per-composition write token for `POST /embed/compositions/{compositionId}/entries/{table}`, also handed to the widget inside `widgetic:host` as `entries.writeToken`. | [optional] |
+| **width** | **Integer** |  | [optional] |
+| **height** | **Integer** |  | [optional] |
+| **design** | **Object** |  | [optional] |
+| **content** | **Object** |  | [optional] |
+| **content_items** | **Array<Hash<String, Object>>** |  | [optional] |
+| **iframe_allow** | **String** | The browser features the widget needs the iframe that shows it to be allowed to use, as the value of that iframe's `allow` attribute (for example `camera; microphone`; the words are `camera`, `display-capture` and `microphone`). Present only for a widget that uses a module that needs one, and absent for every other widget. A page that embeds the frame itself copies it onto its own iframe (`allow=\"...\"`); a page that does not leaves the widget to say, in its own words, that the feature is blocked there. The frame wrapper already passes it on to the iframe it holds. | [optional] |
+| **direct** | [**GetPublicCompositionEmbed200ResponseDirect**](GetPublicCompositionEmbed200ResponseDirect.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::GetPublicCompositionEmbed200Response.new(
+  composition_id: null,
+  widget_id: null,
+  version: null,
+  widget_version: null,
+  player_version: null,
+  data_source: null,
+  embed_url: null,
+  entry_write_token: null,
+  width: null,
+  height: null,
+  design: null,
+  content: null,
+  content_items: null,
+  iframe_allow: camera; microphone,
+  direct: null
+)
+```
+

data/docs/GetPublicCompositionEmbed200ResponseDataSource.md

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

data/docs/GetPublicCompositionEmbed200ResponseDirect.md

@@ -0,0 +1,22 @@
+# ApiSdkRb::GetPublicCompositionEmbed200ResponseDirect
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **module_url** | **String** |  | [optional] |
+| **contract_version** | **Integer** |  | [optional] |
+| **module_hash** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::GetPublicCompositionEmbed200ResponseDirect.new(
+  module_url: null,
+  contract_version: null,
+  module_hash: null
+)
+```
+

data/docs/GetUserAdapterConnections200Response.md

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

data/docs/GetUserApiKeyUsageLogsResponse.md

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

data/docs/GetUserApiKeyUsageLogsResponseData.md

@@ -0,0 +1,18 @@
+# ApiSdkRb::GetUserApiKeyUsageLogsResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **logs** | [**Array<UserApiKeyUsageLog>**](UserApiKeyUsageLog.md) |  |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::GetUserApiKeyUsageLogsResponseData.new(
+  logs: null
+)
+```
+

data/docs/GetUserApiKeys200Response.md

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

data/docs/GetWidgets200Response.md

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

data/docs/GetWidgetsBatchRequest.md

@@ -0,0 +1,18 @@
+# ApiSdkRb::GetWidgetsBatchRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **widget_ids** | **Array<String>** |  |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::GetWidgetsBatchRequest.new(
+  widget_ids: null
+)
+```
+

data/docs/GetWidgetsBatchResponse.md

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

data/docs/GetWidgetsBatchResponseData.md

@@ -0,0 +1,20 @@
+# ApiSdkRb::GetWidgetsBatchResponseData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **widgets** | [**Array<Widget>**](Widget.md) |  | [optional] |
+| **errors** | [**Array<GetWidgetsBatchResponseDataErrorsInner>**](GetWidgetsBatchResponseDataErrorsInner.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::GetWidgetsBatchResponseData.new(
+  widgets: null,
+  errors: null
+)
+```
+

data/docs/GetWidgetsBatchResponseDataErrorsInner.md

@@ -0,0 +1,20 @@
+# ApiSdkRb::GetWidgetsBatchResponseDataErrorsInner
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **error** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::GetWidgetsBatchResponseDataErrorsInner.new(
+  id: null,
+  error: null
+)
+```
+

data/docs/InvoicesApi.md

@@ -0,0 +1,85 @@
+# ApiSdkRb::InvoicesApi
+
+All URIs are relative to *https://api.widgetic.com/v1*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**get_invoices_by_partner_id_0**](InvoicesApi.md#get_invoices_by_partner_id_0) | **GET** /invoices/partner/{partnerId} | List a partner's invoices |
+
+
+## get_invoices_by_partner_id_0
+
+> <GetInvoicesByPartnerId200Response> get_invoices_by_partner_id_0(partner_id, opts)
+
+List a partner's invoices
+
+Lists the invoices issued to a partner, newest first. Each carries the price (`subtotal`), the tax on it (`taxAmount`) and what is paid (`total`), its status as the payment provider reports it, why the last payment failed (`failureReason`), and the page where it is paid (`hostedInvoiceUrl`).  A partner reads its own: the caller must be the person who administers the partner (an API key of that account works), and anyone else is refused with 403 whether or not the partner exists. Widgetic administrators can read any partner's and see exactly what the partner sees; the full records, with the internal fields, are `getAllInvoices` filtered by partner.  The page is always bounded: `limit` defaults to 50 and is capped at 100, `offset` defaults to 0. 
+
+### 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::InvoicesApi.new
+partner_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | The partner whose invoices to list
+opts = {
+  status: 'draft', # String | Only invoices with this status
+  limit: 56, # Integer | Maximum number of invoices to return
+  offset: 56 # Integer | Number of invoices to skip
+}
+
+begin
+  # List a partner's invoices
+  result = api_instance.get_invoices_by_partner_id_0(partner_id, opts)
+  p result
+rescue ApiSdkRb::ApiError => e
+  puts "Error when calling InvoicesApi->get_invoices_by_partner_id_0: #{e}"
+end
+```
+
+#### Using the get_invoices_by_partner_id_0_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<GetInvoicesByPartnerId200Response>, Integer, Hash)> get_invoices_by_partner_id_0_with_http_info(partner_id, opts)
+
+```ruby
+begin
+  # List a partner's invoices
+  data, status_code, headers = api_instance.get_invoices_by_partner_id_0_with_http_info(partner_id, opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <GetInvoicesByPartnerId200Response>
+rescue ApiSdkRb::ApiError => e
+  puts "Error when calling InvoicesApi->get_invoices_by_partner_id_0_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **partner_id** | **String** | The partner whose invoices to list |  |
+| **status** | **String** | Only invoices with this status | [optional] |
+| **limit** | **Integer** | Maximum number of invoices to return | [optional][default to 50] |
+| **offset** | **Integer** | Number of invoices to skip | [optional][default to 0] |
+
+### Return type
+
+[**GetInvoicesByPartnerId200Response**](GetInvoicesByPartnerId200Response.md)
+
+### Authorization
+
+[apiKeyAuth](../README.md#apiKeyAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/ListPartnerPresets200Response.md

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

data/docs/ManagedUser.md

@@ -0,0 +1,30 @@
+# ApiSdkRb::ManagedUser
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique identifier for the managed user |  |
+| **manager_id** | **String** | ID of the user who manages this managed user |  |
+| **external_id** | **String** | Your own identifier for the managed user. Unique among the managed users you manage (two different partners may use the same value). |  |
+| **metadata** | **Object** | Additional metadata for the managed user | [optional] |
+| **is_active** | **Boolean** | Whether new compositions, widgets and uploads can be filed under this managed user. `false` means it has been switched off (`updateManagedUser` with `is_active: false`): what it already has stays, and filing anything new under it answers `409 MANAGED_USER_INACTIVE`. A record from before the switch existed may answer `null`, which counts as on.  | [optional] |
+| **created_at** | **Time** | Timestamp when the managed user was created |  |
+| **updated_at** | **Time** | Timestamp when the managed user was last updated |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::ManagedUser.new(
+  id: 123e4567-e89b-12d3-a456-426614174000,
+  manager_id: 123e4567-e89b-12d3-a456-426614174001,
+  external_id: external-user-123,
+  metadata: {"firstName":"John","lastName":"Doe","role":"editor"},
+  is_active: true,
+  created_at: 2023-01-01T00:00Z,
+  updated_at: 2023-01-02T00:00Z
+)
+```
+

data/docs/ManagedUserEntriesMeta.md

@@ -0,0 +1,26 @@
+# ApiSdkRb::ManagedUserEntriesMeta
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **next_cursor** | **String** |  |  |
+| **total** | **Integer** |  |  |
+| **compositions_considered** | **Integer** |  |  |
+| **more_compositions** | **Boolean** |  |  |
+| **partial** | **Boolean** |  | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::ManagedUserEntriesMeta.new(
+  next_cursor: null,
+  total: null,
+  compositions_considered: null,
+  more_compositions: null,
+  partial: null
+)
+```
+

data/docs/ManagedUserEntriesPageSuccess.md

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

data/docs/ManagedUserEntryItem.md

@@ -0,0 +1,30 @@
+# ApiSdkRb::ManagedUserEntryItem
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **values** | **Hash<String, Object>** |  |  |
+| **context** | **Hash<String, Object>** | The host context the entry was stored with: what the embedding page passed in, without the two keys of a signature (`widgetic_exp` and `widgetic_sig`), which are checked when the entry comes in and are never stored. |  |
+| **created_at** | **Time** |  |  |
+| **truncated_columns** | **Array<String>** | The columns whose value was cut: a value longer than 20,000 characters is cut there (a JSON value is cut as text, so it comes back as a string and no longer as an object), and its column is named here. Absent when nothing was cut.  | [optional] |
+| **composition_id** | **String** |  |  |
+| **table** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::ManagedUserEntryItem.new(
+  id: null,
+  values: null,
+  context: null,
+  created_at: null,
+  truncated_columns: null,
+  composition_id: null,
+  table: null
+)
+```
+

data/docs/ManagedUserLimits.md

@@ -0,0 +1,24 @@
+# ApiSdkRb::ManagedUserLimits
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **monthly_credits** | **Integer** | The cap, or null when there is no monthly cap |  |
+| **credits_used_this_month** | **Integer** |  |  |
+| **credits_left_this_month** | **Integer** |  |  |
+| **resets_at** | **Time** | First instant of the next UTC calendar month |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::ManagedUserLimits.new(
+  monthly_credits: null,
+  credits_used_this_month: null,
+  credits_left_this_month: null,
+  resets_at: null
+)
+```
+

data/docs/ManagedUserOperationUsage.md

@@ -0,0 +1,26 @@
+# ApiSdkRb::ManagedUserOperationUsage
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **operation** | **String** | The metered operation, as the credit ledger names it |  |
+| **calls** | **Integer** | How many runs of the operation were paid for and kept (a run that was refunded is not one) |  |
+| **credits** | **Integer** | The credits those runs took from your account |  |
+| **refunded_calls** | **Integer** | How many runs were refunded (a generation that failed), and so are not in `calls` |  |
+| **refunded_credits** | **Integer** | The credits the refunded runs took, which went back to your account |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::ManagedUserOperationUsage.new(
+  operation: agent.code.generate,
+  calls: null,
+  credits: null,
+  refunded_calls: null,
+  refunded_credits: null
+)
+```
+