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

zdk

v0.5.0

Published

Kit de desenvolvimento Zappy

Downloads

209

Readme

ZDK (Kit de Desenvolvimento Zappy)

NPM Version License

ZDK é um SDK poderoso projetado para simplificar interações com a API da Zappy, permitindo gerenciar conexões, contatos, mensagens, filas, tags, tickets e usuários.

Instalação

Instale o ZDK via npm:

npm install zdk

Ou usando Yarn:

yarn add zdk

Configuração

Para inicializar o Zdk, você pode fornecer rootUrl e token como argumentos ou configurá-los como variáveis de ambiente. Ambos rootUrl e token são argumentos opcionais se as variáveis de ambiente ZAPPY_URL e ZAPPY_TOKEN estiverem configuradas.

Usando argumentos

const { Zdk } = require('zdk');

const zdk = new Zdk("https://api-example.chat", "TOKEN");

Usando variáveis de ambiente

Alternativamente, você pode configurar as variáveis de ambiente para evitar passar rootUrl e token diretamente no seu código:

export ZAPPY_URL="https://api-example.chat"
export ZAPPY_TOKEN="TOKEN"

Com as variáveis de ambiente configuradas, você pode inicializar a classe Zdk sem argumentos:

const { Zdk } = require('zdk');

const zdk = new Zdk();

Visão Geral

ZappyApi

A classe ZappyApi é a classe base para realizar solicitações de API de baixo nível. Ela inclui o método makeRequest para solicitações HTTP gerais.

makeRequest(método, endpoint, corpo?, tipoDeConteúdo?): Envia uma solicitação para o endpoint especificado com corpo e tipoDeConteúdo opcionais. Parâmetros: método: Método HTTP (GET, POST, etc.). endpoint: Endpoint da API (string). corpo (opcional): Payload da solicitação. tipoDeConteúdo (opcional): Tipo MIME, por exemplo, application/json.

Zdk

A classe Zdk estende ZapApi e inclui propriedades para gerenciar recursos principais da API Zappy. Cada propriedade é uma instância de uma classe especializada que fornece métodos específicos para manipulação de dados e operações.

Propriedades

| Propriedade | Descrição | | ----------- | ------------------------------------------------------ | | connections | Gerencia conexões da instância | | contacts | Gerencia contatos, como buscar e criar novos contatos. | | messages | Gerencia operações relacionadas a mensagens. | | queues | Gerencia filas para organização de atendimento. | | tags | Gerencia funcionalidade de tags para categorização. | | tickets | Gerencia tickets de atendimento. | | users | Acessa métodos relacionados a usuários do sistema. |

Documentação completa