@pronesoft-rd/ecf-sdk 0.0.1 → 0.0.3

package/docs/AutomatedCertificationApi.md

@@ -0,0 +1,294 @@
+# AutomatedCertificationApi
+
+All URIs are relative to *https://api.ecf.sandbox.pronesoft.com/api/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**downloadCertification**](AutomatedCertificationApi.md#downloadcertification) | **GET** /dgii-ecf/automated-certification/{id}/download | Download certification ZIP |
+| [**getCertificationStatus**](AutomatedCertificationApi.md#getcertificationstatus) | **GET** /dgii-ecf/automated-certification/{id}/status | Get certification process status |
+| [**listCertificationNiches**](AutomatedCertificationApi.md#listcertificationniches) | **GET** /dgii-ecf/automated-certification/niches | List certification niches |
+| [**startCertification**](AutomatedCertificationApi.md#startcertificationoperation) | **POST** /dgii-ecf/automated-certification/start | Start certification process |
+
+
+
+## downloadCertification
+
+> Blob downloadCertification(id)
+
+Download certification ZIP
+
+Downloads ZIP with PDFs and XMLs. Only available when status is COMPLETED.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AutomatedCertificationApi,
+} from '@pronesoft-rd/ecf-sdk';
+import type { DownloadCertificationRequest } 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 AutomatedCertificationApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies DownloadCertificationRequest;
+
+  try {
+    const data = await api.downloadCertification(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [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/zip`, `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | ZIP file with certification 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)
+
+
+## getCertificationStatus
+
+> CertificationStatus getCertificationStatus(id)
+
+Get certification process status
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AutomatedCertificationApi,
+} from '@pronesoft-rd/ecf-sdk';
+import type { GetCertificationStatusRequest } 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 AutomatedCertificationApi(config);
+
+  const body = {
+    // string
+    id: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+  } satisfies GetCertificationStatusRequest;
+
+  try {
+    const data = await api.getCertificationStatus(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **id** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**CertificationStatus**](CertificationStatus.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** | Certification process status |  -  |
+| **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)
+
+
+## listCertificationNiches
+
+> Array<CertificationNiche> listCertificationNiches()
+
+List certification niches
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AutomatedCertificationApi,
+} from '@pronesoft-rd/ecf-sdk';
+import type { ListCertificationNichesRequest } 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 AutomatedCertificationApi(config);
+
+  try {
+    const data = await api.listCertificationNiches();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Array<CertificationNiche>**](CertificationNiche.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 available niches |  -  |
+| **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)
+
+
+## startCertification
+
+> StartCertification200Response startCertification(startCertificationRequest)
+
+Start certification process
+
+### Example
+
+```ts
+import {
+  Configuration,
+  AutomatedCertificationApi,
+} from '@pronesoft-rd/ecf-sdk';
+import type { StartCertificationOperationRequest } 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 AutomatedCertificationApi(config);
+
+  const body = {
+    // StartCertificationRequest
+    startCertificationRequest: ...,
+  } satisfies StartCertificationOperationRequest;
+
+  try {
+    const data = await api.startCertification(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **startCertificationRequest** | [StartCertificationRequest](StartCertificationRequest.md) |  | |
+
+### Return type
+
+[**StartCertification200Response**](StartCertification200Response.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** | Certification process started |  -  |
+| **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/BillingIndicator.md

@@ -1,7 +1,7 @@
 
 # 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) 
+0=Non-billable, 1=18% ITBIS, 2=16% ITBIS, 3=0% ITBIS, 4=Exempt
 
 ## Properties
 
@@ -11,7 +11,7 @@ Name | Type
 ## Example
 
 ```typescript
-import type { BillingIndicator } from '@pronesoft/ecf-sdk'
+import type { BillingIndicator } from '@pronesoft-rd/ecf-sdk'
 
 // TODO: Update the object below with actual values
 const example = {

package/docs/Buyer.md

@@ -1,34 +1,53 @@
 
 # Buyer
 
-Information about the buyer/recipient of the document.
 
 ## Properties
 
 Name | Type
 ------------ | -------------
 `taxId` | string
+`foreignId` | string
 `name` | string
+`contact` | string
 `email` | string
 `address` | string
 `municipalityCode` | string
 `provinceCode` | string
+`deliveryDate` | Date
+`deliveryContact` | string
 `deliveryAddress` | string
+`additionalPhone` | string
+`purchaseOrderDate` | Date
+`purchaseOrderNumber` | string
+`internalCode` | string
+`paymentResponsible` | string
+`additionalInfo` | string
 
 ## Example
 
 ```typescript
-import type { Buyer } from '@pronesoft/ecf-sdk'
+import type { Buyer } from '@pronesoft-rd/ecf-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
-  "taxId": 130000001,
-  "name": Empresa Compradora SRL,
-  "email": comprador@empresa.com,
+  "taxId": 131415678,
+  "foreignId": null,
+  "name": Cliente Empresa SRL,
+  "contact": null,
+  "email": null,
   "address": null,
   "municipalityCode": null,
   "provinceCode": null,
+  "deliveryDate": null,
+  "deliveryContact": null,
   "deliveryAddress": null,
+  "additionalPhone": null,
+  "purchaseOrderDate": null,
+  "purchaseOrderNumber": null,
+  "internalCode": null,
+  "paymentResponsible": null,
+  "additionalInfo": null,
 } satisfies Buyer
 
 console.log(example)

package/docs/CertificationNiche.md

@@ -0,0 +1,40 @@
+
+# CertificationNiche
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`description` | string
+`nicheItems` | [Array<CertificationNicheNicheItemsInner>](CertificationNicheNicheItemsInner.md)
+
+## Example
+
+```typescript
+import type { CertificationNiche } from '@pronesoft-rd/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "description": null,
+  "nicheItems": null,
+} satisfies CertificationNiche
+
+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 CertificationNiche
+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/CertificationNicheNicheItemsInner.md

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

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

@@ -0,0 +1,114 @@
+# CommercialApprovalsApi
+
+All URIs are relative to *https://api.ecf.sandbox.pronesoft.com/api/v1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**listApprovals**](CommercialApprovalsApi.md#listapprovals) | **GET** /documents/approvals/all | List commercial approvals |
+
+
+
+## listApprovals
+
+> ApprovalListResponse listApprovals(businessId, page, limit, status, documentType, dateFrom, dateTo, minAmount, maxAmount, search, sortBy, sortOrder)
+
+List commercial approvals
+
+### Example
+
+```ts
+import {
+  Configuration,
+  CommercialApprovalsApi,
+} from '@pronesoft-rd/ecf-sdk';
+import type { ListApprovalsRequest } 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 CommercialApprovalsApi(config);
+
+  const body = {
+    // string
+    businessId: businessId_example,
+    // number (optional)
+    page: 56,
+    // number (optional)
+    limit: 56,
+    // 'PENDING' | 'APPROVED' | 'REJECTED' (optional)
+    status: status_example,
+    // string (optional)
+    documentType: documentType_example,
+    // Date (optional)
+    dateFrom: 2013-10-20T19:20:30+01:00,
+    // Date (optional)
+    dateTo: 2013-10-20T19:20:30+01:00,
+    // number (optional)
+    minAmount: 8.14,
+    // number (optional)
+    maxAmount: 8.14,
+    // string (optional)
+    search: search_example,
+    // 'createdAt' | 'amount' | 'status' (optional)
+    sortBy: sortBy_example,
+    // 'asc' | 'desc' (optional)
+    sortOrder: sortOrder_example,
+  } satisfies ListApprovalsRequest;
+
+  try {
+    const data = await api.listApprovals(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **businessId** | `string` |  | [Defaults to `undefined`] |
+| **page** | `number` |  | [Optional] [Defaults to `1`] |
+| **limit** | `number` |  | [Optional] [Defaults to `20`] |
+| **status** | `PENDING`, `APPROVED`, `REJECTED` |  | [Optional] [Defaults to `undefined`] [Enum: PENDING, APPROVED, REJECTED] |
+| **documentType** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **dateFrom** | `Date` |  | [Optional] [Defaults to `undefined`] |
+| **dateTo** | `Date` |  | [Optional] [Defaults to `undefined`] |
+| **minAmount** | `number` |  | [Optional] [Defaults to `undefined`] |
+| **maxAmount** | `number` |  | [Optional] [Defaults to `undefined`] |
+| **search** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **sortBy** | `createdAt`, `amount`, `status` |  | [Optional] [Defaults to `undefined`] [Enum: createdAt, amount, status] |
+| **sortOrder** | `asc`, `desc` |  | [Optional] [Defaults to `undefined`] [Enum: asc, desc] |
+
+### Return type
+
+[**ApprovalListResponse**](ApprovalListResponse.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 commercial approvals |  -  |
+| **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/CompanyDocumentMetrics.md

@@ -0,0 +1,40 @@
+
+# CompanyDocumentMetrics
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`mainBusiness` | [CompanyDocumentMetricsMainBusiness](CompanyDocumentMetricsMainBusiness.md)
+`associatedBusiness` | [CompanyDocumentMetricsMainBusiness](CompanyDocumentMetricsMainBusiness.md)
+`totals` | [CompanyDocumentMetricsTotals](CompanyDocumentMetricsTotals.md)
+`groupByStatus` | [Array<CompanyDocumentMetricsGroupByStatusInner>](CompanyDocumentMetricsGroupByStatusInner.md)
+
+## Example
+
+```typescript
+import type { CompanyDocumentMetrics } from '@pronesoft-rd/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "mainBusiness": null,
+  "associatedBusiness": null,
+  "totals": null,
+  "groupByStatus": null,
+} satisfies CompanyDocumentMetrics
+
+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 CompanyDocumentMetrics
+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/CompanyDocumentMetricsGroupByStatusInner.md

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