Sunwise BOTY API Client

Description

This package provides a client for interacting with the Sunwise BOTY API. It allows you to easily make requests to the API and handle responses. It is built using TypeScript and Axios, and it includes type definitions for all the endpoints and data structures used by the API.

API Documentation

For complete API documentation, visit here

Installation

To install the package you can use npm, pnpm or any other package manager that supports npm packages.

npm install @sunwise-clients/boty

pnpm install @sunwise-clients/boty

Usage

It exposes the client (an Axios instance) and also exports the types and schemas used by the API.

import { client } from "@sunwise-clients/boty";
import { PaginationReportSchema } from "@sunwise-clients/boty";

All the endpoints are available as methods on the client object.

import { projectsProjectsUploadDocuments } from "@sunwise-clients/boty";

const response = await reportsGetFunnelsList();

Authentication

To authenticate the client you can use the setConfig method.

import { client } from "@sunwise-clients/boty";

client.setConfig({
  auth: () => "<my_token>", // Required for authentication
  baseURL: "https://example.com", // Optional
});

It uses the "@hey-api/client-axios" package under the hood to create the client. You can find more information about the package here.

Types and Schemas

The package also exports the types and schemas used by the API, which can be useful for TypeScript users and for validating data structures.

import { RetrieveReport } from "@sunwise-clients/boty";

// Example usage
const report: RetrieveReport = {
  id: "project_id",
  // other fields...
};

Issues and Support

If you encounter any issues or have questions, please contact our support team at [email protected].