api-sdk-js

A reusable TypeScript SDK for consuming enterprise APIs, including Postcode Search and Business Search.

Installation

npm install api-sdk-js

Usage

import { getOAuthToken, ApiSDK } from "api-sdk-js";

const auth = await getOAuthToken({
  // authUrl: "http://localhost:4000",  // optional
  clientId: "mock-client-id",
  clientSecret: "mock-client-secret",
});

const sdk = new ApiSDK({
  // baseURL: "http://localhost:4000", // optional
  token: auth.access_token,
});

const address = await sdk.postcode.getAddress({
  postcode: "3000",
});

console.log(address);

const businesses = await sdk.business.searchBusiness({
  keyword: "Dental",
  suburb: "Sydney",
});

console.log(businesses);

SDK API

getOAuthToken(config)

• authUrl?: string — OAuth server base URL.
• clientId: string
• clientSecret: string
• returns Promise<OAuthResponse>

new ApiSDK(config)

• baseURL?: string — API base URL.
• token: string — Bearer access token.

Postcode

• sdk.postcode.getAddress(request)
  • request.postcode: string
  • returns Promise<Address>

Business

• sdk.business.searchBusiness(request)
  • request.keyword: string
  • request.suburb?: string
  • returns Promise<Business[]>

Types

Address

• postcode: string | null
• suburb: string | null
• state: string | null

Business

• id: number
• name: string
• address: string

OAuthResponse

• access_token: string
• token_type: string
• expires_in: number

Build

npm run build

Package

• main: dist/index.js
• module: dist/index.mjs
• types: dist/index.d.ts

License

MIT