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

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

import Foundation

open class TemplateAPI {

    /**
     Deletes the caller org's OWN starter kit.
     
     - parameter slug: (path) Slug is the starter kit to act on, from the path. 
     - parameter apiConfiguration: The configuration for the http request.
     - returns: Void
     */
    @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
    open class func deleteTemplateBySlug(slug: String, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) async throws(ErrorResponse) {
        return try await deleteTemplateBySlugWithRequestBuilder(slug: slug, apiConfiguration: apiConfiguration).execute().body
    }

    /**
     Deletes the caller org's OWN starter kit.
     - DELETE /v1/template/{slug}
     - Deletes the caller org's OWN starter kit. A slug they do not own is a 404, never a delete: the DELETE binds org.
     - Bearer Token:
       - type: http
       - name: bearer
     - parameter slug: (path) Slug is the starter kit to act on, from the path. 
     - parameter apiConfiguration: The configuration for the http request.
     - returns: RequestBuilder<Void> 
     */
    open class func deleteTemplateBySlugWithRequestBuilder(slug: String, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) -> RequestBuilder<Void> {
        var localVariablePath = "/v1/template/{slug}"
        let slugPreEscape = "\(APIHelper.mapValueToPathItem(slug))"
        let slugPostEscape = slugPreEscape.addingPercentEncoding(withAllowedCharacters: .urlPathAllowed) ?? ""
        localVariablePath = localVariablePath.replacingOccurrences(of: "{slug}", with: slugPostEscape, 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<Void>.Type = apiConfiguration.requestBuilderFactory.getNonDecodableBuilder()

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

    /**
     Lists the public starter-kit catalog plus, for a validated caller, that org's own private kits.
     
     - parameter apiConfiguration: The configuration for the http request.
     - returns: KitList
     */
    @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
    open class func getTemplate(apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) async throws(ErrorResponse) -> KitList {
        return try await getTemplateWithRequestBuilder(apiConfiguration: apiConfiguration).execute().body
    }

    /**
     Lists the public starter-kit catalog plus, for a validated caller, that org's own private kits.
     - GET /v1/template
     - Lists the public starter-kit catalog plus, for a validated caller, that org's own private kits. No request field can widen the scope: the org comes from the validated principal, so an anonymous or cross-org caller structurally sees the public catalog only.
     - Bearer Token:
       - type: http
       - name: bearer
     - parameter apiConfiguration: The configuration for the http request.
     - returns: RequestBuilder<KitList> 
     */
    open class func getTemplateWithRequestBuilder(apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) -> RequestBuilder<KitList> {
        let localVariablePath = "/v1/template"
        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<KitList>.Type = apiConfiguration.requestBuilderFactory.getBuilder()

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

    /**
     Returns one starter kit: the caller org's own by that slug, else the public catalog's.
     
     - parameter slug: (path) Slug is the starter kit to act on, from the path. 
     - parameter apiConfiguration: The configuration for the http request.
     - returns: StarterKit
     */
    @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
    open class func getTemplateBySlug(slug: String, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) async throws(ErrorResponse) -> StarterKit {
        return try await getTemplateBySlugWithRequestBuilder(slug: slug, apiConfiguration: apiConfiguration).execute().body
    }

    /**
     Returns one starter kit: the caller org's own by that slug, else the public catalog's.
     - GET /v1/template/{slug}
     - Returns one starter kit: the caller org's own by that slug, else the public catalog's. A slug another org owns reads as not found.
     - Bearer Token:
       - type: http
       - name: bearer
     - parameter slug: (path) Slug is the starter kit to act on, from the path. 
     - parameter apiConfiguration: The configuration for the http request.
     - returns: RequestBuilder<StarterKit> 
     */
    open class func getTemplateBySlugWithRequestBuilder(slug: String, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) -> RequestBuilder<StarterKit> {
        var localVariablePath = "/v1/template/{slug}"
        let slugPreEscape = "\(APIHelper.mapValueToPathItem(slug))"
        let slugPostEscape = slugPreEscape.addingPercentEncoding(withAllowedCharacters: .urlPathAllowed) ?? ""
        localVariablePath = localVariablePath.replacingOccurrences(of: "{slug}", with: slugPostEscape, 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<StarterKit>.Type = apiConfiguration.requestBuilderFactory.getBuilder()

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

    /**
     Creates a starter kit PRIVATE to the caller's org and answers 201 with the stored kit.
     
     - parameter publishKitIn: (body)  
     - parameter apiConfiguration: The configuration for the http request.
     - returns: StarterKit
     */
    @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
    open class func postTemplate(publishKitIn: PublishKitIn, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) async throws(ErrorResponse) -> StarterKit {
        return try await postTemplateWithRequestBuilder(publishKitIn: publishKitIn, apiConfiguration: apiConfiguration).execute().body
    }

    /**
     Creates a starter kit PRIVATE to the caller's org and answers 201 with the stored kit.
     - POST /v1/template
     - Creates a starter kit PRIVATE to the caller's org and answers 201 with the stored kit. The owner is stamped by the server, so a body \"org\" is never trusted; publishing over a public-catalog slug is 409, so a slug still names exactly one kit.
     - Bearer Token:
       - type: http
       - name: bearer
     - parameter publishKitIn: (body)  
     - parameter apiConfiguration: The configuration for the http request.
     - returns: RequestBuilder<StarterKit> 
     */
    open class func postTemplateWithRequestBuilder(publishKitIn: PublishKitIn, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) -> RequestBuilder<StarterKit> {
        let localVariablePath = "/v1/template"
        let localVariableURLString = apiConfiguration.basePath + localVariablePath
        let localVariableParameters = JSONEncodingHelper.encodingParameters(forEncodableObject: publishKitIn, 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<StarterKit>.Type = apiConfiguration.requestBuilderFactory.getBuilder()

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

    /**
     Overwrites the caller org's OWN starter kit at the path slug, answering the stored kit.
     
     - parameter slug: (path) Slug is the kit to replace, from the path. 
     - parameter replaceKitIn: (body)  
     - parameter apiConfiguration: The configuration for the http request.
     - returns: StarterKit
     */
    @available(macOS 10.15, iOS 13.0, tvOS 13.0, watchOS 6.0, *)
    open class func putTemplateBySlug(slug: String, replaceKitIn: ReplaceKitIn, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) async throws(ErrorResponse) -> StarterKit {
        return try await putTemplateBySlugWithRequestBuilder(slug: slug, replaceKitIn: replaceKitIn, apiConfiguration: apiConfiguration).execute().body
    }

    /**
     Overwrites the caller org's OWN starter kit at the path slug, answering the stored kit.
     - PUT /v1/template/{slug}
     - Overwrites the caller org's OWN starter kit at the path slug, answering the stored kit. A slug they do not own is 404, never a create: the UPDATE binds org, so a PUT can never reach another org's kit.
     - Bearer Token:
       - type: http
       - name: bearer
     - parameter slug: (path) Slug is the kit to replace, from the path. 
     - parameter replaceKitIn: (body)  
     - parameter apiConfiguration: The configuration for the http request.
     - returns: RequestBuilder<StarterKit> 
     */
    open class func putTemplateBySlugWithRequestBuilder(slug: String, replaceKitIn: ReplaceKitIn, apiConfiguration: HanzoAPIConfiguration = HanzoAPIConfiguration.shared) -> RequestBuilder<StarterKit> {
        var localVariablePath = "/v1/template/{slug}"
        let slugPreEscape = "\(APIHelper.mapValueToPathItem(slug))"
        let slugPostEscape = slugPreEscape.addingPercentEncoding(withAllowedCharacters: .urlPathAllowed) ?? ""
        localVariablePath = localVariablePath.replacingOccurrences(of: "{slug}", with: slugPostEscape, options: .literal, range: nil)
        let localVariableURLString = apiConfiguration.basePath + localVariablePath
        let localVariableParameters = JSONEncodingHelper.encodingParameters(forEncodableObject: replaceKitIn, 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<StarterKit>.Type = apiConfiguration.requestBuilderFactory.getBuilder()

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