ddr_client 2.0.0.d9f2bd2b

data/lib/ddr_client/api/queues_api.rb

@@ -0,0 +1,109 @@
+=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 QueuesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Unlock locked jobs
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_queues_locks(opts = {})
+      delete_queues_locks_with_http_info(opts)
+      nil
+    end
+
+    # Unlock locked jobs
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def delete_queues_locks_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: QueuesApi.delete_queues_locks ...'
+      end
+      # resource path
+      local_var_path = '/queues/locks'
+
+      # 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: QueuesApi#delete_queues_locks\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Retrieve summary infomation on background job queues
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def get_queues_stats(opts = {})
+      get_queues_stats_with_http_info(opts)
+      nil
+    end
+
+    # Retrieve summary infomation on background job queues
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def get_queues_stats_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: QueuesApi.get_queues_stats ...'
+      end
+      # resource path
+      local_var_path = '/queues/stats'
+
+      # 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: QueuesApi#get_queues_stats\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/ddr_client/api/reports_api.rb

@@ -0,0 +1,179 @@
+=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 ReportsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Collection summary report
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :fields Fields to include for each collection (default: id, title, ingestion_date, admin_set, workflow_state)
+    # @return [File]
+    def get_reports_collection_summary(opts = {})
+      data, _status_code, _headers = get_reports_collection_summary_with_http_info(opts)
+      data
+    end
+
+    # Collection summary report
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :fields Fields to include for each collection (default: id, title, ingestion_date, admin_set, workflow_state)
+    # @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
+    def get_reports_collection_summary_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ReportsApi.get_reports_collection_summary ...'
+      end
+      if @api_client.config.client_side_validation && opts[:'fields'] && !opts[:'fields'].all? { |item| ['abstract', 'accessRights', 'admin_set', 'aleph_id', 'alternative', 'aspace_id', 'available', 'biblical_book', 'caption', 'category', 'chapter_and_verse', 'company', 'content', 'contentdm_id', 'contributor', 'created_at', 'creator', 'date', 'derived_image', 'description', 'display_format', 'doi', 'ead_id', 'extent', 'extracted_text', 'fcrepo3_pid', 'fits_file', 'format', 'hasPart', 'headline', 'id', 'identifier', 'ingested_by', 'ingestion_date', 'intermediate_file', 'isFormatOf', 'isPartOf', 'issue_number', 'language', 'local_id', 'medium', 'model', 'multires_image', 'nested_path', 'optimistic_lock_token', 'permanent_id', 'permanent_url', 'placement_company', 'product', 'provenance', 'publication', 'publisher', 'relation', 'research_help_contact', 'rights', 'rights_note', 'roles', 'series', 'setting', 'spatial', 'sponsor', 'streamable_media', 'struct_metadata', 'subject', 'thumbnail', 'title', 'tone', 'type', 'updated_at', 'volume', 'workflow_state'].include?(item) }
+        fail ArgumentError, 'invalid value for "fields", must include one of abstract, accessRights, admin_set, aleph_id, alternative, aspace_id, available, biblical_book, caption, category, chapter_and_verse, company, content, contentdm_id, contributor, created_at, creator, date, derived_image, description, display_format, doi, ead_id, extent, extracted_text, fcrepo3_pid, fits_file, format, hasPart, headline, id, identifier, ingested_by, ingestion_date, intermediate_file, isFormatOf, isPartOf, issue_number, language, local_id, medium, model, multires_image, nested_path, optimistic_lock_token, permanent_id, permanent_url, placement_company, product, provenance, publication, publisher, relation, research_help_contact, rights, rights_note, roles, series, setting, spatial, sponsor, streamable_media, struct_metadata, subject, thumbnail, title, tone, type, updated_at, volume, workflow_state'
+      end
+      # resource path
+      local_var_path = '/reports/collection_summary'
+
+      # query parameters
+      query_params = {}
+      query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['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 => 'File')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ReportsApi#get_reports_collection_summary\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Duplicate content report
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :fields Fields to include in the report (default: sha1, id, model, original_filename, parent_id, collection_title, workflow_state, ingestion_date)
+    # @return [File]
+    def get_reports_duplicate_content(opts = {})
+      data, _status_code, _headers = get_reports_duplicate_content_with_http_info(opts)
+      data
+    end
+
+    # Duplicate content report
+    # @param [Hash] opts the optional parameters
+    # @option opts [Array<String>] :fields Fields to include in the report (default: sha1, id, model, original_filename, parent_id, collection_title, workflow_state, ingestion_date)
+    # @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
+    def get_reports_duplicate_content_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ReportsApi.get_reports_duplicate_content ...'
+      end
+      if @api_client.config.client_side_validation && opts[:'fields'] && !opts[:'fields'].all? { |item| ['abstract', 'accessRights', 'admin_set', 'aleph_id', 'alternative', 'aspace_id', 'available', 'biblical_book', 'caption', 'category', 'chapter_and_verse', 'collection_id', 'collection_title', 'company', 'content', 'contentdm_id', 'contributor', 'created_at', 'creator', 'date', 'derived_image', 'description', 'display_format', 'doi', 'ead_id', 'extent', 'extracted_text', 'fcrepo3_pid', 'fits_file', 'format', 'hasPart', 'headline', 'id', 'identifier', 'ingested_by', 'ingestion_date', 'intermediate_file', 'isFormatOf', 'isPartOf', 'issue_number', 'language', 'local_id', 'medium', 'model', 'multires_image', 'nested_path', 'optimistic_lock_token', 'original_filename', 'parent_id', 'parent_title', 'permanent_id', 'permanent_url', 'placement_company', 'product', 'provenance', 'publication', 'publisher', 'relation', 'research_help_contact', 'rights', 'rights_note', 'roles', 'series', 'setting', 'sha1', 'spatial', 'sponsor', 'streamable_media', 'struct_metadata', 'subject', 'thumbnail', 'title', 'tone', 'type', 'updated_at', 'volume', 'workflow_state'].include?(item) }
+        fail ArgumentError, 'invalid value for "fields", must include one of abstract, accessRights, admin_set, aleph_id, alternative, aspace_id, available, biblical_book, caption, category, chapter_and_verse, collection_id, collection_title, company, content, contentdm_id, contributor, created_at, creator, date, derived_image, description, display_format, doi, ead_id, extent, extracted_text, fcrepo3_pid, fits_file, format, hasPart, headline, id, identifier, ingested_by, ingestion_date, intermediate_file, isFormatOf, isPartOf, issue_number, language, local_id, medium, model, multires_image, nested_path, optimistic_lock_token, original_filename, parent_id, parent_title, permanent_id, permanent_url, placement_company, product, provenance, publication, publisher, relation, research_help_contact, rights, rights_note, roles, series, setting, sha1, spatial, sponsor, streamable_media, struct_metadata, subject, thumbnail, title, tone, type, updated_at, volume, workflow_state'
+      end
+      # resource path
+      local_var_path = '/reports/duplicate_content'
+
+      # query parameters
+      query_params = {}
+      query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['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 => 'File')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ReportsApi#get_reports_duplicate_content\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+    # Roles report
+    # @param [Hash] opts the optional parameters
+    # @option opts [BOOLEAN] :include_inherited Include inherited roles for Item resources (default to false)
+    # @option opts [String] :collection_id Limit resources to members of Collection ID
+    # @option opts [Array<String>] :fields Fields to include in the report (default: id, model, title)
+    # @return [File]
+    def get_reports_roles(opts = {})
+      data, _status_code, _headers = get_reports_roles_with_http_info(opts)
+      data
+    end
+
+    # Roles report
+    # @param [Hash] opts the optional parameters
+    # @option opts [BOOLEAN] :include_inherited Include inherited roles for Item resources
+    # @option opts [String] :collection_id Limit resources to members of Collection ID
+    # @option opts [Array<String>] :fields Fields to include in the report (default: id, model, title)
+    # @return [Array<(File, Fixnum, Hash)>] File data, response status code and response headers
+    def get_reports_roles_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ReportsApi.get_reports_roles ...'
+      end
+      if @api_client.config.client_side_validation && opts[:'fields'] && !opts[:'fields'].all? { |item| ['abstract', 'accessRights', 'admin_set', 'aleph_id', 'alternative', 'aspace_id', 'available', 'biblical_book', 'caption', 'category', 'chapter_and_verse', 'collection_id', 'collection_title', 'company', 'content', 'contentdm_id', 'contributor', 'created_at', 'creator', 'date', 'derived_image', 'description', 'display_format', 'doi', 'ead_id', 'extent', 'extracted_text', 'fcrepo3_pid', 'fits_file', 'format', 'hasPart', 'headline', 'id', 'identifier', 'ingested_by', 'ingestion_date', 'intermediate_file', 'isFormatOf', 'isPartOf', 'issue_number', 'language', 'local_id', 'medium', 'model', 'multires_image', 'nested_path', 'optimistic_lock_token', 'original_filename', 'parent_id', 'parent_title', 'permanent_id', 'permanent_url', 'placement_company', 'product', 'provenance', 'publication', 'publisher', 'relation', 'research_help_contact', 'rights', 'rights_note', 'roles', 'series', 'setting', 'sha1', 'spatial', 'sponsor', 'streamable_media', 'struct_metadata', 'subject', 'thumbnail', 'title', 'tone', 'type', 'updated_at', 'volume', 'workflow_state'].include?(item) }
+        fail ArgumentError, 'invalid value for "fields", must include one of abstract, accessRights, admin_set, aleph_id, alternative, aspace_id, available, biblical_book, caption, category, chapter_and_verse, collection_id, collection_title, company, content, contentdm_id, contributor, created_at, creator, date, derived_image, description, display_format, doi, ead_id, extent, extracted_text, fcrepo3_pid, fits_file, format, hasPart, headline, id, identifier, ingested_by, ingestion_date, intermediate_file, isFormatOf, isPartOf, issue_number, language, local_id, medium, model, multires_image, nested_path, optimistic_lock_token, original_filename, parent_id, parent_title, permanent_id, permanent_url, placement_company, product, provenance, publication, publisher, relation, research_help_contact, rights, rights_note, roles, series, setting, sha1, spatial, sponsor, streamable_media, struct_metadata, subject, thumbnail, title, tone, type, updated_at, volume, workflow_state'
+      end
+      # resource path
+      local_var_path = '/reports/roles'
+
+      # query parameters
+      query_params = {}
+      query_params[:'include_inherited'] = opts[:'include_inherited'] if !opts[:'include_inherited'].nil?
+      query_params[:'collection_id'] = opts[:'collection_id'] if !opts[:'collection_id'].nil?
+      query_params[:'fields'] = @api_client.build_collection_param(opts[:'fields'], :csv) if !opts[:'fields'].nil?
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['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 => 'File')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ReportsApi#get_reports_roles\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end