cmv4-openapi-client 1.0.3

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

@@ -0,0 +1,654 @@
+=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 EntityPropertiesApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Clone an existing property
+    # Clones an existing property.
+    # @param id [Integer]
+    # @param [Hash] opts the optional parameters
+    # @return [Property]
+    def properties_clone(id, opts = {})
+      data, _status_code, _headers = properties_clone_with_http_info(id, opts)
+      data
+    end
+
+    # Clone an existing property
+    # Clones an existing property.
+    # @param id [Integer]
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Property, Integer, Hash)>] Property data, response status code and response headers
+    def properties_clone_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EntityPropertiesApi.properties_clone ...'
+      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 EntityPropertiesApi.properties_clone"
+      end
+      # resource path
+      local_var_path = '/entities/property/{id}/clone'.sub('{' + 'id' + '}', CGI.escape(id.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] || 'Property'
+
+      # 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: EntityPropertiesApi#properties_clone\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Create a new property
+    # Creates a new property.
+    # @param ensure_entity_instance_command_data [EnsureEntityInstanceCommandData]
+    # @param [Hash] opts the optional parameters
+    # @return [Property]
+    def properties_create(ensure_entity_instance_command_data, opts = {})
+      data, _status_code, _headers = properties_create_with_http_info(ensure_entity_instance_command_data, opts)
+      data
+    end
+
+    # Create a new property
+    # Creates a new property.
+    # @param ensure_entity_instance_command_data [EnsureEntityInstanceCommandData]
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Property, Integer, Hash)>] Property data, response status code and response headers
+    def properties_create_with_http_info(ensure_entity_instance_command_data, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EntityPropertiesApi.properties_create ...'
+      end
+      # verify the required parameter 'ensure_entity_instance_command_data' is set
+      if @api_client.config.client_side_validation && ensure_entity_instance_command_data.nil?
+        fail ArgumentError, "Missing the required parameter 'ensure_entity_instance_command_data' when calling EntityPropertiesApi.properties_create"
+      end
+      # resource path
+      local_var_path = '/entities/property'
+
+      # 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'])
+      # 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(ensure_entity_instance_command_data)
+
+      # return_type
+      return_type = opts[:return_type] || 'Property'
+
+      # 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: EntityPropertiesApi#properties_create\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete a property
+    # Deletes an existing property.
+    # @param id [Integer]
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def properties_delete(id, opts = {})
+      data, _status_code, _headers = properties_delete_with_http_info(id, opts)
+      data
+    end
+
+    # Delete a property
+    # Deletes an existing property.
+    # @param id [Integer]
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def properties_delete_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EntityPropertiesApi.properties_delete ...'
+      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 EntityPropertiesApi.properties_delete"
+      end
+      # resource path
+      local_var_path = '/entities/property/{id}'.sub('{' + 'id' + '}', CGI.escape(id.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] || 'Object'
+
+      # 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(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EntityPropertiesApi#properties_delete\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Delete a property
+    # Deletes an existing property.
+    # @param id [Integer]
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def properties_delete_using_post(id, opts = {})
+      data, _status_code, _headers = properties_delete_using_post_with_http_info(id, opts)
+      data
+    end
+
+    # Delete a property
+    # Deletes an existing property.
+    # @param id [Integer]
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def properties_delete_using_post_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EntityPropertiesApi.properties_delete_using_post ...'
+      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 EntityPropertiesApi.properties_delete_using_post"
+      end
+      # resource path
+      local_var_path = '/entities/property/{id}/delete'.sub('{' + 'id' + '}', CGI.escape(id.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] || 'Object'
+
+      # 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: EntityPropertiesApi#properties_delete_using_post\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get All Properties
+    # Gets all properties and allows for the results to be paged.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page
+    # @option opts [Integer] :page_size
+    # @return [Property]
+    def properties_get_all(opts = {})
+      data, _status_code, _headers = properties_get_all_with_http_info(opts)
+      data
+    end
+
+    # Get All Properties
+    # Gets all properties and allows for the results to be paged.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :page
+    # @option opts [Integer] :page_size
+    # @return [Array<(Property, Integer, Hash)>] Property data, response status code and response headers
+    def properties_get_all_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EntityPropertiesApi.properties_get_all ...'
+      end
+      # resource path
+      local_var_path = '/entities/property?{page}&{pageSize}'
+
+      # 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] || 'Property'
+
+      # 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: EntityPropertiesApi#properties_get_all\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get Property By Id
+    # Gets a single property by its Id
+    # @param id [Integer]
+    # @param [Hash] opts the optional parameters
+    # @return [Property]
+    def properties_get_by_id(id, opts = {})
+      data, _status_code, _headers = properties_get_by_id_with_http_info(id, opts)
+      data
+    end
+
+    # Get Property By Id
+    # Gets a single property by its Id
+    # @param id [Integer]
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Property, Integer, Hash)>] Property data, response status code and response headers
+    def properties_get_by_id_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EntityPropertiesApi.properties_get_by_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 EntityPropertiesApi.properties_get_by_id"
+      end
+      # resource path
+      local_var_path = '/entities/property/{id}'.sub('{' + 'id' + '}', CGI.escape(id.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] || 'Property'
+
+      # 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: EntityPropertiesApi#properties_get_by_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get Properties Count
+    # Gets the count of all properties
+    # @param [Hash] opts the optional parameters
+    # @return [Integer]
+    def properties_get_count(opts = {})
+      data, _status_code, _headers = properties_get_count_with_http_info(opts)
+      data
+    end
+
+    # Get Properties Count
+    # Gets the count of all properties
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Integer, Integer, Hash)>] Integer data, response status code and response headers
+    def properties_get_count_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EntityPropertiesApi.properties_get_count ...'
+      end
+      # resource path
+      local_var_path = '/entities/property/count'
+
+      # 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] || 'Integer'
+
+      # 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: EntityPropertiesApi#properties_get_count\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Merge Properties
+    # Merge existing properties.
+    # @param id [Integer]
+    # @param merge_entity_instances_command_data [MergeEntityInstancesCommandData]
+    # @param [Hash] opts the optional parameters
+    # @return [Property]
+    def properties_merge(id, merge_entity_instances_command_data, opts = {})
+      data, _status_code, _headers = properties_merge_with_http_info(id, merge_entity_instances_command_data, opts)
+      data
+    end
+
+    # Merge Properties
+    # Merge existing properties.
+    # @param id [Integer]
+    # @param merge_entity_instances_command_data [MergeEntityInstancesCommandData]
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Property, Integer, Hash)>] Property data, response status code and response headers
+    def properties_merge_with_http_info(id, merge_entity_instances_command_data, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EntityPropertiesApi.properties_merge ...'
+      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 EntityPropertiesApi.properties_merge"
+      end
+      # verify the required parameter 'merge_entity_instances_command_data' is set
+      if @api_client.config.client_side_validation && merge_entity_instances_command_data.nil?
+        fail ArgumentError, "Missing the required parameter 'merge_entity_instances_command_data' when calling EntityPropertiesApi.properties_merge"
+      end
+      # resource path
+      local_var_path = '/entities/property/{id}/merge'.sub('{' + 'id' + '}', CGI.escape(id.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'])
+      # 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(merge_entity_instances_command_data)
+
+      # return_type
+      return_type = opts[:return_type] || 'Property'
+
+      # 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: EntityPropertiesApi#properties_merge\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Modify a property
+    # Modify an existing property.
+    # @param id [Integer]
+    # @param ensure_entity_instance_command_data [EnsureEntityInstanceCommandData]
+    # @param [Hash] opts the optional parameters
+    # @return [Property]
+    def properties_modify(id, ensure_entity_instance_command_data, opts = {})
+      data, _status_code, _headers = properties_modify_with_http_info(id, ensure_entity_instance_command_data, opts)
+      data
+    end
+
+    # Modify a property
+    # Modify an existing property.
+    # @param id [Integer]
+    # @param ensure_entity_instance_command_data [EnsureEntityInstanceCommandData]
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Property, Integer, Hash)>] Property data, response status code and response headers
+    def properties_modify_with_http_info(id, ensure_entity_instance_command_data, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EntityPropertiesApi.properties_modify ...'
+      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 EntityPropertiesApi.properties_modify"
+      end
+      # verify the required parameter 'ensure_entity_instance_command_data' is set
+      if @api_client.config.client_side_validation && ensure_entity_instance_command_data.nil?
+        fail ArgumentError, "Missing the required parameter 'ensure_entity_instance_command_data' when calling EntityPropertiesApi.properties_modify"
+      end
+      # resource path
+      local_var_path = '/entities/property/{id}'.sub('{' + 'id' + '}', CGI.escape(id.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'])
+      # 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(ensure_entity_instance_command_data)
+
+      # return_type
+      return_type = opts[:return_type] || 'Property'
+
+      # 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(:PATCH, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: EntityPropertiesApi#properties_modify\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Restore a property
+    # Restores a property.
+    # @param id [Integer]
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def properties_restore(id, opts = {})
+      data, _status_code, _headers = properties_restore_with_http_info(id, opts)
+      data
+    end
+
+    # Restore a property
+    # Restores a property.
+    # @param id [Integer]
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def properties_restore_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: EntityPropertiesApi.properties_restore ...'
+      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 EntityPropertiesApi.properties_restore"
+      end
+      # resource path
+      local_var_path = '/entities/property/{id}/restore'.sub('{' + 'id' + '}', CGI.escape(id.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] || 'Object'
+
+      # 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: EntityPropertiesApi#properties_restore\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end