ddr_client 2.0.0.d9f2bd2b

data/docs/DdrAPIBatchEntity.md

@@ -0,0 +1,24 @@
+# DdrClient::DdrAPIBatchEntity
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**collection_id** | **String** |  | [optional] 
+**collection_title** | **String** |  | [optional] 
+**created_at** | **String** |  | [optional] 
+**description** | **String** |  | [optional] 
+**id** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**outcome** | **String** |  | [optional] 
+**status** | **String** |  | [optional] 
+**updated_at** | **String** |  | [optional] 
+**version** | **String** |  | [optional] 
+**started_at** | **String** |  | [optional] 
+**stopped_at** | **String** |  | [optional] 
+**processing_started_at** | **String** |  | [optional] 
+**logfile** | [**DdrAPIBatchEntityLogfile**](DdrAPIBatchEntityLogfile.md) |  | [optional] 
+**user** | [**DdrAPIUserEntity**](DdrAPIUserEntity.md) |  | [optional] 
+**batch_objects** | [**Array<DdrAPIBatchObjectEntity>**](DdrAPIBatchObjectEntity.md) |  | [optional] 
+**links** | [**Array<DdrAPILinkEntity>**](DdrAPILinkEntity.md) |  | [optional] 
+
+

data/docs/DdrAPIBatchEntityLogfile.md

@@ -0,0 +1,11 @@
+# DdrClient::DdrAPIBatchEntityLogfile
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**file_name** | **String** |  | [optional] 
+**file_size** | **String** |  | [optional] 
+**content_type** | **String** |  | [optional] 
+**updated_at** | **String** |  | [optional] 
+
+

data/docs/DdrAPIBatchObjectAttributeEntity.md

@@ -0,0 +1,16 @@
+# DdrClient::DdrAPIBatchObjectAttributeEntity
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**batch_object_id** | **String** |  | [optional] 
+**datastream** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**operation** | **String** |  | [optional] 
+**value** | **String** |  | [optional] 
+**value_type** | **String** |  | [optional] 
+**created_at** | **String** |  | [optional] 
+**updated_at** | **String** |  | [optional] 
+
+

data/docs/DdrAPIBatchObjectDatastreamEntity.md

@@ -0,0 +1,17 @@
+# DdrClient::DdrAPIBatchObjectDatastreamEntity
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**batch_object_id** | **String** |  | [optional] 
+**operation** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**payload** | **String** |  | [optional] 
+**payload_type** | **String** |  | [optional] 
+**created_at** | **String** |  | [optional] 
+**updated_at** | **String** |  | [optional] 
+**checksum** | **String** |  | [optional] 
+**checksum_type** | **String** |  | [optional] 
+
+

data/docs/DdrAPIBatchObjectEntity.md

@@ -0,0 +1,26 @@
+# DdrClient::DdrAPIBatchObjectEntity
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**batch_id** | **String** |  | [optional] 
+**identifier** | **String** |  | [optional] 
+**model** | **String** |  | [optional] 
+**label** | **String** |  | [optional] 
+**resource_id** | **String** |  | [optional] 
+**created_at** | **String** |  | [optional] 
+**updated_at** | **String** |  | [optional] 
+**type** | **String** |  | [optional] 
+**verified** | **String** |  | [optional] 
+**handled** | **String** |  | [optional] 
+**processed** | **String** |  | [optional] 
+**validated** | **String** |  | [optional] 
+**attributes** | [**DdrAPIBatchObjectAttributeEntity**](DdrAPIBatchObjectAttributeEntity.md) |  | [optional] 
+**files** | [**DdrAPIBatchObjectDatastreamEntity**](DdrAPIBatchObjectDatastreamEntity.md) |  | [optional] 
+**messages** | [**DdrAPIBatchObjectMessageEntity**](DdrAPIBatchObjectMessageEntity.md) |  | [optional] 
+**relationships** | [**DdrAPIBatchObjectRelationshipEntity**](DdrAPIBatchObjectRelationshipEntity.md) |  | [optional] 
+**roles** | [**DdrAPIBatchObjectRoleEntity**](DdrAPIBatchObjectRoleEntity.md) |  | [optional] 
+**links** | [**Array<DdrAPILinkEntity>**](DdrAPILinkEntity.md) |  | [optional] 
+
+

data/docs/DdrAPIBatchObjectMessageEntity.md

@@ -0,0 +1,13 @@
+# DdrClient::DdrAPIBatchObjectMessageEntity
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**batch_object_id** | **String** |  | [optional] 
+**level** | **String** |  | [optional] 
+**message** | **String** |  | [optional] 
+**created_at** | **String** |  | [optional] 
+**updated_at** | **String** |  | [optional] 
+
+

data/docs/DdrAPIBatchObjectRelationshipEntity.md

@@ -0,0 +1,15 @@
+# DdrClient::DdrAPIBatchObjectRelationshipEntity
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**batch_object_id** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**operation** | **String** |  | [optional] 
+**object** | **String** |  | [optional] 
+**object_type** | **String** |  | [optional] 
+**created_at** | **String** |  | [optional] 
+**updated_at** | **String** |  | [optional] 
+
+

data/docs/DdrAPIBatchObjectRoleEntity.md

@@ -0,0 +1,15 @@
+# DdrClient::DdrAPIBatchObjectRoleEntity
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**batch_object_id** | **String** |  | [optional] 
+**operation** | **String** |  | [optional] 
+**agent** | **String** |  | [optional] 
+**role_type** | **String** |  | [optional] 
+**role_scope** | **String** |  | [optional] 
+**created_at** | **String** |  | [optional] 
+**updated_at** | **String** |  | [optional] 
+
+

data/docs/DdrAPIEventEntity.md

@@ -0,0 +1,17 @@
+# DdrClient::DdrAPIEventEntity
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | Event ID | [optional] 
+**resource_id** | **String** | ID of the resource to which the event pertains | [optional] 
+**type** | **String** | Event category | [optional] 
+**description** | **String** | Operator comment or automated summary of event action | [optional] 
+**event_date_time** | **DateTime** | When the event occurred or was recorded | [optional] 
+**outcome** | **String** | Event outcome cast as a success or failure | [optional] 
+**software** | **String** | Software associated with the event | [optional] [default to 'ddr-admin 2.0.0+de733cf0']
+**detail** | **String** | Additional description of or information from the event, such as an exception | [optional] 
+**operator** | **String** | Person or entity responsible for initiating or causing the event | [optional] [default to 'SYSTEM']
+**links** | [**DdrAPILinkEntity**](DdrAPILinkEntity.md) |  | [optional] 
+
+

data/docs/DdrAPIFileEntity.md

@@ -0,0 +1,11 @@
+# DdrClient::DdrAPIFileEntity
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**original_filename** | **String** | Original name of file at time of ingest | [optional] 
+**media_type** | **String** | Standard internet media type descriptor for file content | [optional] 
+**file_path** | **String** | Path to file on a storage device | [optional] 
+**sha1** | **String** | SHA1 digest of file contents | [optional] 
+
+

data/docs/DdrAPIGroupEntity.md

@@ -0,0 +1,10 @@
+# DdrClient::DdrAPIGroupEntity
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**label** | **String** |  | [optional] 
+**members** | [**DdrAPIGroupMemberEntity**](DdrAPIGroupMemberEntity.md) |  | [optional] 
+
+

data/docs/DdrAPIGroupMemberEntity.md

@@ -0,0 +1,10 @@
+# DdrClient::DdrAPIGroupMemberEntity
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**type** | **String** |  | [optional] 
+
+

data/docs/DdrAPILinkEntity.md

@@ -0,0 +1,9 @@
+# DdrClient::DdrAPILinkEntity
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**href** | **String** |  | [optional] 
+**rel** | **String** |  | [optional] 
+
+

data/docs/DdrAPIResourceEntity.md

@@ -0,0 +1,17 @@
+# DdrClient::DdrAPIResourceEntity
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** | Unique resource identifier assigned by the repository | [optional] 
+**model** | **String** | The model type of the resource | [optional] 
+**created_at** | **DateTime** | Creation time of the database record (may differ from ingestion date) | [optional] 
+**updated_at** | **DateTime** | Modification time of the database record | [optional] 
+**optimistic_lock_token** | **String** | Token required for update with optimistic locking | [optional] 
+**metadata** | [**DdrAPIResourceEntityMetadata**](DdrAPIResourceEntityMetadata.md) |  | [optional] 
+**roles** | [**Array<DdrAPIRoleEntity>**](DdrAPIRoleEntity.md) | Role-based access control assertions on the resource | [optional] 
+**files** | [**DdrAPIResourceEntityFiles**](DdrAPIResourceEntityFiles.md) |  | [optional] 
+**related** | [**DdrAPIResourceEntityRelated**](DdrAPIResourceEntityRelated.md) |  | [optional] 
+**links** | [**Array<DdrAPILinkEntity>**](DdrAPILinkEntity.md) |  | [optional] 
+
+

data/docs/DdrAPIResourceEntityFiles.md

@@ -0,0 +1,17 @@
+# DdrClient::DdrAPIResourceEntityFiles
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**caption** | [**DdrAPIFileEntity**](DdrAPIFileEntity.md) | http://pcdm.org/use#Transcript | [optional] 
+**content** | [**DdrAPIFileEntity**](DdrAPIFileEntity.md) | http://pcdm.org/use#OriginalFile | [optional] 
+**derived_image** | [**DdrAPIFileEntity**](DdrAPIFileEntity.md) | http://pcdm.org/use#ServiceFile | [optional] 
+**extracted_text** | [**DdrAPIFileEntity**](DdrAPIFileEntity.md) | http://pcdm.org/use#ExtractedText | [optional] 
+**fits_file** | [**DdrAPIFileEntity**](DdrAPIFileEntity.md) | FITS XML file characterization data for the original file | [optional] 
+**intermediate_file** | [**DdrAPIFileEntity**](DdrAPIFileEntity.md) | http://pcdm.org/use#IntermediateFile | [optional] 
+**multires_image** | [**DdrAPIFileEntity**](DdrAPIFileEntity.md) | Derivative file for UI support | [optional] 
+**streamable_media** | [**DdrAPIFileEntity**](DdrAPIFileEntity.md) | Derivative file used for streaming | [optional] 
+**struct_metadata** | [**DdrAPIFileEntity**](DdrAPIFileEntity.md) | Structural metadata for the resource | [optional] 
+**thumbnail** | [**DdrAPIFileEntity**](DdrAPIFileEntity.md) | http://pcdm.org/use#ThumbnailImage | [optional] 
+
+

data/docs/DdrAPIResourceEntityMetadata.md

@@ -0,0 +1,62 @@
+# DdrClient::DdrAPIResourceEntityMetadata
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**abstract** | **Array<String>** | http://purl.org/dc/terms/abstract | [optional] 
+**access_rights** | **Array<String>** | http://purl.org/dc/terms/accessRights | [optional] 
+**alternative** | **Array<String>** | http://purl.org/dc/terms/alternative | [optional] 
+**available** | **DateTime** | http://purl.org/dc/terms/available | [optional] 
+**contributor** | **Array<String>** | http://purl.org/dc/terms/contributor | [optional] 
+**creator** | **Array<String>** | http://purl.org/dc/terms/creator | [optional] 
+**date** | **Array<String>** | http://purl.org/dc/terms/date | [optional] 
+**description** | **Array<String>** | http://purl.org/dc/terms/description | [optional] 
+**extent** | **Array<String>** | http://purl.org/dc/terms/extent | [optional] 
+**format** | **Array<String>** | http://purl.org/dc/terms/format | [optional] 
+**has_part** | **Array<String>** | http://purl.org/dc/terms/hasPart | [optional] 
+**identifier** | **Array<String>** | http://purl.org/dc/terms/identifier | [optional] 
+**is_format_of** | **Array<String>** | http://purl.org/dc/terms/isFormatOf | [optional] 
+**is_part_of** | **Array<String>** | http://purl.org/dc/terms/isPartOf | [optional] 
+**language** | **Array<String>** | http://purl.org/dc/terms/language | [optional] 
+**medium** | **Array<String>** | http://purl.org/dc/terms/medium | [optional] 
+**provenance** | **Array<String>** | http://purl.org/dc/terms/provenance | [optional] 
+**publisher** | **Array<String>** | http://purl.org/dc/terms/publisher | [optional] 
+**relation** | **Array<String>** | http://purl.org/dc/terms/relation | [optional] 
+**rights** | **Array<String>** | http://purl.org/dc/terms/rights | [optional] 
+**spatial** | **Array<String>** | http://purl.org/dc/terms/spatial | [optional] 
+**subject** | **Array<String>** | http://purl.org/dc/terms/subject | [optional] 
+**title** | **Array<String>** | http://purl.org/dc/terms/title | [optional] 
+**type** | **Array<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** | **DateTime** | 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** | **Array<String>** | Rights Note | [optional] 
+**workflow_state** | **String** | Workflow State | [optional] [default to 'unpublished']
+**biblical_book** | **Array<String>** | Biblical Book | [optional] 
+**category** | **Array<String>** | Category | [optional] 
+**chapter_and_verse** | **Array<String>** | Chapter And Verse | [optional] 
+**company** | **Array<String>** | Company | [optional] 
+**headline** | **Array<String>** | Headline | [optional] 
+**issue_number** | **Array<String>** | Issue Number | [optional] 
+**placement_company** | **Array<String>** | Placement Company | [optional] 
+**product** | **Array<String>** | Product | [optional] 
+**publication** | **Array<String>** | Publication | [optional] 
+**series** | **Array<String>** | Series | [optional] 
+**setting** | **Array<String>** | Setting | [optional] 
+**sponsor** | **Array<String>** | Sponsor | [optional] 
+**tone** | **Array<String>** | Tone | [optional] 
+**volume** | **Array<String>** | Volume | [optional] 
+
+

data/docs/DdrAPIResourceEntityRelated.md

@@ -0,0 +1,11 @@
+# DdrClient::DdrAPIResourceEntityRelated
+
+## 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/DdrAPIRoleEntity.md

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

data/docs/DdrAPITechnicalMetadataEntity.md

@@ -0,0 +1,24 @@
+# DdrClient::DdrAPITechnicalMetadataEntity
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **String** |  | [optional] 
+**local_id** | **String** |  | [optional] 
+**color_space** | **String** |  | [optional] 
+**created** | **String** |  | [optional] 
+**creating_application** | **String** |  | [optional] 
+**extent** | **String** |  | [optional] 
+**format_label** | **String** |  | [optional] 
+**format_version** | **String** |  | [optional] 
+**icc_profile_name** | **String** |  | [optional] 
+**icc_profile_version** | **String** |  | [optional] 
+**image_height** | **String** |  | [optional] 
+**image_width** | **String** |  | [optional] 
+**media_type** | **String** |  | [optional] 
+**modified** | **String** |  | [optional] 
+**pronom_identifier** | **String** |  | [optional] 
+**valid** | **String** |  | [optional] 
+**well_formed** | **String** |  | [optional] 
+
+

data/docs/DdrAPIUserEntity.md

@@ -0,0 +1,19 @@
+# DdrClient::DdrAPIUserEntity
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**id** | **Integer** | User ID | [optional] 
+**username** | **String** | User Name | [optional] 
+**netid** | **String** | Duke NetID | [optional] 
+**duid** | **String** | Duke Unique ID | [optional] 
+**email** | **String** | Email Address | [optional] 
+**first_name** | **String** | First Name | [optional] 
+**middle_name** | **String** | Middle Name | [optional] 
+**nickname** | **String** | Nickname | [optional] 
+**last_name** | **String** | Last Name | [optional] 
+**display_name** | **String** | Display Name | [optional] 
+**created_at** | **DateTime** | Created At | [optional] 
+**updated_at** | **DateTime** | Updated At | [optional] 
+
+

data/docs/EventsApi.md

@@ -0,0 +1,131 @@
+# DdrClient::EventsApi
+
+All URIs are relative to *https://example.org/api*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_events**](EventsApi.md#get_events) | **GET** /events | 
+[**get_events_id**](EventsApi.md#get_events_id) | **GET** /events/{id} | 
+
+
+# **get_events**
+> Array<DdrAPIEventEntity> get_events(opts)
+
+
+
+Retrieve events
+
+### 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::EventsApi.new
+
+opts = { 
+  resource_id: 'resource_id_example', # String | Filter by resource (required for XML output)
+  type: 'type_example', # String | Filter by event type
+  outcome: 'outcome_example', # String | Filter by event outcome
+  operator: 'operator_example', # String | Filter by event operator (user name or \"SYSTEM\")
+  since: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter events occurring since a point a time
+  before: DateTime.parse('2013-10-20T19:20:30+01:00'), # DateTime | Filter events occurring up to (before) a point in time
+  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_events(opts)
+  p result
+rescue DdrClient::ApiError => e
+  puts "Exception when calling EventsApi->get_events: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **resource_id** | **String**| Filter by resource (required for XML output) | [optional] 
+ **type** | **String**| Filter by event type | [optional] 
+ **outcome** | **String**| Filter by event outcome | [optional] 
+ **operator** | **String**| Filter by event operator (user name or \"SYSTEM\") | [optional] 
+ **since** | **DateTime**| Filter events occurring since a point a time | [optional] 
+ **before** | **DateTime**| Filter events occurring up to (before) a point in time | [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<DdrAPIEventEntity>**](DdrAPIEventEntity.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, text/csv, text/xml
+
+
+
+# **get_events_id**
+> DdrAPIEventEntity get_events_id(id)
+
+
+
+Retrieve event
+
+### 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::EventsApi.new
+
+id = 'id_example' # String | 
+
+
+begin
+  result = api_instance.get_events_id(id)
+  p result
+rescue DdrClient::ApiError => e
+  puts "Exception when calling EventsApi->get_events_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **String**|  | 
+
+### Return type
+
+[**DdrAPIEventEntity**](DdrAPIEventEntity.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, text/xml
+
+
+

data/docs/GroupsApi.md

@@ -0,0 +1,63 @@
+# DdrClient::GroupsApi
+
+All URIs are relative to *https://example.org/api*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_groups**](GroupsApi.md#get_groups) | **GET** /groups | 
+
+
+# **get_groups**
+> Array<DdrAPIGroupEntity> get_groups(opts)
+
+
+
+List repository groups
+
+### 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::GroupsApi.new
+
+opts = { 
+  include_members: false # BOOLEAN | Include members for each group
+}
+
+begin
+  result = api_instance.get_groups(opts)
+  p result
+rescue DdrClient::ApiError => e
+  puts "Exception when calling GroupsApi->get_groups: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **include_members** | **BOOLEAN**| Include members for each group | [optional] [default to false]
+
+### Return type
+
+[**Array<DdrAPIGroupEntity>**](DdrAPIGroupEntity.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+