@opvious/api

Opvious API

This package contains auto-generated types for Opvious' GraphQL API. Consider also using our higher level SDK.

Quickstart

npm i @opvious/api

You'll need an API access token to call most SDK methods. Once you have it, you can use this package to emit type-safe API requests.

import {createSdk, createGraphqlSdk} from '@opvious/api';

// Typesafe REST SDK (data operations)
const sdk = createSdk('https://api.beta.opvious.io', {
  headers: {authorization: process.env.OPVIOUS_TOKEN},
});

// Typesafe GraphQL SDK (metadata operations)
const graphqlSdk = createGraphqlSdk(sdk);

Resources

This package includes the following resource files:

• OpenAPI specification (resources/openapi.yaml);
• GraphQL schema (resources/graphql/schema.gql);
• GraphQL operations (resources/graphql/**/*.graphql).