POSTIVO.PL REST API Client SDK for TypeScript (@postivo/postivo-client)

This package provides the POSTIVO.PL Hybrid Mail Services SDK for Typescript, allowing you to dispatch shipments directly from your application via the POSTIVO.PL platform.

Additional documentation:

Comprehensive documentation of all methods and types is available below in Available Resources and Operations.

You can also refer to the REST API v1 documentation for additional details about this SDK.

SDK Installation

The SDK can be installed with either npm, pnpm, bun or yarn package managers.

NPM

npm add @postivo/postivo-client

PNPM

pnpm add @postivo/postivo-client

Bun

bun add @postivo/postivo-client

Yarn

yarn add @postivo/postivo-client

Note

This package is published with CommonJS and ES Modules (ESM) support.

Requirements

For supported JavaScript runtimes, please consult RUNTIMES.md.

SDK Example Usage

Sending Shipment to single recipient

This example demonstrates simple sending Shipment to a single recipient:

import { Client } from "@postivo/postivo-client";

const client = new Client({
  bearer: "<YOUR API ACCESS TOKEN>",
});

async function run() {
  const result = await client.shipments.dispatch({
    recipients: {
      name: "Jan Nowak",
      name2: "Firma testowa Sp. z o.o.",
      address: "ul. Testowa",
      homeNumber: "23",
      flatNumber: "2",
      postCode: "00-999",
      city: "Warszawa",
      country: "PL",
      phoneNumber: "+48666666666",
      postscript: "Komunikat",
      customId: "1234567890",
    },
    documents: [
      {
        fileStream: "<document_1 content encoded to base64>",
        fileName: "document1.pdf",
      },
      {
        fileStream: "<document_2 content encoded to base64>",
        fileName: "document2.pdf",
      },
    ],
    options: {
      predefinedConfigId: 2670,
    },
  });

  console.log(result);
}

run();

Checking the price of a shipment for single recipient

This example demonstrates simple checking the price of a Shipment to a single recipient:

import { Client } from "@postivo/postivo-client";

const client = new Client({
  bearer: "<YOUR API ACCESS TOKEN>",
});

async function run() {
  const result = await client.shipments.price({
    recipients: {
      name: "Jan Nowak",
      name2: "Firma testowa Sp. z o.o.",
      address: "ul. Testowa",
      homeNumber: "23",
      flatNumber: "2",
      postCode: "00-999",
      city: "Warszawa",
      country: "PL",
      phoneNumber: "+48666666666",
      postscript: "Komunikat",
      customId: "1234567890",
    },
    documents: [
      {
        fileStream: "<document_1 content encoded to base64>",
        fileName: "document1.pdf",
      },
      {
        fileStream: "<document_2 content encoded to base64>",
        fileName: "document2.pdf",
      },
    ],
    options: {
      predefinedConfigId: 2670,
    },
  });

  console.log(result);
}

run();

Authentication

Per-Client Security Schemes

This SDK supports the following security scheme globally:

Name	Type	Scheme	Environment Variable
`bearer`	http	HTTP Bearer	`CLIENT_BEARER`

To authenticate with the API the bearer parameter must be set when initializing the SDK client instance. For example:

import { Client } from "@postivo/postivo-client";

const client = new Client({
  bearer: "<YOUR API ACCESS TOKEN>",
});

async function run() {
  const result = await client.accounts.get();

  console.log(result);
}

run();

Available Resources and Operations

Available methods

accounts

get - Retrieve account details
getSubaccount - Get subaccount details

addressBook.contacts

list - List contacts
add - Add a new contact
get - Retrieve contact details
update - Update a contact
delete - Delete a contact
removeFromGroup - Remove a contact from a group
addToGroup - Add a contact to a group

addressBook.contacts.byExtId

get - Retrieve contact details by EXT_ID
update - Update a contact by EXT_ID
delete - Delete a contact by EXT_ID
removeFromGroup - Remove a contact from a group by EXT_ID
addToGroup - Add a contact to a group by EXT_ID

addressBook.groups

list - List groups
add - Add a new group
get - Retrieve group details
update - Update a group
delete - Delete a group

common

ping - Check API availability and version

metadata

list - List metadata
getPredefinedConfigs - List predefined configs

senders

list - List senders
add - Add a new sender
delete - Delete a sender
verify - Verify sender

shipments

status - Retrieve shipment details with status events
cancel - Cancel shipments
dispatch - Dispatch a new shipment
documents - Retrieve documents related to a shipment
price - Check the shipment price

Standalone functions

All the methods listed above are available as standalone functions. These functions are ideal for use in applications running in the browser, serverless runtimes or other environments where application bundle size is a primary concern. When using a bundler to build your application, all unused functionality will be either excluded from the final bundle or tree-shaken away.

To read more about standalone functions, check FUNCTIONS.md.

Available standalone functions

accountsGet - Retrieve account details
accountsGetSubaccount - Get subaccount details
addressBookContactsAdd - Add a new contact
addressBookContactsAddToGroup - Add a contact to a group
addressBookContactsByExtIdAddToGroup - Add a contact to a group by EXT_ID
addressBookContactsByExtIdDelete - Delete a contact by EXT_ID
addressBookContactsByExtIdGet - Retrieve contact details by EXT_ID
addressBookContactsByExtIdRemoveFromGroup - Remove a contact from a group by EXT_ID
addressBookContactsByExtIdUpdate - Update a contact by EXT_ID
addressBookContactsDelete - Delete a contact
addressBookContactsGet - Retrieve contact details
addressBookContactsList - List contacts
addressBookContactsRemoveFromGroup - Remove a contact from a group
addressBookContactsUpdate - Update a contact
addressBookGroupsAdd - Add a new group
addressBookGroupsDelete - Delete a group
addressBookGroupsGet - Retrieve group details
addressBookGroupsList - List groups
addressBookGroupsUpdate - Update a group
commonPing - Check API availability and version
metadataGetPredefinedConfigs - List predefined configs
metadataList - List metadata
sendersAdd - Add a new sender
sendersDelete - Delete a sender
sendersList - List senders
sendersVerify - Verify sender
shipmentsCancel - Cancel shipments
shipmentsDispatch - Dispatch a new shipment
shipmentsDocuments - Retrieve documents related to a shipment
shipmentsPrice - Check the shipment price
shipmentsStatus - Retrieve shipment details with status events

Retries

Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK.

To change the default retry strategy for a single API call, simply provide a retryConfig object to the call:

import { Client } from "@postivo/postivo-client";

const client = new Client({
  bearer: "<YOUR API ACCESS TOKEN>",
});

async function run() {
  const result = await client.accounts.get({
    retries: {
      strategy: "backoff",
      backoff: {
        initialInterval: 1,
        maxInterval: 50,
        exponent: 1.1,
        maxElapsedTime: 100,
      },
      retryConnectionErrors: false,
    },
  });

  console.log(result);
}

run();

If you'd like to override the default retry strategy for all operations that support retries, you can provide a retryConfig at SDK initialization:

import { Client } from "@postivo/postivo-client";

const client = new Client({
  retryConfig: {
    strategy: "backoff",
    backoff: {
      initialInterval: 1,
      maxInterval: 50,
      exponent: 1.1,
      maxElapsedTime: 100,
    },
    retryConnectionErrors: false,
  },
  bearer: "<YOUR API ACCESS TOKEN>",
});

async function run() {
  const result = await client.accounts.get();

  console.log(result);
}

run();

Error Handling

ClientError is the base class for all HTTP error responses. It has the following properties:

Property	Type	Description
`error.message`	`string`	Error message
`error.statusCode`	`number`	HTTP response status code eg `404`
`error.headers`	`Headers`	HTTP response headers
`error.body`	`string`	HTTP body. Can be empty string if no body is returned.
`error.rawResponse`	`Response`	Raw HTTP response
`error.data$`		Optional. Some errors may contain structured data. See Error Classes.

Example

import { Client } from "@postivo/postivo-client";
import * as errors from "@postivo/postivo-client/models/errors";

const client = new Client({
  bearer: "<YOUR API ACCESS TOKEN>",
});

async function run() {
  try {
    const result = await client.accounts.get();

    console.log(result);
  } catch (error) {
    // The base class for HTTP error responses
    if (error instanceof errors.ClientError) {
      console.log(error.message);
      console.log(error.statusCode);
      console.log(error.body);
      console.log(error.headers);

      // Depending on the method different errors may be thrown
      if (error instanceof errors.ErrorResponse) {
        console.log(error.data$.type); // string
        console.log(error.data$.status); // number
        console.log(error.data$.title); // string
        console.log(error.data$.detail); // string
        console.log(error.data$.code); // string
      }
    }
  }
}

run();

Error Classes

Primary errors:

ClientError: The base class for HTTP error responses.
- ErrorResponse: Problem Details object (RFC 9457) describing the error.

Less common errors (6)

Network errors:

ConnectionError: HTTP client was unable to make a request to a server.
RequestTimeoutError: HTTP request timed out due to an AbortSignal signal.
RequestAbortedError: HTTP request was aborted by the client.
InvalidRequestError: Any input used to create a request is invalid.
UnexpectedClientError: Unrecognised or unexpected error.

Inherit from ClientError:

ResponseValidationError: Type mismatch between the data returned from the server and the structure expected by the SDK. See error.rawValue for the raw value and error.pretty() for a nicely formatted multi-line string.

Server Selection

Select Server by Name

You can override the default server globally by passing a server name to the server: keyof typeof ServerList optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the names associated with the available servers:

Name	Server	Description
`prod`	`https://api.postivo.pl/rest/v1`	Production system
`sandbox`	`https://api.postivo.pl/rest-sandbox/v1`	Test system (SANDBOX)

Example

import { Client } from "@postivo/postivo-client";

const client = new Client({
  server: "sandbox",
  bearer: "<YOUR API ACCESS TOKEN>",
});

async function run() {
  const result = await client.accounts.get();

  console.log(result);
}

run();

Override Server URL Per-Client

The default server can also be overridden globally by passing a URL to the serverURL: string optional parameter when initializing the SDK client instance. For example:

import { Client } from "@postivo/postivo-client";

const client = new Client({
  serverURL: "https://api.postivo.pl/rest/v1",
  bearer: "<YOUR API ACCESS TOKEN>",
});

async function run() {
  const result = await client.accounts.get();

  console.log(result);
}

run();

Custom HTTP Client

The TypeScript SDK makes API calls using an HTTPClient that wraps the native Fetch API. This client is a thin wrapper around fetch and provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle errors and response.

The HTTPClient constructor takes an optional fetcher argument that can be used to integrate a third-party HTTP client or when writing tests to mock out the HTTP client and feed in fixtures.

The following example shows how to use the "beforeRequest" hook to to add a custom header and a timeout to requests and how to use the "requestError" hook to log errors:

import { Client } from "@postivo/postivo-client";
import { HTTPClient } from "@postivo/postivo-client/lib/http";

const httpClient = new HTTPClient({
  // fetcher takes a function that has the same signature as native `fetch`.
  fetcher: (request) => {
    return fetch(request);
  }
});

httpClient.addHook("beforeRequest", (request) => {
  const nextRequest = new Request(request, {
    signal: request.signal || AbortSignal.timeout(5000)
  });

  nextRequest.headers.set("x-custom-header", "custom value");

  return nextRequest;
});

httpClient.addHook("requestError", (error, request) => {
  console.group("Request Error");
  console.log("Reason:", `${error}`);
  console.log("Endpoint:", `${request.method} ${request.url}`);
  console.groupEnd();
});

const sdk = new Client({ httpClient: httpClient });

Debugging

You can setup your SDK to emit debug logs for SDK requests and responses.

You can pass a logger that matches console's interface as an SDK option.

Warning

Beware that debug logging will reveal secrets, like API tokens in headers, in log messages printed to a console or files. It's recommended to use this feature only during local development and not in production.

import { Client } from "@postivo/postivo-client";

const sdk = new Client({ debugLogger: console });

You can also enable a default debug logger by setting an environment variable CLIENT_DEBUG to true.

Development

Maturity

This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.

Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release.

Name		Name	Last commit message	Last commit date
Latest commit History 8 Commits
.devcontainer		.devcontainer
.github/workflows		.github/workflows
docs		docs
examples		examples
src		src
.gitattributes		.gitattributes
.gitignore		.gitignore
.npmignore		.npmignore
CONTRIBUTING.md		CONTRIBUTING.md
FUNCTIONS.md		FUNCTIONS.md
LICENSE		LICENSE
README.md		README.md
RUNTIMES.md		RUNTIMES.md
USAGE.md		USAGE.md
eslint.config.mjs		eslint.config.mjs
jsr.json		jsr.json
package-lock.json		package-lock.json
package.json		package.json
tsconfig.json		tsconfig.json

License

postivo/typescript-client

Folders and files

Latest commit

History

Repository files navigation

POSTIVO.PL REST API Client SDK for TypeScript (@postivo/postivo-client)

Additional documentation:

Table of Contents

SDK Installation

NPM

PNPM

Bun

Yarn

Requirements

SDK Example Usage

Sending Shipment to single recipient

Checking the price of a shipment for single recipient

Authentication

Per-Client Security Schemes

Available Resources and Operations

Standalone functions

Retries

Error Handling

Example

Error Classes

Server Selection

Select Server by Name

Example

Override Server URL Per-Client

Custom HTTP Client

Debugging

Development

Maturity

Contributions

About

Resources

License

Contributing

Uh oh!

Stars

Watchers

Forks

Languages