ddr_client 2.0.0.d9f2bd2b

data/docs/SchemaApi.md

@@ -0,0 +1,128 @@
+# DdrClient::SchemaApi
+
+All URIs are relative to *https://example.org/api*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_schema_event**](SchemaApi.md#get_schema_event) | **GET** /schema/event | 
+[**get_schema_resource**](SchemaApi.md#get_schema_resource) | **GET** /schema/resource | 
+[**get_schema_user**](SchemaApi.md#get_schema_user) | **GET** /schema/user | 
+
+
+# **get_schema_event**
+> get_schema_event
+
+
+
+Event schema
+
+### Example
+```ruby
+# load the gem
+require 'ddr_client'
+
+api_instance = DdrClient::SchemaApi.new
+
+begin
+  api_instance.get_schema_event
+rescue DdrClient::ApiError => e
+  puts "Exception when calling SchemaApi->get_schema_event: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/schema+json
+
+
+
+# **get_schema_resource**
+> get_schema_resource
+
+
+
+Resource schema
+
+### Example
+```ruby
+# load the gem
+require 'ddr_client'
+
+api_instance = DdrClient::SchemaApi.new
+
+begin
+  api_instance.get_schema_resource
+rescue DdrClient::ApiError => e
+  puts "Exception when calling SchemaApi->get_schema_resource: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/schema+json
+
+
+
+# **get_schema_user**
+> get_schema_user
+
+
+
+User schema
+
+### Example
+```ruby
+# load the gem
+require 'ddr_client'
+
+api_instance = DdrClient::SchemaApi.new
+
+begin
+  api_instance.get_schema_user
+rescue DdrClient::ApiError => e
+  puts "Exception when calling SchemaApi->get_schema_user: #{e}"
+end
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/schema+json
+
+
+

data/docs/UsersApi.md

@@ -0,0 +1,131 @@
+# DdrClient::UsersApi
+
+All URIs are relative to *https://example.org/api*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_users**](UsersApi.md#get_users) | **GET** /users | 
+[**get_users_id**](UsersApi.md#get_users_id) | **GET** /users/{id} | 
+
+
+# **get_users**
+> Array<DdrAPIUserEntity> get_users(opts)
+
+
+
+List users
+
+### 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::UsersApi.new
+
+opts = { 
+  username: 'username_example', # String | User Name
+  netid: 'netid_example', # String | Duke NetID
+  duid: 'duid_example', # String | Duke Unique ID
+  email: 'email_example', # String | Email Address
+  first_name: 'first_name_example', # String | First Name
+  last_name: 'last_name_example', # String | Last Name
+  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_users(opts)
+  p result
+rescue DdrClient::ApiError => e
+  puts "Exception when calling UsersApi->get_users: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **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] 
+ **last_name** | **String**| Last Name | [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<DdrAPIUserEntity>**](DdrAPIUserEntity.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, text/csv
+
+
+
+# **get_users_id**
+> DdrAPIUserEntity get_users_id(id)
+
+
+
+Retrieve a user 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::UsersApi.new
+
+id = 56 # Integer | 
+
+
+begin
+  result = api_instance.get_users_id(id)
+  p result
+rescue DdrClient::ApiError => e
+  puts "Exception when calling UsersApi->get_users_id: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**|  | 
+
+### Return type
+
+[**DdrAPIUserEntity**](DdrAPIUserEntity.md)
+
+### Authorization
+
+[oauth](../README.md#oauth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+

data/git_push.sh

@@ -0,0 +1,55 @@
+#!/bin/sh
+#
+# Generated by: https://github.com/swagger-api/swagger-codegen.git
+#
+# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
+#
+# Usage example: /bin/sh ./git_push.sh wing328 swagger-petstore-perl "minor update"
+
+git_user_id=$1
+git_repo_id=$2
+release_note=$3
+
+if [ "$git_user_id" = "" ]; then
+    git_user_id="GIT_USER_ID"
+    echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
+fi
+
+if [ "$git_repo_id" = "" ]; then
+    git_repo_id="GIT_REPO_ID"
+    echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
+fi
+
+if [ "$release_note" = "" ]; then
+    release_note="Minor update"
+    echo "[INFO] No command line input provided. Set \$release_note to $release_note"
+fi
+
+# Initialize the local directory as a Git repository
+git init
+
+# Adds the files in the local repository and stages them for commit.
+git add .
+
+# Commits the tracked changes and prepares them to be pushed to a remote repository.
+git commit -m "$release_note"
+
+# Sets the new remote
+git_remote=`git remote`
+if [ "$git_remote" = "" ]; then # git remote not defined
+
+    if [ "$GIT_TOKEN" = "" ]; then
+        echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
+        git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
+    else
+        git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
+    fi
+
+fi
+
+git pull origin master
+
+# Pushes (Forces) the changes in the local repository up to the remote repository
+echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
+git push origin master 2>&1 | grep -v 'To https'
+

data/lib/ddr_client/api/batch_objects_api.rb

@@ -0,0 +1,138 @@
+=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
+
+require 'uri'
+
+module DdrClient
+  class BatchObjectsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Retrieve batch object records
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :resource_id Filter by resource ID
+    # @option opts [String] :type Filter by batch object type
+    # @option opts [Array<String>] :model Filter by models(s)
+    # @option opts [Object] :per_page JSON only: Number of records to return per page (default: 20)
+    # @option opts [Object] :page JSON only: Page number of results to return (default: 1)
+    # @return [Array<DdrAPIBatchObjectEntity>]
+    def get_batch_objects(opts = {})
+      data, _status_code, _headers = get_batch_objects_with_http_info(opts)
+      data
+    end
+
+    # Retrieve batch object records
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :resource_id Filter by resource ID
+    # @option opts [String] :type Filter by batch object type
+    # @option opts [Array<String>] :model Filter by models(s)
+    # @option opts [Object] :per_page JSON only: Number of records to return per page (default: 20)
+    # @option opts [Object] :page JSON only: Page number of results to return (default: 1)
+    # @return [Array<(Array<DdrAPIBatchObjectEntity>, Fixnum, Hash)>] Array<DdrAPIBatchObjectEntity> data, response status code and response headers
+    def get_batch_objects_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BatchObjectsApi.get_batch_objects ...'
+      end
+      if @api_client.config.client_side_validation && opts[:'type'] && !['Ingest', 'Update'].include?(opts[:'type'])
+        fail ArgumentError, 'invalid value for "type", must be one of Ingest, Update'
+      end
+      if @api_client.config.client_side_validation && opts[:'model'] && !opts[:'model'].all? { |item| ['Collection', 'Item', 'Component', 'Target', 'Attachment'].include?(item) }
+        fail ArgumentError, 'invalid value for "model", must include one of Collection, Item, Component, Target, Attachment'
+      end
+      # resource path
+      local_var_path = '/batch_objects'
+
+      # query parameters
+      query_params = {}
+      query_params[:'resource_id'] = opts[:'resource_id'] if !opts[:'resource_id'].nil?
+      query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
+      query_params[:'model'] = @api_client.build_collection_param(opts[:'model'], :csv) if !opts[:'model'].nil?
+      query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/csv'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['oauth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'Array<DdrAPIBatchObjectEntity>')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: BatchObjectsApi#get_batch_objects\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Retrieve a batch object record with details (attributes, files, messages, relationships, roles)
+    # @param id 
+    # @param [Hash] opts the optional parameters
+    # @return [DdrAPIBatchObjectEntity]
+    def get_batch_objects_id(id, opts = {})
+      data, _status_code, _headers = get_batch_objects_id_with_http_info(id, opts)
+      data
+    end
+
+    # Retrieve a batch object record with details (attributes, files, messages, relationships, roles)
+    # @param id 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(DdrAPIBatchObjectEntity, Fixnum, Hash)>] DdrAPIBatchObjectEntity data, response status code and response headers
+    def get_batch_objects_id_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BatchObjectsApi.get_batch_objects_id ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling BatchObjectsApi.get_batch_objects_id"
+      end
+      # resource path
+      local_var_path = '/batch_objects/{id}'.sub('{' + 'id' + '}', id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['oauth']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'DdrAPIBatchObjectEntity')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: BatchObjectsApi#get_batch_objects_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end