ragie_ruby_sdk 1.0.1

data/docs/PartitionLimitResetWebhook.md

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

data/docs/PartitionLimitResetWebhookPayload.md

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

data/docs/PartitionLimits.md

@@ -0,0 +1,40 @@
+# RagieRubySdk::PartitionLimits
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pages_processed_limit_monthly** | **Integer** |  | [optional] |
+| **pages_hosted_limit_monthly** | **Integer** |  | [optional] |
+| **pages_processed_limit_max** | **Integer** |  | [optional] |
+| **pages_hosted_limit_max** | **Integer** |  | [optional] |
+| **video_processed_limit_monthly** | **Integer** |  | [optional] |
+| **video_processed_limit_max** | **Integer** |  | [optional] |
+| **audio_processed_limit_monthly** | **Integer** |  | [optional] |
+| **audio_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::PartitionLimits.new(
+  pages_processed_limit_monthly: null,
+  pages_hosted_limit_monthly: null,
+  pages_processed_limit_max: null,
+  pages_hosted_limit_max: null,
+  video_processed_limit_monthly: null,
+  video_processed_limit_max: null,
+  audio_processed_limit_monthly: null,
+  audio_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/PartitionList.md

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

data/docs/PartitionStats.md

@@ -0,0 +1,42 @@
+# RagieRubySdk::PartitionStats
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **pages_processed_monthly** | **Float** | Number of pages processed in the current month in this partition. |  |
+| **pages_hosted_monthly** | **Float** | Number of hosted pages added in the current month in this partition. |  |
+| **pages_processed_total** | **Float** | Total number of pages processed in this partition. |  |
+| **pages_hosted_total** | **Float** | Total number of hosted pages in this partition. |  |
+| **document_count** | **Integer** | Total number of documents, inclusive of all files types, in this partition. |  |
+| **video_processed_monthly** | **Float** | Total number of seconds of video processed in the current month in this partition. |  |
+| **video_processed_total** | **Float** | Total number of seconds of video processed in this partition. |  |
+| **audio_processed_monthly** | **Float** | Total number of seconds of audio processed in the current month in this partition. |  |
+| **audio_processed_total** | **Float** | Total number of seconds of audio processed in this partition. |  |
+| **media_streamed_monthly** | **Float** | Total number of MBs streamed in the current month in this partition. |  |
+| **media_streamed_total** | **Float** | Total number of MBs streamed in this partition. |  |
+| **media_hosted_monthly** | **Float** | Total number of MBs hosted in the current month in this partition. |  |
+| **media_hosted_total** | **Float** | Total number of MBs hosted in this partition. |  |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::PartitionStats.new(
+  pages_processed_monthly: null,
+  pages_hosted_monthly: null,
+  pages_processed_total: null,
+  pages_hosted_total: null,
+  document_count: null,
+  video_processed_monthly: null,
+  video_processed_total: null,
+  audio_processed_monthly: null,
+  audio_processed_total: null,
+  media_streamed_monthly: null,
+  media_streamed_total: null,
+  media_hosted_monthly: null,
+  media_hosted_total: null
+)
+```
+

data/docs/PartitionStrategy.md

@@ -0,0 +1,22 @@
+# RagieRubySdk::PartitionStrategy
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **static** | **String** |  | [optional] |
+| **audio** | **Boolean** |  | [optional] |
+| **video** | **String** |  | [optional] |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::PartitionStrategy.new(
+  static: null,
+  audio: null,
+  video: null
+)
+```
+

data/docs/PartitionsApi.md

@@ -0,0 +1,363 @@
+# RagieRubySdk::PartitionsApi
+
+All URIs are relative to *https://api.ragie.ai*
+
+| Method | HTTP request | Description |
+| ------ | ------------ | ----------- |
+| [**create_partition_partitions_post**](PartitionsApi.md#create_partition_partitions_post) | **POST** /partitions | Create Partition |
+| [**delete_partition_partitions_partition_id_delete**](PartitionsApi.md#delete_partition_partitions_partition_id_delete) | **DELETE** /partitions/{partition_id} | Delete Partition |
+| [**get_partition_partitions_partition_id_get**](PartitionsApi.md#get_partition_partitions_partition_id_get) | **GET** /partitions/{partition_id} | Get Partition |
+| [**list_partitions_partitions_get**](PartitionsApi.md#list_partitions_partitions_get) | **GET** /partitions | List Partitions |
+| [**set_partition_limits_partitions_partition_id_limits_put**](PartitionsApi.md#set_partition_limits_partitions_partition_id_limits_put) | **PUT** /partitions/{partition_id}/limits | Set Partition Limits |
+
+
+## create_partition_partitions_post
+
+> <Partition> create_partition_partitions_post(create_partition_params)
+
+Create Partition
+
+Create a new partition. Partitions are used to scope documents, connections, and instructions. Partitions must be lowercase alphanumeric and may only include the special characters `_` and `-`. A partition may also be created by creating a document in it. Limits for a partition may optionally be defined when creating.
+
+### 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::PartitionsApi.new
+create_partition_params = RagieRubySdk::CreatePartitionParams.new({name: 'name_example'}) # CreatePartitionParams | 
+
+begin
+  # Create Partition
+  result = api_instance.create_partition_partitions_post(create_partition_params)
+  p result
+rescue RagieRubySdk::ApiError => e
+  puts "Error when calling PartitionsApi->create_partition_partitions_post: #{e}"
+end
+```
+
+#### Using the create_partition_partitions_post_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<Partition>, Integer, Hash)> create_partition_partitions_post_with_http_info(create_partition_params)
+
+```ruby
+begin
+  # Create Partition
+  data, status_code, headers = api_instance.create_partition_partitions_post_with_http_info(create_partition_params)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <Partition>
+rescue RagieRubySdk::ApiError => e
+  puts "Error when calling PartitionsApi->create_partition_partitions_post_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **create_partition_params** | [**CreatePartitionParams**](CreatePartitionParams.md) |  |  |
+
+### Return type
+
+[**Partition**](Partition.md)
+
+### Authorization
+
+[auth](../README.md#auth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_partition_partitions_partition_id_delete
+
+> Hash&lt;String, String&gt; delete_partition_partitions_partition_id_delete(partition_id)
+
+Delete Partition
+
+Deletes a partition and all of its associated data. This includes connections, documents, and partition specific instructions. This operation is irreversible.
+
+### 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::PartitionsApi.new
+partition_id = 'partition_id_example' # String | 
+
+begin
+  # Delete Partition
+  result = api_instance.delete_partition_partitions_partition_id_delete(partition_id)
+  p result
+rescue RagieRubySdk::ApiError => e
+  puts "Error when calling PartitionsApi->delete_partition_partitions_partition_id_delete: #{e}"
+end
+```
+
+#### Using the delete_partition_partitions_partition_id_delete_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(Hash&lt;String, String&gt;, Integer, Hash)> delete_partition_partitions_partition_id_delete_with_http_info(partition_id)
+
+```ruby
+begin
+  # Delete Partition
+  data, status_code, headers = api_instance.delete_partition_partitions_partition_id_delete_with_http_info(partition_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => Hash&lt;String, String&gt;
+rescue RagieRubySdk::ApiError => e
+  puts "Error when calling PartitionsApi->delete_partition_partitions_partition_id_delete_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **partition_id** | **String** |  |  |
+
+### Return type
+
+**Hash&lt;String, String&gt;**
+
+### Authorization
+
+[auth](../README.md#auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_partition_partitions_partition_id_get
+
+> <PartitionDetail> get_partition_partitions_partition_id_get(partition_id)
+
+Get Partition
+
+Get a partition by its ID. Includes usage information such as the number of documents and pages hosted and processed. The partition's limits are also included.
+
+### 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::PartitionsApi.new
+partition_id = 'partition_id_example' # String | 
+
+begin
+  # Get Partition
+  result = api_instance.get_partition_partitions_partition_id_get(partition_id)
+  p result
+rescue RagieRubySdk::ApiError => e
+  puts "Error when calling PartitionsApi->get_partition_partitions_partition_id_get: #{e}"
+end
+```
+
+#### Using the get_partition_partitions_partition_id_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PartitionDetail>, Integer, Hash)> get_partition_partitions_partition_id_get_with_http_info(partition_id)
+
+```ruby
+begin
+  # Get Partition
+  data, status_code, headers = api_instance.get_partition_partitions_partition_id_get_with_http_info(partition_id)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PartitionDetail>
+rescue RagieRubySdk::ApiError => e
+  puts "Error when calling PartitionsApi->get_partition_partitions_partition_id_get_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **partition_id** | **String** |  |  |
+
+### Return type
+
+[**PartitionDetail**](PartitionDetail.md)
+
+### Authorization
+
+[auth](../README.md#auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## list_partitions_partitions_get
+
+> <PartitionList> list_partitions_partitions_get(opts)
+
+List Partitions
+
+List all partitions sorted by name in ascending order. Results are paginated with a max limit of 100. When more partitions 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::PartitionsApi.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 Partitions
+  result = api_instance.list_partitions_partitions_get(opts)
+  p result
+rescue RagieRubySdk::ApiError => e
+  puts "Error when calling PartitionsApi->list_partitions_partitions_get: #{e}"
+end
+```
+
+#### Using the list_partitions_partitions_get_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PartitionList>, Integer, Hash)> list_partitions_partitions_get_with_http_info(opts)
+
+```ruby
+begin
+  # List Partitions
+  data, status_code, headers = api_instance.list_partitions_partitions_get_with_http_info(opts)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PartitionList>
+rescue RagieRubySdk::ApiError => e
+  puts "Error when calling PartitionsApi->list_partitions_partitions_get_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
+
+[**PartitionList**](PartitionList.md)
+
+### Authorization
+
+[auth](../README.md#auth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## set_partition_limits_partitions_partition_id_limits_put
+
+> <PartitionDetail> set_partition_limits_partitions_partition_id_limits_put(partition_id, partition_limit_params)
+
+Set Partition Limits
+
+Sets limits on a partition. Limits can be set on the total number of pages a partition can host and process. When the limit is reached, the partition will be disabled. A limit may be removed by setting it to `null`.
+
+### 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::PartitionsApi.new
+partition_id = 'partition_id_example' # String | 
+partition_limit_params = RagieRubySdk::PartitionLimitParams.new # PartitionLimitParams | 
+
+begin
+  # Set Partition Limits
+  result = api_instance.set_partition_limits_partitions_partition_id_limits_put(partition_id, partition_limit_params)
+  p result
+rescue RagieRubySdk::ApiError => e
+  puts "Error when calling PartitionsApi->set_partition_limits_partitions_partition_id_limits_put: #{e}"
+end
+```
+
+#### Using the set_partition_limits_partitions_partition_id_limits_put_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<PartitionDetail>, Integer, Hash)> set_partition_limits_partitions_partition_id_limits_put_with_http_info(partition_id, partition_limit_params)
+
+```ruby
+begin
+  # Set Partition Limits
+  data, status_code, headers = api_instance.set_partition_limits_partitions_partition_id_limits_put_with_http_info(partition_id, partition_limit_params)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <PartitionDetail>
+rescue RagieRubySdk::ApiError => e
+  puts "Error when calling PartitionsApi->set_partition_limits_partitions_partition_id_limits_put_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **partition_id** | **String** |  |  |
+| **partition_limit_params** | [**PartitionLimitParams**](PartitionLimitParams.md) |  |  |
+
+### Return type
+
+[**PartitionDetail**](PartitionDetail.md)
+
+### Authorization
+
+[auth](../README.md#auth)
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+

data/docs/PatchDocumentMetadataParams.md

@@ -0,0 +1,20 @@
+# RagieRubySdk::PatchDocumentMetadataParams
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **metadata** | **Hash<String, Object>** | The metadata to update on the document. Performs a partial update of the document's metadata. 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. Keys set to `null` are deleted. 1000 total values are allowed, inclusive of existing metadata. 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`. If the document is managed by a connection, this operation will extend a metadata overlay which is applied to the document any time the connection syncs the document. |  |
+| **async** | **Boolean** | Whether to run the metadata update asynchronously. If true, the metadata update will be run in the background and the response will be 202. If false, the metadata update will be run synchronously and the response will be 200. | [optional][default to false] |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::PatchDocumentMetadataParams.new(
+  metadata: null,
+  async: null
+)
+```
+

data/docs/Payload.md

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

data/docs/PublicBackblazeConnection.md

@@ -0,0 +1,22 @@
+# RagieRubySdk::PublicBackblazeConnection
+
+## Properties
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **provider** | **String** |  |  |
+| **data** | [**BucketData**](BucketData.md) |  |  |
+| **credentials** | [**BackblazeCredentials**](BackblazeCredentials.md) |  |  |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::PublicBackblazeConnection.new(
+  provider: null,
+  data: null,
+  credentials: null
+)
+```
+

data/docs/PublicCreateConnection.md

@@ -0,0 +1,28 @@
+# RagieRubySdk::PublicCreateConnection
+
+## 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** | [**Connection2**](Connection2.md) |  |  |
+
+## Example
+
+```ruby
+require 'ragie_ruby_sdk'
+
+instance = RagieRubySdk::PublicCreateConnection.new(
+  partition_strategy: null,
+  partition: null,
+  page_limit: null,
+  config: null,
+  metadata: null,
+  connection: null
+)
+```
+