ragie_ruby_sdk 1.0.1

data/docs/BetaApi.md

@@ -0,0 +1,363 @@
+# RagieRubySdk::BetaApi
+
+All URIs are relative to *https://api.ragie.ai*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_authenticator**](BetaApi.md#create_authenticator) | **POST** /authenticators | Create Authenticator |
+| [**create_authenticator_connection**](BetaApi.md#create_authenticator_connection) | **POST** /authenticators/{authenticator_id}/connection | Create Authenticator Connection |
+| [**create_connection**](BetaApi.md#create_connection) | **POST** /connection | Create Connection |
+| [**delete_authenticator_connection**](BetaApi.md#delete_authenticator_connection) | **DELETE** /authenticators/{authenticator_id} | Delete Authenticator |
+| [**list_authenticators**](BetaApi.md#list_authenticators) | **GET** /authenticators | List Authenticators |
+
+
+## create_authenticator
+
+> <BaseGetAuthenticator> create_authenticator(payload)
+
+Create Authenticator
+
+Create White labeled connector credentials
+
+### 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::BetaApi.new
+payload = RagieRubySdk::CreateGoogleAuthenticator.new({provider: 'google', name: 'name_example', client_id: 'client_id_example', client_secret: 'client_secret_example'}) # Payload | 
+
+begin
+  # Create Authenticator
+  result = api_instance.create_authenticator(payload)
+  p result
+rescue RagieRubySdk::ApiError => e
+  puts "Error when calling BetaApi->create_authenticator: #{e}"
+end
+```
+
+#### Using the create_authenticator_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<BaseGetAuthenticator>, Integer, Hash)> create_authenticator_with_http_info(payload)
+
+```ruby
+begin
+  # Create Authenticator
+  data, status_code, headers = api_instance.create_authenticator_with_http_info(payload)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <BaseGetAuthenticator>
+rescue RagieRubySdk::ApiError => e
+  puts "Error when calling BetaApi->create_authenticator_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **payload** | [**Payload**](Payload.md) |  |  |
+
+### Return type
+
+[**BaseGetAuthenticator**](BaseGetAuthenticator.md)
+
+### Authorization
+
+[auth](../README.md#auth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## create_authenticator_connection
+
+> <Connection> create_authenticator_connection(authenticator_id, create_authenticator_connection)
+
+Create Authenticator Connection
+
+Create a connector for a given authenticator. This requires credentials dependent on the provider. For google drive it is a refresh token.
+
+### 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::BetaApi.new
+authenticator_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+create_authenticator_connection = RagieRubySdk::CreateAuthenticatorConnection.new({partition_strategy: RagieRubySdk::MediaModeParam.new, connection: RagieRubySdk::AuthenticatorConfluenceConnection.new({provider: 'confluence', data: [RagieRubySdk::ConfluenceData.new({resource_id: 'resource_id_example', space_id: 37, space_key: 'space_key_example', space_name: 'space_name_example'})], credentials: RagieRubySdk::OAuthRefreshTokenCredentials.new({refresh_token: 'refresh_token_example'})})}) # CreateAuthenticatorConnection | 
+
+begin
+  # Create Authenticator Connection
+  result = api_instance.create_authenticator_connection(authenticator_id, create_authenticator_connection)
+  p result
+rescue RagieRubySdk::ApiError => e
+  puts "Error when calling BetaApi->create_authenticator_connection: #{e}"
+end
+```
+
+#### Using the create_authenticator_connection_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Connection>, Integer, Hash)> create_authenticator_connection_with_http_info(authenticator_id, create_authenticator_connection)
+
+```ruby
+begin
+  # Create Authenticator Connection
+  data, status_code, headers = api_instance.create_authenticator_connection_with_http_info(authenticator_id, create_authenticator_connection)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Connection>
+rescue RagieRubySdk::ApiError => e
+  puts "Error when calling BetaApi->create_authenticator_connection_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **authenticator_id** | **String** |  |  |
+| **create_authenticator_connection** | [**CreateAuthenticatorConnection**](CreateAuthenticatorConnection.md) |  |  |
+
+### Return type
+
+[**Connection**](Connection.md)
+
+### Authorization
+
+[auth](../README.md#auth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## create_connection
+
+> <Connection> create_connection(public_create_connection)
+
+Create Connection
+
+Create a connection. This is only for non-oauth connections such as S3 compatible connections, Freshdesk, and Zendesk.
+
+### 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::BetaApi.new
+public_create_connection = RagieRubySdk::PublicCreateConnection.new({partition_strategy: RagieRubySdk::MediaModeParam.new, connection: RagieRubySdk::PublicBackblazeConnection.new({provider: 'backblaze', data: RagieRubySdk::BucketData.new({bucket: 'bucket_example'}), credentials: RagieRubySdk::BackblazeCredentials.new({key_id: 'key_id_example', application_key: 'application_key_example', region: 'region_example', endpoint: 'endpoint_example'})})}) # PublicCreateConnection | 
+
+begin
+  # Create Connection
+  result = api_instance.create_connection(public_create_connection)
+  p result
+rescue RagieRubySdk::ApiError => e
+  puts "Error when calling BetaApi->create_connection: #{e}"
+end
+```
+
+#### Using the create_connection_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Connection>, Integer, Hash)> create_connection_with_http_info(public_create_connection)
+
+```ruby
+begin
+  # Create Connection
+  data, status_code, headers = api_instance.create_connection_with_http_info(public_create_connection)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Connection>
+rescue RagieRubySdk::ApiError => e
+  puts "Error when calling BetaApi->create_connection_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **public_create_connection** | [**PublicCreateConnection**](PublicCreateConnection.md) |  |  |
+
+### Return type
+
+[**Connection**](Connection.md)
+
+### Authorization
+
+[auth](../README.md#auth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_authenticator_connection
+
+> <ResponseOK> delete_authenticator_connection(authenticator_id)
+
+Delete Authenticator
+
+Delete an authenticator. This requires all connections created by that authenticator to be deleted first.
+
+### 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::BetaApi.new
+authenticator_id = '38400000-8cf0-11bd-b23e-10b96e4ef00d' # String | 
+
+begin
+  # Delete Authenticator
+  result = api_instance.delete_authenticator_connection(authenticator_id)
+  p result
+rescue RagieRubySdk::ApiError => e
+  puts "Error when calling BetaApi->delete_authenticator_connection: #{e}"
+end
+```
+
+#### Using the delete_authenticator_connection_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ResponseOK>, Integer, Hash)> delete_authenticator_connection_with_http_info(authenticator_id)
+
+```ruby
+begin
+  # Delete Authenticator
+  data, status_code, headers = api_instance.delete_authenticator_connection_with_http_info(authenticator_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ResponseOK>
+rescue RagieRubySdk::ApiError => e
+  puts "Error when calling BetaApi->delete_authenticator_connection_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **authenticator_id** | **String** |  |  |
+
+### Return type
+
+[**ResponseOK**](ResponseOK.md)
+
+### Authorization
+
+[auth](../README.md#auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_authenticators
+
+> <AuthenticatorList> list_authenticators(opts)
+
+List Authenticators
+
+List all authenticators sorted by created_at in descending order. Results are paginated with a max limit of 100. When more authenticators are available, a `cursor` will be provided. Use the `cursor` parameter to retrieve the subsequent page.
+
+### 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::BetaApi.new
+opts = {
+  cursor: 'cursor_example', # String | An opaque cursor for pagination
+  page_size: 56 # Integer | The number of items per page (must be greater than 0 and less than or equal to 100)
+}
+
+begin
+  # List Authenticators
+  result = api_instance.list_authenticators(opts)
+  p result
+rescue RagieRubySdk::ApiError => e
+  puts "Error when calling BetaApi->list_authenticators: #{e}"
+end
+```
+
+#### Using the list_authenticators_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<AuthenticatorList>, Integer, Hash)> list_authenticators_with_http_info(opts)
+
+```ruby
+begin
+  # List Authenticators
+  data, status_code, headers = api_instance.list_authenticators_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <AuthenticatorList>
+rescue RagieRubySdk::ApiError => e
+  puts "Error when calling BetaApi->list_authenticators_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **cursor** | **String** | An opaque cursor for pagination | [optional] |
+| **page_size** | **Integer** | The number of items per page (must be greater than 0 and less than or equal to 100) | [optional][default to 10] |
+
+### Return type
+
+[**AuthenticatorList**](AuthenticatorList.md)
+
+### Authorization
+
+[auth](../README.md#auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+

data/docs/Body.md

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

data/docs/BodyCreateDocument.md

@@ -0,0 +1,28 @@
+# RagieRubySdk::BodyCreateDocument
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mode** | **String** | Partition strategy for the document. Different strategies exist for textual, audio and video file types and you can set the strategy you want for  each file type, or just for textual types.  For textual documents the options are `'hi_res'` or `'fast'`. When set to `'hi_res'`, images and tables will be extracted from the document. `'fast'` will only extract text. `'fast'` may be up to 20x faster than `'hi_res'`. `hi_res` is only applicable for Word documents, PDFs, Images, and PowerPoints. Images will always be processed in `hi_res`. If `hi_res` is set for an unsupported document type, it will be processed and billed in `fast` mode.  For audio files, the options are true or false. True if you want to process audio, false otherwise.          For video files, the options are `'audio_only'`, `'video_only'`, `'audio_video'`. `'audio_only'` will extract just the audio part of the video. `'video_only'` will similarly just extract the video part, ignoring audio. `'audio_video'` will extract both audio and video.  To process all media types at the highest quality, use `'all'`.  When you specify audio or video stategies, the format must be a JSON object. In this case, textual documents are denoted by the key \"static\". If you omit a key, that document type won't be processd.  See examples below.  Examples  Textual documents only     \"fast\"  Video documents only {     \"video\": \"audio_video\" }  Specify multiple document types {     \"static\": \"hi_res\",     \"audio\": true,     \"video\": \"video_only\" }  Specify only textual or audio document types {     \"static\": \"fast\",     \"audio\": true }  Highest quality processing for all media types     \"all\" | [optional][default to 'fast'] |
+| **metadata** | **String** | 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][default to '{}'] |
+| **file** | **File** | The binary file to upload, extract, and index for retrieval. The following file types are supported: Plain Text: `.eml` `.html` `.json` `.md` `.msg` `.rst` `.rtf` `.txt` `.xml` Images: `.png` `.webp` `.jpg` `.jpeg` `.tiff` `.bmp` `.heic` Documents: `.csv` `.doc` `.docx` `.epub` `.epub+zip` `.odt` `.pdf` `.ppt` `.pptx` `.tsv` `.xlsx` `.xls`. |  |
+| **external_id** | **String** | An optional identifier for the document. A common value might be an id in an external system or the URL where the source file may be found. | [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] |
+| **name** | **String** | An optional name for the document. If set, the document will have this name. Otherwise it will default to the file's name. | [optional] |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::BodyCreateDocument.new(
+  mode: null,
+  metadata: null,
+  file: null,
+  external_id: null,
+  partition: null,
+  name: null
+)
+```
+

data/docs/BodyUpdateDocumentFile.md

@@ -0,0 +1,20 @@
+# RagieRubySdk::BodyUpdateDocumentFile
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **mode** | **String** | Partition strategy for the document. Different strategies exist for textual, audio and video file types and you can set the strategy you want for  each file type, or just for textual types.  For textual documents the options are `'hi_res'` or `'fast'`. When set to `'hi_res'`, images and tables will be extracted from the document. `'fast'` will only extract text. `'fast'` may be up to 20x faster than `'hi_res'`. `hi_res` is only applicable for Word documents, PDFs, Images, and PowerPoints. Images will always be processed in `hi_res`. If `hi_res` is set for an unsupported document type, it will be processed and billed in `fast` mode.  For audio files, the options are true or false. True if you want to process audio, false otherwise.          For video files, the options are `'audio_only'`, `'video_only'`, `'audio_video'`. `'audio_only'` will extract just the audio part of the video. `'video_only'` will similarly just extract the video part, ignoring audio. `'audio_video'` will extract both audio and video.  To process all media types at the highest quality, use `'all'`.  When you specify audio or video stategies, the format must be a JSON object. In this case, textual documents are denoted by the key \"static\". If you omit a key, that document type won't be processd.  See examples below.  Examples  Textual documents only     \"fast\"  Video documents only {     \"video\": \"audio_video\" }  Specify multiple document types {     \"static\": \"hi_res\",     \"audio\": true,     \"video\": \"video_only\" }  Specify only textual or audio document types {     \"static\": \"fast\",     \"audio\": true }  Highest quality processing for all media types     \"all\" | [optional][default to 'fast'] |
+| **file** | **File** | The binary file to upload, extract, and index for retrieval. The following file types are supported: Plain Text: `.eml` `.html` `.json` `.md` `.msg` `.rst` `.rtf` `.txt` `.xml` Images: `.png` `.webp` `.jpg` `.jpeg` `.tiff` `.bmp` `.heic` Documents: `.csv` `.doc` `.docx` `.epub` `.epub+zip` `.odt` `.pdf` `.ppt` `.pptx` `.tsv` `.xlsx` `.xls`. |  |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::BodyUpdateDocumentFile.new(
+  mode: null,
+  file: null
+)
+```
+

data/docs/BucketData.md

@@ -0,0 +1,22 @@
+# RagieRubySdk::BucketData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **bucket** | **String** |  |  |
+| **prefix** | **String** |  | [optional] |
+| **import_file_metadata** | **Boolean** |  | [optional][default to false] |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::BucketData.new(
+  bucket: null,
+  prefix: null,
+  import_file_metadata: null
+)
+```
+

data/docs/ConfluenceData.md

@@ -0,0 +1,24 @@
+# RagieRubySdk::ConfluenceData
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **resource_id** | **String** |  |  |
+| **space_id** | **Integer** |  |  |
+| **space_key** | **String** |  |  |
+| **space_name** | **String** |  |  |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::ConfluenceData.new(
+  resource_id: null,
+  space_id: null,
+  space_key: null,
+  space_name: null
+)
+```
+

data/docs/Connection.md

@@ -0,0 +1,44 @@
+# RagieRubySdk::Connection
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **id** | **String** |  |  |
+| **created_at** | **Time** |  |  |
+| **updated_at** | **Time** |  |  |
+| **metadata** | [**Hash<String, MetadataValue>**](MetadataValue.md) |  |  |
+| **type** | **String** |  |  |
+| **name** | **String** |  |  |
+| **source** | [**Source**](Source.md) |  |  |
+| **enabled** | **Boolean** |  |  |
+| **disabled_by_system_reason** | **String** |  |  |
+| **last_synced_at** | **Time** |  | [optional] |
+| **syncing** | **Boolean** |  | [optional] |
+| **partition** | **String** |  | [optional] |
+| **page_limit** | **Integer** |  |  |
+| **disabled_by_system** | **Boolean** |  | [readonly] |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::Connection.new(
+  id: null,
+  created_at: null,
+  updated_at: null,
+  metadata: null,
+  type: null,
+  name: null,
+  source: null,
+  enabled: null,
+  disabled_by_system_reason: null,
+  last_synced_at: null,
+  syncing: null,
+  partition: null,
+  page_limit: null,
+  disabled_by_system: null
+)
+```
+

data/docs/Connection1.md

@@ -0,0 +1,106 @@
+# RagieRubySdk::Connection1
+
+## Class instance methods
+
+### `openapi_one_of`
+
+Returns the list of classes defined in oneOf.
+
+#### Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+RagieRubySdk::Connection1.openapi_one_of
+# =>
+# [
+#   :'AuthenticatorConfluenceConnection',
+#   :'AuthenticatorDropboxConnection',
+#   :'AuthenticatorGmailConnection',
+#   :'AuthenticatorGoogleDriveConnection',
+#   :'AuthenticatorHubspotConnection',
+#   :'AuthenticatorJiraConnection',
+#   :'AuthenticatorNotionConnection',
+#   :'AuthenticatorOnedriveConnection',
+#   :'AuthenticatorSalesforceConnection',
+#   :'AuthenticatorSharepointConnection',
+#   :'AuthenticatorSlackConnection'
+# ]
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's property name.
+
+#### Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+RagieRubySdk::Connection1.openapi_discriminator_name
+# => :'provider'
+```
+
+### `openapi_discriminator_name`
+
+Returns the discriminator's mapping.
+
+#### Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+RagieRubySdk::Connection1.openapi_discriminator_mapping
+# =>
+# {
+#   :'confluence' => :'AuthenticatorConfluenceConnection',
+#   :'dropbox' => :'AuthenticatorDropboxConnection',
+#   :'gmail' => :'AuthenticatorGmailConnection',
+#   :'google_drive' => :'AuthenticatorGoogleDriveConnection',
+#   :'hubspot' => :'AuthenticatorHubspotConnection',
+#   :'jira' => :'AuthenticatorJiraConnection',
+#   :'notion' => :'AuthenticatorNotionConnection',
+#   :'onedrive' => :'AuthenticatorOnedriveConnection',
+#   :'salesforce' => :'AuthenticatorSalesforceConnection',
+#   :'sharepoint' => :'AuthenticatorSharepointConnection',
+#   :'slack' => :'AuthenticatorSlackConnection'
+# }
+```
+
+### build
+
+Find the appropriate object from the `openapi_one_of` list and casts the data into it.
+
+#### Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+RagieRubySdk::Connection1.build(data)
+# => #<AuthenticatorConfluenceConnection:0x00007fdd4aab02a0>
+
+RagieRubySdk::Connection1.build(data_that_doesnt_match)
+# => nil
+```
+
+#### Parameters
+
+| Name | Type | Description |
+| ---- | ---- | ----------- |
+| **data** | **Mixed** | data to be matched against the list of oneOf items |
+
+#### Return type
+
+- `AuthenticatorConfluenceConnection`
+- `AuthenticatorDropboxConnection`
+- `AuthenticatorGmailConnection`
+- `AuthenticatorGoogleDriveConnection`
+- `AuthenticatorHubspotConnection`
+- `AuthenticatorJiraConnection`
+- `AuthenticatorNotionConnection`
+- `AuthenticatorOnedriveConnection`
+- `AuthenticatorSalesforceConnection`
+- `AuthenticatorSharepointConnection`
+- `AuthenticatorSlackConnection`
+- `nil` (if no type matches)
+