@pronesoft-rd/ecf-sdk 0.0.1 → 0.0.3

package/docs/ItemDiscountInner.md

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

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

@@ -8,16 +8,18 @@ Name | Type
 ------------ | -------------
 `success` | boolean
 `data` | [Array<TaxSequence>](TaxSequence.md)
+`meta` | [PaginationMeta](PaginationMeta.md)
 
 ## Example
 
 ```typescript
-import type { ListTaxSequences200Response } from '@pronesoft/ecf-sdk'
+import type { ListTaxSequences200Response } from '@pronesoft-rd/ecf-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
   "success": null,
   "data": null,
+  "meta": null,
 } satisfies ListTaxSequences200Response
 
 console.log(example)

package/docs/OAuthTokenRequest.md

@@ -1,7 +1,7 @@
 
 # OAuthTokenRequest
 
-Credentials for OAuth 2.0 Client Credentials authentication.  Obtain `clientId` and `clientSecret` from the Pronesoft portal: - Sandbox: https://ecf.sandbox.pronesoft.com - Production: https://ecf.pronesoft.com 
+Credentials for OAuth 2.0. Get from Pronesoft portal.
 
 ## Properties
 
@@ -13,12 +13,12 @@ Name | Type
 ## Example
 
 ```typescript
-import type { OAuthTokenRequest } from '@pronesoft/ecf-sdk'
+import type { OAuthTokenRequest } from '@pronesoft-rd/ecf-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
-  "clientId": my-app-client-id,
-  "clientSecret": my-super-secret-value,
+  "clientId": app_live_TU_CLIENT_ID,
+  "clientSecret": sk_live_TU_CLIENT_SECRET,
 } satisfies OAuthTokenRequest
 
 console.log(example)

package/docs/OAuthTokenResponse.md

@@ -1,7 +1,7 @@
 
 # OAuthTokenResponse
 
-Successful token response. Use `accessToken` as a Bearer token in the `Authorization` header of all subsequent requests. 
+Bearer token valid for 24 hours (86400 seconds).
 
 ## Properties
 
@@ -14,13 +14,13 @@ Name | Type
 ## Example
 
 ```typescript
-import type { OAuthTokenResponse } from '@pronesoft/ecf-sdk'
+import type { OAuthTokenResponse } from '@pronesoft-rd/ecf-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
-  "accessToken": eyJhbGciOiJSUzI1NiJ9...,
+  "accessToken": eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...,
   "tokenType": Bearer,
-  "expiresIn": 3600,
+  "expiresIn": 86400,
 } satisfies OAuthTokenResponse
 
 console.log(example)

package/docs/Page.md

@@ -1,7 +1,6 @@
 
 # Page
 
-Page-level breakdown for multi-page documents.
 
 ## Properties
 
@@ -10,40 +9,40 @@ Name | Type
 `pageNumber` | number
 `lineFrom` | number
 `lineTo` | number
-`subtotal` | number
 `taxableAmount` | number
 `taxableAmount1` | number
 `taxableAmount2` | number
 `taxableAmount3` | number
+`exemptAmount` | number
 `totalITBIS` | number
 `itbis1` | number
 `itbis2` | number
 `itbis3` | number
 `additionalTaxes` | number
-`exemptAmount` | number
+`subtotal` | number
 `nonBillableAmount` | number
 
 ## Example
 
 ```typescript
-import type { Page } from '@pronesoft/ecf-sdk'
+import type { Page } from '@pronesoft-rd/ecf-sdk'
 
 // TODO: Update the object below with actual values
 const example = {
   "pageNumber": null,
   "lineFrom": null,
   "lineTo": null,
-  "subtotal": null,
   "taxableAmount": null,
   "taxableAmount1": null,
   "taxableAmount2": null,
   "taxableAmount3": null,
+  "exemptAmount": null,
   "totalITBIS": null,
   "itbis1": null,
   "itbis2": null,
   "itbis3": null,
   "additionalTaxes": null,
-  "exemptAmount": null,
+  "subtotal": null,
   "nonBillableAmount": null,
 } satisfies Page
 

package/docs/PaginationMeta.md

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

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

@@ -1,7 +1,7 @@
 
 # PaymentMethod
 
-Payment method code: - `1`: Cash (Efectivo) - `2`: Check (Cheque) - `3`: Debit/Credit Card (Tarjeta de Débito/Crédito) - `4`: Credit (Crédito) - `5`: Bank Transfer (Transferencia Bancaria) - `6`: Electronic Money (Dinero Electrónico) - `7`: Bond/Gift Card (Bono/Gift Card) - `8`: Other (Otro) 
+1=Cash, 2=Check, 3=Card, 4=Credit, 5=Transfer, 6=Electronic, 7=Bond, 8=Other
 
 ## Properties
 
@@ -11,7 +11,7 @@ Name | Type
 ## Example
 
 ```typescript
-import type { PaymentMethod } from '@pronesoft/ecf-sdk'
+import type { PaymentMethod } from '@pronesoft-rd/ecf-sdk'
 
 // TODO: Update the object below with actual values
 const example = {

package/docs/PrintFormat.md

@@ -1,7 +1,6 @@
 
 # PrintFormat
 
-Printer/receipt format: - `A4`: Standard A4 paper - `thermal_80`: 80mm thermal printer - `thermal_58`: 58mm thermal printer 
 
 ## Properties
 
@@ -11,7 +10,7 @@ Name | Type
 ## Example
 
 ```typescript
-import type { PrintFormat } from '@pronesoft/ecf-sdk'
+import type { PrintFormat } from '@pronesoft-rd/ecf-sdk'
 
 // TODO: Update the object below with actual values
 const example = {

package/docs/ProcessingLog.md

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

@@ -0,0 +1,40 @@
+
+# RateLimitErrorResponse
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`statusCode` | number
+`message` | string
+`error` | string
+`retryAfter` | number
+
+## Example
+
+```typescript
+import type { RateLimitErrorResponse } from '@pronesoft-rd/ecf-sdk'
+
+// TODO: Update the object below with actual values
+const example = {
+  "statusCode": 429,
+  "message": Rate limit exceeded. Retry after 1 second.,
+  "error": Too Many Requests,
+  "retryAfter": 1,
+} satisfies RateLimitErrorResponse
+
+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 RateLimitErrorResponse
+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/ReceivedDocument.md

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

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

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

@@ -1,7 +1,7 @@
 
 # ReferenceInfo
 
-Reference to a previously issued document. Required for: - Credit Notes (type 34) — references the original invoice - Debit Notes (type 33) — references the original invoice 
+Reference to previously issued document (for credit/debit notes).
 
 ## Properties
 
@@ -16,7 +16,7 @@ Name | Type
 ## Example
 
 ```typescript
-import type { ReferenceInfo } from '@pronesoft/ecf-sdk'
+import type { ReferenceInfo } from '@pronesoft-rd/ecf-sdk'
 
 // TODO: Update the object below with actual values
 const example = {