BluefinShieldconexMgmt SDK

Shieldconex Management Api client, generated from the OpenAPI spec.

Learn more about Shieldconex Management Api at portal-cert.shieldconex.com.

This is an unofficial SDK for the Shieldconex Management public API, generated by Voxgig with @voxgig/sdkgen. It is not affiliated with, endorsed by, or sponsored by the upstream API provider.

Learn more about Voxgig SDKs at voxgig.com/sdk.

TypeScript, Python, PHP, Golang, Ruby, Lua, C, Clojure, C++, C#, Dart, Elixir, Haskell, Java, JavaScript, Kotlin, OCaml, Perl, Rust, Scala, Swift, Zig SDKs, a CLI, an interactive REPL, and an MCP server for AI agents — all generated from one OpenAPI spec by @voxgig/sdkgen.

Entities, not endpoints

This SDK exposes the API as 7 semantic entities that you call directly, instead of assembling URL paths and query strings. See the Entities table below for the full list. Entities are Capitalised to mark them as the primary surface, each with the operations they support (list, load, create, update, remove):

const client = new BluefinShieldconexMgmtSDK()
const items = await client.Client().list()

Thinking in entities keeps the mental model small — for people and AI agents alike — rather than reasoning about raw HTTP routes and query parameters.

Offline unit testing

Every SDK ships a built-in test mode that swaps the HTTP transport for an in-memory mock, so your unit tests run fully offline — no server, no network, and no credentials:

TypeScript

const client = BluefinShieldconexMgmtSDK.test()
const partners = await client.Partner().list()
// partners is an array of bare Partner records populated with mock data
console.log(partners)

Python

client = BluefinShieldconexMgmtSDK.test()
partners = client.Partner().list()
print(partners)

PHP

// Seed fixture data so offline calls resolve without a live server.
$client = BluefinShieldconexMgmtSDK::test([
    "entity" => ["partner" => ["test01" => ["id" => "test01"]]],
]);
$partners = $client->Partner()->list();

Golang

client := sdk.Test()
result, err := client.Partner(nil).List(
    nil, nil,
)

Ruby

# Seed fixture data so offline calls resolve without a live server.
client = BluefinShieldconexMgmtSDK.test({
  "entity" => { "partner" => { "test01" => { "id" => "test01" } } },
})
partners = client.Partner.list()

Lua

local client = sdk.test()
local results, err = client:Partner():list()

C

#include "core/api.h"

BluefinShieldconexMgmtSDK* client = test_sdk(NULL, NULL);
PNError* err = NULL;
Entity* partner = bluefinshieldconexmgmt_partner(client, NULL);
voxgig_value* partners = partner->vt->list(partner, NULL, NULL, &err);
printf("%s\n", voxgig_to_json(partners));

Clojure

(require '[sdk.api :as api]
         '[sdk.entity.partner :as e-partner]
         '[voxgig.struct :as vs])

(def client (api/test-sdk nil nil))
(def partners (e-partner/list (api/partner client nil) nil nil))
(println partners)

C++

auto client = BluefinShieldconexMgmtSDK::testSDK();
Value partners = client->partner()->list(Value::undef(), Value::undef());
std::cout << Struct::jsonify(partners) << std::endl;

C#

var client = BluefinShieldconexMgmtSDK.TestSDK(null, null);
var partnerList = client.Partner().List(null);
Console.WriteLine(partnerList);

Dart

import 'package:bluefin_shieldconex_mgmt_sdk/BluefinShieldconexMgmtSDK.dart';

Future<void> main() async {
  final client = BluefinShieldconexMgmtSDK.test();
  final partners = await client.Partner().list();
  print(partners);
}

Elixir

alias BluefinShieldconexMgmt.Helpers, as: H

sdk = BluefinShieldconexMgmt.test()
partner = BluefinShieldconexMgmt.partner(sdk)
records = BluefinShieldconexMgmt.Entity.Partner.list(partner, H.deep(%{}))
IO.inspect(records)

Haskell

import qualified SdkClient as Sdk
import VoxgigStruct (Value (..), emptyMap)
import SdkHelpers (jo)

main :: IO ()
main = do
  sdk <- Sdk.testSdk0
  ent <- Sdk.partner sdk VNoval
  arg <- emptyMap
  ctrl <- emptyMap
  partners <- Sdk.eList ent arg ctrl
  print partners

Java

BluefinShieldconexMgmtSDK client = BluefinShieldconexMgmtSDK.testSDK(null, null);
Object partnerList = client.partner(null).list(null, null);
System.out.println(partnerList);

JavaScript

const client = BluefinShieldconexMgmtSDK.test()
const partners = await client.Partner().list()
// partners is an array of bare entities populated with mock data
console.log(partners)

Kotlin

val client = BluefinShieldconexMgmtSDK.testSDK(null, null)
val partnerList = client.partner(null).list(null, null)
println(partnerList)

OCaml

let () =
  let client = Sdk_client.test () in
  let result = (Sdk_client.partner client Noval).e_list (empty_map ()) Noval in
  print_endline (stringify result)

Perl

use lib 'perl/lib';
use BluefinShieldconexMgmtSDK;

my $client = BluefinShieldconexMgmtSDK->test(undef, undef);
my $partners = $client->Partner->list();
print scalar(@$partners), " records\n";

Rust

use bluefin_shieldconex_mgmt_sdk::{jo, test_sdk, Value};

let client = test_sdk(Value::Noval, Value::Noval);
let partners = client.partner(Value::Noval).list(Value::Noval, Value::Noval).unwrap();
println!("{:?}", partners);

Scala

val client = BluefinShieldconexMgmtSDK.testSDK(null, null)
val partnerList = client.partner(null).list(null, null)
println(partnerList)

Swift

let client = BluefinShieldconexMgmtSDK.testSDK(nil, nil)
let partnerList = try client.Partner().list(nil, nil)
print(partnerList)

Zig

const std = @import("std");
const sdk = @import("sdk");
const h = sdk.h;

const client = sdk.test_sdk(h.vnull(), h.vnull());
switch (client.partner(h.vnull()).list(h.vnull(), h.vnull())) {
    .ok => |partners| std.debug.print("{s}\n", .{h.stringify(partners)}),
    .err => |e| std.debug.print("list failed: {s}\n", .{e.msg}),
}

Packages

Quickstart

TypeScript

import { BluefinShieldconexMgmtSDK } from '@voxgig-sdk/bluefin-shieldconex-mgmt'

const client = new BluefinShieldconexMgmtSDK({
  apikey: process.env.BLUEFIN_SHIELDCONEX_MGMT_APIKEY,
})

// List all clients (returns Client[])
const client_s = await client.Client().list()
for (const client_ of client_s) {
  console.log(client_)
}

See the TypeScript README for the full guide.

Surfaces

Use it from an AI agent (MCP)

The generated MCP server exposes every operation in this SDK as an MCP tool that Claude, Cursor or Cline can call directly. Build and register it:

cd go-mcp && go build -o bluefin-shieldconex-mgmt-mcp .

Then add it to your agent’s MCP config (Claude Desktop, Cursor, etc.):

{
  "mcpServers": {
    "bluefin-shieldconex-mgmt": {
      "command": "/abs/path/to/bluefin-shieldconex-mgmt-mcp"
    }
  }
}

Entities

The API exposes 7 entities:

The operations available across these entities are load, list, create, update, remove — see each entity’s own list above for exactly which it supports.

Quickstart in other languages

Python

import os
from bluefinshieldconexmgmt_sdk import BluefinShieldconexMgmtSDK

client = BluefinShieldconexMgmtSDK({
    "apikey": os.environ.get("BLUEFIN_SHIELDCONEX_MGMT_APIKEY"),
})

# List all clients (returns a list, raises on error)
client_s = client.Client().list()
for client_ in client_s:
    print(client_)

# Load a specific client (returns the record, raises on error)
client_ = client.Client().load({"id": "example_id"})
print(client_)

PHP

<?php
require_once 'bluefinshieldconexmgmt_sdk.php';

$client = new BluefinShieldconexMgmtSDK([
    "apikey" => getenv("BLUEFIN_SHIELDCONEX_MGMT_APIKEY"),
]);

// List all clients (returns an array; throws on error)
$clients = $client->Client()->list();
print_r($clients);

// Load a specific client (returns the bare record; throws on error)
$client = $client->Client()->load(["id" => "example_id"]);
print_r($client);

Golang

import sdk "github.com/voxgig-sdk/bluefin-shieldconex-mgmt-sdk/go"

client := sdk.NewBluefinShieldconexMgmtSDK(map[string]any{
    "apikey": os.Getenv("BLUEFIN_SHIELDCONEX_MGMT_APIKEY"),
})

// List all clients
client_s, err := client.Client(nil).List(nil, nil)
if err != nil {
    panic(err)
}
fmt.Println(client_s)

Ruby

require_relative "BluefinShieldconexMgmt_sdk"

client = BluefinShieldconexMgmtSDK.new({
  "apikey" => ENV["BLUEFIN_SHIELDCONEX_MGMT_APIKEY"],
})

# List all clients (returns an Array; raises on error)
client_s = client.Client.list
puts client_s

# Load a specific client (returns the bare record; raises on error)
client_ = client.Client.load({ "id" => "example_id" })
puts client_

Lua

local sdk = require("bluefin-shieldconex-mgmt_sdk")

local client = sdk.new({
  apikey = os.getenv("BLUEFIN_SHIELDCONEX_MGMT_APIKEY"),
})

-- List all clients
local client_s, err = client:Client():list()
print(client_s)

-- Load a specific client
local client_, err = client:Client():load({ id = "example_id" })
print(client_)

C

#include "core/api.h"

BluefinShieldconexMgmtSDK* client = bluefinshieldconexmgmt_sdk_new(cmap(1,
    "apikey", v_str(getenv("BLUEFIN_SHIELDCONEX_MGMT_APIKEY"))));
PNError* err = NULL;

Entity* client = bluefinshieldconexmgmt_client(client, NULL);

// List all clients (returns a List, sets *err on failure)
voxgig_value* clients = client->vt->list(client, NULL, NULL, &err);
for (size_t i = 0; i < (size_t)voxgig_size(clients); i++) {
    printf("%s\n", voxgig_to_json(voxgig_getelem(clients, v_int(i), NULL)));
}

// Load a specific client (returns the record, sets *err on failure)
voxgig_value* client_rec = client->vt->load(client, cmap(1, "id", v_str("example_id")), NULL, &err);
printf("%s\n", voxgig_to_json(client_rec));

Clojure

(require '[sdk.api :as api]
         '[sdk.entity.client :as e-client]
         '[voxgig.struct :as vs])

(def client (api/make-sdk (vs/jm "apikey" (System/getenv "BLUEFIN_SHIELDCONEX_MGMT_APIKEY"))))

;; List all clients (returns a vector, raises on error)
(doseq [client (e-client/list (api/client client nil) nil nil)]
  (println client))

;; Load a specific client (returns the record, raises on error)
(def client (e-client/load (api/client client nil) (vs/jm "id" "example_id") nil))
(println client)

C++

#include <cstdlib>
#include "core/sdk.hpp"

using namespace sdk;

const char* apikey = std::getenv("BLUEFIN_SHIELDCONEX_MGMT_APIKEY");
auto client = std::make_shared<BluefinShieldconexMgmtSDK>(vmap({
    {"apikey", Value(apikey ? apikey : "")},
}));

// List all clients (returns a Value list, throws on error)
Value clients = client->client()->list(Value::undef(), Value::undef());
for (const auto& client : *clients.as_list()) {
  std::cout << Struct::jsonify(client) << std::endl;
}

// Load a specific client (returns the record, throws on error)
Value client = client->client()->load(vmap({{"id", Value("example_id")}}), Value::undef());
std::cout << Struct::jsonify(client) << std::endl;

C#

using BluefinShieldconexMgmtSdk;

var client = new BluefinShieldconexMgmtSDK(new Dictionary<string, object?>
{
    ["apikey"] = Environment.GetEnvironmentVariable("BLUEFIN_SHIELDCONEX_MGMT_APIKEY"),
});

// List all clients (returns object?, an aggregate list; raises on error)
var clientList = client.Client().List(null);
Console.WriteLine(clientList);

// Load a specific client (returns the record, raises on error)
var client = client.Client().Load(new Dictionary<string, object?> { ["id"] = "example_id" });
Console.WriteLine(client);

Dart

import 'dart:io';
import 'package:bluefin_shieldconex_mgmt_sdk/BluefinShieldconexMgmtSDK.dart';

Future<void> main() async {
  final client = BluefinShieldconexMgmtSDK({
    'apikey': Platform.environment['BLUEFIN_SHIELDCONEX_MGMT_APIKEY'],
  });

  // List all clients (returns a list of entities, throws on error)
  final client_s = await client.Client().list();
  for (final item in client_s) {
    print(item.data());
  }

  // Load a specific client (returns the record, throws on error)
  final client_ = await client.Client().load({'id': 'example_id'});
  print(client_);
}

Elixir

alias BluefinShieldconexMgmt.Helpers, as: H

sdk = BluefinShieldconexMgmt.new(H.deep(%{"apikey" => System.get_env("BLUEFIN_SHIELDCONEX_MGMT_APIKEY")}))

client = BluefinShieldconexMgmt.client(sdk)

# List all client records (raises on error)
records = BluefinShieldconexMgmt.Entity.Client.list(client)
IO.inspect(records)

# Load a specific client (returns the record, raises on error)
record = BluefinShieldconexMgmt.Entity.Client.load(client, H.deep(%{"id" => "example_id"}))
IO.inspect(record)

Haskell

import System.Environment (lookupEnv)
import qualified SdkClient as Sdk
import VoxgigStruct (Value (..), emptyMap)
import SdkHelpers (jo)

main :: IO ()
main = do
  mkey <- lookupEnv "BLUEFIN_SHIELDCONEX_MGMT_APIKEY"
  opts <- jo [("apikey", maybe VNoval VStr mkey)]
  sdk <- Sdk.newSdk opts

  -- List all clients (returns a list Value, raises on error)
  ent <- Sdk.client sdk VNoval
  match <- emptyMap
  ctrl <- emptyMap
  clients <- Sdk.eList ent match ctrl
  print clients

  -- Load a specific client (returns the record, raises on error)
  ent2 <- Sdk.client sdk VNoval
  m <- jo [("id", VStr "example_id")]
  ctrl2 <- emptyMap
  client <- Sdk.eLoad ent2 m ctrl2
  print client

Java

import voxgig.bluefinshieldconexmgmtsdk.core.BluefinShieldconexMgmtSDK;

Map<String, Object> options = new java.util.LinkedHashMap<>();
options.put("apikey", System.getenv("BLUEFIN_SHIELDCONEX_MGMT_APIKEY"));
BluefinShieldconexMgmtSDK client = new BluefinShieldconexMgmtSDK(options);

// List all clients (returns Object, an aggregate list; raises on error)
Object clientList = client.client(null).list(null, null);
System.out.println(clientList);

// Load a specific client (returns the record, raises on error)
Object client = client.client(null).load(Map.of("id", "example_id"), null);
System.out.println(client);

JavaScript

const { BluefinShieldconexMgmtSDK } = require('@voxgig-sdk/bluefin-shieldconex-mgmt-js')

const client = new BluefinShieldconexMgmtSDK({
  apikey: process.env.BLUEFIN_SHIELDCONEX_MGMT_APIKEY,
})

// List all clients (returns an array)
const client_s = await client.Client().list()
for (const client_ of client_s) {
  console.log(client_)
}

Kotlin

import voxgig.bluefinshieldconexmgmtsdk.core.BluefinShieldconexMgmtSDK

val client = BluefinShieldconexMgmtSDK(mutableMapOf<String, Any?>(
    "apikey" to System.getenv("BLUEFIN_SHIELDCONEX_MGMT_APIKEY"),
))

// List all clients (returns Any?, an aggregate list; raises on error)
val clientList = client.client(null).list(null, null)
println(clientList)

// Load a specific client (returns the record, raises on error)
val client = client.client(null).load(mutableMapOf<String, Any?>("id" to "example_id"), null)
println(client)

OCaml

open Voxgig_struct
open Sdk_helpers

let () =
  let client = Sdk_client.make (jo [("apikey", Str (Sys.getenv "BLUEFIN_SHIELDCONEX_MGMT_APIKEY"))]) in
  (* List all client records (returns a List value; raises on error) *)
  let clients = (Sdk_client.client client Noval).e_list (empty_map ()) Noval in
  (match clients with List items -> List.iter (fun r -> print_endline (stringify r)) !items | _ -> ());
  (* Load a specific client (returns the record; raises on error) *)
  let client = (Sdk_client.client client Noval).e_load (jo [("id", (Str "example_id"))]) Noval in
  print_endline (stringify client)

Perl

use lib 'perl/lib';
use BluefinShieldconexMgmtSDK;

my $client = BluefinShieldconexMgmtSDK->new({
    'apikey' => $ENV{'BLUEFIN_SHIELDCONEX_MGMT_APIKEY'},
});

# List all clients (returns an arrayref; dies on error)
my $clients = $client->Client->list;
for my $client (@$clients) {
    print "$client->{id}\n";
}

# Load a specific client (returns the bare record; dies on error)
my $client = $client->Client->load({ 'id' => 'example_id' });
print "$client->{id}\n";

Rust

use bluefin_shieldconex_mgmt_sdk::{jo, BluefinShieldconexMgmtSDK, Value};

let client = BluefinShieldconexMgmtSDK::new(jo(vec![
    ("apikey", Value::str(std::env::var("BLUEFIN_SHIELDCONEX_MGMT_APIKEY").unwrap_or_default())),
]));

// List all clients (returns a Value::List, Err on failure)
let clients = client.client(Value::Noval).list(Value::Noval, Value::Noval).unwrap();
if let Value::List(items) = &clients {
    for client in items.borrow().iter() {
        println!("{:?}", client);
    }
}

// Load a specific client (returns the record, Err on failure)
let client = client.client(Value::Noval).load(jo(vec![("id", Value::str("example_id"))]), Value::Noval).unwrap();
println!("{:?}", client);

Scala

import voxgig.bluefinshieldconexmgmtsdk.core.BluefinShieldconexMgmtSDK

val options = new java.util.LinkedHashMap[String, Object]()
options.put("apikey", System.getenv("BLUEFIN_SHIELDCONEX_MGMT_APIKEY"))
val client = new BluefinShieldconexMgmtSDK(options)

// List all clients (returns Object, an aggregate list; raises on error)
val clientList = client.client(null).list(null, null)
println(clientList)

// Load a specific client (returns the record, raises on error)
val client = client.client(null).load(java.util.Map.of("id", "example_id"), null)
println(client)

Swift

import BluefinShieldconexMgmtSdk

let options = VMap()
options.entries["apikey"] = .string(
    ProcessInfo.processInfo.environment["BLUEFIN_SHIELDCONEX_MGMT_APIKEY"] ?? "")
let client = BluefinShieldconexMgmtSDK(options)

// List all clients (returns a Value list, throws on error)
let clientList = try client.Client().list(nil, nil)
for client in clientList.asList?.items ?? [] {
    print(client)
}

// Load a specific client (returns the record, throws on error)
let client = try client.Client().load(VMap([("id", .string("example_id"))]), nil)
print(client)

Zig

const std = @import("std");
const sdk = @import("sdk");
const h = sdk.h;

const client = sdk.BluefinShieldconexMgmtSDK.new(h.jo(&.{
    .{ "apikey", h.vstr(std.posix.getenv("BLUEFIN_SHIELDCONEX_MGMT_APIKEY") orelse "") },
}));

// List all clients (Ok is a Value array, .err on failure)
switch (client.client(h.vnull()).list(h.vnull(), h.vnull())) {
    .ok => |clients| std.debug.print("{s}\n", .{h.stringify(clients)}),
    .err => |e| std.debug.print("list failed: {s}\n", .{e.msg}),
}

// Load a specific client (Ok is the record, .err on failure)
switch (client.client(h.vnull()).load(h.jo(&.{.{ "id", h.vstr("example_id") }}), h.vnull())) {
    .ok => |client| std.debug.print("{s}\n", .{h.stringify(client)}),
    .err => |e| std.debug.print("load failed: {s}\n", .{e.msg}),
}

Direct and prepare

For endpoints the entity model doesn’t cover, use the low-level methods:

• direct(fetchargs) — build and send an HTTP request in one step.
• prepare(fetchargs) — build the request without sending it.

Both accept a map with path, method, params, query, headers, and body. See the How-to guides below.

How-to guides

Make a direct API call

When the entity interface does not cover an endpoint, use direct:

TypeScript:

const result = await client.direct({
  path: '/api/resource/{id}',
  method: 'GET',
  params: { id: 'example' },
})
if (result instanceof Error) {
  throw result
}
console.log(result.data)

Python:

result = client.direct({
    "path": "/api/resource/{id}",
    "method": "GET",
    "params": {"id": "example"},
})

PHP:

$result = $client->direct([
    "path" => "/api/resource/{id}",
    "method" => "GET",
    "params" => ["id" => "example"],
]);

Go:

result, err := client.Direct(map[string]any{
    "path":   "/api/resource/{id}",
    "method": "GET",
    "params": map[string]any{"id": "example"},
})
if err != nil {
    panic(err)
}
fmt.Println(result)

Ruby:

result = client.direct({
  "path" => "/api/resource/{id}",
  "method" => "GET",
  "params" => { "id" => "example" },
})

Lua:

local result, err = client:direct({
  path = "/api/resource/{id}",
  method = "GET",
  params = { id = "example" },
})

C:

PNError* err = NULL;
voxgig_value* result = sdk_direct(client, cmap(3,
    "path", v_str("/api/resource/{id}"),
    "method", v_str("GET"),
    "params", cmap(1, "id", v_str("example"))), &err);

Clojure:

(def result
  (api/direct client
    (vs/jm "path" "/api/resource/{id}"
           "method" "GET"
           "params" (vs/jm "id" "example"))))

C++:

Value result = client->direct(vmap({
    {"path", Value("/api/resource/{id}")},
    {"method", Value("GET")},
    {"params", vmap({{"id", Value("example")}})},
}));

C#:

var result = client.Direct(new Dictionary<string, object?>
{
    ["path"] = "/api/resource/{id}",
    ["method"] = "GET",
    ["params"] = new Dictionary<string, object?> { ["id"] = "example" },
});

Dart:

final result = await client.direct({
  'path': '/api/resource/{id}',
  'method': 'GET',
  'params': {'id': 'example'},
});

Elixir:

result = BluefinShieldconexMgmt.direct(sdk, BluefinShieldconexMgmt.Helpers.deep(%{
  "path" => "/api/resource/{id}",
  "method" => "GET",
  "params" => %{"id" => "example"}
}))

Haskell:

import qualified SdkClient as Sdk
import qualified SdkFeatures as F
import VoxgigStruct (Value (..))
import SdkHelpers (jo)

main :: IO ()
main = do
  sdk <- Sdk.newSdk0
  params <- jo [("id", VStr "example")]
  args <- jo [("path", VStr "/api/resource/{id}"), ("method", VStr "GET"), ("params", params)]
  result <- F.direct sdk args
  print result

Java:

Map<String, Object> result = client.direct(Map.of(
    "path", "/api/resource/{id}",
    "method", "GET",
    "params", Map.of("id", "example")));

JavaScript:

const result = await client.direct({
  path: '/api/resource/{id}',
  method: 'GET',
  params: { id: 'example' },
})
if (result instanceof Error) {
  throw result
}
console.log(result.data)

Kotlin:

val result = client.direct(mutableMapOf<String, Any?>(
    "path" to "/api/resource/{id}",
    "method" to "GET",
    "params" to mapOf("id" to "example")))

OCaml:

let result = Sdk_client.direct client (jo [
    ("path", Str "/api/resource/{id}");
    ("method", Str "GET");
    ("params", jo [("id", Str "example")]);
]) in
ignore result

Perl:

my $result = $client->direct({
    'path' => '/api/resource/{id}',
    'method' => 'GET',
    'params' => { 'id' => 'example' },
});

Rust:

let result = client.direct(jo(vec![
    ("path", Value::str("/api/resource/{id}")),
    ("method", Value::str("GET")),
    ("params", jo(vec![("id", Value::str("example"))])),
]));

Scala:

val result = client.direct(java.util.Map.of(
    "path", "/api/resource/{id}",
    "method", "GET",
    "params", java.util.Map.of("id", "example")))

Swift:

let result = client.direct(VMap([
    ("path", .string("/api/resource/{id}")),
    ("method", .string("GET")),
    ("params", .map([("id", .string("example"))])),
]))

Zig:

const result = client.direct(h.jo(&.{
    .{ "path", h.vstr("/api/resource/{id}") },
    .{ "method", h.vstr("GET") },
    .{ "params", h.jo(&.{.{ "id", h.vstr("example") }}) },
}));

Advanced

Everyday use only needs the sections above. This explains the internals behind every call — relevant when writing custom features.

Every SDK call runs the same five-stage pipeline:

1. Point — resolve the API endpoint from the operation definition.
2. Spec — build the HTTP specification (URL, method, headers, body).
3. Request — send the HTTP request.
4. Response — receive and parse the response.
5. Result — extract the result data for the caller.

A feature hook fires at each stage (e.g. PrePoint, PreSpec, PreRequest), so features can inspect or modify the pipeline without forking the SDK.

Features

Pass custom features via the extend option at construction time.

Per-language documentation

• TypeScript
• Python
• PHP
• Golang
• Ruby
• Lua
• C
• Clojure
• C++
• C#
• Dart
• Elixir
• Haskell
• Java
• JavaScript
• Kotlin
• OCaml
• Perl
• Rust
• Scala
• Swift
• Zig

Upstream API

This SDK is generated from the upstream OpenAPI specification. It is an unofficial client and is not affiliated with the API provider.

• Upstream API: https://portal-cert.shieldconex.com:4010/api/v1

Security

Please report security issues to security@voxgig.com. See SECURITY.md. Do not open public issues for suspected vulnerabilities.

Generated from the Shieldconex Management Api OpenAPI spec by @voxgig/sdkgen.