@experteam-mx/ngx-services 20.4.0 → 20.5.0
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/index.d.ts
CHANGED
|
@@ -35,7 +35,6 @@ type Environment = {
|
|
|
35
35
|
apiDiscountsUrl?: string;
|
|
36
36
|
apiEToolsAutoBilling?: string;
|
|
37
37
|
apiEventsUrl?: string;
|
|
38
|
-
apiExternalOperationsKey?: string;
|
|
39
38
|
apiExternalOperationsUrl?: string;
|
|
40
39
|
apiInventoriesUrl?: string;
|
|
41
40
|
apiInvoicesUrl?: string;
|
|
@@ -47,7 +46,6 @@ type Environment = {
|
|
|
47
46
|
apiServicesUrl?: string;
|
|
48
47
|
apiShipmentUrl?: string;
|
|
49
48
|
apiSuppliesUrl?: string;
|
|
50
|
-
apiSurveysKey?: string;
|
|
51
49
|
apiSurveysUrl?: string;
|
|
52
50
|
authCookie?: string;
|
|
53
51
|
cacheTtl?: number;
|
|
@@ -5045,7 +5043,6 @@ type DeliveryConfirmationSearchOut = {
|
|
|
5045
5043
|
declare class ApiExternalOperationsService {
|
|
5046
5044
|
private http;
|
|
5047
5045
|
private environment;
|
|
5048
|
-
private appKey;
|
|
5049
5046
|
/**
|
|
5050
5047
|
* Getter method to retrieve the API's external operations URL.
|
|
5051
5048
|
* Fetches the URL from the `apiExternalOperationsUrl` property of the environment object.
|
|
@@ -5086,7 +5083,6 @@ declare class ApiExternalOperationsService {
|
|
|
5086
5083
|
* @return {Observable<Object>} An observable that emits the server's response when the cancellation is processed.
|
|
5087
5084
|
*/
|
|
5088
5085
|
putDeliveryConfirmation({ otp, ...body }: DeliveryConfirmationIn): Observable<{}>;
|
|
5089
|
-
private getAppKeyHeader;
|
|
5090
5086
|
static ɵfac: i0.ɵɵFactoryDeclaration<ApiExternalOperationsService, never>;
|
|
5091
5087
|
static ɵprov: i0.ɵɵInjectableDeclaration<ApiExternalOperationsService>;
|
|
5092
5088
|
}
|
|
@@ -8542,13 +8538,11 @@ type CustomerSurveyFinishIn = {
|
|
|
8542
8538
|
declare class ApiSurveysService {
|
|
8543
8539
|
private environments;
|
|
8544
8540
|
private http;
|
|
8545
|
-
private appKey;
|
|
8546
8541
|
/**
|
|
8547
8542
|
* Base URL for surveys API endpoints.
|
|
8548
8543
|
* @returns The configured surveys API URL or an empty string.
|
|
8549
8544
|
*/
|
|
8550
8545
|
get url(): string;
|
|
8551
|
-
private appKeyHeader;
|
|
8552
8546
|
/**
|
|
8553
8547
|
* Retrieves surveys list based on query parameters.
|
|
8554
8548
|
* @param params Query parameters used to filter, paginate, or sort surveys.
|
|
@@ -8712,40 +8706,6 @@ declare class CryptoService {
|
|
|
8712
8706
|
*/
|
|
8713
8707
|
declare function apiHeadersInterceptor(req: HttpRequest<unknown>, next: HttpHandlerFn): Observable<HttpEvent<unknown>>;
|
|
8714
8708
|
|
|
8715
|
-
/**
|
|
8716
|
-
* HTTP interceptor that injects the external operations API key into outbound requests.
|
|
8717
|
-
*
|
|
8718
|
-
* The interceptor:
|
|
8719
|
-
* 1. Reads `apiExternalOperationsKey` from the injected `ENVIRONMENT_TOKEN`.
|
|
8720
|
-
* 2. Skips modification if the key is absent.
|
|
8721
|
-
* 3. Leaves the request unchanged if it already contains an `AppKey` header (caller override).
|
|
8722
|
-
* 4. Otherwise clones the request adding `AppKey: apiExternalOperationsKey`.
|
|
8723
|
-
*
|
|
8724
|
-
* This enables centralized, transparent authentication for services targeting external
|
|
8725
|
-
* operations endpoints while allowing explicit per-request overrides.
|
|
8726
|
-
*
|
|
8727
|
-
* Example:
|
|
8728
|
-
* ```ts
|
|
8729
|
-
* provideHttpClient(
|
|
8730
|
-
* withInterceptors([apiKeyInterceptor])
|
|
8731
|
-
* );
|
|
8732
|
-
* ```
|
|
8733
|
-
*
|
|
8734
|
-
* @param request The original immutable `HttpRequest` instance.
|
|
8735
|
-
* @param next The next handler in the interceptor chain, used to forward the (possibly cloned) request.
|
|
8736
|
-
* @returns An `Observable` stream of the HTTP events for the (potentially augmented) request.
|
|
8737
|
-
*
|
|
8738
|
-
* @remarks
|
|
8739
|
-
* - If you need to intentionally send a different key for a specific request, set the `AppKey`
|
|
8740
|
-
* header manually before this interceptor runs.
|
|
8741
|
-
* - If `apiExternalOperationsKey` is undefined (e.g., missing configuration), the request is passed through unchanged.
|
|
8742
|
-
* - Order matters: place this interceptor before others that rely on the presence of the `AppKey` header.
|
|
8743
|
-
*
|
|
8744
|
-
* @see HttpRequest
|
|
8745
|
-
* @see HttpHandlerFn
|
|
8746
|
-
*/
|
|
8747
|
-
declare function apiKeyInterceptor(request: HttpRequest<unknown>, next: HttpHandlerFn): Observable<HttpEvent<unknown>>;
|
|
8748
|
-
|
|
8749
8709
|
/**
|
|
8750
8710
|
* An HTTP interceptor to append an Authorization header with a Bearer token
|
|
8751
8711
|
* to outgoing HTTP requests if certain conditions are met.
|
|
@@ -8807,5 +8767,5 @@ declare const xmlHeaders: (format?: "object" | "http_header") => HttpHeaders | {
|
|
|
8807
8767
|
[header: string]: string | string[];
|
|
8808
8768
|
};
|
|
8809
8769
|
|
|
8810
|
-
export { AlphaNumeric, ApiBillingCOService, ApiBillingDOService, ApiBillingGtService, ApiBillingMxService, ApiBillingPaService, ApiBillingSvService, ApiCashOperationsService, ApiCatalogsService, ApiCompaniesService, ApiCompositionService, ApiCustomsService, ApiDiscountsService, ApiEToolsAutoBillingService, ApiEventsService, ApiExternalOperationsService, ApiInventoriesService, ApiInvoicesService, ApiNotificationsService, ApiOpenItemsService, ApiQuoteService, ApiReportsService, ApiSecurityService, ApiServicesService, ApiShipmentsService, ApiSuppliesService, ApiSurveysService, CryptoService, DefaultValueType, DepositTypeCode, DocumentStatusCode, ENVIRONMENT_TOKEN, Event, Group, NgxServicesModule, OpeningStatusCode, OperationModuleStatus, PaymentTypeCode, TransferenceTypeCode, ViewSectionOption, WebSocketsService, apiHeadersInterceptor,
|
|
8770
|
+
export { AlphaNumeric, ApiBillingCOService, ApiBillingDOService, ApiBillingGtService, ApiBillingMxService, ApiBillingPaService, ApiBillingSvService, ApiCashOperationsService, ApiCatalogsService, ApiCompaniesService, ApiCompositionService, ApiCustomsService, ApiDiscountsService, ApiEToolsAutoBillingService, ApiEventsService, ApiExternalOperationsService, ApiInventoriesService, ApiInvoicesService, ApiNotificationsService, ApiOpenItemsService, ApiQuoteService, ApiReportsService, ApiSecurityService, ApiServicesService, ApiShipmentsService, ApiSuppliesService, ApiSurveysService, CryptoService, DefaultValueType, DepositTypeCode, DocumentStatusCode, ENVIRONMENT_TOKEN, Event, Group, NgxServicesModule, OpeningStatusCode, OperationModuleStatus, PaymentTypeCode, TransferenceTypeCode, ViewSectionOption, WebSocketsService, apiHeadersInterceptor, apiTokenInterceptor, base64PdfToUrl, downloadBase64Pdf, httpCachingInterceptor, httpParams, pdfHeaders, provideNgxServices, queryString, xmlHeaders };
|
|
8811
8771
|
export type { Account, AccountCategoriesOut, AccountCategory, AccountCompanyCountry, AccountCompanyCountryLocation, AccountEntitiesIn, AccountEntitiesOut, AccountIn, AccountLocation, AccountLocationId, AccountOut, AccountPayment, AccountResponse, AccountToTDX, AccountType, AccountTypeIn, AccountTypeOut, AccountTypesOut, AccountWithDefault, AccountWithLocations, AccountsActivesOut, AccountsOut, ActiveLessLaravelModel, ActiveLessSymfonyModel, AdditionalData, AddressPlaceDetail, AddressPlaceDetailIn, AddressPlaceDetailsOut, AddressSuggestion, AddressSuggestionIn, AddressSuggestionsOut, ApiBillingConfigurable, ApiModel, ApiResponse, ApiSuccess, Attribute, AttributeIn, AttributeWithId, Attributes, AuthLoginIn, AuthLoginOut, AuthMeOut, AuthUserLoginIn, Bank, BankAccount, BankAccountType, BankAccountsOut, BillingConfig, BillingConfigIn, BillingConfigOut, BillingConfigsOut, BillingDetailsPayment, BillingDetailsReport, BillingDetailsReportOut, BillingPaCustomer, BillingPaCustomerOut, BoardingProcess, BoardingProcessHistory, BoardingProcessIdIn, BoardingProcessIn, BoardingProcessStatus, BusinessPartyTraderType, BusinessPartyTraderTypesOut, CFDI, CancelPaymentReceiptIn, CancellationReason, CancellationReasonIn, CancellationReasonOut, CancellationReasonsOut, CashValueSummary, CashValueSummaryOut, Catalog, CatalogLess, CatalogsOut, ChangeLanguageIn, Checkpoint, CheckpointEventReason, CheckpointEventReasonsOut, CheckpointsOut, City, Closing, ClosingIn, ClosingOut, ClosingPayment, CoCustomer, CoCustomerIn, CoDepartment, CoDepartmentsOut, CoExtraFields, CoFiscalRegime, CoFiscalRegimesOut, CoFiscalResponsibilitiesOut, CoFiscalResponsibility, CoGetCustomerOut, CoMunicipalitiesOut, CoMunicipality, CoPostCustomerOut, CoPostalCode, CoPostalCodesOut, CoTribute, CoTributesOut, CollectionPayment, CollectionPaymentsOut, CommercialInvoice, Commodity, CompaniesOut, Company, CompanyCountriesOut, CompanyCountry, CompanyCountryIn, CompanyCountryOut, CompanyCountryTax, CompanyCountryTaxesOut, CompanyIn, CompanyOut, CompositionCountryReferencesOut, CountriesOut, Country, CountryAccount, CountryCurrencyRate, CountryDocumentType, CountryDocumentTypesOut, CountryExchange, CountryGroups, CountryGroupsOut, CountryIn, CountryOut, CountryPaymentType, CountryPaymentTypeField, CountryPaymentTypeFieldIn, CountryPaymentTypeFieldOut, CountryPaymentTypeFieldsOut, CountryPaymentTypeIn, CountryPaymentTypeOut, CountryPaymentTypesOut, CountryReference, CountryReferenceCurrenciesOut, CountryReferenceCurrency, CountryReferenceCurrencyIn, CountryReferenceCurrencyOut, CountryReferenceExtraCharge, CountryReferenceExtraChargeIn, CountryReferenceExtraChargeOut, CountryReferenceIn, CountryReferenceOut, CountryReferenceProduct, CountryReferenceProductIn, CountryReferenceProductOut, CountryReferenceProductsOut, CountryReferencesOut, CountryToExportReason, CourierCheckOutPackesOut, Criteria, CriteriaCustom, CriteriaIn, CriteriaOut, CriteriaWithTimestamps, CurrenciesOut, Currency, CurrencyOut, Customer, CustomerComposition, CustomerCountryDocumentType, CustomerDocumentTypesOut, CustomerOpenItem, CustomerOtherInvoice, CustomerRestriction, CustomerRestrictionIn, CustomerRestrictionInV2, CustomerRestrictionOut, CustomerRestrictionsOut, CustomerSurvey, CustomerSurveyFinishIn, CustomerSurveyIn, CustomerSurveyOut, CustomerType, CustomerTypesOut, CustomersOut, Customs, DeliveryConfirmationCompleteIn, DeliveryConfirmationGenerateIn, DeliveryConfirmationGenerateOut, DeliveryConfirmationIn, DeliveryConfirmationSearchOut, Department, DepartmentsOut, DependentRules, Deposit, DepositIn, DepositOut, DepositSlipOut, DestinationCountry, DhlCode, DhlCodeLess, Discount, DiscountIn, DiscountOut, DiscountsOut, District, DistrictsOut, Document, DocumentCategory, DocumentCategoryReports, DocumentFunction, DocumentItem, DocumentPayment, DocumentRequests, DocumentStatus, DocumentStatusesOut, DocumentType, DocumentTypeComposition, DocumentTypeRange, DocumentTypeRangeIn, DocumentTypeRangeOut, DocumentTypeRangesOut, DocumentTypeReports, DocumentsTypesRangesCurrentStatusOut, Dropdown, DropdownConfig, EconomicActivitiesOut, EconomicActivity, EmailErrorIn, EmbassyShipment, EmbassyShipmentIn, EmbassyShipmentOut, EmbassyShipmentsOut, Employee, EmployeeCustomerDhl, EmployeeCustomersIn, EmployeeCustomersOut, EmployeeIn, EmployeeOut, EmployeesCustomersOut, EmployeesOut, Entity, Environment, EstablishmentType, EstablishmentTypesOut, Exchange, ExchangeIn, ExchangeOut, ExchangesOut, ExportReason, ExportReasonIn, ExportReasonOut, ExportReasonTypes, ExportReasonTypesOut, ExportReasonsOut, ExportType, ExportTypesOut, ExternalShipmentAddress, ExternalShipmentAddressCancellation, ExternalShipmentAddressesIn, ExternalShipmentAddressesOut, ExternalShipmentCancellationIn, ExternalShipmentFile, ExternalShipmentFileHistory, ExternalShipmentFileOut, ExternalShipmentHistoriesOut, ExternalShipmentHistory, ExternalShipmentStatus, ExternalShipmentStatusOut, ExternalShipmentStatuses, ExternalShipmentsOut, ExtraCharge, ExtraChargeComposition, ExtraChargeEntitiesIn, ExtraChargeEntitiesOut, ExtraChargeEntity, ExtraChargeIn, ExtraChargeOut, ExtraChargesOut, Facility, Field, FieldLess, FieldsOut, FileCheckOut, FillFrom, FillFromIn, FiscalRegimen, FiscalRegimensAcceptedOut, FiscalRegimensOut, GenericFolio, GenericFolioIn, GenericFolioOut, GenericFoliosOut, GetDocumentsOut, GetPostalLocationsIn, GetUserOut, GetUsersOut, HistoriesReportOut, HistoryReport, HistoryReportCheckpoint, Holiday, HolidayIn, HolidayOut, HolidaysOut, IdentificationType, IdentificationTypeComposition, IdentificationTypeCustomer, IdentificationTypeIn, IdentificationTypeNumberValidationIn, IdentificationTypeNumberValidationOut, IdentificationTypeOut, IdentificationTypesOut, Incident, IncidentIn, IncidentOut, IncidentReason, IncidentReasonComplement, IncidentReasonComplementIn, IncidentReasonComplementOut, IncidentReasonComplementsOut, IncidentReasonIn, IncidentReasonOut, IncidentReasonsOut, IncidentsOut, IncomeType, IncomeTypesOut, Installation, InstallationCountryReferenceCurrenciesOut, InstallationCountryReferenceCurrency, InstallationCountryReferenceCurrencyIn, InstallationCountryReferenceCurrencyOut, InstallationIn, InstallationOut, InstallationsOut, InventoriesReportOut, InventoryReport, InvoiceCancellationIn, InvoiceReport, InvoiceTypeCustomParamsIn, InvoicesOut, Item, Language, LanguagesOut, LaravelModel, Location, LocationEmployee, LocationEmployeeBatchIn, LocationEmployeeOut, LocationEmployeesIn, LocationEmployeesOut, LocationIn, LocationOut, LocationType, LocationTypeFields, LocationsOut, LoyaltyPeriod, LoyaltyPeriodIn, LoyaltyPeriodOut, LoyaltyPeriodsOut, LoyaltyRule, LoyaltyRuleIn, LoyaltyRuleOut, LoyaltyRulesOut, ManagementArea, ManagementAreasOut, ManifestMultipleIn, ManifestMultipleOut, ManufactureCountry, Module, ModuleType, ModulesOut, MunicipalitiesOut, Municipality, Notification, NotificationConfiguration, NotificationConfigurationIn, NotificationConfigurationOut, NotificationIn, NotificationOut, NotificationStatus, NotificationType, NotificationsOut, NotificationsTypeOut, OpenItem, OpenItemIn, OpenItems, OpenItemsOut, Opening, OpeningCountryReferenceCurrency, OpeningHistory, OpeningIn, OpeningOut, OpeningPreClosingRequestIn, OpeningStatus, OpeningTransference, OpeningTransferenceIn, OpeningTransferenceOut, OpeningsOut, Operation, OperationAccountPaymentIn, OperationAccountPaymentOut, OperationAction, OperationCancelBillingIn, OperationCancelBillingOut, OperationDocumentCustomerIn, OperationDocumentCustomerOut, OperationDocumentIn, OperationDocumentOut, OperationDocumentRequestsOut, OperationEvent, OperationModule, OperationModuleEndIn, OperationModuleOut, OperationModuleStartIn, OperationPrintDocumentOut, OperationPrintXmlOut, OperationReport, OperationShipmentExternalIn, OperationShipmentExternalOut, OperationType, OperationTypeInventory, OperationTypesInventoryOut, OperationTypesOut, OperationsLoadTopCustomerV2In, OperationsReportOut, OtherInvoiceIn, OtherInvoiceOut, OtherInvoices, Override, OverridesOut, PackageInStockDetailOut, PackageInventory, PackageLocation, PackageLocationsData, PackageMissing, PackageReport, PackagesInStockIn, PackagesInStockOut, PackagesReportOut, Parameter, ParameterConfig, ParameterConfigIn, ParameterConfigOut, ParameterConfigsOut, ParameterValueIn, ParameterValueOut, ParametersByLevelIn, ParametersOut, ParametersValuesIn, ParametersValuesOut, ParcelReport, ParcelsReportOut, Parish, ParishesOut, PartialWithdrawal, PartialWithdrawalsOut, Payment, PaymentDetail, PaymentOpenItemIn, PaymentOut, PaymentType, PaymentTypeFieldAccount, PaymentTypeFieldAccountIn, PaymentTypeFieldAccountOut, PaymentTypeFieldAccountsOut, PaymentTypeFieldCardType, PaymentTypeFieldCardTypeIn, PaymentTypeFieldCardTypeOut, PaymentTypeFieldCardTypesOut, PaymentTypesOut, Permission, PersonType, PersonTypesOut, Pivot, PostalCode, PostalCodeBillings, PostalCodeFormat, PostalCodesOut, PostalLocation, PostalLocationsOut, PrintCollectionReceiptOut, Product, ProductEntitiesIn, ProductEntitiesOut, ProductEntity, ProductIn, ProductOut, ProductSubtotal, PromotionCodeDiscount, PromotionCodeDiscountsOut, PromotionIn, PromotionOut, Provider, ProvidersOut, Province, ProvincesOut, PutUsersIn, PutUsersOut, QuantityUnit, QueryParams, Question, QuestionIn, QuestionOption, QuestionOut, QuestionResponse, QuestionType, QuestionTypesOut, QuestionsOut, QuoteEvent, QuoteEventIn, QuoteEventOut, QuoteEventType, QuoteEventTypesOut, QuoteEventsOut, ReEntryOfMissingPackage, ReEntryOfMissingPackageOut, ReEntryOfMissingPackages, ReEntryOfMissingPackagesIn, ReEntryOfMissingPackagesOut, ReceiptFile, ReceiptFileOut, Region, RegionsOut, ReportExternalShipment, ReportExternalShipmentAddress, Role, RoleIn, RoleOut, RoleType, RoleTypesOut, RolesOut, Rule, RuleByCriteria, RuleCriteriaIn, RuleIn, RuleOut, Rules, RulesByCriteriaOut, RulesIn, RulesOut, Sales, SalesBookReportOut, ServiceArea, ServiceAreaIn, ServiceAreasOut, Session, SessionIn, SessionOut, ShipmentAddresses, ShipmentBookPickup, ShipmentCancellationIn, ShipmentCancellationOut, ShipmentCompanyCountryExtraCharges, ShipmentComposition, ShipmentContentType, ShipmentContentTypesOut, ShipmentEmployeeCustomer, ShipmentEmployeeCustomers, ShipmentGroup, ShipmentGroupsOut, ShipmentGsop, ShipmentIncomeType, ShipmentIncomeTypeIn, ShipmentIncomeTypeOut, ShipmentIncomeTypesOut, ShipmentLandingReport, ShipmentOut, ShipmentPieceCompanyCountrySupplies, ShipmentPieces, ShipmentReports, ShipmentScope, ShipmentScopesOut, ShipmentSignaturePageOut, ShipmentStatus, ShipmentStatusesOut, ShipmentTag, ShipmentsLandingReportOut, ShipmentsReportOut, SignaturePageSetting, SignaturePageSettingIn, SignaturePageSettingOut, SignaturePageSettingsOut, State, Status, StatusesOut, StockUpdatePackagesOut, Suburb, SuppliesOut, Supply, SupplyEntitiesIn, SupplyEntitiesOut, SupplyEntity, SupplyEntityPacking, SupplyEntityType, SupplyIn, SupplyLocation, SupplyLocationIn, SupplyLocationOut, SupplyLocationTransaction, SupplyLocationTransactionIn, SupplyLocationTransactionOut, SupplyLocationsOut, SupplyOut, SupplyPacking, SupplyTransactionType, SupplyTransactionTypesOut, SupplyType, SupplyTypesOut, Survey, SurveyIn, SurveyOut, SurveyQuestion, SurveyQuestionIn, SurveyQuestionOut, SurveyQuestionsOut, SurveysOut, SymfonyModel, System, SystemEntitiesIn, SystemEntitiesOut, SystemIn, SystemOut, SystemsOut, TDXAccountSetting, TDXAccountSettingsIn, TDXAccountSettingsOut, TDXAccountsSettingsOut, Tax, TextConfig, Tolerance, ToleranceIn, ToleranceOut, TolerancesOut, TopCustomer, TopCustomersOut, TradingTransactionType, TransferenceType, TranslateLang, Translations, UniqueFolio, UniqueFolioIn, UniqueFolioOut, UniqueFoliosOut, Unit, UnitsOut, User, UserMe, ValidateAccountIn, ValidateAccountOut, ValidateFacilityIn, ValidateFacilityOut, ValidateIdentificationBRIn, ValidateIdentificationBROut, ValidateNIPIn, ValidateNIPOut, Values, WithdrawalAmount, WorkflowConfig, WorkflowConfigsBatchIn, WorkflowConfigsOut, WorkflowsOut, Zone, ZonesOut };
|