@pronesoft-rd/ecf-sdk 0.0.1 → 0.0.3

package/dist/esm/apis/AssociatedCompaniesApi.d.ts

@@ -1,18 +1,17 @@
 /**
  * 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 * as runtime from '../runtime';
-import type { AssociatedCompany, CreateAssociatedCompany201Response, PrintFormat } from '../models/index';
+import type { AssociatedCompany, CompanyDocumentMetrics, CompanyMetrics, CreateAssociatedCompany201Response, DeleteAssociatedCompany200Response, PrintFormat } from '../models/index';
 export interface CreateAssociatedCompanyRequest {
-    xTenantId: string;
     email: string;
     password: string;
     name: string;
@@ -21,17 +20,36 @@ export interface CreateAssociatedCompanyRequest {
     address: string;
     city: string;
     country: string;
+    printerType: PrintFormat;
     firstName?: string;
     lastName?: string;
     jobTitle?: string;
     website?: string;
     category?: string;
     monthlySalesRange?: string;
-    printerType?: PrintFormat;
     logo?: Blob;
 }
+export interface DeleteAssociatedCompanyRequest {
+    companyId: string;
+}
+export interface GetCompanyDocumentMetricsRequest {
+    companyId: string;
+}
+export interface GetCompanyMetricsRequest {
+    companyId: string;
+}
 export interface ListAssociatedCompaniesRequest {
-    xTenantId: string;
+    page?: number;
+    limit?: number;
+}
+export interface UpdateAssociatedCompanyRequest {
+    companyId: string;
+    name?: string;
+    phone?: string;
+    website?: string;
+    city?: string;
+    country?: string;
+    logo?: Blob;
 }
 /**
  * AssociatedCompaniesApi - interface
@@ -42,78 +60,169 @@ export interface ListAssociatedCompaniesRequest {
 export interface AssociatedCompaniesApiInterface {
     /**
      * Creates request options for createAssociatedCompany without sending the request
-     * @param {string} xTenantId UUID of the company or branch (tenant) making the request. Obtained from the Pronesoft portal after account setup.
-     * @param {string} email Owner\\\&#39;s email address (used for login).
-     * @param {string} password Initial password for the new account (min 8 characters).
-     * @param {string} name Legal business name.
-     * @param {string} rnc Company RNC (9 digits) or personal cedula (11 digits).
+     * @param {string} email
+     * @param {string} password
+     * @param {string} name
+     * @param {string} rnc
      * @param {string} phone
      * @param {string} address
      * @param {string} city
      * @param {string} country
+     * @param {PrintFormat} printerType
      * @param {string} [firstName]
      * @param {string} [lastName]
      * @param {string} [jobTitle]
      * @param {string} [website]
-     * @param {string} [category] Business category or industry.
-     * @param {string} [monthlySalesRange] Estimated monthly sales range (e.g. \\\&quot;0-500000\\\&quot;).
-     * @param {PrintFormat} [printerType]
-     * @param {Blob} [logo] Company logo image file (multipart upload).
+     * @param {string} [category]
+     * @param {string} [monthlySalesRange]
+     * @param {Blob} [logo]
      * @throws {RequiredError}
      * @memberof AssociatedCompaniesApiInterface
      */
     createAssociatedCompanyRequestOpts(requestParameters: CreateAssociatedCompanyRequest): Promise<runtime.RequestOpts>;
     /**
-     * Registers a new branch or associated company under the current tenant account. Accepts multipart/form-data to support logo upload.
-     * @summary Create new associated company
-     * @param {string} xTenantId UUID of the company or branch (tenant) making the request. Obtained from the Pronesoft portal after account setup.
-     * @param {string} email Owner\\\&#39;s email address (used for login).
-     * @param {string} password Initial password for the new account (min 8 characters).
-     * @param {string} name Legal business name.
-     * @param {string} rnc Company RNC (9 digits) or personal cedula (11 digits).
+     *
+     * @summary Create associated company / branch
+     * @param {string} email
+     * @param {string} password
+     * @param {string} name
+     * @param {string} rnc
      * @param {string} phone
      * @param {string} address
      * @param {string} city
      * @param {string} country
+     * @param {PrintFormat} printerType
      * @param {string} [firstName]
      * @param {string} [lastName]
      * @param {string} [jobTitle]
      * @param {string} [website]
-     * @param {string} [category] Business category or industry.
-     * @param {string} [monthlySalesRange] Estimated monthly sales range (e.g. \\\&quot;0-500000\\\&quot;).
-     * @param {PrintFormat} [printerType]
-     * @param {Blob} [logo] Company logo image file (multipart upload).
+     * @param {string} [category]
+     * @param {string} [monthlySalesRange]
+     * @param {Blob} [logo]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof AssociatedCompaniesApiInterface
      */
     createAssociatedCompanyRaw(requestParameters: CreateAssociatedCompanyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateAssociatedCompany201Response>>;
     /**
-     * Registers a new branch or associated company under the current tenant account. Accepts multipart/form-data to support logo upload.
-     * Create new associated company
+     * Create associated company / branch
      */
     createAssociatedCompany(requestParameters: CreateAssociatedCompanyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateAssociatedCompany201Response>;
+    /**
+     * Creates request options for deleteAssociatedCompany without sending the request
+     * @param {string} companyId
+     * @throws {RequiredError}
+     * @memberof AssociatedCompaniesApiInterface
+     */
+    deleteAssociatedCompanyRequestOpts(requestParameters: DeleteAssociatedCompanyRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Permanently deletes an associated company. This action is irreversible.
+     * @summary Delete associated company
+     * @param {string} companyId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AssociatedCompaniesApiInterface
+     */
+    deleteAssociatedCompanyRaw(requestParameters: DeleteAssociatedCompanyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteAssociatedCompany200Response>>;
+    /**
+     * Permanently deletes an associated company. This action is irreversible.
+     * Delete associated company
+     */
+    deleteAssociatedCompany(requestParameters: DeleteAssociatedCompanyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteAssociatedCompany200Response>;
+    /**
+     * Creates request options for getCompanyDocumentMetrics without sending the request
+     * @param {string} companyId
+     * @throws {RequiredError}
+     * @memberof AssociatedCompaniesApiInterface
+     */
+    getCompanyDocumentMetricsRequestOpts(requestParameters: GetCompanyDocumentMetricsRequest): Promise<runtime.RequestOpts>;
+    /**
+     *
+     * @summary Get company document metrics
+     * @param {string} companyId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AssociatedCompaniesApiInterface
+     */
+    getCompanyDocumentMetricsRaw(requestParameters: GetCompanyDocumentMetricsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CompanyDocumentMetrics>>;
+    /**
+     * Get company document metrics
+     */
+    getCompanyDocumentMetrics(requestParameters: GetCompanyDocumentMetricsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CompanyDocumentMetrics>;
+    /**
+     * Creates request options for getCompanyMetrics without sending the request
+     * @param {string} companyId
+     * @throws {RequiredError}
+     * @memberof AssociatedCompaniesApiInterface
+     */
+    getCompanyMetricsRequestOpts(requestParameters: GetCompanyMetricsRequest): Promise<runtime.RequestOpts>;
+    /**
+     *
+     * @summary Get company metrics
+     * @param {string} companyId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AssociatedCompaniesApiInterface
+     */
+    getCompanyMetricsRaw(requestParameters: GetCompanyMetricsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CompanyMetrics>>;
+    /**
+     * Get company metrics
+     */
+    getCompanyMetrics(requestParameters: GetCompanyMetricsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CompanyMetrics>;
     /**
      * Creates request options for listAssociatedCompanies without sending the request
-     * @param {string} xTenantId UUID of the company or branch (tenant) making the request. Obtained from the Pronesoft portal after account setup.
+     * @param {number} [page]
+     * @param {number} [limit]
      * @throws {RequiredError}
      * @memberof AssociatedCompaniesApiInterface
      */
     listAssociatedCompaniesRequestOpts(requestParameters: ListAssociatedCompaniesRequest): Promise<runtime.RequestOpts>;
     /**
-     * Returns all companies and branches linked to the current tenant.
+     *
      * @summary List associated companies / branches
-     * @param {string} xTenantId UUID of the company or branch (tenant) making the request. Obtained from the Pronesoft portal after account setup.
+     * @param {number} [page]
+     * @param {number} [limit]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof AssociatedCompaniesApiInterface
      */
     listAssociatedCompaniesRaw(requestParameters: ListAssociatedCompaniesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<AssociatedCompany>>>;
     /**
-     * Returns all companies and branches linked to the current tenant.
      * List associated companies / branches
      */
     listAssociatedCompanies(requestParameters: ListAssociatedCompaniesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AssociatedCompany>>;
+    /**
+     * Creates request options for updateAssociatedCompany without sending the request
+     * @param {string} companyId
+     * @param {string} [name]
+     * @param {string} [phone]
+     * @param {string} [website]
+     * @param {string} [city]
+     * @param {string} [country]
+     * @param {Blob} [logo]
+     * @throws {RequiredError}
+     * @memberof AssociatedCompaniesApiInterface
+     */
+    updateAssociatedCompanyRequestOpts(requestParameters: UpdateAssociatedCompanyRequest): Promise<runtime.RequestOpts>;
+    /**
+     *
+     * @summary Update associated company
+     * @param {string} companyId
+     * @param {string} [name]
+     * @param {string} [phone]
+     * @param {string} [website]
+     * @param {string} [city]
+     * @param {string} [country]
+     * @param {Blob} [logo]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof AssociatedCompaniesApiInterface
+     */
+    updateAssociatedCompanyRaw(requestParameters: UpdateAssociatedCompanyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateAssociatedCompany201Response>>;
+    /**
+     * Update associated company
+     */
+    updateAssociatedCompany(requestParameters: UpdateAssociatedCompanyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateAssociatedCompany201Response>;
 }
 /**
  *
@@ -124,27 +233,73 @@ export declare class AssociatedCompaniesApi extends runtime.BaseAPI implements A
      */
     createAssociatedCompanyRequestOpts(requestParameters: CreateAssociatedCompanyRequest): Promise<runtime.RequestOpts>;
     /**
-     * Registers a new branch or associated company under the current tenant account. Accepts multipart/form-data to support logo upload.
-     * Create new associated company
+     * Create associated company / branch
      */
     createAssociatedCompanyRaw(requestParameters: CreateAssociatedCompanyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateAssociatedCompany201Response>>;
     /**
-     * Registers a new branch or associated company under the current tenant account. Accepts multipart/form-data to support logo upload.
-     * Create new associated company
+     * Create associated company / branch
      */
     createAssociatedCompany(requestParameters: CreateAssociatedCompanyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateAssociatedCompany201Response>;
+    /**
+     * Creates request options for deleteAssociatedCompany without sending the request
+     */
+    deleteAssociatedCompanyRequestOpts(requestParameters: DeleteAssociatedCompanyRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Permanently deletes an associated company. This action is irreversible.
+     * Delete associated company
+     */
+    deleteAssociatedCompanyRaw(requestParameters: DeleteAssociatedCompanyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeleteAssociatedCompany200Response>>;
+    /**
+     * Permanently deletes an associated company. This action is irreversible.
+     * Delete associated company
+     */
+    deleteAssociatedCompany(requestParameters: DeleteAssociatedCompanyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeleteAssociatedCompany200Response>;
+    /**
+     * Creates request options for getCompanyDocumentMetrics without sending the request
+     */
+    getCompanyDocumentMetricsRequestOpts(requestParameters: GetCompanyDocumentMetricsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Get company document metrics
+     */
+    getCompanyDocumentMetricsRaw(requestParameters: GetCompanyDocumentMetricsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CompanyDocumentMetrics>>;
+    /**
+     * Get company document metrics
+     */
+    getCompanyDocumentMetrics(requestParameters: GetCompanyDocumentMetricsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CompanyDocumentMetrics>;
+    /**
+     * Creates request options for getCompanyMetrics without sending the request
+     */
+    getCompanyMetricsRequestOpts(requestParameters: GetCompanyMetricsRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Get company metrics
+     */
+    getCompanyMetricsRaw(requestParameters: GetCompanyMetricsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CompanyMetrics>>;
+    /**
+     * Get company metrics
+     */
+    getCompanyMetrics(requestParameters: GetCompanyMetricsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CompanyMetrics>;
     /**
      * Creates request options for listAssociatedCompanies without sending the request
      */
     listAssociatedCompaniesRequestOpts(requestParameters: ListAssociatedCompaniesRequest): Promise<runtime.RequestOpts>;
     /**
-     * Returns all companies and branches linked to the current tenant.
      * List associated companies / branches
      */
     listAssociatedCompaniesRaw(requestParameters: ListAssociatedCompaniesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<AssociatedCompany>>>;
     /**
-     * Returns all companies and branches linked to the current tenant.
      * List associated companies / branches
      */
-    listAssociatedCompanies(requestParameters: ListAssociatedCompaniesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AssociatedCompany>>;
+    listAssociatedCompanies(requestParameters?: ListAssociatedCompaniesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<AssociatedCompany>>;
+    /**
+     * Creates request options for updateAssociatedCompany without sending the request
+     */
+    updateAssociatedCompanyRequestOpts(requestParameters: UpdateAssociatedCompanyRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Update associated company
+     */
+    updateAssociatedCompanyRaw(requestParameters: UpdateAssociatedCompanyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CreateAssociatedCompany201Response>>;
+    /**
+     * Update associated company
+     */
+    updateAssociatedCompany(requestParameters: UpdateAssociatedCompanyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CreateAssociatedCompany201Response>;
 }