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

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

import Foundation

open class CodeAPI {

    /**
     Answers a question about the caller org's code with a CITED answer: retrieval packs grounding context, then the synthesizer writes the answer over exactly those spans, which come back alongside it.
     
     - parameter q: (query) Q is the question to answer. Required, max 4000 bytes. (optional)
     - parameter repo: (query) Repo narrows retrieval to one repository. Empty searches every repo the org has indexed. (optional)
     - parameter apiConfiguration: The configuration for the http request.
     - returns: AskAnswer
     */
    @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
    open class func getCodeAsk(q: String? = nil, repo: String? = nil, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) async throws(ErrorResponse) -> AskAnswer {
        return try await getCodeAskWithRequestBuilder(q: q, repo: repo, apiConfiguration: apiConfiguration).execute().body
    }

    /**
     Answers a question about the caller org's code with a CITED answer: retrieval packs grounding context, then the synthesizer writes the answer over exactly those spans, which come back alongside it.
     - GET /v1/code/ask
     - Answers a question about the caller org's code with a CITED answer: retrieval packs grounding context, then the synthesizer writes the answer over exactly those spans, which come back alongside it. It never answers without grounding — with no matched code the answer is empty and says so, and with no synthesizer available the citations still come back with \"degraded\": true so the caller can reason over the spans itself.
     - Bearer Token:
       - type: http
       - name: bearer
     - parameter q: (query) Q is the question to answer. Required, max 4000 bytes. (optional)
     - parameter repo: (query) Repo narrows retrieval to one repository. Empty searches every repo the org has indexed. (optional)
     - parameter apiConfiguration: The configuration for the http request.
     - returns: RequestBuilder<AskAnswer> 
     */
    open class func getCodeAskWithRequestBuilder(q: String? = nil, repo: String? = nil, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) -> RequestBuilder<AskAnswer> {
        let localVariablePath = "/v1/code/ask"
        let localVariableURLString = apiConfiguration.basePath + localVariablePath
        let localVariableParameters: [String: any Sendable]? = nil

        var localVariableUrlComponents = URLComponents(string: localVariableURLString)
        localVariableUrlComponents?.queryItems = APIHelper.mapValuesToQueryItems([
            "q": (wrappedValue: q?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true),
            "repo": (wrappedValue: repo?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true),
        ])

        let localVariableNillableHeaders: [String: (any Sendable)?] = [
            :
        ]

        let localVariableHeaderParameters = APIHelper.rejectNilHeaders(localVariableNillableHeaders)

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

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

    /**
     Returns the INDEXED content of one file — read_file over the chunks the search tiers hold, for pulling up code an agent just found.
     
     - parameter path: (query) Path is the file&#39;s repo-relative path. Required. (optional)
     - parameter repo: (query) Repo is the repository the file belongs to. REQUIRED. (optional)
     - parameter apiConfiguration: The configuration for the http request.
     - returns: FileContent
     */
    @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
    open class func getCodeFile(path: String? = nil, repo: String? = nil, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) async throws(ErrorResponse) -> FileContent {
        return try await getCodeFileWithRequestBuilder(path: path, repo: repo, apiConfiguration: apiConfiguration).execute().body
    }

    /**
     Returns the INDEXED content of one file — read_file over the chunks the search tiers hold, for pulling up code an agent just found.
     - GET /v1/code/file
     - Returns the INDEXED content of one file — read_file over the chunks the search tiers hold, for pulling up code an agent just found. It is NOT byte-verbatim: the git object plane is the source of record for exact bytes, history and blame. A file absent from the index is a 404, so an agent can tell \"not indexed\" from \"empty file\".
     - Bearer Token:
       - type: http
       - name: bearer
     - parameter path: (query) Path is the file&#39;s repo-relative path. Required. (optional)
     - parameter repo: (query) Repo is the repository the file belongs to. REQUIRED. (optional)
     - parameter apiConfiguration: The configuration for the http request.
     - returns: RequestBuilder<FileContent> 
     */
    open class func getCodeFileWithRequestBuilder(path: String? = nil, repo: String? = nil, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) -> RequestBuilder<FileContent> {
        let localVariablePath = "/v1/code/file"
        let localVariableURLString = apiConfiguration.basePath + localVariablePath
        let localVariableParameters: [String: any Sendable]? = nil

        var localVariableUrlComponents = URLComponents(string: localVariableURLString)
        localVariableUrlComponents?.queryItems = APIHelper.mapValuesToQueryItems([
            "path": (wrappedValue: path?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true),
            "repo": (wrappedValue: repo?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true),
        ])

        let localVariableNillableHeaders: [String: (any Sendable)?] = [
            :
        ]

        let localVariableHeaderParameters = APIHelper.rejectNilHeaders(localVariableNillableHeaders)

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

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

    /**
     Finds code in the caller org's index across three orthogonal retrieval tiers fused by reciprocal-rank fusion: lexical (FTS5 trigram over code-tokenized text), symbolic (real definition and reference edges), and semantic (embedding cosine over AST-boundary chunks).
     
     - parameter q: (query) Q is the search query. Required, max 4000 bytes. For type&#x3D;regex it is a regular expression; for type&#x3D;symbol it is a symbol name. (optional)
     - parameter type: (query) Type selects the retrieval tier: \&quot;text\&quot; (FTS5 trigram), \&quot;regex\&quot;, \&quot;symbol\&quot; (definitions), \&quot;semantic\&quot; (embeddings) or \&quot;hybrid\&quot;. Anything else — including empty — reads as hybrid. (optional)
     - parameter repo: (query) Repo narrows to one repository. Empty searches every repo the org has indexed. (optional)
     - parameter limit: (query) Limit caps how many spans come back: default 20, maximum 100. A value that is not a positive integer reads as the default. (optional)
     - parameter apiConfiguration: The configuration for the http request.
     - returns: SearchResults
     */
    @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
    open class func getCodeSearch(q: String? = nil, type: String? = nil, repo: String? = nil, limit: Int64? = nil, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) async throws(ErrorResponse) -> SearchResults {
        return try await getCodeSearchWithRequestBuilder(q: q, type: type, repo: repo, limit: limit, apiConfiguration: apiConfiguration).execute().body
    }

    /**
     Finds code in the caller org's index across three orthogonal retrieval tiers fused by reciprocal-rank fusion: lexical (FTS5 trigram over code-tokenized text), symbolic (real definition and reference edges), and semantic (embedding cosine over AST-boundary chunks).
     - GET /v1/code/search
     - Finds code in the caller org's index across three orthogonal retrieval tiers fused by reciprocal-rank fusion: lexical (FTS5 trigram over code-tokenized text), symbolic (real definition and reference edges), and semantic (embedding cosine over AST-boundary chunks). Pick one tier with `type`, or leave it to run all three as hybrid, which is what a coding agent usually wants. It is FAIL-HONEST: a retrieval outage answers 200 with an empty result set and \"degraded\": true rather than a 5xx, so an agent degrades instead of stalling. A malformed regex is a 400.
     - Bearer Token:
       - type: http
       - name: bearer
     - parameter q: (query) Q is the search query. Required, max 4000 bytes. For type&#x3D;regex it is a regular expression; for type&#x3D;symbol it is a symbol name. (optional)
     - parameter type: (query) Type selects the retrieval tier: \&quot;text\&quot; (FTS5 trigram), \&quot;regex\&quot;, \&quot;symbol\&quot; (definitions), \&quot;semantic\&quot; (embeddings) or \&quot;hybrid\&quot;. Anything else — including empty — reads as hybrid. (optional)
     - parameter repo: (query) Repo narrows to one repository. Empty searches every repo the org has indexed. (optional)
     - parameter limit: (query) Limit caps how many spans come back: default 20, maximum 100. A value that is not a positive integer reads as the default. (optional)
     - parameter apiConfiguration: The configuration for the http request.
     - returns: RequestBuilder<SearchResults> 
     */
    open class func getCodeSearchWithRequestBuilder(q: String? = nil, type: String? = nil, repo: String? = nil, limit: Int64? = nil, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) -> RequestBuilder<SearchResults> {
        let localVariablePath = "/v1/code/search"
        let localVariableURLString = apiConfiguration.basePath + localVariablePath
        let localVariableParameters: [String: any Sendable]? = nil

        var localVariableUrlComponents = URLComponents(string: localVariableURLString)
        localVariableUrlComponents?.queryItems = APIHelper.mapValuesToQueryItems([
            "q": (wrappedValue: q?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true),
            "type": (wrappedValue: type?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true),
            "repo": (wrappedValue: repo?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true),
            "limit": (wrappedValue: limit?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true),
        ])

        let localVariableNillableHeaders: [String: (any Sendable)?] = [
            :
        ]

        let localVariableHeaderParameters = APIHelper.rejectNilHeaders(localVariableNillableHeaders)

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

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

    /**
     Returns one repository's file structure with a per-file symbol count — get_repo_structure over the org's own index, with no git checkout involved.
     
     - parameter repo: (query) Repo is the repository to walk. REQUIRED — a tree is repo-scoped. (optional)
     - parameter apiConfiguration: The configuration for the http request.
     - returns: RepoTree
     */
    @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
    open class func getCodeTree(repo: String? = nil, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) async throws(ErrorResponse) -> RepoTree {
        return try await getCodeTreeWithRequestBuilder(repo: repo, apiConfiguration: apiConfiguration).execute().body
    }

    /**
     Returns one repository's file structure with a per-file symbol count — get_repo_structure over the org's own index, with no git checkout involved.
     - GET /v1/code/tree
     - Returns one repository's file structure with a per-file symbol count — get_repo_structure over the org's own index, with no git checkout involved. A repository that has not been indexed answers an empty tree rather than an error, so an agent can tell \"nothing here\" without handling a failure.
     - Bearer Token:
       - type: http
       - name: bearer
     - parameter repo: (query) Repo is the repository to walk. REQUIRED — a tree is repo-scoped. (optional)
     - parameter apiConfiguration: The configuration for the http request.
     - returns: RequestBuilder<RepoTree> 
     */
    open class func getCodeTreeWithRequestBuilder(repo: String? = nil, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) -> RequestBuilder<RepoTree> {
        let localVariablePath = "/v1/code/tree"
        let localVariableURLString = apiConfiguration.basePath + localVariablePath
        let localVariableParameters: [String: any Sendable]? = nil

        var localVariableUrlComponents = URLComponents(string: localVariableURLString)
        localVariableUrlComponents?.queryItems = APIHelper.mapValuesToQueryItems([
            "repo": (wrappedValue: repo?.asParameter(codableHelper: apiConfiguration.codableHelper), isExplode: true),
        ])

        let localVariableNillableHeaders: [String: (any Sendable)?] = [
            :
        ]

        let localVariableHeaderParameters = APIHelper.rejectNilHeaders(localVariableNillableHeaders)

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

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

    /**
     Is askGet with the question in the request BODY, for a question too long or too awkward to put in a URL.
     
     - parameter askPostIn: (body)  
     - parameter apiConfiguration: The configuration for the http request.
     - returns: AskAnswer
     */
    @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
    open class func postCodeAsk(askPostIn: AskPostIn, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) async throws(ErrorResponse) -> AskAnswer {
        return try await postCodeAskWithRequestBuilder(askPostIn: askPostIn, apiConfiguration: apiConfiguration).execute().body
    }

    /**
     Is askGet with the question in the request BODY, for a question too long or too awkward to put in a URL.
     - POST /v1/code/ask
     - Is askGet with the question in the request BODY, for a question too long or too awkward to put in a URL. `query` and `repo` in the body take precedence over `?q=` and `?repo=`; either source works alone.
     - Bearer Token:
       - type: http
       - name: bearer
     - parameter askPostIn: (body)  
     - parameter apiConfiguration: The configuration for the http request.
     - returns: RequestBuilder<AskAnswer> 
     */
    open class func postCodeAskWithRequestBuilder(askPostIn: AskPostIn, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) -> RequestBuilder<AskAnswer> {
        let localVariablePath = "/v1/code/ask"
        let localVariableURLString = apiConfiguration.basePath + localVariablePath
        let localVariableParameters = JSONEncodingHelper.encodingParameters(forEncodableObject: askPostIn, 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<AskAnswer>.Type = apiConfiguration.requestBuilderFactory.getBuilder()

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

    /**
     Packs the most relevant code for a query into a token budget — THE primitive for a coding agent that has to decide what to put in a prompt.
     
     - parameter contextIn: (body)  
     - parameter apiConfiguration: The configuration for the http request.
     - returns: ContextBundle
     */
    @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
    open class func postCodeContext(contextIn: ContextIn, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) async throws(ErrorResponse) -> ContextBundle {
        return try await postCodeContextWithRequestBuilder(contextIn: contextIn, apiConfiguration: apiConfiguration).execute().body
    }

    /**
     Packs the most relevant code for a query into a token budget — THE primitive for a coding agent that has to decide what to put in a prompt.
     - POST /v1/code/context
     - Packs the most relevant code for a query into a token budget — THE primitive for a coding agent that has to decide what to put in a prompt. It retrieves seed spans, expands each with the definitions it calls and its key callers, then greedily fills the budget, so the answer is a coherent slice of the codebase rather than a list of disconnected matches. The top match is always included, truncated if it alone overflows, so a matched query never comes back empty. A retrieval outage answers 200 with an empty bundle rather than a 5xx.
     - Bearer Token:
       - type: http
       - name: bearer
     - parameter contextIn: (body)  
     - parameter apiConfiguration: The configuration for the http request.
     - returns: RequestBuilder<ContextBundle> 
     */
    open class func postCodeContextWithRequestBuilder(contextIn: ContextIn, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) -> RequestBuilder<ContextBundle> {
        let localVariablePath = "/v1/code/context"
        let localVariableURLString = apiConfiguration.basePath + localVariablePath
        let localVariableParameters = JSONEncodingHelper.encodingParameters(forEncodableObject: contextIn, 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<ContextBundle>.Type = apiConfiguration.requestBuilderFactory.getBuilder()

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

    /**
     (re)indexes a repository for the caller's org, incrementally: files whose content hash is unchanged are skipped, so re-sending a whole tree is cheap.
     
     - parameter indexIn: (body)  
     - parameter apiConfiguration: The configuration for the http request.
     - returns: IndexResult
     */
    @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
    open class func postCodeIndex(indexIn: IndexIn, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) async throws(ErrorResponse) -> IndexResult {
        return try await postCodeIndexWithRequestBuilder(indexIn: indexIn, apiConfiguration: apiConfiguration).execute().body
    }

    /**
     (re)indexes a repository for the caller's org, incrementally: files whose content hash is unchanged are skipped, so re-sending a whole tree is cheap.
     - POST /v1/code/index
     - (re)indexes a repository for the caller's org, incrementally: files whose content hash is unchanged are skipped, so re-sending a whole tree is cheap. Each file is parsed for symbols, split at AST boundaries and — when the semantic tier is available — embedded, which is what makes it searchable across all three retrieval tiers. Pass `prune` to also DELETE indexed files absent from the request, which turns the call into a full sync; without it the call is an upsert. The index is written to the caller org's own physically separate database.
     - Bearer Token:
       - type: http
       - name: bearer
     - parameter indexIn: (body)  
     - parameter apiConfiguration: The configuration for the http request.
     - returns: RequestBuilder<IndexResult> 
     */
    open class func postCodeIndexWithRequestBuilder(indexIn: IndexIn, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) -> RequestBuilder<IndexResult> {
        let localVariablePath = "/v1/code/index"
        let localVariableURLString = apiConfiguration.basePath + localVariablePath
        let localVariableParameters = JSONEncodingHelper.encodingParameters(forEncodableObject: indexIn, 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<IndexResult>.Type = apiConfiguration.requestBuilderFactory.getBuilder()

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