@pronesoft-rd/ecf-sdk 0.0.1

package/docs/AssociatedCompany.md

@@ -0,0 +1,63 @@
+
+# AssociatedCompany
+
+A company or branch associated with the main tenant account.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`rnc` | string
+`phone` | string
+`address` | string
+`city` | string
+`country` | string
+`website` | string
+`logoPath` | string
+`type` | string
+`createdAt` | Date
+`docsIssuedThisMonth` | number
+`purchasedDocsConsumedThisMonth` | number
+`ownerEmail` | string
+`subscription` | [AssociatedCompanySubscription](AssociatedCompanySubscription.md)
+
+## Example
+
+```typescript
+import type { AssociatedCompany } from '@pronesoft/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "rnc": null,
+  "phone": null,
+  "address": null,
+  "city": null,
+  "country": null,
+  "website": null,
+  "logoPath": null,
+  "type": null,
+  "createdAt": null,
+  "docsIssuedThisMonth": null,
+  "purchasedDocsConsumedThisMonth": null,
+  "ownerEmail": null,
+  "subscription": null,
+} satisfies AssociatedCompany
+
+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 AssociatedCompany
+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/AssociatedCompanySubscription.md

@@ -0,0 +1,38 @@
+
+# AssociatedCompanySubscription
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`status` | string
+`expirationDate` | Date
+`plan` | [AssociatedCompanySubscriptionPlan](AssociatedCompanySubscriptionPlan.md)
+
+## Example
+
+```typescript
+import type { AssociatedCompanySubscription } from '@pronesoft/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "status": null,
+  "expirationDate": null,
+  "plan": null,
+} satisfies AssociatedCompanySubscription
+
+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 AssociatedCompanySubscription
+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/AssociatedCompanySubscriptionPlan.md

@@ -0,0 +1,36 @@
+
+# AssociatedCompanySubscriptionPlan
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`maxDocsPerMonth` | number
+
+## Example
+
+```typescript
+import type { AssociatedCompanySubscriptionPlan } from '@pronesoft/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "maxDocsPerMonth": null,
+} satisfies AssociatedCompanySubscriptionPlan
+
+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 AssociatedCompanySubscriptionPlan
+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/AuthenticationApi.md

@@ -0,0 +1,77 @@
+# AuthenticationApi
+
+All URIs are relative to *https://api.ecf.sandbox.pronesoft.com/api/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getAccessToken**](AuthenticationApi.md#getaccesstoken) | **POST** /oauth/token | Get access token |
+
+
+
+## getAccessToken
+
+> OAuthTokenResponse getAccessToken(oAuthTokenRequest)
+
+Get access token
+
+Authenticates using OAuth 2.0 **Client Credentials** flow. Returns a Bearer token to use in subsequent requests.  **This endpoint does NOT require an Authorization header.**  ``` POST /oauth/token Content-Type: application/json  {   \"clientId\": \"your-client-id\",   \"clientSecret\": \"your-client-secret\" } ```  Use the returned `accessToken` as: ``` Authorization: Bearer <accessToken> ``` 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AuthenticationApi,
+} from '@pronesoft/ecf-sdk';
+import type { GetAccessTokenRequest } from '@pronesoft/ecf-sdk';
+
+async function example() {
+  console.log("🚀 Testing @pronesoft/ecf-sdk SDK...");
+  const api = new AuthenticationApi();
+
+  const body = {
+    // OAuthTokenRequest
+    oAuthTokenRequest: {"clientId":"my-client-id","clientSecret":"my-super-secret"},
+  } satisfies GetAccessTokenRequest;
+
+  try {
+    const data = await api.getAccessToken(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **oAuthTokenRequest** | [OAuthTokenRequest](OAuthTokenRequest.md) |  | |
+
+### Return type
+
+[**OAuthTokenResponse**](OAuthTokenResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Token generated successfully |  -  |
+| **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/BillingIndicator.md

@@ -0,0 +1,33 @@
+
+# BillingIndicator
+
+ITBIS tax billing indicator for a line item: - `0`: Non-billable (No facturable) - `1`: 18% ITBIS rate - `2`: 16% ITBIS rate - `3`: 0% ITBIS rate - `4`: Exempt (Exento) 
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { BillingIndicator } from '@pronesoft/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies BillingIndicator
+
+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 BillingIndicator
+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/Buyer.md

@@ -0,0 +1,47 @@
+
+# Buyer
+
+Information about the buyer/recipient of the document.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`taxId` | string
+`name` | string
+`email` | string
+`address` | string
+`municipalityCode` | string
+`provinceCode` | string
+`deliveryAddress` | string
+
+## Example
+
+```typescript
+import type { Buyer } from '@pronesoft/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "taxId": 130000001,
+  "name": Empresa Compradora SRL,
+  "email": comprador@empresa.com,
+  "address": null,
+  "municipalityCode": null,
+  "provinceCode": null,
+  "deliveryAddress": null,
+} satisfies Buyer
+
+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 Buyer
+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/CreateAssociatedCompany201Response.md

@@ -0,0 +1,36 @@
+
+# CreateAssociatedCompany201Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`message` | string
+`business` | [AssociatedCompany](AssociatedCompany.md)
+
+## Example
+
+```typescript
+import type { CreateAssociatedCompany201Response } from '@pronesoft/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "message": null,
+  "business": null,
+} satisfies CreateAssociatedCompany201Response
+
+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 CreateAssociatedCompany201Response
+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/CreateTaxSequenceRequest.md

@@ -0,0 +1,39 @@
+
+# CreateTaxSequenceRequest
+
+Request to register a new block of fiscal numbers. The `from` and `to` values define the numeric range (inclusive). 
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | [InvoiceType](InvoiceType.md)
+`from` | number
+`to` | number
+
+## Example
+
+```typescript
+import type { CreateTaxSequenceRequest } from '@pronesoft/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "from": 1,
+  "to": 500,
+} satisfies CreateTaxSequenceRequest
+
+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 CreateTaxSequenceRequest
+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/CreateWebhookConfig.md

@@ -0,0 +1,41 @@
+
+# CreateWebhookConfig
+
+Request body for registering a new webhook.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`url` | string
+`eventTypes` | [Array<WebhookEventType>](WebhookEventType.md)
+`description` | string
+`secret` | string
+
+## Example
+
+```typescript
+import type { CreateWebhookConfig } from '@pronesoft/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "url": https://myapp.com/webhooks/ecf,
+  "eventTypes": null,
+  "description": null,
+  "secret": null,
+} satisfies CreateWebhookConfig
+
+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 CreateWebhookConfig
+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/DigitalCertificatesApi.md

@@ -0,0 +1,90 @@
+# DigitalCertificatesApi
+
+All URIs are relative to *https://api.ecf.sandbox.pronesoft.com/api/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**uploadCertificate**](DigitalCertificatesApi.md#uploadcertificate) | **POST** /{rnc}/certificates | Upload digital certificate (P12) |
+
+
+
+## uploadCertificate
+
+> UploadCertificateResponse uploadCertificate(rnc, file, password)
+
+Upload digital certificate (P12)
+
+Uploads the DGII-issued digital signing certificate for a company identified by its RNC. The certificate must be in P12/PFX format.  This is required before submitting any e-CF documents. 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DigitalCertificatesApi,
+} from '@pronesoft/ecf-sdk';
+import type { UploadCertificateRequest } 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 DigitalCertificatesApi(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,
+    // Blob | The P12/PFX certificate file.
+    file: BINARY_DATA_HERE,
+    // string | Password to unlock the P12 certificate.
+    password: password_example,
+  } satisfies UploadCertificateRequest;
+
+  try {
+    const data = await api.uploadCertificate(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`] |
+| **file** | `Blob` | The P12/PFX certificate file. | [Defaults to `undefined`] |
+| **password** | `string` | Password to unlock the P12 certificate. | [Defaults to `undefined`] |
+
+### Return type
+
+[**UploadCertificateResponse**](UploadCertificateResponse.md)
+
+### Authorization
+
+[oauth2 application](../README.md#oauth2-application), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `multipart/form-data`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Certificate uploaded and 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)
+

package/docs/DiscountOrSurcharge.md

@@ -0,0 +1,49 @@
+
+# DiscountOrSurcharge
+
+A document-level discount or surcharge.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`lineNumber` | number
+`type` | string
+`valueType` | string
+`amount` | number
+`description` | string
+`percentageValue` | number
+`alternativeCurrencyAmount` | number
+`billingIndicator` | [BillingIndicator](BillingIndicator.md)
+
+## Example
+
+```typescript
+import type { DiscountOrSurcharge } from '@pronesoft/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "lineNumber": null,
+  "type": null,
+  "valueType": null,
+  "amount": null,
+  "description": null,
+  "percentageValue": null,
+  "alternativeCurrencyAmount": null,
+  "billingIndicator": null,
+} satisfies DiscountOrSurcharge
+
+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 DiscountOrSurcharge
+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/ECFSubmissionApi.md

@@ -0,0 +1,90 @@
+# ECFSubmissionApi
+
+All URIs are relative to *https://api.ecf.sandbox.pronesoft.com/api/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**submitEcf**](ECFSubmissionApi.md#submitecf) | **POST** /{environment}/ecf/submit | Submit e-CF document to DGII |
+
+
+
+## submitEcf
+
+> EcfSubmissionResponse submitEcf(xTenantId, environment, electronicDocument)
+
+Submit e-CF document to DGII
+
+Submits an electronic tax document to the DGII via the Pronesoft platform. Pronesoft handles XML signing, DGII authentication, and status polling on your behalf.  ### Flow 1. Build the `ElectronicDocument` payload. 2. Call this endpoint with the target `environment` in the path. 3. Receive a `documentId` and `trackId` in the response. 4. Listen for the `document.status_changed` webhook event, or poll    the DGII track ID to confirm final approval.  ### Path parameter: environment | Value | Description | |---|---| | `TesteCF` | Functional tests (no DGII interaction) | | `CerteCF` | DGII certification environment | | `eCF` | Production — real documents | 
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ECFSubmissionApi,
+} from '@pronesoft/ecf-sdk';
+import type { SubmitEcfRequest } 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 ECFSubmissionApi(config);
+
+  const body = {
+    // string | UUID of the company or branch (tenant) making the request. Obtained from the Pronesoft portal after account setup. 
+    xTenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // Environment | Target submission environment.
+    environment: ...,
+    // ElectronicDocument
+    electronicDocument: ...,
+  } satisfies SubmitEcfRequest;
+
+  try {
+    const data = await api.submitEcf(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **xTenantId** | `string` | UUID of the company or branch (tenant) making the request. Obtained from the Pronesoft portal after account setup.  | [Defaults to `undefined`] |
+| **environment** | `Environment` | Target submission environment. | [Defaults to `undefined`] [Enum: TesteCF, CerteCF, eCF] |
+| **electronicDocument** | [ElectronicDocument](ElectronicDocument.md) |  | |
+
+### Return type
+
+[**EcfSubmissionResponse**](EcfSubmissionResponse.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 |
+|-------------|-------------|------------------|
+| **200** | Document accepted and submitted to DGII |  -  |
+| **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)
+

package/docs/EcfSubmissionResponse.md

@@ -0,0 +1,43 @@
+
+# EcfSubmissionResponse
+
+Response returned after successfully submitting an e-CF document.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`success` | boolean
+`documentId` | string
+`encf` | string
+`trackId` | string
+`message` | string
+
+## Example
+
+```typescript
+import type { EcfSubmissionResponse } from '@pronesoft/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "success": null,
+  "documentId": null,
+  "encf": E310000000001,
+  "trackId": TRK-20240101-0001,
+  "message": null,
+} satisfies EcfSubmissionResponse
+
+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 EcfSubmissionResponse
+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)
+
+