ddr_client 2.0.0.d9f2bd2b

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bf12271ce3a97053bb5f98322585a86262405689db002cbcb3a883650dc1eaeb
+  data.tar.gz: c500c94ad43b8649b105bc8665eaf9e1b98adb59efdd7dce90fd6956651d862c
+SHA512:
+  metadata.gz: 432da4960f7ddebded707a024eade13a93ea186a65a05f62b818327e747ad5240488f965d89d38ba8f90c2e6a2f5fa1d20b97ad688efb992a44fea8146f2c2e5
+  data.tar.gz: 0f7efe1af2615cf553865d29c29b59f5d28ab2cd5ea3678930e1895933a6ca29e4c56fd781436e690540c40b950bfa0e27871f8974210e9435006cd90b20eb52

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.3.3'
+end

data/README.md

@@ -0,0 +1,168 @@
+# ddr_client
+
+DdrClient - the Ruby gem for the Duke Digital Repository API
+
+No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
+
+- API version: v1
+- Package version: 2.0.0.d9f2bd2b
+- Build package: io.swagger.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build ddr_client.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./ddr_client-2.0.0.d9f2bd2b.gem
+```
+(for development, run `gem install --dev ./ddr_client-2.0.0.d9f2bd2b.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'ddr_client', '~> 2.0.0.d9f2bd2b'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'ddr_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation](#installation) procedure and then run the following code:
+```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::BatchObjectsApi.new
+
+opts = { 
+  resource_id: 'resource_id_example', # String | Filter by resource ID
+  type: 'type_example', # String | Filter by batch object type
+  model: ['model_example'], # Array<String> | Filter by models(s)
+  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_batch_objects(opts)
+  p result
+rescue DdrClient::ApiError => e
+  puts "Exception when calling BatchObjectsApi->get_batch_objects: #{e}"
+end
+
+```
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://example.org/api*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*DdrClient::BatchObjectsApi* | [**get_batch_objects**](docs/BatchObjectsApi.md#get_batch_objects) | **GET** /batch_objects | 
+*DdrClient::BatchObjectsApi* | [**get_batch_objects_id**](docs/BatchObjectsApi.md#get_batch_objects_id) | **GET** /batch_objects/{id} | 
+*DdrClient::BatchesApi* | [**get_batches**](docs/BatchesApi.md#get_batches) | **GET** /batches | 
+*DdrClient::BatchesApi* | [**get_batches_id**](docs/BatchesApi.md#get_batches_id) | **GET** /batches/{id} | 
+*DdrClient::BatchesApi* | [**get_batches_id_batch_objects**](docs/BatchesApi.md#get_batches_id_batch_objects) | **GET** /batches/{id}/batch_objects | 
+*DdrClient::BatchesApi* | [**get_batches_id_log**](docs/BatchesApi.md#get_batches_id_log) | **GET** /batches/{id}/log | 
+*DdrClient::BatchesApi* | [**get_batches_id_messages**](docs/BatchesApi.md#get_batches_id_messages) | **GET** /batches/{id}/messages | 
+*DdrClient::EventsApi* | [**get_events**](docs/EventsApi.md#get_events) | **GET** /events | 
+*DdrClient::EventsApi* | [**get_events_id**](docs/EventsApi.md#get_events_id) | **GET** /events/{id} | 
+*DdrClient::GroupsApi* | [**get_groups**](docs/GroupsApi.md#get_groups) | **GET** /groups | 
+*DdrClient::IndexApi* | [**delete_index_id**](docs/IndexApi.md#delete_index_id) | **DELETE** /index/{id} | 
+*DdrClient::IndexApi* | [**get_index_id**](docs/IndexApi.md#get_index_id) | **GET** /index/{id} | 
+*DdrClient::IndexApi* | [**get_index_schema**](docs/IndexApi.md#get_index_schema) | **GET** /index/schema | 
+*DdrClient::QueuesApi* | [**delete_queues_locks**](docs/QueuesApi.md#delete_queues_locks) | **DELETE** /queues/locks | 
+*DdrClient::QueuesApi* | [**get_queues_stats**](docs/QueuesApi.md#get_queues_stats) | **GET** /queues/stats | 
+*DdrClient::ReportsApi* | [**get_reports_collection_summary**](docs/ReportsApi.md#get_reports_collection_summary) | **GET** /reports/collection_summary | 
+*DdrClient::ReportsApi* | [**get_reports_duplicate_content**](docs/ReportsApi.md#get_reports_duplicate_content) | **GET** /reports/duplicate_content | 
+*DdrClient::ReportsApi* | [**get_reports_roles**](docs/ReportsApi.md#get_reports_roles) | **GET** /reports/roles | 
+*DdrClient::ResourcesApi* | [**get_resources**](docs/ResourcesApi.md#get_resources) | **GET** /resources | 
+*DdrClient::ResourcesApi* | [**get_resources_by_role**](docs/ResourcesApi.md#get_resources_by_role) | **GET** /resources/by_role | 
+*DdrClient::ResourcesApi* | [**get_resources_id**](docs/ResourcesApi.md#get_resources_id) | **GET** /resources/{id} | 
+*DdrClient::ResourcesApi* | [**get_resources_id_attachments**](docs/ResourcesApi.md#get_resources_id_attachments) | **GET** /resources/{id}/attachments | 
+*DdrClient::ResourcesApi* | [**get_resources_id_batches**](docs/ResourcesApi.md#get_resources_id_batches) | **GET** /resources/{id}/batches | 
+*DdrClient::ResourcesApi* | [**get_resources_id_children**](docs/ResourcesApi.md#get_resources_id_children) | **GET** /resources/{id}/children | 
+*DdrClient::ResourcesApi* | [**get_resources_id_download**](docs/ResourcesApi.md#get_resources_id_download) | **GET** /resources/{id}/download | 
+*DdrClient::ResourcesApi* | [**get_resources_id_files_slug**](docs/ResourcesApi.md#get_resources_id_files_slug) | **GET** /resources/{id}/files/{slug} | 
+*DdrClient::ResourcesApi* | [**get_resources_id_fixity**](docs/ResourcesApi.md#get_resources_id_fixity) | **GET** /resources/{id}/fixity | Perform a fixity check on the resource
+*DdrClient::ResourcesApi* | [**get_resources_id_members**](docs/ResourcesApi.md#get_resources_id_members) | **GET** /resources/{id}/members | Get members of a Collection
+*DdrClient::ResourcesApi* | [**get_resources_id_permanent_id**](docs/ResourcesApi.md#get_resources_id_permanent_id) | **GET** /resources/{id}/permanent_id | 
+*DdrClient::ResourcesApi* | [**get_resources_id_permissions**](docs/ResourcesApi.md#get_resources_id_permissions) | **GET** /resources/{id}/permissions | 
+*DdrClient::ResourcesApi* | [**get_resources_id_targets**](docs/ResourcesApi.md#get_resources_id_targets) | **GET** /resources/{id}/targets | 
+*DdrClient::ResourcesApi* | [**get_resources_id_technical_metadata**](docs/ResourcesApi.md#get_resources_id_technical_metadata) | **GET** /resources/{id}/technical_metadata | 
+*DdrClient::ResourcesApi* | [**patch_resources_id**](docs/ResourcesApi.md#patch_resources_id) | **PATCH** /resources/{id} | 
+*DdrClient::ResourcesApi* | [**post_resources**](docs/ResourcesApi.md#post_resources) | **POST** /resources | 
+*DdrClient::SchemaApi* | [**get_schema_event**](docs/SchemaApi.md#get_schema_event) | **GET** /schema/event | 
+*DdrClient::SchemaApi* | [**get_schema_resource**](docs/SchemaApi.md#get_schema_resource) | **GET** /schema/resource | 
+*DdrClient::SchemaApi* | [**get_schema_user**](docs/SchemaApi.md#get_schema_user) | **GET** /schema/user | 
+*DdrClient::UsersApi* | [**get_users**](docs/UsersApi.md#get_users) | **GET** /users | 
+*DdrClient::UsersApi* | [**get_users_id**](docs/UsersApi.md#get_users_id) | **GET** /users/{id} | 
+
+
+## Documentation for Models
+
+ - [DdrClient::DdrAPIBatchEntity](docs/DdrAPIBatchEntity.md)
+ - [DdrClient::DdrAPIBatchEntityLogfile](docs/DdrAPIBatchEntityLogfile.md)
+ - [DdrClient::DdrAPIBatchObjectAttributeEntity](docs/DdrAPIBatchObjectAttributeEntity.md)
+ - [DdrClient::DdrAPIBatchObjectDatastreamEntity](docs/DdrAPIBatchObjectDatastreamEntity.md)
+ - [DdrClient::DdrAPIBatchObjectEntity](docs/DdrAPIBatchObjectEntity.md)
+ - [DdrClient::DdrAPIBatchObjectMessageEntity](docs/DdrAPIBatchObjectMessageEntity.md)
+ - [DdrClient::DdrAPIBatchObjectRelationshipEntity](docs/DdrAPIBatchObjectRelationshipEntity.md)
+ - [DdrClient::DdrAPIBatchObjectRoleEntity](docs/DdrAPIBatchObjectRoleEntity.md)
+ - [DdrClient::DdrAPIEventEntity](docs/DdrAPIEventEntity.md)
+ - [DdrClient::DdrAPIFileEntity](docs/DdrAPIFileEntity.md)
+ - [DdrClient::DdrAPIGroupEntity](docs/DdrAPIGroupEntity.md)
+ - [DdrClient::DdrAPIGroupMemberEntity](docs/DdrAPIGroupMemberEntity.md)
+ - [DdrClient::DdrAPILinkEntity](docs/DdrAPILinkEntity.md)
+ - [DdrClient::DdrAPIResourceEntity](docs/DdrAPIResourceEntity.md)
+ - [DdrClient::DdrAPIResourceEntityFiles](docs/DdrAPIResourceEntityFiles.md)
+ - [DdrClient::DdrAPIResourceEntityMetadata](docs/DdrAPIResourceEntityMetadata.md)
+ - [DdrClient::DdrAPIResourceEntityRelated](docs/DdrAPIResourceEntityRelated.md)
+ - [DdrClient::DdrAPIRoleEntity](docs/DdrAPIRoleEntity.md)
+ - [DdrClient::DdrAPITechnicalMetadataEntity](docs/DdrAPITechnicalMetadataEntity.md)
+ - [DdrClient::DdrAPIUserEntity](docs/DdrAPIUserEntity.md)
+ - [DdrClient::PatchResources](docs/PatchResources.md)
+ - [DdrClient::PatchResourcesMetadata](docs/PatchResourcesMetadata.md)
+ - [DdrClient::PatchResourcesRelated](docs/PatchResourcesRelated.md)
+ - [DdrClient::PatchResourcesRoles](docs/PatchResourcesRoles.md)
+ - [DdrClient::PostResources](docs/PostResources.md)
+
+
+## Documentation for Authorization
+
+
+### oauth
+
+- **Type**: API key
+- **API key parameter name**: Authorization
+- **Location**: HTTP header
+

data/Rakefile

@@ -0,0 +1,8 @@
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/ddr_client.gemspec

@@ -0,0 +1,46 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+#Duke Digital Repository API
+
+#No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
+
+OpenAPI spec version: v1
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.36
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "ddr_client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "ddr_client"
+  s.version     = DdrClient::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Duke University Libraries"]
+  s.email       = ["david.chandek.stark@duke.edu"]
+  s.homepage    = "https://gitlab.oit.duke.edu/ddr/ddr-admin"
+  s.summary     = "Duke Digital Repository API client"
+  s.description = "Duke Digital Repository API client generated by swagger-codegen (https://github.com/swagger-api/swagger-codegen)"
+  s.license     = 'BSD-3-Clause'
+  s.required_ruby_version = ">= 1.9"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
+  s.add_runtime_dependency 'addressable', '~> 2.3', '>= 2.3.0'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+  s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
+  s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
+  s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
+  s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
+  s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
+  s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/docs/BatchObjectsApi.md

@@ -0,0 +1,125 @@
+# DdrClient::BatchObjectsApi
+
+All URIs are relative to *https://example.org/api*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_batch_objects**](BatchObjectsApi.md#get_batch_objects) | **GET** /batch_objects | 
+[**get_batch_objects_id**](BatchObjectsApi.md#get_batch_objects_id) | **GET** /batch_objects/{id} | 
+
+
+# **get_batch_objects**
+> Array<DdrAPIBatchObjectEntity> get_batch_objects(opts)
+
+
+
+Retrieve batch object records
+
+### 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::BatchObjectsApi.new
+
+opts = { 
+  resource_id: 'resource_id_example', # String | Filter by resource ID
+  type: 'type_example', # String | Filter by batch object type
+  model: ['model_example'], # Array<String> | Filter by models(s)
+  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_batch_objects(opts)
+  p result
+rescue DdrClient::ApiError => e
+  puts "Exception when calling BatchObjectsApi->get_batch_objects: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **resource_id** | **String**| Filter by resource ID | [optional] 
+ **type** | **String**| Filter by batch object type | [optional] 
+ **model** | [**Array&lt;String&gt;**](String.md)| Filter by models(s) | [optional] 
+ **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;DdrAPIBatchObjectEntity&gt;**](DdrAPIBatchObjectEntity.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, text/csv
+
+
+
+# **get_batch_objects_id**
+> DdrAPIBatchObjectEntity get_batch_objects_id(id)
+
+
+
+Retrieve a batch object record with details (attributes, files, messages, relationships, roles)
+
+### 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::BatchObjectsApi.new
+
+id = 56 # Integer | 
+
+
+begin
+  result = api_instance.get_batch_objects_id(id)
+  p result
+rescue DdrClient::ApiError => e
+  puts "Exception when calling BatchObjectsApi->get_batch_objects_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**|  | 
+
+### Return type
+
+[**DdrAPIBatchObjectEntity**](DdrAPIBatchObjectEntity.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/docs/BatchesApi.md

@@ -0,0 +1,305 @@
+# DdrClient::BatchesApi
+
+All URIs are relative to *https://example.org/api*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_batches**](BatchesApi.md#get_batches) | **GET** /batches | 
+[**get_batches_id**](BatchesApi.md#get_batches_id) | **GET** /batches/{id} | 
+[**get_batches_id_batch_objects**](BatchesApi.md#get_batches_id_batch_objects) | **GET** /batches/{id}/batch_objects | 
+[**get_batches_id_log**](BatchesApi.md#get_batches_id_log) | **GET** /batches/{id}/log | 
+[**get_batches_id_messages**](BatchesApi.md#get_batches_id_messages) | **GET** /batches/{id}/messages | 
+
+
+# **get_batches**
+> Array<DdrAPIBatchEntity> get_batches(opts)
+
+
+
+List batches
+
+### 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::BatchesApi.new
+
+opts = { 
+  outcome: 'outcome_example', # String | Filter by batch processing outcome
+  user_id: 56, # Integer | Filter by user ID associated with the batch
+  status: 'status_example', # String | Filter by batch status
+  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_batches(opts)
+  p result
+rescue DdrClient::ApiError => e
+  puts "Exception when calling BatchesApi->get_batches: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **outcome** | **String**| Filter by batch processing outcome | [optional] 
+ **user_id** | **Integer**| Filter by user ID associated with the batch | [optional] 
+ **status** | **String**| Filter by batch status | [optional] 
+ **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<DdrAPIBatchEntity>**](DdrAPIBatchEntity.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, text/csv
+
+
+
+# **get_batches_id**
+> DdrAPIBatchEntity get_batches_id(id, opts)
+
+
+
+Retrieve a batch record
+
+### 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::BatchesApi.new
+
+id = 56 # Integer | 
+
+opts = { 
+  batch_objects: false # BOOLEAN | Include related batch objects (not paginated)
+}
+
+begin
+  result = api_instance.get_batches_id(id, opts)
+  p result
+rescue DdrClient::ApiError => e
+  puts "Exception when calling BatchesApi->get_batches_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**|  | 
+ **batch_objects** | **BOOLEAN**| Include related batch objects (not paginated) | [optional] [default to false]
+
+### Return type
+
+[**DdrAPIBatchEntity**](DdrAPIBatchEntity.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+
+# **get_batches_id_batch_objects**
+> Array<DdrAPIBatchObjectEntity> get_batches_id_batch_objects(id, opts)
+
+
+
+Retrieve the batch objects for a batch
+
+### 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::BatchesApi.new
+
+id = 56 # Integer | 
+
+opts = { 
+  batch_object_details: true, # BOOLEAN | JSON only: Include related attributes, files, messages, relationships, and roles for each batch object
+  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_batches_id_batch_objects(id, opts)
+  p result
+rescue DdrClient::ApiError => e
+  puts "Exception when calling BatchesApi->get_batches_id_batch_objects: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**|  | 
+ **batch_object_details** | **BOOLEAN**| JSON only: Include related attributes, files, messages, relationships, and roles for each batch object | [optional] [default to true]
+ **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<DdrAPIBatchObjectEntity>**](DdrAPIBatchObjectEntity.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, text/csv
+
+
+
+# **get_batches_id_log**
+> File get_batches_id_log(id)
+
+
+
+Download the batch log 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::BatchesApi.new
+
+id = 56 # Integer | 
+
+
+begin
+  result = api_instance.get_batches_id_log(id)
+  p result
+rescue DdrClient::ApiError => e
+  puts "Exception when calling BatchesApi->get_batches_id_log: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**|  | 
+
+### Return type
+
+**File**
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: text/plain
+
+
+
+# **get_batches_id_messages**
+> Array<DdrAPIBatchObjectMessageEntity> get_batches_id_messages(id, opts)
+
+
+
+Retrieve the batch object messages for a batch
+
+### 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::BatchesApi.new
+
+id = 56 # Integer | 
+
+opts = { 
+  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_batches_id_messages(id, opts)
+  p result
+rescue DdrClient::ApiError => e
+  puts "Exception when calling BatchesApi->get_batches_id_messages: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**|  | 
+ **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<DdrAPIBatchObjectMessageEntity>**](DdrAPIBatchObjectMessageEntity.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, text/csv
+
+
+