BluefinShieldconex SDK

ShieldConex Api client, generated from the OpenAPI spec.

The purpose of the ShieldConex API’s are to provide ability to tokenize/detokenize data

Learn more about ShieldConex Api at secure-cert.shieldconex.com.

This is an unofficial SDK for the ShieldConex 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 a small set of semantic entities — Detokenize, Tokenize, TokenizeBatch, TokenizeRead and Validate — that you call directly, instead of assembling URL paths and query strings. Entities are Capitalised to mark them as the primary surface, each with the operations they support (list, create):

const client = new BluefinShieldconexSDK()
const items = await client.Detokenize().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 = BluefinShieldconexSDK.test()
const detokenizes = await client.Detokenize().list()
// detokenizes is an array of bare Detokenize records populated with mock data
console.log(detokenizes)

Python

client = BluefinShieldconexSDK.test()
detokenizes = client.Detokenize().list()
print(detokenizes)

PHP

// Seed fixture data so offline calls resolve without a live server.
$client = BluefinShieldconexSDK::test([
    "entity" => ["detokenize" => ["test01" => []]],
]);
$detokenizes = $client->Detokenize()->list();

Golang

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

Ruby

# Seed fixture data so offline calls resolve without a live server.
client = BluefinShieldconexSDK.test({
  "entity" => { "detokenize" => { "test01" => {} } },
})
detokenizes = client.Detokenize.list()

Lua

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

C

#include "core/api.h"

BluefinShieldconexSDK* client = test_sdk(NULL, NULL);
PNError* err = NULL;
Entity* detokenize = bluefinshieldconex_detokenize(client, NULL);
voxgig_value* detokenizes = detokenize->vt->list(detokenize, NULL, NULL, &err);
printf("%s\n", voxgig_to_json(detokenizes));

Clojure

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

(def client (api/test-sdk nil nil))
(def detokenizes (e-detokenize/list (api/detokenize client nil) nil nil))
(println detokenizes)

C++

auto client = BluefinShieldconexSDK::testSDK();
Value detokenizes = client->detokenize()->list(Value::undef(), Value::undef());
std::cout << Struct::jsonify(detokenizes) << std::endl;

C#

var client = BluefinShieldconexSDK.TestSDK(null, null);
var detokenizeList = client.Detokenize().List(null);
Console.WriteLine(detokenizeList);

Dart

import 'package:bluefin_shieldconex_sdk/BluefinShieldconexSDK.dart';

Future<void> main() async {
  final client = BluefinShieldconexSDK.test();
  final detokenizes = await client.Detokenize().list();
  print(detokenizes);
}

Elixir

alias BluefinShieldconex.Helpers, as: H

sdk = BluefinShieldconex.test()
detokenize = BluefinShieldconex.detokenize(sdk)
records = BluefinShieldconex.Entity.Detokenize.list(detokenize, 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.detokenize sdk VNoval
  arg <- emptyMap
  ctrl <- emptyMap
  detokenizes <- Sdk.eList ent arg ctrl
  print detokenizes

Java

BluefinShieldconexSDK client = BluefinShieldconexSDK.testSDK(null, null);
Object detokenizeList = client.detokenize(null).list(null, null);
System.out.println(detokenizeList);

JavaScript

const client = BluefinShieldconexSDK.test()
const detokenizes = await client.Detokenize().list()
// detokenizes is an array of bare entities populated with mock data
console.log(detokenizes)

Kotlin

val client = BluefinShieldconexSDK.testSDK(null, null)
val detokenizeList = client.detokenize(null).list(null, null)
println(detokenizeList)

OCaml

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

Perl

use lib 'perl/lib';
use BluefinShieldconexSDK;

my $client = BluefinShieldconexSDK->test(undef, undef);
my $detokenizes = $client->Detokenize->list();
print scalar(@$detokenizes), " records\n";

Rust

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

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

Scala

val client = BluefinShieldconexSDK.testSDK(null, null)
val detokenizeList = client.detokenize(null).list(null, null)
println(detokenizeList)

Swift

let client = BluefinShieldconexSDK.testSDK(nil, nil)
let detokenizeList = try client.Detokenize().list(nil, nil)
print(detokenizeList)

Zig

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

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

Packages

Quickstart

TypeScript

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

const client = new BluefinShieldconexSDK({
  apikey: process.env.BLUEFIN_SHIELDCONEX_APIKEY,
})

// List all detokenizes (returns Detokenize[])
const detokenizes = await client.Detokenize().list()
for (const detokenize of detokenizes) {
  console.log(detokenize)
}

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-mcp .

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

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

Entities

The API exposes 5 entities:

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

Quickstart in other languages

Python

import os
from bluefinshieldconex_sdk import BluefinShieldconexSDK

client = BluefinShieldconexSDK({
    "apikey": os.environ.get("BLUEFIN_SHIELDCONEX_APIKEY"),
})

# List all detokenizes (returns a list, raises on error)
detokenizes = client.Detokenize().list()
for detokenize in detokenizes:
    print(detokenize)

PHP

<?php
require_once 'bluefinshieldconex_sdk.php';

$client = new BluefinShieldconexSDK([
    "apikey" => getenv("BLUEFIN_SHIELDCONEX_APIKEY"),
]);

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

Golang

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

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

// List all detokenizes
detokenizes, err := client.Detokenize(nil).List(nil, nil)
if err != nil {
    panic(err)
}
fmt.Println(detokenizes)

Ruby

require_relative "BluefinShieldconex_sdk"

client = BluefinShieldconexSDK.new({
  "apikey" => ENV["BLUEFIN_SHIELDCONEX_APIKEY"],
})

# List all detokenizes (returns an Array; raises on error)
detokenizes = client.Detokenize.list
puts detokenizes

Lua

local sdk = require("bluefin-shieldconex_sdk")

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

-- List all detokenizes
local detokenizes, err = client:Detokenize():list()
print(detokenizes)

C

#include "core/api.h"

BluefinShieldconexSDK* client = bluefinshieldconex_sdk_new(cmap(1,
    "apikey", v_str(getenv("BLUEFIN_SHIELDCONEX_APIKEY"))));
PNError* err = NULL;

Entity* detokenize = bluefinshieldconex_detokenize(client, NULL);

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

Clojure

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

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

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

C++

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

using namespace sdk;

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

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

C#

using BluefinShieldconexSdk;

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

// List all detokenizes (returns object?, an aggregate list; raises on error)
var detokenizeList = client.Detokenize().List(null);
Console.WriteLine(detokenizeList);

Dart

import 'dart:io';
import 'package:bluefin_shieldconex_sdk/BluefinShieldconexSDK.dart';

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

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

Elixir

alias BluefinShieldconex.Helpers, as: H

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

detokenize = BluefinShieldconex.detokenize(sdk)

# List all detokenize records (raises on error)
records = BluefinShieldconex.Entity.Detokenize.list(detokenize)
IO.inspect(records)

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_APIKEY"
  opts <- jo [("apikey", maybe VNoval VStr mkey)]
  sdk <- Sdk.newSdk opts

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

Java

import voxgig.bluefinshieldconexsdk.core.BluefinShieldconexSDK;

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

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

JavaScript

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

const client = new BluefinShieldconexSDK({
  apikey: process.env.BLUEFIN_SHIELDCONEX_APIKEY,
})

// List all detokenizes (returns an array)
const detokenizes = await client.Detokenize().list()
for (const detokenize of detokenizes) {
  console.log(detokenize)
}

Kotlin

import voxgig.bluefinshieldconexsdk.core.BluefinShieldconexSDK

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

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

OCaml

open Voxgig_struct
open Sdk_helpers

let () =
  let client = Sdk_client.make (jo [("apikey", Str (Sys.getenv "BLUEFIN_SHIELDCONEX_APIKEY"))]) in
  (* List all detokenize records (returns a List value; raises on error) *)
  let detokenizes = (Sdk_client.detokenize client Noval).e_list (empty_map ()) Noval in
  (match detokenizes with List items -> List.iter (fun r -> print_endline (stringify r)) !items | _ -> ());

Perl

use lib 'perl/lib';
use BluefinShieldconexSDK;

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

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

Rust

use bluefin_shieldconex_sdk::{jo, BluefinShieldconexSDK, Value};

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

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

Scala

import voxgig.bluefinshieldconexsdk.core.BluefinShieldconexSDK

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

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

Swift

import BluefinShieldconexSdk

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

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

Zig

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

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

// List all detokenizes (Ok is a Value array, .err on failure)
switch (client.detokenize(h.vnull()).list(h.vnull(), h.vnull())) {
    .ok => |detokenizes| std.debug.print("{s}\n", .{h.stringify(detokenizes)}),
    .err => |e| std.debug.print("list 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 = BluefinShieldconex.direct(sdk, BluefinShieldconex.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://secure-cert.shieldconex.com/api

Security

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

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