@pronesoft-rd/ecf-sdk 0.0.1 → 0.0.2

package/docs/ReportsApi.md

@@ -0,0 +1,186 @@
+# ReportsApi
+
+All URIs are relative to *https://api.ecf.sandbox.pronesoft.com/api/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**export606**](ReportsApi.md#export606) | **GET** /dgii/606/export | Export Format 606 (Purchases) |
+| [**exportSentDocuments**](ReportsApi.md#exportsentdocuments) | **GET** /dgii/sent/export | Export sent documents report |
+
+
+
+## export606
+
+> string export606(from, to, format)
+
+Export Format 606 (Purchases)
+
+Downloads the official Format 606 for DGII in TXT (official) or Excel format.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ReportsApi,
+} from '@pronesoft-rd/ecf-sdk';
+import type { Export606Request } 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 ReportsApi(config);
+
+  const body = {
+    // Date
+    from: 2013-10-20,
+    // Date
+    to: 2013-10-20,
+    // 'txt' | 'xlsx'
+    format: format_example,
+  } satisfies Export606Request;
+
+  try {
+    const data = await api.export606(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **from** | `Date` |  | [Defaults to `undefined`] |
+| **to** | `Date` |  | [Defaults to `undefined`] |
+| **format** | `txt`, `xlsx` |  | [Defaults to `undefined`] [Enum: txt, xlsx] |
+
+### Return type
+
+**string**
+
+### Authorization
+
+[oauth2 application](../README.md#oauth2-application), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `text/plain`, `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`, `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Format 606 report |  -  |
+| **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. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## exportSentDocuments
+
+> Blob exportSentDocuments(from, to, env, encf, type, status, trackId)
+
+Export sent documents report
+
+Downloads submitted documents in a date range as Excel. Requires reports:read scope.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ReportsApi,
+} from '@pronesoft-rd/ecf-sdk';
+import type { ExportSentDocumentsRequest } 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 ReportsApi(config);
+
+  const body = {
+    // Date
+    from: 2024-01-01,
+    // Date
+    to: 2024-01-31,
+    // Environment (optional)
+    env: ...,
+    // string (optional)
+    encf: encf_example,
+    // string (optional)
+    type: type_example,
+    // 'ACCEPTED' | 'REJECTED' | 'PENDING' (optional)
+    status: status_example,
+    // string (optional)
+    trackId: trackId_example,
+  } satisfies ExportSentDocumentsRequest;
+
+  try {
+    const data = await api.exportSentDocuments(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **from** | `Date` |  | [Defaults to `undefined`] |
+| **to** | `Date` |  | [Defaults to `undefined`] |
+| **env** | `Environment` |  | [Optional] [Defaults to `undefined`] [Enum: TesteCF, CerteCF, eCF] |
+| **encf** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **type** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **status** | `ACCEPTED`, `REJECTED`, `PENDING` |  | [Optional] [Defaults to `undefined`] [Enum: ACCEPTED, REJECTED, PENDING] |
+| **trackId** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+**Blob**
+
+### Authorization
+
+[oauth2 application](../README.md#oauth2-application), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet`, `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Excel report file |  -  |
+| **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. |  -  |
+
+[[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/SentDocumentDetail.md

@@ -0,0 +1,58 @@
+
+# SentDocumentDetail
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`encf` | string
+`status` | [DocumentStatus](DocumentStatus.md)
+`statusDisplay` | string
+`trackId` | string
+`documentType` | string
+`totalAmount` | number
+`receivedAt` | Date
+`createdAt` | Date
+`xmlUrl` | string
+`business` | [SentDocumentSummaryBusiness](SentDocumentSummaryBusiness.md)
+`logs` | [Array<ProcessingLog>](ProcessingLog.md)
+`auditLogs` | Array<object>
+
+## Example
+
+```typescript
+import type { SentDocumentDetail } from '@pronesoft-rd/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "encf": null,
+  "status": null,
+  "statusDisplay": Aceptado,
+  "trackId": null,
+  "documentType": null,
+  "totalAmount": null,
+  "receivedAt": null,
+  "createdAt": null,
+  "xmlUrl": null,
+  "business": null,
+  "logs": null,
+  "auditLogs": null,
+} satisfies SentDocumentDetail
+
+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 SentDocumentDetail
+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/SentDocumentListResponse.md

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

@@ -0,0 +1,54 @@
+
+# SentDocumentSummary
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`encf` | string
+`status` | [DocumentStatus](DocumentStatus.md)
+`statusDisplay` | string
+`trackId` | string
+`documentType` | string
+`totalAmount` | number
+`receivedAt` | Date
+`createdAt` | Date
+`xmlUrl` | string
+`business` | [SentDocumentSummaryBusiness](SentDocumentSummaryBusiness.md)
+
+## Example
+
+```typescript
+import type { SentDocumentSummary } from '@pronesoft-rd/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "encf": null,
+  "status": null,
+  "statusDisplay": Aceptado,
+  "trackId": null,
+  "documentType": null,
+  "totalAmount": null,
+  "receivedAt": null,
+  "createdAt": null,
+  "xmlUrl": null,
+  "business": null,
+} satisfies SentDocumentSummary
+
+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 SentDocumentSummary
+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/SentDocumentSummaryBusiness.md

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

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

@@ -0,0 +1,40 @@
+
+# StartCertificationRequest
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`rnc` | string
+`businessName` | string
+`nicheId` | string
+`environment` | [Environment](Environment.md)
+
+## Example
+
+```typescript
+import type { StartCertificationRequest } from '@pronesoft-rd/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "rnc": null,
+  "businessName": null,
+  "nicheId": null,
+  "environment": null,
+} satisfies StartCertificationRequest
+
+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 StartCertificationRequest
+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/Subquantity.md

@@ -1,7 +1,6 @@
 
 # Subquantity
 
-Sub-quantity for items measured in multiple units.
 
 ## Properties
 
@@ -13,7 +12,7 @@ Name | Type
 ## Example
 
 ```typescript
-import type { Subquantity } from '@pronesoft/ecf-sdk'
+import type { Subquantity } from '@pronesoft-rd/ecf-sdk'
 
 // TODO: Update the object below with actual values
 const example = {

package/docs/Subtotal.md

@@ -1,15 +1,14 @@
 
 # Subtotal
 
-Subtotal for a page or section within a multi-page document.
 
 ## Properties
 
 Name | Type
 ------------ | -------------
 `number` | number
-`amount` | number
 `description` | string
+`order` | number
 `taxableAmount` | number
 `taxableAmount1` | number
 `taxableAmount2` | number
@@ -20,18 +19,19 @@ Name | Type
 `itbis3` | number
 `additionalTaxes` | number
 `exemptAmount` | number
+`amount` | number
 `lines` | number
 
 ## Example
 
 ```typescript
-import type { Subtotal } from '@pronesoft/ecf-sdk'
+import type { Subtotal } from '@pronesoft-rd/ecf-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
   "number": null,
-  "amount": null,
   "description": null,
+  "order": null,
   "taxableAmount": null,
   "taxableAmount1": null,
   "taxableAmount2": null,
@@ -42,6 +42,7 @@ const example = {
   "itbis3": null,
   "additionalTaxes": null,
   "exemptAmount": null,
+  "amount": null,
   "lines": null,
 } satisfies Subtotal
 

package/docs/TaxSequence.md

@@ -1,26 +1,41 @@
 
 # TaxSequence
 
-A registered fiscal number sequence for a given invoice type.
 
 ## Properties
 
 Name | Type
 ------------ | -------------
 `id` | string
-`type` | [InvoiceType](InvoiceType.md)
-`nextNumber` | string
+`type` | [InvoiceTypeSequence](InvoiceTypeSequence.md)
+`startNumber` | string
+`endNumber` | string
+`currentNumber` | string
+`status` | string
+`totalNumbers` | number
+`usedNumbers` | number
+`availableNumbers` | number
+`createdAt` | Date
+`expiresAt` | Date
 
 ## Example
 
 ```typescript
-import type { TaxSequence } from '@pronesoft/ecf-sdk'
+import type { TaxSequence } from '@pronesoft-rd/ecf-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
-  "id": null,
+  "id": seq_sbx_1234567890,
   "type": null,
-  "nextNumber": E310000000001,
+  "startNumber": E32000000001,
+  "endNumber": E32000010000,
+  "currentNumber": E32000005250,
+  "status": null,
+  "totalNumbers": null,
+  "usedNumbers": null,
+  "availableNumbers": null,
+  "createdAt": null,
+  "expiresAt": null,
 } satisfies TaxSequence
 
 console.log(example)

package/docs/TaxSequenceCreated.md

@@ -0,0 +1,44 @@
+
+# TaxSequenceCreated
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`type` | [InvoiceTypeSequence](InvoiceTypeSequence.md)
+`from` | number
+`to` | number
+`environment` | [Environment](Environment.md)
+`createdAt` | Date
+
+## Example
+
+```typescript
+import type { TaxSequenceCreated } from '@pronesoft-rd/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "type": null,
+  "from": null,
+  "to": null,
+  "environment": null,
+  "createdAt": null,
+} satisfies TaxSequenceCreated
+
+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 TaxSequenceCreated
+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)
+
+