blueprint_ruby_client 0.1.0

data/lib/blueprint_ruby_client/api/hierarchy_api.rb

@@ -0,0 +1,1174 @@
+=begin
+Talis Blueprint API
+
+This is the API documentation for [Blueprint](https://github.com/talis/blueprint-server), a primitive for institutional structure and time periods
+
+OpenAPI spec version: 1.0.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+
+=end
+
+require "uri"
+
+module BlueprintClient
+  class HierarchyApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # 
+    # Add a node
+    # @param namespace_inc_global identifier namespacing the blueprint. `global` is a special namespace which references data from all blueprints in the call.
+    # @param body node
+    # @param [Hash] opts the optional parameters
+    # @return [NodeBody]
+    def add_node(namespace_inc_global, body, opts = {})
+      data, _status_code, _headers = add_node_with_http_info(namespace_inc_global, body, opts)
+      return data
+    end
+
+    # 
+    # Add a node
+    # @param namespace_inc_global identifier namespacing the blueprint. `global` is a special namespace which references data from all blueprints in the call.
+    # @param body node
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(NodeBody, Fixnum, Hash)>] NodeBody data, response status code and response headers
+    def add_node_with_http_info(namespace_inc_global, body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: HierarchyApi.add_node ..."
+      end
+      
+      
+      # verify the required parameter 'namespace_inc_global' is set
+      fail ArgumentError, "Missing the required parameter 'namespace_inc_global' when calling HierarchyApi.add_node" if namespace_inc_global.nil?
+      
+      
+      
+      
+      
+      
+      # verify the required parameter 'body' is set
+      fail ArgumentError, "Missing the required parameter 'body' when calling HierarchyApi.add_node" if body.nil?
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/{namespaceIncGlobal}/nodes".sub('{format}','json').sub('{' + 'namespaceIncGlobal' + '}', namespace_inc_global.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/vnd.api+json']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(body)
+      
+      auth_names = ['oauth2']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'NodeBody')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: HierarchyApi#add_node\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 
+    # Send operations to modify nodes in bulk, to be applied/rejected as a single transaction.\nFormat will be:\n\n  OLD NODE TYPE, OLD NODE ID, NEW NODE TYPE, NEW NODE ID, PARENTS, TITLE, DESCRIPTION, DOMAIN IDS, STUDENT NUMBERS\n
+    # @param namespace identifier namespacing the blueprint.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def bulk_upload(namespace, opts = {})
+      bulk_upload_with_http_info(namespace, opts)
+      return nil
+    end
+
+    # 
+    # Send operations to modify nodes in bulk, to be applied/rejected as a single transaction.\nFormat will be:\n\n  OLD NODE TYPE, OLD NODE ID, NEW NODE TYPE, NEW NODE ID, PARENTS, TITLE, DESCRIPTION, DOMAIN IDS, STUDENT NUMBERS\n
+    # @param namespace identifier namespacing the blueprint.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def bulk_upload_with_http_info(namespace, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: HierarchyApi.bulk_upload ..."
+      end
+      
+      
+      # verify the required parameter 'namespace' is set
+      fail ArgumentError, "Missing the required parameter 'namespace' when calling HierarchyApi.bulk_upload" if namespace.nil?
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/{namespace}/nodes.csv".sub('{format}','json').sub('{' + 'namespace' + '}', namespace.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/vnd.api+json']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = ['text/plain', 'application/octet-stream']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+      auth_names = ['oauth2']
+      data, status_code, headers = @api_client.call_api(:POST, 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: HierarchyApi#bulk_upload\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 
+    # Delete a node
+    # @param namespace identifier namespacing the blueprint.
+    # @param id id identifying a domain model
+    # @param type Plural form of node type (adds an &#39;s&#39; to the end of the type) todo - allow configuration of plurals
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def delete_node(namespace, id, type, opts = {})
+      delete_node_with_http_info(namespace, id, type, opts)
+      return nil
+    end
+
+    # 
+    # Delete a node
+    # @param namespace identifier namespacing the blueprint.
+    # @param id id identifying a domain model
+    # @param type Plural form of node type (adds an &#39;s&#39; to the end of the type) todo - allow configuration of plurals
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def delete_node_with_http_info(namespace, id, type, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: HierarchyApi.delete_node ..."
+      end
+      
+      
+      # verify the required parameter 'namespace' is set
+      fail ArgumentError, "Missing the required parameter 'namespace' when calling HierarchyApi.delete_node" if namespace.nil?
+      
+      
+      
+      
+      
+      
+      # verify the required parameter 'id' is set
+      fail ArgumentError, "Missing the required parameter 'id' when calling HierarchyApi.delete_node" if id.nil?
+      
+      
+      
+      
+      
+      
+      # verify the required parameter 'type' is set
+      fail ArgumentError, "Missing the required parameter 'type' when calling HierarchyApi.delete_node" if type.nil?
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/{namespace}/nodes/{type}/{id}".sub('{format}','json').sub('{' + 'namespace' + '}', namespace.to_s).sub('{' + 'id' + '}', id.to_s).sub('{' + 'type' + '}', type.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/vnd.api+json']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+      auth_names = ['oauth2']
+      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: HierarchyApi#delete_node\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 
+    # Download the blueprint's nodes in CSV format\nFormat will be:\n\n  OLD NODE TYPE, OLD NODE ID, NEW NODE TYPE, NEW NODE ID, PARENTS, TITLE, DESCRIPTION, DOMAIN IDS, STUDENT NUMBERS\n\nOLD NODE TYPE and OLD NODE ID are left intentionally blank to allow direct upload of the output back into the bulk importer\n
+    # @param namespace identifier namespacing the blueprint.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def export_hierarchy(namespace, opts = {})
+      export_hierarchy_with_http_info(namespace, opts)
+      return nil
+    end
+
+    # 
+    # Download the blueprint&#39;s nodes in CSV format\nFormat will be:\n\n  OLD NODE TYPE, OLD NODE ID, NEW NODE TYPE, NEW NODE ID, PARENTS, TITLE, DESCRIPTION, DOMAIN IDS, STUDENT NUMBERS\n\nOLD NODE TYPE and OLD NODE ID are left intentionally blank to allow direct upload of the output back into the bulk importer\n
+    # @param namespace identifier namespacing the blueprint.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
+    def export_hierarchy_with_http_info(namespace, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: HierarchyApi.export_hierarchy ..."
+      end
+      
+      
+      # verify the required parameter 'namespace' is set
+      fail ArgumentError, "Missing the required parameter 'namespace' when calling HierarchyApi.export_hierarchy" if namespace.nil?
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/{namespace}/nodes.csv".sub('{format}','json').sub('{' + 'namespace' + '}', namespace.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/vnd.api+json']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+      auth_names = ['oauth2']
+      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: HierarchyApi#export_hierarchy\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get ancestor nodes
+    # A proxy for finding ancestors of a given node, equivalent to\n`/1/abc/nodes?filter[descendant]=department%2Fdep101`\n
+    # @param id id identifying a domain model
+    # @param namespace identifier namespacing the blueprint.
+    # @param type Plural form of node type (adds an &#39;s&#39; to the end of the type) todo - allow configuration of plurals
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :offset index to start result set from
+    # @option opts [Float] :limit number of records to return
+    # @return [NodeResultSet]
+    def get_ancestors(id, namespace, type, opts = {})
+      data, _status_code, _headers = get_ancestors_with_http_info(id, namespace, type, opts)
+      return data
+    end
+
+    # Get ancestor nodes
+    # A proxy for finding ancestors of a given node, equivalent to\n`/1/abc/nodes?filter[descendant]=department%2Fdep101`\n
+    # @param id id identifying a domain model
+    # @param namespace identifier namespacing the blueprint.
+    # @param type Plural form of node type (adds an &#39;s&#39; to the end of the type) todo - allow configuration of plurals
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :offset index to start result set from
+    # @option opts [Float] :limit number of records to return
+    # @return [Array<(NodeResultSet, Fixnum, Hash)>] NodeResultSet data, response status code and response headers
+    def get_ancestors_with_http_info(id, namespace, type, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: HierarchyApi.get_ancestors ..."
+      end
+      
+      
+      # verify the required parameter 'id' is set
+      fail ArgumentError, "Missing the required parameter 'id' when calling HierarchyApi.get_ancestors" if id.nil?
+      
+      
+      
+      
+      
+      
+      # verify the required parameter 'namespace' is set
+      fail ArgumentError, "Missing the required parameter 'namespace' when calling HierarchyApi.get_ancestors" if namespace.nil?
+      
+      
+      
+      
+      
+      
+      # verify the required parameter 'type' is set
+      fail ArgumentError, "Missing the required parameter 'type' when calling HierarchyApi.get_ancestors" if type.nil?
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/{namespace}/nodes/{type}/{id}/ancestors".sub('{format}','json').sub('{' + 'id' + '}', id.to_s).sub('{' + 'namespace' + '}', namespace.to_s).sub('{' + 'type' + '}', type.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'offset'] = opts[:'offset'] if opts[:'offset']
+      query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/vnd.api+json']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+      auth_names = ['oauth2']
+      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 => 'NodeResultSet')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: HierarchyApi#get_ancestors\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get child nodes
+    # A proxy for finding children of a given node, equivalent to\n`/1/abc/nodes?filter[parent]=department%2Fdep101`\n
+    # @param id id identifying a domain model
+    # @param namespace identifier namespacing the blueprint.
+    # @param type Plural form of node type (adds an &#39;s&#39; to the end of the type) todo - allow configuration of plurals
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :offset index to start result set from
+    # @option opts [Float] :limit number of records to return
+    # @return [NodeResultSet]
+    def get_children(id, namespace, type, opts = {})
+      data, _status_code, _headers = get_children_with_http_info(id, namespace, type, opts)
+      return data
+    end
+
+    # Get child nodes
+    # A proxy for finding children of a given node, equivalent to\n`/1/abc/nodes?filter[parent]=department%2Fdep101`\n
+    # @param id id identifying a domain model
+    # @param namespace identifier namespacing the blueprint.
+    # @param type Plural form of node type (adds an &#39;s&#39; to the end of the type) todo - allow configuration of plurals
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :offset index to start result set from
+    # @option opts [Float] :limit number of records to return
+    # @return [Array<(NodeResultSet, Fixnum, Hash)>] NodeResultSet data, response status code and response headers
+    def get_children_with_http_info(id, namespace, type, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: HierarchyApi.get_children ..."
+      end
+      
+      
+      # verify the required parameter 'id' is set
+      fail ArgumentError, "Missing the required parameter 'id' when calling HierarchyApi.get_children" if id.nil?
+      
+      
+      
+      
+      
+      
+      # verify the required parameter 'namespace' is set
+      fail ArgumentError, "Missing the required parameter 'namespace' when calling HierarchyApi.get_children" if namespace.nil?
+      
+      
+      
+      
+      
+      
+      # verify the required parameter 'type' is set
+      fail ArgumentError, "Missing the required parameter 'type' when calling HierarchyApi.get_children" if type.nil?
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/{namespace}/nodes/{type}/{id}/children".sub('{format}','json').sub('{' + 'id' + '}', id.to_s).sub('{' + 'namespace' + '}', namespace.to_s).sub('{' + 'type' + '}', type.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'offset'] = opts[:'offset'] if opts[:'offset']
+      query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/vnd.api+json']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+      auth_names = ['oauth2']
+      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 => 'NodeResultSet')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: HierarchyApi#get_children\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get descendant nodes
+    # A proxy for finding descendants of a given node, equivalent to\n`/1/abc/nodes?filter[ancestor]=department%2Fdep101`\n
+    # @param id id identifying a domain model
+    # @param namespace identifier namespacing the blueprint.
+    # @param type Plural form of node type (adds an &#39;s&#39; to the end of the type) todo - allow configuration of plurals
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :offset index to start result set from
+    # @option opts [Float] :limit number of records to return
+    # @return [NodeResultSet]
+    def get_descendants(id, namespace, type, opts = {})
+      data, _status_code, _headers = get_descendants_with_http_info(id, namespace, type, opts)
+      return data
+    end
+
+    # Get descendant nodes
+    # A proxy for finding descendants of a given node, equivalent to\n`/1/abc/nodes?filter[ancestor]=department%2Fdep101`\n
+    # @param id id identifying a domain model
+    # @param namespace identifier namespacing the blueprint.
+    # @param type Plural form of node type (adds an &#39;s&#39; to the end of the type) todo - allow configuration of plurals
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :offset index to start result set from
+    # @option opts [Float] :limit number of records to return
+    # @return [Array<(NodeResultSet, Fixnum, Hash)>] NodeResultSet data, response status code and response headers
+    def get_descendants_with_http_info(id, namespace, type, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: HierarchyApi.get_descendants ..."
+      end
+      
+      
+      # verify the required parameter 'id' is set
+      fail ArgumentError, "Missing the required parameter 'id' when calling HierarchyApi.get_descendants" if id.nil?
+      
+      
+      
+      
+      
+      
+      # verify the required parameter 'namespace' is set
+      fail ArgumentError, "Missing the required parameter 'namespace' when calling HierarchyApi.get_descendants" if namespace.nil?
+      
+      
+      
+      
+      
+      
+      # verify the required parameter 'type' is set
+      fail ArgumentError, "Missing the required parameter 'type' when calling HierarchyApi.get_descendants" if type.nil?
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/{namespace}/nodes/{type}/{id}/descendants".sub('{format}','json').sub('{' + 'id' + '}', id.to_s).sub('{' + 'namespace' + '}', namespace.to_s).sub('{' + 'type' + '}', type.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'offset'] = opts[:'offset'] if opts[:'offset']
+      query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/vnd.api+json']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+      auth_names = ['oauth2']
+      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 => 'NodeResultSet')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: HierarchyApi#get_descendants\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 
+    # Get details of a given node
+    # @param namespace identifier namespacing the blueprint.
+    # @param id id identifying a domain model
+    # @param type Plural form of node type (adds an &#39;s&#39; to the end of the type) todo - allow configuration of plurals
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :includes comma separated list of elements to hydrate. Can include children, ancestors or both
+    # @return [NodeBody]
+    def get_node(namespace, id, type, opts = {})
+      data, _status_code, _headers = get_node_with_http_info(namespace, id, type, opts)
+      return data
+    end
+
+    # 
+    # Get details of a given node
+    # @param namespace identifier namespacing the blueprint.
+    # @param id id identifying a domain model
+    # @param type Plural form of node type (adds an &#39;s&#39; to the end of the type) todo - allow configuration of plurals
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :includes comma separated list of elements to hydrate. Can include children, ancestors or both
+    # @return [Array<(NodeBody, Fixnum, Hash)>] NodeBody data, response status code and response headers
+    def get_node_with_http_info(namespace, id, type, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: HierarchyApi.get_node ..."
+      end
+      
+      
+      # verify the required parameter 'namespace' is set
+      fail ArgumentError, "Missing the required parameter 'namespace' when calling HierarchyApi.get_node" if namespace.nil?
+      
+      
+      
+      
+      
+      
+      # verify the required parameter 'id' is set
+      fail ArgumentError, "Missing the required parameter 'id' when calling HierarchyApi.get_node" if id.nil?
+      
+      
+      
+      
+      
+      
+      # verify the required parameter 'type' is set
+      fail ArgumentError, "Missing the required parameter 'type' when calling HierarchyApi.get_node" if type.nil?
+      
+      
+      
+      
+      
+      
+      
+      
+      if opts[:'includes'] && !['children', 'ancestors', 'children,ancestors', 'ancestors,children'].include?(opts[:'includes'])
+        fail ArgumentError, 'invalid value for "includes", must be one of children, ancestors, children,ancestors, ancestors,children'
+      end
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/{namespace}/nodes/{type}/{id}".sub('{format}','json').sub('{' + 'namespace' + '}', namespace.to_s).sub('{' + 'id' + '}', id.to_s).sub('{' + 'type' + '}', type.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'includes'] = opts[:'includes'] if opts[:'includes']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/vnd.api+json']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+      auth_names = ['oauth2']
+      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 => 'NodeBody')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: HierarchyApi#get_node\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Get parent nodes
+    # A proxy for finding parents of a given node, equivalent to\n`/1/abc/nodes?filter[child]=department%2Fdep101`\n
+    # @param id id identifying a domain model
+    # @param namespace identifier namespacing the blueprint.
+    # @param type Plural form of node type (adds an &#39;s&#39; to the end of the type) todo - allow configuration of plurals
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :offset index to start result set from
+    # @option opts [Float] :limit number of records to return
+    # @return [NodeResultSet]
+    def get_parents(id, namespace, type, opts = {})
+      data, _status_code, _headers = get_parents_with_http_info(id, namespace, type, opts)
+      return data
+    end
+
+    # Get parent nodes
+    # A proxy for finding parents of a given node, equivalent to\n`/1/abc/nodes?filter[child]=department%2Fdep101`\n
+    # @param id id identifying a domain model
+    # @param namespace identifier namespacing the blueprint.
+    # @param type Plural form of node type (adds an &#39;s&#39; to the end of the type) todo - allow configuration of plurals
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :offset index to start result set from
+    # @option opts [Float] :limit number of records to return
+    # @return [Array<(NodeResultSet, Fixnum, Hash)>] NodeResultSet data, response status code and response headers
+    def get_parents_with_http_info(id, namespace, type, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: HierarchyApi.get_parents ..."
+      end
+      
+      
+      # verify the required parameter 'id' is set
+      fail ArgumentError, "Missing the required parameter 'id' when calling HierarchyApi.get_parents" if id.nil?
+      
+      
+      
+      
+      
+      
+      # verify the required parameter 'namespace' is set
+      fail ArgumentError, "Missing the required parameter 'namespace' when calling HierarchyApi.get_parents" if namespace.nil?
+      
+      
+      
+      
+      
+      
+      # verify the required parameter 'type' is set
+      fail ArgumentError, "Missing the required parameter 'type' when calling HierarchyApi.get_parents" if type.nil?
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/{namespace}/nodes/{type}/{id}/parents".sub('{format}','json').sub('{' + 'id' + '}', id.to_s).sub('{' + 'namespace' + '}', namespace.to_s).sub('{' + 'type' + '}', type.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'offset'] = opts[:'offset'] if opts[:'offset']
+      query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/vnd.api+json']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+      auth_names = ['oauth2']
+      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 => 'NodeResultSet')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: HierarchyApi#get_parents\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 
+    # Replaces the node with the data sent in the body
+    # @param namespace identifier namespacing the blueprint.
+    # @param id id identifying a domain model
+    # @param body node
+    # @param type Plural form of node type (adds an &#39;s&#39; to the end of the type) todo - allow configuration of plurals
+    # @param [Hash] opts the optional parameters
+    # @return [NodeBody]
+    def replace_node(namespace, id, body, type, opts = {})
+      data, _status_code, _headers = replace_node_with_http_info(namespace, id, body, type, opts)
+      return data
+    end
+
+    # 
+    # Replaces the node with the data sent in the body
+    # @param namespace identifier namespacing the blueprint.
+    # @param id id identifying a domain model
+    # @param body node
+    # @param type Plural form of node type (adds an &#39;s&#39; to the end of the type) todo - allow configuration of plurals
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(NodeBody, Fixnum, Hash)>] NodeBody data, response status code and response headers
+    def replace_node_with_http_info(namespace, id, body, type, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: HierarchyApi.replace_node ..."
+      end
+      
+      
+      # verify the required parameter 'namespace' is set
+      fail ArgumentError, "Missing the required parameter 'namespace' when calling HierarchyApi.replace_node" if namespace.nil?
+      
+      
+      
+      
+      
+      
+      # verify the required parameter 'id' is set
+      fail ArgumentError, "Missing the required parameter 'id' when calling HierarchyApi.replace_node" if id.nil?
+      
+      
+      
+      
+      
+      
+      # verify the required parameter 'body' is set
+      fail ArgumentError, "Missing the required parameter 'body' when calling HierarchyApi.replace_node" if body.nil?
+      
+      
+      
+      
+      
+      
+      # verify the required parameter 'type' is set
+      fail ArgumentError, "Missing the required parameter 'type' when calling HierarchyApi.replace_node" if type.nil?
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/{namespace}/nodes/{type}/{id}".sub('{format}','json').sub('{' + 'namespace' + '}', namespace.to_s).sub('{' + 'id' + '}', id.to_s).sub('{' + 'type' + '}', type.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/vnd.api+json']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(body)
+      
+      auth_names = ['oauth2']
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'NodeBody')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: HierarchyApi#replace_node\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Search nodes
+    # This endpoint is a really flexible way to ask questions about the hierarchy. for example:\n\n###### Find all nodes for abc:\n`/1/abc/nodes`\n\n###### Find all modules for abc:\n`/1/abc/nodes?filter[nodeType]=Module`\n\n###### Find all nodes that are descendants of DEP101:\n`/1/abc/nodes?filter[descendant]=department%2Fdep101`\n\n###### Find all Departments that are ancestors of ABF203:\n`/1/abc/nodes?filter[descendant]=module%2Fabf203&filter[nodeType]=Department` # <= case insensitive\n\n###### Find all nodes with list assets that are descendants of DEP101 for abc:\n`/1/abc/nodes?filter[nodeType]=Module&filter[ancestor]=department%2FDEP101&filter[hasAssets]=true&filter[assetType]=List`\n\n###### Globally, find all modules that have no list assets\n`/1/global/nodes?filter[nodeType]=Module&filter[hasAssets]=false&filter[assetType]=List`\n\n###### Find all nodes of type time period valid during 2015 that have no list assets. Note a node's valid_from/valid_to just need to overlap from/to to qualify\n`/1/global/nodes?filter[nodeType]=TimePeriod&filter[hasAssets]=false&filter[assetType]=List&filter[from]=20150101&filter[to]=20151231`\n
+    # @param namespace_inc_global identifier namespacing the blueprint. `global` is a special namespace which references data from all blueprints in the call.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :offset index to start result set from
+    # @option opts [Float] :limit number of records to return
+    # @option opts [String] :filter_node_type type of nodes to return
+    # @option opts [String] :filter_child limit to nodes with children matching code
+    # @option opts [String] :filter_parent limit to nodes with parent matching code
+    # @option opts [String] :filter_ancestor limit to nodes with ancestor matching code
+    # @option opts [String] :filter_descendant limit to nodes with descendant matching code
+    # @option opts [BOOLEAN] :filter_has_assets limit to either nodes that have assets (true) nodes that have no assets (false) or omit to consider both nodes with and without assets
+    # @option opts [String] :filter_asset_type type of asset to return
+    # @option opts [Date] :filter_from limit to results valid after this date, format is  ISO8601 date
+    # @option opts [Date] :filter_to limit to results valid before this date, format is  ISO8601
+    # @return [NodeResultSet]
+    def search_nodes(namespace_inc_global, opts = {})
+      data, _status_code, _headers = search_nodes_with_http_info(namespace_inc_global, opts)
+      return data
+    end
+
+    # Search nodes
+    # This endpoint is a really flexible way to ask questions about the hierarchy. for example:\n\n###### Find all nodes for abc:\n`/1/abc/nodes`\n\n###### Find all modules for abc:\n`/1/abc/nodes?filter[nodeType]=Module`\n\n###### Find all nodes that are descendants of DEP101:\n`/1/abc/nodes?filter[descendant]=department%2Fdep101`\n\n###### Find all Departments that are ancestors of ABF203:\n`/1/abc/nodes?filter[descendant]=module%2Fabf203&amp;filter[nodeType]=Department` # &lt;= case insensitive\n\n###### Find all nodes with list assets that are descendants of DEP101 for abc:\n`/1/abc/nodes?filter[nodeType]=Module&amp;filter[ancestor]=department%2FDEP101&amp;filter[hasAssets]=true&amp;filter[assetType]=List`\n\n###### Globally, find all modules that have no list assets\n`/1/global/nodes?filter[nodeType]=Module&amp;filter[hasAssets]=false&amp;filter[assetType]=List`\n\n###### Find all nodes of type time period valid during 2015 that have no list assets. Note a node&#39;s valid_from/valid_to just need to overlap from/to to qualify\n`/1/global/nodes?filter[nodeType]=TimePeriod&amp;filter[hasAssets]=false&amp;filter[assetType]=List&amp;filter[from]=20150101&amp;filter[to]=20151231`\n
+    # @param namespace_inc_global identifier namespacing the blueprint. `global` is a special namespace which references data from all blueprints in the call.
+    # @param [Hash] opts the optional parameters
+    # @option opts [Float] :offset index to start result set from
+    # @option opts [Float] :limit number of records to return
+    # @option opts [String] :filter_node_type type of nodes to return
+    # @option opts [String] :filter_child limit to nodes with children matching code
+    # @option opts [String] :filter_parent limit to nodes with parent matching code
+    # @option opts [String] :filter_ancestor limit to nodes with ancestor matching code
+    # @option opts [String] :filter_descendant limit to nodes with descendant matching code
+    # @option opts [BOOLEAN] :filter_has_assets limit to either nodes that have assets (true) nodes that have no assets (false) or omit to consider both nodes with and without assets
+    # @option opts [String] :filter_asset_type type of asset to return
+    # @option opts [Date] :filter_from limit to results valid after this date, format is  ISO8601 date
+    # @option opts [Date] :filter_to limit to results valid before this date, format is  ISO8601
+    # @return [Array<(NodeResultSet, Fixnum, Hash)>] NodeResultSet data, response status code and response headers
+    def search_nodes_with_http_info(namespace_inc_global, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: HierarchyApi.search_nodes ..."
+      end
+      
+      
+      # verify the required parameter 'namespace_inc_global' is set
+      fail ArgumentError, "Missing the required parameter 'namespace_inc_global' when calling HierarchyApi.search_nodes" if namespace_inc_global.nil?
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/{namespaceIncGlobal}/nodes".sub('{format}','json').sub('{' + 'namespaceIncGlobal' + '}', namespace_inc_global.to_s)
+
+      # query parameters
+      query_params = {}
+      query_params[:'offset'] = opts[:'offset'] if opts[:'offset']
+      query_params[:'limit'] = opts[:'limit'] if opts[:'limit']
+      query_params[:'filter[nodeType]'] = opts[:'filter_node_type'] if opts[:'filter_node_type']
+      query_params[:'filter[child]'] = opts[:'filter_child'] if opts[:'filter_child']
+      query_params[:'filter[parent]'] = opts[:'filter_parent'] if opts[:'filter_parent']
+      query_params[:'filter[ancestor]'] = opts[:'filter_ancestor'] if opts[:'filter_ancestor']
+      query_params[:'filter[descendant]'] = opts[:'filter_descendant'] if opts[:'filter_descendant']
+      query_params[:'filter[hasAssets]'] = opts[:'filter_has_assets'] if opts[:'filter_has_assets']
+      query_params[:'filter[assetType]'] = opts[:'filter_asset_type'] if opts[:'filter_asset_type']
+      query_params[:'filter[from]'] = opts[:'filter_from'] if opts[:'filter_from']
+      query_params[:'filter[to]'] = opts[:'filter_to'] if opts[:'filter_to']
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/vnd.api+json']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      
+      auth_names = ['oauth2']
+      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 => 'NodeResultSet')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: HierarchyApi#search_nodes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # 
+    # Perform a partial update of a node
+    # @param namespace identifier namespacing the blueprint.
+    # @param id id identifying a domain model
+    # @param body node
+    # @param type Plural form of node type (adds an &#39;s&#39; to the end of the type) todo - allow configuration of plurals
+    # @param [Hash] opts the optional parameters
+    # @return [NodeBody]
+    def update_node(namespace, id, body, type, opts = {})
+      data, _status_code, _headers = update_node_with_http_info(namespace, id, body, type, opts)
+      return data
+    end
+
+    # 
+    # Perform a partial update of a node
+    # @param namespace identifier namespacing the blueprint.
+    # @param id id identifying a domain model
+    # @param body node
+    # @param type Plural form of node type (adds an &#39;s&#39; to the end of the type) todo - allow configuration of plurals
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(NodeBody, Fixnum, Hash)>] NodeBody data, response status code and response headers
+    def update_node_with_http_info(namespace, id, body, type, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: HierarchyApi.update_node ..."
+      end
+      
+      
+      # verify the required parameter 'namespace' is set
+      fail ArgumentError, "Missing the required parameter 'namespace' when calling HierarchyApi.update_node" if namespace.nil?
+      
+      
+      
+      
+      
+      
+      # verify the required parameter 'id' is set
+      fail ArgumentError, "Missing the required parameter 'id' when calling HierarchyApi.update_node" if id.nil?
+      
+      
+      
+      
+      
+      
+      # verify the required parameter 'body' is set
+      fail ArgumentError, "Missing the required parameter 'body' when calling HierarchyApi.update_node" if body.nil?
+      
+      
+      
+      
+      
+      
+      # verify the required parameter 'type' is set
+      fail ArgumentError, "Missing the required parameter 'type' when calling HierarchyApi.update_node" if type.nil?
+      
+      
+      
+      
+      
+      # resource path
+      local_var_path = "/{namespace}/nodes/{type}/{id}".sub('{format}','json').sub('{' + 'namespace' + '}', namespace.to_s).sub('{' + 'id' + '}', id.to_s).sub('{' + 'type' + '}', type.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+
+      # HTTP header 'Accept' (if needed)
+      local_header_accept = ['application/vnd.api+json']
+      local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result
+
+      # HTTP header 'Content-Type'
+      local_header_content_type = ['application/json']
+      header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(body)
+      
+      auth_names = ['oauth2']
+      data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'NodeBody')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: HierarchyApi#update_node\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end