TypeScript SDK

Official TypeScript client for the Mployr API

Requirements

Node.js 18+

TypeScript 4.7+ (optional)

Installation

terminal

# Using npm
npm install @mployr/api-client

# Using yarn
yarn add @mployr/api-client

# Using pnpm
pnpm add @mployr/api-client

Quick Start

Initialize the client and make your first API call:

import { MployrClient } from '@mployr/api-client';

// Initialize the client
const client = new MployrClient({
  baseUrl: 'https://api.mployr.com.au/v1',
});

// Authenticate
const auth = await client.auth.login({
  email: 'user@example.com',
  password: 'your-password',
});

// The client automatically uses the token for subsequent requests
// List all people
const people = await client.people.list({ page: 1, per_page: 25 });
console.log(people.data);

// Get a specific person
const person = await client.people.get(42);
console.log(person.data.first_name);

Examples

Create a Person

Create a new employee record with contact information.

const newPerson = await client.people.create({
  first_name: 'John',
  last_name: 'Doe',
  email: 'john.doe@example.com',
  phone: '+61 400 123 456',
  date_of_birth: '1990-05-15',
});

console.log('Created person:', newPerson.data.id);

Update a Person

Update an existing person's information.

const updated = await client.people.update(42, {
  last_name: 'Smith',
  email: 'john.smith@example.com',
});

console.log('Updated:', updated.data);

Pagination

Iterate through all pages of results.

async function getAllPeople() {
  const allPeople: Person[] = [];
  let page = 1;
  let hasMore = true;

  while (hasMore) {
    const response = await client.people.list({
      page,
      per_page: 100,
    });

    allPeople.push(...response.data);
    hasMore = page < response.pagination.last_page;
    page++;
  }

  return allPeople;
}

Error Handling

Handle API errors gracefully.

import { ApiError } from '@mployr/api-client';

try {
  const person = await client.people.get(999);
} catch (error) {
  if (error instanceof ApiError) {
    console.error('API Error:', error.message);
    console.error('Status:', error.status);

    if (error.status === 404) {
      console.log('Person not found');
    } else if (error.status === 401) {
      // Re-authenticate
      await client.auth.login({ email, password });
    }
  }
}

Full API Reference

See all available methods and endpoints in the interactive API reference.

Developers