@pronesoft-rd/ecf-sdk 0.0.1 → 0.0.3

package/docs/WebhookConfigResponse.md

@@ -1,7 +1,6 @@
 
 # WebhookConfigResponse
 
-A registered webhook configuration.
 
 ## Properties
 
@@ -9,23 +8,27 @@ Name | Type
 ------------ | -------------
 `id` | string
 `url` | string
+`description` | string
 `eventTypes` | [Array<WebhookEventType>](WebhookEventType.md)
 `isActive` | boolean
 `createdAt` | Date
+`updatedAt` | Date
 `lastTriggeredAt` | Date
 
 ## Example
 
 ```typescript
-import type { WebhookConfigResponse } from '@pronesoft/ecf-sdk'
+import type { WebhookConfigResponse } from '@pronesoft-rd/ecf-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
-  "id": null,
+  "id": webhook_sbx_1234567890abcdef,
   "url": null,
+  "description": null,
   "eventTypes": null,
   "isActive": null,
   "createdAt": null,
+  "updatedAt": null,
   "lastTriggeredAt": null,
 } satisfies WebhookConfigResponse
 

package/docs/WebhookConfigurationApi.md

@@ -4,19 +4,17 @@ All URIs are relative to *https://api.ecf.sandbox.pronesoft.com/api/v1*
 
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
-| [**createWebhook**](WebhookConfigurationApi.md#createwebhook) | **POST** /{rnc}/webhooks | Register new webhook |
-| [**deleteWebhook**](WebhookConfigurationApi.md#deletewebhook) | **DELETE** /{rnc}/webhooks/{webhookId} | Delete webhook configuration |
+| [**getWebhook**](WebhookConfigurationApi.md#getwebhook) | **GET** /{rnc}/webhooks/{webhookId} | Get webhook details |
+| [**getWebhookStats**](WebhookConfigurationApi.md#getwebhookstats) | **GET** /{rnc}/webhooks/{webhookId}/stats | Get webhook delivery statistics |
 | [**listWebhooks**](WebhookConfigurationApi.md#listwebhooks) | **GET** /{rnc}/webhooks | List webhook configurations |
 
 
 
-## createWebhook
+## getWebhook
 
-> WebhookConfigResponse createWebhook(rnc, createWebhookConfig)
+> WebhookConfigDetail getWebhook(rnc, webhookId)
 
-Register new webhook
-
-Registers a URL to receive real-time event notifications for the given RNC. You can subscribe to one or more `WebhookEventType` values.  Optionally provide a `secret` (min 16 chars) — Pronesoft will sign webhook payloads with HMAC-SHA256 using this secret so you can verify authenticity on your end. 
+Get webhook details
 
 ### Example
 
@@ -24,11 +22,11 @@ Registers a URL to receive real-time event notifications for the given RNC. You
 import {
   Configuration,
   WebhookConfigurationApi,
-} from '@pronesoft/ecf-sdk';
-import type { CreateWebhookRequest } from '@pronesoft/ecf-sdk';
+} from '@pronesoft-rd/ecf-sdk';
+import type { GetWebhookRequest } from '@pronesoft-rd/ecf-sdk';
 
 async function example() {
-  console.log("🚀 Testing @pronesoft/ecf-sdk SDK...");
+  console.log("🚀 Testing @pronesoft-rd/ecf-sdk SDK...");
   const config = new Configuration({ 
     // To configure OAuth2 access token for authorization: oauth2 application
     accessToken: "YOUR ACCESS TOKEN",
@@ -38,14 +36,14 @@ async function example() {
   const api = new WebhookConfigurationApi(config);
 
   const body = {
-    // string | RNC (Registro Nacional del Contribuyente) of the company. Must be 9 digits (persona jurídica) or 11 digits (persona física). 
-    rnc: 130000001,
-    // CreateWebhookConfig
-    createWebhookConfig: {"url":"https://myapp.com/webhooks/ecf","eventTypes":["document.status_changed","sequence.depleted"],"description":"Main notification endpoint","secret":"my-super-secret-value-here"},
-  } satisfies CreateWebhookRequest;
+    // string | Company RNC (9 or 11 digits). In Sandbox use SBX-prefixed values.
+    rnc: 133190907,
+    // string
+    webhookId: webhookId_example,
+  } satisfies GetWebhookRequest;
 
   try {
-    const data = await api.createWebhook(body);
+    const data = await api.getWebhook(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -61,12 +59,12 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **rnc** | `string` | RNC (Registro Nacional del Contribuyente) of the company. Must be 9 digits (persona jurídica) or 11 digits (persona física).  | [Defaults to `undefined`] |
-| **createWebhookConfig** | [CreateWebhookConfig](CreateWebhookConfig.md) |  | |
+| **rnc** | `string` | Company RNC (9 or 11 digits). In Sandbox use SBX-prefixed values. | [Defaults to `undefined`] |
+| **webhookId** | `string` |  | [Defaults to `undefined`] |
 
 ### Return type
 
-[**WebhookConfigResponse**](WebhookConfigResponse.md)
+[**WebhookConfigDetail**](WebhookConfigDetail.md)
 
 ### Authorization
 
@@ -74,27 +72,24 @@ example().catch(console.error);
 
 ### HTTP request headers
 
-- **Content-Type**: `application/json`
+- **Content-Type**: Not defined
 - **Accept**: `application/json`
 
 
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **201** | Webhook registered successfully |  -  |
-| **400** | Validation error (400 Bad Request). The request body or parameters did not pass validation. Check the `message` field for details.  |  -  |
-| **401** | Authorization error. The token is missing, expired, or invalid. Call `POST /oauth/token` to get a new token.  |  -  |
+| **200** | Webhook details |  -  |
+| **401** | Token missing, expired, or invalid. Call POST /oauth/token to renew. |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
 
-## deleteWebhook
-
-> deleteWebhook(rnc, webhookId)
+## getWebhookStats
 
-Delete webhook configuration
+> WebhookStats getWebhookStats(rnc, webhookId, period)
 
-Removes a registered webhook by its ID.
+Get webhook delivery statistics
 
 ### Example
 
@@ -102,11 +97,11 @@ Removes a registered webhook by its ID.
 import {
   Configuration,
   WebhookConfigurationApi,
-} from '@pronesoft/ecf-sdk';
-import type { DeleteWebhookRequest } from '@pronesoft/ecf-sdk';
+} from '@pronesoft-rd/ecf-sdk';
+import type { GetWebhookStatsRequest } from '@pronesoft-rd/ecf-sdk';
 
 async function example() {
-  console.log("🚀 Testing @pronesoft/ecf-sdk SDK...");
+  console.log("🚀 Testing @pronesoft-rd/ecf-sdk SDK...");
   const config = new Configuration({ 
     // To configure OAuth2 access token for authorization: oauth2 application
     accessToken: "YOUR ACCESS TOKEN",
@@ -116,14 +111,16 @@ async function example() {
   const api = new WebhookConfigurationApi(config);
 
   const body = {
-    // string | RNC (Registro Nacional del Contribuyente) of the company. Must be 9 digits (persona jurídica) or 11 digits (persona física). 
-    rnc: 130000001,
-    // string | The unique ID of the webhook to delete.
+    // string | Company RNC (9 or 11 digits). In Sandbox use SBX-prefixed values.
+    rnc: 133190907,
+    // string
     webhookId: webhookId_example,
-  } satisfies DeleteWebhookRequest;
+    // 'today' | 'week' | 'month' | 'all' (optional)
+    period: period_example,
+  } satisfies GetWebhookStatsRequest;
 
   try {
-    const data = await api.deleteWebhook(body);
+    const data = await api.getWebhookStats(body);
     console.log(data);
   } catch (error) {
     console.error(error);
@@ -139,12 +136,13 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **rnc** | `string` | RNC (Registro Nacional del Contribuyente) of the company. Must be 9 digits (persona jurídica) or 11 digits (persona física).  | [Defaults to `undefined`] |
-| **webhookId** | `string` | The unique ID of the webhook to delete. | [Defaults to `undefined`] |
+| **rnc** | `string` | Company RNC (9 or 11 digits). In Sandbox use SBX-prefixed values. | [Defaults to `undefined`] |
+| **webhookId** | `string` |  | [Defaults to `undefined`] |
+| **period** | `today`, `week`, `month`, `all` |  | [Optional] [Defaults to `'month'`] [Enum: today, week, month, all] |
 
 ### Return type
 
-`void` (Empty response body)
+[**WebhookStats**](WebhookStats.md)
 
 ### Authorization
 
@@ -159,9 +157,8 @@ example().catch(console.error);
 ### HTTP response details
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
-| **200** | Webhook deleted successfully |  -  |
-| **401** | Authorization error. The token is missing, expired, or invalid. Call `POST /oauth/token` to get a new token.  |  -  |
-| **404** | Webhook not found |  -  |
+| **200** | Webhook delivery statistics |  -  |
+| **401** | Token missing, expired, or invalid. Call POST /oauth/token to renew. |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
@@ -172,7 +169,7 @@ example().catch(console.error);
 
 List webhook configurations
 
-Returns all registered webhooks for the given RNC.
+Returns all webhooks for the RNC. Webhooks are created from the Dashboard UI only.
 
 ### Example
 
@@ -180,11 +177,11 @@ Returns all registered webhooks for the given RNC.
 import {
   Configuration,
   WebhookConfigurationApi,
-} from '@pronesoft/ecf-sdk';
-import type { ListWebhooksRequest } from '@pronesoft/ecf-sdk';
+} from '@pronesoft-rd/ecf-sdk';
+import type { ListWebhooksRequest } from '@pronesoft-rd/ecf-sdk';
 
 async function example() {
-  console.log("🚀 Testing @pronesoft/ecf-sdk SDK...");
+  console.log("🚀 Testing @pronesoft-rd/ecf-sdk SDK...");
   const config = new Configuration({ 
     // To configure OAuth2 access token for authorization: oauth2 application
     accessToken: "YOUR ACCESS TOKEN",
@@ -194,8 +191,8 @@ async function example() {
   const api = new WebhookConfigurationApi(config);
 
   const body = {
-    // string | RNC (Registro Nacional del Contribuyente) of the company. Must be 9 digits (persona jurídica) or 11 digits (persona física). 
-    rnc: 130000001,
+    // string | Company RNC (9 or 11 digits). In Sandbox use SBX-prefixed values.
+    rnc: 133190907,
   } satisfies ListWebhooksRequest;
 
   try {
@@ -215,7 +212,7 @@ example().catch(console.error);
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
-| **rnc** | `string` | RNC (Registro Nacional del Contribuyente) of the company. Must be 9 digits (persona jurídica) or 11 digits (persona física).  | [Defaults to `undefined`] |
+| **rnc** | `string` | Company RNC (9 or 11 digits). In Sandbox use SBX-prefixed values. | [Defaults to `undefined`] |
 
 ### Return type
 
@@ -235,7 +232,7 @@ example().catch(console.error);
 | Status code | Description | Response headers |
 |-------------|-------------|------------------|
 | **200** | List of webhook configurations |  -  |
-| **401** | Authorization error. The token is missing, expired, or invalid. Call `POST /oauth/token` to get a new token.  |  -  |
+| **401** | Token missing, expired, or invalid. Call POST /oauth/token to renew. |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 

package/docs/WebhookEventType.md

@@ -1,7 +1,6 @@
 
 # WebhookEventType
 
-Type of event that triggers a webhook notification.
 
 ## Properties
 
@@ -11,7 +10,7 @@ Name | Type
 ## Example
 
 ```typescript
-import type { WebhookEventType } from '@pronesoft/ecf-sdk'
+import type { WebhookEventType } from '@pronesoft-rd/ecf-sdk'
 
 // TODO: Update the object below with actual values
 const example = {

package/docs/WebhookNotificationPayload.md

@@ -1,7 +1,7 @@
 
 # WebhookNotificationPayload
 
-Payload sent to your registered webhook URL when an event occurs. Verify authenticity using HMAC-SHA256 with your webhook `secret`. 
+Payload sent to your webhook URL when an event occurs. Validate using header X-Webhook-Signature: sha256=<hmac>. Other headers: X-Webhook-Event, X-Webhook-ID, X-Webhook-Timestamp. 
 
 ## Properties
 
@@ -16,11 +16,11 @@ Name | Type
 ## Example
 
 ```typescript
-import type { WebhookNotificationPayload } from '@pronesoft/ecf-sdk'
+import type { WebhookNotificationPayload } from '@pronesoft-rd/ecf-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
-  "id": null,
+  "id": evt_1234567890abcdef,
   "event": null,
   "timestamp": null,
   "businessRnc": null,

package/docs/WebhookStats.md

@@ -0,0 +1,38 @@
+
+# WebhookStats
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`webhookId` | string
+`period` | string
+`stats` | [WebhookStatsStats](WebhookStatsStats.md)
+
+## Example
+
+```typescript
+import type { WebhookStats } from '@pronesoft-rd/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "webhookId": null,
+  "period": null,
+  "stats": null,
+} satisfies WebhookStats
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as WebhookStats
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/docs/WebhookStatsStats.md

@@ -0,0 +1,44 @@
+
+# WebhookStatsStats
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`totalAttempts` | number
+`successful` | number
+`failed` | number
+`successRate` | string
+`averageResponseTime` | number
+`lastAttempt` | Date
+
+## Example
+
+```typescript
+import type { WebhookStatsStats } from '@pronesoft-rd/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "totalAttempts": null,
+  "successful": null,
+  "failed": null,
+  "successRate": null,
+  "averageResponseTime": null,
+  "lastAttempt": null,
+} satisfies WebhookStatsStats
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as WebhookStatsStats
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pronesoft-rd/ecf-sdk",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "OpenAPI client for @pronesoft-rd/ecf-sdk",
   "author": "OpenAPI-Generator",
   "repository": {