QuickbaseNet 1.0.1

QuickbaseNet 🚀

📋 Overview

QuickbaseNet is a versatile C# library designed to simplify and streamline interactions with the QuickBase API. Tailored for developers looking to efficiently perform CRUD operations and build complex queries, QuickbaseNet offers a set of intuitive tools including QuickBaseCommandBuilder, QueryBuilder, and QuickbaseClient. Whether you're managing database records or crafting detailed queries, QuickbaseNet enhances your experience with QuickBase tables through its fluent and user-friendly interfaces.

✨ Features

• Fluent Interface 🌊: Methods for building various requests easily and intuitively.
• Comprehensive CRUD Operations 🛠️: QuickBaseCommandBuilder for adding new records, updating existing ones, or deleting records efficiently.
• Advanced Query Support 🔍: QueryBuilder for constructing complex query requests with ease.
• Seamless Client Setup 🌐: QuickbaseClient for initializing connections with realm and user token for secure and straightforward API interaction.

💾 Installation

To get started with QuickbaseNet, you can install it via NuGet or clone the repository:

# Install via NuGet
Install-Package QuickbaseNet

# Or clone the repository
git clone https://github.com/ducksoop/quickbase-net.git

🛠️ Usage

QuickbaseNet simplifies working with the QuickBase API across various operations. Here's how you can use its main features:

Initializing QuickbaseClient 🌟

// Initialize QuickbaseClient with your realm hostname and user token
var quickbaseClient = new QuickbaseClient("your_realm_hostname", "your_user_token");

Handling API Responses 📬

Inserting Records

// Configure and build an insert request using QuickBaseCommandBuilder
var insertRequest = new QuickBaseCommandBuilder()
    .ForTable("your_table_id")
    .ReturnFields(1, 2, 3) // Specify which fields to return after the insert operation
    .AddNewRecord(record => record
        .AddField(6, "New record description") // Add data for field 6
        .AddField(7, 100) // Add data for field 7
        .AddField(9, "2024-02-13")) // Add data for field 9
    .BuildInsertUpdateCommand();

// Send the insert request and handle the response
var result = await quickbaseClient.InsertRecords(insertRequest);

if (result.IsSuccess)
{
    // Handle successful insert response
}
else
{
    // Process the error
}

Updating Records

// Configure and build an update request using QuickBaseCommandBuilder
var updateRequest = new QuickBaseCommandBuilder()
    .ForTable("your_table_id")
    .ReturnFields(1, 2, 3) // Specify which fields to return after the update operation
    .UpdateRecord(8, record => record // Specify the record to update based on its record ID (8 in this example)
        .AddField(7, 150) // Update field 7 with a new value
        .AddField(9, "2024-02-15")) // Update field 9 with a new value
    .BuildInsertUpdateCommand();

// Send the update request and handle the response
var result = await quickbaseClient.UpdateRecords(updateRequest);

if (result.IsSuccess)
{
    // Handle successful update response
}
else
{
    // Process the error
}

Deleting Records

// Build a delete request using QuickBaseCommandBuilder
var deleteRequest = new QuickBaseCommandBuilder()
    .ForTable("your_table_id")
    .WithDeletionCriteria("{6.EX.'hello'}")
    .BuildDeleteCommand();

// Send the delete request and handle the response
var result = await quickbaseClient.DeleteRecords(deleteRequest);

if (result.IsSuccess)
{
    // Handle successful delete response
}
else
{
    // Process the error
}

QueryBuilder - Crafting Queries with Precision 🔎

Building and Sending a Query 📤

// Create a query using QueryBuilder
var query = new QueryBuilder()
    .From("bck7gp3q2")
    .Select(1, 2, 3)
    .Where("{1.CT.'hello'}")
    .SortBy(4, "ASC")
    .SortBy(5, "ASC")
    .GroupBy(6, "equal-values")
    .Build();

// Send the query and handle the response
var result = await quickbaseClient.QueryRecords(query);

if (result.IsSuccess)
{
    // Process successful response
}
else
{
    // Handle error
}

👐 Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

📜 License

Distributed under the MIT License. See LICENSE for more information.

📚 Additional Resources

• QuickBase API Documentation