planship-management-fetch-client

Fetch client for Planship Management API. Autogerated using https://github.com/OpenAPITools/openapi-generator/blob/master/docs/generators/typescript-fetch.md

Autogenerate and publish to npmjs

Pre-requisite: Install openapi-generator

Run the Planship API locally and run the following command to autogenerate the client code:

pnpm openapi-gen

Compile ts code to a distributable js and rebuild the docs

pnpm build
pnpm build-docs

Increment the package version in package.json, commit all changes (required), and run the following command to publish:

pnpm publish

Local dev

Steps to get started in a local dev environment. This assumes that your other project is using pnpm.

pnpm install
pnpm build
pnpm link --global

Go to your target project and run the follow to link the client library as a dependency:

pnpm link --global planship-management-fetch-client

Sample code to import, get a list of orgs from Planship, and print the result. This assumes that Planship is running on localhost.

import { OrganizationsApi } from 'planship-management-fetch-client';

let organizationsApi = new OrganizationsApi();
organizationsApi.listOrganizations().then((response) => {console.dir(response)});

API classes documentation can be found here.