@pronesoft-rd/ecf-sdk 0.0.1 → 0.0.2

package/src/apis/DocumentsSentApi.ts

@@ -0,0 +1,481 @@
+/* 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 {
+  DocumentStatsResponse,
+  Environment,
+  ErrorResponse,
+  SentDocumentDetail,
+  SentDocumentListResponse,
+} from '../models/index';
+import {
+    DocumentStatsResponseFromJSON,
+    DocumentStatsResponseToJSON,
+    EnvironmentFromJSON,
+    EnvironmentToJSON,
+    ErrorResponseFromJSON,
+    ErrorResponseToJSON,
+    SentDocumentDetailFromJSON,
+    SentDocumentDetailToJSON,
+    SentDocumentListResponseFromJSON,
+    SentDocumentListResponseToJSON,
+} from '../models/index';
+
+export interface DownloadDocumentRequest {
+    fileUrl: string;
+}
+
+export interface GetDocumentRequest {
+    id: string;
+    xTenantId?: string;
+}
+
+export interface GetDocumentStatsRequest {
+    xTenantId?: string;
+    period?: GetDocumentStatsPeriodEnum;
+}
+
+export interface ListSentDocumentsRequest {
+    xTenantId?: string;
+    env?: Environment;
+    ecf?: string;
+    type?: string;
+    status?: ListSentDocumentsStatusEnum;
+    dateFrom?: Date;
+    dateTo?: Date;
+    page?: number;
+    limit?: number;
+}
+
+/**
+ * DocumentsSentApi - interface
+ * 
+ * @export
+ * @interface DocumentsSentApiInterface
+ */
+export interface DocumentsSentApiInterface {
+    /**
+     * Creates request options for downloadDocument without sending the request
+     * @param {string} fileUrl 
+     * @throws {RequiredError}
+     * @memberof DocumentsSentApiInterface
+     */
+    downloadDocumentRequestOpts(requestParameters: DownloadDocumentRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * 
+     * @summary Download document XML
+     * @param {string} fileUrl 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentsSentApiInterface
+     */
+    downloadDocumentRaw(requestParameters: DownloadDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+
+    /**
+     * Download document XML
+     */
+    downloadDocument(requestParameters: DownloadDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+
+    /**
+     * Creates request options for getDocument without sending the request
+     * @param {string} id 
+     * @param {string} [xTenantId] UUID of the associated company (branch). Include ONLY when acting on behalf of a branch. Omit when acting as the main company. 
+     * @throws {RequiredError}
+     * @memberof DocumentsSentApiInterface
+     */
+    getDocumentRequestOpts(requestParameters: GetDocumentRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * 
+     * @summary Get document details
+     * @param {string} id 
+     * @param {string} [xTenantId] UUID of the associated company (branch). Include ONLY when acting on behalf of a branch. Omit when acting as the main company. 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentsSentApiInterface
+     */
+    getDocumentRaw(requestParameters: GetDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SentDocumentDetail>>;
+
+    /**
+     * Get document details
+     */
+    getDocument(requestParameters: GetDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SentDocumentDetail>;
+
+    /**
+     * Creates request options for getDocumentStats without sending the request
+     * @param {string} [xTenantId] UUID of the associated company (branch). Include ONLY when acting on behalf of a branch. Omit when acting as the main company. 
+     * @param {'7d' | '30d' | '90d'} [period] 
+     * @throws {RequiredError}
+     * @memberof DocumentsSentApiInterface
+     */
+    getDocumentStatsRequestOpts(requestParameters: GetDocumentStatsRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * 
+     * @summary Get document statistics
+     * @param {string} [xTenantId] UUID of the associated company (branch). Include ONLY when acting on behalf of a branch. Omit when acting as the main company. 
+     * @param {'7d' | '30d' | '90d'} [period] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentsSentApiInterface
+     */
+    getDocumentStatsRaw(requestParameters: GetDocumentStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentStatsResponse>>;
+
+    /**
+     * Get document statistics
+     */
+    getDocumentStats(requestParameters: GetDocumentStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentStatsResponse>;
+
+    /**
+     * Creates request options for listSentDocuments without sending the request
+     * @param {string} [xTenantId] UUID of the associated company (branch). Include ONLY when acting on behalf of a branch. Omit when acting as the main company. 
+     * @param {Environment} [env] 
+     * @param {string} [ecf] 
+     * @param {string} [type] 
+     * @param {'APPROVED' | 'REJECTED' | 'IN_PROCESS' | 'CONTINGENCY' | 'ERROR'} [status] 
+     * @param {Date} [dateFrom] 
+     * @param {Date} [dateTo] 
+     * @param {number} [page] 
+     * @param {number} [limit] 
+     * @throws {RequiredError}
+     * @memberof DocumentsSentApiInterface
+     */
+    listSentDocumentsRequestOpts(requestParameters: ListSentDocumentsRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * 
+     * @summary List sent documents
+     * @param {string} [xTenantId] UUID of the associated company (branch). Include ONLY when acting on behalf of a branch. Omit when acting as the main company. 
+     * @param {Environment} [env] 
+     * @param {string} [ecf] 
+     * @param {string} [type] 
+     * @param {'APPROVED' | 'REJECTED' | 'IN_PROCESS' | 'CONTINGENCY' | 'ERROR'} [status] 
+     * @param {Date} [dateFrom] 
+     * @param {Date} [dateTo] 
+     * @param {number} [page] 
+     * @param {number} [limit] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DocumentsSentApiInterface
+     */
+    listSentDocumentsRaw(requestParameters: ListSentDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SentDocumentListResponse>>;
+
+    /**
+     * List sent documents
+     */
+    listSentDocuments(requestParameters: ListSentDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SentDocumentListResponse>;
+
+}
+
+/**
+ * 
+ */
+export class DocumentsSentApi extends runtime.BaseAPI implements DocumentsSentApiInterface {
+
+    /**
+     * Creates request options for downloadDocument without sending the request
+     */
+    async downloadDocumentRequestOpts(requestParameters: DownloadDocumentRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['fileUrl'] == null) {
+            throw new runtime.RequiredError(
+                'fileUrl',
+                'Required parameter "fileUrl" was null or undefined when calling downloadDocument().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['fileUrl'] != null) {
+            queryParameters['fileUrl'] = requestParameters['fileUrl'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["documents: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 = `/documents/download`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Download document XML
+     */
+    async downloadDocumentRaw(requestParameters: DownloadDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>> {
+        const requestOptions = await this.downloadDocumentRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        if (this.isJsonMime(response.headers.get('content-type'))) {
+            return new runtime.JSONApiResponse<string>(response);
+        } else {
+            return new runtime.TextApiResponse(response) as any;
+        }
+    }
+
+    /**
+     * Download document XML
+     */
+    async downloadDocument(requestParameters: DownloadDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string> {
+        const response = await this.downloadDocumentRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getDocument without sending the request
+     */
+    async getDocumentRequestOpts(requestParameters: GetDocumentRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['id'] == null) {
+            throw new runtime.RequiredError(
+                'id',
+                'Required parameter "id" was null or undefined when calling getDocument().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (requestParameters['xTenantId'] != null) {
+            headerParameters['x-tenant-id'] = String(requestParameters['xTenantId']);
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["documents: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 = `/documents/{id}`;
+        urlPath = urlPath.replace(`{${"id"}}`, encodeURIComponent(String(requestParameters['id'])));
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Get document details
+     */
+    async getDocumentRaw(requestParameters: GetDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SentDocumentDetail>> {
+        const requestOptions = await this.getDocumentRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => SentDocumentDetailFromJSON(jsonValue));
+    }
+
+    /**
+     * Get document details
+     */
+    async getDocument(requestParameters: GetDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SentDocumentDetail> {
+        const response = await this.getDocumentRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for getDocumentStats without sending the request
+     */
+    async getDocumentStatsRequestOpts(requestParameters: GetDocumentStatsRequest): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        if (requestParameters['period'] != null) {
+            queryParameters['period'] = requestParameters['period'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (requestParameters['xTenantId'] != null) {
+            headerParameters['x-tenant-id'] = String(requestParameters['xTenantId']);
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["documents: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 = `/documents/stats/summary`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Get document statistics
+     */
+    async getDocumentStatsRaw(requestParameters: GetDocumentStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DocumentStatsResponse>> {
+        const requestOptions = await this.getDocumentStatsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => DocumentStatsResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Get document statistics
+     */
+    async getDocumentStats(requestParameters: GetDocumentStatsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DocumentStatsResponse> {
+        const response = await this.getDocumentStatsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for listSentDocuments without sending the request
+     */
+    async listSentDocumentsRequestOpts(requestParameters: ListSentDocumentsRequest): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        if (requestParameters['env'] != null) {
+            queryParameters['env'] = requestParameters['env'];
+        }
+
+        if (requestParameters['ecf'] != null) {
+            queryParameters['ecf'] = requestParameters['ecf'];
+        }
+
+        if (requestParameters['type'] != null) {
+            queryParameters['type'] = requestParameters['type'];
+        }
+
+        if (requestParameters['status'] != null) {
+            queryParameters['status'] = requestParameters['status'];
+        }
+
+        if (requestParameters['dateFrom'] != null) {
+            queryParameters['dateFrom'] = (requestParameters['dateFrom'] as any).toISOString().substring(0,10);
+        }
+
+        if (requestParameters['dateTo'] != null) {
+            queryParameters['dateTo'] = (requestParameters['dateTo'] as any).toISOString().substring(0,10);
+        }
+
+        if (requestParameters['page'] != null) {
+            queryParameters['page'] = requestParameters['page'];
+        }
+
+        if (requestParameters['limit'] != null) {
+            queryParameters['limit'] = requestParameters['limit'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (requestParameters['xTenantId'] != null) {
+            headerParameters['x-tenant-id'] = String(requestParameters['xTenantId']);
+        }
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["documents: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 = `/documents/sent`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * List sent documents
+     */
+    async listSentDocumentsRaw(requestParameters: ListSentDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SentDocumentListResponse>> {
+        const requestOptions = await this.listSentDocumentsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => SentDocumentListResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * List sent documents
+     */
+    async listSentDocuments(requestParameters: ListSentDocumentsRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SentDocumentListResponse> {
+        const response = await this.listSentDocumentsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}
+
+/**
+ * @export
+ */
+export const GetDocumentStatsPeriodEnum = {
+    _7d: '7d',
+    _30d: '30d',
+    _90d: '90d'
+} as const;
+export type GetDocumentStatsPeriodEnum = typeof GetDocumentStatsPeriodEnum[keyof typeof GetDocumentStatsPeriodEnum];
+/**
+ * @export
+ */
+export const ListSentDocumentsStatusEnum = {
+    Approved: 'APPROVED',
+    Rejected: 'REJECTED',
+    InProcess: 'IN_PROCESS',
+    Contingency: 'CONTINGENCY',
+    Error: 'ERROR'
+} as const;
+export type ListSentDocumentsStatusEnum = typeof ListSentDocumentsStatusEnum[keyof typeof ListSentDocumentsStatusEnum];