ragie_ruby_sdk 1.0.1

data/docs/ConnectorSource.md

@@ -0,0 +1,15 @@
+# RagieRubySdk::ConnectorSource
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::ConnectorSource.new()
+```
+

data/docs/ConnectorSourceTypeInfo.md

@@ -0,0 +1,24 @@
+# RagieRubySdk::ConnectorSourceTypeInfo
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **source_type** | [**ConnectorSource**](ConnectorSource.md) |  |  |
+| **display_name** | **String** |  |  |
+| **icon_url** | **String** |  |  |
+| **docs_url** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::ConnectorSourceTypeInfo.new(
+  source_type: null,
+  display_name: null,
+  icon_url: null,
+  docs_url: null
+)
+```
+

data/docs/CreateAuthenticatorConnection.md

@@ -0,0 +1,28 @@
+# RagieRubySdk::CreateAuthenticatorConnection
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **partition_strategy** | [**MediaModeParam**](MediaModeParam.md) |  |  |
+| **partition** | **String** |  | [optional] |
+| **page_limit** | **Integer** |  | [optional] |
+| **config** | **Hash<String, Object>** |  | [optional] |
+| **metadata** | [**Hash<String, MetadataValue>**](MetadataValue.md) | Metadata for the document. Keys must be strings. Values may be strings, numbers, booleans, or lists of strings. Numbers may be integers or floating point and will be converted to 64 bit floating point. 1000 total values are allowed. Each item in an array counts towards the total. The following keys are reserved for internal use: `document_id`, `document_type`, `document_source`, `document_name`, `document_uploaded_at`, `start_time`, `end_time`. | [optional] |
+| **connection** | [**Connection1**](Connection1.md) |  |  |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::CreateAuthenticatorConnection.new(
+  partition_strategy: null,
+  partition: null,
+  page_limit: null,
+  config: null,
+  metadata: null,
+  connection: null
+)
+```
+

data/docs/CreateDocumentFromUrlParams.md

@@ -0,0 +1,28 @@
+# RagieRubySdk::CreateDocumentFromUrlParams
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  | [optional] |
+| **metadata** | [**Hash<String, MetadataValue>**](MetadataValue.md) | Metadata for the document. Keys must be strings. Values may be strings, numbers, booleans, or lists of strings. Numbers may be integers or floating point and will be converted to 64 bit floating point. 1000 total values are allowed. Each item in an array counts towards the total. The following keys are reserved for internal use: `document_id`, `document_type`, `document_source`, `document_name`, `document_uploaded_at`, `start_time`, `end_time`. | [optional] |
+| **mode** | [**Mode**](Mode.md) |  | [optional] |
+| **external_id** | **String** |  | [optional] |
+| **partition** | **String** | An optional partition identifier. Documents can be scoped to a partition. Partitions must be lowercase alphanumeric and may only include the special characters `_` and `-`.  A partition is created any time a document is created. | [optional] |
+| **url** | **String** | Url of the file to download. Must be publicly accessible and HTTP or HTTPS scheme. |  |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::CreateDocumentFromUrlParams.new(
+  name: null,
+  metadata: null,
+  mode: null,
+  external_id: null,
+  partition: null,
+  url: null
+)
+```
+

data/docs/CreateDocumentRawParams.md

@@ -0,0 +1,26 @@
+# RagieRubySdk::CreateDocumentRawParams
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | An optional name for the document. If set, the document will have this name. Otherwise it will default to the current timestamp. | [optional] |
+| **metadata** | [**Hash<String, MetadataValue>**](MetadataValue.md) | Metadata for the document. Keys must be strings. Values may be strings, numbers, booleans, or lists of strings. Numbers may be integers or floating point and will be converted to 64 bit floating point. 1000 total values are allowed. Each item in an array counts towards the total. The following keys are reserved for internal use: `document_id`, `document_type`, `document_source`, `document_name`, `document_uploaded_at`, `start_time`, `end_time`. | [optional] |
+| **external_id** | **String** |  | [optional] |
+| **partition** | **String** | An optional partition identifier. Documents can be scoped to a partition. Partitions must be lowercase alphanumeric and may only include the special characters `_` and `-`.  A partition is created any time a document is created. | [optional] |
+| **data** | [**Data**](Data.md) |  |  |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::CreateDocumentRawParams.new(
+  name: null,
+  metadata: null,
+  external_id: null,
+  partition: null,
+  data: null
+)
+```
+

data/docs/CreateGoogleAuthenticator.md

@@ -0,0 +1,28 @@
+# RagieRubySdk::CreateGoogleAuthenticator
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **provider** | **String** |  |  |
+| **name** | **String** | The unique name of your authenticator, used to identify it and distinguish it from others. This name must be unique. Attempting to reuse the same name will result in an error. |  |
+| **client_id** | **String** |  |  |
+| **client_secret** | **String** |  |  |
+| **domain** | **String** |  | [optional] |
+| **project_number** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::CreateGoogleAuthenticator.new(
+  provider: null,
+  name: null,
+  client_id: null,
+  client_secret: null,
+  domain: null,
+  project_number: null
+)
+```
+

data/docs/CreateInstructionParams.md

@@ -0,0 +1,30 @@
+# RagieRubySdk::CreateInstructionParams
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** | The name of the instruction. Must be unique. |  |
+| **active** | **Boolean** | Whether the instruction is active. Active instructions are applied to documents when they're created or when their file is updated. | [optional][default to true] |
+| **scope** | **String** | The scope of the instruction. Determines whether the instruction is applied to the entire document or to each chunk of the document. Options are `'document'` or `'chunk'`. Generally `'document'` should be used when analyzing the full document is desired, such as when generating a summary or determining sentiment, and `'chunk'` should be used when a fine grained search over a document is desired. | [optional][default to 'chunk'] |
+| **prompt** | **String** | A natural language instruction which will be applied to documents as they are created and updated. The results of the `instruction_prompt` will be stored as an `entity` in the schema defined by the `entity_schema` parameter. |  |
+| **entity_schema** | **Hash<String, Object>** |  |  |
+| **filter** | **Hash<String, Object>** | An optional metadata filter that is matched against document metadata during update and creation. The instruction will only be applied to documents with metadata matching the filter.  The following filter operators are supported: $eq - Equal to (number, string, boolean), $ne - Not equal to (number, string, boolean), $gt - Greater than (number), $gte - Greater than or equal to (number), $lt - Less than (number), $lte - Less than or equal to (number), $in - In array (string or number), $nin - Not in array (string or number). The operators can be combined with AND and OR. Read [Metadata & Filters guide](https://docs.ragie.ai/docs/metadata-filters) for more details and examples. | [optional] |
+| **partition** | **String** | An optional partition identifier. Instructions can be scoped to a partition. An instruction that defines a partition will only be executed for documents in that partition. | [optional] |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::CreateInstructionParams.new(
+  name: null,
+  active: null,
+  scope: null,
+  prompt: null,
+  entity_schema: null,
+  filter: null,
+  partition: null
+)
+```
+

data/docs/CreatePartitionParams.md

@@ -0,0 +1,42 @@
+# RagieRubySdk::CreatePartitionParams
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **name** | **String** |  |  |
+| **pages_hosted_limit_monthly** | **Integer** |  | [optional] |
+| **pages_processed_limit_monthly** | **Integer** |  | [optional] |
+| **pages_hosted_limit_max** | **Integer** |  | [optional] |
+| **pages_processed_limit_max** | **Integer** |  | [optional] |
+| **audio_processed_limit_monthly** | **Integer** |  | [optional] |
+| **audio_processed_limit_max** | **Integer** |  | [optional] |
+| **video_processed_limit_monthly** | **Integer** |  | [optional] |
+| **video_processed_limit_max** | **Integer** |  | [optional] |
+| **media_streamed_limit_monthly** | **Integer** |  | [optional] |
+| **media_streamed_limit_max** | **Integer** |  | [optional] |
+| **media_hosted_limit_monthly** | **Integer** |  | [optional] |
+| **media_hosted_limit_max** | **Integer** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::CreatePartitionParams.new(
+  name: null,
+  pages_hosted_limit_monthly: null,
+  pages_processed_limit_monthly: null,
+  pages_hosted_limit_max: null,
+  pages_processed_limit_max: null,
+  audio_processed_limit_monthly: null,
+  audio_processed_limit_max: null,
+  video_processed_limit_monthly: null,
+  video_processed_limit_max: null,
+  media_streamed_limit_monthly: null,
+  media_streamed_limit_max: null,
+  media_hosted_limit_monthly: null,
+  media_hosted_limit_max: null
+)
+```
+

data/docs/Data.md

@@ -0,0 +1,15 @@
+# RagieRubySdk::Data
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::Data.new()
+```
+

data/docs/DefaultApi.md

@@ -0,0 +1,77 @@
+# RagieRubySdk::DefaultApi
+
+All URIs are relative to *https://api.ragie.ai*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**eventevent_post**](DefaultApi.md#eventevent_post) | **POST** /event | Event |
+
+
+## eventevent_post
+
+> Object eventevent_post(body)
+
+Event
+
+When events occur in Ragie such as a document being processed, we'll send this data to URLs that you can register in app. Learn more about webhooks in our docs: https://docs.ragie.ai/docs/webhooks.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ragie_ruby_sdk'
+# setup authorization
+RagieRubySdk.configure do |config|
+  # Configure Bearer authorization: auth
+  config.access_token = 'YOUR_BEARER_TOKEN'
+end
+
+api_instance = RagieRubySdk::DefaultApi.new
+body =  # Body | 
+
+begin
+  # Event
+  result = api_instance.eventevent_post(body)
+  p result
+rescue RagieRubySdk::ApiError => e
+  puts "Error when calling DefaultApi->eventevent_post: #{e}"
+end
+```
+
+#### Using the eventevent_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Object, Integer, Hash)> eventevent_post_with_http_info(body)
+
+```ruby
+begin
+  # Event
+  data, status_code, headers = api_instance.eventevent_post_with_http_info(body)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Object
+rescue RagieRubySdk::ApiError => e
+  puts "Error when calling DefaultApi->eventevent_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **body** | [**Body**](Body.md) |  |  |
+
+### Return type
+
+**Object**
+
+### Authorization
+
+[auth](../README.md#auth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/DeleteConnectionPayload.md

@@ -0,0 +1,18 @@
+# RagieRubySdk::DeleteConnectionPayload
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **keep_files** | **Boolean** |  |  |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::DeleteConnectionPayload.new(
+  keep_files: null
+)
+```
+

data/docs/Document.md

@@ -0,0 +1,36 @@
+# RagieRubySdk::Document
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** |  |  |
+| **id** | **String** |  |  |
+| **created_at** | **Time** |  |  |
+| **updated_at** | **Time** |  |  |
+| **name** | **String** |  |  |
+| **metadata** | [**Hash<String, MetadataValue>**](MetadataValue.md) |  |  |
+| **partition** | **String** |  |  |
+| **chunk_count** | **Integer** |  | [optional] |
+| **external_id** | **String** |  | [optional] |
+| **page_count** | **Float** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::Document.new(
+  status: null,
+  id: null,
+  created_at: null,
+  updated_at: null,
+  name: null,
+  metadata: null,
+  partition: null,
+  chunk_count: null,
+  external_id: null,
+  page_count: null
+)
+```
+

data/docs/DocumentChunk.md

@@ -0,0 +1,26 @@
+# RagieRubySdk::DocumentChunk
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **index** | **Integer** |  | [optional][default to -1] |
+| **text** | **String** |  |  |
+| **metadata** | **Hash<String, Object>** |  | [optional] |
+| **links** | [**Hash<String, Link>**](Link.md) |  |  |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::DocumentChunk.new(
+  id: null,
+  index: null,
+  text: null,
+  metadata: null,
+  links: null
+)
+```
+

data/docs/DocumentChunkDetail.md

@@ -0,0 +1,28 @@
+# RagieRubySdk::DocumentChunkDetail
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **index** | **Integer** |  | [optional][default to -1] |
+| **text** | **String** |  |  |
+| **metadata** | **Hash<String, Object>** |  | [optional] |
+| **links** | [**Hash<String, Link>**](Link.md) |  |  |
+| **modality_data** | [**DocumentChunkDetailModalityData**](DocumentChunkDetailModalityData.md) |  | [optional] |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::DocumentChunkDetail.new(
+  id: null,
+  index: null,
+  text: null,
+  metadata: null,
+  links: null,
+  modality_data: null
+)
+```
+

data/docs/DocumentChunkDetailModalityData.md

@@ -0,0 +1,79 @@
+# RagieRubySdk::DocumentChunkDetailModalityData
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+RagieRubySdk::DocumentChunkDetailModalityData.openapi_one_of
+# =>
+# [
+#   :'AudioModalityData',
+#   :'VideoModalityData'
+# ]
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's property name.
+
+#### Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+RagieRubySdk::DocumentChunkDetailModalityData.openapi_discriminator_name
+# => :'type'
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's mapping.
+
+#### Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+RagieRubySdk::DocumentChunkDetailModalityData.openapi_discriminator_mapping
+# =>
+# {
+#   :'audio' => :'AudioModalityData',
+#   :'video' => :'VideoModalityData'
+# }
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+RagieRubySdk::DocumentChunkDetailModalityData.build(data)
+# => #<AudioModalityData:0x00007fdd4aab02a0>
+
+RagieRubySdk::DocumentChunkDetailModalityData.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `AudioModalityData`
+- `VideoModalityData`
+- `nil` (if no type matches)
+

data/docs/DocumentChunkList.md

@@ -0,0 +1,20 @@
+# RagieRubySdk::DocumentChunkList
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pagination** | [**Pagination**](Pagination.md) |  |  |
+| **chunks** | [**Array<DocumentChunk>**](DocumentChunk.md) |  |  |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::DocumentChunkList.new(
+  pagination: null,
+  chunks: null
+)
+```
+

data/docs/DocumentDelete.md

@@ -0,0 +1,18 @@
+# RagieRubySdk::DocumentDelete
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::DocumentDelete.new(
+  status: null
+)
+```
+

data/docs/DocumentDeleteWebhook.md

@@ -0,0 +1,22 @@
+# RagieRubySdk::DocumentDeleteWebhook
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **nonce** | **String** |  |  |
+| **type** | **String** |  |  |
+| **payload** | [**DocumentDeleteWebhookPayload**](DocumentDeleteWebhookPayload.md) |  |  |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::DocumentDeleteWebhook.new(
+  nonce: null,
+  type: null,
+  payload: null
+)
+```
+

data/docs/DocumentDeleteWebhookPayload.md

@@ -0,0 +1,30 @@
+# RagieRubySdk::DocumentDeleteWebhookPayload
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **document_id** | **String** |  |  |
+| **partition** | **String** |  |  |
+| **metadata** | **Hash<String, Object>** |  |  |
+| **external_id** | **String** |  |  |
+| **name** | **String** |  |  |
+| **connection_id** | **String** |  |  |
+| **sync_id** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::DocumentDeleteWebhookPayload.new(
+  document_id: null,
+  partition: null,
+  metadata: null,
+  external_id: null,
+  name: null,
+  connection_id: null,
+  sync_id: null
+)
+```
+

data/docs/DocumentFileUpdate.md

@@ -0,0 +1,18 @@
+# RagieRubySdk::DocumentFileUpdate
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::DocumentFileUpdate.new(
+  status: null
+)
+```
+

data/docs/DocumentGet.md

@@ -0,0 +1,38 @@
+# RagieRubySdk::DocumentGet
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **status** | **String** |  |  |
+| **id** | **String** |  |  |
+| **created_at** | **Time** |  |  |
+| **updated_at** | **Time** |  |  |
+| **name** | **String** |  |  |
+| **metadata** | [**Hash<String, MetadataValue>**](MetadataValue.md) |  |  |
+| **partition** | **String** |  |  |
+| **chunk_count** | **Integer** |  | [optional] |
+| **external_id** | **String** |  | [optional] |
+| **page_count** | **Float** |  | [optional] |
+| **errors** | **Array<String>** |  |  |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::DocumentGet.new(
+  status: null,
+  id: null,
+  created_at: null,
+  updated_at: null,
+  name: null,
+  metadata: null,
+  partition: null,
+  chunk_count: null,
+  external_id: null,
+  page_count: null,
+  errors: null
+)
+```
+