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

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

import Foundation

open class WalletAPI {

    /**
     Returns the caller org's wallets, newest first, optionally NARROWED within the org by project, agent or account.
     
     - parameter project: (query) Project narrows to wallets scoped to one project. Must be a url-safe segment. (optional)
     - parameter agent: (query) Agent narrows to wallets scoped to one agent. Must be a url-safe segment. (optional)
     - parameter account: (query) Account narrows to wallets under one account id. Must be a url-safe segment. (optional)
     - parameter apiConfiguration: The configuration for the http request.
     - returns: WalletList
     */
    @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
    open class func getWallet(project: String? = nil, agent: String? = nil, account: String? = nil, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) async throws(ErrorResponse) -> WalletList {
        return try await getWalletWithRequestBuilder(project: project, agent: agent, account: account, apiConfiguration: apiConfiguration).execute().body
    }

    /**
     Returns the caller org's wallets, newest first, optionally NARROWED within the org by project, agent or account.
     - GET /v1/wallet
     - Returns the caller org's wallets, newest first, optionally NARROWED within the org by project, agent or account. The org is always the bound isolation boundary — the filters only ever narrow inside it, so a caller can never widen past its own org.
     - Bearer Token:
       - type: http
       - name: bearer
     - parameter project: (query) Project narrows to wallets scoped to one project. Must be a url-safe segment. (optional)
     - parameter agent: (query) Agent narrows to wallets scoped to one agent. Must be a url-safe segment. (optional)
     - parameter account: (query) Account narrows to wallets under one account id. Must be a url-safe segment. (optional)
     - parameter apiConfiguration: The configuration for the http request.
     - returns: RequestBuilder<WalletList> 
     */
    open class func getWalletWithRequestBuilder(project: String? = nil, agent: String? = nil, account: String? = nil, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) -> RequestBuilder<WalletList> {
        let localVariablePath = "/v1/wallet"
        let localVariableURLString = apiConfiguration.basePath + localVariablePath
        let localVariableParameters: [String: any Sendable]? = nil

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

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

        let localVariableHeaderParameters = APIHelper.rejectNilHeaders(localVariableNillableHeaders)

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

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

    /**
     Returns the caller org's wallet accounts, newest first.
     
     - parameter apiConfiguration: The configuration for the http request.
     - returns: AccountList
     */
    @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
    open class func getWalletAccounts(apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) async throws(ErrorResponse) -> AccountList {
        return try await getWalletAccountsWithRequestBuilder(apiConfiguration: apiConfiguration).execute().body
    }

    /**
     Returns the caller org's wallet accounts, newest first.
     - GET /v1/wallet/accounts
     - Returns the caller org's wallet accounts, newest first. Accounts are physically org-scoped, so another tenant's are not reachable from here.
     - Bearer Token:
       - type: http
       - name: bearer
     - parameter apiConfiguration: The configuration for the http request.
     - returns: RequestBuilder<AccountList> 
     */
    open class func getWalletAccountsWithRequestBuilder(apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) -> RequestBuilder<AccountList> {
        let localVariablePath = "/v1/wallet/accounts"
        let localVariableURLString = apiConfiguration.basePath + localVariablePath
        let localVariableParameters: [String: any Sendable]? = nil

        let localVariableUrlComponents = URLComponents(string: localVariableURLString)

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

        let localVariableHeaderParameters = APIHelper.rejectNilHeaders(localVariableNillableHeaders)

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

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

    /**
     Returns one of the caller org's wallets: its scope, custody kind, tier, chain and on-chain address.
     
     - parameter id: (path)  
     - parameter apiConfiguration: The configuration for the http request.
     - returns: Wallet
     */
    @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
    open class func getWalletById(id: String, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) async throws(ErrorResponse) -> Wallet {
        return try await getWalletByIdWithRequestBuilder(id: id, apiConfiguration: apiConfiguration).execute().body
    }

    /**
     Returns one of the caller org's wallets: its scope, custody kind, tier, chain and on-chain address.
     - GET /v1/wallet/{id}
     - Returns one of the caller org's wallets: its scope, custody kind, tier, chain and on-chain address. The custody handle to the signing material is never part of the answer. A wallet id another org owns reads as not found, so the response cannot confirm that it exists.
     - Bearer Token:
       - type: http
       - name: bearer
     - parameter id: (path)  
     - parameter apiConfiguration: The configuration for the http request.
     - returns: RequestBuilder<Wallet> 
     */
    open class func getWalletByIdWithRequestBuilder(id: String, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) -> RequestBuilder<Wallet> {
        var localVariablePath = "/v1/wallet/{id}"
        let idPreEscape = "\(APIHelper.mapValueToPathItem(id))"
        let idPostEscape = idPreEscape.addingPercentEncoding(withAllowedCharacters: .urlPathAllowed) ?? ""
        localVariablePath = localVariablePath.replacingOccurrences(of: "{id}", with: idPostEscape, options: .literal, range: nil)
        let localVariableURLString = apiConfiguration.basePath + localVariablePath
        let localVariableParameters: [String: any Sendable]? = nil

        let localVariableUrlComponents = URLComponents(string: localVariableURLString)

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

        let localVariableHeaderParameters = APIHelper.rejectNilHeaders(localVariableNillableHeaders)

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

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

    /**
     Provisions a new signing identity under one of the caller org's accounts and answers the stored wallet including its on-chain address.
     
     - parameter createWalletIn: (body)  
     - parameter apiConfiguration: The configuration for the http request.
     - returns: Wallet
     */
    @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
    open class func postWallet(createWalletIn: CreateWalletIn, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) async throws(ErrorResponse) -> Wallet {
        return try await postWalletWithRequestBuilder(createWalletIn: createWalletIn, apiConfiguration: apiConfiguration).execute().body
    }

    /**
     Provisions a new signing identity under one of the caller org's accounts and answers the stored wallet including its on-chain address.
     - POST /v1/wallet
     - Provisions a new signing identity under one of the caller org's accounts and answers the stored wallet including its on-chain address. The custody backend generates the key material — a KMS-sealed secp256k1 key, an MPC threshold key on the ring, or a Safe smart wallet owned by one — and the HANDLE to it is kept server-side and never returned. A custody kind the deployment has not wired fails CLOSED with 503: a signature is never fabricated. The wallet is scoped to the org, the caller's ambient project, and optionally an agent and the named account; those narrowings are what its key ref is derived from, so each must be a url-safe segment.
     - Bearer Token:
       - type: http
       - name: bearer
     - parameter createWalletIn: (body)  
     - parameter apiConfiguration: The configuration for the http request.
     - returns: RequestBuilder<Wallet> 
     */
    open class func postWalletWithRequestBuilder(createWalletIn: CreateWalletIn, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) -> RequestBuilder<Wallet> {
        let localVariablePath = "/v1/wallet"
        let localVariableURLString = apiConfiguration.basePath + localVariablePath
        let localVariableParameters = JSONEncodingHelper.encodingParameters(forEncodableObject: createWalletIn, 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<Wallet>.Type = apiConfiguration.requestBuilderFactory.getBuilder()

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

    /**
     Opens a named wallet account for the caller's org.
     
     - parameter createAccountIn: (body)  
     - parameter apiConfiguration: The configuration for the http request.
     - returns: WalletAccount
     */
    @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
    open class func postWalletAccounts(createAccountIn: CreateAccountIn, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) async throws(ErrorResponse) -> WalletAccount {
        return try await postWalletAccountsWithRequestBuilder(createAccountIn: createAccountIn, apiConfiguration: apiConfiguration).execute().body
    }

    /**
     Opens a named wallet account for the caller's org.
     - POST /v1/wallet/accounts
     - Opens a named wallet account for the caller's org. An account is a GROUPING of wallets, not a key or a balance: wallets are created under one and can be listed by it. The org is stamped by the server from the validated principal, so a request can never open an account in another tenant.
     - Bearer Token:
       - type: http
       - name: bearer
     - parameter createAccountIn: (body)  
     - parameter apiConfiguration: The configuration for the http request.
     - returns: RequestBuilder<WalletAccount> 
     */
    open class func postWalletAccountsWithRequestBuilder(createAccountIn: CreateAccountIn, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) -> RequestBuilder<WalletAccount> {
        let localVariablePath = "/v1/wallet/accounts"
        let localVariableURLString = apiConfiguration.basePath + localVariablePath
        let localVariableParameters = JSONEncodingHelper.encodingParameters(forEncodableObject: createAccountIn, 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<WalletAccount>.Type = apiConfiguration.requestBuilderFactory.getBuilder()

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

    /**
     Rolls one wallet's signing material through its own custody backend and answers the wallet with whatever address that produced.
     
     - parameter id: (path)  
     - parameter apiConfiguration: The configuration for the http request.
     - returns: Wallet
     */
    @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
    open class func postWalletByIdKeys(id: String, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) async throws(ErrorResponse) -> Wallet {
        return try await postWalletByIdKeysWithRequestBuilder(id: id, apiConfiguration: apiConfiguration).execute().body
    }

    /**
     Rolls one wallet's signing material through its own custody backend and answers the wallet with whatever address that produced.
     - POST /v1/wallet/{id}/keys
     - Rolls one wallet's signing material through its own custody backend and answers the wallet with whatever address that produced. For KMS custody a fresh secp256k1 key is generated and sealed, which CHANGES the address — funds and approvals at the old address do not move. For a Safe the address is counterfactual and the owner shares are ring-managed, so rotation is a no-op and the address is unchanged. A backend that is not configured fails closed with 503 rather than leaving the wallet half-rotated.
     - Bearer Token:
       - type: http
       - name: bearer
     - parameter id: (path)  
     - parameter apiConfiguration: The configuration for the http request.
     - returns: RequestBuilder<Wallet> 
     */
    open class func postWalletByIdKeysWithRequestBuilder(id: String, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) -> RequestBuilder<Wallet> {
        var localVariablePath = "/v1/wallet/{id}/keys"
        let idPreEscape = "\(APIHelper.mapValueToPathItem(id))"
        let idPostEscape = idPreEscape.addingPercentEncoding(withAllowedCharacters: .urlPathAllowed) ?? ""
        localVariablePath = localVariablePath.replacingOccurrences(of: "{id}", with: idPostEscape, options: .literal, range: nil)
        let localVariableURLString = apiConfiguration.basePath + localVariablePath
        let localVariableParameters: [String: any Sendable]? = nil

        let localVariableUrlComponents = URLComponents(string: localVariableURLString)

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

        let localVariableHeaderParameters = APIHelper.rejectNilHeaders(localVariableNillableHeaders)

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

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

    /**
     Produces a secp256k1 signature from one of the caller org's wallets over a 32-byte digest, through whichever custody backend that wallet uses.
     
     - parameter id: (path)  
     - parameter signIn: (body)  
     - parameter apiConfiguration: The configuration for the http request.
     - returns: Signature
     */
    @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
    open class func postWalletByIdSign(id: String, signIn: SignIn, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) async throws(ErrorResponse) -> Signature {
        return try await postWalletByIdSignWithRequestBuilder(id: id, signIn: signIn, apiConfiguration: apiConfiguration).execute().body
    }

    /**
     Produces a secp256k1 signature from one of the caller org's wallets over a 32-byte digest, through whichever custody backend that wallet uses.
     - POST /v1/wallet/{id}/sign
     - Produces a secp256k1 signature from one of the caller org's wallets over a 32-byte digest, through whichever custody backend that wallet uses. Give it either a `digest` (32 bytes as hex, signed verbatim) or a `message` (hashed with Keccak256 first) — exactly one is required. The private key never leaves its backend: KMS custody opens the sealed key in-process, MPC custody produces a threshold signature on the ring. The answer carries the digest that was signed alongside the signature, so a caller can verify what it got.
     - Bearer Token:
       - type: http
       - name: bearer
     - parameter id: (path)  
     - parameter signIn: (body)  
     - parameter apiConfiguration: The configuration for the http request.
     - returns: RequestBuilder<Signature> 
     */
    open class func postWalletByIdSignWithRequestBuilder(id: String, signIn: SignIn, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) -> RequestBuilder<Signature> {
        var localVariablePath = "/v1/wallet/{id}/sign"
        let idPreEscape = "\(APIHelper.mapValueToPathItem(id))"
        let idPostEscape = idPreEscape.addingPercentEncoding(withAllowedCharacters: .urlPathAllowed) ?? ""
        localVariablePath = localVariablePath.replacingOccurrences(of: "{id}", with: idPostEscape, options: .literal, range: nil)
        let localVariableURLString = apiConfiguration.basePath + localVariablePath
        let localVariableParameters = JSONEncodingHelper.encodingParameters(forEncodableObject: signIn, 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<Signature>.Type = apiConfiguration.requestBuilderFactory.getBuilder()

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

    /**
     Composes a Safe transaction on the MPC ring and answers its EIP-712 hash together with the owner approval the ring's threshold signature produced.
     
     - parameter id: (path)  
     - parameter safeTxIn: (body)  
     - parameter apiConfiguration: The configuration for the http request.
     - returns: SafeProposal
     */
    @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
    open class func postWalletByIdTransactions(id: String, safeTxIn: SafeTxIn, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) async throws(ErrorResponse) -> SafeProposal {
        return try await postWalletByIdTransactionsWithRequestBuilder(id: id, safeTxIn: safeTxIn, apiConfiguration: apiConfiguration).execute().body
    }

    /**
     Composes a Safe transaction on the MPC ring and answers its EIP-712 hash together with the owner approval the ring's threshold signature produced.
     - POST /v1/wallet/{id}/transactions
     - Composes a Safe transaction on the MPC ring and answers its EIP-712 hash together with the owner approval the ring's threshold signature produced. Only a wallet whose custody is \"safe\" can do this — any other custody is a 400, because the backend itself is asked whether it can propose rather than the kind being switched on. The ring computes the Safe-tx hash bound to the Safe contract and the chain id, so the hash a caller gets back is the one the Safe will verify. This PROPOSES: it does not execute the transaction.
     - Bearer Token:
       - type: http
       - name: bearer
     - parameter id: (path)  
     - parameter safeTxIn: (body)  
     - parameter apiConfiguration: The configuration for the http request.
     - returns: RequestBuilder<SafeProposal> 
     */
    open class func postWalletByIdTransactionsWithRequestBuilder(id: String, safeTxIn: SafeTxIn, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) -> RequestBuilder<SafeProposal> {
        var localVariablePath = "/v1/wallet/{id}/transactions"
        let idPreEscape = "\(APIHelper.mapValueToPathItem(id))"
        let idPostEscape = idPreEscape.addingPercentEncoding(withAllowedCharacters: .urlPathAllowed) ?? ""
        localVariablePath = localVariablePath.replacingOccurrences(of: "{id}", with: idPostEscape, options: .literal, range: nil)
        let localVariableURLString = apiConfiguration.basePath + localVariablePath
        let localVariableParameters = JSONEncodingHelper.encodingParameters(forEncodableObject: safeTxIn, 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<SafeProposal>.Type = apiConfiguration.requestBuilderFactory.getBuilder()

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