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

REST

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

// Typesafe SDK
const sdk = createSdk('https://api.beta.opvious.io');

GraphQL

import {GraphQLClient} from 'graphql-request';
import {createGraphqlSdk} from '@opvious/api';

// Underlying generic GraphQL client
const client = new GraphQLClient('https://api.beta.opvious.io/graphql', {
  headers: {authorization: process.env.OPVIOUS_TOKEN},
});

// Typesafe GraphQL SDK
const graphqlSdk = createGraphqlSdk(
  <R, V>(query: string, vars: V) => client.rawRequest<R, V>(query, vars)
);

Resources

This package includes the following resource files:

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