ddr_client 2.0.0.d9f2bd2b

data/docs/ResourcesApi.md

@@ -0,0 +1,1003 @@
+# DdrClient::ResourcesApi
+
+All URIs are relative to *https://example.org/api*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_resources**](ResourcesApi.md#get_resources) | **GET** /resources | 
+[**get_resources_by_role**](ResourcesApi.md#get_resources_by_role) | **GET** /resources/by_role | 
+[**get_resources_id**](ResourcesApi.md#get_resources_id) | **GET** /resources/{id} | 
+[**get_resources_id_attachments**](ResourcesApi.md#get_resources_id_attachments) | **GET** /resources/{id}/attachments | 
+[**get_resources_id_batches**](ResourcesApi.md#get_resources_id_batches) | **GET** /resources/{id}/batches | 
+[**get_resources_id_children**](ResourcesApi.md#get_resources_id_children) | **GET** /resources/{id}/children | 
+[**get_resources_id_download**](ResourcesApi.md#get_resources_id_download) | **GET** /resources/{id}/download | 
+[**get_resources_id_files_slug**](ResourcesApi.md#get_resources_id_files_slug) | **GET** /resources/{id}/files/{slug} | 
+[**get_resources_id_fixity**](ResourcesApi.md#get_resources_id_fixity) | **GET** /resources/{id}/fixity | Perform a fixity check on the resource
+[**get_resources_id_members**](ResourcesApi.md#get_resources_id_members) | **GET** /resources/{id}/members | Get members of a Collection
+[**get_resources_id_permanent_id**](ResourcesApi.md#get_resources_id_permanent_id) | **GET** /resources/{id}/permanent_id | 
+[**get_resources_id_permissions**](ResourcesApi.md#get_resources_id_permissions) | **GET** /resources/{id}/permissions | 
+[**get_resources_id_targets**](ResourcesApi.md#get_resources_id_targets) | **GET** /resources/{id}/targets | 
+[**get_resources_id_technical_metadata**](ResourcesApi.md#get_resources_id_technical_metadata) | **GET** /resources/{id}/technical_metadata | 
+[**patch_resources_id**](ResourcesApi.md#patch_resources_id) | **PATCH** /resources/{id} | 
+[**post_resources**](ResourcesApi.md#post_resources) | **POST** /resources | 
+
+
+# **get_resources**
+> Array<DdrAPIResourceEntity> get_resources(opts)
+
+
+
+Filter resources
+
+### 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::ResourcesApi.new
+
+opts = { 
+  admin_set: 'admin_set_example', # String | Limit to selected admin set
+  original_filename: 'original_filename_example', # String | Match by original file name
+  sha1: ['sha1_example'], # Array<String> | Match by original file SHA1 digest
+  model: ['model_example'], # Array<String> | Limit to selected model type(s)
+  workflow_state: 'workflow_state_example', # String | Filter by workflow state
+  modified_before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Limit results to resources created or modified before a date/time
+  modified_since: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Limit results to resources created or modified since a date/time
+  fields: ['fields_example'], # Array<String> | Metadata fields to include (resource ID and model are always included)
+  exclude_fields: ['exclude_fields_example'], # Array<String> | Metadata fields to exclude (cannot combine with \"fields\")
+  csv_fields: ['csv_fields_example'], # Array<String> | CSV only: Include additional columns
+  file_fields: ['file_fields_example'], # Array<String> | CSV only: Include file columns (row values: 'present', 'absent', or 'n/a')
+  remove_empty_columns: false, # BOOLEAN | CSV only: Remove empty columns from CSV output table
+  per_page: nil, # Object | JSON only: Number of records to return per page (default: 20)
+  page: nil # Object | JSON only: Page number of results to return (default: 1)
+}
+
+begin
+  result = api_instance.get_resources(opts)
+  p result
+rescue DdrClient::ApiError => e
+  puts "Exception when calling ResourcesApi->get_resources: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **admin_set** | **String**| Limit to selected admin set | [optional] 
+ **original_filename** | **String**| Match by original file name | [optional] 
+ **sha1** | [**Array&lt;String&gt;**](String.md)| Match by original file SHA1 digest | [optional] 
+ **model** | [**Array&lt;String&gt;**](String.md)| Limit to selected model type(s) | [optional] 
+ **workflow_state** | **String**| Filter by workflow state | [optional] 
+ **modified_before** | **DateTime**| Limit results to resources created or modified before a date/time | [optional] 
+ **modified_since** | **DateTime**| Limit results to resources created or modified since a date/time | [optional] 
+ **fields** | [**Array&lt;String&gt;**](String.md)| Metadata fields to include (resource ID and model are always included) | [optional] 
+ **exclude_fields** | [**Array&lt;String&gt;**](String.md)| Metadata fields to exclude (cannot combine with \&quot;fields\&quot;) | [optional] 
+ **csv_fields** | [**Array&lt;String&gt;**](String.md)| CSV only: Include additional columns | [optional] 
+ **file_fields** | [**Array&lt;String&gt;**](String.md)| CSV only: Include file columns (row values: &#39;present&#39;, &#39;absent&#39;, or &#39;n/a&#39;) | [optional] 
+ **remove_empty_columns** | **BOOLEAN**| CSV only: Remove empty columns from CSV output table | [optional] [default to false]
+ **per_page** | [**Object**](.md)| JSON only: Number of records to return per page (default: 20) | [optional] 
+ **page** | [**Object**](.md)| JSON only: Page number of results to return (default: 1) | [optional] 
+
+### Return type
+
+[**Array&lt;DdrAPIResourceEntity&gt;**](DdrAPIResourceEntity.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, text/csv
+
+
+
+# **get_resources_by_role**
+> Array&lt;DdrAPIResourceEntity&gt; get_resources_by_role(opts)
+
+
+
+Find resources by role
+
+### 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::ResourcesApi.new
+
+opts = { 
+  agent: 'agent_example', # String | Person or group to whom access is granted
+  role_type: 'role_type_example', # String | Type of access granted
+  scope: 'scope_example', # String | Scope of the access granted
+  fields: ['fields_example'], # Array<String> | Metadata fields to include (resource ID and model are always included)
+  exclude_fields: ['exclude_fields_example'], # Array<String> | Metadata fields to exclude (cannot combine with \"fields\")
+  csv_fields: ['csv_fields_example'], # Array<String> | CSV only: Include additional columns
+  file_fields: ['file_fields_example'], # Array<String> | CSV only: Include file columns (row values: 'present', 'absent', or 'n/a')
+  remove_empty_columns: false, # BOOLEAN | CSV only: Remove empty columns from CSV output table
+  per_page: nil, # Object | JSON only: Number of records to return per page (default: 20)
+  page: nil # Object | JSON only: Page number of results to return (default: 1)
+}
+
+begin
+  result = api_instance.get_resources_by_role(opts)
+  p result
+rescue DdrClient::ApiError => e
+  puts "Exception when calling ResourcesApi->get_resources_by_role: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **agent** | **String**| Person or group to whom access is granted | [optional] 
+ **role_type** | **String**| Type of access granted | [optional] 
+ **scope** | **String**| Scope of the access granted | [optional] 
+ **fields** | [**Array&lt;String&gt;**](String.md)| Metadata fields to include (resource ID and model are always included) | [optional] 
+ **exclude_fields** | [**Array&lt;String&gt;**](String.md)| Metadata fields to exclude (cannot combine with \&quot;fields\&quot;) | [optional] 
+ **csv_fields** | [**Array&lt;String&gt;**](String.md)| CSV only: Include additional columns | [optional] 
+ **file_fields** | [**Array&lt;String&gt;**](String.md)| CSV only: Include file columns (row values: &#39;present&#39;, &#39;absent&#39;, or &#39;n/a&#39;) | [optional] 
+ **remove_empty_columns** | **BOOLEAN**| CSV only: Remove empty columns from CSV output table | [optional] [default to false]
+ **per_page** | [**Object**](.md)| JSON only: Number of records to return per page (default: 20) | [optional] 
+ **page** | [**Object**](.md)| JSON only: Page number of results to return (default: 1) | [optional] 
+
+### Return type
+
+[**Array&lt;DdrAPIResourceEntity&gt;**](DdrAPIResourceEntity.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, text/csv
+
+
+
+# **get_resources_id**
+> DdrAPIResourceEntity get_resources_id(id, opts)
+
+
+
+Retrieve a resource
+
+### 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::ResourcesApi.new
+
+id = 'id_example' # String | 
+
+opts = { 
+  fields: ['fields_example'], # Array<String> | Metadata fields to include (resource ID and model are always included)
+  exclude_fields: ['exclude_fields_example'] # Array<String> | Metadata fields to exclude (cannot combine with \"fields\")
+}
+
+begin
+  result = api_instance.get_resources_id(id, opts)
+  p result
+rescue DdrClient::ApiError => e
+  puts "Exception when calling ResourcesApi->get_resources_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+ **fields** | [**Array&lt;String&gt;**](String.md)| Metadata fields to include (resource ID and model are always included) | [optional] 
+ **exclude_fields** | [**Array&lt;String&gt;**](String.md)| Metadata fields to exclude (cannot combine with \&quot;fields\&quot;) | [optional] 
+
+### Return type
+
+[**DdrAPIResourceEntity**](DdrAPIResourceEntity.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_resources_id_attachments**
+> Array&lt;DdrAPIResourceEntity&gt; get_resources_id_attachments(id, opts)
+
+
+
+Get attachments to a Collection
+
+### 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::ResourcesApi.new
+
+id = 'id_example' # String | 
+
+opts = { 
+  fields: ['fields_example'], # Array<String> | Metadata fields to include (resource ID and model are always included)
+  exclude_fields: ['exclude_fields_example'], # Array<String> | Metadata fields to exclude (cannot combine with \"fields\")
+  csv_fields: ['csv_fields_example'], # Array<String> | CSV only: Include additional columns
+  file_fields: ['file_fields_example'], # Array<String> | CSV only: Include file columns (row values: 'present', 'absent', or 'n/a')
+  remove_empty_columns: false, # BOOLEAN | CSV only: Remove empty columns from CSV output table
+  per_page: nil, # Object | JSON only: Number of records to return per page (default: 20)
+  page: nil # Object | JSON only: Page number of results to return (default: 1)
+}
+
+begin
+  result = api_instance.get_resources_id_attachments(id, opts)
+  p result
+rescue DdrClient::ApiError => e
+  puts "Exception when calling ResourcesApi->get_resources_id_attachments: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+ **fields** | [**Array&lt;String&gt;**](String.md)| Metadata fields to include (resource ID and model are always included) | [optional] 
+ **exclude_fields** | [**Array&lt;String&gt;**](String.md)| Metadata fields to exclude (cannot combine with \&quot;fields\&quot;) | [optional] 
+ **csv_fields** | [**Array&lt;String&gt;**](String.md)| CSV only: Include additional columns | [optional] 
+ **file_fields** | [**Array&lt;String&gt;**](String.md)| CSV only: Include file columns (row values: &#39;present&#39;, &#39;absent&#39;, or &#39;n/a&#39;) | [optional] 
+ **remove_empty_columns** | **BOOLEAN**| CSV only: Remove empty columns from CSV output table | [optional] [default to false]
+ **per_page** | [**Object**](.md)| JSON only: Number of records to return per page (default: 20) | [optional] 
+ **page** | [**Object**](.md)| JSON only: Page number of results to return (default: 1) | [optional] 
+
+### Return type
+
+[**Array&lt;DdrAPIResourceEntity&gt;**](DdrAPIResourceEntity.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, text/csv
+
+
+
+# **get_resources_id_batches**
+> Array&lt;DdrAPIBatchEntity&gt; get_resources_id_batches(id, opts)
+
+
+
+Get batches associated with the resource (by batch collection_id or batch object resource_id)
+
+### 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::ResourcesApi.new
+
+id = 'id_example' # String | 
+
+opts = { 
+  batch_objects: false, # BOOLEAN | Include batch objects for each batch
+  per_page: nil, # Object | JSON only: Number of records to return per page (default: 20)
+  page: nil # Object | JSON only: Page number of results to return (default: 1)
+}
+
+begin
+  result = api_instance.get_resources_id_batches(id, opts)
+  p result
+rescue DdrClient::ApiError => e
+  puts "Exception when calling ResourcesApi->get_resources_id_batches: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+ **batch_objects** | **BOOLEAN**| Include batch objects for each batch | [optional] [default to false]
+ **per_page** | [**Object**](.md)| JSON only: Number of records to return per page (default: 20) | [optional] 
+ **page** | [**Object**](.md)| JSON only: Page number of results to return (default: 1) | [optional] 
+
+### Return type
+
+[**Array&lt;DdrAPIBatchEntity&gt;**](DdrAPIBatchEntity.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_resources_id_children**
+> Array&lt;DdrAPIResourceEntity&gt; get_resources_id_children(id, opts)
+
+
+
+Get children of a resource
+
+### 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::ResourcesApi.new
+
+id = 'id_example' # String | 
+
+opts = { 
+  fields: ['fields_example'], # Array<String> | Metadata fields to include (resource ID and model are always included)
+  exclude_fields: ['exclude_fields_example'], # Array<String> | Metadata fields to exclude (cannot combine with \"fields\")
+  csv_fields: ['csv_fields_example'], # Array<String> | CSV only: Include additional columns
+  file_fields: ['file_fields_example'], # Array<String> | CSV only: Include file columns (row values: 'present', 'absent', or 'n/a')
+  remove_empty_columns: false, # BOOLEAN | CSV only: Remove empty columns from CSV output table
+  per_page: nil, # Object | JSON only: Number of records to return per page (default: 20)
+  page: nil # Object | JSON only: Page number of results to return (default: 1)
+}
+
+begin
+  result = api_instance.get_resources_id_children(id, opts)
+  p result
+rescue DdrClient::ApiError => e
+  puts "Exception when calling ResourcesApi->get_resources_id_children: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+ **fields** | [**Array&lt;String&gt;**](String.md)| Metadata fields to include (resource ID and model are always included) | [optional] 
+ **exclude_fields** | [**Array&lt;String&gt;**](String.md)| Metadata fields to exclude (cannot combine with \&quot;fields\&quot;) | [optional] 
+ **csv_fields** | [**Array&lt;String&gt;**](String.md)| CSV only: Include additional columns | [optional] 
+ **file_fields** | [**Array&lt;String&gt;**](String.md)| CSV only: Include file columns (row values: &#39;present&#39;, &#39;absent&#39;, or &#39;n/a&#39;) | [optional] 
+ **remove_empty_columns** | **BOOLEAN**| CSV only: Remove empty columns from CSV output table | [optional] [default to false]
+ **per_page** | [**Object**](.md)| JSON only: Number of records to return per page (default: 20) | [optional] 
+ **page** | [**Object**](.md)| JSON only: Page number of results to return (default: 1) | [optional] 
+
+### Return type
+
+[**Array&lt;DdrAPIResourceEntity&gt;**](DdrAPIResourceEntity.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, text/csv
+
+
+
+# **get_resources_id_download**
+> File get_resources_id_download(id)
+
+
+
+Download original file
+
+### 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::ResourcesApi.new
+
+id = 'id_example' # String | 
+
+
+begin
+  result = api_instance.get_resources_id_download(id)
+  p result
+rescue DdrClient::ApiError => e
+  puts "Exception when calling ResourcesApi->get_resources_id_download: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+
+### Return type
+
+**File**
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_resources_id_files_slug**
+> File get_resources_id_files_slug(id, slug)
+
+
+
+Download a file attached to a resource
+
+### 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::ResourcesApi.new
+
+id = 'id_example' # String | 
+
+slug = 'slug_example' # String | 
+
+
+begin
+  result = api_instance.get_resources_id_files_slug(id, slug)
+  p result
+rescue DdrClient::ApiError => e
+  puts "Exception when calling ResourcesApi->get_resources_id_files_slug: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+ **slug** | **String**|  | 
+
+### Return type
+
+**File**
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_resources_id_fixity**
+> get_resources_id_fixity(id)
+
+Perform a fixity check on the resource
+
+Content <= 1GB is checked and results returned; content > 1GB is accepted and background job information is returned
+
+### 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::ResourcesApi.new
+
+id = 'id_example' # String | 
+
+
+begin
+  #Perform a fixity check on the resource
+  api_instance.get_resources_id_fixity(id)
+rescue DdrClient::ApiError => e
+  puts "Exception when calling ResourcesApi->get_resources_id_fixity: #{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_resources_id_members**
+> Array&lt;DdrAPIResourceEntity&gt; get_resources_id_members(id, opts)
+
+Get members of a Collection
+
+Members include all resources related to the collection by admin_policy_id, which includes itself.
+
+### 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::ResourcesApi.new
+
+id = 'id_example' # String | 
+
+opts = { 
+  model: ['model_example'], # Array<String> | Limit to selected model type(s)
+  fields: ['fields_example'], # Array<String> | Metadata fields to include (resource ID and model are always included)
+  exclude_fields: ['exclude_fields_example'], # Array<String> | Metadata fields to exclude (cannot combine with \"fields\")
+  csv_fields: ['csv_fields_example'], # Array<String> | CSV only: Include additional columns
+  file_fields: ['file_fields_example'], # Array<String> | CSV only: Include file columns (row values: 'present', 'absent', or 'n/a')
+  remove_empty_columns: false, # BOOLEAN | CSV only: Remove empty columns from CSV output table
+  per_page: nil, # Object | JSON only: Number of records to return per page (default: 20)
+  page: nil # Object | JSON only: Page number of results to return (default: 1)
+}
+
+begin
+  #Get members of a Collection
+  result = api_instance.get_resources_id_members(id, opts)
+  p result
+rescue DdrClient::ApiError => e
+  puts "Exception when calling ResourcesApi->get_resources_id_members: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+ **model** | [**Array&lt;String&gt;**](String.md)| Limit to selected model type(s) | [optional] 
+ **fields** | [**Array&lt;String&gt;**](String.md)| Metadata fields to include (resource ID and model are always included) | [optional] 
+ **exclude_fields** | [**Array&lt;String&gt;**](String.md)| Metadata fields to exclude (cannot combine with \&quot;fields\&quot;) | [optional] 
+ **csv_fields** | [**Array&lt;String&gt;**](String.md)| CSV only: Include additional columns | [optional] 
+ **file_fields** | [**Array&lt;String&gt;**](String.md)| CSV only: Include file columns (row values: &#39;present&#39;, &#39;absent&#39;, or &#39;n/a&#39;) | [optional] 
+ **remove_empty_columns** | **BOOLEAN**| CSV only: Remove empty columns from CSV output table | [optional] [default to false]
+ **per_page** | [**Object**](.md)| JSON only: Number of records to return per page (default: 20) | [optional] 
+ **page** | [**Object**](.md)| JSON only: Page number of results to return (default: 1) | [optional] 
+
+### Return type
+
+[**Array&lt;DdrAPIResourceEntity&gt;**](DdrAPIResourceEntity.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, text/csv
+
+
+
+# **get_resources_id_permanent_id**
+> get_resources_id_permanent_id(id)
+
+
+
+Retrieve metadata for the permanent ID assigned to the resource
+
+### 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::ResourcesApi.new
+
+id = 'id_example' # String | 
+
+
+begin
+  api_instance.get_resources_id_permanent_id(id)
+rescue DdrClient::ApiError => e
+  puts "Exception when calling ResourcesApi->get_resources_id_permanent_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_resources_id_permissions**
+> get_resources_id_permissions(id)
+
+
+
+Return the effective permissions on the resource
+
+### 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::ResourcesApi.new
+
+id = 'id_example' # String | 
+
+
+begin
+  api_instance.get_resources_id_permissions(id)
+rescue DdrClient::ApiError => e
+  puts "Exception when calling ResourcesApi->get_resources_id_permissions: #{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_resources_id_targets**
+> Array&lt;DdrAPIResourceEntity&gt; get_resources_id_targets(id, opts)
+
+
+
+Get targets associated with the Collection
+
+### 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::ResourcesApi.new
+
+id = 'id_example' # String | 
+
+opts = { 
+  fields: ['fields_example'], # Array<String> | Metadata fields to include (resource ID and model are always included)
+  exclude_fields: ['exclude_fields_example'], # Array<String> | Metadata fields to exclude (cannot combine with \"fields\")
+  csv_fields: ['csv_fields_example'], # Array<String> | CSV only: Include additional columns
+  file_fields: ['file_fields_example'], # Array<String> | CSV only: Include file columns (row values: 'present', 'absent', or 'n/a')
+  remove_empty_columns: false, # BOOLEAN | CSV only: Remove empty columns from CSV output table
+  per_page: nil, # Object | JSON only: Number of records to return per page (default: 20)
+  page: nil # Object | JSON only: Page number of results to return (default: 1)
+}
+
+begin
+  result = api_instance.get_resources_id_targets(id, opts)
+  p result
+rescue DdrClient::ApiError => e
+  puts "Exception when calling ResourcesApi->get_resources_id_targets: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+ **fields** | [**Array&lt;String&gt;**](String.md)| Metadata fields to include (resource ID and model are always included) | [optional] 
+ **exclude_fields** | [**Array&lt;String&gt;**](String.md)| Metadata fields to exclude (cannot combine with \&quot;fields\&quot;) | [optional] 
+ **csv_fields** | [**Array&lt;String&gt;**](String.md)| CSV only: Include additional columns | [optional] 
+ **file_fields** | [**Array&lt;String&gt;**](String.md)| CSV only: Include file columns (row values: &#39;present&#39;, &#39;absent&#39;, or &#39;n/a&#39;) | [optional] 
+ **remove_empty_columns** | **BOOLEAN**| CSV only: Remove empty columns from CSV output table | [optional] [default to false]
+ **per_page** | [**Object**](.md)| JSON only: Number of records to return per page (default: 20) | [optional] 
+ **page** | [**Object**](.md)| JSON only: Page number of results to return (default: 1) | [optional] 
+
+### Return type
+
+[**Array&lt;DdrAPIResourceEntity&gt;**](DdrAPIResourceEntity.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, text/csv
+
+
+
+# **get_resources_id_technical_metadata**
+> Array&lt;DdrAPITechnicalMetadataEntity&gt; get_resources_id_technical_metadata(id)
+
+
+
+Get technical metadata for Component members of the Collection
+
+### 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::ResourcesApi.new
+
+id = 'id_example' # String | 
+
+
+begin
+  result = api_instance.get_resources_id_technical_metadata(id)
+  p result
+rescue DdrClient::ApiError => e
+  puts "Exception when calling ResourcesApi->get_resources_id_technical_metadata: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+
+### Return type
+
+[**Array&lt;DdrAPITechnicalMetadataEntity&gt;**](DdrAPITechnicalMetadataEntity.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, text/csv
+
+
+
+# **patch_resources_id**
+> DdrAPIResourceEntity patch_resources_id(id, resources)
+
+
+
+Update a resource
+
+### 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::ResourcesApi.new
+
+id = 'id_example' # String | 
+
+resources = DdrClient::PatchResources.new # PatchResources | 
+
+
+begin
+  result = api_instance.patch_resources_id(id, resources)
+  p result
+rescue DdrClient::ApiError => e
+  puts "Exception when calling ResourcesApi->patch_resources_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+ **resources** | [**PatchResources**](PatchResources.md)|  | 
+
+### Return type
+
+[**DdrAPIResourceEntity**](DdrAPIResourceEntity.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
+# **post_resources**
+> DdrAPIResourceEntity post_resources(resources)
+
+
+
+Create a resource
+
+### 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::ResourcesApi.new
+
+resources = DdrClient::PostResources.new # PostResources | 
+
+
+begin
+  result = api_instance.post_resources(resources)
+  p result
+rescue DdrClient::ApiError => e
+  puts "Exception when calling ResourcesApi->post_resources: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **resources** | [**PostResources**](PostResources.md)|  | 
+
+### Return type
+
+[**DdrAPIResourceEntity**](DdrAPIResourceEntity.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+