cmv4-openapi-client 1.0.3

data/lib/cmv4-openapi-client/api/general_organisational_settings_api.rb

@@ -0,0 +1,80 @@
+=begin
+#Consultation Manager REST API
+
+#The REST API for the Consultation Manager application
+
+The version of the OpenAPI document: v1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.2.3
+
+=end
+
+require 'cgi'
+
+module CMV4APIClient
+  class GeneralOrganisationalSettingsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get Organisational Settings
+    # Gets a specific type of organisational setting
+    # @param category [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [File]
+    def organisational_settings_get(category, opts = {})
+      data, _status_code, _headers = organisational_settings_get_with_http_info(category, opts)
+      data
+    end
+
+    # Get Organisational Settings
+    # Gets a specific type of organisational setting
+    # @param category [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(File, Integer, Hash)>] File data, response status code and response headers
+    def organisational_settings_get_with_http_info(category, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GeneralOrganisationalSettingsApi.organisational_settings_get ...'
+      end
+      # resource path
+      local_var_path = '/organisationalsettings/{category}'.sub('{' + 'category' + '}', CGI.escape(category.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'File' 
+
+      # auth_names
+      auth_names = opts[:auth_names] || []
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: GeneralOrganisationalSettingsApi#organisational_settings_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/cmv4-openapi-client/api/general_query_api.rb

@@ -0,0 +1,86 @@
+=begin
+#Consultation Manager REST API
+
+#The REST API for the Consultation Manager application
+
+The version of the OpenAPI document: v1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.2.3
+
+=end
+
+require 'cgi'
+
+module CMV4APIClient
+  class GeneralQueryApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Query Entity
+    # Gets an entity based on the passed request
+    # @param query_request [QueryRequest]
+    # @param [Hash] opts the optional parameters
+    # @return [Action]
+    def query_get(query_request, opts = {})
+      data, _status_code, _headers = query_get_with_http_info(query_request, opts)
+      data
+    end
+
+    # Query Entity
+    # Gets an entity based on the passed request
+    # @param query_request [QueryRequest]
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Action, Integer, Hash)>] Action data, response status code and response headers
+    def query_get_with_http_info(query_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GeneralQueryApi.query_get ...'
+      end
+      # verify the required parameter 'query_request' is set
+      if @api_client.config.client_side_validation && query_request.nil?
+        fail ArgumentError, "Missing the required parameter 'query_request' when calling GeneralQueryApi.query_get"
+      end
+      # resource path
+      local_var_path = '/query'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json+action', 'application/json+correspondence', 'application/json+document', 'application/json+event', 'application/json+organisation', 'application/json+project', 'application/json+property', 'application/json+stakeholder', 'application/json+team', 'application/json+user', 'application/json+ActionDocument', 'application/json+actionProjectRelationship', 'application/json+assignedByaction', 'application/json+assignedToaction', 'application/json+correspondenceProjectRelationship', 'application/json+CorrespondenceToStakeholder', 'application/json+CorrespondenceToUser', 'application/json+documentProjectRelationship', 'application/json+DocumentStakeholder', 'application/json+DocumentUser', 'application/json+EventAction', 'application/json+EventDocument', 'application/json+eventorganisation', 'application/json+eventProjectRelationship', 'application/json+EventUser', 'application/json+membership', 'application/json+organisationProjectRelationship', 'application/json+propertyAction', 'application/json+propertyDocument', 'application/json+propertyEvent', 'application/json+propertyorganisation', 'application/json+propertyProjectRelationship', 'application/json+propertyUser', 'application/json+sar', 'application/json+ser', 'application/json+spr', 'application/json+stakeholderorganisation', 'application/json+stakeholderProjectRelationship', 'application/json+teamProjectRelationship', 'application/json+userStakeholder'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(query_request)
+
+      # return_type
+      return_type = opts[:return_type] || 'Action'
+
+      # auth_names
+      auth_names = opts[:auth_names] || []
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: GeneralQueryApi#query_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end

data/lib/cmv4-openapi-client/api/general_search_api.rb

@@ -0,0 +1,150 @@
+=begin
+#Consultation Manager REST API
+
+#The REST API for the Consultation Manager application
+
+The version of the OpenAPI document: v1
+
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.2.3
+
+=end
+
+require 'cgi'
+
+module CMV4APIClient
+  class GeneralSearchApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get Search Data
+    # Gets the search data based up on the passed request
+    # @param search_request [SearchRequest]
+    # @param [Hash] opts the optional parameters
+    # @return [Action]
+    def search_search(search_request, opts = {})
+      data, _status_code, _headers = search_search_with_http_info(search_request, opts)
+      data
+    end
+
+    # Get Search Data
+    # Gets the search data based up on the passed request
+    # @param search_request [SearchRequest]
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Action, Integer, Hash)>] Action data, response status code and response headers
+    def search_search_with_http_info(search_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GeneralSearchApi.search_search ...'
+      end
+      # verify the required parameter 'search_request' is set
+      if @api_client.config.client_side_validation && search_request.nil?
+        fail ArgumentError, "Missing the required parameter 'search_request' when calling GeneralSearchApi.search_search"
+      end
+      # resource path
+      local_var_path = '/search'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json+action', 'application/json+correspondence', 'application/json+document', 'application/json+event', 'application/json+organisation', 'application/json+project', 'application/json+property', 'application/json+stakeholder', 'application/json+team', 'application/json+user'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(search_request)
+
+      # return_type
+      return_type = opts[:return_type] || 'Action'
+
+      # auth_names
+      auth_names = opts[:auth_names] || ['Bearer', 'Username / E-mail and Password']
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: GeneralSearchApi#search_search\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Perform Multiple Searches
+    # Gets the search data for each request in the array
+    # @param search_request [Array<SearchRequest>]
+    # @param [Hash] opts the optional parameters
+    # @return [Action]
+    def search_search_multi(search_request, opts = {})
+      data, _status_code, _headers = search_search_multi_with_http_info(search_request, opts)
+      data
+    end
+
+    # Perform Multiple Searches
+    # Gets the search data for each request in the array
+    # @param search_request [Array<SearchRequest>]
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Action, Integer, Hash)>] Action data, response status code and response headers
+    def search_search_multi_with_http_info(search_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GeneralSearchApi.search_search_multi ...'
+      end
+      # verify the required parameter 'search_request' is set
+      if @api_client.config.client_side_validation && search_request.nil?
+        fail ArgumentError, "Missing the required parameter 'search_request' when calling GeneralSearchApi.search_search_multi"
+      end
+      # resource path
+      local_var_path = '/search/multi'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json+action', 'application/json+correspondence', 'application/json+document', 'application/json+event', 'application/json+organisation', 'application/json+project', 'application/json+property', 'application/json+stakeholder', 'application/json+team', 'application/json+user'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] || @api_client.object_to_http_body(search_request)
+
+      # return_type
+      return_type = opts[:return_type] || 'Action'
+
+      # auth_names
+      auth_names = opts[:auth_names] || []
+
+      new_options = opts.merge(
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: GeneralSearchApi#search_search_multi\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end