Helioadditive

https://docs.helioadditive.com/en
Admin
Helioadditive provides solutions and tools to make additive manufacturing scalable.
Tokens:31,905
Snippets:151
Trust Score:5.8
Update:1 year ago
Show doc for...
Tokens:
Raw
### Setup Project with Bun

Source: https://docs.helioadditive.com/en/developers/typescript

Initializes a new project directory, navigates into it, and installs the GraphQL Code Generator CLI and necessary presets using the Bun package manager. This sets up the foundational tools for code generation.

```bash
#!/bin/bash

mkdirexample && cdexample

bun init

bun add @graphql-codegen/cli @graphql-codegen/near-operation-file-preset --dev
```

--------------------------------

### Project Setup and vcpkg Installation

Source: https://docs.helioadditive.com/en/developers/cpp

Initializes a new project directory and sets up the vcpkg dependency manager. This involves cloning the vcpkg repository, bootstrapping it, and installing project dependencies defined in vcpkg.json.

```bash
#!/bin/bash

mkdirexample && cdexample
```

```bash
git submodule add https://github.com/microsoft/vcpkg

./vcpkg/bootstrap-vcpkg.sh

./vcpkg/vcpkg install
```

--------------------------------

### Initialize Project and Install Dependencies

Source: https://docs.helioadditive.com/en/developers/python

This bash script initializes a new Python project directory and installs the `ariadne-codegen` tool, which is essential for generating Python client code from a GraphQL schema. It uses `uv` for package management.

```bash
#!/bin/bash

mkdirexample && cdexample

uv init

uv add ariadne-codegen # GraphQL codegen tool

```

--------------------------------

### Generate Client Code

Source: https://docs.helioadditive.com/en/developers/python

This command executes the `ariadne-codegen` tool using the configuration specified in `pyproject.toml`. It reads the GraphQL schema from the remote URL and generates Python client code, including type definitions and request functions, into the `./client` directory.

```bash
uv run ariadne-codegen --config pyproject.toml

```

--------------------------------

### Configure GraphQL Codegen

Source: https://docs.helioadditive.com/en/developers/python

This TOML configuration file (`pyproject.toml`) sets up `ariadne-codegen` by specifying the target package path, query directory, remote schema URL, package name, and various generation options like async client support, snake_case conversion, and inclusion of inputs/enums.

```toml
[project]

name = "example"
version = "0.1.0"
description = "Add your description here"
readme = "README.md"
requires-python = ">=3.13"
dependencies = [
  "ariadne-codegen>=0.14.0",
]

[tool.ariadne-codegen]
target_package_path = "./client"
queries_path = "./queries"
remote_schema_url = "https://api.helioadditive.com/graphql"
target_package_name = "graphql_client"
async_client = true
include_comments = "stable"
convert_to_snake_case = true
include_all_inputs = true
include_all_emums = true

```

--------------------------------

### Use Generated Client in Python

Source: https://docs.helioadditive.com/en/developers/python

This Python script demonstrates how to use the auto-generated GraphQL client. It initializes the client with the API URL and authentication headers, defines an asynchronous function to fetch materials using the generated `materials` method, and prints basic information about each material.

```python
import asyncio

import httpx

from client.client import Client

headers = {"Authorization": "Bearer <helio_pat>"}

graphql_client = Client(
    url="https://api.helioadditive.com/graphql",
    headers=headers,
    http_client=httpx.AsyncClient(headers=headers, timeout=60)
)

async def main():
    materials = await graphql_client.materials(page_size=20)

    for material in materials.objects:
        # The `material` object is fully type inferred
        material_id = material.id
        material_name = material.name
        print(f"Material ID: {material_id}, Name: {material_name}")

if __name__ == "__main__":
    asyncio.run(main())

```

--------------------------------

### Add Codegen Script to package.json

Source: https://docs.helioadditive.com/en/developers/typescript

Adds a script to the project's `package.json` file to execute the GraphQL Code Generator. This allows running the code generation process easily via the command line, transforming GraphQL definitions into usable TypeScript code.

```json
{
  "name": "example",
  "version": "0.1.0",
  "scripts": {
    "codegen": "graphql-codegen --config codegen.ts"
  }
}
```

--------------------------------

### GraphQL Request Structure Example

Source: https://docs.helioadditive.com/en/developers/api

Demonstrates the basic structure of a GraphQL request to the Helioadditive API. It includes the 'query' field for specifying data retrieval and the 'variables' field for passing arguments.

```json
{
  "query": "query Materials($pageSize: Int) { materials(pageSize: $pageSize) { id name } }",
  "variables": {"pageSize": 20}
}
```

--------------------------------

### Define GraphQL Query for Materials

Source: https://docs.helioadditive.com/en/developers/python

This GraphQL file defines a query to fetch material data from the API. It specifies parameters for pagination (`page`, `pageSize`) and filtering (`filters`), and requests specific fields like `id`, `name`, and nested `brand` information, along with pagination details.

```graphql
query ListMaterials($page: Int, $pageSize: Int, $filters: [MaterialFilter!]) {
  materials(page: $page, pageSize: $pageSize, filters: $filters) {
    pages
    pageInfo {
      hasPreviousPage
      hasNextPage
    }
    objects {
      ... on Material {
        id
        name
        brand {
          id
          name
        }
      }
    }
  }
}

```

--------------------------------

### Configure GraphQL Codegen

Source: https://docs.helioadditive.com/en/developers/typescript

Defines the configuration for GraphQL Code Generator, specifying the schema endpoint, document locations, and output plugins. It generates TypeScript types for the schema and operations, enabling type-safe GraphQL requests.

```typescript
import type { CodegenConfig } from "@graphql-codegen/cli";

const config: CodegenConfig = {
  overwrite: true,
  schema: "https://api.helioadditive.com/graphql",
  documents: "./**/*.graphql",
  generates: {
    "types.generated.ts": {
      plugins: ["typescript"],
      config: {
        useInterface: true,
        useTypeImports: false,
        declarationKind: {
          input: "interface",
        },
      },
    },
    ".": {
      preset: "near-operation-file",
      presetConfig: {
        extension: ".generated.ts",
        baseTypesPath: "types.generated.ts",
      },
      plugins: ["typescript-operations", "typed-document-node"],
      config: {
        useTypeImports: false,
        declarationKind: {
          input: "interface",
        },
      },
    },
  },
};

export default config;
```

--------------------------------

### Define GraphQL Query for Materials

Source: https://docs.helioadditive.com/en/developers/typescript

A GraphQL document defining a query to fetch material data. It specifies pagination parameters and filters, requesting material IDs, names, and associated brand information. This file is used by the codegen tool to generate typed query operations.

```graphql
query ListMaterials($page: Int, $pageSize: Int, $filters: [MaterialFilter!]) {
  materials(page: $page, pageSize: $pageSize, filters: $filters) {
    pages
    pageInfo {
      hasPreviousPage
      hasNextPage
    }
    objects {
      ... on Material {
        id
        name
        brand {
          id
          name
        }
      }
    }
  }
}
```

--------------------------------

### Utilize Generated Types with Apollo Client

Source: https://docs.helioadditive.com/en/developers/typescript

Demonstrates how to use the generated TypeScript types and operations with Apollo Client to fetch data from the GraphQL API. It configures the Apollo Client, executes the `ListMaterials` query, and iterates over the results, logging material details.

```typescript
import { ApolloClient, InMemoryCache, HttpLink } from "@apollo/client";
import { MaterialsDocument } from "./queries/Materials.generated";

const apolloClient = new ApolloClient({
  uri: "https://api.helioadditive.com/graphql",
  cache: new InMemoryCache(),
  link: new HttpLink({
    uri: "https://api.helioadditive.com/graphql",
    headers: {
      "Content-Type": "application/json",
      Authorization: "Bearer <pat-token>"
    },
    credentials: "include",
    fetchOptions: { cache: "no-store" },
  }),
});

const query = await apolloClient.query({
  query: MaterialsDocument,
  variables: {
    pageSize: 20,
    page: 1
  },
  fetchPolicy: "no-cache",
});

for (const material of query.data.materials.objects) {
  console.log(`Material ID: ${material.id}, Name: ${material.name}`);
}
```

--------------------------------

### ExampleApp CMake Configuration

Source: https://docs.helioadditive.com/en/developers/cpp

Demonstrates the CMake configuration for an ExampleApp, specifying include directories for generated headers and external dependencies like VCPKG. It highlights build-time and install-time include paths.

```cmake
target_include_directories(ExampleApp

PUBLIC

$<$<BUILD_INTERFACE:${CMAKE_CURRENT_SOURCE_DIR}/generated>

$<$<INSTALL_INTERFACE:generated/include>

PRIVATE

${VCPKG_DIR}/include

)
```

--------------------------------

### LayerRange API

Source: https://docs.helioadditive.com/en/developers/api

Defines a range of layers, specifying the starting and ending layer numbers.

```APIDOC
LayerRange:
  fromLayer (Int!): The starting layer number for the specified range (inclusive).
  toLayer (Int!): The ending layer number for the specified range (inclusive).
```

--------------------------------

### LayerRangeInput API

Source: https://docs.helioadditive.com/en/developers/api

Defines a range for layers, specifying a starting and ending layer number, both inclusive.

```APIDOC
LayerRangeInput:
  fromLayer: Int! - The starting layer number for the specified range (inclusive).
  toLayer: Int! - The ending layer number for the specified range (inclusive).
```

--------------------------------

### C++ Application Entrypoint

Source: https://docs.helioadditive.com/en/developers/cpp

The main application file that utilizes the autogenerated GraphQL client code to query materials from the Helioadditive API. It demonstrates how to serialize variables, send the request, parse the response, and display results.

```cpp
#include <iostream>
#include <string>
#include "MaterialsClient.h"
#include "graphqlservice/GraphQLResponse.h"
#include "graphqlservice/JSONResponse.h"

namespace Materials = graphql::client::query::Materials;

// Assume sendHttpRequest is defined elsewhere or provided
// graphql::response::Value sendHttpRequest(const std::string &query, graphql::response::Value &variables);

int main() {
    const std::string query = Materials::GetRequestText();
    graphql::response::Value variables = Materials::serializeVariables(Materials::Variables{.pageSize = 20, .page = 1});

    // Placeholder for actual HTTP request sending
    // auto parsed_response = Materials::parseResponse(sendHttpRequest(query, variables));
    
    // Example of using parsed data structure (assuming sendHttpRequest returns a valid response)
    /*
    for (const auto& material : parsed_response.materials.objects) {
        std::cout << "Material ID: " << material.id.c_str() << ", Name: " << material.name << '\n';
    }
    */
    std::cout << "Example execution finished. Uncomment HTTP call to see results.\n";
    return 0;
}
```

--------------------------------

### Event API Object

Source: https://docs.helioadditive.com/en/developers/api

An entry representing an event, including its unique identifier, name, location, start and end dates, an optional link, a flag indicating if it's upcoming, and creation/update timestamps.

```APIDOC
Event:
  id: ID!
  name: String!
  location: String!
  startDate: DateTime!
  endDate: DateTime!
  link: String
  isUpcoming: Boolean!
  insertedAt: DateTime!
  updatedAt: DateTime!
```

--------------------------------

### vcpkg Dependencies Configuration

Source: https://docs.helioadditive.com/en/developers/cpp

Defines the project's dependencies for vcpkg, including specific versions and features for libraries like pegtl, cppgraphqlgen, boost-json, and cpr. This file ensures consistent builds across different environments.

```json
{
  "name": "example",
  "version-string": "0.0.1",
  "builtin-baseline": "095a29ce59608465032c3747307dd0009b3e089c",
  "dependencies": [
    {
      "name": "pegtl",
      "version>=": "3.2.8"
    },
    {
      "name": "cppgraphqlgen",
      "version>=": "4.5.7",
      "features": ["clientgen", "rapidjson"]
    },
    {
      "name": "boost-json",
      "version>=": "1.88.0"
    },
    {
      "name": "cpr",
      "version>=": "1.11.2"
    }
  ]
}
```

--------------------------------

### Generate 3D Plot Lines

Source: https://docs.helioadditive.com/en/assets/exported-files

Iterates through grouped data, calculates colors based on quality, and creates `go.Scatter3d` objects representing lines between consecutive points in 3D space. Each line segment is colored according to the quality value of its starting point.

```python
lines: List[go.Scatter3d]  =[]

for group_id, group_data in grouped_df:
    shifted_group_data = group_data.shift(-1)

    for previous_row, row inzip(group_data.iter_rows(named=True), shifted_group_data.iter_rows(named=True)):
        color =get_gradient_rgb(previous_row["quality"])

        line = go.Scatter3d(
            x=[previous_row["x"], row["x"]],
            y=[previous_row["y"], row["y"]],
            z=[previous_row["z"], row["z"]],
            mode="lines",
            line=dict(color=f"rgb({color.r},{color.g},{color.b})",width=5),

        )
        lines.append(line)

```

--------------------------------

### Platform Summary Query API

Source: https://docs.helioadditive.com/en/developers/api

Retrieve a summary of the platform. This query provides a high-level overview of the Helioadditive platform's status or key information.

```APIDOC
summary: Summary!

Returns: Summary!
```

--------------------------------

### CreateOptimizationInput Input API Documentation

Source: https://docs.helioadditive.com/en/developers/api

Defines the input structure for creating a new optimization run. It requires a G-code ID and allows configuration of simulation and optimization settings.

```APIDOC
CreateOptimizationInput:
  name: String!
    - User-defined name for the optimization run.
  gcodeId: ID!
    - Unique identifier of the G-code to optimize.
  simulationSettings: SimulationSettingsInput
    - Settings related to the simulation environment and initial conditions.
  optimizationSettings: OptimizationSettingsInput
    - Parameters and strategy configurations for running the optimization.
```

--------------------------------

### Initialize and Add Polars/Plotly Environment

Source: https://docs.helioadditive.com/en/assets/exported-files

Shell script to initialize the environment and add necessary Polars and Plotly libraries. This sets up the execution context for the subsequent Python scripts.

```bash
#!/bin/bash

uvinit

uvaddpolarsplotly

```

--------------------------------

### Helioadditive API GraphQL Queries

Source: https://docs.helioadditive.com/en/developers/api

Documentation for various query operations available in the Helioadditive GraphQL API. This includes details on arguments, return types, and the purpose of each query.

```APIDOC
Query Operations:

Retrieve a list of FAQ's.
  faqs(page: Int, pageSize: Int)
    - Returns: PaginatedResponse!
    - Arguments:
      - page (Int): The page number to retrieve.
      - pageSize (Int): The page size to retrieve.

Retrieve a list of Events.
  events(page: Int, pageSize: Int)
    - Returns: PaginatedResponse!
    - Arguments:
      - page (Int): Page number (1-based index).
      - pageSize (Int): Page size.

Retrieve a list of G-Codes.
  gcodes(page: Int, pageSize: Int, sortBy: GcodeField, sortDirection: SortDirection, filters: [GcodeFilter!])
    - Returns: PaginatedResponse!
    - Arguments:
      - page (Int): The page number to retrieve.
      - pageSize (Int): The number of items per page.
      - sortBy (GcodeField): Field to sort the results by.
      - sortDirection (SortDirection): Direction to sort the results (ascending or descending).
      - filters ([GcodeFilter!]): List of filters to apply to the Gcode results.

Retrieve details of a single G-Code by its ID.
  gcode(id: ID!)
    - Returns: Gcode!
    - Arguments:
      - id (ID!): ID of the Gcode to retrieve.

Fetch thermal history asset data.
  thermalHistories(optimizationId: ID!, layer: Int!, isOptimized: Boolean!)
    - Returns: SimulationAsset
    - Arguments:
      - optimizationId (ID!): The ID of the optimization.
      - layer (Int!): The layer number.
      - isOptimized (Boolean!): Flag indicating if the data is optimized.
```

--------------------------------

### CreateGcodeInput Input API Documentation

Source: https://docs.helioadditive.com/en/developers/api

Specifies the input parameters required to create a new G-code entry. Includes essential details like name, material, printer, G-code content, and printing parameters.

```APIDOC
CreateGcodeInput:
  name: String!
    - The name of the gcode.
  materialId: ID!
    - The ID of the material.
  printerId: ID!
    - The ID of the printer.
  gcodeKey: String!
    - The key of the gcode.
  nozzleTemperature: Float
    - The nozzle temperature.
  isSingleShell: Boolean!
    - Whether the gcode is single shell.
  layerHeight: Float
    - The layer height.
  lineWidth: Float
    - The line width.
  platformTemperature: Float
    - The platform temperature.
```

--------------------------------

### HelioSubscription API

Source: https://docs.helioadditive.com/en/developers/api

Details of user subscriptions, including plan name, optimization limits, duration, and timestamps.

```APIDOC
HelioSubscription:
  id (ID!): Unique identifier for the user.
  name (String!): Name of the subscription plan.
  description (String): Description of the subscription plan.
  optsPerMonth (Int!): Number of optimization runs allowed per month under this subscription.
  membershipDuration (Int!): Duration of the subscription in months.
  insertedAt (DateTime!): Timestamp when the subscription was created.
  updatedAt (DateTime!): Timestamp when the subscription was last updated.
```

--------------------------------

### CMake Build Configuration

Source: https://docs.helioadditive.com/en/developers/cpp

Configures the build process using CMake, specifying C++ standard, compiler flags, and linking necessary libraries like Boost.JSON, cpr, and cppgraphqlgen. It also includes generated source files for the executable.

```cmake
cmake_minimum_required(VERSION 3.14)
project(ExampleApp)

set(CMAKE_CXX_STANDARD 20)
set(CMAKE_CXX_FLAGS "-std=c++20 -O3 ")

# Assuming VCPKG_DIR is set in the environment or passed as a cache variable
# For example: set(CMAKE_TOOLCHAIN_FILE "${CMAKE_CURRENT_SOURCE_DIR}/vcpkg/scripts/buildsystems/vcpkg.cmake")

# Include directories for vcpkg packages
include_directories(${VCPKG_INSTALLED_DIR}/include)
link_directories(${VCPKG_INSTALLED_DIR}/lib)

# Find necessary packages
find_package(CURL)
find_package(Boost REQUIRED COMPONENTS json)
find_package(cppgraphqlgen 4.5.7 CONFIG REQUIRED)
find_package(cpr 1.11.1 REQUIRED)

# Include generated headers
include_directories(generated/include)

# Add executable
file(GLOB_RECURSE GENERATED_SRC "generated/src/*.cpp")
add_executable(ExampleApp src/main.cpp ${GENERATED_SRC})

# Link libraries
target_link_libraries(ExampleApp
    PRIVATE
    cppgraphqlgen::graphqlservice
    Boost::json
    cpr
    ${CURL_LIBRARIES}
)
```

--------------------------------

### Mutations for Creating and Managing Resources

Source: https://docs.helioadditive.com/en/developers/api

This section details various mutations available in the Helioadditive API for creating and updating resources such as simulations, optimizations, personal access tokens, suggestions, and feedback. Each mutation specifies its arguments, their types, and the expected return object.

```APIDOC
mutation createSimulation($input: CreateSimulationInput!)
  "Create a new simulation based on a G-Code."
  Returns: Simulation!
  Arguments:
    input: Input data for creating a simulation (type: CreateSimulationInput!)
```

```APIDOC
mutation createPersonalAccessToken($name: String!, $expirationDaysDelta: Int!)
  "Create a new personal access token."
  Returns: CreatePatTokenResponse!
  Arguments:
    name: (type: String!)
    expirationDaysDelta: (type: Int!)
```

```APIDOC
mutation createOptimization($input: CreateOptimizationInput!)
  "Create a new optimization based on a G-code."
  Returns: Optimization!
  Arguments:
    input: Input data for creating an optimization (type: CreateOptimizationInput!)
```

```APIDOC
mutation createSuggestion($input: CreateSuggestionInput!)
  "Create a new suggestion for the L-FAM platform."
  Returns: Suggestion!
  Arguments:
    input: (type: CreateSuggestionInput!)
```

```APIDOC
mutation incrementBuyNowClickCount($id: ID!)
  "Increment the buy now click count for a material."
  Returns: Material!
  Arguments:
    id: (type: ID!)
```

```APIDOC
mutation redeemFreeTrialCode($input: RedeemFreeTrialCodeInput!)
  "Redeem a free trial code for the platform."
  Returns: FreeTrialCode!
  Arguments:
    input: (type: RedeemFreeTrialCodeInput!)
```

```APIDOC
mutation updateNewsArticleFeedback($newsArticleId: ID!, $input: NewsArticleFeedbackInput!)
  "Update feedback for a news article."
  Returns: NewsArticleFeedback!
  Arguments:
    newsArticleId: (type: ID!)
    input: (type: NewsArticleFeedbackInput!)
```

--------------------------------

### SimulationSettings Object API

Source: https://docs.helioadditive.com/en/developers/api

Defines the simulation environment settings. Includes parameters like air temperature, stabilization height, and optional overrides for nozzle, platform temperature, and fan speed.

```APIDOC
SimulationSettings:
  airTemperatureAboveBuildPlate: Float!
  temperatureStabilizationHeight: Float!
  stabilizedAirTemperature: Float!
  constantPlatformTemperature: Float
  constantNozzleTemperature: Float
  constantFanSpeed: Float
```

--------------------------------

### User and System Queries

Source: https://docs.helioadditive.com/en/developers/api

Endpoints for retrieving user-specific data like login history and personal access tokens, and system-related information like news articles.

```APIDOC
query logins:
  description: Retrieve login history for the user.
  returns:
    type: [Login!]!

query personalAccessTokens:
  description: Retrieve personal access tokens for the user.
  returns:
    type: [PersonalAccessToken!]!

query newsArticle(
  id: ID!
): NewsArticle!
  description: Retrieve the default simulation parameters.
  arguments:
    id:
      type: ID!
      description: (No description provided)
  returns:
    type: NewsArticle!
```

--------------------------------

### CreateSimulationInput API

Source: https://docs.helioadditive.com/en/developers/api

Defines the input structure for creating a simulation. It includes a name, the G-code identifier, and simulation-specific settings.

```APIDOC
CreateSimulationInput:
  name: String! - User-defined name for the simulation.
  gcodeId: ID! - Unique identifier of the G-code to simulate.
  simulationSettings: SimulationSettingsInput - Settings related to the simulation environment and parameters.
```

--------------------------------

### Faq API Object

Source: https://docs.helioadditive.com/en/developers/api

Represents a Frequently Asked Question entry, containing localized question and answer text, its category, and timestamps for creation and last update.

```APIDOC
Faq:
  id: ID!
  question: String
  answer: String
  category: FaqCategory
  insertedAt: DateTime!
  updatedAt: DateTime!
```

--------------------------------

### Helioadditive API Queries

Source: https://docs.helioadditive.com/en/developers/api

This section lists the available queries for retrieving data from the Helioadditive API. These queries allow access to information such as FAQs, events, G-Codes, thermal histories, material details, printer configurations, simulation data, and user profiles. Each query represents a specific data retrieval operation.

```APIDOC
Queries:
  faqs
    Retrieves a list of frequently asked questions.

  events
    Retrieves a list of system events.

  gcodes
    Retrieves a list of G-Codes.

  gcode(id: ID!)
    Retrieves a specific G-Code by its ID.

  thermalHistories
    Retrieves thermal history data.

  materials
    Retrieves a list of available materials.

  material(id: ID!)
    Retrieves a specific material by its ID.

  materialBrands
    Retrieves a list of material brands.

  materialsSummary
    Retrieves a summary of material data.

  logins
    Retrieves login records.

  personalAccessTokens
    Retrieves a list of personal access tokens.

  printers
    Retrieves a list of configured printers.

  printer(id: ID!)
    Retrieves a specific printer by its ID.

  newsArticle(id: ID!)
    Retrieves a specific news article by its ID.

  newsArticles
    Retrieves a list of news articles.

  newsArticleFeedback(id: ID!)
    Retrieves feedback for a specific news article.

  simulations
    Retrieves a list of simulations.

  optimizations
    Retrieves a list of optimizations.

  defaultSimulationSettings
    Retrieves default settings for simulations.

  defaultOptimizationSettings
    Retrieves default settings for optimizations.

  optimization(id: ID!)
    Retrieves a specific optimization by its ID.

  simulation(id: ID!)
    Retrieves a specific simulation by its ID.

  summary
    Retrieves a general summary of data.

  getPresignedUrl(fileName: String!, fileType: String!)
    Generates a pre-signed URL for file uploads.

  transactionHistoriesForUser(userId: ID!)
    Retrieves transaction histories for a specific user.

  user(id: ID!)
    Retrieves a specific user by their ID.
```

--------------------------------

### Simulation Query API

Source: https://docs.helioadditive.com/en/developers/api

Retrieve the default simulation parameters. This query fetches the standard configuration settings for simulations.

```APIDOC
simulation(id: ID!): Simulation!

Arguments for simulation:
  id (ID!): The unique identifier of the Simulation to retrieve.

Returns: Simulation!
```

--------------------------------

### Helioadditive C++ Library Identifiers

Source: https://docs.helioadditive.com/en/developers/cpp

Lists core C++ libraries and namespaces utilized by the Helioadditive project, such as cppgraphqlgen for GraphQL integration, taocpp::pegtl for parsing, cpr for HTTP requests, and Boost.json for JSON handling.

```cpp
cppgraphqlgen::graphqlclient
cppgraphqlgen::graphqlresponse
cppgraphqlgen::graphqlpeg
cppgraphqlgen::graphqlcoro
cppgraphqlgen::graphqljson
taocpp::pegtl
cpr::cpr
Boost::json
```

--------------------------------

### FreeTrialCode API Object

Source: https://docs.helioadditive.com/en/developers/api

Details of free trial codes, including their unique identifier, the code itself, usage status, associated group, user who redeemed it, and timestamps for creation and updates.

```APIDOC
FreeTrialCode:
  description: Details of free trial codes.
  fields:
    id:
      type: "ID!"
      description: "Unique identifier for the code."
      link: "https://docs.helioadditive.com/en/developers/api#scalar-id"
    code:
      type: "String!"
      description: "The free trial code itself."
      link: "https://docs.helioadditive.com/en/developers/api#scalar-string"
    isUsed:
      type: "Boolean!"
      description: "Indicates whether the free trial code has been used."
      link: "https://docs.helioadditive.com/en/developers/api#scalar-boolean"
    group:
      type: "FreeTrialCodeGroup!"
      description: "The group this code belongs to."
      link: "https://docs.helioadditive.com/en/developers/api#object-FreeTrialCodeGroup"
    user:
      type: "User"
      description: "User who redeemed the code, if any."
      link: "https://docs.helioadditive.com/en/developers/api#object-User"
    insertedAt:
      type: "DateTime!"
      description: "Timestamp when the free trial code was created."
      link: "https://docs.helioadditive.com/en/developers/api#scalar-DateTime"
    updatedAt:
      type: "DateTime!"
      description: "Timestamp when the free trial code was last updated."
      link: "https://docs.helioadditive.com/en/developers/api#scalar-DateTime"
```

--------------------------------

### Query Simulations

Source: https://docs.helioadditive.com/en/developers/api

Retrieves a paginated list of simulations. Supports sorting and filtering by various simulation fields.

```APIDOC
query simulations(
  page: Int,
  pageSize: Int,
  sortBy: SimulationField,
  sortDirection: SortDirection,
  filters: [SimulationFilter!]
): PaginatedResponse!
  Arguments:
    page: The page number to retrieve (1-based index).
    pageSize: The number of items per page.
    sortBy: Field to sort the results by.
    sortDirection: Direction to sort the results (ascending or descending).
    filters: List of filters to apply to the Simulation results.
  Returns:
    PaginatedResponse!: A paginated response containing simulation data.
```

--------------------------------

### GraphQL Client Code Generation

Source: https://docs.helioadditive.com/en/developers/cpp

Generates C++ client code from a GraphQL schema and query files. This process creates type-safe functions, structs, and enums, simplifying API interaction by abstracting request construction and response parsing.

```bash
mkdir -p ./generated/src
mkdir -p ./generated/include

curl https://api.helioadditive.com/graphql/schema.graphqls -o ./schema.graphqls

./vcpkg/packages/cppgraphqlgen_arm64-osx/tools/cppgraphqlgen/clientgen \
  --schema ./schema.graphqls \
  --request queries/Materials.graphql \
  --namespace HelioAdditive \
  --prefix Materials \
  --source-dir ./generated/src \
  --header-dir ./generated/include
```

--------------------------------

### SimulationSettingsInput API

Source: https://docs.helioadditive.com/en/developers/api

Specifies environmental and operational settings for a simulation. This includes ambient temperatures, stabilization heights, and optional overrides for nozzle temperature and fan speed.

```APIDOC
SimulationSettingsInput:
  roomTemperature: Float
    description: Ambient air temperature in the room, in degrees Kelvin.
  airTemperatureAboveBuildPlate: Float
    description: Ambient air temperature just above the build plate, in degrees Kelvin.
  temperatureStabilizationHeight: Float
    description: The height at which the air temperature around the print begins to stabilize.
  stabilizedAirTemperature: Float
    description: The temperature maintained at the stabilization height, in degrees Kelvin.
  constantPlatformTemperature: Float
    description: Optional override for the platform (bed) temperature, in degrees Kelvin.
  constantNozzleTemperature: Float
    description: Optional override for the nozzle temperature, in degrees Kelvin.
  constantFanSpeed: Float
    description: Optional override for fan speed as a percentage (0–100).
```

--------------------------------

### Login API

Source: https://docs.helioadditive.com/en/developers/api

Represents a user's login record, detailing the user, login method, and associated credentials or identifiers.

```APIDOC
Login:
  id (ID!): Unique identifier of the login record.
  user (User!): The user associated with this login record.
  loginType (LoginType!): Type of login method used (e.g. username/password or Auth0).
  upUsername (String): Username used for traditional login, if applicable.
  upPassword (String): Password hash used for traditional login, if applicable.
  auth0UserId (String): Auth0 user ID if the user logged in via Auth0.
  auth0Email (String): Email associated with the Auth0 login, if applicable.
```

--------------------------------

### OptimizationSettings API

Source: https://docs.helioadditive.com/en/developers/api

Defines parameters for optimization processes, including velocity, flow rate, iterations, and strategy settings.

```APIDOC
OptimizationSettings:
  minVelocity (Float!): Minimum velocity used during optimization.
  maxVelocity (Float!): Maximum velocity allowed during optimization.
  minVelocityIncrement (Float!): Minimum velocity increment allowed.
  minExtruderFlowRate (Float!): Maximum extruder flow rate during optimization.
  maxExtruderFlowRate (Float!): Minimum extruder flow rate during optimization.
  tolerance (Float!): Tolerance value for convergence in optimization.
  maxIterations (Int!): Maximum number of iterations in the optimization run.
  nNodes (Int!): Number of nodes used in the optimization process.
  reductionStrategySettings (ReductionStrategySettings!): Configuration settings for the reduction strategy used during optimization.
  residualStrategySettings (ResidualStrategySettings!): Configuration settings for the residual strategy used during optimization.
  layersToOptimize ([LayerRange!]!): List of layer ranges to include in the optimization process.
  optimizer (Optimizer!): Selected optimization algorithm to use during the simulation process.
```

--------------------------------

### User Object API Documentation

Source: https://docs.helioadditive.com/en/developers/api

Details the fields available for a User object in the Helioadditive API. Includes user identifiers, contact information, role, avatar, transaction history, optimization limits, subscription status, and login records.

```APIDOC
User:
  id: ID!
    - Unique identifier of the user.
  email: String
    - User's email address.
  handle: String
    - Custom user handle or username.
  type: UserType!
    - The user type or role in the system (e.g. Hobbyist, Academic).
  avatarUrl: String
    - URL to the user's avatar image.
  transactionHistories: [TransactionHistory!]!
    - List of the user's transaction history records.
  remainingOptsThisMonth: Int
    - Remaining number of optimizations allowed for the user this month.
  subscriptionStartDate: DateTime
    - Start date of the user's subscription, if active.
  subscriptionEndDate: DateTime
    - End date of the user's subscription, if active.
  subscription: HelioSubscription
    - Subscription details for the user, if any.
  logins: [Login!]!
    - List of user login records.
  membershipStatus: String!
    - Indicates if the user has an active subscription.
```

--------------------------------

### APIDOC PresignedUrl Object

Source: https://docs.helioadditive.com/en/developers/api

Contains information for uploading files using a presigned URL, including MIME type, the URL itself, and a storage key.

```APIDOC
APIDOC PresignedUrl:
  Description: Contains information for uploading a file using a presigned URL.
  Fields:
    mimeType (String!): MIME type of the file associated with the presigned URL.
    url (String!): Presigned URL allowing for direct uploads.
    key (String!): Key or identifier associated with the file in storage.
```

--------------------------------

### Gcode Object API Documentation

Source: https://docs.helioadditive.com/en/developers/api

Details the structure and fields of the Gcode API object. This object encapsulates parsed data and metadata from G-code files, providing information on file properties, print dimensions, temperature settings, slicer details, and timestamps. Each field includes its type, description, and a link to the API schema.

```APIDOC
Gcode:
  description: Represents parsed data and metadata extracted from a G-code file.
  fields:
    id:
      type: "ID!"
      description: "Unique identifier for the G-code file."
      link: "https://docs.helioadditive.com/en/developers/api#scalar-id"
    name:
      type: "String!"
      description: "Original name of the G-code file."
      link: "https://docs.helioadditive.com/en/developers/api#scalar-string"
    sizeKb:
      type: "Float!"
      description: "Size of the G-code file in kilobytes."
      link: "https://docs.helioadditive.com/en/developers/api#scalar-float"
    height:
      type: "Float!"
      description: "Maximum height reached during the print, in millimetres."
      link: "https://docs.helioadditive.com/en/developers/api#scalar-float"
    width:
      type: "Float!"
      description: "Maximum width of the print area, in millimetres."
      link: "https://docs.helioadditive.com/en/developers/api#scalar-float"
    depth:
      type: "Float!"
      description: "Maximum depth of the print area, in millimetres."
      link: "https://docs.helioadditive.com/en/developers/api#scalar-float"
    platformTemperature:
      type: "GcodeCustomFloat"
      description: "Platform (bed) temperature used during the print. May be overridden or missing."
      link: "https://docs.helioadditive.com/en/developers/api#object-GcodeCustomFloat"
    nozzleTemperatureMin:
      type: "GcodeCustomFloat!"
      description: "Minimum nozzle temperature detected in the G-code."
      link: "https://docs.helioadditive.com/en/developers/api#object-GcodeCustomFloat"
    nozzleTemperatureMax:
      type: "GcodeCustomFloat!"
      description: "Maximum nozzle temperature detected in the G-code."
      link: "https://docs.helioadditive.com/en/developers/api#object-GcodeCustomFloat"
    gcodeUrl:
      type: "String!"
      description: "URL to the G-code file in storage, if available. May be null if not stored."
      link: "https://docs.helioadditive.com/en/developers/api#scalar-string"
    gcodeKey:
      type: "String!"
      description: "Key used to access the G-code file in storage. This is not a URL but a unique identifier."
      link: "https://docs.helioadditive.com/en/developers/api#scalar-string"
    roadWidthMin:
      type: "GcodeCustomFloat!"
      description: "Minimum road width specified in the G-code."
      link: "https://docs.helioadditive.com/en/developers/api#object-GcodeCustomFloat"
    roadWidthMax:
      type: "GcodeCustomFloat!"
      description: "Maximum road width specified in the G-code."
      link: "https://docs.helioadditive.com/en/developers/api#object-GcodeCustomFloat"
    layerHeightMin:
      type: "GcodeCustomFloat!"
      description: "Minimum layer height specified in the G-code."
      link: "https://docs.helioadditive.com/en/developers/api#object-GcodeCustomFloat"
    layerHeightMax:
      type: "GcodeCustomFloat!"
      description: "Maximum layer height specified in the G-code."
      link: "https://docs.helioadditive.com/en/developers/api#object-GcodeCustomFloat"
    speedMin:
      type: "GcodeCustomFloat!"
      description: "Minimum print speed specified in the G-code."
      link: "https://docs.helioadditive.com/en/developers/api#object-GcodeCustomFloat"
    speedMax:
      type: "GcodeCustomFloat!"
      description: "Maximum print speed specified in the G-code."
      link: "https://docs.helioadditive.com/en/developers/api#object-GcodeCustomFloat"
    fanSpeedMin:
      type: "GcodeCustomFloat!"
      description: "Minimum fan speed used in the G-code."
      link: "https://docs.helioadditive.com/en/developers/api#object-GcodeCustomFloat"
    fanSpeedMax:
      type: "GcodeCustomFloat!"
      description: "Maximum fan speed used in the G-code."
      link: "https://docs.helioadditive.com/en/developers/api#object-GcodeCustomFloat"
    numberOfLayers:
      type: "Int!"
      description: "Total number of layers found in the G-code."
      link: "https://docs.helioadditive.com/en/developers/api#scalar-int"
    slicer:
      type: "Slicer!"
      description: "Slicer software identified from the G-code metadata."
      link: "https://docs.helioadditive.com/en/developers/api#enum-Slicer"
    material:
      type: "Material!"
      description: "Material associated with this G-code."
      link: "https://docs.helioadditive.com/en/developers/api#object-Material"
    printer:
      type: "Printer!"
      description: "Printer associated with this G-code."
      link: "https://docs.helioadditive.com/en/developers/api#object-Printer"
    flowRatio:
      type: "Float"
      description: "Optional flow ratio specified in the G-code, if available."
      link: "https://docs.helioadditive.com/en/developers/api#scalar-float"
    overrideGcodeParams:
      type: "OverrideGcodeParams"
      description: "Overrides applied to G-code parameters, if any."
      link: "https://docs.helioadditive.com/en/developers/api#object-OverrideGcodeParams"
    isSingleShell:
      type: "Boolean!"
      description: "Indicates whether the print is a single-shell structure."
      link: "https://docs.helioadditive.com/en/developers/api#scalar-boolean"
    insertedAt:
      type: "DateTime!"
      description: "Timestamp when the G-code was first processed or uploaded."
      link: "https://docs.helioadditive.com/en/developers/api#scalar-DateTime"
    updatedAt:
      type: "DateTime!"
      description: "Timestamp of the last update to this G-code record."
      link: "https://docs.helioadditive.com/en/developers/api#scalar-DateTime"
```

--------------------------------

### Query Optimizations

Source: https://docs.helioadditive.com/en/developers/api

Retrieves a paginated list of optimizations. Supports sorting and filtering by various optimization fields.

```APIDOC
query optimizations(
  page: Int,
  pageSize: Int,
  sortBy: SimulationField,
  sortDirection: SortDirection,
  filters: [SimulationFilter!]
): PaginatedResponse!
  Arguments:
    page: The page number to retrieve (1-based index).
    pageSize: The number of items per page.
    sortBy: Field to sort the results by.
    sortDirection: Direction to sort the results (ascending or descending).
    filters: List of filters to apply to the Optimization results.
  Returns:
    PaginatedResponse!: A paginated response containing optimization data.
```

--------------------------------

### Simulation Object API

Source: https://docs.helioadditive.com/en/developers/api

Represents a simulation run with associated metadata and results. Includes fields like ID, name, progress, status, asset URLs, printer, material, and timestamps.

```APIDOC
Simulation:
  id: ID!
  name: String!
  progress: Float!
  status: SimulationStatus!
  meshUrl: SimulationAsset
  gcode: Gcode!
  printer: Printer!
  material: Material!
  reportJsonUrl: String
  thermalIndexGcodeUrl: String
  estimatedSimulationDurationSeconds: Float
  simulationSettings: SimulationSettings!
  thermalIndexStatistics: ThermalIndexStatistics!
  updatedAt: DateTime!
  insertedAt: DateTime!
```
Tokens:
Raw