@pronesoft-rd/ecf-sdk 0.0.1 → 0.0.2

package/src/apis/ReportsApi.ts

@@ -0,0 +1,323 @@
+/* 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 {
+  Environment,
+  ErrorResponse,
+} from '../models/index';
+import {
+    EnvironmentFromJSON,
+    EnvironmentToJSON,
+    ErrorResponseFromJSON,
+    ErrorResponseToJSON,
+} from '../models/index';
+
+export interface Export606Request {
+    from: Date;
+    to: Date;
+    format: Export606FormatEnum;
+}
+
+export interface ExportSentDocumentsRequest {
+    from: Date;
+    to: Date;
+    env?: Environment;
+    encf?: string;
+    type?: string;
+    status?: ExportSentDocumentsStatusEnum;
+    trackId?: string;
+}
+
+/**
+ * ReportsApi - interface
+ * 
+ * @export
+ * @interface ReportsApiInterface
+ */
+export interface ReportsApiInterface {
+    /**
+     * Creates request options for export606 without sending the request
+     * @param {Date} from 
+     * @param {Date} to 
+     * @param {'txt' | 'xlsx'} format 
+     * @throws {RequiredError}
+     * @memberof ReportsApiInterface
+     */
+    export606RequestOpts(requestParameters: Export606Request): Promise<runtime.RequestOpts>;
+
+    /**
+     * Downloads the official Format 606 for DGII in TXT (official) or Excel format.
+     * @summary Export Format 606 (Purchases)
+     * @param {Date} from 
+     * @param {Date} to 
+     * @param {'txt' | 'xlsx'} format 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReportsApiInterface
+     */
+    export606Raw(requestParameters: Export606Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>>;
+
+    /**
+     * Downloads the official Format 606 for DGII in TXT (official) or Excel format.
+     * Export Format 606 (Purchases)
+     */
+    export606(requestParameters: Export606Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string>;
+
+    /**
+     * Creates request options for exportSentDocuments without sending the request
+     * @param {Date} from 
+     * @param {Date} to 
+     * @param {Environment} [env] 
+     * @param {string} [encf] 
+     * @param {string} [type] 
+     * @param {'ACCEPTED' | 'REJECTED' | 'PENDING'} [status] 
+     * @param {string} [trackId] 
+     * @throws {RequiredError}
+     * @memberof ReportsApiInterface
+     */
+    exportSentDocumentsRequestOpts(requestParameters: ExportSentDocumentsRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Downloads submitted documents in a date range as Excel. Requires reports:read scope.
+     * @summary Export sent documents report
+     * @param {Date} from 
+     * @param {Date} to 
+     * @param {Environment} [env] 
+     * @param {string} [encf] 
+     * @param {string} [type] 
+     * @param {'ACCEPTED' | 'REJECTED' | 'PENDING'} [status] 
+     * @param {string} [trackId] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ReportsApiInterface
+     */
+    exportSentDocumentsRaw(requestParameters: ExportSentDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
+
+    /**
+     * Downloads submitted documents in a date range as Excel. Requires reports:read scope.
+     * Export sent documents report
+     */
+    exportSentDocuments(requestParameters: ExportSentDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
+
+}
+
+/**
+ * 
+ */
+export class ReportsApi extends runtime.BaseAPI implements ReportsApiInterface {
+
+    /**
+     * Creates request options for export606 without sending the request
+     */
+    async export606RequestOpts(requestParameters: Export606Request): Promise<runtime.RequestOpts> {
+        if (requestParameters['from'] == null) {
+            throw new runtime.RequiredError(
+                'from',
+                'Required parameter "from" was null or undefined when calling export606().'
+            );
+        }
+
+        if (requestParameters['to'] == null) {
+            throw new runtime.RequiredError(
+                'to',
+                'Required parameter "to" was null or undefined when calling export606().'
+            );
+        }
+
+        if (requestParameters['format'] == null) {
+            throw new runtime.RequiredError(
+                'format',
+                'Required parameter "format" was null or undefined when calling export606().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['from'] != null) {
+            queryParameters['from'] = (requestParameters['from'] as any).toISOString().substring(0,10);
+        }
+
+        if (requestParameters['to'] != null) {
+            queryParameters['to'] = (requestParameters['to'] as any).toISOString().substring(0,10);
+        }
+
+        if (requestParameters['format'] != null) {
+            queryParameters['format'] = requestParameters['format'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["reports: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/606/export`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Downloads the official Format 606 for DGII in TXT (official) or Excel format.
+     * Export Format 606 (Purchases)
+     */
+    async export606Raw(requestParameters: Export606Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>> {
+        const requestOptions = await this.export606RequestOpts(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;
+        }
+    }
+
+    /**
+     * Downloads the official Format 606 for DGII in TXT (official) or Excel format.
+     * Export Format 606 (Purchases)
+     */
+    async export606(requestParameters: Export606Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string> {
+        const response = await this.export606Raw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Creates request options for exportSentDocuments without sending the request
+     */
+    async exportSentDocumentsRequestOpts(requestParameters: ExportSentDocumentsRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['from'] == null) {
+            throw new runtime.RequiredError(
+                'from',
+                'Required parameter "from" was null or undefined when calling exportSentDocuments().'
+            );
+        }
+
+        if (requestParameters['to'] == null) {
+            throw new runtime.RequiredError(
+                'to',
+                'Required parameter "to" was null or undefined when calling exportSentDocuments().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['from'] != null) {
+            queryParameters['from'] = (requestParameters['from'] as any).toISOString().substring(0,10);
+        }
+
+        if (requestParameters['to'] != null) {
+            queryParameters['to'] = (requestParameters['to'] as any).toISOString().substring(0,10);
+        }
+
+        if (requestParameters['env'] != null) {
+            queryParameters['env'] = requestParameters['env'];
+        }
+
+        if (requestParameters['encf'] != null) {
+            queryParameters['encf'] = requestParameters['encf'];
+        }
+
+        if (requestParameters['type'] != null) {
+            queryParameters['type'] = requestParameters['type'];
+        }
+
+        if (requestParameters['status'] != null) {
+            queryParameters['status'] = requestParameters['status'];
+        }
+
+        if (requestParameters['trackId'] != null) {
+            queryParameters['trackId'] = requestParameters['trackId'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("oauth2", ["reports: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/sent/export`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Downloads submitted documents in a date range as Excel. Requires reports:read scope.
+     * Export sent documents report
+     */
+    async exportSentDocumentsRaw(requestParameters: ExportSentDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>> {
+        const requestOptions = await this.exportSentDocumentsRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.BlobApiResponse(response);
+    }
+
+    /**
+     * Downloads submitted documents in a date range as Excel. Requires reports:read scope.
+     * Export sent documents report
+     */
+    async exportSentDocuments(requestParameters: ExportSentDocumentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob> {
+        const response = await this.exportSentDocumentsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}
+
+/**
+ * @export
+ */
+export const Export606FormatEnum = {
+    Txt: 'txt',
+    Xlsx: 'xlsx'
+} as const;
+export type Export606FormatEnum = typeof Export606FormatEnum[keyof typeof Export606FormatEnum];
+/**
+ * @export
+ */
+export const ExportSentDocumentsStatusEnum = {
+    Accepted: 'ACCEPTED',
+    Rejected: 'REJECTED',
+    Pending: 'PENDING'
+} as const;
+export type ExportSentDocumentsStatusEnum = typeof ExportSentDocumentsStatusEnum[keyof typeof ExportSentDocumentsStatusEnum];