[](https://buildwithfern.com?utm_source=github&utm_medium=github&utm_campaign=readme&utm_source=https%3A%2F%2Fgithub.com%2Fpinnacle-dev%2Frcs-js) [
The Pinnacle TypeScript library provides convenient access to the Pinnacle APIs from TypeScript.
``sh`
npm i -s rcs-js
A full reference for this library is available here.
Instantiate and use the client with the following:
`typescript
import { PinnacleClient } from "rcs-js";
const client = new PinnacleClient({ apiKey: "YOUR_API_KEY" });
await client.brands.autofill({
additional_info: "A developer-friendly, compliant API for SMS, MMS, and RCS, built to scale real conversations.",
name: "Pinnacle",
options: {
forceReload: true
},
website: "https://www.pinnacle.sh"
});
`
The SDK exports all request and response types as TypeScript interfaces. Simply import them with the
following namespace:
`typescript
import { Pinnacle } from "rcs-js";
const request: Pinnacle.AutofillBrandParams = {
...
};
`
When the API returns a non-success status code (4xx or 5xx response), a subclass of the following error
will be thrown.
`typescript
import { PinnacleError } from "rcs-js";
try {
await client.brands.autofill(...);
} catch (err) {
if (err instanceof PinnacleError) {
console.log(err.statusCode);
console.log(err.message);
console.log(err.body);
console.log(err.rawResponse);
}
}
`
If you would like to send additional headers as part of the request, use the headers request option.
`typescript`
const response = await client.brands.autofill(..., {
headers: {
'X-Custom-Header': 'custom value'
}
});
If you would like to send additional query string parameters as part of the request, use the queryParams request option.
`typescript`
const response = await client.brands.autofill(..., {
queryParams: {
'customQueryParamKey': 'custom query param value'
}
});
The SDK is instrumented with automatic retries with exponential backoff. A request will be retried as long
as the request is deemed retryable and the number of retry attempts has not grown larger than the configured
retry limit (default: 2).
A request is deemed retryable when any of the following HTTP status codes is returned:
- 408 (Timeout)
- 429 (Too Many Requests)
- 5XX (Internal Server Errors)
Use the maxRetries request option to configure this behavior.
`typescript`
const response = await client.brands.autofill(..., {
maxRetries: 0 // override maxRetries at the request level
});
The SDK defaults to a 60 second timeout. Use the timeoutInSeconds option to configure this behavior.
`typescript`
const response = await client.brands.autofill(..., {
timeoutInSeconds: 30 // override timeout to 30s
});
The SDK allows users to abort requests at any point by passing in an abort signal.
`typescript`
const controller = new AbortController();
const response = await client.brands.autofill(..., {
abortSignal: controller.signal
});
controller.abort(); // aborts the request
The SDK provides access to raw response data, including headers, through the .withRawResponse() method..withRawResponse()
The method returns a promise that results to an object with a data and a rawResponse property.
`typescript
const { data, rawResponse } = await client.brands.autofill(...).withRawResponse();
console.log(data);
console.log(rawResponse.headers['X-My-Header']);
`
The SDK supports logging. You can configure the logger by passing in a logging object to the client options.
`typescript
import { PinnacleClient, logging } from "rcs-js";
const client = new PinnacleClient({
...
logging: {
level: logging.LogLevel.Debug, // defaults to logging.LogLevel.Info
logger: new logging.ConsoleLogger(), // defaults to ConsoleLogger
silent: false, // defaults to true, set to false to enable logging
}
});
`
The object can have the following properties:level
- : The log level to use. Defaults to logging.LogLevel.Info.logger
- : The logger to use. Defaults to a logging.ConsoleLogger.silent
- : Whether to silence the logger. Defaults to true.
The level property can be one of the following values:logging.LogLevel.Debug
-
-
-
-
To provide a custom logger, you can pass in an object that implements the logging.ILogger interface.
Custom logger examples
Here's an example using the popular winston logging library.`ts
import winston from 'winston';
const winstonLogger = winston.createLogger({...});
const logger: logging.ILogger = {
debug: (msg, ...args) => winstonLogger.debug(msg, ...args),
info: (msg, ...args) => winstonLogger.info(msg, ...args),
warn: (msg, ...args) => winstonLogger.warn(msg, ...args),
error: (msg, ...args) => winstonLogger.error(msg, ...args),
};
`
Here's an example using the popular pino logging library.
`ts
import pino from 'pino';
const pinoLogger = pino({...});
const logger: logging.ILogger = {
debug: (msg, ...args) => pinoLogger.debug(args, msg),
info: (msg, ...args) => pinoLogger.info(args, msg),
warn: (msg, ...args) => pinoLogger.warn(args, msg),
error: (msg, ...args) => pinoLogger.error(args, msg),
};
`
The SDK works in the following runtimes:
- Node.js 18+
- Vercel
- Cloudflare Workers
- Deno v1.25+
- Bun 1.0+
- React Native
The SDK provides a way for you to customize the underlying HTTP client / Fetch function. If you're running in an
unsupported environment, this provides a way for you to break glass and ensure the SDK works.
`typescript
import { PinnacleClient } from "rcs-js";
const client = new PinnacleClient({
...
fetcher: // provide your implementation here
});
``
While we value open-source contributions to this SDK, this library is generated programmatically.
Additions made directly to this library would have to be moved over to our generation code,
otherwise they would be overwritten upon the next generated release. Feel free to open a PR as
a proof of concept, but know that we will not be able to merge it as-is. We suggest opening
an issue first to discuss with us!
On the other hand, contributions to the README are always very welcome!