ddr_client 2.0.0.d9f2bd2b

data/lib/ddr_client/api/batches_api.rb

@@ -0,0 +1,306 @@
+=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 BatchesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # List batches
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :outcome Filter by batch processing outcome
+    # @option opts [Integer] :user_id Filter by user ID associated with the batch
+    # @option opts [String] :status Filter by batch status
+    # @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<DdrAPIBatchEntity>]
+    def get_batches(opts = {})
+      data, _status_code, _headers = get_batches_with_http_info(opts)
+      data
+    end
+
+    # List batches
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :outcome Filter by batch processing outcome
+    # @option opts [Integer] :user_id Filter by user ID associated with the batch
+    # @option opts [String] :status Filter by batch status
+    # @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<DdrAPIBatchEntity>, Fixnum, Hash)>] Array<DdrAPIBatchEntity> data, response status code and response headers
+    def get_batches_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BatchesApi.get_batches ...'
+      end
+      if @api_client.config.client_side_validation && opts[:'outcome'] && !['SUCCESS', 'FAILURE'].include?(opts[:'outcome'])
+        fail ArgumentError, 'invalid value for "outcome", must be one of SUCCESS, FAILURE'
+      end
+      if @api_client.config.client_side_validation && opts[:'status'] && !['READY', 'VALIDATING', 'INVALID', 'VALIDATED', 'QUEUED', 'PROCESSING', 'RUNNING', 'FINISHED', 'INTERRUPTED', 'INTERRUPTED - RESTARTABLE', 'QUEUED FOR DELETION', 'DELETING'].include?(opts[:'status'])
+        fail ArgumentError, 'invalid value for "status", must be one of READY, VALIDATING, INVALID, VALIDATED, QUEUED, PROCESSING, RUNNING, FINISHED, INTERRUPTED, INTERRUPTED - RESTARTABLE, QUEUED FOR DELETION, DELETING'
+      end
+      # resource path
+      local_var_path = '/batches'
+
+      # query parameters
+      query_params = {}
+      query_params[:'outcome'] = opts[:'outcome'] if !opts[:'outcome'].nil?
+      query_params[:'user_id'] = opts[:'user_id'] if !opts[:'user_id'].nil?
+      query_params[:'status'] = opts[:'status'] if !opts[:'status'].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<DdrAPIBatchEntity>')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: BatchesApi#get_batches\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Retrieve a batch record
+    # @param id 
+    # @param [Hash] opts the optional parameters
+    # @option opts [BOOLEAN] :batch_objects Include related batch objects (not paginated) (default to false)
+    # @return [DdrAPIBatchEntity]
+    def get_batches_id(id, opts = {})
+      data, _status_code, _headers = get_batches_id_with_http_info(id, opts)
+      data
+    end
+
+    # Retrieve a batch record
+    # @param id 
+    # @param [Hash] opts the optional parameters
+    # @option opts [BOOLEAN] :batch_objects Include related batch objects (not paginated)
+    # @return [Array<(DdrAPIBatchEntity, Fixnum, Hash)>] DdrAPIBatchEntity data, response status code and response headers
+    def get_batches_id_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BatchesApi.get_batches_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 BatchesApi.get_batches_id"
+      end
+      # resource path
+      local_var_path = '/batches/{id}'.sub('{' + 'id' + '}', id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'batch_objects'] = opts[:'batch_objects'] if !opts[:'batch_objects'].nil?
+
+      # 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 => 'DdrAPIBatchEntity')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: BatchesApi#get_batches_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Retrieve the batch objects for a batch
+    # @param id 
+    # @param [Hash] opts the optional parameters
+    # @option opts [BOOLEAN] :batch_object_details JSON only: Include related attributes, files, messages, relationships, and roles for each batch object (default to true)
+    # @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_batches_id_batch_objects(id, opts = {})
+      data, _status_code, _headers = get_batches_id_batch_objects_with_http_info(id, opts)
+      data
+    end
+
+    # Retrieve the batch objects for a batch
+    # @param id 
+    # @param [Hash] opts the optional parameters
+    # @option opts [BOOLEAN] :batch_object_details JSON only: Include related attributes, files, messages, relationships, and roles for each batch object
+    # @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_batches_id_batch_objects_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BatchesApi.get_batches_id_batch_objects ...'
+      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 BatchesApi.get_batches_id_batch_objects"
+      end
+      # resource path
+      local_var_path = '/batches/{id}/batch_objects'.sub('{' + 'id' + '}', id.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'batch_object_details'] = opts[:'batch_object_details'] if !opts[:'batch_object_details'].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: BatchesApi#get_batches_id_batch_objects\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Download the batch log file
+    # @param id 
+    # @param [Hash] opts the optional parameters
+    # @return [File]
+    def get_batches_id_log(id, opts = {})
+      data, _status_code, _headers = get_batches_id_log_with_http_info(id, opts)
+      data
+    end
+
+    # Download the batch log file
+    # @param id 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
+    def get_batches_id_log_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BatchesApi.get_batches_id_log ...'
+      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 BatchesApi.get_batches_id_log"
+      end
+      # resource path
+      local_var_path = '/batches/{id}/log'.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(['text/plain'])
+
+      # 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 => 'File')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: BatchesApi#get_batches_id_log\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Retrieve the batch object messages for a batch
+    # @param id 
+    # @param [Hash] opts the optional parameters
+    # @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<DdrAPIBatchObjectMessageEntity>]
+    def get_batches_id_messages(id, opts = {})
+      data, _status_code, _headers = get_batches_id_messages_with_http_info(id, opts)
+      data
+    end
+
+    # Retrieve the batch object messages for a batch
+    # @param id 
+    # @param [Hash] opts the optional parameters
+    # @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<DdrAPIBatchObjectMessageEntity>, Fixnum, Hash)>] Array<DdrAPIBatchObjectMessageEntity> data, response status code and response headers
+    def get_batches_id_messages_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: BatchesApi.get_batches_id_messages ...'
+      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 BatchesApi.get_batches_id_messages"
+      end
+      # resource path
+      local_var_path = '/batches/{id}/messages'.sub('{' + 'id' + '}', id.to_s)
+
+      # query parameters
+      query_params = {}
+      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<DdrAPIBatchObjectMessageEntity>')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: BatchesApi#get_batches_id_messages\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/ddr_client/api/events_api.rb

@@ -0,0 +1,147 @@
+=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 EventsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Retrieve events
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :resource_id Filter by resource (required for XML output)
+    # @option opts [String] :type Filter by event type
+    # @option opts [String] :outcome Filter by event outcome
+    # @option opts [String] :operator Filter by event operator (user name or \"SYSTEM\")
+    # @option opts [DateTime] :since Filter events occurring since a point a time
+    # @option opts [DateTime] :before Filter events occurring up to (before) a point in time
+    # @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<DdrAPIEventEntity>]
+    def get_events(opts = {})
+      data, _status_code, _headers = get_events_with_http_info(opts)
+      data
+    end
+
+    # Retrieve events
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :resource_id Filter by resource (required for XML output)
+    # @option opts [String] :type Filter by event type
+    # @option opts [String] :outcome Filter by event outcome
+    # @option opts [String] :operator Filter by event operator (user name or \&quot;SYSTEM\&quot;)
+    # @option opts [DateTime] :since Filter events occurring since a point a time
+    # @option opts [DateTime] :before Filter events occurring up to (before) a point in time
+    # @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<DdrAPIEventEntity>, Fixnum, Hash)>] Array<DdrAPIEventEntity> data, response status code and response headers
+    def get_events_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EventsApi.get_events ...'
+      end
+      if @api_client.config.client_side_validation && opts[:'type'] && !['Creation', 'Deaccession', 'Deletion', 'FixityCheck', 'Ingestion', 'Migration', 'Update', 'Validation', 'VirusCheck'].include?(opts[:'type'])
+        fail ArgumentError, 'invalid value for "type", must be one of Creation, Deaccession, Deletion, FixityCheck, Ingestion, Migration, Update, Validation, VirusCheck'
+      end
+      if @api_client.config.client_side_validation && opts[:'outcome'] && !['success', 'failure'].include?(opts[:'outcome'])
+        fail ArgumentError, 'invalid value for "outcome", must be one of success, failure'
+      end
+      # resource path
+      local_var_path = '/events'
+
+      # 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[:'outcome'] = opts[:'outcome'] if !opts[:'outcome'].nil?
+      query_params[:'operator'] = opts[:'operator'] if !opts[:'operator'].nil?
+      query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
+      query_params[:'before'] = opts[:'before'] if !opts[:'before'].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', 'text/xml'])
+
+      # 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<DdrAPIEventEntity>')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EventsApi#get_events\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Retrieve event
+    # @param id 
+    # @param [Hash] opts the optional parameters
+    # @return [DdrAPIEventEntity]
+    def get_events_id(id, opts = {})
+      data, _status_code, _headers = get_events_id_with_http_info(id, opts)
+      data
+    end
+
+    # Retrieve event
+    # @param id 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(DdrAPIEventEntity, Fixnum, Hash)>] DdrAPIEventEntity data, response status code and response headers
+    def get_events_id_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EventsApi.get_events_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 EventsApi.get_events_id"
+      end
+      # resource path
+      local_var_path = '/events/{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', 'text/xml'])
+
+      # 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 => 'DdrAPIEventEntity')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EventsApi#get_events_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/ddr_client/api/groups_api.rb

@@ -0,0 +1,70 @@
+=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 GroupsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # List repository groups
+    # @param [Hash] opts the optional parameters
+    # @option opts [BOOLEAN] :include_members Include members for each group (default to false)
+    # @return [Array<DdrAPIGroupEntity>]
+    def get_groups(opts = {})
+      data, _status_code, _headers = get_groups_with_http_info(opts)
+      data
+    end
+
+    # List repository groups
+    # @param [Hash] opts the optional parameters
+    # @option opts [BOOLEAN] :include_members Include members for each group
+    # @return [Array<(Array<DdrAPIGroupEntity>, Fixnum, Hash)>] Array<DdrAPIGroupEntity> data, response status code and response headers
+    def get_groups_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GroupsApi.get_groups ...'
+      end
+      # resource path
+      local_var_path = '/groups'
+
+      # query parameters
+      query_params = {}
+      query_params[:'include_members'] = opts[:'include_members'] if !opts[:'include_members'].nil?
+
+      # 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 => 'Array<DdrAPIGroupEntity>')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: GroupsApi#get_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/ddr_client/api/index_api.rb

@@ -0,0 +1,164 @@
+=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 IndexApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Delete a document
+    # @param id 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_index_id(id, opts = {})
+      delete_index_id_with_http_info(id, opts)
+      nil
+    end
+
+    # Delete a document
+    # @param id 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def delete_index_id_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IndexApi.delete_index_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 IndexApi.delete_index_id"
+      end
+      # resource path
+      local_var_path = '/index/{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(:DELETE, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: IndexApi#delete_index_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Retrieve a document
+    # @param id 
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def get_index_id(id, opts = {})
+      get_index_id_with_http_info(id, opts)
+      nil
+    end
+
+    # Retrieve a document
+    # @param id 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def get_index_id_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IndexApi.get_index_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 IndexApi.get_index_id"
+      end
+      # resource path
+      local_var_path = '/index/{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)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: IndexApi#get_index_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Retrieve the index schema
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def get_index_schema(opts = {})
+      get_index_schema_with_http_info(opts)
+      nil
+    end
+
+    # Retrieve the index schema
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def get_index_schema_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: IndexApi.get_index_schema ...'
+      end
+      # resource path
+      local_var_path = '/index/schema'
+
+      # 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)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: IndexApi#get_index_schema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end