@pronesoft-rd/ecf-sdk 0.0.1 → 0.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +104 -2
- package/README.md +90 -24
- package/dist/apis/AssociatedCompaniesApi.d.ts +195 -40
- package/dist/apis/AssociatedCompaniesApi.js +252 -23
- package/dist/apis/AuthenticationApi.d.ts +11 -11
- package/dist/apis/AuthenticationApi.js +7 -7
- package/dist/apis/AutomatedCertificationApi.d.ts +164 -0
- package/dist/apis/AutomatedCertificationApi.js +232 -0
- package/dist/apis/CommercialApprovalsApi.d.ts +120 -0
- package/dist/apis/CommercialApprovalsApi.js +141 -0
- package/dist/apis/DigitalCertificatesApi.d.ts +17 -17
- package/dist/apis/DigitalCertificatesApi.js +7 -7
- package/dist/apis/DocumentsReceivedApi.d.ts +117 -0
- package/dist/apis/DocumentsReceivedApi.js +152 -0
- package/dist/apis/DocumentsSentApi.d.ts +216 -0
- package/dist/apis/DocumentsSentApi.js +286 -0
- package/dist/apis/ECFSubmissionApi.d.ts +130 -13
- package/dist/apis/ECFSubmissionApi.js +168 -8
- package/dist/apis/ReportsApi.d.ts +143 -0
- package/dist/apis/ReportsApi.js +193 -0
- package/dist/apis/TaxSequencesApi.d.ts +120 -38
- package/dist/apis/TaxSequencesApi.js +129 -22
- package/dist/apis/WebhookConfigurationApi.d.ts +60 -53
- package/dist/apis/WebhookConfigurationApi.js +49 -41
- package/dist/apis/index.d.ts +5 -0
- package/dist/apis/index.js +5 -0
- package/dist/esm/apis/AssociatedCompaniesApi.d.ts +195 -40
- package/dist/esm/apis/AssociatedCompaniesApi.js +253 -24
- package/dist/esm/apis/AuthenticationApi.d.ts +11 -11
- package/dist/esm/apis/AuthenticationApi.js +7 -7
- package/dist/esm/apis/AutomatedCertificationApi.d.ts +164 -0
- package/dist/esm/apis/AutomatedCertificationApi.js +228 -0
- package/dist/esm/apis/CommercialApprovalsApi.d.ts +120 -0
- package/dist/esm/apis/CommercialApprovalsApi.js +137 -0
- package/dist/esm/apis/DigitalCertificatesApi.d.ts +17 -17
- package/dist/esm/apis/DigitalCertificatesApi.js +7 -7
- package/dist/esm/apis/DocumentsReceivedApi.d.ts +117 -0
- package/dist/esm/apis/DocumentsReceivedApi.js +148 -0
- package/dist/esm/apis/DocumentsSentApi.d.ts +216 -0
- package/dist/esm/apis/DocumentsSentApi.js +282 -0
- package/dist/esm/apis/ECFSubmissionApi.d.ts +130 -13
- package/dist/esm/apis/ECFSubmissionApi.js +169 -9
- package/dist/esm/apis/ReportsApi.d.ts +143 -0
- package/dist/esm/apis/ReportsApi.js +189 -0
- package/dist/esm/apis/TaxSequencesApi.d.ts +120 -38
- package/dist/esm/apis/TaxSequencesApi.js +130 -23
- package/dist/esm/apis/WebhookConfigurationApi.d.ts +60 -53
- package/dist/esm/apis/WebhookConfigurationApi.js +49 -41
- package/dist/esm/apis/index.d.ts +5 -0
- package/dist/esm/apis/index.js +5 -0
- package/dist/esm/models/AccountType.d.ts +4 -8
- package/dist/esm/models/AccountType.js +4 -8
- package/dist/esm/models/AdditionalInfo.d.ts +60 -12
- package/dist/esm/models/AdditionalInfo.js +23 -7
- package/dist/esm/models/AlternativeCurrency.d.ts +78 -8
- package/dist/esm/models/AlternativeCurrency.js +27 -3
- package/dist/esm/models/ApprovalItem.d.ts +74 -0
- package/dist/esm/models/ApprovalItem.js +55 -0
- package/dist/esm/models/ApprovalListResponse.d.ts +40 -0
- package/dist/esm/models/ApprovalListResponse.js +45 -0
- package/dist/esm/models/AssociatedCompany.d.ts +33 -14
- package/dist/esm/models/AssociatedCompany.js +18 -11
- package/dist/esm/models/AssociatedCompanySubscription.d.ts +5 -5
- package/dist/esm/models/AssociatedCompanySubscription.js +3 -3
- package/dist/esm/models/AssociatedCompanySubscriptionPlan.d.ts +4 -4
- package/dist/esm/models/AssociatedCompanySubscriptionPlan.js +3 -3
- package/dist/esm/models/BillingIndicator.d.ts +4 -10
- package/dist/esm/models/BillingIndicator.js +4 -10
- package/dist/esm/models/Buyer.d.ts +71 -11
- package/dist/esm/models/Buyer.js +23 -3
- package/dist/esm/models/CertificationNiche.d.ts +51 -0
- package/dist/esm/models/CertificationNiche.js +48 -0
- package/dist/esm/models/CertificationNicheNicheItemsInner.d.ts +38 -0
- package/dist/esm/models/CertificationNicheNicheItemsInner.js +43 -0
- package/dist/esm/models/CertificationStatus.d.ts +54 -0
- package/dist/esm/models/CertificationStatus.js +54 -0
- package/dist/esm/models/CompanyDocumentMetrics.d.ts +53 -0
- package/dist/esm/models/CompanyDocumentMetrics.js +50 -0
- package/dist/esm/models/CompanyDocumentMetricsGroupByStatusInner.d.ts +39 -0
- package/dist/esm/models/CompanyDocumentMetricsGroupByStatusInner.js +44 -0
- package/dist/esm/models/CompanyDocumentMetricsGroupByStatusInnerCount.d.ts +32 -0
- package/dist/esm/models/CompanyDocumentMetricsGroupByStatusInnerCount.js +41 -0
- package/dist/esm/models/CompanyDocumentMetricsMainBusiness.d.ts +44 -0
- package/dist/esm/models/CompanyDocumentMetricsMainBusiness.js +45 -0
- package/dist/esm/models/CompanyDocumentMetricsTotals.d.ts +38 -0
- package/dist/esm/models/CompanyDocumentMetricsTotals.js +43 -0
- package/dist/esm/models/CompanyMetrics.d.ts +81 -0
- package/dist/esm/models/CompanyMetrics.js +58 -0
- package/dist/esm/models/CompanyMetricsDocumentsStatus.d.ts +44 -0
- package/dist/esm/models/CompanyMetricsDocumentsStatus.js +45 -0
- package/dist/esm/models/CreateAssociatedCompany201Response.d.ts +3 -3
- package/dist/esm/models/CreateAssociatedCompany201Response.js +3 -3
- package/dist/esm/models/CreateTaxSequence201Response.d.ts +39 -0
- package/dist/esm/models/CreateTaxSequence201Response.js +44 -0
- package/dist/esm/models/CreateTaxSequenceRequest.d.ts +27 -10
- package/dist/esm/models/CreateTaxSequenceRequest.js +13 -6
- package/dist/esm/models/DeleteAssociatedCompany200Response.d.ts +32 -0
- package/dist/esm/models/DeleteAssociatedCompany200Response.js +41 -0
- package/dist/esm/models/DiscountOrSurcharge.d.ts +31 -19
- package/dist/esm/models/DiscountOrSurcharge.js +16 -7
- package/dist/esm/models/DocumentStatsResponse.d.ts +54 -0
- package/dist/esm/models/DocumentStatsResponse.js +47 -0
- package/dist/esm/models/DocumentStatus.d.ts +28 -0
- package/dist/esm/models/DocumentStatus.js +46 -0
- package/dist/esm/models/EcfHistoryItem.d.ts +83 -0
- package/dist/esm/models/EcfHistoryItem.js +60 -0
- package/dist/esm/models/EcfStatsResponse.d.ts +80 -0
- package/dist/esm/models/EcfStatsResponse.js +57 -0
- package/dist/esm/models/EcfStatusResponse.d.ts +110 -0
- package/dist/esm/models/EcfStatusResponse.js +74 -0
- package/dist/esm/models/EcfStatusResponseMensajesInner.d.ts +38 -0
- package/dist/esm/models/EcfStatusResponseMensajesInner.js +43 -0
- package/dist/esm/models/EcfSubmissionResponse.d.ts +68 -11
- package/dist/esm/models/EcfSubmissionResponse.js +25 -8
- package/dist/esm/models/EcfSubmissionResponseDgiiResponse.d.ts +50 -0
- package/dist/esm/models/EcfSubmissionResponseDgiiResponse.js +47 -0
- package/dist/esm/models/ElectronicDocument.d.ts +166 -64
- package/dist/esm/models/ElectronicDocument.js +66 -22
- package/dist/esm/models/Environment.d.ts +4 -8
- package/dist/esm/models/Environment.js +4 -8
- package/dist/esm/models/ErrorResponse.d.ts +13 -7
- package/dist/esm/models/ErrorResponse.js +5 -3
- package/dist/esm/models/GetNextNumber200Response.d.ts +3 -3
- package/dist/esm/models/GetNextNumber200Response.js +3 -3
- package/dist/esm/models/GetNextNumber200ResponseData.d.ts +11 -5
- package/dist/esm/models/GetNextNumber200ResponseData.js +5 -3
- package/dist/esm/models/InvoiceType.d.ts +6 -14
- package/dist/esm/models/InvoiceType.js +6 -14
- package/dist/esm/models/InvoiceTypeSequence.d.ts +33 -0
- package/dist/esm/models/InvoiceTypeSequence.js +51 -0
- package/dist/esm/models/Item.d.ts +118 -21
- package/dist/esm/models/Item.js +45 -9
- package/dist/esm/models/ItemAdditionalTax.d.ts +7 -7
- package/dist/esm/models/ItemAdditionalTax.js +4 -6
- package/dist/esm/models/ItemAlternativeCurrency.d.ts +50 -0
- package/dist/esm/models/ItemAlternativeCurrency.js +47 -0
- package/dist/esm/models/ItemCodesInner.d.ts +38 -0
- package/dist/esm/models/ItemCodesInner.js +43 -0
- package/dist/esm/models/ItemDiscountInner.d.ts +44 -0
- package/dist/esm/models/ItemDiscountInner.js +45 -0
- package/dist/esm/models/ItemMiningInfo.d.ts +50 -0
- package/dist/esm/models/ItemMiningInfo.js +47 -0
- package/dist/esm/models/ListTaxSequences200Response.d.ts +10 -3
- package/dist/esm/models/ListTaxSequences200Response.js +6 -3
- package/dist/esm/models/OAuthTokenRequest.d.ts +6 -11
- package/dist/esm/models/OAuthTokenRequest.js +3 -3
- package/dist/esm/models/OAuthTokenResponse.d.ts +7 -9
- package/dist/esm/models/OAuthTokenResponse.js +3 -3
- package/dist/esm/models/Page.d.ts +15 -15
- package/dist/esm/models/Page.js +10 -16
- package/dist/esm/models/PaginationMeta.d.ts +50 -0
- package/dist/esm/models/PaginationMeta.js +47 -0
- package/dist/esm/models/PaymentForm.d.ts +39 -0
- package/dist/esm/models/PaymentForm.js +48 -0
- package/dist/esm/models/PaymentMethod.d.ts +4 -13
- package/dist/esm/models/PaymentMethod.js +4 -13
- package/dist/esm/models/PrintFormat.d.ts +3 -7
- package/dist/esm/models/PrintFormat.js +3 -7
- package/dist/esm/models/ProcessingLog.d.ts +54 -0
- package/dist/esm/models/ProcessingLog.js +54 -0
- package/dist/esm/models/RateLimitErrorResponse.d.ts +50 -0
- package/dist/esm/models/RateLimitErrorResponse.js +47 -0
- package/dist/esm/models/ReceivedDocument.d.ts +81 -0
- package/dist/esm/models/ReceivedDocument.js +58 -0
- package/dist/esm/models/ReceivedDocumentListResponse.d.ts +46 -0
- package/dist/esm/models/ReceivedDocumentListResponse.js +47 -0
- package/dist/esm/models/ReceivedDocumentStatsResponse.d.ts +46 -0
- package/dist/esm/models/ReceivedDocumentStatsResponse.js +45 -0
- package/dist/esm/models/ReferenceInfo.d.ts +9 -18
- package/dist/esm/models/ReferenceInfo.js +4 -4
- package/dist/esm/models/SentDocumentDetail.d.ts +107 -0
- package/dist/esm/models/SentDocumentDetail.js +68 -0
- package/dist/esm/models/SentDocumentListResponse.d.ts +46 -0
- package/dist/esm/models/SentDocumentListResponse.js +47 -0
- package/dist/esm/models/SentDocumentSummary.d.ts +94 -0
- package/dist/esm/models/SentDocumentSummary.js +63 -0
- package/dist/esm/models/SentDocumentSummaryBusiness.d.ts +38 -0
- package/dist/esm/models/SentDocumentSummaryBusiness.js +43 -0
- package/dist/esm/models/StartCertification200Response.d.ts +32 -0
- package/dist/esm/models/StartCertification200Response.js +41 -0
- package/dist/esm/models/StartCertificationRequest.d.ts +51 -0
- package/dist/esm/models/StartCertificationRequest.js +54 -0
- package/dist/esm/models/Subquantity.d.ts +6 -6
- package/dist/esm/models/Subquantity.js +3 -3
- package/dist/esm/models/Subtotal.d.ts +18 -12
- package/dist/esm/models/Subtotal.js +8 -10
- package/dist/esm/models/TaxSequence.d.ts +68 -10
- package/dist/esm/models/TaxSequence.js +33 -8
- package/dist/esm/models/TaxSequenceCreated.d.ts +64 -0
- package/dist/esm/models/TaxSequenceCreated.js +53 -0
- package/dist/esm/models/Totals.d.ts +29 -32
- package/dist/esm/models/Totals.js +5 -6
- package/dist/esm/models/Transport.d.ts +26 -14
- package/dist/esm/models/Transport.js +11 -7
- package/dist/esm/models/UpdateTaxSequenceRequest.d.ts +64 -0
- package/dist/esm/models/UpdateTaxSequenceRequest.js +53 -0
- package/dist/esm/models/UploadCertificateResponse.d.ts +7 -7
- package/dist/esm/models/UploadCertificateResponse.js +3 -3
- package/dist/esm/models/VoidTaxSequence200Response.d.ts +39 -0
- package/dist/esm/models/VoidTaxSequence200Response.js +44 -0
- package/dist/esm/models/VoidTaxSequence200ResponseData.d.ts +44 -0
- package/dist/esm/models/VoidTaxSequence200ResponseData.js +45 -0
- package/dist/esm/models/VoidTaxSequenceRequest.d.ts +50 -0
- package/dist/esm/models/VoidTaxSequenceRequest.js +55 -0
- package/dist/esm/models/WebhookConfigDetail.d.ts +81 -0
- package/dist/esm/models/WebhookConfigDetail.js +58 -0
- package/dist/esm/models/WebhookConfigResponse.d.ts +21 -9
- package/dist/esm/models/WebhookConfigResponse.js +7 -3
- package/dist/esm/models/WebhookEventType.d.ts +9 -8
- package/dist/esm/models/WebhookEventType.js +9 -8
- package/dist/esm/models/WebhookNotificationPayload.d.ts +10 -9
- package/dist/esm/models/WebhookNotificationPayload.js +3 -3
- package/dist/esm/models/WebhookStats.d.ts +45 -0
- package/dist/esm/models/WebhookStats.js +46 -0
- package/dist/esm/models/WebhookStatsStats.d.ts +62 -0
- package/dist/esm/models/WebhookStatsStats.js +51 -0
- package/dist/esm/models/index.d.ts +47 -1
- package/dist/esm/models/index.js +47 -1
- package/dist/esm/runtime.d.ts +3 -3
- package/dist/esm/runtime.js +3 -3
- package/dist/models/AccountType.d.ts +4 -8
- package/dist/models/AccountType.js +4 -8
- package/dist/models/AdditionalInfo.d.ts +60 -12
- package/dist/models/AdditionalInfo.js +23 -7
- package/dist/models/AlternativeCurrency.d.ts +78 -8
- package/dist/models/AlternativeCurrency.js +27 -3
- package/dist/models/ApprovalItem.d.ts +74 -0
- package/dist/models/ApprovalItem.js +62 -0
- package/dist/models/ApprovalListResponse.d.ts +40 -0
- package/dist/models/ApprovalListResponse.js +52 -0
- package/dist/models/AssociatedCompany.d.ts +33 -14
- package/dist/models/AssociatedCompany.js +18 -11
- package/dist/models/AssociatedCompanySubscription.d.ts +5 -5
- package/dist/models/AssociatedCompanySubscription.js +3 -3
- package/dist/models/AssociatedCompanySubscriptionPlan.d.ts +4 -4
- package/dist/models/AssociatedCompanySubscriptionPlan.js +3 -3
- package/dist/models/BillingIndicator.d.ts +4 -10
- package/dist/models/BillingIndicator.js +4 -10
- package/dist/models/Buyer.d.ts +71 -11
- package/dist/models/Buyer.js +23 -3
- package/dist/models/CertificationNiche.d.ts +51 -0
- package/dist/models/CertificationNiche.js +55 -0
- package/dist/models/CertificationNicheNicheItemsInner.d.ts +38 -0
- package/dist/models/CertificationNicheNicheItemsInner.js +50 -0
- package/dist/models/CertificationStatus.d.ts +54 -0
- package/dist/models/CertificationStatus.js +62 -0
- package/dist/models/CompanyDocumentMetrics.d.ts +53 -0
- package/dist/models/CompanyDocumentMetrics.js +57 -0
- package/dist/models/CompanyDocumentMetricsGroupByStatusInner.d.ts +39 -0
- package/dist/models/CompanyDocumentMetricsGroupByStatusInner.js +51 -0
- package/dist/models/CompanyDocumentMetricsGroupByStatusInnerCount.d.ts +32 -0
- package/dist/models/CompanyDocumentMetricsGroupByStatusInnerCount.js +48 -0
- package/dist/models/CompanyDocumentMetricsMainBusiness.d.ts +44 -0
- package/dist/models/CompanyDocumentMetricsMainBusiness.js +52 -0
- package/dist/models/CompanyDocumentMetricsTotals.d.ts +38 -0
- package/dist/models/CompanyDocumentMetricsTotals.js +50 -0
- package/dist/models/CompanyMetrics.d.ts +81 -0
- package/dist/models/CompanyMetrics.js +65 -0
- package/dist/models/CompanyMetricsDocumentsStatus.d.ts +44 -0
- package/dist/models/CompanyMetricsDocumentsStatus.js +52 -0
- package/dist/models/CreateAssociatedCompany201Response.d.ts +3 -3
- package/dist/models/CreateAssociatedCompany201Response.js +3 -3
- package/dist/models/CreateTaxSequence201Response.d.ts +39 -0
- package/dist/models/CreateTaxSequence201Response.js +51 -0
- package/dist/models/CreateTaxSequenceRequest.d.ts +27 -10
- package/dist/models/CreateTaxSequenceRequest.js +13 -6
- package/dist/models/DeleteAssociatedCompany200Response.d.ts +32 -0
- package/dist/models/DeleteAssociatedCompany200Response.js +48 -0
- package/dist/models/DiscountOrSurcharge.d.ts +31 -19
- package/dist/models/DiscountOrSurcharge.js +17 -8
- package/dist/models/DocumentStatsResponse.d.ts +54 -0
- package/dist/models/DocumentStatsResponse.js +54 -0
- package/dist/models/DocumentStatus.d.ts +28 -0
- package/dist/models/DocumentStatus.js +54 -0
- package/dist/models/EcfHistoryItem.d.ts +83 -0
- package/dist/models/EcfHistoryItem.js +67 -0
- package/dist/models/EcfStatsResponse.d.ts +80 -0
- package/dist/models/EcfStatsResponse.js +64 -0
- package/dist/models/EcfStatusResponse.d.ts +110 -0
- package/dist/models/EcfStatusResponse.js +82 -0
- package/dist/models/EcfStatusResponseMensajesInner.d.ts +38 -0
- package/dist/models/EcfStatusResponseMensajesInner.js +50 -0
- package/dist/models/EcfSubmissionResponse.d.ts +68 -11
- package/dist/models/EcfSubmissionResponse.js +25 -8
- package/dist/models/EcfSubmissionResponseDgiiResponse.d.ts +50 -0
- package/dist/models/EcfSubmissionResponseDgiiResponse.js +54 -0
- package/dist/models/ElectronicDocument.d.ts +166 -64
- package/dist/models/ElectronicDocument.js +67 -23
- package/dist/models/Environment.d.ts +4 -8
- package/dist/models/Environment.js +4 -8
- package/dist/models/ErrorResponse.d.ts +13 -7
- package/dist/models/ErrorResponse.js +5 -3
- package/dist/models/GetNextNumber200Response.d.ts +3 -3
- package/dist/models/GetNextNumber200Response.js +3 -3
- package/dist/models/GetNextNumber200ResponseData.d.ts +11 -5
- package/dist/models/GetNextNumber200ResponseData.js +5 -3
- package/dist/models/InvoiceType.d.ts +6 -14
- package/dist/models/InvoiceType.js +6 -14
- package/dist/models/InvoiceTypeSequence.d.ts +33 -0
- package/dist/models/InvoiceTypeSequence.js +59 -0
- package/dist/models/Item.d.ts +118 -21
- package/dist/models/Item.js +45 -9
- package/dist/models/ItemAdditionalTax.d.ts +7 -7
- package/dist/models/ItemAdditionalTax.js +4 -6
- package/dist/models/ItemAlternativeCurrency.d.ts +50 -0
- package/dist/models/ItemAlternativeCurrency.js +54 -0
- package/dist/models/ItemCodesInner.d.ts +38 -0
- package/dist/models/ItemCodesInner.js +50 -0
- package/dist/models/ItemDiscountInner.d.ts +44 -0
- package/dist/models/ItemDiscountInner.js +52 -0
- package/dist/models/ItemMiningInfo.d.ts +50 -0
- package/dist/models/ItemMiningInfo.js +54 -0
- package/dist/models/ListTaxSequences200Response.d.ts +10 -3
- package/dist/models/ListTaxSequences200Response.js +6 -3
- package/dist/models/OAuthTokenRequest.d.ts +6 -11
- package/dist/models/OAuthTokenRequest.js +3 -3
- package/dist/models/OAuthTokenResponse.d.ts +7 -9
- package/dist/models/OAuthTokenResponse.js +3 -3
- package/dist/models/Page.d.ts +15 -15
- package/dist/models/Page.js +10 -16
- package/dist/models/PaginationMeta.d.ts +50 -0
- package/dist/models/PaginationMeta.js +54 -0
- package/dist/models/PaymentForm.d.ts +39 -0
- package/dist/models/PaymentForm.js +55 -0
- package/dist/models/PaymentMethod.d.ts +4 -13
- package/dist/models/PaymentMethod.js +4 -13
- package/dist/models/PrintFormat.d.ts +3 -7
- package/dist/models/PrintFormat.js +3 -7
- package/dist/models/ProcessingLog.d.ts +54 -0
- package/dist/models/ProcessingLog.js +62 -0
- package/dist/models/RateLimitErrorResponse.d.ts +50 -0
- package/dist/models/RateLimitErrorResponse.js +54 -0
- package/dist/models/ReceivedDocument.d.ts +81 -0
- package/dist/models/ReceivedDocument.js +65 -0
- package/dist/models/ReceivedDocumentListResponse.d.ts +46 -0
- package/dist/models/ReceivedDocumentListResponse.js +54 -0
- package/dist/models/ReceivedDocumentStatsResponse.d.ts +46 -0
- package/dist/models/ReceivedDocumentStatsResponse.js +52 -0
- package/dist/models/ReferenceInfo.d.ts +9 -18
- package/dist/models/ReferenceInfo.js +4 -4
- package/dist/models/SentDocumentDetail.d.ts +107 -0
- package/dist/models/SentDocumentDetail.js +75 -0
- package/dist/models/SentDocumentListResponse.d.ts +46 -0
- package/dist/models/SentDocumentListResponse.js +54 -0
- package/dist/models/SentDocumentSummary.d.ts +94 -0
- package/dist/models/SentDocumentSummary.js +70 -0
- package/dist/models/SentDocumentSummaryBusiness.d.ts +38 -0
- package/dist/models/SentDocumentSummaryBusiness.js +50 -0
- package/dist/models/StartCertification200Response.d.ts +32 -0
- package/dist/models/StartCertification200Response.js +48 -0
- package/dist/models/StartCertificationRequest.d.ts +51 -0
- package/dist/models/StartCertificationRequest.js +61 -0
- package/dist/models/Subquantity.d.ts +6 -6
- package/dist/models/Subquantity.js +3 -3
- package/dist/models/Subtotal.d.ts +18 -12
- package/dist/models/Subtotal.js +8 -10
- package/dist/models/TaxSequence.d.ts +68 -10
- package/dist/models/TaxSequence.js +34 -8
- package/dist/models/TaxSequenceCreated.d.ts +64 -0
- package/dist/models/TaxSequenceCreated.js +60 -0
- package/dist/models/Totals.d.ts +29 -32
- package/dist/models/Totals.js +5 -6
- package/dist/models/Transport.d.ts +26 -14
- package/dist/models/Transport.js +11 -7
- package/dist/models/UpdateTaxSequenceRequest.d.ts +64 -0
- package/dist/models/UpdateTaxSequenceRequest.js +60 -0
- package/dist/models/UploadCertificateResponse.d.ts +7 -7
- package/dist/models/UploadCertificateResponse.js +3 -3
- package/dist/models/VoidTaxSequence200Response.d.ts +39 -0
- package/dist/models/VoidTaxSequence200Response.js +51 -0
- package/dist/models/VoidTaxSequence200ResponseData.d.ts +44 -0
- package/dist/models/VoidTaxSequence200ResponseData.js +52 -0
- package/dist/models/VoidTaxSequenceRequest.d.ts +50 -0
- package/dist/models/VoidTaxSequenceRequest.js +62 -0
- package/dist/models/WebhookConfigDetail.d.ts +81 -0
- package/dist/models/WebhookConfigDetail.js +65 -0
- package/dist/models/WebhookConfigResponse.d.ts +21 -9
- package/dist/models/WebhookConfigResponse.js +7 -3
- package/dist/models/WebhookEventType.d.ts +9 -8
- package/dist/models/WebhookEventType.js +9 -8
- package/dist/models/WebhookNotificationPayload.d.ts +10 -9
- package/dist/models/WebhookNotificationPayload.js +3 -3
- package/dist/models/WebhookStats.d.ts +45 -0
- package/dist/models/WebhookStats.js +53 -0
- package/dist/models/WebhookStatsStats.d.ts +62 -0
- package/dist/models/WebhookStatsStats.js +58 -0
- package/dist/models/index.d.ts +47 -1
- package/dist/models/index.js +47 -1
- package/dist/runtime.d.ts +3 -3
- package/dist/runtime.js +3 -3
- package/docs/AccountType.md +2 -2
- package/docs/AdditionalInfo.md +21 -6
- package/docs/AlternativeCurrency.md +26 -3
- package/docs/ApprovalItem.md +48 -0
- package/docs/ApprovalListResponse.md +36 -0
- package/docs/AssociatedCompaniesApi.md +350 -42
- package/docs/AssociatedCompany.md +15 -10
- package/docs/AssociatedCompanySubscription.md +1 -1
- package/docs/AssociatedCompanySubscriptionPlan.md +1 -1
- package/docs/AuthenticationApi.md +8 -8
- package/docs/AutomatedCertificationApi.md +294 -0
- package/docs/BillingIndicator.md +2 -2
- package/docs/Buyer.md +24 -5
- package/docs/CertificationNiche.md +40 -0
- package/docs/CertificationNicheNicheItemsInner.md +36 -0
- package/docs/CertificationStatus.md +38 -0
- package/docs/CommercialApprovalsApi.md +114 -0
- package/docs/CompanyDocumentMetrics.md +40 -0
- package/docs/CompanyDocumentMetricsGroupByStatusInner.md +36 -0
- package/docs/CompanyDocumentMetricsGroupByStatusInnerCount.md +34 -0
- package/docs/CompanyDocumentMetricsMainBusiness.md +38 -0
- package/docs/CompanyDocumentMetricsTotals.md +36 -0
- package/docs/CompanyMetrics.md +50 -0
- package/docs/CompanyMetricsDocumentsStatus.md +38 -0
- package/docs/CreateAssociatedCompany201Response.md +1 -1
- package/docs/CreateTaxSequence201Response.md +36 -0
- package/docs/CreateTaxSequenceRequest.md +9 -4
- package/docs/DeleteAssociatedCompany200Response.md +34 -0
- package/docs/DigitalCertificatesApi.md +18 -16
- package/docs/DiscountOrSurcharge.md +7 -6
- package/docs/DocumentStatsResponse.md +40 -0
- package/docs/DocumentStatus.md +32 -0
- package/docs/DocumentsReceivedApi.md +175 -0
- package/docs/DocumentsSentApi.md +330 -0
- package/docs/ECFSubmissionApi.md +245 -13
- package/docs/EcfHistoryItem.md +50 -0
- package/docs/EcfStatsResponse.md +50 -0
- package/docs/EcfStatusResponse.md +56 -0
- package/docs/EcfStatusResponseMensajesInner.md +36 -0
- package/docs/EcfSubmissionResponse.md +22 -4
- package/docs/EcfSubmissionResponseDgiiResponse.md +40 -0
- package/docs/ElectronicDocument.md +52 -12
- package/docs/Environment.md +2 -2
- package/docs/ErrorResponse.md +6 -5
- package/docs/GetNextNumber200Response.md +1 -1
- package/docs/GetNextNumber200ResponseData.md +5 -3
- package/docs/InvoiceType.md +2 -2
- package/docs/InvoiceTypeSequence.md +33 -0
- package/docs/Item.md +42 -11
- package/docs/ItemAdditionalTax.md +1 -2
- package/docs/ItemAlternativeCurrency.md +40 -0
- package/docs/ItemCodesInner.md +36 -0
- package/docs/ItemDiscountInner.md +38 -0
- package/docs/ItemMiningInfo.md +40 -0
- package/docs/ListTaxSequences200Response.md +3 -1
- package/docs/OAuthTokenRequest.md +4 -4
- package/docs/OAuthTokenResponse.md +4 -4
- package/docs/Page.md +5 -6
- package/docs/PaginationMeta.md +40 -0
- package/docs/PaymentForm.md +36 -0
- package/docs/PaymentMethod.md +2 -2
- package/docs/PrintFormat.md +1 -2
- package/docs/ProcessingLog.md +38 -0
- package/docs/RateLimitErrorResponse.md +40 -0
- package/docs/ReceivedDocument.md +50 -0
- package/docs/ReceivedDocumentListResponse.md +38 -0
- package/docs/ReceivedDocumentStatsResponse.md +38 -0
- package/docs/ReferenceInfo.md +2 -2
- package/docs/ReportsApi.md +186 -0
- package/docs/SentDocumentDetail.md +58 -0
- package/docs/SentDocumentListResponse.md +38 -0
- package/docs/SentDocumentSummary.md +54 -0
- package/docs/SentDocumentSummaryBusiness.md +36 -0
- package/docs/StartCertification200Response.md +34 -0
- package/docs/StartCertificationRequest.md +40 -0
- package/docs/Subquantity.md +1 -2
- package/docs/Subtotal.md +5 -4
- package/docs/TaxSequence.md +21 -6
- package/docs/TaxSequenceCreated.md +44 -0
- package/docs/TaxSequencesApi.md +197 -38
- package/docs/Totals.md +2 -3
- package/docs/Transport.md +9 -6
- package/docs/UpdateTaxSequenceRequest.md +44 -0
- package/docs/UploadCertificateResponse.md +2 -3
- package/docs/VoidTaxSequence200Response.md +36 -0
- package/docs/VoidTaxSequence200ResponseData.md +38 -0
- package/docs/VoidTaxSequenceRequest.md +40 -0
- package/docs/WebhookConfigDetail.md +50 -0
- package/docs/WebhookConfigResponse.md +6 -3
- package/docs/WebhookConfigurationApi.md +47 -50
- package/docs/WebhookEventType.md +1 -2
- package/docs/WebhookNotificationPayload.md +3 -3
- package/docs/WebhookStats.md +38 -0
- package/docs/WebhookStatsStats.md +44 -0
- package/package.json +1 -1
- package/src/apis/AssociatedCompaniesApi.ts +455 -57
- package/src/apis/AuthenticationApi.ts +11 -11
- package/src/apis/AutomatedCertificationApi.ts +382 -0
- package/src/apis/CommercialApprovalsApi.ts +234 -0
- package/src/apis/DigitalCertificatesApi.ts +17 -17
- package/src/apis/DocumentsReceivedApi.ts +256 -0
- package/src/apis/DocumentsSentApi.ts +481 -0
- package/src/apis/ECFSubmissionApi.ts +309 -17
- package/src/apis/ReportsApi.ts +323 -0
- package/src/apis/TaxSequencesApi.ts +264 -63
- package/src/apis/WebhookConfigurationApi.ts +90 -76
- package/src/apis/index.ts +5 -0
- package/src/models/AccountType.ts +4 -8
- package/src/models/AdditionalInfo.ts +80 -16
- package/src/models/AlternativeCurrency.ts +102 -8
- package/src/models/ApprovalItem.ts +121 -0
- package/src/models/ApprovalListResponse.ts +88 -0
- package/src/models/AssociatedCompany.ts +53 -22
- package/src/models/AssociatedCompanySubscription.ts +5 -5
- package/src/models/AssociatedCompanySubscriptionPlan.ts +4 -4
- package/src/models/BillingIndicator.ts +4 -10
- package/src/models/Buyer.ts +91 -11
- package/src/models/CertificationNiche.ts +97 -0
- package/src/models/CertificationNicheNicheItemsInner.ts +73 -0
- package/src/models/CertificationStatus.ts +94 -0
- package/src/models/CompanyDocumentMetrics.ts +111 -0
- package/src/models/CompanyDocumentMetricsGroupByStatusInner.ts +81 -0
- package/src/models/CompanyDocumentMetricsGroupByStatusInnerCount.ts +65 -0
- package/src/models/CompanyDocumentMetricsMainBusiness.ts +81 -0
- package/src/models/CompanyDocumentMetricsTotals.ts +73 -0
- package/src/models/CompanyMetrics.ts +137 -0
- package/src/models/CompanyMetricsDocumentsStatus.ts +81 -0
- package/src/models/CreateAssociatedCompany201Response.ts +3 -3
- package/src/models/CreateTaxSequence201Response.ts +81 -0
- package/src/models/CreateTaxSequenceRequest.ts +46 -17
- package/src/models/DeleteAssociatedCompany200Response.ts +65 -0
- package/src/models/DiscountOrSurcharge.ts +38 -23
- package/src/models/DocumentStatsResponse.ts +89 -0
- package/src/models/DocumentStatus.ts +56 -0
- package/src/models/EcfHistoryItem.ts +153 -0
- package/src/models/EcfStatsResponse.ts +129 -0
- package/src/models/EcfStatusResponse.ts +193 -0
- package/src/models/EcfStatusResponseMensajesInner.ts +73 -0
- package/src/models/EcfSubmissionResponse.ts +96 -15
- package/src/models/EcfSubmissionResponseDgiiResponse.ts +89 -0
- package/src/models/ElectronicDocument.ts +252 -97
- package/src/models/Environment.ts +4 -8
- package/src/models/ErrorResponse.ts +15 -7
- package/src/models/GetNextNumber200Response.ts +3 -3
- package/src/models/GetNextNumber200ResponseData.ts +13 -5
- package/src/models/InvoiceType.ts +6 -14
- package/src/models/InvoiceTypeSequence.ts +61 -0
- package/src/models/Item.ts +180 -27
- package/src/models/ItemAdditionalTax.ts +8 -9
- package/src/models/ItemAlternativeCurrency.ts +89 -0
- package/src/models/ItemCodesInner.ts +73 -0
- package/src/models/ItemDiscountInner.ts +81 -0
- package/src/models/ItemMiningInfo.ts +89 -0
- package/src/models/ListTaxSequences200Response.ts +18 -3
- package/src/models/OAuthTokenRequest.ts +6 -11
- package/src/models/OAuthTokenResponse.ts +7 -9
- package/src/models/Page.ts +22 -25
- package/src/models/PaginationMeta.ts +89 -0
- package/src/models/PaymentForm.ts +85 -0
- package/src/models/PaymentMethod.ts +4 -13
- package/src/models/PrintFormat.ts +3 -7
- package/src/models/ProcessingLog.ts +94 -0
- package/src/models/RateLimitErrorResponse.ts +89 -0
- package/src/models/ReceivedDocument.ts +137 -0
- package/src/models/ReceivedDocumentListResponse.ts +96 -0
- package/src/models/ReceivedDocumentStatsResponse.ts +81 -0
- package/src/models/ReferenceInfo.ts +10 -19
- package/src/models/SentDocumentDetail.ts +185 -0
- package/src/models/SentDocumentListResponse.ts +96 -0
- package/src/models/SentDocumentSummary.ts +162 -0
- package/src/models/SentDocumentSummaryBusiness.ts +73 -0
- package/src/models/StartCertification200Response.ts +65 -0
- package/src/models/StartCertificationRequest.ts +102 -0
- package/src/models/Subquantity.ts +6 -6
- package/src/models/Subtotal.ts +23 -17
- package/src/models/TaxSequence.ts +94 -19
- package/src/models/TaxSequenceCreated.ts +122 -0
- package/src/models/Totals.ts +31 -41
- package/src/models/Transport.ts +34 -18
- package/src/models/UpdateTaxSequenceRequest.ts +122 -0
- package/src/models/UploadCertificateResponse.ts +7 -7
- package/src/models/VoidTaxSequence200Response.ts +81 -0
- package/src/models/VoidTaxSequence200ResponseData.ts +81 -0
- package/src/models/VoidTaxSequenceRequest.ts +93 -0
- package/src/models/WebhookConfigDetail.ts +137 -0
- package/src/models/WebhookConfigResponse.ts +25 -9
- package/src/models/WebhookEventType.ts +9 -8
- package/src/models/WebhookNotificationPayload.ts +10 -9
- package/src/models/WebhookStats.ts +89 -0
- package/src/models/WebhookStatsStats.ts +105 -0
- package/src/models/index.ts +47 -1
- package/src/runtime.ts +3 -3
|
@@ -4,18 +4,20 @@ All URIs are relative to *https://api.ecf.sandbox.pronesoft.com/api/v1*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
| [**createAssociatedCompany**](AssociatedCompaniesApi.md#createassociatedcompany) | **POST** /associated-companies | Create
|
|
7
|
+
| [**createAssociatedCompany**](AssociatedCompaniesApi.md#createassociatedcompany) | **POST** /associated-companies | Create associated company / branch |
|
|
8
|
+
| [**deleteAssociatedCompany**](AssociatedCompaniesApi.md#deleteassociatedcompany) | **DELETE** /associated-companies/{companyId} | Delete associated company |
|
|
9
|
+
| [**getCompanyDocumentMetrics**](AssociatedCompaniesApi.md#getcompanydocumentmetrics) | **GET** /associated-companies/{companyId}/documents-metrics | Get company document metrics |
|
|
10
|
+
| [**getCompanyMetrics**](AssociatedCompaniesApi.md#getcompanymetrics) | **GET** /associated-companies/{companyId}/metrics | Get company metrics |
|
|
8
11
|
| [**listAssociatedCompanies**](AssociatedCompaniesApi.md#listassociatedcompanies) | **GET** /associated-companies | List associated companies / branches |
|
|
12
|
+
| [**updateAssociatedCompany**](AssociatedCompaniesApi.md#updateassociatedcompany) | **PUT** /associated-companies/{companyId} | Update associated company |
|
|
9
13
|
|
|
10
14
|
|
|
11
15
|
|
|
12
16
|
## createAssociatedCompany
|
|
13
17
|
|
|
14
|
-
> CreateAssociatedCompany201Response createAssociatedCompany(
|
|
18
|
+
> CreateAssociatedCompany201Response createAssociatedCompany(email, password, name, rnc, phone, address, city, country, printerType, firstName, lastName, jobTitle, website, category, monthlySalesRange, logo)
|
|
15
19
|
|
|
16
|
-
Create
|
|
17
|
-
|
|
18
|
-
Registers a new branch or associated company under the current tenant account. Accepts multipart/form-data to support logo upload.
|
|
20
|
+
Create associated company / branch
|
|
19
21
|
|
|
20
22
|
### Example
|
|
21
23
|
|
|
@@ -23,11 +25,11 @@ Registers a new branch or associated company under the current tenant account. A
|
|
|
23
25
|
import {
|
|
24
26
|
Configuration,
|
|
25
27
|
AssociatedCompaniesApi,
|
|
26
|
-
} from '@pronesoft/ecf-sdk';
|
|
27
|
-
import type { CreateAssociatedCompanyRequest } from '@pronesoft/ecf-sdk';
|
|
28
|
+
} from '@pronesoft-rd/ecf-sdk';
|
|
29
|
+
import type { CreateAssociatedCompanyRequest } from '@pronesoft-rd/ecf-sdk';
|
|
28
30
|
|
|
29
31
|
async function example() {
|
|
30
|
-
console.log("🚀 Testing @pronesoft/ecf-sdk SDK...");
|
|
32
|
+
console.log("🚀 Testing @pronesoft-rd/ecf-sdk SDK...");
|
|
31
33
|
const config = new Configuration({
|
|
32
34
|
// To configure OAuth2 access token for authorization: oauth2 application
|
|
33
35
|
accessToken: "YOUR ACCESS TOKEN",
|
|
@@ -37,15 +39,13 @@ async function example() {
|
|
|
37
39
|
const api = new AssociatedCompaniesApi(config);
|
|
38
40
|
|
|
39
41
|
const body = {
|
|
40
|
-
// string
|
|
41
|
-
xTenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
42
|
-
// string | Owner\\\'s email address (used for login).
|
|
42
|
+
// string
|
|
43
43
|
email: email_example,
|
|
44
|
-
// string
|
|
44
|
+
// string
|
|
45
45
|
password: password_example,
|
|
46
|
-
// string
|
|
46
|
+
// string
|
|
47
47
|
name: name_example,
|
|
48
|
-
// string
|
|
48
|
+
// string
|
|
49
49
|
rnc: rnc_example,
|
|
50
50
|
// string
|
|
51
51
|
phone: phone_example,
|
|
@@ -55,6 +55,8 @@ async function example() {
|
|
|
55
55
|
city: city_example,
|
|
56
56
|
// string
|
|
57
57
|
country: country_example,
|
|
58
|
+
// PrintFormat
|
|
59
|
+
printerType: ...,
|
|
58
60
|
// string (optional)
|
|
59
61
|
firstName: firstName_example,
|
|
60
62
|
// string (optional)
|
|
@@ -63,13 +65,11 @@ async function example() {
|
|
|
63
65
|
jobTitle: jobTitle_example,
|
|
64
66
|
// string (optional)
|
|
65
67
|
website: website_example,
|
|
66
|
-
// string
|
|
68
|
+
// string (optional)
|
|
67
69
|
category: category_example,
|
|
68
|
-
// string
|
|
70
|
+
// string (optional)
|
|
69
71
|
monthlySalesRange: monthlySalesRange_example,
|
|
70
|
-
//
|
|
71
|
-
printerType: ...,
|
|
72
|
-
// Blob | Company logo image file (multipart upload). (optional)
|
|
72
|
+
// Blob (optional)
|
|
73
73
|
logo: BINARY_DATA_HERE,
|
|
74
74
|
} satisfies CreateAssociatedCompanyRequest;
|
|
75
75
|
|
|
@@ -90,23 +90,22 @@ example().catch(console.error);
|
|
|
90
90
|
|
|
91
91
|
| Name | Type | Description | Notes |
|
|
92
92
|
|------------- | ------------- | ------------- | -------------|
|
|
93
|
-
| **
|
|
94
|
-
| **
|
|
95
|
-
| **
|
|
96
|
-
| **
|
|
97
|
-
| **rnc** | `string` | Company RNC (9 digits) or personal cedula (11 digits). | [Defaults to `undefined`] |
|
|
93
|
+
| **email** | `string` | | [Defaults to `undefined`] |
|
|
94
|
+
| **password** | `string` | | [Defaults to `undefined`] |
|
|
95
|
+
| **name** | `string` | | [Defaults to `undefined`] |
|
|
96
|
+
| **rnc** | `string` | | [Defaults to `undefined`] |
|
|
98
97
|
| **phone** | `string` | | [Defaults to `undefined`] |
|
|
99
98
|
| **address** | `string` | | [Defaults to `undefined`] |
|
|
100
99
|
| **city** | `string` | | [Defaults to `undefined`] |
|
|
101
100
|
| **country** | `string` | | [Defaults to `undefined`] |
|
|
101
|
+
| **printerType** | `PrintFormat` | | [Defaults to `undefined`] [Enum: A4, thermal_80, thermal_58] |
|
|
102
102
|
| **firstName** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
103
103
|
| **lastName** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
104
104
|
| **jobTitle** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
105
105
|
| **website** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
106
|
-
| **category** | `string` |
|
|
107
|
-
| **monthlySalesRange** | `string` |
|
|
108
|
-
| **
|
|
109
|
-
| **logo** | `Blob` | Company logo image file (multipart upload). | [Optional] [Defaults to `undefined`] |
|
|
106
|
+
| **category** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
107
|
+
| **monthlySalesRange** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
108
|
+
| **logo** | `Blob` | | [Optional] [Defaults to `undefined`] |
|
|
110
109
|
|
|
111
110
|
### Return type
|
|
112
111
|
|
|
@@ -125,32 +124,248 @@ example().catch(console.error);
|
|
|
125
124
|
### HTTP response details
|
|
126
125
|
| Status code | Description | Response headers |
|
|
127
126
|
|-------------|-------------|------------------|
|
|
128
|
-
| **201** |
|
|
129
|
-
| **400** | Validation error (400
|
|
130
|
-
| **401** |
|
|
127
|
+
| **201** | Company created successfully | - |
|
|
128
|
+
| **400** | Validation error (400). Check the message field for details. | - |
|
|
129
|
+
| **401** | Token missing, expired, or invalid. Call POST /oauth/token to renew. | - |
|
|
130
|
+
|
|
131
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
## deleteAssociatedCompany
|
|
135
|
+
|
|
136
|
+
> DeleteAssociatedCompany200Response deleteAssociatedCompany(companyId)
|
|
137
|
+
|
|
138
|
+
Delete associated company
|
|
139
|
+
|
|
140
|
+
Permanently deletes an associated company. This action is irreversible.
|
|
141
|
+
|
|
142
|
+
### Example
|
|
143
|
+
|
|
144
|
+
```ts
|
|
145
|
+
import {
|
|
146
|
+
Configuration,
|
|
147
|
+
AssociatedCompaniesApi,
|
|
148
|
+
} from '@pronesoft-rd/ecf-sdk';
|
|
149
|
+
import type { DeleteAssociatedCompanyRequest } from '@pronesoft-rd/ecf-sdk';
|
|
150
|
+
|
|
151
|
+
async function example() {
|
|
152
|
+
console.log("🚀 Testing @pronesoft-rd/ecf-sdk SDK...");
|
|
153
|
+
const config = new Configuration({
|
|
154
|
+
// To configure OAuth2 access token for authorization: oauth2 application
|
|
155
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
156
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
157
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
158
|
+
});
|
|
159
|
+
const api = new AssociatedCompaniesApi(config);
|
|
160
|
+
|
|
161
|
+
const body = {
|
|
162
|
+
// string
|
|
163
|
+
companyId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
164
|
+
} satisfies DeleteAssociatedCompanyRequest;
|
|
165
|
+
|
|
166
|
+
try {
|
|
167
|
+
const data = await api.deleteAssociatedCompany(body);
|
|
168
|
+
console.log(data);
|
|
169
|
+
} catch (error) {
|
|
170
|
+
console.error(error);
|
|
171
|
+
}
|
|
172
|
+
}
|
|
173
|
+
|
|
174
|
+
// Run the test
|
|
175
|
+
example().catch(console.error);
|
|
176
|
+
```
|
|
177
|
+
|
|
178
|
+
### Parameters
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
| Name | Type | Description | Notes |
|
|
182
|
+
|------------- | ------------- | ------------- | -------------|
|
|
183
|
+
| **companyId** | `string` | | [Defaults to `undefined`] |
|
|
184
|
+
|
|
185
|
+
### Return type
|
|
186
|
+
|
|
187
|
+
[**DeleteAssociatedCompany200Response**](DeleteAssociatedCompany200Response.md)
|
|
188
|
+
|
|
189
|
+
### Authorization
|
|
190
|
+
|
|
191
|
+
[oauth2 application](../README.md#oauth2-application), [bearerAuth](../README.md#bearerAuth)
|
|
192
|
+
|
|
193
|
+
### HTTP request headers
|
|
194
|
+
|
|
195
|
+
- **Content-Type**: Not defined
|
|
196
|
+
- **Accept**: `application/json`
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
### HTTP response details
|
|
200
|
+
| Status code | Description | Response headers |
|
|
201
|
+
|-------------|-------------|------------------|
|
|
202
|
+
| **200** | Company deleted successfully | - |
|
|
203
|
+
| **401** | Token missing, expired, or invalid. Call POST /oauth/token to renew. | - |
|
|
204
|
+
|
|
205
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
206
|
+
|
|
207
|
+
|
|
208
|
+
## getCompanyDocumentMetrics
|
|
209
|
+
|
|
210
|
+
> CompanyDocumentMetrics getCompanyDocumentMetrics(companyId)
|
|
211
|
+
|
|
212
|
+
Get company document metrics
|
|
213
|
+
|
|
214
|
+
### Example
|
|
215
|
+
|
|
216
|
+
```ts
|
|
217
|
+
import {
|
|
218
|
+
Configuration,
|
|
219
|
+
AssociatedCompaniesApi,
|
|
220
|
+
} from '@pronesoft-rd/ecf-sdk';
|
|
221
|
+
import type { GetCompanyDocumentMetricsRequest } from '@pronesoft-rd/ecf-sdk';
|
|
222
|
+
|
|
223
|
+
async function example() {
|
|
224
|
+
console.log("🚀 Testing @pronesoft-rd/ecf-sdk SDK...");
|
|
225
|
+
const config = new Configuration({
|
|
226
|
+
// To configure OAuth2 access token for authorization: oauth2 application
|
|
227
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
228
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
229
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
230
|
+
});
|
|
231
|
+
const api = new AssociatedCompaniesApi(config);
|
|
232
|
+
|
|
233
|
+
const body = {
|
|
234
|
+
// string
|
|
235
|
+
companyId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
236
|
+
} satisfies GetCompanyDocumentMetricsRequest;
|
|
237
|
+
|
|
238
|
+
try {
|
|
239
|
+
const data = await api.getCompanyDocumentMetrics(body);
|
|
240
|
+
console.log(data);
|
|
241
|
+
} catch (error) {
|
|
242
|
+
console.error(error);
|
|
243
|
+
}
|
|
244
|
+
}
|
|
245
|
+
|
|
246
|
+
// Run the test
|
|
247
|
+
example().catch(console.error);
|
|
248
|
+
```
|
|
249
|
+
|
|
250
|
+
### Parameters
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
| Name | Type | Description | Notes |
|
|
254
|
+
|------------- | ------------- | ------------- | -------------|
|
|
255
|
+
| **companyId** | `string` | | [Defaults to `undefined`] |
|
|
256
|
+
|
|
257
|
+
### Return type
|
|
258
|
+
|
|
259
|
+
[**CompanyDocumentMetrics**](CompanyDocumentMetrics.md)
|
|
260
|
+
|
|
261
|
+
### Authorization
|
|
262
|
+
|
|
263
|
+
[oauth2 application](../README.md#oauth2-application), [bearerAuth](../README.md#bearerAuth)
|
|
264
|
+
|
|
265
|
+
### HTTP request headers
|
|
266
|
+
|
|
267
|
+
- **Content-Type**: Not defined
|
|
268
|
+
- **Accept**: `application/json`
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
### HTTP response details
|
|
272
|
+
| Status code | Description | Response headers |
|
|
273
|
+
|-------------|-------------|------------------|
|
|
274
|
+
| **200** | Document metrics | - |
|
|
275
|
+
| **401** | Token missing, expired, or invalid. Call POST /oauth/token to renew. | - |
|
|
276
|
+
|
|
277
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
## getCompanyMetrics
|
|
281
|
+
|
|
282
|
+
> CompanyMetrics getCompanyMetrics(companyId)
|
|
283
|
+
|
|
284
|
+
Get company metrics
|
|
285
|
+
|
|
286
|
+
### Example
|
|
287
|
+
|
|
288
|
+
```ts
|
|
289
|
+
import {
|
|
290
|
+
Configuration,
|
|
291
|
+
AssociatedCompaniesApi,
|
|
292
|
+
} from '@pronesoft-rd/ecf-sdk';
|
|
293
|
+
import type { GetCompanyMetricsRequest } from '@pronesoft-rd/ecf-sdk';
|
|
294
|
+
|
|
295
|
+
async function example() {
|
|
296
|
+
console.log("🚀 Testing @pronesoft-rd/ecf-sdk SDK...");
|
|
297
|
+
const config = new Configuration({
|
|
298
|
+
// To configure OAuth2 access token for authorization: oauth2 application
|
|
299
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
300
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
301
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
302
|
+
});
|
|
303
|
+
const api = new AssociatedCompaniesApi(config);
|
|
304
|
+
|
|
305
|
+
const body = {
|
|
306
|
+
// string
|
|
307
|
+
companyId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
308
|
+
} satisfies GetCompanyMetricsRequest;
|
|
309
|
+
|
|
310
|
+
try {
|
|
311
|
+
const data = await api.getCompanyMetrics(body);
|
|
312
|
+
console.log(data);
|
|
313
|
+
} catch (error) {
|
|
314
|
+
console.error(error);
|
|
315
|
+
}
|
|
316
|
+
}
|
|
317
|
+
|
|
318
|
+
// Run the test
|
|
319
|
+
example().catch(console.error);
|
|
320
|
+
```
|
|
321
|
+
|
|
322
|
+
### Parameters
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
| Name | Type | Description | Notes |
|
|
326
|
+
|------------- | ------------- | ------------- | -------------|
|
|
327
|
+
| **companyId** | `string` | | [Defaults to `undefined`] |
|
|
328
|
+
|
|
329
|
+
### Return type
|
|
330
|
+
|
|
331
|
+
[**CompanyMetrics**](CompanyMetrics.md)
|
|
332
|
+
|
|
333
|
+
### Authorization
|
|
334
|
+
|
|
335
|
+
[oauth2 application](../README.md#oauth2-application), [bearerAuth](../README.md#bearerAuth)
|
|
336
|
+
|
|
337
|
+
### HTTP request headers
|
|
338
|
+
|
|
339
|
+
- **Content-Type**: Not defined
|
|
340
|
+
- **Accept**: `application/json`
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
### HTTP response details
|
|
344
|
+
| Status code | Description | Response headers |
|
|
345
|
+
|-------------|-------------|------------------|
|
|
346
|
+
| **200** | Company metrics | - |
|
|
347
|
+
| **401** | Token missing, expired, or invalid. Call POST /oauth/token to renew. | - |
|
|
131
348
|
|
|
132
349
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
133
350
|
|
|
134
351
|
|
|
135
352
|
## listAssociatedCompanies
|
|
136
353
|
|
|
137
|
-
> Array<AssociatedCompany> listAssociatedCompanies(
|
|
354
|
+
> Array<AssociatedCompany> listAssociatedCompanies(page, limit)
|
|
138
355
|
|
|
139
356
|
List associated companies / branches
|
|
140
357
|
|
|
141
|
-
Returns all companies and branches linked to the current tenant.
|
|
142
|
-
|
|
143
358
|
### Example
|
|
144
359
|
|
|
145
360
|
```ts
|
|
146
361
|
import {
|
|
147
362
|
Configuration,
|
|
148
363
|
AssociatedCompaniesApi,
|
|
149
|
-
} from '@pronesoft/ecf-sdk';
|
|
150
|
-
import type { ListAssociatedCompaniesRequest } from '@pronesoft/ecf-sdk';
|
|
364
|
+
} from '@pronesoft-rd/ecf-sdk';
|
|
365
|
+
import type { ListAssociatedCompaniesRequest } from '@pronesoft-rd/ecf-sdk';
|
|
151
366
|
|
|
152
367
|
async function example() {
|
|
153
|
-
console.log("🚀 Testing @pronesoft/ecf-sdk SDK...");
|
|
368
|
+
console.log("🚀 Testing @pronesoft-rd/ecf-sdk SDK...");
|
|
154
369
|
const config = new Configuration({
|
|
155
370
|
// To configure OAuth2 access token for authorization: oauth2 application
|
|
156
371
|
accessToken: "YOUR ACCESS TOKEN",
|
|
@@ -160,8 +375,10 @@ async function example() {
|
|
|
160
375
|
const api = new AssociatedCompaniesApi(config);
|
|
161
376
|
|
|
162
377
|
const body = {
|
|
163
|
-
//
|
|
164
|
-
|
|
378
|
+
// number (optional)
|
|
379
|
+
page: 56,
|
|
380
|
+
// number (optional)
|
|
381
|
+
limit: 56,
|
|
165
382
|
} satisfies ListAssociatedCompaniesRequest;
|
|
166
383
|
|
|
167
384
|
try {
|
|
@@ -181,7 +398,8 @@ example().catch(console.error);
|
|
|
181
398
|
|
|
182
399
|
| Name | Type | Description | Notes |
|
|
183
400
|
|------------- | ------------- | ------------- | -------------|
|
|
184
|
-
| **
|
|
401
|
+
| **page** | `number` | | [Optional] [Defaults to `1`] |
|
|
402
|
+
| **limit** | `number` | | [Optional] [Defaults to `10`] |
|
|
185
403
|
|
|
186
404
|
### Return type
|
|
187
405
|
|
|
@@ -200,8 +418,98 @@ example().catch(console.error);
|
|
|
200
418
|
### HTTP response details
|
|
201
419
|
| Status code | Description | Response headers |
|
|
202
420
|
|-------------|-------------|------------------|
|
|
203
|
-
| **200** |
|
|
204
|
-
| **401** |
|
|
421
|
+
| **200** | Array of associated companies | - |
|
|
422
|
+
| **401** | Token missing, expired, or invalid. Call POST /oauth/token to renew. | - |
|
|
423
|
+
|
|
424
|
+
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
425
|
+
|
|
426
|
+
|
|
427
|
+
## updateAssociatedCompany
|
|
428
|
+
|
|
429
|
+
> CreateAssociatedCompany201Response updateAssociatedCompany(companyId, name, phone, website, city, country, logo)
|
|
430
|
+
|
|
431
|
+
Update associated company
|
|
432
|
+
|
|
433
|
+
### Example
|
|
434
|
+
|
|
435
|
+
```ts
|
|
436
|
+
import {
|
|
437
|
+
Configuration,
|
|
438
|
+
AssociatedCompaniesApi,
|
|
439
|
+
} from '@pronesoft-rd/ecf-sdk';
|
|
440
|
+
import type { UpdateAssociatedCompanyRequest } from '@pronesoft-rd/ecf-sdk';
|
|
441
|
+
|
|
442
|
+
async function example() {
|
|
443
|
+
console.log("🚀 Testing @pronesoft-rd/ecf-sdk SDK...");
|
|
444
|
+
const config = new Configuration({
|
|
445
|
+
// To configure OAuth2 access token for authorization: oauth2 application
|
|
446
|
+
accessToken: "YOUR ACCESS TOKEN",
|
|
447
|
+
// Configure HTTP bearer authorization: bearerAuth
|
|
448
|
+
accessToken: "YOUR BEARER TOKEN",
|
|
449
|
+
});
|
|
450
|
+
const api = new AssociatedCompaniesApi(config);
|
|
451
|
+
|
|
452
|
+
const body = {
|
|
453
|
+
// string
|
|
454
|
+
companyId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
|
|
455
|
+
// string (optional)
|
|
456
|
+
name: name_example,
|
|
457
|
+
// string (optional)
|
|
458
|
+
phone: phone_example,
|
|
459
|
+
// string (optional)
|
|
460
|
+
website: website_example,
|
|
461
|
+
// string (optional)
|
|
462
|
+
city: city_example,
|
|
463
|
+
// string (optional)
|
|
464
|
+
country: country_example,
|
|
465
|
+
// Blob (optional)
|
|
466
|
+
logo: BINARY_DATA_HERE,
|
|
467
|
+
} satisfies UpdateAssociatedCompanyRequest;
|
|
468
|
+
|
|
469
|
+
try {
|
|
470
|
+
const data = await api.updateAssociatedCompany(body);
|
|
471
|
+
console.log(data);
|
|
472
|
+
} catch (error) {
|
|
473
|
+
console.error(error);
|
|
474
|
+
}
|
|
475
|
+
}
|
|
476
|
+
|
|
477
|
+
// Run the test
|
|
478
|
+
example().catch(console.error);
|
|
479
|
+
```
|
|
480
|
+
|
|
481
|
+
### Parameters
|
|
482
|
+
|
|
483
|
+
|
|
484
|
+
| Name | Type | Description | Notes |
|
|
485
|
+
|------------- | ------------- | ------------- | -------------|
|
|
486
|
+
| **companyId** | `string` | | [Defaults to `undefined`] |
|
|
487
|
+
| **name** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
488
|
+
| **phone** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
489
|
+
| **website** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
490
|
+
| **city** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
491
|
+
| **country** | `string` | | [Optional] [Defaults to `undefined`] |
|
|
492
|
+
| **logo** | `Blob` | | [Optional] [Defaults to `undefined`] |
|
|
493
|
+
|
|
494
|
+
### Return type
|
|
495
|
+
|
|
496
|
+
[**CreateAssociatedCompany201Response**](CreateAssociatedCompany201Response.md)
|
|
497
|
+
|
|
498
|
+
### Authorization
|
|
499
|
+
|
|
500
|
+
[oauth2 application](../README.md#oauth2-application), [bearerAuth](../README.md#bearerAuth)
|
|
501
|
+
|
|
502
|
+
### HTTP request headers
|
|
503
|
+
|
|
504
|
+
- **Content-Type**: `multipart/form-data`
|
|
505
|
+
- **Accept**: `application/json`
|
|
506
|
+
|
|
507
|
+
|
|
508
|
+
### HTTP response details
|
|
509
|
+
| Status code | Description | Response headers |
|
|
510
|
+
|-------------|-------------|------------------|
|
|
511
|
+
| **200** | Company updated successfully | - |
|
|
512
|
+
| **401** | Token missing, expired, or invalid. Call POST /oauth/token to renew. | - |
|
|
205
513
|
|
|
206
514
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
207
515
|
|
|
@@ -1,7 +1,6 @@
|
|
|
1
1
|
|
|
2
2
|
# AssociatedCompany
|
|
3
3
|
|
|
4
|
-
A company or branch associated with the main tenant account.
|
|
5
4
|
|
|
6
5
|
## Properties
|
|
7
6
|
|
|
@@ -10,13 +9,16 @@ Name | Type
|
|
|
10
9
|
`id` | string
|
|
11
10
|
`name` | string
|
|
12
11
|
`rnc` | string
|
|
13
|
-
`
|
|
14
|
-
`
|
|
12
|
+
`logoPath` | string
|
|
13
|
+
`type` | string
|
|
15
14
|
`city` | string
|
|
16
15
|
`country` | string
|
|
16
|
+
`phone` | string
|
|
17
|
+
`address` | string
|
|
17
18
|
`website` | string
|
|
18
|
-
`
|
|
19
|
-
`
|
|
19
|
+
`category` | string
|
|
20
|
+
`monthlySalesRange` | string
|
|
21
|
+
`printerType` | [PrintFormat](PrintFormat.md)
|
|
20
22
|
`createdAt` | Date
|
|
21
23
|
`docsIssuedThisMonth` | number
|
|
22
24
|
`purchasedDocsConsumedThisMonth` | number
|
|
@@ -26,20 +28,23 @@ Name | Type
|
|
|
26
28
|
## Example
|
|
27
29
|
|
|
28
30
|
```typescript
|
|
29
|
-
import type { AssociatedCompany } from '@pronesoft/ecf-sdk'
|
|
31
|
+
import type { AssociatedCompany } from '@pronesoft-rd/ecf-sdk'
|
|
30
32
|
|
|
31
33
|
// TODO: Update the object below with actual values
|
|
32
34
|
const example = {
|
|
33
35
|
"id": null,
|
|
34
36
|
"name": null,
|
|
35
37
|
"rnc": null,
|
|
36
|
-
"
|
|
37
|
-
"
|
|
38
|
+
"logoPath": null,
|
|
39
|
+
"type": null,
|
|
38
40
|
"city": null,
|
|
39
41
|
"country": null,
|
|
42
|
+
"phone": null,
|
|
43
|
+
"address": null,
|
|
40
44
|
"website": null,
|
|
41
|
-
"
|
|
42
|
-
"
|
|
45
|
+
"category": null,
|
|
46
|
+
"monthlySalesRange": null,
|
|
47
|
+
"printerType": null,
|
|
43
48
|
"createdAt": null,
|
|
44
49
|
"docsIssuedThisMonth": null,
|
|
45
50
|
"purchasedDocsConsumedThisMonth": null,
|
|
@@ -13,7 +13,7 @@ Name | Type
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
15
15
|
```typescript
|
|
16
|
-
import type { AssociatedCompanySubscription } from '@pronesoft/ecf-sdk'
|
|
16
|
+
import type { AssociatedCompanySubscription } from '@pronesoft-rd/ecf-sdk'
|
|
17
17
|
|
|
18
18
|
// TODO: Update the object below with actual values
|
|
19
19
|
const example = {
|
|
@@ -12,7 +12,7 @@ Name | Type
|
|
|
12
12
|
## Example
|
|
13
13
|
|
|
14
14
|
```typescript
|
|
15
|
-
import type { AssociatedCompanySubscriptionPlan } from '@pronesoft/ecf-sdk'
|
|
15
|
+
import type { AssociatedCompanySubscriptionPlan } from '@pronesoft-rd/ecf-sdk'
|
|
16
16
|
|
|
17
17
|
// TODO: Update the object below with actual values
|
|
18
18
|
const example = {
|
|
@@ -4,7 +4,7 @@ All URIs are relative to *https://api.ecf.sandbox.pronesoft.com/api/v1*
|
|
|
4
4
|
|
|
5
5
|
| Method | HTTP request | Description |
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
| [**getAccessToken**](AuthenticationApi.md#getaccesstoken) | **POST** /oauth/token | Get access token |
|
|
7
|
+
| [**getAccessToken**](AuthenticationApi.md#getaccesstoken) | **POST** /oauth/token | Get access token (OAuth 2.0) |
|
|
8
8
|
|
|
9
9
|
|
|
10
10
|
|
|
@@ -12,9 +12,9 @@ All URIs are relative to *https://api.ecf.sandbox.pronesoft.com/api/v1*
|
|
|
12
12
|
|
|
13
13
|
> OAuthTokenResponse getAccessToken(oAuthTokenRequest)
|
|
14
14
|
|
|
15
|
-
Get access token
|
|
15
|
+
Get access token (OAuth 2.0)
|
|
16
16
|
|
|
17
|
-
Authenticates using OAuth 2.0
|
|
17
|
+
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.
|
|
18
18
|
|
|
19
19
|
### Example
|
|
20
20
|
|
|
@@ -22,16 +22,16 @@ Authenticates using OAuth 2.0 **Client Credentials** flow. Returns a Bearer toke
|
|
|
22
22
|
import {
|
|
23
23
|
Configuration,
|
|
24
24
|
AuthenticationApi,
|
|
25
|
-
} from '@pronesoft/ecf-sdk';
|
|
26
|
-
import type { GetAccessTokenRequest } from '@pronesoft/ecf-sdk';
|
|
25
|
+
} from '@pronesoft-rd/ecf-sdk';
|
|
26
|
+
import type { GetAccessTokenRequest } from '@pronesoft-rd/ecf-sdk';
|
|
27
27
|
|
|
28
28
|
async function example() {
|
|
29
|
-
console.log("🚀 Testing @pronesoft/ecf-sdk SDK...");
|
|
29
|
+
console.log("🚀 Testing @pronesoft-rd/ecf-sdk SDK...");
|
|
30
30
|
const api = new AuthenticationApi();
|
|
31
31
|
|
|
32
32
|
const body = {
|
|
33
33
|
// OAuthTokenRequest
|
|
34
|
-
oAuthTokenRequest: {"clientId":"
|
|
34
|
+
oAuthTokenRequest: {"clientId":"app_live_TU_CLIENT_ID","clientSecret":"sk_live_TU_CLIENT_SECRET"},
|
|
35
35
|
} satisfies GetAccessTokenRequest;
|
|
36
36
|
|
|
37
37
|
try {
|
|
@@ -71,7 +71,7 @@ No authorization required
|
|
|
71
71
|
| Status code | Description | Response headers |
|
|
72
72
|
|-------------|-------------|------------------|
|
|
73
73
|
| **200** | Token generated successfully | - |
|
|
74
|
-
| **401** |
|
|
74
|
+
| **401** | Token missing, expired, or invalid. Call POST /oauth/token to renew. | - |
|
|
75
75
|
|
|
76
76
|
[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
|
|
77
77
|
|