@stackguardian/sg-sdk

sg-sdk is a fern generated Node.js client library for StackGuardian API that provides a simple way to interact with the API.

Documentation

API reference can be found here.

Installation

npm install @stackguardian/sg-sdk

Usage

import { SgClient, SgEnvironment } from '@stackguardian/sg-sdk';
const SG_API_KEY = process.env.SG_APIKEY;
const SG_ORG_ID = "your-org-id";

const client = new SgClient({
    apiKey: "apikey " + SG_API_KEY,
});

(async () => {
    const myOrgs = await client.organizations.readOrganization(SG_ORG_ID);
    console.log(myOrgs);
})();

More examples can be found in tests directory.

SDK Status

This SDK is currently under development and may undergo significant changes. Future updates could include breaking changes as we work to improve and stabilize it. Additionally, some endpoints have not been fully tested, so you may encounter unexpected behavior. If you notice any schema validation issues, especially if the response does not match the expected schema, we kindly ask you to report them.

Contributing

We appreciate open-source contributions to this SDK! Since the code is generated programmatically, direct changes will be overwritten in future releases. If you have an idea, please open an issue to discuss it first. Contributions to the README and tests are always welcome!