swift-sdk/Sources/Hanzo/APIs/LspAPI.swift

//
// LspAPI.swift
//
// Generated by openapi-generator
// https://openapi-generator.tech
//

import Foundation

open class LspAPI {

    /**
     Offers the candidates a language server has at a position, typed and resolved through the repository's dependencies rather than guessed from text.
     
     - parameter query: (body)  
     - parameter apiConfiguration: The configuration for the http request.
     - returns: Answer
     */
    @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
    open class func postLspComplete(query: Query, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) async throws(ErrorResponse) -> Answer {
        return try await postLspCompleteWithRequestBuilder(query: query, apiConfiguration: apiConfiguration).execute().body
    }

    /**
     Offers the candidates a language server has at a position, typed and resolved through the repository's dependencies rather than guessed from text.
     - POST /v1/lsp/complete
     - Offers the candidates a language server has at a position, typed and resolved through the repository's dependencies rather than guessed from text.
     - Bearer Token:
       - type: http
       - name: bearer
     - parameter query: (body)  
     - parameter apiConfiguration: The configuration for the http request.
     - returns: RequestBuilder<Answer> 
     */
    open class func postLspCompleteWithRequestBuilder(query: Query, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) -> RequestBuilder<Answer> {
        let localVariablePath = "/v1/lsp/complete"
        let localVariableURLString = apiConfiguration.basePath + localVariablePath
        let localVariableParameters = JSONEncodingHelper.encodingParameters(forEncodableObject: query, codableHelper: apiConfiguration.codableHelper)

        let localVariableUrlComponents = URLComponents(string: localVariableURLString)

        let localVariableNillableHeaders: [String: (any Sendable)?] = [
            "Content-Type": "application/json",
        ]

        let localVariableHeaderParameters = APIHelper.rejectNilHeaders(localVariableNillableHeaders)

        let localVariableRequestBuilder: RequestBuilder<Answer>.Type = apiConfiguration.requestBuilderFactory.getBuilder()

        return localVariableRequestBuilder.init(method: "POST", URLString: (localVariableUrlComponents?.string ?? localVariableURLString), parameters: localVariableParameters, headers: localVariableHeaderParameters, requiresAuthentication: true, apiConfiguration: apiConfiguration)
    }

    /**
     Reports every problem the language server finds in one file — compile errors, type errors and lints, each with its span and its severity (1 error, 2 warning, 3 information, 4 hint).
     
     - parameter query: (body)  
     - parameter apiConfiguration: The configuration for the http request.
     - returns: Answer
     */
    @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
    open class func postLspDiagnostics(query: Query, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) async throws(ErrorResponse) -> Answer {
        return try await postLspDiagnosticsWithRequestBuilder(query: query, apiConfiguration: apiConfiguration).execute().body
    }

    /**
     Reports every problem the language server finds in one file — compile errors, type errors and lints, each with its span and its severity (1 error, 2 warning, 3 information, 4 hint).
     - POST /v1/lsp/diagnostics
     - Reports every problem the language server finds in one file — compile errors, type errors and lints, each with its span and its severity (1 error, 2 warning, 3 information, 4 hint). The position is ignored.
     - Bearer Token:
       - type: http
       - name: bearer
     - parameter query: (body)  
     - parameter apiConfiguration: The configuration for the http request.
     - returns: RequestBuilder<Answer> 
     */
    open class func postLspDiagnosticsWithRequestBuilder(query: Query, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) -> RequestBuilder<Answer> {
        let localVariablePath = "/v1/lsp/diagnostics"
        let localVariableURLString = apiConfiguration.basePath + localVariablePath
        let localVariableParameters = JSONEncodingHelper.encodingParameters(forEncodableObject: query, codableHelper: apiConfiguration.codableHelper)

        let localVariableUrlComponents = URLComponents(string: localVariableURLString)

        let localVariableNillableHeaders: [String: (any Sendable)?] = [
            "Content-Type": "application/json",
        ]

        let localVariableHeaderParameters = APIHelper.rejectNilHeaders(localVariableNillableHeaders)

        let localVariableRequestBuilder: RequestBuilder<Answer>.Type = apiConfiguration.requestBuilderFactory.getBuilder()

        return localVariableRequestBuilder.init(method: "POST", URLString: (localVariableUrlComponents?.string ?? localVariableURLString), parameters: localVariableParameters, headers: localVariableHeaderParameters, requiresAuthentication: true, apiConfiguration: apiConfiguration)
    }

    /**
     Renders the type and documentation of the symbol at a position, as the language server itself renders it.
     
     - parameter query: (body)  
     - parameter apiConfiguration: The configuration for the http request.
     - returns: Answer
     */
    @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
    open class func postLspHover(query: Query, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) async throws(ErrorResponse) -> Answer {
        return try await postLspHoverWithRequestBuilder(query: query, apiConfiguration: apiConfiguration).execute().body
    }

    /**
     Renders the type and documentation of the symbol at a position, as the language server itself renders it.
     - POST /v1/lsp/hover
     - Renders the type and documentation of the symbol at a position, as the language server itself renders it.  Positions are the LSP's: line and character are 0-BASED and character counts UTF-16 code units, so an editor's 1-based line must have 1 subtracted before it is sent. The repository is named by slug and is always one in the caller's own org; rev pins a branch, tag or commit sha, and empty means the default branch.
     - Bearer Token:
       - type: http
       - name: bearer
     - parameter query: (body)  
     - parameter apiConfiguration: The configuration for the http request.
     - returns: RequestBuilder<Answer> 
     */
    open class func postLspHoverWithRequestBuilder(query: Query, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) -> RequestBuilder<Answer> {
        let localVariablePath = "/v1/lsp/hover"
        let localVariableURLString = apiConfiguration.basePath + localVariablePath
        let localVariableParameters = JSONEncodingHelper.encodingParameters(forEncodableObject: query, codableHelper: apiConfiguration.codableHelper)

        let localVariableUrlComponents = URLComponents(string: localVariableURLString)

        let localVariableNillableHeaders: [String: (any Sendable)?] = [
            "Content-Type": "application/json",
        ]

        let localVariableHeaderParameters = APIHelper.rejectNilHeaders(localVariableNillableHeaders)

        let localVariableRequestBuilder: RequestBuilder<Answer>.Type = apiConfiguration.requestBuilderFactory.getBuilder()

        return localVariableRequestBuilder.init(method: "POST", URLString: (localVariableUrlComponents?.string ?? localVariableURLString), parameters: localVariableParameters, headers: localVariableHeaderParameters, requiresAuthentication: true, apiConfiguration: apiConfiguration)
    }

    /**
     Finds where a symbol lives: its definition, its references, its type or its implementations, chosen by relation (definition, reference, type, implementation — empty means definition).
     
     - parameter query: (body)  
     - parameter apiConfiguration: The configuration for the http request.
     - returns: Answer
     */
    @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
    open class func postLspLocate(query: Query, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) async throws(ErrorResponse) -> Answer {
        return try await postLspLocateWithRequestBuilder(query: query, apiConfiguration: apiConfiguration).execute().body
    }

    /**
     Finds where a symbol lives: its definition, its references, its type or its implementations, chosen by relation (definition, reference, type, implementation — empty means definition).
     - POST /v1/lsp/locate
     - Finds where a symbol lives: its definition, its references, its type or its implementations, chosen by relation (definition, reference, type, implementation — empty means definition).  It resolves THROUGH dependencies. An answer whose external flag is set left the repository, and its path is then the module coordinate it landed in — which is the question a static index cannot answer and this service exists for.
     - Bearer Token:
       - type: http
       - name: bearer
     - parameter query: (body)  
     - parameter apiConfiguration: The configuration for the http request.
     - returns: RequestBuilder<Answer> 
     */
    open class func postLspLocateWithRequestBuilder(query: Query, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) -> RequestBuilder<Answer> {
        let localVariablePath = "/v1/lsp/locate"
        let localVariableURLString = apiConfiguration.basePath + localVariablePath
        let localVariableParameters = JSONEncodingHelper.encodingParameters(forEncodableObject: query, codableHelper: apiConfiguration.codableHelper)

        let localVariableUrlComponents = URLComponents(string: localVariableURLString)

        let localVariableNillableHeaders: [String: (any Sendable)?] = [
            "Content-Type": "application/json",
        ]

        let localVariableHeaderParameters = APIHelper.rejectNilHeaders(localVariableNillableHeaders)

        let localVariableRequestBuilder: RequestBuilder<Answer>.Type = apiConfiguration.requestBuilderFactory.getBuilder()

        return localVariableRequestBuilder.init(method: "POST", URLString: (localVariableUrlComponents?.string ?? localVariableURLString), parameters: localVariableParameters, headers: localVariableHeaderParameters, requiresAuthentication: true, apiConfiguration: apiConfiguration)
    }

    /**
     Outlines one file: every declaration in it, with its kind and its span.
     
     - parameter query: (body)  
     - parameter apiConfiguration: The configuration for the http request.
     - returns: Answer
     */
    @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
    open class func postLspSymbols(query: Query, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) async throws(ErrorResponse) -> Answer {
        return try await postLspSymbolsWithRequestBuilder(query: query, apiConfiguration: apiConfiguration).execute().body
    }

    /**
     Outlines one file: every declaration in it, with its kind and its span.
     - POST /v1/lsp/symbols
     - Outlines one file: every declaration in it, with its kind and its span. The position is ignored — the answer is the whole file.
     - Bearer Token:
       - type: http
       - name: bearer
     - parameter query: (body)  
     - parameter apiConfiguration: The configuration for the http request.
     - returns: RequestBuilder<Answer> 
     */
    open class func postLspSymbolsWithRequestBuilder(query: Query, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) -> RequestBuilder<Answer> {
        let localVariablePath = "/v1/lsp/symbols"
        let localVariableURLString = apiConfiguration.basePath + localVariablePath
        let localVariableParameters = JSONEncodingHelper.encodingParameters(forEncodableObject: query, codableHelper: apiConfiguration.codableHelper)

        let localVariableUrlComponents = URLComponents(string: localVariableURLString)

        let localVariableNillableHeaders: [String: (any Sendable)?] = [
            "Content-Type": "application/json",
        ]

        let localVariableHeaderParameters = APIHelper.rejectNilHeaders(localVariableNillableHeaders)

        let localVariableRequestBuilder: RequestBuilder<Answer>.Type = apiConfiguration.requestBuilderFactory.getBuilder()

        return localVariableRequestBuilder.init(method: "POST", URLString: (localVariableUrlComponents?.string ?? localVariableURLString), parameters: localVariableParameters, headers: localVariableHeaderParameters, requiresAuthentication: true, apiConfiguration: apiConfiguration)
    }
}