npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@sinch/fax

v1.2.0

Published

Sinch Fax API

Downloads

2,288

Readme

Sinch Fax SDK for Node.js

This package contains the Sinch Fax SDK for Node.js for use with Sinch APIs. To use it, you will need a Sinch account. Please sign up or log in if you already have one.

Warning: This SDK is currently available for preview purposes only. It should not be used in production environments.

Installation

We recommend to use this SDK as part of the @sinch/sdk-core package in order to make the most out of all the Sinch products.

However, it's still possible to use this SDK standalone is you need to access the Fax API only.

With NPM

npm install @sinch/fax

With Yarn

yarn add @sinch/fax

Usage

Credentials

The Fax API uses the Sinch unified authentication with OAuth2. You will need to provide the following credentials:

  • projectId: can be found in the Account Dashboard
  • keyId:: can be found in your Access key list in the Account Dashboard
  • keySecret: can be found ONLY when generating a new access key: keep it safe!

As part of the Sinch SDK

If you are using this SDK as part of the Sinch SDK (@sinch/sdk-core) you can access it as the fax property of the client that you would have instantiated.

import {
  FaxService,
  Fax,
  SinchClient,
  UnifiedCredentials,
} from '@sinch/sdk-core';

const credentials: UnifiedCredentials = {
  projectId: 'PROJECT_ID',
  keyId: 'KEY_ID',
  keySecret: 'KEY_SECRET',
};

// Access the 'fax' service registered on the Sinch Client
const sinch = new SinchClient(credentials);
const faxService: FaxService = sinch.fax;

// Build the request data
const requestData: Fax.SendFaxRequestData = {
  sendFaxRequestBody: {
    to: '+12015555555',
    contentUrl: 'https://developers.sinch.com/fax/fax.pdf',
    callbackUrl: 'https://yourserver/incomingFax',
  },
};

// Use the 'fax' service registered on the Sinch client
const response = await faxService.faxes.send(requestData);

Standalone

The SDK can be used standalone if you need to use only the Fax APIs.

import {
  UnifiedCredentials,
} from '@sinch/sdk-client';
import {
  FaxService,
  Fax,
} from '@sinch/fax';

const credentials: UnifiedCredentials = {
  projectId: 'PROJECT_ID',
  keyId: 'KEY_ID',
  keySecret: 'KEY_SECRET',
};

// Declare the 'fax' service in a standalone way
const faxService = new FaxService(credentials);

// Build the request data
const requestData: Fax.SendFaxRequestData = {
  sendFaxRequestBody: {
    to: '+12015555555',
    contentUrl: 'https://developers.sinch.com/fax/fax.pdf',
    callbackUrl: 'https://yourserver/incomingFax',
  },
};

// Use the standalone declaration of the 'fax' service
const response = await faxService.faxes.send(requestData);

Promises

All the methods that interact with the Sinch APIs use Promises. You can use await in an async method to wait for the response, or you can resolve them yourself with then() / catch().

// Method 1: Wait for the Promise to complete (you need to be in an 'async' method)
let sendFaxResult: Fax.Fax;
try {
  sendFaxResult = await faxService.faxes.send(requestData);
  console.log(`Fax successfully created at '${sendFaxResult.createTime}'. Status = '${sendFaxResult.status}`);
} catch (error: any) {
  console.error(`ERROR ${error.statusCode}: Impossible to crete the fax sent to ${requestdata.to}.`);
}

// Method 2: Resolve the promise
faxService.faxes.send(requestData)
  .then(response => console.log(`Fax successfully created at '${sendFaxResult.createTime}'. Status = '${sendFaxResult.status}`))
  .catch(error => console.error(`ERROR ${error.statusCode}: Impossible to crete the fax sent to ${requestdata.to}.`));

Contact

Developer Experience team: [email protected]