api-sdk-rb 1.11.66

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/api-sdk-rb.gemspec

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+#Widgetic API Gateway
+
+#API documentation for the Widgetic API Gateway
+
+The version of the OpenAPI document: 1.0.0
+
+Generated by: https://openapi-generator.tech
+Generator version: 7.9.0
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "api-sdk-rb/version"
+
+Gem::Specification.new do |s|
+  s.name        = "api-sdk-rb"
+  s.version     = ApiSdkRb::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Widgetic"]
+  s.email       = ["support@widgetic.com"]
+  s.homepage    = "https://docs.widgetic.com/"
+  s.summary     = "Widgetic API Gateway Ruby Gem"
+  s.description = "API documentation for the Widgetic API Gateway"
+  s.license     = "Nonstandard"
+  s.required_ruby_version = ">= 2.7"
+  s.metadata    = {}
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/docs/AccountCreditBalance.md

@@ -0,0 +1,26 @@
+# ApiSdkRb::AccountCreditBalance
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **user_id** | **String** |  | [optional] |
+| **balance** | **Float** | Credits the account holds | [optional] |
+| **reserved_balance** | **Float** | Credits committed to an operation that is still running. They cannot be spent, so what a new operation can use is `balance - reservedBalance`.  | [optional] |
+| **last_updated** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::AccountCreditBalance.new(
+  id: null,
+  user_id: null,
+  balance: null,
+  reserved_balance: null,
+  last_updated: null
+)
+```
+

data/docs/AccountCreditBalanceResponse.md

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

data/docs/AccountCreditTransaction.md

@@ -0,0 +1,30 @@
+# ApiSdkRb::AccountCreditTransaction
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  | [optional] |
+| **transaction_type** | **String** | What the entry did to the balance. `debit` is credits spent (this is how consumption shows), `credit` and `subscription` are credits added, `refund` returns credits that were spent, `reserve` and `release` move credits in and out of the reserved amount, and `adjustment`, `expiration`, `transfer_out` and `transfer_in` are the remaining ways a balance changes. The list can grow, so treat an unknown type as an entry you do not need to interpret.  | [optional] |
+| **amount** | **Float** | Always positive. The `transactionType` says whether the credits were added or taken. | [optional] |
+| **balance_after** | **Float** | The balance once this entry was applied | [optional] |
+| **description** | **String** |  | [optional] |
+| **reference_id** | **String** | The event the entry belongs to. An entry is recorded once per reference. | [optional] |
+| **created_at** | **Time** |  | [optional] |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::AccountCreditTransaction.new(
+  id: null,
+  transaction_type: null,
+  amount: null,
+  balance_after: null,
+  description: null,
+  reference_id: null,
+  created_at: null
+)
+```
+

data/docs/AdapterConnection.md

@@ -0,0 +1,30 @@
+# ApiSdkRb::AdapterConnection
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **adapter_id** | **String** | The adapter the key is for (its id in the adapter catalog) |  |
+| **adapter_label** | **String** | What the adapter is called to its owner |  |
+| **credential_key** | **String** | The name of the key within the adapter. Use it, with the adapter id, to connect or remove the key |  |
+| **label** | **String** | What the key is called to its owner |  |
+| **scope** | **String** | Who may keep this key. `owner` is the person who made the widget, in their own account. `partner` is a partner, for the widgets of the customers it manages. `owner_or_partner` is either; for a widget of a managed customer the partner's key is used. |  |
+| **connected** | **Boolean** | Whether this account has connected the key |  |
+| **updated_at** | **Time** | When the key was last set. Null when it is not connected |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::AdapterConnection.new(
+  adapter_id: email,
+  adapter_label: Email,
+  credential_key: resendApiKey,
+  label: Resend API key,
+  scope: null,
+  connected: null,
+  updated_at: null
+)
+```
+

data/docs/AdapterConnectionRemoval.md

@@ -0,0 +1,18 @@
+# ApiSdkRb::AdapterConnectionRemoval
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **removed** | **Boolean** | False when the key was not connected, so there was nothing to remove |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::AdapterConnectionRemoval.new(
+  removed: null
+)
+```
+

data/docs/AddAiAnswersKnowledgeDocument201Response.md

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

data/docs/AddAiAnswersKnowledgeDocumentRequest.md

@@ -0,0 +1,20 @@
+# ApiSdkRb::AddAiAnswersKnowledgeDocumentRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **title** | **String** | What the document is called, on one line. Visitors see it as the source of an answer. Line breaks and invisible characters are removed |  |
+| **text** | **String** | The text of the document, as plain text. It is cleaned (line endings are made the same, invisible characters and surplus blank lines are removed) and then counted: up to 100000 characters. Markup is not interpreted, so paste the words, not a web page |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::AddAiAnswersKnowledgeDocumentRequest.new(
+  title: Shipping and returns,
+  text: Orders ship within 2 business days. Returns are accepted for 30 days after delivery, in the original packaging.
+)
+```
+

data/docs/AddDomainRequest.md

@@ -0,0 +1,18 @@
+# ApiSdkRb::AddDomainRequest
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **domain** | **String** | Domain pattern to allow (supports wildcards like *.example.com) |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::AddDomainRequest.new(
+  domain: example.com
+)
+```
+

data/docs/AiAnswersKnowledge.md

@@ -0,0 +1,20 @@
+# ApiSdkRb::AiAnswersKnowledge
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **documents** | [**Array<AiAnswersKnowledgeDocument>**](AiAnswersKnowledgeDocument.md) | Oldest first |  |
+| **totals** | [**AiAnswersKnowledgeTotals**](AiAnswersKnowledgeTotals.md) |  |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::AiAnswersKnowledge.new(
+  documents: null,
+  totals: null
+)
+```
+

data/docs/AiAnswersKnowledgeDocument.md

@@ -0,0 +1,30 @@
+# ApiSdkRb::AiAnswersKnowledgeDocument
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Use it to remove the document |  |
+| **title** | **String** | What the document is called. Visitors see it as the source of an answer, so write it for them |  |
+| **status** | **String** | `ready` documents are used to answer questions. A `processing` document is not: it is being added, or an add was interrupted. Remove one that stays in this state and add it again |  |
+| **char_count** | **Integer** | How many characters of text the document holds, after it was cleaned |  |
+| **chunk_count** | **Integer** | Into how many passages the text was cut. Zero until the document is ready |  |
+| **created_at** | **Time** |  |  |
+| **ready_at** | **Time** | When the document became ready. Null while it is not |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::AiAnswersKnowledgeDocument.new(
+  id: null,
+  title: Shipping and returns,
+  status: null,
+  char_count: 4210,
+  chunk_count: 6,
+  created_at: null,
+  ready_at: null
+)
+```
+

data/docs/AiAnswersKnowledgeRemoval.md

@@ -0,0 +1,18 @@
+# ApiSdkRb::AiAnswersKnowledgeRemoval
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **removed** | **Boolean** | Always true. A document that was not there is a 404 instead |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::AiAnswersKnowledgeRemoval.new(
+  removed: null
+)
+```
+

data/docs/AiAnswersKnowledgeTotals.md

@@ -0,0 +1,24 @@
+# ApiSdkRb::AiAnswersKnowledgeTotals
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **documents** | **Integer** | How many documents the widget has |  |
+| **characters** | **Integer** | How many characters of text they hold in all |  |
+| **max_documents** | **Integer** | The most documents one widget can hold |  |
+| **max_total_chars** | **Integer** | The most characters of text one widget's documents can hold in all |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::AiAnswersKnowledgeTotals.new(
+  documents: null,
+  characters: null,
+  max_documents: 20,
+  max_total_chars: 400000
+)
+```
+

data/docs/ApiKeyScope.md

@@ -0,0 +1,15 @@
+# ApiSdkRb::ApiKeyScope
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::ApiKeyScope.new()
+```
+

data/docs/Canvas.md

@@ -0,0 +1,32 @@
+# ApiSdkRb::Canvas
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** | Unique identifier for the canvas |  |
+| **persistence_key** | **String** | Key used for persistent storage and reference |  |
+| **canvas_content** | **Object** | JSON content of the canvas, containing layout and configuration | [optional] |
+| **creator_id** | **String** | UUID of the user who created the canvas | [optional] |
+| **primary_widget_id** | **String** | Primary widget for My widgets list and canvas-only deep-link (Convert per shape may add secondary widgets on the same canvas) | [optional] |
+| **managed_user_id** | **String** | The managed user the canvas was made for (Widgetic's id for the user); null for a canvas that is the account's own. | [optional] |
+| **created_at** | **Time** | Timestamp when the canvas was created |  |
+| **updated_at** | **Time** | Timestamp when the canvas was last updated |  |
+
+## Example
+
+```ruby
+require 'api-sdk-rb'
+
+instance = ApiSdkRb::Canvas.new(
+  id: 123e4567-e89b-12d3-a456-426614174000,
+  persistence_key: canvas_xyz123,
+  canvas_content: {"version":1,"elements":[],"settings":{}},
+  creator_id: null,
+  primary_widget_id: 123e4567-e89b-12d3-a456-426614174099,
+  managed_user_id: 123e4567-e89b-12d3-a456-426614174077,
+  created_at: 2023-01-01T00:00Z,
+  updated_at: 2023-01-02T00:00Z
+)
+```
+

data/docs/CanvasResponse.md

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