@pronesoft-rd/ecf-sdk 0.0.1

package/docs/WebhookConfigurationApi.md

@@ -0,0 +1,241 @@
+# WebhookConfigurationApi
+
+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 |
+| [**listWebhooks**](WebhookConfigurationApi.md#listwebhooks) | **GET** /{rnc}/webhooks | List webhook configurations |
+
+
+
+## createWebhook
+
+> WebhookConfigResponse createWebhook(rnc, createWebhookConfig)
+
+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. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WebhookConfigurationApi,
+} from '@pronesoft/ecf-sdk';
+import type { CreateWebhookRequest } from '@pronesoft/ecf-sdk';
+
+async function example() {
+  console.log("🚀 Testing @pronesoft/ecf-sdk SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: oauth2 application
+    accessToken: "YOUR ACCESS TOKEN",
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  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;
+
+  try {
+    const data = await api.createWebhook(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| 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) |  | |
+
+### Return type
+
+[**WebhookConfigResponse**](WebhookConfigResponse.md)
+
+### Authorization
+
+[oauth2 application](../README.md#oauth2-application), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **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.  |  -  |
+
+[[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)
+
+Delete webhook configuration
+
+Removes a registered webhook by its ID.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WebhookConfigurationApi,
+} from '@pronesoft/ecf-sdk';
+import type { DeleteWebhookRequest } from '@pronesoft/ecf-sdk';
+
+async function example() {
+  console.log("🚀 Testing @pronesoft/ecf-sdk SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: oauth2 application
+    accessToken: "YOUR ACCESS TOKEN",
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  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.
+    webhookId: webhookId_example,
+  } satisfies DeleteWebhookRequest;
+
+  try {
+    const data = await api.deleteWebhook(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| 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`] |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+[oauth2 application](../README.md#oauth2-application), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### 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 |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## listWebhooks
+
+> Array<WebhookConfigResponse> listWebhooks(rnc)
+
+List webhook configurations
+
+Returns all registered webhooks for the given RNC.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  WebhookConfigurationApi,
+} from '@pronesoft/ecf-sdk';
+import type { ListWebhooksRequest } from '@pronesoft/ecf-sdk';
+
+async function example() {
+  console.log("🚀 Testing @pronesoft/ecf-sdk SDK...");
+  const config = new Configuration({ 
+    // To configure OAuth2 access token for authorization: oauth2 application
+    accessToken: "YOUR ACCESS TOKEN",
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  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,
+  } satisfies ListWebhooksRequest;
+
+  try {
+    const data = await api.listWebhooks(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| 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`] |
+
+### Return type
+
+[**Array<WebhookConfigResponse>**](WebhookConfigResponse.md)
+
+### Authorization
+
+[oauth2 application](../README.md#oauth2-application), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| 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.  |  -  |
+
+[[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

@@ -0,0 +1,33 @@
+
+# WebhookEventType
+
+Type of event that triggers a webhook notification.
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { WebhookEventType } from '@pronesoft/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies WebhookEventType
+
+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 WebhookEventType
+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/WebhookNotificationPayload.md

@@ -0,0 +1,43 @@
+
+# WebhookNotificationPayload
+
+Payload sent to your registered webhook URL when an event occurs. Verify authenticity using HMAC-SHA256 with your webhook `secret`. 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`event` | [WebhookEventType](WebhookEventType.md)
+`timestamp` | Date
+`businessRnc` | string
+`data` | object
+
+## Example
+
+```typescript
+import type { WebhookNotificationPayload } from '@pronesoft/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "event": null,
+  "timestamp": null,
+  "businessRnc": null,
+  "data": null,
+} satisfies WebhookNotificationPayload
+
+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 WebhookNotificationPayload
+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

@@ -0,0 +1,21 @@
+{
+  "name": "@pronesoft-rd/ecf-sdk",
+  "version": "0.0.1",
+  "description": "OpenAPI client for @pronesoft-rd/ecf-sdk",
+  "author": "OpenAPI-Generator",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ProneSoftSRL/pronesoft-ecf-sdks.git"
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "module": "./dist/esm/index.js",
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsc && tsc -p tsconfig.esm.json",
+    "prepare": "npm run build"
+  },
+  "devDependencies": {
+    "typescript": "^4.0 || ^5.0"
+  }
+}