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

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

import Foundation

open class SeoAPI {

    /**
     Fetch one page and report what it gets wrong
     
     - parameter seoAuditIn: (body)  
     - parameter apiConfiguration: The configuration for the http request.
     - returns: SeoAuditOut
     */
    @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
    open class func seoAudit(seoAuditIn: SeoAuditIn, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) async throws(ErrorResponse) -> SeoAuditOut {
        return try await seoAuditWithRequestBuilder(seoAuditIn: seoAuditIn, apiConfiguration: apiConfiguration).execute().body
    }

    /**
     Fetch one page and report what it gets wrong
     - POST /v1/seo/audit
     - Fetches one page and reports what it gets wrong.  It returns the page's on-page score, its title and description, how much readable text it carries, and the full set of named checks — is it https, does it have one h1, is the title duplicated, is it slow, is it a redirect, is anything on it broken. It is the technical half of search visibility, and it is the half a developer can act on this afternoon.  ONE PAGE, LIVE, IN THIS REQUEST. It is deliberately not a site crawl: a crawl is a job with a lifecycle, and this answers the same questions about the page somebody is actually looking at, now, with no task id to poll. Point it at the pages that matter one at a time.  It is priced per page fetched, which is one.
     - Bearer Token:
       - type: http
       - name: bearer
     - parameter seoAuditIn: (body)  
     - parameter apiConfiguration: The configuration for the http request.
     - returns: RequestBuilder<SeoAuditOut> 
     */
    open class func seoAuditWithRequestBuilder(seoAuditIn: SeoAuditIn, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) -> RequestBuilder<SeoAuditOut> {
        let localVariablePath = "/v1/seo/audit"
        let localVariableURLString = apiConfiguration.basePath + localVariablePath
        let localVariableParameters = JSONEncodingHelper.encodingParameters(forEncodableObject: seoAuditIn, 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<SeoAuditOut>.Type = apiConfiguration.requestBuilderFactory.getBuilder()

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

    /**
     Who links to a target, and how much of it is broken or spam
     
     - parameter seoBacklinkIn: (body)  
     - parameter apiConfiguration: The configuration for the http request.
     - returns: SeoBacklinkOut
     */
    @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
    open class func seoBacklink(seoBacklinkIn: SeoBacklinkIn, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) async throws(ErrorResponse) -> SeoBacklinkOut {
        return try await seoBacklinkWithRequestBuilder(seoBacklinkIn: seoBacklinkIn, apiConfiguration: apiConfiguration).execute().body
    }

    /**
     Who links to a target, and how much of it is broken or spam
     - POST /v1/seo/backlinks
     - Summarises who links to a target.  It returns the authority score, how many links point at it and from how many distinct sites, how many of those are broken, and how much of the profile reads as spam. Distinct sites is the number to read: a thousand links from one domain is one endorsement, and a profile that grew fast in links and not in domains is usually a profile somebody bought.  The target can be a whole domain, a subdomain, or one page URL — the summary is scoped to whatever is named. It is priced per request, so a domain with ten million links costs the same as one with ten.
     - Bearer Token:
       - type: http
       - name: bearer
     - parameter seoBacklinkIn: (body)  
     - parameter apiConfiguration: The configuration for the http request.
     - returns: RequestBuilder<SeoBacklinkOut> 
     */
    open class func seoBacklinkWithRequestBuilder(seoBacklinkIn: SeoBacklinkIn, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) -> RequestBuilder<SeoBacklinkOut> {
        let localVariablePath = "/v1/seo/backlinks"
        let localVariableURLString = apiConfiguration.basePath + localVariablePath
        let localVariableParameters = JSONEncodingHelper.encodingParameters(forEncodableObject: seoBacklinkIn, 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<SeoBacklinkOut>.Type = apiConfiguration.requestBuilderFactory.getBuilder()

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

    /**
     The domains that place for the same phrases
     
     - parameter seoCompetitorIn: (body)  
     - parameter apiConfiguration: The configuration for the http request.
     - returns: SeoCompetitorOut
     */
    @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
    open class func seoCompetitor(seoCompetitorIn: SeoCompetitorIn, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) async throws(ErrorResponse) -> SeoCompetitorOut {
        return try await seoCompetitorWithRequestBuilder(seoCompetitorIn: seoCompetitorIn, apiConfiguration: apiConfiguration).execute().body
    }

    /**
     The domains that place for the same phrases
     - POST /v1/seo/competitors
     - Names the domains that place for the same phrases.  Given a set of phrases it returns the sites that appear across them, with each one's average position, how many of the phrases it places for, its share of the available attention and the visits that earns. It answers \"who am I actually up against here\", which is a different question from \"who do I think my competitors are\" and frequently a different answer.  Pair it with seoRank: this says who is in the race, seoRank says where any one of them finishes. It is priced per row, so Limit decides the cost.
     - Bearer Token:
       - type: http
       - name: bearer
     - parameter seoCompetitorIn: (body)  
     - parameter apiConfiguration: The configuration for the http request.
     - returns: RequestBuilder<SeoCompetitorOut> 
     */
    open class func seoCompetitorWithRequestBuilder(seoCompetitorIn: SeoCompetitorIn, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) -> RequestBuilder<SeoCompetitorOut> {
        let localVariablePath = "/v1/seo/competitors"
        let localVariableURLString = apiConfiguration.basePath + localVariablePath
        let localVariableParameters = JSONEncodingHelper.encodingParameters(forEncodableObject: seoCompetitorIn, 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<SeoCompetitorOut>.Type = apiConfiguration.requestBuilderFactory.getBuilder()

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

    /**
     Grow a seed phrase into the phrases nobody named yet
     
     - parameter seoIdeaIn: (body)  
     - parameter apiConfiguration: The configuration for the http request.
     - returns: SeoIdeaOut
     */
    @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
    open class func seoIdea(seoIdeaIn: SeoIdeaIn, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) async throws(ErrorResponse) -> SeoIdeaOut {
        return try await seoIdeaWithRequestBuilder(seoIdeaIn: seoIdeaIn, apiConfiguration: apiConfiguration).execute().body
    }

    /**
     Grow a seed phrase into the phrases nobody named yet
     - POST /v1/seo/ideas
     - Grows a seed phrase into the phrases nobody named yet.  It takes phrases you have and returns phrases in the same category that you do not — relevant rather than merely containing the seed — each with its search volume, click cost, competition and how hard its first page is to reach. This is where a keyword list comes FROM; seoKeyword is where a list you already have gets measured.  It is priced per row, so Limit is the knob that decides what the call costs. Total says how many more there were.
     - Bearer Token:
       - type: http
       - name: bearer
     - parameter seoIdeaIn: (body)  
     - parameter apiConfiguration: The configuration for the http request.
     - returns: RequestBuilder<SeoIdeaOut> 
     */
    open class func seoIdeaWithRequestBuilder(seoIdeaIn: SeoIdeaIn, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) -> RequestBuilder<SeoIdeaOut> {
        let localVariablePath = "/v1/seo/ideas"
        let localVariableURLString = apiConfiguration.basePath + localVariablePath
        let localVariableParameters = JSONEncodingHelper.encodingParameters(forEncodableObject: seoIdeaIn, 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<SeoIdeaOut>.Type = apiConfiguration.requestBuilderFactory.getBuilder()

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

    /**
     How often named phrases are searched, and what a click costs
     
     - parameter seoKeywordIn: (body)  
     - parameter apiConfiguration: The configuration for the http request.
     - returns: SeoKeywordOut
     */
    @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
    open class func seoKeyword(seoKeywordIn: SeoKeywordIn, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) async throws(ErrorResponse) -> SeoKeywordOut {
        return try await seoKeywordWithRequestBuilder(seoKeywordIn: seoKeywordIn, apiConfiguration: apiConfiguration).execute().body
    }

    /**
     How often named phrases are searched, and what a click costs
     - POST /v1/seo/keywords
     - Measures phrases the caller already has.  It answers, for each phrase named, how many people search it in a month, what an advertising click on it costs, and how contested that advertising is. This is the ground fact of search: everything else on this surface is a question about phrases, and this is the one that says whether a phrase is worth having.  Give it phrases you already suspect. To find phrases you have not thought of, use seoIdea; to find the ones a site already places for, use seoRank.  The market defaults to the United States in English. It is priced per request rather than per phrase, so asking about fifty phrases costs what asking about one does.
     - Bearer Token:
       - type: http
       - name: bearer
     - parameter seoKeywordIn: (body)  
     - parameter apiConfiguration: The configuration for the http request.
     - returns: RequestBuilder<SeoKeywordOut> 
     */
    open class func seoKeywordWithRequestBuilder(seoKeywordIn: SeoKeywordIn, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) -> RequestBuilder<SeoKeywordOut> {
        let localVariablePath = "/v1/seo/keywords"
        let localVariableURLString = apiConfiguration.basePath + localVariablePath
        let localVariableParameters = JSONEncodingHelper.encodingParameters(forEncodableObject: seoKeywordIn, 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<SeoKeywordOut>.Type = apiConfiguration.requestBuilderFactory.getBuilder()

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

    /**
     Every phrase a domain already places for, with its position
     
     - parameter seoRankIn: (body)  
     - parameter apiConfiguration: The configuration for the http request.
     - returns: SeoRankOut
     */
    @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
    open class func seoRank(seoRankIn: SeoRankIn, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) async throws(ErrorResponse) -> SeoRankOut {
        return try await seoRankWithRequestBuilder(seoRankIn: seoRankIn, apiConfiguration: apiConfiguration).execute().body
    }

    /**
     Every phrase a domain already places for, with its position
     - POST /v1/seo/rankings
     - Reports every phrase a domain already places for.  For each one it gives the phrase, the position on the results page, the page of the site that placed, that result's headline, the phrase's monthly searches and the visits the placement is estimated to earn. It is the single most direct question about a site's search visibility — yours or a competitor's, since it takes any domain.  Position is the ABSOLUTE rank, counting every element on the page — the ads, the answer boxes, the map — because that is what a person scrolling actually passes. An organic-only rank flatters a result that sits below half a screen of other things.  It is priced per row, so Limit decides what the call costs, and Total says how many more there were.
     - Bearer Token:
       - type: http
       - name: bearer
     - parameter seoRankIn: (body)  
     - parameter apiConfiguration: The configuration for the http request.
     - returns: RequestBuilder<SeoRankOut> 
     */
    open class func seoRankWithRequestBuilder(seoRankIn: SeoRankIn, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) -> RequestBuilder<SeoRankOut> {
        let localVariablePath = "/v1/seo/rankings"
        let localVariableURLString = apiConfiguration.basePath + localVariablePath
        let localVariableParameters = JSONEncodingHelper.encodingParameters(forEncodableObject: seoRankIn, 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<SeoRankOut>.Type = apiConfiguration.requestBuilderFactory.getBuilder()

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

    /**
     What each call on this surface costs, from the vendor's own list
     
     - parameter apiConfiguration: The configuration for the http request.
     - returns: SeoRateOut
     */
    @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
    open class func seoRate(apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) async throws(ErrorResponse) -> SeoRateOut {
        return try await seoRateWithRequestBuilder(apiConfiguration: apiConfiguration).execute().body
    }

    /**
     What each call on this surface costs, from the vendor's own list
     - GET /v1/seo/rates
     - Publishes what every call on this surface costs.  The numbers are read from the upstream's own published price list, not from a table kept here, so a price change on their side moves this card within the hour and moves what is debited with it. That is the whole of the pricing model: this surface resells at cost, and the cost is theirs to state.  A row has two numbers because a call has two costs: a flat charge for asking, and a charge per row returned. An op priced per request reports zero for the second, and for one priced per row the total is `request + result x limit` — which is the amount your balance is authorized against before the call, and roughly what you will be debited after it.  It is a read and it is free: asking what something costs must not require the balance that would pay for it. If the upstream cannot be reached the card comes back empty rather than stale — a price nobody can confirm is not a price.
     - Bearer Token:
       - type: http
       - name: bearer
     - parameter apiConfiguration: The configuration for the http request.
     - returns: RequestBuilder<SeoRateOut> 
     */
    open class func seoRateWithRequestBuilder(apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) -> RequestBuilder<SeoRateOut> {
        let localVariablePath = "/v1/seo/rates"
        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<SeoRateOut>.Type = apiConfiguration.requestBuilderFactory.getBuilder()

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