@pronesoft-rd/ecf-sdk 0.0.1 → 0.0.3

package/src/apis/AuthenticationApi.ts

@@ -2,10 +2,10 @@
 /* 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
@@ -48,8 +48,8 @@ export interface AuthenticationApiInterface {
     getAccessTokenRequestOpts(requestParameters: GetAccessTokenRequest): Promise<runtime.RequestOpts>;
 
     /**
-     * Authenticates using OAuth 2.0 **Client Credentials** flow. Returns a Bearer token to use in subsequent requests.  **This endpoint does NOT require an Authorization header.**  ``` POST /oauth/token Content-Type: application/json  {   \"clientId\": \"your-client-id\",   \"clientSecret\": \"your-client-secret\" } ```  Use the returned `accessToken` as: ``` Authorization: Bearer <accessToken> ``` 
-     * @summary Get access token
+     * Authenticates using OAuth 2.0 Client Credentials flow. Returns a Bearer token valid for 24 hours (86400 seconds). This endpoint is public — no Authorization header needed. 
+     * @summary Get access token (OAuth 2.0)
      * @param {OAuthTokenRequest} oAuthTokenRequest 
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -58,8 +58,8 @@ export interface AuthenticationApiInterface {
     getAccessTokenRaw(requestParameters: GetAccessTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OAuthTokenResponse>>;
 
     /**
-     * Authenticates using OAuth 2.0 **Client Credentials** flow. Returns a Bearer token to use in subsequent requests.  **This endpoint does NOT require an Authorization header.**  ``` POST /oauth/token Content-Type: application/json  {   \"clientId\": \"your-client-id\",   \"clientSecret\": \"your-client-secret\" } ```  Use the returned `accessToken` as: ``` Authorization: Bearer <accessToken> ``` 
-     * Get access token
+     * Authenticates using OAuth 2.0 Client Credentials flow. Returns a Bearer token valid for 24 hours (86400 seconds). This endpoint is public — no Authorization header needed. 
+     * Get access token (OAuth 2.0)
      */
     getAccessToken(requestParameters: GetAccessTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OAuthTokenResponse>;
 
@@ -100,8 +100,8 @@ export class AuthenticationApi extends runtime.BaseAPI implements Authentication
     }
 
     /**
-     * Authenticates using OAuth 2.0 **Client Credentials** flow. Returns a Bearer token to use in subsequent requests.  **This endpoint does NOT require an Authorization header.**  ``` POST /oauth/token Content-Type: application/json  {   \"clientId\": \"your-client-id\",   \"clientSecret\": \"your-client-secret\" } ```  Use the returned `accessToken` as: ``` Authorization: Bearer <accessToken> ``` 
-     * Get access token
+     * Authenticates using OAuth 2.0 Client Credentials flow. Returns a Bearer token valid for 24 hours (86400 seconds). This endpoint is public — no Authorization header needed. 
+     * Get access token (OAuth 2.0)
      */
     async getAccessTokenRaw(requestParameters: GetAccessTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OAuthTokenResponse>> {
         const requestOptions = await this.getAccessTokenRequestOpts(requestParameters);
@@ -111,8 +111,8 @@ export class AuthenticationApi extends runtime.BaseAPI implements Authentication
     }
 
     /**
-     * Authenticates using OAuth 2.0 **Client Credentials** flow. Returns a Bearer token to use in subsequent requests.  **This endpoint does NOT require an Authorization header.**  ``` POST /oauth/token Content-Type: application/json  {   \"clientId\": \"your-client-id\",   \"clientSecret\": \"your-client-secret\" } ```  Use the returned `accessToken` as: ``` Authorization: Bearer <accessToken> ``` 
-     * Get access token
+     * Authenticates using OAuth 2.0 Client Credentials flow. Returns a Bearer token valid for 24 hours (86400 seconds). This endpoint is public — no Authorization header needed. 
+     * Get access token (OAuth 2.0)
      */
     async getAccessToken(requestParameters: GetAccessTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OAuthTokenResponse> {
         const response = await this.getAccessTokenRaw(requestParameters, initOverrides);

package/src/apis/AutomatedCertificationApi.ts

@@ -0,0 +1,382 @@
+/* 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.
+ */
+
+
+import * as runtime from '../runtime';
+import type {
+  CertificationNiche,
+  CertificationStatus,
+  ErrorResponse,
+  StartCertification200Response,
+  StartCertificationRequest,
+} from '../models/index';
+import {
+    CertificationNicheFromJSON,
+    CertificationNicheToJSON,
+    CertificationStatusFromJSON,
+    CertificationStatusToJSON,
+    ErrorResponseFromJSON,
+    ErrorResponseToJSON,
+    StartCertification200ResponseFromJSON,
+    StartCertification200ResponseToJSON,
+    StartCertificationRequestFromJSON,
+    StartCertificationRequestToJSON,
+} from '../models/index';
+
+export interface DownloadCertificationRequest {
+    id: string;
+}
+
+export interface GetCertificationStatusRequest {
+    id: string;
+}
+
+export interface StartCertificationOperationRequest {
+    startCertificationRequest: StartCertificationRequest;
+}
+
+/**
+ * AutomatedCertificationApi - interface
+ * 
+ * @export
+ * @interface AutomatedCertificationApiInterface
+ */
+export interface AutomatedCertificationApiInterface {
+    /**
+     * Creates request options for downloadCertification without sending the request
+     * @param {string} id 
+     * @throws {RequiredError}
+     * @memberof AutomatedCertificationApiInterface
+     */
+    downloadCertificationRequestOpts(requestParameters: DownloadCertificationRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Downloads ZIP with PDFs and XMLs. Only available when status is COMPLETED.
+     * @summary Download certification ZIP
+     * @param {string} id 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AutomatedCertificationApiInterface
+     */
+    downloadCertificationRaw(requestParameters: DownloadCertificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
+
+    /**
+     * Downloads ZIP with PDFs and XMLs. Only available when status is COMPLETED.
+     * Download certification ZIP
+     */
+    downloadCertification(requestParameters: DownloadCertificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
+
+    /**
+     * Creates request options for getCertificationStatus without sending the request
+     * @param {string} id 
+     * @throws {RequiredError}
+     * @memberof AutomatedCertificationApiInterface
+     */
+    getCertificationStatusRequestOpts(requestParameters: GetCertificationStatusRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * 
+     * @summary Get certification process status
+     * @param {string} id 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AutomatedCertificationApiInterface
+     */
+    getCertificationStatusRaw(requestParameters: GetCertificationStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CertificationStatus>>;
+
+    /**
+     * Get certification process status
+     */
+    getCertificationStatus(requestParameters: GetCertificationStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CertificationStatus>;
+
+    /**
+     * Creates request options for listCertificationNiches without sending the request
+     * @throws {RequiredError}
+     * @memberof AutomatedCertificationApiInterface
+     */
+    listCertificationNichesRequestOpts(): Promise<runtime.RequestOpts>;
+
+    /**
+     * 
+     * @summary List certification niches
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AutomatedCertificationApiInterface
+     */
+    listCertificationNichesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CertificationNiche>>>;
+
+    /**
+     * List certification niches
+     */
+    listCertificationNiches(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CertificationNiche>>;
+
+    /**
+     * Creates request options for startCertification without sending the request
+     * @param {StartCertificationRequest} startCertificationRequest 
+     * @throws {RequiredError}
+     * @memberof AutomatedCertificationApiInterface
+     */
+    startCertificationRequestOpts(requestParameters: StartCertificationOperationRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * 
+     * @summary Start certification process
+     * @param {StartCertificationRequest} startCertificationRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AutomatedCertificationApiInterface
+     */
+    startCertificationRaw(requestParameters: StartCertificationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StartCertification200Response>>;
+
+    /**
+     * Start certification process
+     */
+    startCertification(requestParameters: StartCertificationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StartCertification200Response>;
+
+}
+
+/**
+ * 
+ */
+export class AutomatedCertificationApi extends runtime.BaseAPI implements AutomatedCertificationApiInterface {
+
+    /**
+     * Creates request options for downloadCertification without sending the request
+     */
+    async downloadCertificationRequestOpts(requestParameters: DownloadCertificationRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling downloadCertification().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["certification:read"]);
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/dgii-ecf/automated-certification/{id}/download`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Downloads ZIP with PDFs and XMLs. Only available when status is COMPLETED.
+     * Download certification ZIP
+     */
+    async downloadCertificationRaw(requestParameters: DownloadCertificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>> {
+        const requestOptions = await this.downloadCertificationRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.BlobApiResponse(response);
+    }
+
+    /**
+     * Downloads ZIP with PDFs and XMLs. Only available when status is COMPLETED.
+     * Download certification ZIP
+     */
+    async downloadCertification(requestParameters: DownloadCertificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob> {
+        const response = await this.downloadCertificationRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getCertificationStatus without sending the request
+     */
+    async getCertificationStatusRequestOpts(requestParameters: GetCertificationStatusRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling getCertificationStatus().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["certification:read"]);
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/dgii-ecf/automated-certification/{id}/status`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Get certification process status
+     */
+    async getCertificationStatusRaw(requestParameters: GetCertificationStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CertificationStatus>> {
+        const requestOptions = await this.getCertificationStatusRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => CertificationStatusFromJSON(jsonValue));
+    }
+
+    /**
+     * Get certification process status
+     */
+    async getCertificationStatus(requestParameters: GetCertificationStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CertificationStatus> {
+        const response = await this.getCertificationStatusRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for listCertificationNiches without sending the request
+     */
+    async listCertificationNichesRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["certification:read"]);
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/dgii-ecf/automated-certification/niches`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * List certification niches
+     */
+    async listCertificationNichesRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<CertificationNiche>>> {
+        const requestOptions = await this.listCertificationNichesRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(CertificationNicheFromJSON));
+    }
+
+    /**
+     * List certification niches
+     */
+    async listCertificationNiches(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<CertificationNiche>> {
+        const response = await this.listCertificationNichesRaw(initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for startCertification without sending the request
+     */
+    async startCertificationRequestOpts(requestParameters: StartCertificationOperationRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['startCertificationRequest'] == null) {
+            throw new runtime.RequiredError(
+                'startCertificationRequest',
+                'Required parameter "startCertificationRequest" was null or undefined when calling startCertification().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["certification:write"]);
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/dgii-ecf/automated-certification/start`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: StartCertificationRequestToJSON(requestParameters['startCertificationRequest']),
+        };
+    }
+
+    /**
+     * Start certification process
+     */
+    async startCertificationRaw(requestParameters: StartCertificationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<StartCertification200Response>> {
+        const requestOptions = await this.startCertificationRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => StartCertification200ResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Start certification process
+     */
+    async startCertification(requestParameters: StartCertificationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<StartCertification200Response> {
+        const response = await this.startCertificationRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}