@pronesoft-rd/ecf-sdk 0.0.1 → 0.0.2

package/dist/esm/models/EcfSubmissionResponse.d.ts

@@ -1,50 +1,107 @@
 /**
  * eCF-Pronesoft Integration API
- * ## Overview Production-grade API for issuing Electronic Tax Receipts (e-CF) in the Dominican Republic through the Pronesoft platform, which handles all communication with the DGII on your behalf.  ## Authentication — OAuth 2.0 Client Credentials This API uses the **OAuth 2.0 Client Credentials** flow. There is no user login — authentication is machine-to-machine using a `clientId` and `clientSecret` issued by the Pronesoft portal.  ### Step-by-step 1. **Get credentials**:    - Sandbox: https://ecf.sandbox.pronesoft.com    - Production: https://ecf.pronesoft.com 2. **Request a token** — call `POST /oauth/token` with your credentials.    The server returns an `accessToken` valid for `expiresIn` seconds. 3. **Authorize requests** — include the token in every subsequent request:    ```    Authorization: Bearer <accessToken>    ``` 4. **Identify your tenant** — include your company/branch UUID in every    protected request:    ```    x-tenant-id: <your-tenant-uuid>    ``` 5. **Refresh** — when the token expires, simply call `POST /oauth/token` again.  ### Scopes | Category | Scope | Description | |---|---|---| | **Business** | `business:read` | Read company data | | | `business:create` | Create a new company | | | `business:update` | Update company data | | **Members** | `members:read` | View team members | | | `members:invite` | Invite new members | | | `members:revoke` | Revoke member access | | **Certificates** | `certificates:read` | View digital certificates | | | `certificates:upload` | Upload new certificates | | | `certificates:update` | Update existing certificates | | **Documents** | `documents:read` | List and view documents | | | `documents:create` | Create drafts or internal documents | | | `documents:send` | Submit e-CF to DGII | | | `documents:receive` | Receive e-CF from third parties | | | `documents:update` | Modify document metadata | | **Approvals** | `approvals:read` | View approval statuses | | | `approvals:commercial` | Perform commercial approvals/rejections | | **Sequences** | `sequences:read` | View NCF/e-NCF ranges | | | `sequences:create` | Request new sequences | | | `sequences:update` | Modify sequence configurations | | | `sequences:cancel` | Cancel unused sequences | | **Dashboard** | `business_info:read` | Access dashboard stats and metrics | | **Certification** | `certification:read` | View certification progress | | | `certification:write` | Run automated DGII certification tests | | **Reports** | `reports:read` | Generate and export reports (e.g. 606) |  ## Environments | Environment | Portal | API Host | Purpose | |---|---|---|---| | Sandbox | https://ecf.sandbox.pronesoft.com | `api.ecf.sandbox.pronesoft.com` | Development & testing | | Production | https://ecf.pronesoft.com | `api.ecf.pronesoft.com` | Live e-CF issuance |  ## Invoice Types (e-NCF) | Code | Name | |---|---| | `31` | Tax Credit Invoice (Factura de Crédito Fiscal) | | `32` | Consumer Invoice (Factura de Consumo) | | `33` | Debit Note (Nota de Débito) | | `34` | Credit Note (Nota de Crédito) | | `41` | Purchases (Compras) | | `43` | Minor Expenses (Gastos Menores) | | `44` | Special Regimes (Regímenes Especiales) | | `45` | Governmental (Gubernamentales) | | `46` | Exports (Exportaciones) | | `47` | Overseas Payments (Pagos al Exterior) |
+ * ## Overview Production-grade API for issuing Electronic Tax Receipts (e-CF) in the Dominican Republic through the Pronesoft platform.  ## Authentication — OAuth 2.0 Client Credentials  ### Steps 1. Get credentials from the portal:    - Sandbox: https://ecf.sandbox.pronesoft.com -> Apps -> Default Sandbox App    - Production: https://ecf.pronesoft.com -> Integrations -> Apps -> Create App 2. Request a token via POST /oauth/token — valid for 24 hours (86400s). 3. Use: Authorization: Bearer <accessToken> on every request. 4. Renew on HTTP 401. Best practice: renew 5 minutes before expiry.  ### Multi-company delegation To act on behalf of an associated company (branch), add:   x-tenant-id: <business-uuid> Do NOT send x-tenant-id when acting as the main company.  ### Sandbox specifics - Use any RNC starting with SBX (e.g. SBX123456) — no real certificate needed. - Sequences are automatic — no need to create them manually. - The environment field in the document body MUST be TesteCF.  ### Scopes business:read, business:create, business:update, members:read, members:invite, members:revoke, certificates:read, certificates:upload, certificates:update, documents:read, documents:create, documents:send, documents:receive, documents:update, approvals:read, approvals:commercial, sequences:read, sequences:create, sequences:update, sequences:cancel, business_info:read, certification:read, certification:write, reports:read
  *
- * The version of the OpenAPI document: 0.0.1
- * Contact: contacto@pronesoft.com
+ * The version of the OpenAPI document: 1.1.0
+ * Contact: support@pronesoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { EcfSubmissionResponseDgiiResponse } from './EcfSubmissionResponseDgiiResponse';
 /**
- * Response returned after successfully submitting an e-CF document.
+ * Response after submitting an e-CF. HTTP 200 even when rejected.
+ * Check the success field and dgiiResponse.estado for actual result.
+ *
  * @export
  * @interface EcfSubmissionResponse
  */
 export interface EcfSubmissionResponse {
     /**
-     * Whether the document was accepted by the platform.
+     *
      * @type {boolean}
      * @memberof EcfSubmissionResponse
      */
     success: boolean;
     /**
-     * Pronesoft internal document identifier.
+     *
      * @type {string}
      * @memberof EcfSubmissionResponse
      */
-    documentId: string;
+    documentId?: string;
     /**
-     * The e-NCF number assigned to the document.
+     *
+     * @type {EcfSubmissionResponseDgiiResponse}
+     * @memberof EcfSubmissionResponse
+     */
+    dgiiResponse?: EcfSubmissionResponseDgiiResponse;
+    /**
+     *
+     * @type {string}
+     * @memberof EcfSubmissionResponse
+     */
+    qrUrl?: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof EcfSubmissionResponse
+     */
+    signatureTime?: Date;
+    /**
+     *
+     * @type {string}
+     * @memberof EcfSubmissionResponse
+     */
+    securityCode?: string;
+    /**
+     *
      * @type {string}
      * @memberof EcfSubmissionResponse
      */
     encf?: string;
     /**
-     * DGII tracking ID for status polling.
+     *
+     * @type {string}
+     * @memberof EcfSubmissionResponse
+     */
+    documentType?: string;
+    /**
+     *
      * @type {string}
      * @memberof EcfSubmissionResponse
      */
-    trackId?: string;
+    printUrl?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof EcfSubmissionResponse
+     */
+    authType?: string;
+    /**
+     *
+     * @type {Date}
+     * @memberof EcfSubmissionResponse
+     */
+    timestamp?: Date;
     /**
-     * Human-readable status message.
+     *
      * @type {string}
      * @memberof EcfSubmissionResponse
      */
     message?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof EcfSubmissionResponse
+     */
+    contingencyMode?: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof EcfSubmissionResponse
+     */
+    estimatedProcessTime?: string;
 }
 /**
  * Check if a given object implements the EcfSubmissionResponse interface.

package/dist/esm/models/EcfSubmissionResponse.js

@@ -2,23 +2,22 @@
 /* eslint-disable */
 /**
  * eCF-Pronesoft Integration API
- * ## Overview Production-grade API for issuing Electronic Tax Receipts (e-CF) in the Dominican Republic through the Pronesoft platform, which handles all communication with the DGII on your behalf.  ## Authentication — OAuth 2.0 Client Credentials This API uses the **OAuth 2.0 Client Credentials** flow. There is no user login — authentication is machine-to-machine using a `clientId` and `clientSecret` issued by the Pronesoft portal.  ### Step-by-step 1. **Get credentials**:    - Sandbox: https://ecf.sandbox.pronesoft.com    - Production: https://ecf.pronesoft.com 2. **Request a token** — call `POST /oauth/token` with your credentials.    The server returns an `accessToken` valid for `expiresIn` seconds. 3. **Authorize requests** — include the token in every subsequent request:    ```    Authorization: Bearer <accessToken>    ``` 4. **Identify your tenant** — include your company/branch UUID in every    protected request:    ```    x-tenant-id: <your-tenant-uuid>    ``` 5. **Refresh** — when the token expires, simply call `POST /oauth/token` again.  ### Scopes | Category | Scope | Description | |---|---|---| | **Business** | `business:read` | Read company data | | | `business:create` | Create a new company | | | `business:update` | Update company data | | **Members** | `members:read` | View team members | | | `members:invite` | Invite new members | | | `members:revoke` | Revoke member access | | **Certificates** | `certificates:read` | View digital certificates | | | `certificates:upload` | Upload new certificates | | | `certificates:update` | Update existing certificates | | **Documents** | `documents:read` | List and view documents | | | `documents:create` | Create drafts or internal documents | | | `documents:send` | Submit e-CF to DGII | | | `documents:receive` | Receive e-CF from third parties | | | `documents:update` | Modify document metadata | | **Approvals** | `approvals:read` | View approval statuses | | | `approvals:commercial` | Perform commercial approvals/rejections | | **Sequences** | `sequences:read` | View NCF/e-NCF ranges | | | `sequences:create` | Request new sequences | | | `sequences:update` | Modify sequence configurations | | | `sequences:cancel` | Cancel unused sequences | | **Dashboard** | `business_info:read` | Access dashboard stats and metrics | | **Certification** | `certification:read` | View certification progress | | | `certification:write` | Run automated DGII certification tests | | **Reports** | `reports:read` | Generate and export reports (e.g. 606) |  ## Environments | Environment | Portal | API Host | Purpose | |---|---|---|---| | Sandbox | https://ecf.sandbox.pronesoft.com | `api.ecf.sandbox.pronesoft.com` | Development & testing | | Production | https://ecf.pronesoft.com | `api.ecf.pronesoft.com` | Live e-CF issuance |  ## Invoice Types (e-NCF) | Code | Name | |---|---| | `31` | Tax Credit Invoice (Factura de Crédito Fiscal) | | `32` | Consumer Invoice (Factura de Consumo) | | `33` | Debit Note (Nota de Débito) | | `34` | Credit Note (Nota de Crédito) | | `41` | Purchases (Compras) | | `43` | Minor Expenses (Gastos Menores) | | `44` | Special Regimes (Regímenes Especiales) | | `45` | Governmental (Gubernamentales) | | `46` | Exports (Exportaciones) | | `47` | Overseas Payments (Pagos al Exterior) |
+ * ## Overview Production-grade API for issuing Electronic Tax Receipts (e-CF) in the Dominican Republic through the Pronesoft platform.  ## Authentication — OAuth 2.0 Client Credentials  ### Steps 1. Get credentials from the portal:    - Sandbox: https://ecf.sandbox.pronesoft.com -> Apps -> Default Sandbox App    - Production: https://ecf.pronesoft.com -> Integrations -> Apps -> Create App 2. Request a token via POST /oauth/token — valid for 24 hours (86400s). 3. Use: Authorization: Bearer <accessToken> on every request. 4. Renew on HTTP 401. Best practice: renew 5 minutes before expiry.  ### Multi-company delegation To act on behalf of an associated company (branch), add:   x-tenant-id: <business-uuid> Do NOT send x-tenant-id when acting as the main company.  ### Sandbox specifics - Use any RNC starting with SBX (e.g. SBX123456) — no real certificate needed. - Sequences are automatic — no need to create them manually. - The environment field in the document body MUST be TesteCF.  ### Scopes business:read, business:create, business:update, members:read, members:invite, members:revoke, certificates:read, certificates:upload, certificates:update, documents:read, documents:create, documents:send, documents:receive, documents:update, approvals:read, approvals:commercial, sequences:read, sequences:create, sequences:update, sequences:cancel, business_info:read, certification:read, certification:write, reports:read
  *
- * The version of the OpenAPI document: 0.0.1
- * Contact: contacto@pronesoft.com
+ * The version of the OpenAPI document: 1.1.0
+ * Contact: support@pronesoft.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { EcfSubmissionResponseDgiiResponseFromJSON, EcfSubmissionResponseDgiiResponseToJSON, } from './EcfSubmissionResponseDgiiResponse';
 /**
  * Check if a given object implements the EcfSubmissionResponse interface.
  */
 export function instanceOfEcfSubmissionResponse(value) {
     if (!('success' in value) || value['success'] === undefined)
         return false;
-    if (!('documentId' in value) || value['documentId'] === undefined)
-        return false;
     return true;
 }
 export function EcfSubmissionResponseFromJSON(json) {
@@ -30,10 +29,19 @@ export function EcfSubmissionResponseFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'success': json['success'],
-        'documentId': json['documentId'],
+        'documentId': json['documentId'] == null ? undefined : json['documentId'],
+        'dgiiResponse': json['dgiiResponse'] == null ? undefined : EcfSubmissionResponseDgiiResponseFromJSON(json['dgiiResponse']),
+        'qrUrl': json['qrUrl'] == null ? undefined : json['qrUrl'],
+        'signatureTime': json['signatureTime'] == null ? undefined : (new Date(json['signatureTime'])),
+        'securityCode': json['securityCode'] == null ? undefined : json['securityCode'],
         'encf': json['encf'] == null ? undefined : json['encf'],
-        'trackId': json['trackId'] == null ? undefined : json['trackId'],
+        'documentType': json['documentType'] == null ? undefined : json['documentType'],
+        'printUrl': json['printUrl'] == null ? undefined : json['printUrl'],
+        'authType': json['authType'] == null ? undefined : json['authType'],
+        'timestamp': json['timestamp'] == null ? undefined : (new Date(json['timestamp'])),
         'message': json['message'] == null ? undefined : json['message'],
+        'contingencyMode': json['contingencyMode'] == null ? undefined : json['contingencyMode'],
+        'estimatedProcessTime': json['estimatedProcessTime'] == null ? undefined : json['estimatedProcessTime'],
     };
 }
 export function EcfSubmissionResponseToJSON(json) {
@@ -46,8 +54,17 @@ export function EcfSubmissionResponseToJSONTyped(value, ignoreDiscriminator = fa
     return {
         'success': value['success'],
         'documentId': value['documentId'],
+        'dgiiResponse': EcfSubmissionResponseDgiiResponseToJSON(value['dgiiResponse']),
+        'qrUrl': value['qrUrl'],
+        'signatureTime': value['signatureTime'] == null ? value['signatureTime'] : value['signatureTime'].toISOString(),
+        'securityCode': value['securityCode'],
         'encf': value['encf'],
-        'trackId': value['trackId'],
+        'documentType': value['documentType'],
+        'printUrl': value['printUrl'],
+        'authType': value['authType'],
+        'timestamp': value['timestamp'] == null ? value['timestamp'] : value['timestamp'].toISOString(),
         'message': value['message'],
+        'contingencyMode': value['contingencyMode'],
+        'estimatedProcessTime': value['estimatedProcessTime'],
     };
 }

package/dist/esm/models/EcfSubmissionResponseDgiiResponse.d.ts

@@ -0,0 +1,50 @@
+/**
+ * eCF-Pronesoft Integration API
+ * ## Overview Production-grade API for issuing Electronic Tax Receipts (e-CF) in the Dominican Republic through the Pronesoft platform.  ## Authentication — OAuth 2.0 Client Credentials  ### Steps 1. Get credentials from the portal:    - Sandbox: https://ecf.sandbox.pronesoft.com -> Apps -> Default Sandbox App    - Production: https://ecf.pronesoft.com -> Integrations -> Apps -> Create App 2. Request a token via POST /oauth/token — valid for 24 hours (86400s). 3. Use: Authorization: Bearer <accessToken> on every request. 4. Renew on HTTP 401. Best practice: renew 5 minutes before expiry.  ### Multi-company delegation To act on behalf of an associated company (branch), add:   x-tenant-id: <business-uuid> Do NOT send x-tenant-id when acting as the main company.  ### Sandbox specifics - Use any RNC starting with SBX (e.g. SBX123456) — no real certificate needed. - Sequences are automatic — no need to create them manually. - The environment field in the document body MUST be TesteCF.  ### Scopes business:read, business:create, business:update, members:read, members:invite, members:revoke, certificates:read, certificates:upload, certificates:update, documents:read, documents:create, documents:send, documents:receive, documents:update, approvals:read, approvals:commercial, sequences:read, sequences:create, sequences:update, sequences:cancel, business_info:read, certification:read, certification:write, reports:read
+ *
+ * The version of the OpenAPI document: 1.1.0
+ * Contact: support@pronesoft.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface EcfSubmissionResponseDgiiResponse
+ */
+export interface EcfSubmissionResponseDgiiResponse {
+    /**
+     * Aprobado, Rechazado, En Proceso
+     * @type {string}
+     * @memberof EcfSubmissionResponseDgiiResponse
+     */
+    estado?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof EcfSubmissionResponseDgiiResponse
+     */
+    trackId?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof EcfSubmissionResponseDgiiResponse
+     */
+    codigoError?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof EcfSubmissionResponseDgiiResponse
+     */
+    mensaje?: string;
+}
+/**
+ * Check if a given object implements the EcfSubmissionResponseDgiiResponse interface.
+ */
+export declare function instanceOfEcfSubmissionResponseDgiiResponse(value: object): value is EcfSubmissionResponseDgiiResponse;
+export declare function EcfSubmissionResponseDgiiResponseFromJSON(json: any): EcfSubmissionResponseDgiiResponse;
+export declare function EcfSubmissionResponseDgiiResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): EcfSubmissionResponseDgiiResponse;
+export declare function EcfSubmissionResponseDgiiResponseToJSON(json: any): EcfSubmissionResponseDgiiResponse;
+export declare function EcfSubmissionResponseDgiiResponseToJSONTyped(value?: EcfSubmissionResponseDgiiResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/EcfSubmissionResponseDgiiResponse.js

@@ -0,0 +1,47 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * eCF-Pronesoft Integration API
+ * ## Overview Production-grade API for issuing Electronic Tax Receipts (e-CF) in the Dominican Republic through the Pronesoft platform.  ## Authentication — OAuth 2.0 Client Credentials  ### Steps 1. Get credentials from the portal:    - Sandbox: https://ecf.sandbox.pronesoft.com -> Apps -> Default Sandbox App    - Production: https://ecf.pronesoft.com -> Integrations -> Apps -> Create App 2. Request a token via POST /oauth/token — valid for 24 hours (86400s). 3. Use: Authorization: Bearer <accessToken> on every request. 4. Renew on HTTP 401. Best practice: renew 5 minutes before expiry.  ### Multi-company delegation To act on behalf of an associated company (branch), add:   x-tenant-id: <business-uuid> Do NOT send x-tenant-id when acting as the main company.  ### Sandbox specifics - Use any RNC starting with SBX (e.g. SBX123456) — no real certificate needed. - Sequences are automatic — no need to create them manually. - The environment field in the document body MUST be TesteCF.  ### Scopes business:read, business:create, business:update, members:read, members:invite, members:revoke, certificates:read, certificates:upload, certificates:update, documents:read, documents:create, documents:send, documents:receive, documents:update, approvals:read, approvals:commercial, sequences:read, sequences:create, sequences:update, sequences:cancel, business_info:read, certification:read, certification:write, reports:read
+ *
+ * The version of the OpenAPI document: 1.1.0
+ * Contact: support@pronesoft.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the EcfSubmissionResponseDgiiResponse interface.
+ */
+export function instanceOfEcfSubmissionResponseDgiiResponse(value) {
+    return true;
+}
+export function EcfSubmissionResponseDgiiResponseFromJSON(json) {
+    return EcfSubmissionResponseDgiiResponseFromJSONTyped(json, false);
+}
+export function EcfSubmissionResponseDgiiResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'estado': json['estado'] == null ? undefined : json['estado'],
+        'trackId': json['trackId'] == null ? undefined : json['trackId'],
+        'codigoError': json['codigoError'] == null ? undefined : json['codigoError'],
+        'mensaje': json['mensaje'] == null ? undefined : json['mensaje'],
+    };
+}
+export function EcfSubmissionResponseDgiiResponseToJSON(json) {
+    return EcfSubmissionResponseDgiiResponseToJSONTyped(json, false);
+}
+export function EcfSubmissionResponseDgiiResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'estado': value['estado'],
+        'trackId': value['trackId'],
+        'codigoError': value['codigoError'],
+        'mensaje': value['mensaje'],
+    };
+}