@pronesoft-rd/ecf-sdk 0.0.1 → 0.0.2

package/docs/CompanyDocumentMetricsGroupByStatusInnerCount.md

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

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

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

@@ -0,0 +1,50 @@
+
+# CompanyMetrics
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`businessId` | string
+`businessName` | string
+`rnc` | string
+`totalDocumentsIssued` | number
+`documentsThisMonth` | number
+`documentsStatus` | [CompanyMetricsDocumentsStatus](CompanyMetricsDocumentsStatus.md)
+`consumptionPercentage` | number
+`subscriptionStatus` | string
+`expirationDate` | Date
+
+## Example
+
+```typescript
+import type { CompanyMetrics } from '@pronesoft-rd/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "businessId": null,
+  "businessName": null,
+  "rnc": null,
+  "totalDocumentsIssued": null,
+  "documentsThisMonth": null,
+  "documentsStatus": null,
+  "consumptionPercentage": null,
+  "subscriptionStatus": null,
+  "expirationDate": null,
+} satisfies CompanyMetrics
+
+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 CompanyMetrics
+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/CompanyMetricsDocumentsStatus.md

@@ -0,0 +1,38 @@
+
+# CompanyMetricsDocumentsStatus
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`aPPROVED` | number
+`rEJECTED` | number
+`pENDING` | number
+
+## Example
+
+```typescript
+import type { CompanyMetricsDocumentsStatus } from '@pronesoft-rd/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "aPPROVED": null,
+  "rEJECTED": null,
+  "pENDING": null,
+} satisfies CompanyMetricsDocumentsStatus
+
+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 CompanyMetricsDocumentsStatus
+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

@@ -12,7 +12,7 @@ Name | Type
 ## Example
 
 ```typescript
-import type { CreateAssociatedCompany201Response } from '@pronesoft/ecf-sdk'
+import type { CreateAssociatedCompany201Response } from '@pronesoft-rd/ecf-sdk'
 
 // TODO: Update the object below with actual values
 const example = {

package/docs/CreateTaxSequence201Response.md

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

@@ -1,26 +1,31 @@
 
 # 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)
+`type` | [InvoiceTypeSequence](InvoiceTypeSequence.md)
 `from` | number
 `to` | number
+`quantity` | number
+`expiration` | Date
+`environment` | [Environment](Environment.md)
 
 ## Example
 
 ```typescript
-import type { CreateTaxSequenceRequest } from '@pronesoft/ecf-sdk'
+import type { CreateTaxSequenceRequest } from '@pronesoft-rd/ecf-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
   "type": null,
   "from": 1,
-  "to": 500,
+  "to": 10000,
+  "quantity": 10000,
+  "expiration": Tue Dec 30 20:00:00 AST 2025,
+  "environment": null,
 } satisfies CreateTaxSequenceRequest
 
 console.log(example)

package/docs/DeleteAssociatedCompany200Response.md

@@ -0,0 +1,34 @@
+
+# DeleteAssociatedCompany200Response
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`message` | string
+
+## Example
+
+```typescript
+import type { DeleteAssociatedCompany200Response } from '@pronesoft-rd/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "message": null,
+} satisfies DeleteAssociatedCompany200Response
+
+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 DeleteAssociatedCompany200Response
+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

@@ -4,7 +4,7 @@ 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**](DigitalCertificatesApi.md#uploadcertificate) | **POST** /{rnc}/certificates | Upload digital certificate (P12/PFX) |
 
 
 
@@ -12,9 +12,9 @@ All URIs are relative to *https://api.ecf.sandbox.pronesoft.com/api/v1*
 
 > UploadCertificateResponse uploadCertificate(rnc, file, password)
 
-Upload digital certificate (P12)
+Upload digital certificate (P12/PFX)
 
-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. 
+Uploads the DGII-issued digital signing certificate for a company. Stored encrypted with AES-256-CBC. No download endpoint exists. Sandbox tip: SBX-prefixed RNCs do not require a certificate. 
 
 ### Example
 
@@ -22,11 +22,11 @@ Uploads the DGII-issued digital signing certificate for a company identified by
 import {
   Configuration,
   DigitalCertificatesApi,
-} from '@pronesoft/ecf-sdk';
-import type { UploadCertificateRequest } from '@pronesoft/ecf-sdk';
+} from '@pronesoft-rd/ecf-sdk';
+import type { UploadCertificateRequest } 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",
@@ -36,11 +36,11 @@ async function example() {
   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.
+    // string | Company RNC (9 or 11 digits). In Sandbox use SBX-prefixed values.
+    rnc: 133190907,
+    // Blob | Certificate file in .p12 or .pfx format.
     file: BINARY_DATA_HERE,
-    // string | Password to unlock the P12 certificate.
+    // string | Password to unlock the certificate.
     password: password_example,
   } satisfies UploadCertificateRequest;
 
@@ -61,9 +61,9 @@ 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`] |
-| **file** | `Blob` | The P12/PFX certificate file. | [Defaults to `undefined`] |
-| **password** | `string` | Password to unlock the P12 certificate. | [Defaults to `undefined`] |
+| **rnc** | `string` | Company RNC (9 or 11 digits). In Sandbox use SBX-prefixed values. | [Defaults to `undefined`] |
+| **file** | `Blob` | Certificate file in .p12 or .pfx format. | [Defaults to `undefined`] |
+| **password** | `string` | Password to unlock the certificate. | [Defaults to `undefined`] |
 
 ### Return type
 
@@ -82,9 +82,11 @@ example().catch(console.error);
 ### 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.  |  -  |
+| **201** | Certificate uploaded successfully |  -  |
+| **400** | Validation error (400). Check the message field for details. |  -  |
+| **401** | Token missing, expired, or invalid. Call POST /oauth/token to renew. |  -  |
+| **403** | The token does not have the required scope. |  -  |
+| **404** | Company RNC not found in the system. |  -  |
 
 [[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

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

package/docs/DocumentStatsResponse.md

@@ -0,0 +1,40 @@
+
+# DocumentStatsResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`total` | number
+`recentActivity` | number
+`byStatus` | { [key: string]: number; }
+`byEnvironment` | { [key: string]: number; }
+
+## Example
+
+```typescript
+import type { DocumentStatsResponse } from '@pronesoft-rd/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "total": null,
+  "recentActivity": null,
+  "byStatus": null,
+  "byEnvironment": null,
+} satisfies DocumentStatsResponse
+
+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 DocumentStatsResponse
+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/DocumentStatus.md

@@ -0,0 +1,32 @@
+
+# DocumentStatus
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { DocumentStatus } from '@pronesoft-rd/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies DocumentStatus
+
+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 DocumentStatus
+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/DocumentsReceivedApi.md

@@ -0,0 +1,175 @@
+# DocumentsReceivedApi
+
+All URIs are relative to *https://api.ecf.sandbox.pronesoft.com/api/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getReceivedDocumentStats**](DocumentsReceivedApi.md#getreceiveddocumentstats) | **GET** /documents/received/stats/summary | Get received documents statistics |
+| [**listReceivedDocuments**](DocumentsReceivedApi.md#listreceiveddocuments) | **GET** /documents/received/all | List received documents |
+
+
+
+## getReceivedDocumentStats
+
+> ReceivedDocumentStatsResponse getReceivedDocumentStats(xTenantId)
+
+Get received documents statistics
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DocumentsReceivedApi,
+} from '@pronesoft-rd/ecf-sdk';
+import type { GetReceivedDocumentStatsRequest } from '@pronesoft-rd/ecf-sdk';
+
+async function example() {
+  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",
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new DocumentsReceivedApi(config);
+
+  const body = {
+    // string | UUID of the associated company (branch). Include ONLY when acting on behalf of a branch. Omit when acting as the main company.  (optional)
+    xTenantId: 468a4aa1-1b80-447e-9ecb-400e39f7d798,
+  } satisfies GetReceivedDocumentStatsRequest;
+
+  try {
+    const data = await api.getReceivedDocumentStats(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 associated company (branch). Include ONLY when acting on behalf of a branch. Omit when acting as the main company.  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**ReceivedDocumentStatsResponse**](ReceivedDocumentStatsResponse.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** | Received document 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)
+
+
+## listReceivedDocuments
+
+> ReceivedDocumentListResponse listReceivedDocuments(xTenantId, encf, type, status, dateFrom, dateTo, page, limit)
+
+List received documents
+
+### Example
+
+```ts
+import {
+  Configuration,
+  DocumentsReceivedApi,
+} from '@pronesoft-rd/ecf-sdk';
+import type { ListReceivedDocumentsRequest } from '@pronesoft-rd/ecf-sdk';
+
+async function example() {
+  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",
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new DocumentsReceivedApi(config);
+
+  const body = {
+    // string | UUID of the associated company (branch). Include ONLY when acting on behalf of a branch. Omit when acting as the main company.  (optional)
+    xTenantId: 468a4aa1-1b80-447e-9ecb-400e39f7d798,
+    // string (optional)
+    encf: encf_example,
+    // string (optional)
+    type: type_example,
+    // number (optional)
+    status: 56,
+    // Date (optional)
+    dateFrom: 2013-10-20,
+    // Date (optional)
+    dateTo: 2013-10-20,
+    // number (optional)
+    page: 56,
+    // number (optional)
+    limit: 56,
+  } satisfies ListReceivedDocumentsRequest;
+
+  try {
+    const data = await api.listReceivedDocuments(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 associated company (branch). Include ONLY when acting on behalf of a branch. Omit when acting as the main company.  | [Optional] [Defaults to `undefined`] |
+| **encf** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **type** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **status** | `number` |  | [Optional] [Defaults to `undefined`] |
+| **dateFrom** | `Date` |  | [Optional] [Defaults to `undefined`] |
+| **dateTo** | `Date` |  | [Optional] [Defaults to `undefined`] |
+| **page** | `number` |  | [Optional] [Defaults to `1`] |
+| **limit** | `number` |  | [Optional] [Defaults to `10`] |
+
+### Return type
+
+[**ReceivedDocumentListResponse**](ReceivedDocumentListResponse.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** | Paginated list of received documents |  -  |
+| **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)
+