cmv4-openapi-client 1.0.3

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

@@ -0,0 +1,312 @@
+=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 GeneralDefinitionApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get Enterprise Definition
+    # Gets the Enterprise Definition object
+    # @param [Hash] opts the optional parameters
+    # @return [ConcreteEnterpriseDefinition]
+    def definition_get(opts = {})
+      data, _status_code, _headers = definition_get_with_http_info(opts)
+      data
+    end
+
+    # Get Enterprise Definition
+    # Gets the Enterprise Definition object
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ConcreteEnterpriseDefinition, Integer, Hash)>] ConcreteEnterpriseDefinition data, response status code and response headers
+    def definition_get_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GeneralDefinitionApi.definition_get ...'
+      end
+      # resource path
+      local_var_path = '/definition/enterprisedefinition'
+
+      # 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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body]
+
+      # return_type
+      return_type = opts[:return_type] || 'ConcreteEnterpriseDefinition'
+
+      # 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(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: GeneralDefinitionApi#definition_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get Enterprise Configuration
+    # Gets the Enterprise Configuration object
+    # @param [Hash] opts the optional parameters
+    # @return [EnterpriseConfigurationModified]
+    def definition_get_enterprise_configuration(opts = {})
+      data, _status_code, _headers = definition_get_enterprise_configuration_with_http_info(opts)
+      data
+    end
+
+    # Get Enterprise Configuration
+    # Gets the Enterprise Configuration object
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EnterpriseConfigurationModified, Integer, Hash)>] EnterpriseConfigurationModified data, response status code and response headers
+    def definition_get_enterprise_configuration_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GeneralDefinitionApi.definition_get_enterprise_configuration ...'
+      end
+      # resource path
+      local_var_path = '/definition/enterpriseconfiguration'
+
+      # 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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body]
+
+      # return_type
+      return_type = opts[:return_type] || 'EnterpriseConfigurationModified'
+
+      # 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(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: GeneralDefinitionApi#definition_get_enterprise_configuration\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get Entity Definition
+    # Gets an entities definition
+    # @param entity_alias [String]
+    # @param [Hash] opts the optional parameters
+    # @return [EntityDefinition]
+    def definition_get_entity(entity_alias, opts = {})
+      data, _status_code, _headers = definition_get_entity_with_http_info(entity_alias, opts)
+      data
+    end
+
+    # Get Entity Definition
+    # Gets an entities definition
+    # @param entity_alias [String]
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(EntityDefinition, Integer, Hash)>] EntityDefinition data, response status code and response headers
+    def definition_get_entity_with_http_info(entity_alias, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GeneralDefinitionApi.definition_get_entity ...'
+      end
+      # resource path
+      local_var_path = '/definition/entity/{entityAlias}'.sub('{' + 'entityAlias' + '}', CGI.escape(entity_alias.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/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body]
+
+      # return_type
+      return_type = opts[:return_type] || 'EntityDefinition'
+
+      # 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(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: GeneralDefinitionApi#definition_get_entity\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get Relationship Definition
+    # Gets a relationships definition
+    # @param relationship_alias [String]
+    # @param [Hash] opts the optional parameters
+    # @return [RelationshipDefinition]
+    def definition_get_relationship(relationship_alias, opts = {})
+      data, _status_code, _headers = definition_get_relationship_with_http_info(relationship_alias, opts)
+      data
+    end
+
+    # Get Relationship Definition
+    # Gets a relationships definition
+    # @param relationship_alias [String]
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(RelationshipDefinition, Integer, Hash)>] RelationshipDefinition data, response status code and response headers
+    def definition_get_relationship_with_http_info(relationship_alias, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GeneralDefinitionApi.definition_get_relationship ...'
+      end
+      # resource path
+      local_var_path = '/definition/relationship/{relationshipAlias}'.sub('{' + 'relationshipAlias' + '}', CGI.escape(relationship_alias.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/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body]
+
+      # return_type
+      return_type = opts[:return_type] || 'RelationshipDefinition'
+
+      # 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(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: GeneralDefinitionApi#definition_get_relationship\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get Stereotypes By Scope
+    # Gets a list of Stereotypes by a particular scope
+    # @param scope [StereotypeScope]
+    # @param [Hash] opts the optional parameters
+    # @return [Array<Stereotype>]
+    def definition_get_stereotypes(scope, opts = {})
+      data, _status_code, _headers = definition_get_stereotypes_with_http_info(scope, opts)
+      data
+    end
+
+    # Get Stereotypes By Scope
+    # Gets a list of Stereotypes by a particular scope
+    # @param scope [StereotypeScope]
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<Stereotype>, Integer, Hash)>] Array<Stereotype> data, response status code and response headers
+    def definition_get_stereotypes_with_http_info(scope, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GeneralDefinitionApi.definition_get_stereotypes ...'
+      end
+      # verify the required parameter 'scope' is set
+      if @api_client.config.client_side_validation && scope.nil?
+        fail ArgumentError, "Missing the required parameter 'scope' when calling GeneralDefinitionApi.definition_get_stereotypes"
+      end
+      # resource path
+      local_var_path = '/definition/stereotypes/{scope}'.sub('{' + 'scope' + '}', CGI.escape(scope.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/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body]
+
+      # return_type
+      return_type = opts[:return_type] || 'Array<Stereotype>'
+
+      # 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(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: GeneralDefinitionApi#definition_get_stereotypes\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_diff_api.rb

@@ -0,0 +1,92 @@
+=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 GeneralDiffApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get Entity Changes
+    # Gets the changes performed on a particular entity<br/><span style=\"font-weight: bold;color: red\">The HistorySearch feature toggle is required to use this route</span>
+    # @param entity_alias [String] 
+    # @param id [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page  (default to 1)
+    # @option opts [Integer] :page_size  (default to 50)
+    # @return [Array<ChangeLog>]
+    def diff_get(entity_alias, id, opts = {})
+      data, _status_code, _headers = diff_get_with_http_info(entity_alias, id, opts)
+      data
+    end
+
+    # Get Entity Changes
+    # Gets the changes performed on a particular entity&lt;br/&gt;&lt;span style&#x3D;\&quot;font-weight: bold;color: red\&quot;&gt;The HistorySearch feature toggle is required to use this route&lt;/span&gt;
+    # @param entity_alias [String] 
+    # @param id [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page 
+    # @option opts [Integer] :page_size 
+    # @return [Array<(Array<ChangeLog>, Integer, Hash)>] Array<ChangeLog> data, response status code and response headers
+    def diff_get_with_http_info(entity_alias, id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GeneralDiffApi.diff_get ...'
+      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 GeneralDiffApi.diff_get"
+      end
+      # resource path
+      local_var_path = '/diff/{entityAlias}/{id}'.sub('{' + 'entityAlias' + '}', CGI.escape(entity_alias.to_s)).sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
+      query_params[:'pageSize'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'Array<ChangeLog>' 
+
+      # 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: GeneralDiffApi#diff_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_features_api.rb

@@ -0,0 +1,134 @@
+=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 GeneralFeaturesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get Active Features
+    # Gets the features that are active within the system
+    # @param [Hash] opts the optional parameters
+    # @return [Array<String>]
+    def features_get_active_features(opts = {})
+      data, _status_code, _headers = features_get_active_features_with_http_info(opts)
+      data
+    end
+
+    # Get Active Features
+    # Gets the features that are active within the system
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<String>, Integer, Hash)>] Array<String> data, response status code and response headers
+    def features_get_active_features_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GeneralFeaturesApi.features_get_active_features ...'
+      end
+      # resource path
+      local_var_path = '/features/active'
+
+      # 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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'Array<String>' 
+
+      # 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: GeneralFeaturesApi#features_get_active_features\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get All Features
+    # Gets all available features within the system
+    # @param [Hash] opts the optional parameters
+    # @return [Array<String>]
+    def features_get_all_features(opts = {})
+      data, _status_code, _headers = features_get_all_features_with_http_info(opts)
+      data
+    end
+
+    # Get All Features
+    # Gets all available features within the system
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Array<String>, Integer, Hash)>] Array<String> data, response status code and response headers
+    def features_get_all_features_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GeneralFeaturesApi.features_get_all_features ...'
+      end
+      # resource path
+      local_var_path = '/features'
+
+      # 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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:body] 
+
+      # return_type
+      return_type = opts[:return_type] || 'Array<String>' 
+
+      # 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: GeneralFeaturesApi#features_get_all_features\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_history_search_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 GeneralHistorySearchApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Get History Search Data
+    # Gets the history search data based on the passed request<br/><span style=\"font-weight: bold;color: red\">The HistorySearch feature toggle is required to use this route</span>
+    # @param search_request [SearchRequest]
+    # @param [Hash] opts the optional parameters
+    # @return [Action]
+    def history_search_get(search_request, opts = {})
+      data, _status_code, _headers = history_search_get_with_http_info(search_request, opts)
+      data
+    end
+
+    # Get History Search Data
+    # Gets the history search data based on the passed request&lt;br/&gt;&lt;span style&#x3D;\&quot;font-weight: bold;color: red\&quot;&gt;The HistorySearch feature toggle is required to use this route&lt;/span&gt;
+    # @param search_request [SearchRequest]
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Action, Integer, Hash)>] Action data, response status code and response headers
+    def history_search_get_with_http_info(search_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: GeneralHistorySearchApi.history_search_get ...'
+      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 GeneralHistorySearchApi.history_search_get"
+      end
+      # resource path
+      local_var_path = '/historysearch'
+
+      # 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: GeneralHistorySearchApi#history_search_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end