@emitfy/sdk
v0.7.0
Published
Official Emitfy API SDK for Node.js / TypeScript (OpenAPI-typed)
Maintainers
Readme
@emitfy/sdk
Official Emitfy API SDK for Node.js / TypeScript.
Tipagem alinhada ao OpenAPI + facade Emitfy amigável.
Install
npm i @emitfy/sdkUsage
import { Emitfy, type WebhookCreate } from '@emitfy/sdk'
const emitfy = new Emitfy({
apiKey: process.env.EMITFY_API_KEY!,
apiSecret: process.env.EMITFY_API_SECRET!
})
const body: WebhookCreate = {
url: 'https://seu-sistema.com/webhooks/emitfy',
events: { invoice: ['nfse.authorized'], cte: [] }
}
await emitfy.webhooks.create(body)
const company = emitfy.company(process.env.EMITFY_COMPANY_ID!)
await company.nfse.create(
{
name: 'Consultoria',
category: 'consulting',
serviceDescription: 'Consultoria em tecnologia',
cityServiceCode: '02800',
federalServiceCode: '01.05',
iss: { rate: 2.9, isWithheld: false },
amount: 100,
borrower: {
taxId: '12.345.678/0001-90',
name: 'Cliente LTDA',
email: '[email protected]'
}
},
'pedido-001'
)Typed OpenAPI surface
- Facade:
emitfy.webhooks,emitfy.companies,emitfy.company(id).nfse|nfe|… - Types:
import type { WebhookCreate, NfseCreateData, … } from '@emitfy/sdk' - Low-level operations:
import { operations } from '@emitfy/sdk'(operations.nfseCreate, …)
Method map
| SDK | HTTP |
| ------------------------------- | -------------------------------------- |
| emitfy.webhooks.* | /v1/webhooks |
| emitfy.companies.* | /v1/companies |
| company.nfse\|nfe\|nfce\|cte | /v1/companies/:id/{resource} |
| company.customers\|products | /v1/companies/:id/{resource} |
| company.invoices.update\|emit | PATCH / POST .../invoices/:id/emit |
| company.receivedNfes | /v1/companies/:id/received-nfes |
Docs: https://docs.emitfy.com/sdks
OpenAPI: https://api.emitfy.com/openapi.yaml
