Swift SDK

dependencies: [
    .package(
        url: "https://github.com/ButterCMS/buttercms-swift.git",
        from: "1.0.0"
    )
]

import ButterCMSSDK

let client = ButterCMSClient(apiKey: "your_api_token")

// Define a Codable type matching your page type's fields
struct LandingPage: Codable {
    let headline: String
}

// Retrieve a single page
client.getPage(
    slug: "home-page",
    parameters: [.locale(value: "en")],
    pageTypeSlug: "landing_page",
    type: LandingPage.self
) { result in
    switch result {
    case .success(let page):
        print(page)
    case .failure(let error):
        print("Error: \(error)")
    }
}

// List all pages of a type
client.getPages(
    parameters: [.page(value: 1), .pageSize(value: 10)],
    pageTypeSlug: "landing_page",
    type: LandingPage.self
) { result in
    switch result {
    case .success(let pages):
        print(pages)
    case .failure(let error):
        print("Error: \(error)")
    }
}

// Collection items must conform to CollectionItem (adds the `meta` field)
struct FaqItem: CollectionItem {
    var meta: CollectionItemMeta
    let question: String
    let answer: String
}

// Retrieve collection content (one collection slug per call)
client.getCollection(
    slug: "faq",
    type: FaqItem.self
) { result in
    switch result {
    case .success(let content):
        print(content)
    case .failure(let error):
        print("Error: \(error)")
    }
}

// List blog posts
client.getPosts(
    parameters: [.page(value: 1), .pageSize(value: 10)]
) { result in
    switch result {
    case .success(let posts):
        print(posts)
    case .failure(let error):
        print("Error: \(error)")
    }
}

// Retrieve a single post
client.getPost(slug: "my-post-slug") { result in
    switch result {
    case .success(let post):
        print(post)
    case .failure(let error):
        print("Error: \(error)")
    }
}

// List authors
client.getAuthors(
    parameters: [.include(value: "recent_posts")]
) { result in /* handle result */ }

// List categories
client.getCategories(
    parameters: [.include(value: "recent_posts")]
) { result in /* handle result */ }

// List tags
client.getTags(
    parameters: [.include(value: "recent_posts")]
) { result in /* handle result */ }