ddr_client 2.0.0.d9f2bd2b

data/docs/IndexApi.md

@@ -0,0 +1,161 @@
+# DdrClient::IndexApi
+
+All URIs are relative to *https://example.org/api*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_index_id**](IndexApi.md#delete_index_id) | **DELETE** /index/{id} | 
+[**get_index_id**](IndexApi.md#get_index_id) | **GET** /index/{id} | 
+[**get_index_schema**](IndexApi.md#get_index_schema) | **GET** /index/schema | 
+
+
+# **delete_index_id**
+> delete_index_id(id)
+
+
+
+Delete a document
+
+### Example
+```ruby
+# load the gem
+require 'ddr_client'
+# setup authorization
+DdrClient.configure do |config|
+  # Configure API key authorization: oauth
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = DdrClient::IndexApi.new
+
+id = 'id_example' # String | 
+
+
+begin
+  api_instance.delete_index_id(id)
+rescue DdrClient::ApiError => e
+  puts "Exception when calling IndexApi->delete_index_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_index_id**
+> get_index_id(id)
+
+
+
+Retrieve a document
+
+### Example
+```ruby
+# load the gem
+require 'ddr_client'
+# setup authorization
+DdrClient.configure do |config|
+  # Configure API key authorization: oauth
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = DdrClient::IndexApi.new
+
+id = 'id_example' # String | 
+
+
+begin
+  api_instance.get_index_id(id)
+rescue DdrClient::ApiError => e
+  puts "Exception when calling IndexApi->get_index_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_index_schema**
+> get_index_schema
+
+
+
+Retrieve the index schema
+
+### Example
+```ruby
+# load the gem
+require 'ddr_client'
+# setup authorization
+DdrClient.configure do |config|
+  # Configure API key authorization: oauth
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = DdrClient::IndexApi.new
+
+begin
+  api_instance.get_index_schema
+rescue DdrClient::ApiError => e
+  puts "Exception when calling IndexApi->get_index_schema: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/PatchResources.md

@@ -0,0 +1,11 @@
+# DdrClient::PatchResources
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**optimistic_lock_token** | **String** | Optimistic lock token | 
+**metadata** | [**PatchResourcesMetadata**](PatchResourcesMetadata.md) |  | [optional] 
+**related** | [**PatchResourcesRelated**](PatchResourcesRelated.md) |  | [optional] 
+**roles** | [**Array<PatchResourcesRoles>**](PatchResourcesRoles.md) | Role-based access control assertions on the resource | [optional] 
+
+

data/docs/PatchResourcesMetadata.md

@@ -0,0 +1,62 @@
+# DdrClient::PatchResourcesMetadata
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**abstract** | **String** | http://purl.org/dc/terms/abstract | [optional] 
+**access_rights** | **String** | http://purl.org/dc/terms/accessRights | [optional] 
+**alternative** | **String** | http://purl.org/dc/terms/alternative | [optional] 
+**available** | **String** | http://purl.org/dc/terms/available | [optional] 
+**contributor** | **String** | http://purl.org/dc/terms/contributor | [optional] 
+**creator** | **String** | http://purl.org/dc/terms/creator | [optional] 
+**date** | **String** | http://purl.org/dc/terms/date | [optional] 
+**description** | **String** | http://purl.org/dc/terms/description | [optional] 
+**extent** | **String** | http://purl.org/dc/terms/extent | [optional] 
+**format** | **String** | http://purl.org/dc/terms/format | [optional] 
+**has_part** | **String** | http://purl.org/dc/terms/hasPart | [optional] 
+**identifier** | **String** | http://purl.org/dc/terms/identifier | [optional] 
+**is_format_of** | **String** | http://purl.org/dc/terms/isFormatOf | [optional] 
+**is_part_of** | **String** | http://purl.org/dc/terms/isPartOf | [optional] 
+**language** | **String** | http://purl.org/dc/terms/language | [optional] 
+**medium** | **String** | http://purl.org/dc/terms/medium | [optional] 
+**provenance** | **String** | http://purl.org/dc/terms/provenance | [optional] 
+**publisher** | **String** | http://purl.org/dc/terms/publisher | [optional] 
+**relation** | **String** | http://purl.org/dc/terms/relation | [optional] 
+**rights** | **String** | http://purl.org/dc/terms/rights | [optional] 
+**spatial** | **String** | http://purl.org/dc/terms/spatial | [optional] 
+**subject** | **String** | http://purl.org/dc/terms/subject | [optional] 
+**title** | **String** | http://purl.org/dc/terms/title | [optional] 
+**type** | **String** | http://purl.org/dc/terms/type | [optional] 
+**admin_set** | **String** | Administrative group to which the collection belongs | [optional] 
+**aleph_id** | **String** | Aleph identifier | [optional] 
+**aspace_id** | **String** | ArchivesSpace identifier | [optional] 
+**contentdm_id** | **String** | CONTENTdm identifier (deprecated) | [optional] 
+**display_format** | **String** | Display Format | [optional] 
+**doi** | **String** | Digital Object Identifier (doi.org) | [optional] 
+**ead_id** | **String** | Source collection identifier | [optional] 
+**fcrepo3_pid** | **String** | Resource ID from defunct Fedora 3 repository | [optional] 
+**ingested_by** | **String** | Person or entity responsible for ingest | [optional] 
+**ingestion_date** | **String** | Date/time of original ingest (may differ from created_at) | [optional] 
+**local_id** | **String** | Digital Collections identifier | [optional] 
+**nested_path** | **String** | Path to original file from root ingest folder | [optional] 
+**permanent_id** | **String** | Permanent identifier (ARK) assigned to the resource | [optional] 
+**permanent_url** | **String** | Permalink to the end-user representation of the resource. | [optional] 
+**research_help_contact** | **String** | Research Help Contact | [optional] 
+**rights_note** | **String** | Rights Note | [optional] 
+**workflow_state** | **String** | Workflow State | [optional] 
+**biblical_book** | **String** | Biblical Book | [optional] 
+**category** | **String** | Category | [optional] 
+**chapter_and_verse** | **String** | Chapter And Verse | [optional] 
+**company** | **String** | Company | [optional] 
+**headline** | **String** | Headline | [optional] 
+**issue_number** | **String** | Issue Number | [optional] 
+**placement_company** | **String** | Placement Company | [optional] 
+**product** | **String** | Product | [optional] 
+**publication** | **String** | Publication | [optional] 
+**series** | **String** | Series | [optional] 
+**setting** | **String** | Setting | [optional] 
+**sponsor** | **String** | Sponsor | [optional] 
+**tone** | **String** | Tone | [optional] 
+**volume** | **String** | Volume | [optional] 
+
+

data/docs/PatchResourcesRelated.md

@@ -0,0 +1,11 @@
+# DdrClient::PatchResourcesRelated
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**admin_policy_id** | **String** | ID of the Collection of which this resource is a member | [optional] 
+**attached_to_id** | **String** | ID of the resource to which this resource is attached | [optional] 
+**parent_id** | **String** | ID of the parent of this resource | [optional] 
+**target_id** | **String** | ID of the Target associated with this resource | [optional] 
+
+

data/docs/PatchResourcesRoles.md

@@ -0,0 +1,10 @@
+# DdrClient::PatchResourcesRoles
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**role_type** | **String** | Type of access granted | 
+**agent** | **String** | Person or group to whom access is granted | 
+**scope** | **String** | Scope of the access granted | 
+
+

data/docs/PostResources.md

@@ -0,0 +1,12 @@
+# DdrClient::PostResources
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Resource ID | [optional] 
+**model** | **String** | Type of resource to create | 
+**metadata** | [**PatchResourcesMetadata**](PatchResourcesMetadata.md) |  | [optional] 
+**related** | [**PatchResourcesRelated**](PatchResourcesRelated.md) |  | [optional] 
+**roles** | [**Array<PatchResourcesRoles>**](PatchResourcesRoles.md) | Role-based access control assertions on the resource | [optional] 
+
+

data/docs/QueuesApi.md

@@ -0,0 +1,102 @@
+# DdrClient::QueuesApi
+
+All URIs are relative to *https://example.org/api*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_queues_locks**](QueuesApi.md#delete_queues_locks) | **DELETE** /queues/locks | 
+[**get_queues_stats**](QueuesApi.md#get_queues_stats) | **GET** /queues/stats | 
+
+
+# **delete_queues_locks**
+> delete_queues_locks
+
+
+
+Unlock locked jobs
+
+### Example
+```ruby
+# load the gem
+require 'ddr_client'
+# setup authorization
+DdrClient.configure do |config|
+  # Configure API key authorization: oauth
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = DdrClient::QueuesApi.new
+
+begin
+  api_instance.delete_queues_locks
+rescue DdrClient::ApiError => e
+  puts "Exception when calling QueuesApi->delete_queues_locks: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_queues_stats**
+> get_queues_stats
+
+
+
+Retrieve summary infomation on background job queues
+
+### Example
+```ruby
+# load the gem
+require 'ddr_client'
+# setup authorization
+DdrClient.configure do |config|
+  # Configure API key authorization: oauth
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = DdrClient::QueuesApi.new
+
+begin
+  api_instance.get_queues_stats
+rescue DdrClient::ApiError => e
+  puts "Exception when calling QueuesApi->get_queues_stats: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/ReportsApi.md

@@ -0,0 +1,177 @@
+# DdrClient::ReportsApi
+
+All URIs are relative to *https://example.org/api*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_reports_collection_summary**](ReportsApi.md#get_reports_collection_summary) | **GET** /reports/collection_summary | 
+[**get_reports_duplicate_content**](ReportsApi.md#get_reports_duplicate_content) | **GET** /reports/duplicate_content | 
+[**get_reports_roles**](ReportsApi.md#get_reports_roles) | **GET** /reports/roles | 
+
+
+# **get_reports_collection_summary**
+> File get_reports_collection_summary(opts)
+
+
+
+Collection summary report
+
+### Example
+```ruby
+# load the gem
+require 'ddr_client'
+# setup authorization
+DdrClient.configure do |config|
+  # Configure API key authorization: oauth
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = DdrClient::ReportsApi.new
+
+opts = { 
+  fields: ['fields_example'] # Array<String> | Fields to include for each collection (default: id, title, ingestion_date, admin_set, workflow_state)
+}
+
+begin
+  result = api_instance.get_reports_collection_summary(opts)
+  p result
+rescue DdrClient::ApiError => e
+  puts "Exception when calling ReportsApi->get_reports_collection_summary: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **fields** | [**Array&lt;String&gt;**](String.md)| Fields to include for each collection (default: id, title, ingestion_date, admin_set, workflow_state) | [optional] 
+
+### Return type
+
+**File**
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: text/csv
+
+
+
+# **get_reports_duplicate_content**
+> File get_reports_duplicate_content(opts)
+
+
+
+Duplicate content report
+
+### Example
+```ruby
+# load the gem
+require 'ddr_client'
+# setup authorization
+DdrClient.configure do |config|
+  # Configure API key authorization: oauth
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = DdrClient::ReportsApi.new
+
+opts = { 
+  fields: ['fields_example'] # Array<String> | Fields to include in the report (default: sha1, id, model, original_filename, parent_id, collection_title, workflow_state, ingestion_date)
+}
+
+begin
+  result = api_instance.get_reports_duplicate_content(opts)
+  p result
+rescue DdrClient::ApiError => e
+  puts "Exception when calling ReportsApi->get_reports_duplicate_content: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **fields** | [**Array&lt;String&gt;**](String.md)| Fields to include in the report (default: sha1, id, model, original_filename, parent_id, collection_title, workflow_state, ingestion_date) | [optional] 
+
+### Return type
+
+**File**
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: text/csv
+
+
+
+# **get_reports_roles**
+> File get_reports_roles(opts)
+
+
+
+Roles report
+
+### Example
+```ruby
+# load the gem
+require 'ddr_client'
+# setup authorization
+DdrClient.configure do |config|
+  # Configure API key authorization: oauth
+  config.api_key['Authorization'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['Authorization'] = 'Bearer'
+end
+
+api_instance = DdrClient::ReportsApi.new
+
+opts = { 
+  include_inherited: false, # BOOLEAN | Include inherited roles for Item resources
+  collection_id: 'collection_id_example', # String | Limit resources to members of Collection ID
+  fields: ['fields_example'] # Array<String> | Fields to include in the report (default: id, model, title)
+}
+
+begin
+  result = api_instance.get_reports_roles(opts)
+  p result
+rescue DdrClient::ApiError => e
+  puts "Exception when calling ReportsApi->get_reports_roles: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **include_inherited** | **BOOLEAN**| Include inherited roles for Item resources | [optional] [default to false]
+ **collection_id** | **String**| Limit resources to members of Collection ID | [optional] 
+ **fields** | [**Array&lt;String&gt;**](String.md)| Fields to include in the report (default: id, model, title) | [optional] 
+
+### Return type
+
+**File**
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: text/csv
+
+
+