From 4ecd86f3e13753a2a25faa53113ddd91ac650a97 Mon Sep 17 00:00:00 2001 From: Marika Marszalkowski Date: Thu, 7 Mar 2024 16:37:09 +0100 Subject: [PATCH] Revert "v3.12.1" This reverts commit bcb8aed65d49cebb1298d4416c2c73c424a2f62a. --- .changeset/five-socks-confess.md | 6 + .changeset/seven-shoes-do.md | 5 + CHANGELOG.md | 11 - DOCUMENTATION.md | 2 +- knowledge-base/api-reference/assets/icons.js | 15 - knowledge-base/api-reference/assets/icons.svg | 1 - knowledge-base/api-reference/assets/main.js | 8 +- .../api-reference/assets/navigation.js | 2 +- .../sap_cloud_sdk_odata_common.AllFields.html | 12 +- ...cloud_sdk_odata_common.BatchChangeSet.html | 16 +- ...dk_odata_common.BooleanFilterFunction.html | 30 +- ...loud_sdk_odata_common.CollectionField.html | 42 +-- ...odata_common.CollectionFilterFunction.html | 32 +-- ...oud_sdk_odata_common.ComplexTypeField.html | 48 ++-- ..._sdk_odata_common.CountRequestBuilder.html | 80 +++--- ...odata_common.CreateRequestBuilderBase.html | 126 ++++----- ...ap_cloud_sdk_odata_common.CustomField.html | 44 +-- ...odata_common.DeleteRequestBuilderBase.html | 108 +++---- ...p_cloud_sdk_odata_common.EdmTypeField.html | 62 ++-- ...sap_cloud_sdk_odata_common.EntityBase.html | 106 +++---- ..._cloud_sdk_odata_common.EntityBuilder.html | 26 +- .../sap_cloud_sdk_odata_common.EnumField.html | 52 ++-- .../sap_cloud_sdk_odata_common.Field.html | 30 +- ...p_cloud_sdk_odata_common.FieldBuilder.html | 50 ++-- .../sap_cloud_sdk_odata_common.Filter.html | 36 +-- ...cloud_sdk_odata_common.FilterFunction.html | 32 +-- ...k_odata_common.FilterLambdaExpression.html | 10 +- ...sap_cloud_sdk_odata_common.FilterLink.html | 30 +- ...sap_cloud_sdk_odata_common.FilterList.html | 24 +- ...odata_common.GetAllRequestBuilderBase.html | 124 ++++---- ...ata_common.GetByKeyRequestBuilderBase.html | 114 ++++---- .../sap_cloud_sdk_odata_common.Link.html | 48 ++-- ...sdk_odata_common.NumberFilterFunction.html | 56 ++-- ..._odata_common.ODataBatchRequestConfig.html | 68 ++--- ..._odata_common.ODataCountRequestConfig.html | 64 ++--- ...odata_common.ODataCreateRequestConfig.html | 76 ++--- ...odata_common.ODataDeleteRequestConfig.html | 78 ++--- ...ata_common.ODataFunctionRequestConfig.html | 78 ++--- ...odata_common.ODataGetAllRequestConfig.html | 88 +++--- ...ata_common.ODataGetByKeyRequestConfig.html | 76 ++--- ...p_cloud_sdk_odata_common.ODataRequest.html | 74 ++--- ...d_sdk_odata_common.ODataRequestConfig.html | 64 ++--- ...odata_common.ODataUpdateRequestConfig.html | 80 +++--- ..._cloud_sdk_odata_common.OneToManyLink.html | 78 ++--- ...p_cloud_sdk_odata_common.OneToOneLink.html | 68 ++--- ...d_sdk_odata_common.OperationParameter.html | 22 +- ...ta_common.OperationRequestBuilderBase.html | 104 +++---- .../sap_cloud_sdk_odata_common.Order.html | 26 +- .../sap_cloud_sdk_odata_common.OrderLink.html | 22 +- ...dk_odata_common.OrderableEdmTypeField.html | 84 +++--- ...cloud_sdk_odata_common.RequestBuilder.html | 16 +- ...sdk_odata_common.StringFilterFunction.html | 54 ++-- ...ap_cloud_sdk_odata_common.UnaryFilter.html | 10 +- ...odata_common.UpdateRequestBuilderBase.html | 144 +++++----- ...loud_sdk_odata_v2.CountRequestBuilder.html | 82 +++--- ...oud_sdk_odata_v2.CreateRequestBuilder.html | 118 ++++---- .../sap_cloud_sdk_odata_v2.CustomField.html | 48 ++-- ...oud_sdk_odata_v2.DeleteRequestBuilder.html | 110 ++++---- .../sap_cloud_sdk_odata_v2.Entity.html | 106 +++---- ...oud_sdk_odata_v2.GetAllRequestBuilder.html | 126 ++++----- ...d_sdk_odata_v2.GetByKeyRequestBuilder.html | 112 ++++---- ...sdk_odata_v2.ODataBatchRequestBuilder.html | 88 +++--- ...k_odata_v2.ODataFunctionRequestConfig.html | 78 ++--- ..._sdk_odata_v2.OperationRequestBuilder.html | 108 +++---- ...oud_sdk_odata_v2.UpdateRequestBuilder.html | 148 +++++----- ...ud_sdk_odata_v4.ActionImportParameter.html | 20 +- ...k_odata_v4.ActionImportRequestBuilder.html | 90 +++--- ...ta_v4.BoundActionImportRequestBuilder.html | 90 +++--- ..._v4.BoundFunctionImportRequestBuilder.html | 90 +++--- ...odata_v4.BoundOperationRequestBuilder.html | 94 +++---- ...loud_sdk_odata_v4.CountRequestBuilder.html | 82 +++--- ...oud_sdk_odata_v4.CreateRequestBuilder.html | 118 ++++---- .../sap_cloud_sdk_odata_v4.CustomField.html | 50 ++-- ...cloud_sdk_odata_v4.DateFilterFunction.html | 54 ++-- ...oud_sdk_odata_v4.DeleteRequestBuilder.html | 110 ++++---- .../sap_cloud_sdk_odata_v4.Entity.html | 106 +++---- ...odata_v4.FunctionImportRequestBuilder.html | 90 +++--- ...oud_sdk_odata_v4.GetAllRequestBuilder.html | 128 ++++----- ...d_sdk_odata_v4.GetByKeyRequestBuilder.html | 114 ++++---- ...sdk_odata_v4.ODataActionRequestConfig.html | 76 ++--- ...sdk_odata_v4.ODataBatchRequestBuilder.html | 88 +++--- ...4.ODataBoundActionImportRequestConfig.html | 70 ++--- ...data_v4.ODataBoundActionRequestConfig.html | 72 ++--- ...ta_v4.ODataBoundFunctionRequestConfig.html | 72 ++--- ...k_odata_v4.ODataFunctionRequestConfig.html | 78 ++--- ..._sdk_odata_v4.OperationRequestBuilder.html | 108 +++---- ...oud_sdk_odata_v4.UpdateRequestBuilder.html | 148 +++++----- ...oud_sdk_openapi.OpenApiRequestBuilder.html | 52 ++-- .../sap_cloud_sdk_util.ErrorWithCause.html | 40 +-- ...ap_cloud_sdk_util.UniqueNameGenerator.html | 54 ++-- ...cloud_sdk_connectivity.alwaysProvider.html | 8 +- ...oud_sdk_connectivity.alwaysSubscriber.html | 8 +- ...dk_connectivity.assertHttpDestination.html | 6 +- ...nnectivity.buildHeadersForDestination.html | 6 +- .../sap_cloud_sdk_connectivity.decodeJwt.html | 6 +- ...ectivity.destinationForServiceBinding.html | 8 +- ...cloud_sdk_connectivity.getAgentConfig.html | 6 +- ..._sdk_connectivity.getAgentConfigAsync.html | 6 +- ...AllDestinationsFromDestinationService.html | 6 +- ...onnectivity.getClientCredentialsToken.html | 8 +- ...cloud_sdk_connectivity.getDestination.html | 6 +- ....getDestinationFromDestinationService.html | 6 +- ...vity.getDestinationFromServiceBinding.html | 6 +- ...p_cloud_sdk_connectivity.getUserToken.html | 8 +- ...ud_sdk_connectivity.isHttpDestination.html | 6 +- ...cloud_sdk_connectivity.jwtBearerToken.html | 8 +- ...oud_sdk_connectivity.parseDestination.html | 6 +- ..._cloud_sdk_connectivity.parseProxyEnv.html | 6 +- ..._sdk_connectivity.registerDestination.html | 8 +- ...ap_cloud_sdk_connectivity.retrieveJwt.html | 6 +- ..._sdk_connectivity.sanitizeDestination.html | 6 +- ...p_cloud_sdk_connectivity.serviceToken.html | 8 +- ..._sdk_connectivity.setDestinationCache.html | 6 +- ...loud_sdk_connectivity.subscriberFirst.html | 8 +- ...sdk_connectivity.toDestinationNameUrl.html | 6 +- ...dk_connectivity.useOrFetchDestination.html | 6 +- .../sap_cloud_sdk_generator.generate.html | 6 +- ...loud_sdk_http_client.buildHttpRequest.html | 6 +- .../sap_cloud_sdk_http_client.csrf.html | 6 +- ...d_sdk_http_client.encodeAllParameters.html | 6 +- ...ud_sdk_http_client.executeHttpRequest.html | 10 +- ...p_client.executeHttpRequestWithOrigin.html | 10 +- .../sap_cloud_sdk_mail_client.sendMail.html | 10 +- .../sap_cloud_sdk_odata_common.and.html | 8 +- .../sap_cloud_sdk_odata_common.asc.html | 8 +- .../sap_cloud_sdk_odata_common.desc.html | 8 +- ...loud_sdk_odata_common.entityBuilder-1.html | 6 +- ...sdk_odata_common.entityDeserializer-1.html | 12 +- ...d_sdk_odata_common.entitySerializer-1.html | 6 +- ...oud_sdk_odata_common.filterFunction-1.html | 2 +- ...d_sdk_odata_common.isOrderableEdmType.html | 6 +- .../sap_cloud_sdk_odata_common.not.html | 6 +- .../sap_cloud_sdk_odata_common.or.html | 8 +- ...n.throwErrorWhenReturnTypeIsUnionType.html | 8 +- ...mmon.transformVariadicArgumentToArray.html | 8 +- .../sap_cloud_sdk_odata_v2.edmToTs.html | 10 +- ...cloud_sdk_odata_v2.entityDeserializer.html | 6 +- ...ap_cloud_sdk_odata_v2.filterFunctions.html | 6 +- .../sap_cloud_sdk_odata_v2.length.html | 4 +- ...data_v2.mergeDefaultDeSerializersWith.html | 6 +- .../sap_cloud_sdk_odata_v2.replace.html | 10 +- .../sap_cloud_sdk_odata_v2.substring.html | 4 +- .../sap_cloud_sdk_odata_v2.substringOf.html | 8 +- ...v2.transformReturnValueForComplexType.html | 10 +- ...ransformReturnValueForComplexTypeList.html | 10 +- ...ata_v2.transformReturnValueForEdmType.html | 10 +- ...v2.transformReturnValueForEdmTypeList.html | 10 +- ...data_v2.transformReturnValueForEntity.html | 8 +- ..._v2.transformReturnValueForEntityList.html | 8 +- ...a_v2.transformReturnValueForUndefined.html | 10 +- .../functions/sap_cloud_sdk_odata_v4.all.html | 6 +- .../functions/sap_cloud_sdk_odata_v4.any.html | 6 +- .../sap_cloud_sdk_odata_v4.contains.html | 8 +- .../sap_cloud_sdk_odata_v4.edmToTs.html | 10 +- ...cloud_sdk_odata_v4.entityDeserializer.html | 6 +- ...sap_cloud_sdk_odata_v4.filterFunction.html | 66 ++--- ...ap_cloud_sdk_odata_v4.filterFunctions.html | 6 +- ..._cloud_sdk_odata_v4.fractionalSeconds.html | 6 +- ...sap_cloud_sdk_odata_v4.hasSubsequence.html | 8 +- .../sap_cloud_sdk_odata_v4.hasSubset.html | 8 +- ...sap_cloud_sdk_odata_v4.matchesPattern.html | 8 +- .../sap_cloud_sdk_odata_v4.maxDateTime.html | 6 +- ...data_v4.mergeDefaultDeSerializersWith.html | 6 +- .../sap_cloud_sdk_odata_v4.minDateTime.html | 6 +- .../functions/sap_cloud_sdk_odata_v4.now.html | 6 +- ...cloud_sdk_odata_v4.totalOffsetMinutes.html | 6 +- ...v4.transformReturnValueForComplexType.html | 10 +- ...ransformReturnValueForComplexTypeList.html | 10 +- ...ata_v4.transformReturnValueForEdmType.html | 10 +- ...v4.transformReturnValueForEdmTypeList.html | 10 +- ...data_v4.transformReturnValueForEntity.html | 8 +- ..._v4.transformReturnValueForEntityList.html | 8 +- ...a_v4.transformReturnValueForUndefined.html | 10 +- ..._cloud_sdk_openapi_generator.generate.html | 6 +- ...p_cloud_sdk_resilience.circuitBreaker.html | 6 +- ...oud_sdk_resilience.circuitBreakerHttp.html | 4 +- .../sap_cloud_sdk_resilience.resilience.html | 6 +- .../sap_cloud_sdk_resilience.retry.html | 6 +- .../sap_cloud_sdk_resilience.timeout.html | 6 +- ...k_test_util.getTestDestinationByAlias.html | 8 +- ...oud_sdk_test_util.getTestDestinations.html | 6 +- ...sdk_test_util.mockAllTestDestinations.html | 6 +- ...oud_sdk_test_util.mockTestDestination.html | 8 +- ...loud_sdk_test_util.setTestDestination.html | 6 +- ...k_test_util.unmockAllTestDestinations.html | 4 +- ...d_sdk_test_util.unmockTestDestination.html | 6 +- .../functions/sap_cloud_sdk_util.assoc.html | 11 +- .../sap_cloud_sdk_util.camelCase.html | 6 +- .../functions/sap_cloud_sdk_util.caps.html | 6 +- .../sap_cloud_sdk_util.checkUrlExists.html | 6 +- .../sap_cloud_sdk_util.codeBlock.html | 8 +- .../sap_cloud_sdk_util.createLogger.html | 6 +- ...cloud_sdk_util.disableExceptionLogger.html | 4 +- ...sap_cloud_sdk_util.documentationBlock.html | 8 +- ..._cloud_sdk_util.enableExceptionLogger.html | 4 +- .../sap_cloud_sdk_util.encodeBase64.html | 6 +- .../functions/sap_cloud_sdk_util.equal.html | 8 +- .../sap_cloud_sdk_util.equalArrays.html | 8 +- .../sap_cloud_sdk_util.equalObjects.html | 8 +- .../functions/sap_cloud_sdk_util.exclude.html | 8 +- .../sap_cloud_sdk_util.filterDuplicates.html | 10 +- ..._cloud_sdk_util.filterDuplicatesRight.html | 10 +- .../sap_cloud_sdk_util.findProjectRoot.html | 2 +- .../sap_cloud_sdk_util.finishAll.html | 8 +- .../functions/sap_cloud_sdk_util.first.html | 6 +- .../functions/sap_cloud_sdk_util.flat.html | 6 +- .../functions/sap_cloud_sdk_util.flatten.html | 6 +- .../sap_cloud_sdk_util.formatJson.html | 6 +- ...sap_cloud_sdk_util.getGlobalLogFormat.html | 4 +- .../sap_cloud_sdk_util.getGlobalLogLevel.html | 4 +- .../sap_cloud_sdk_util.getLogger.html | 6 +- .../sap_cloud_sdk_util.getMessageOrStack.html | 6 +- .../sap_cloud_sdk_util.identity.html | 6 +- .../sap_cloud_sdk_util.isErrorWithCause.html | 6 +- .../sap_cloud_sdk_util.isNullish.html | 6 +- .../sap_cloud_sdk_util.kebabCase.html | 6 +- .../functions/sap_cloud_sdk_util.last.html | 6 +- .../sap_cloud_sdk_util.mergeIgnoreCase.html | 8 +- ...ap_cloud_sdk_util.mergeLeftIgnoreCase.html | 8 +- .../sap_cloud_sdk_util.muteLoggers.html | 4 +- .../sap_cloud_sdk_util.partition.html | 10 +- .../sap_cloud_sdk_util.pascalCase.html | 6 +- .../functions/sap_cloud_sdk_util.pick.html | 8 +- .../sap_cloud_sdk_util.pickIgnoreCase.html | 8 +- .../sap_cloud_sdk_util.pickNonNullish.html | 6 +- ...ap_cloud_sdk_util.pickValueIgnoreCase.html | 8 +- .../sap_cloud_sdk_util.propertyExists.html | 8 +- .../sap_cloud_sdk_util.readJSON.html | 6 +- ...ap_cloud_sdk_util.removeFileExtension.html | 6 +- ...p_cloud_sdk_util.removeLeadingSlashes.html | 2 +- .../sap_cloud_sdk_util.removeSlashes.html | 2 +- ..._cloud_sdk_util.removeTrailingSlashes.html | 2 +- .../sap_cloud_sdk_util.renameKeys.html | 8 +- ..._cloud_sdk_util.resetCustomLogFormats.html | 4 +- ...p_cloud_sdk_util.resetCustomLogLevels.html | 4 +- .../sap_cloud_sdk_util.sanitizeRecord.html | 10 +- ...sap_cloud_sdk_util.setGlobalLogFormat.html | 6 +- .../sap_cloud_sdk_util.setGlobalLogLevel.html | 6 +- ...ap_cloud_sdk_util.setGlobalTransports.html | 6 +- .../sap_cloud_sdk_util.setLogFormat.html | 8 +- .../sap_cloud_sdk_util.setLogLevel.html | 8 +- .../sap_cloud_sdk_util.splitInChunks.html | 8 +- .../sap_cloud_sdk_util.titleFormat.html | 6 +- .../sap_cloud_sdk_util.toSanitizedObject.html | 8 +- ...util.transformVariadicArgumentToArray.html | 8 +- .../functions/sap_cloud_sdk_util.trim.html | 6 +- .../sap_cloud_sdk_util.trimLeft.html | 6 +- .../sap_cloud_sdk_util.trimRight.html | 6 +- .../functions/sap_cloud_sdk_util.unique.html | 6 +- .../sap_cloud_sdk_util.unmuteLoggers.html | 4 +- ...sap_cloud_sdk_util.upperCaseSnakeCase.html | 6 +- .../functions/sap_cloud_sdk_util.zip.html | 8 +- knowledge-base/api-reference/hierarchy.html | 2 +- knowledge-base/api-reference/index.html | 4 +- ...loud_sdk_connectivity.AllDestinations.html | 12 +- ..._connectivity.BasicProxyConfiguration.html | 16 +- ...sap_cloud_sdk_connectivity.CacheEntry.html | 12 +- ...cloud_sdk_connectivity.CachingOptions.html | 8 +- ...onnectivity.ClientCredentialsResponse.html | 24 +- ...ap_cloud_sdk_connectivity.Destination.html | 124 ++++---- ...nnectivity.DestinationAccessorOptions.html | 24 +- ...sdk_connectivity.DestinationAuthToken.html | 24 +- ...k_connectivity.DestinationCertificate.html | 16 +- ...connectivity.DestinationConfiguration.html | 68 ++--- ..._connectivity.DestinationFetchOptions.html | 44 +-- ...y.DestinationForServiceBindingOptions.html | 8 +- ...loud_sdk_connectivity.DestinationJson.html | 16 +- ...d_sdk_connectivity.DestinationsByType.html | 12 +- ...loud_sdk_connectivity.HttpAgentConfig.html | 8 +- ...oud_sdk_connectivity.HttpsAgentConfig.html | 8 +- ...sap_cloud_sdk_connectivity.JwtPayload.html | 32 +-- ...d_sdk_connectivity.ProxyConfiguration.html | 24 +- ...onnectivity.ProxyConfigurationHeaders.html | 12 +- .../sap_cloud_sdk_connectivity.Service.html | 20 +- ...oud_sdk_connectivity.VerifyJwtOptions.html | 8 +- ..._cloud_sdk_generator.GeneratorOptions.html | 68 ++--- ...nerator_common.CommonGeneratorOptions.html | 60 ++-- ...sdk_http_client.CsrfMiddlewareOptions.html | 16 +- ...p_client.DestinationHttpRequestConfig.html | 28 +- ...sdk_http_client.HttpMiddlewareContext.html | 20 +- ...sdk_http_client.HttpRequestConfigBase.html | 40 +-- ...ud_sdk_http_client.HttpRequestOptions.html | 8 +- ...ap_cloud_sdk_http_client.HttpResponse.html | 12 +- ...p_cloud_sdk_http_client.OriginOptions.html | 12 +- .../sap_cloud_sdk_mail_client.Address.html | 12 +- .../sap_cloud_sdk_mail_client.Attachment.html | 44 +-- ..._cloud_sdk_mail_client.AttachmentLike.html | 12 +- .../sap_cloud_sdk_mail_client.Envelope.html | 12 +- ...oud_sdk_mail_client.MailClientOptions.html | 60 ++-- .../sap_cloud_sdk_mail_client.MailConfig.html | 60 ++-- ...ap_cloud_sdk_mail_client.MailResponse.html | 24 +- .../sap_cloud_sdk_mail_client.SDKOptions.html | 8 +- ..._sdk_mail_client.SmtpTransportOptions.html | 56 ++-- ...cloud_sdk_odata_common.BatchReference.html | 8 +- ...sdk_odata_common.ComplexTypeNamespace.html | 8 +- ..._cloud_sdk_odata_common.Constructable.html | 18 +- ...p_cloud_sdk_odata_common.DeSerializer.html | 43 +-- ..._cloud_sdk_odata_common.DeSerializers.html | 60 ++-- .../sap_cloud_sdk_odata_common.EntityApi.html | 26 +- ...d_sdk_odata_common.EntityDeserializer.html | 14 +- ...d_sdk_odata_common.EntityIdentifiable.html | 12 +- ...oud_sdk_odata_common.EntitySerializer.html | 19 +- ..._cloud_sdk_odata_common.ErrorResponse.html | 24 +- ...p_cloud_sdk_odata_common.FieldOptions.html | 12 +- ..._sdk_odata_common.FilterFunctionsType.html | 100 ++++--- .../sap_cloud_sdk_odata_common.ODataUri.html | 18 +- ...oud_sdk_odata_common.PropertyMetadata.html | 20 +- ...p_cloud_sdk_odata_common.ReadResponse.html | 36 +-- ...sdk_odata_common.ResponseDataAccessor.html | 27 +- .../sap_cloud_sdk_odata_common.Time.html | 16 +- ...d_sdk_odata_common.WithBatchReference.html | 14 +- .../sap_cloud_sdk_odata_common.WithETag.html | 12 +- ...k_odata_common.WithGetAllRestrictions.html | 24 +- .../sap_cloud_sdk_odata_common.WithKeys.html | 8 +- ..._cloud_sdk_odata_common.WithSelection.html | 8 +- ..._cloud_sdk_odata_common.WriteResponse.html | 28 +- ...cloud_sdk_odata_common.WriteResponses.html | 18 +- .../sap_cloud_sdk_odata_v2.DeSerializers.html | 72 ++--- .../sap_cloud_sdk_odata_v2.ErrorResponse.html | 24 +- ...cloud_sdk_odata_v2.ReadResponseCommon.html | 36 +-- ...loud_sdk_odata_v2.WriteResponseCommon.html | 28 +- ...oud_sdk_odata_v2.WriteResponsesCommon.html | 18 +- .../sap_cloud_sdk_odata_v4.DeSerializers.html | 80 +++--- ..._sdk_openapi.OpenApiRequestParameters.html | 16 +- ...loud_sdk_resilience.MiddlewareContext.html | 12 +- ...loud_sdk_resilience.MiddlewareOptions.html | 12 +- ...loud_sdk_resilience.ResilienceOptions.html | 16 +- ...k_test_util.GetTestDestinationOptions.html | 12 +- .../sap_cloud_sdk_util.LoggerOptions.html | 8 +- .../sap_cloud_sdk_util.MessageContextObj.html | 8 +- .../modules/sap_cloud_sdk_connectivity.html | 140 ++++----- .../modules/sap_cloud_sdk_generator.html | 8 +- .../sap_cloud_sdk_generator_common.html | 6 +- .../modules/sap_cloud_sdk_http_client.html | 42 +-- .../modules/sap_cloud_sdk_mail_client.html | 26 +- .../modules/sap_cloud_sdk_odata_common.html | 266 +++++++++--------- .../modules/sap_cloud_sdk_odata_v2.html | 146 +++++----- .../modules/sap_cloud_sdk_odata_v4.html | 184 ++++++------ .../modules/sap_cloud_sdk_openapi.html | 8 +- .../sap_cloud_sdk_openapi_generator.html | 8 +- .../modules/sap_cloud_sdk_resilience.html | 24 +- ...sap_cloud_sdk_temporal_de_serializers.html | 8 +- .../modules/sap_cloud_sdk_test_util.html | 20 +- .../modules/sap_cloud_sdk_util.html | 164 +++++------ ...dk_connectivity.AllDestinationOptions.html | 4 +- ...d_sdk_connectivity.AuthenticationType.html | 4 +- ...onnectivity.DestinationCacheInterface.html | 4 +- ...d_sdk_connectivity.DestinationOptions.html | 4 +- ...onnectivity.DestinationOrFetchOptions.html | 4 +- ...sdk_connectivity.DestinationProxyType.html | 4 +- ...nectivity.DestinationRetrievalOptions.html | 4 +- ...ectivity.DestinationSelectionStrategy.html | 4 +- ..._sdk_connectivity.DestinationWithName.html | 4 +- ..._connectivity.DestinationWithoutToken.html | 4 +- ...loud_sdk_connectivity.HttpDestination.html | 4 +- ...ctivity.HttpDestinationOrFetchOptions.html | 4 +- ...ud_sdk_connectivity.IsolationStrategy.html | 4 +- ...tivity.PartialDestinationFetchOptions.html | 4 +- .../sap_cloud_sdk_connectivity.Protocol.html | 4 +- ...nnectivity.RegisterDestinationOptions.html | 4 +- ...ivity.ServiceBindingTransformFunction.html | 4 +- ...tivity.ServiceBindingTransformOptions.html | 4 +- ...d_sdk_connectivity.ServiceCredentials.html | 4 +- ..._connectivity.XsuaaServiceCredentials.html | 4 +- ..._cloud_sdk_http_client.HttpMiddleware.html | 4 +- ...sdk_http_client.HttpMiddlewareOptions.html | 4 +- ...oud_sdk_http_client.HttpRequestConfig.html | 4 +- ...tp_client.HttpRequestConfigWithOrigin.html | 4 +- .../sap_cloud_sdk_http_client.Method.html | 4 +- ...loud_sdk_http_client.ParameterEncoder.html | 4 +- .../sap_cloud_sdk_mail_client.Headers.html | 4 +- ..._odata_common.BatchSubRequestPathType.html | 4 +- ...dk_odata_common.ChangesetBuilderTypes.html | 4 +- ..._sdk_odata_common.CollectionFieldType.html | 6 +- ...ta_common.ComplexTypeFieldConstructor.html | 4 +- ...data_common.ComplexTypePropertyFields.html | 4 +- ...d_sdk_odata_common.ConstructorOrField.html | 4 +- ..._sdk_odata_common.CustomOrDefaultType.html | 8 +- ...sdk_odata_common.DefaultDeSerializers.html | 4 +- ...oud_sdk_odata_common.DeserializedType.html | 8 +- ..._cloud_sdk_odata_common.EdmTypeCommon.html | 4 +- ...ata_common.EdmTypeDifferentConverters.html | 4 +- ...dk_odata_common.EdmTypeSameConverters.html | 4 +- ..._cloud_sdk_odata_common.EdmTypeShared.html | 4 +- ...ud_sdk_odata_common.EntityBuilderType.html | 4 +- ...sap_cloud_sdk_odata_common.EntityType.html | 4 +- ...dk_odata_common.EntityTypeFromFieldOf.html | 4 +- ...d_sdk_odata_common.ExclusiveEdmTypeV2.html | 4 +- ...d_sdk_odata_common.ExclusiveEdmTypeV4.html | 4 +- ...sap_cloud_sdk_odata_common.Expandable.html | 6 +- ...d_sdk_odata_common.FieldTypeByEdmType.html | 8 +- ...ta_common.FilterFunctionParameterType.html | 4 +- ....FilterFunctionPrimitiveParameterType.html | 4 +- ..._sdk_odata_common.FilterFunctionTypes.html | 4 +- ...sdk_odata_common.FilterLambdaOperator.html | 4 +- ...cloud_sdk_odata_common.FilterOperator.html | 4 +- ...dk_odata_common.FilterOperatorBoolean.html | 4 +- ...sdk_odata_common.FilterOperatorNumber.html | 4 +- ...sdk_odata_common.FilterOperatorString.html | 4 +- ...sap_cloud_sdk_odata_common.Filterable.html | 6 +- ...p_cloud_sdk_odata_common.FromJsonType.html | 6 +- ...odata_common.FunctionImportParameters.html | 4 +- ...ud_sdk_odata_common.IsSelectableField.html | 6 +- ...cloud_sdk_odata_common.NonNullishType.html | 4 +- ...ud_sdk_odata_common.NullableFieldType.html | 8 +- ...p_cloud_sdk_odata_common.NullishTypes.html | 4 +- ...cloud_sdk_odata_common.ODataVersionOf.html | 4 +- ..._sdk_odata_common.OperationParameters.html | 6 +- .../sap_cloud_sdk_odata_common.OrderType.html | 4 +- .../sap_cloud_sdk_odata_common.Orderable.html | 6 +- ...ata_common.OrderableAndOrderableInput.html | 6 +- ...oud_sdk_odata_common.OrderableEdmType.html | 4 +- ...cloud_sdk_odata_common.OrderableInput.html | 6 +- ...cloud_sdk_odata_common.PureEntityType.html | 4 +- ...ud_sdk_odata_common.RequestMethodType.html | 4 +- ...sap_cloud_sdk_odata_common.Selectable.html | 4 +- ...oud_sdk_odata_common.SimpleTypeFields.html | 4 +- .../sap_cloud_sdk_odata_v2.BatchResponse.html | 4 +- ...loud_sdk_odata_v2.CustomDeSerializers.html | 4 +- ...loud_sdk_odata_v2.CustomOrDefaultType.html | 8 +- ...oud_sdk_odata_v2.DefaultDeSerializers.html | 4 +- ...loud_sdk_odata_v2.FilterFunctionsType.html | 4 +- ...d_sdk_odata_v4.ActionImportParameters.html | 4 +- .../sap_cloud_sdk_odata_v4.BatchResponse.html | 4 +- ...loud_sdk_odata_v4.CustomDeSerializers.html | 4 +- ...loud_sdk_odata_v4.CustomOrDefaultType.html | 8 +- ...oud_sdk_odata_v4.DefaultDeSerializers.html | 4 +- ...loud_sdk_odata_v4.FilterFunctionTypes.html | 4 +- ...dk_openapi_generator.GeneratorOptions.html | 4 +- .../sap_cloud_sdk_resilience.Middleware.html | 4 +- ...oud_sdk_resilience.MiddlewareFunction.html | 4 +- .../types/sap_cloud_sdk_util.LogLevel.html | 4 +- .../sap_cloud_sdk_util.ODataVersion.html | 4 +- .../types/sap_cloud_sdk_util.Without.html | 4 +- .../types/sap_cloud_sdk_util.Xor.html | 4 +- ...tivity.DestinationSelectionStrategies.html | 4 +- ...sdk_http_client.defaultDisallowedKeys.html | 4 +- ...ctionFunctionImportRequestBuilderBase.html | 4 +- ..._odata_common.FunctionImportParameter.html | 4 +- ...mmon.ODataFunctionImportRequestConfig.html | 4 +- ...odata_v2.FunctionImportRequestBuilder.html | 4 +- ...a_v2.ODataFunctionImportRequestConfig.html | 4 +- ...d_sdk_odata_v2.defaultDeSerializers-1.html | 4 +- ...ata_v4.ODataActionImportRequestConfig.html | 4 +- ...a_v4.ODataFunctionImportRequestConfig.html | 4 +- ...OdataBoundFunctionImportRequestConfig.html | 4 +- ...d_sdk_odata_v4.defaultDeSerializers-1.html | 4 +- ...e_serializers.temporalDeSerializersV2.html | 4 +- ...e_serializers.temporalDeSerializersV4.html | 4 +- ...loud_sdk_util.cloudSdkExceptionLogger.html | 4 +- .../variables/sap_cloud_sdk_util.kibana.html | 4 +- .../variables/sap_cloud_sdk_util.local.html | 4 +- .../sap_cloud_sdk_util.logFormat.html | 4 +- .../variables/sap_cloud_sdk_util.unixEOL.html | 4 +- .../variables/sap_cloud_sdk_util.webEOL.html | 4 +- package.json | 2 +- packages/connectivity/CHANGELOG.md | 8 - packages/connectivity/package.json | 6 +- packages/eslint-config/CHANGELOG.md | 2 - packages/eslint-config/package.json | 2 +- packages/generator-common/CHANGELOG.md | 6 - packages/generator-common/package.json | 4 +- packages/generator/CHANGELOG.md | 11 - packages/generator/package.json | 12 +- packages/http-client/CHANGELOG.md | 9 - packages/http-client/package.json | 8 +- packages/mail-client/CHANGELOG.md | 8 - packages/mail-client/package.json | 6 +- packages/odata-common/CHANGELOG.md | 10 - packages/odata-common/package.json | 10 +- packages/odata-v2/CHANGELOG.md | 11 - packages/odata-v2/package.json | 14 +- packages/odata-v4/CHANGELOG.md | 11 - packages/odata-v4/package.json | 12 +- packages/openapi-generator/CHANGELOG.md | 9 - packages/openapi-generator/package.json | 8 +- packages/openapi/CHANGELOG.md | 11 - packages/openapi/package.json | 10 +- packages/resilience/CHANGELOG.md | 6 - packages/resilience/package.json | 4 +- packages/temporal-de-serializers/CHANGELOG.md | 7 - packages/temporal-de-serializers/package.json | 4 +- packages/test-util/CHANGELOG.md | 8 - packages/test-util/package.json | 6 +- packages/util/CHANGELOG.md | 2 - packages/util/package.json | 2 +- test-packages/e2e-tests/CHANGELOG.md | 2 - test-packages/e2e-tests/package.json | 20 +- test-packages/integration-tests/CHANGELOG.md | 13 - test-packages/integration-tests/package.json | 24 +- test-packages/self-tests/CHANGELOG.md | 2 - test-packages/self-tests/package.json | 2 +- test-packages/test-services-e2e/CHANGELOG.md | 2 - test-packages/test-services-e2e/package.json | 2 +- .../test-services-odata-common/CHANGELOG.md | 2 - .../test-services-odata-common/package.json | 4 +- .../test-services-odata-v2/CHANGELOG.md | 2 - .../test-services-odata-v2/package.json | 2 +- .../test-services-odata-v4/CHANGELOG.md | 2 - .../test-services-odata-v4/package.json | 2 +- .../test-services-openapi/CHANGELOG.md | 7 - .../no-schema-service/package.json | 2 +- .../test-services-openapi/package.json | 6 +- .../swagger-yaml-service/package.json | 2 +- .../test-service/package.json | 2 +- test-packages/type-tests/CHANGELOG.md | 2 - test-packages/type-tests/package.json | 22 +- 507 files changed, 5459 insertions(+), 5574 deletions(-) create mode 100644 .changeset/five-socks-confess.md create mode 100644 .changeset/seven-shoes-do.md delete mode 100644 knowledge-base/api-reference/assets/icons.js delete mode 100644 knowledge-base/api-reference/assets/icons.svg diff --git a/.changeset/five-socks-confess.md b/.changeset/five-socks-confess.md new file mode 100644 index 0000000000..57e22f4ea4 --- /dev/null +++ b/.changeset/five-socks-confess.md @@ -0,0 +1,6 @@ +--- +"@sap-cloud-sdk/odata-common": patch +"@sap-cloud-sdk/openapi": patch +--- + +[Fixed Issue] Fix type in `addCustomRequestConfiguration` method to accept values of type `any`. diff --git a/.changeset/seven-shoes-do.md b/.changeset/seven-shoes-do.md new file mode 100644 index 0000000000..59b7d023f2 --- /dev/null +++ b/.changeset/seven-shoes-do.md @@ -0,0 +1,5 @@ +--- +"@sap-cloud-sdk/connectivity": patch +--- + +[Fixed Issue] Fix `fetchDestinationWithoutTokenRetrieval` to correctly return instance and subaccount destinations. diff --git a/CHANGELOG.md b/CHANGELOG.md index 0fc17778e2..307690de02 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -28,17 +28,6 @@ - -# 3.12.1 - -API Docs: https://sap.github.io/cloud-sdk/api/3.12.1 - -## Fixed Issues - -- [connectivity] Fix `fetchDestinationWithoutTokenRetrieval` to correctly return instance and subaccount destinations. - - @sap-cloud-sdk/resilience@3.12.1 - - @sap-cloud-sdk/util@3.12.1 (64341b1) -- [openapi, odata-common] Fix type in `addCustomRequestConfiguration` method to accept values of type `any`. (7e93fd7) - # 3.12.0 API Docs: https://sap.github.io/cloud-sdk/api/3.12.0 diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md index 6ac6bdc76e..3f81e29e3c 100644 --- a/DOCUMENTATION.md +++ b/DOCUMENTATION.md @@ -1,4 +1,4 @@ -## Version: 3.12.1 +## Version: 3.12.0 The SAP Cloud SDK for JavaScript consists of multiple libraries to enable you to write side-by-side extensions on SAP Business Technology Platform. diff --git a/knowledge-base/api-reference/assets/icons.js b/knowledge-base/api-reference/assets/icons.js deleted file mode 100644 index b79c9e89fb..0000000000 --- a/knowledge-base/api-reference/assets/icons.js +++ /dev/null @@ -1,15 +0,0 @@ -(function(svg) { - svg.innerHTML = ``; - svg.style.display = 'none'; - if (location.protocol === 'file:') { - if (document.readyState === 'loading') document.addEventListener('DOMContentLoaded', updateUseElements); - else updateUseElements() - function updateUseElements() { - document.querySelectorAll('use').forEach(el => { - if (el.getAttribute('href').includes('#icon-')) { - el.setAttribute('href', el.getAttribute('href').replace(/.*#/, '#')); - } - }); - } - } -})(document.body.appendChild(document.createElementNS('http://www.w3.org/2000/svg', 'svg'))) \ No newline at end of file diff --git a/knowledge-base/api-reference/assets/icons.svg b/knowledge-base/api-reference/assets/icons.svg deleted file mode 100644 index 7dead61183..0000000000 --- a/knowledge-base/api-reference/assets/icons.svg +++ /dev/null @@ -1 +0,0 @@ - \ No newline at end of file diff --git a/knowledge-base/api-reference/assets/main.js b/knowledge-base/api-reference/assets/main.js index 1daeb69001..7270cff8dc 100644 --- a/knowledge-base/api-reference/assets/main.js +++ b/knowledge-base/api-reference/assets/main.js @@ -1,8 +1,8 @@ "use strict"; -"use strict";(()=>{var Ce=Object.create;var ne=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var _e=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var Me=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Fe=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!Re.call(t,i)&&i!==n&&ne(t,i,{get:()=>e[i],enumerable:!(r=Pe(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Ce(_e(t)):{},Fe(e||!t||!t.__esModule?ne(n,"default",{value:t,enumerable:!0}):n,t));var ae=Me((se,oe)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. -`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[u+1]*i[d+1],u+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),y=s.str.charAt(1),p;y in s.node.edges?p=s.node.edges[y]:(p=new t.TokenSet,s.node.edges[y]=p),s.str.length==1&&(p.final=!0),i.push({node:p,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof se=="object"?oe.exports=n():e.lunr=n()}(this,function(){return t})})()});var re=[];function G(t,e){re.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible()),document.body.style.display||(this.scrollToHash(),this.updateIndexVisibility())}createComponents(e){re.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}showPage(){document.body.style.display&&(document.body.style.removeProperty("display"),this.scrollToHash(),this.updateIndexVisibility())}scrollToHash(){if(location.hash){let e=document.getElementById(location.hash.substring(1));if(!e)return;e.scrollIntoView({behavior:"instant",block:"start"})}}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e&&!e.checkVisibility()){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r}}updateIndexVisibility(){let e=document.querySelector(".tsd-index-content"),n=e?.open;e&&(e.open=!0),document.querySelectorAll(".tsd-index-section").forEach(r=>{r.style.display="block";let i=Array.from(r.querySelectorAll(".tsd-index-link")).every(s=>s.offsetParent==null);r.style.display=i?"none":"block"}),e&&(e.open=n)}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(n&&n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let r=document.createElement("p");r.classList.add("warning"),r.textContent="This member is normally hidden due to your filter settings.",n.prepend(r)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var de=De(ae());async function le(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=de.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function he(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{le(e,t)}),le(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");let s=!1;i.addEventListener("mousedown",()=>s=!0),i.addEventListener("mouseup",()=>{s=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{s||(s=!1,t.classList.remove("has-focus"))}),Ae(t,i,r,e)}function Ae(t,e,n,r){n.addEventListener("input",ie(()=>{Ne(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ve(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ne(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=ce(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` - ${ce(l.parent,i)}.${d}`);let y=document.createElement("li");y.classList.value=l.classes??"";let p=document.createElement("a");p.href=r.base+l.url,p.innerHTML=u+d,y.append(p),e.appendChild(y)}}function ue(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ve(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),e.blur()}}function ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(K(t.substring(s))),i.join("")}var He={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>He[e])}var I=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",fe="mousemove",H="mouseup",J={x:0,y:0},pe=!1,ee=!1,Be=!1,D=!1,me=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(me?"is-mobile":"not-mobile");me&&"ontouchstart"in document.documentElement&&(Be=!0,F="touchstart",fe="touchmove",H="touchend");document.addEventListener(F,t=>{ee=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(fe,t=>{if(ee&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(H,()=>{ee=!1});document.addEventListener("click",t=>{pe&&(t.preventDefault(),t.stopImmediatePropagation(),pe=!1)});var X=class extends I{constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(H,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(F,n=>this.onDocumentPointerDown(n)),document.addEventListener(H,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){D||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!D&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var ye=document.head.appendChild(document.createElement("style"));ye.dataset.for="filters";var Y=class extends I{constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ye.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } -`,this.app.updateIndexVisibility()}fromLocalStorage(){let e=Q.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){Q.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),this.app.updateIndexVisibility()}};var Z=class extends I{constructor(e){super(e),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let r=this.summary.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ge(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ve(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ve(t.value)})}function ve(t){document.documentElement.dataset.theme=t}var Le;function be(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",xe),xe())}async function xe(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();Le=t.dataset.base+"/",t.innerHTML="";for(let s of i)we(s,t,[]);window.app.createComponents(t),window.app.showPage(),window.app.ensureActivePageVisible()}function we(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-index-accordion`:"tsd-index-accordion",s.dataset.key=i.join("$");let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.innerHTML='',Ee(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)we(u,l,i)}else Ee(t,r,t.class)}function Ee(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=Le+t.path,n&&(r.className=n),location.pathname===r.pathname&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Se=document.getElementById("tsd-theme");Se&&ge(Se);var je=new U;Object.defineProperty(window,"app",{value:je});he();be();})(); +"use strict";(()=>{var Pe=Object.create;var ne=Object.defineProperty;var Ie=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var _e=Object.getPrototypeOf,Re=Object.prototype.hasOwnProperty;var Me=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var Fe=(t,e,n,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let i of Oe(e))!Re.call(t,i)&&i!==n&&ne(t,i,{get:()=>e[i],enumerable:!(r=Ie(e,i))||r.enumerable});return t};var De=(t,e,n)=>(n=t!=null?Pe(_e(t)):{},Fe(e||!t||!t.__esModule?ne(n,"default",{value:t,enumerable:!0}):n,t));var ae=Me((se,oe)=>{(function(){var t=function(e){var n=new t.Builder;return n.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),n.searchPipeline.add(t.stemmer),e.call(n,n),n.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(n){e.console&&console.warn&&console.warn(n)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var n=Object.create(null),r=Object.keys(e),i=0;i0){var d=t.utils.clone(n)||{};d.position=[a,u],d.index=s.length,s.push(new t.Token(r.slice(a,o),d))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,n){n in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+n),e.label=n,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var n=e.label&&e.label in this.registeredFunctions;n||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. +`,e)},t.Pipeline.load=function(e){var n=new t.Pipeline;return e.forEach(function(r){var i=t.Pipeline.registeredFunctions[r];if(i)n.add(i);else throw new Error("Cannot load unregistered function: "+r)}),n},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(n){t.Pipeline.warnIfFunctionNotRegistered(n),this._stack.push(n)},this)},t.Pipeline.prototype.after=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");r=r+1,this._stack.splice(r,0,n)},t.Pipeline.prototype.before=function(e,n){t.Pipeline.warnIfFunctionNotRegistered(n);var r=this._stack.indexOf(e);if(r==-1)throw new Error("Cannot find existingFn");this._stack.splice(r,0,n)},t.Pipeline.prototype.remove=function(e){var n=this._stack.indexOf(e);n!=-1&&this._stack.splice(n,1)},t.Pipeline.prototype.run=function(e){for(var n=this._stack.length,r=0;r1&&(oe&&(r=s),o!=e);)i=r-n,s=n+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(ol?d+=2:a==l&&(n+=r[u+1]*i[d+1],u+=2,d+=2);return n},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),n=1,r=0;n0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}if(s.str.length==0&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var u=s.node.edges["*"];else{var u=new t.TokenSet;s.node.edges["*"]=u}s.str.length==1&&(u.final=!0),i.push({node:u,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var d=s.str.charAt(0),v=s.str.charAt(1),f;v in s.node.edges?f=s.node.edges[v]:(f=new t.TokenSet,s.node.edges[v]=f),s.str.length==1&&(f.final=!0),i.push({node:f,editsRemaining:s.editsRemaining-1,str:d+s.str.slice(2)})}}}return r},t.TokenSet.fromString=function(e){for(var n=new t.TokenSet,r=n,i=0,s=e.length;i=e;n--){var r=this.uncheckedNodes[n],i=r.child.toString();i in this.minimizedNodes?r.parent.edges[r.char]=this.minimizedNodes[i]:(r.child._str=i,this.minimizedNodes[i]=r.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(n){var r=new t.QueryParser(e,n);r.parse()})},t.Index.prototype.query=function(e){for(var n=new t.Query(this.fields),r=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),l=0;l1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,n){var r=e[this._ref],i=Object.keys(this._fields);this._documents[r]=n||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,n;do e=this.next(),n=e.charCodeAt(0);while(n>47&&n<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var n=e.next();if(n==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(n.charCodeAt(0)==92){e.escapeCharacter();continue}if(n==":")return t.QueryLexer.lexField;if(n=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(n=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(n=="+"&&e.width()===1||n=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(n.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,n){this.lexer=new t.QueryLexer(e),this.query=n,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var n=e.peekLexeme();if(n!=null)switch(n.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expected either a field or a term, found "+n.type;throw n.str.length>=1&&(r+=" with value '"+n.str+"'"),new t.QueryParseError(r,n.start,n.end)}},t.QueryParser.parsePresence=function(e){var n=e.consumeLexeme();if(n!=null){switch(n.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var r="unrecognised presence operator'"+n.str+"'";throw new t.QueryParseError(r,n.start,n.end)}var i=e.peekLexeme();if(i==null){var r="expecting term or field, found nothing";throw new t.QueryParseError(r,n.start,n.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var r="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(r,i.start,i.end)}}},t.QueryParser.parseField=function(e){var n=e.consumeLexeme();if(n!=null){if(e.query.allFields.indexOf(n.str)==-1){var r=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+n.str+"', possible fields: "+r;throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.fields=[n.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,n.start,n.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var n=e.consumeLexeme();if(n!=null){e.currentClause.term=n.str.toLowerCase(),n.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var r=e.peekLexeme();if(r==null){e.nextClause();return}switch(r.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+r.type+"'";throw new t.QueryParseError(i,r.start,r.end)}}},t.QueryParser.parseEditDistance=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="edit distance must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.editDistance=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var n=e.consumeLexeme();if(n!=null){var r=parseInt(n.str,10);if(isNaN(r)){var i="boost must be numeric";throw new t.QueryParseError(i,n.start,n.end)}e.currentClause.boost=r;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,n){typeof define=="function"&&define.amd?define(n):typeof se=="object"?oe.exports=n():e.lunr=n()}(this,function(){return t})})()});var re=[];function G(t,e){re.push({selector:e,constructor:t})}var U=class{constructor(){this.alwaysVisibleMember=null;this.createComponents(document.body),this.ensureActivePageVisible(),this.ensureFocusedElementVisible(),this.listenForCodeCopies(),window.addEventListener("hashchange",()=>this.ensureFocusedElementVisible())}createComponents(e){re.forEach(n=>{e.querySelectorAll(n.selector).forEach(r=>{r.dataset.hasInstance||(new n.constructor({el:r,app:this}),r.dataset.hasInstance=String(!0))})})}filterChanged(){this.ensureFocusedElementVisible()}ensureActivePageVisible(){let e=document.querySelector(".tsd-navigation .current"),n=e?.parentElement;for(;n&&!n.classList.contains(".tsd-navigation");)n instanceof HTMLDetailsElement&&(n.open=!0),n=n.parentElement;if(e){let r=e.getBoundingClientRect().top-document.documentElement.clientHeight/4;document.querySelector(".site-menu").scrollTop=r}}ensureFocusedElementVisible(){if(this.alwaysVisibleMember&&(this.alwaysVisibleMember.classList.remove("always-visible"),this.alwaysVisibleMember.firstElementChild.remove(),this.alwaysVisibleMember=null),!location.hash)return;let e=document.getElementById(location.hash.substring(1));if(!e)return;let n=e.parentElement;for(;n&&n.tagName!=="SECTION";)n=n.parentElement;if(n&&n.offsetParent==null){this.alwaysVisibleMember=n,n.classList.add("always-visible");let r=document.createElement("p");r.classList.add("warning"),r.textContent="This member is normally hidden due to your filter settings.",n.prepend(r)}}listenForCodeCopies(){document.querySelectorAll("pre > button").forEach(e=>{let n;e.addEventListener("click",()=>{e.previousElementSibling instanceof HTMLElement&&navigator.clipboard.writeText(e.previousElementSibling.innerText.trim()),e.textContent="Copied!",e.classList.add("visible"),clearTimeout(n),n=setTimeout(()=>{e.classList.remove("visible"),n=setTimeout(()=>{e.textContent="Copy"},100)},1e3)})})}};var ie=(t,e=100)=>{let n;return()=>{clearTimeout(n),n=setTimeout(()=>t(),e)}};var de=De(ae());async function le(t,e){if(!window.searchData)return;let n=await fetch(window.searchData),r=new Blob([await n.arrayBuffer()]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();t.data=i,t.index=de.Index.load(i.index),e.classList.remove("loading"),e.classList.add("ready")}function he(){let t=document.getElementById("tsd-search");if(!t)return;let e={base:t.dataset.base+"/"},n=document.getElementById("tsd-search-script");t.classList.add("loading"),n&&(n.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),n.addEventListener("load",()=>{le(e,t)}),le(e,t));let r=document.querySelector("#tsd-search input"),i=document.querySelector("#tsd-search .results");if(!r||!i)throw new Error("The input field or the result list wrapper was not found");let s=!1;i.addEventListener("mousedown",()=>s=!0),i.addEventListener("mouseup",()=>{s=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{s||(s=!1,t.classList.remove("has-focus"))}),Ae(t,i,r,e)}function Ae(t,e,n,r){n.addEventListener("input",ie(()=>{Ne(t,e,n,r)},200));let i=!1;n.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ve(e,n):s.key=="Escape"?n.blur():s.key=="ArrowUp"?ue(e,-1):s.key==="ArrowDown"?ue(e,1):i=!1}),n.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!n.matches(":focus")&&s.key==="/"&&(n.focus(),s.preventDefault())})}function Ne(t,e,n,r){if(!r.index||!r.data)return;e.textContent="";let i=n.value.trim(),s;if(i){let o=i.split(" ").map(a=>a.length?`*${a}*`:"").join(" ");s=r.index.search(o)}else s=[];for(let o=0;oa.score-o.score);for(let o=0,a=Math.min(10,s.length);o`,d=ce(l.name,i);globalThis.DEBUG_SEARCH_WEIGHTS&&(d+=` (score: ${s[o].score.toFixed(2)})`),l.parent&&(d=` + ${ce(l.parent,i)}.${d}`);let v=document.createElement("li");v.classList.value=l.classes??"";let f=document.createElement("a");f.href=r.base+l.url,f.innerHTML=u+d,v.append(f),e.appendChild(v)}}function ue(t,e){let n=t.querySelector(".current");if(!n)n=t.querySelector(e==1?"li:first-child":"li:last-child"),n&&n.classList.add("current");else{let r=n;if(e===1)do r=r.nextElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);else do r=r.previousElementSibling??void 0;while(r instanceof HTMLElement&&r.offsetParent==null);r&&(n.classList.remove("current"),r.classList.add("current"))}}function Ve(t,e){let n=t.querySelector(".current");if(n||(n=t.querySelector("li:first-child")),n){let r=n.querySelector("a");r&&(window.location.href=r.href),e.blur()}}function ce(t,e){if(e==="")return t;let n=t.toLocaleLowerCase(),r=e.toLocaleLowerCase(),i=[],s=0,o=n.indexOf(r);for(;o!=-1;)i.push(K(t.substring(s,o)),`${K(t.substring(o,o+r.length))}`),s=o+r.length,o=n.indexOf(r,s);return i.push(K(t.substring(s))),i.join("")}var Be={"&":"&","<":"<",">":">","'":"'",'"':"""};function K(t){return t.replace(/[&<>"'"]/g,e=>Be[e])}var C=class{constructor(e){this.el=e.el,this.app=e.app}};var F="mousedown",pe="mousemove",B="mouseup",J={x:0,y:0},fe=!1,ee=!1,He=!1,D=!1,me=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(me?"is-mobile":"not-mobile");me&&"ontouchstart"in document.documentElement&&(He=!0,F="touchstart",pe="touchmove",B="touchend");document.addEventListener(F,t=>{ee=!0,D=!1;let e=F=="touchstart"?t.targetTouches[0]:t;J.y=e.pageY||0,J.x=e.pageX||0});document.addEventListener(pe,t=>{if(ee&&!D){let e=F=="touchstart"?t.targetTouches[0]:t,n=J.x-(e.pageX||0),r=J.y-(e.pageY||0);D=Math.sqrt(n*n+r*r)>10}});document.addEventListener(B,()=>{ee=!1});document.addEventListener("click",t=>{fe&&(t.preventDefault(),t.stopImmediatePropagation(),fe=!1)});var X=class extends C{constructor(e){super(e),this.className=this.el.dataset.toggle||"",this.el.addEventListener(B,n=>this.onPointerUp(n)),this.el.addEventListener("click",n=>n.preventDefault()),document.addEventListener(F,n=>this.onDocumentPointerDown(n)),document.addEventListener(B,n=>this.onDocumentPointerUp(n))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let n=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(n),setTimeout(()=>document.documentElement.classList.remove(n),500)}onPointerUp(e){D||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-sidebar, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!D&&this.active&&e.target.closest(".col-sidebar")){let n=e.target.closest("a");if(n){let r=window.location.href;r.indexOf("#")!=-1&&(r=r.substring(0,r.indexOf("#"))),n.href.substring(0,r.length)==r&&setTimeout(()=>this.setActive(!1),250)}}}};var te;try{te=localStorage}catch{te={getItem(){return null},setItem(){}}}var Q=te;var ve=document.head.appendChild(document.createElement("style"));ve.dataset.for="filters";var Y=class extends C{constructor(e){super(e),this.key=`filter-${this.el.name}`,this.value=this.el.checked,this.el.addEventListener("change",()=>{this.setLocalStorage(this.el.checked)}),this.setLocalStorage(this.fromLocalStorage()),ve.innerHTML+=`html:not(.${this.key}) .tsd-is-${this.el.name} { display: none; } +`,this.handleValueChange()}fromLocalStorage(){let e=Q.getItem(this.key);return e?e==="true":this.el.checked}setLocalStorage(e){Q.setItem(this.key,e.toString()),this.value=e,this.handleValueChange()}handleValueChange(){this.el.checked=this.value,document.documentElement.classList.toggle(this.key,this.value),this.app.filterChanged(),document.querySelectorAll(".tsd-index-section").forEach(e=>{e.style.display="block";let n=Array.from(e.querySelectorAll(".tsd-index-link")).every(r=>r.offsetParent==null);e.style.display=n?"none":"block"})}};var Z=class extends C{constructor(e){super(e),this.summary=this.el.querySelector(".tsd-accordion-summary"),this.icon=this.summary.querySelector("svg"),this.key=`tsd-accordion-${this.summary.dataset.key??this.summary.textContent.trim().replace(/\s+/g,"-").toLowerCase()}`;let n=Q.getItem(this.key);this.el.open=n?n==="true":this.el.open,this.el.addEventListener("toggle",()=>this.update());let r=this.summary.querySelector("a");r&&r.addEventListener("click",()=>{location.assign(r.href)}),this.update()}update(){this.icon.style.transform=`rotate(${this.el.open?0:-90}deg)`,Q.setItem(this.key,this.el.open.toString())}};function ge(t){let e=Q.getItem("tsd-theme")||"os";t.value=e,ye(e),t.addEventListener("change",()=>{Q.setItem("tsd-theme",t.value),ye(t.value)})}function ye(t){document.documentElement.dataset.theme=t}var Le;function be(){let t=document.getElementById("tsd-nav-script");t&&(t.addEventListener("load",xe),xe())}async function xe(){let t=document.getElementById("tsd-nav-container");if(!t||!window.navigationData)return;let n=await(await fetch(window.navigationData)).arrayBuffer(),r=new Blob([n]).stream().pipeThrough(new DecompressionStream("gzip")),i=await new Response(r).json();Le=t.dataset.base+"/",t.innerHTML="";for(let s of i)we(s,t,[]);window.app.createComponents(t),window.app.ensureActivePageVisible()}function we(t,e,n){let r=e.appendChild(document.createElement("li"));if(t.children){let i=[...n,t.text],s=r.appendChild(document.createElement("details"));s.className=t.class?`${t.class} tsd-index-accordion`:"tsd-index-accordion",s.dataset.key=i.join("$");let o=s.appendChild(document.createElement("summary"));o.className="tsd-accordion-summary",o.innerHTML='',Ee(t,o);let a=s.appendChild(document.createElement("div"));a.className="tsd-accordion-details";let l=a.appendChild(document.createElement("ul"));l.className="tsd-nested-navigation";for(let u of t.children)we(u,l,i)}else Ee(t,r,t.class)}function Ee(t,e,n){if(t.path){let r=e.appendChild(document.createElement("a"));r.href=Le+t.path,n&&(r.className=n),location.href===r.href&&r.classList.add("current"),t.kind&&(r.innerHTML=``),r.appendChild(document.createElement("span")).textContent=t.text}else e.appendChild(document.createElement("span")).textContent=t.text}G(X,"a[data-toggle]");G(Z,".tsd-index-accordion");G(Y,".tsd-filter-item input[type=checkbox]");var Se=document.getElementById("tsd-theme");Se&&ge(Se);var je=new U;Object.defineProperty(window,"app",{value:je});he();be();})(); /*! Bundled license information: lunr/lunr.js: diff --git a/knowledge-base/api-reference/assets/navigation.js b/knowledge-base/api-reference/assets/navigation.js index 8a97054bcb..1756e36fff 100644 --- a/knowledge-base/api-reference/assets/navigation.js +++ b/knowledge-base/api-reference/assets/navigation.js @@ -1 +1 @@ -window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA82dXXPcNpaG/4v2NvZMHCa746uVZNlxYlsuS/akairlgkh0NyI22QFASe2p/PctfjQbIICDc8Du3rmzVXjfBwQJ4uMcsP/17zPNn/TZy7P/VWzzLC/rpnimivu/5XVV8VyLB6G3Z9+dbZhenb08W9dFU3L1N8U2X7uyX1Vx/9Us+3yl1+XZd2f3oirOXr747ixfibKQvDp7+a+RdV6Wr7jSomJa1JXa+4tKc7lgOYyYyCfIH3/667uRdMGUyD/K+ml7WVcLsWxkp6ESAzYQ+ZLlK35VabmlwvbKmL+oltebpCa01SCnFLzSl5IXvNKCleoTV5u6UpyMDBlBdOM+U3mGFEk4z3OuVC0T2zTshOU3enVb3/M5lzp6IJmXXGqxEDnT5Bvqd8Fy53THkA+S/ZrrfDX/Jps2WHItb7h8EDm/EFWR3n0Rlsga/aJmNX8rR5LUxfZ2u5nzlA0OEO9nrTfny/Y90z0XVNhEHiOpmSiFZP3yqD+ybVmzgkrZKyH/+QMkbWx0S//MWcEluR8EjSD60F2orEEGOX/hUiy2vzzqxG491UMsexLkAPV2Q5lE+YF//8d/f//jCxPa6FU7euedyO7OcaIjjuHM93w7KXq7a0UCNehBgNNbl960pkL6RygSVQLDEwTvuhTxzvrkBOQnrqXgD6ycdcVTF0IFbnjZOtbVjZZM8+U2rQaODaEK/xR69YGtE1t9pyYC60ZP5ptU6M4hBm5HO+9cPgqcKImg5K4E+sQq8VbVJUt8nhxtDPaRyXY5FZ3fRsmwkbca353lJVPq7OVZwTeSt/P/4swe6HWd1yWlFoMkdtmf+FIozeWs13TYJIa359y3klVqUcv166bKiQ94xCmxIvS2gI2Q1TCW93S0IY7hflMNY7OYAYcZo4bgBv+BScHuIntlsJldlR/MWrDykW3VR1k/iILLPXUxPDQg1RbblJ8yh3LT3KlcirtEzl4OkZTiUgcHCRzO5wEw7xpRFsNy4XUt08FhI4Be8Lwu+C+PmggbdaB3eHeAjAtbTWsQGwyWXHvXy6iK2OJ56HO1rfJZ/M4BuANtaXuT+rWs11Z3n6xB0ZXA2MI1czZiJ3NAbFX8PjA7vZfZYjTlUO0etSTVaFafjNnBNfmsuEy84aMUIAg17y3u6AHWH4/6gjOZdj22GKBsmFQ8/YKm8hipW0BfVQ8pmJ0WYEh3xkskeRxAXrcqTxjpDCXgr1gltPg24wZ5HCBe39VSnjhTChLM7t3tWZFBjgPEGydor4VU1Ls0UQMcXRuVajcrPsuSCPNZAMRG8WHdnv50eD0c5u8GdRJIX/KKS6ZrY/bsj6KPBVEh9De70vit5j1gKob2mQcV4hnc++80Se30LK/Xa/M+RZrra18e1WqXXdE5bbej+Z3chgSueKV1+992EhW72Lbo174o7jqVXLwXRVHyRyY5/jJNjtcDGetrx/BP/M+GK3x0zGRDVrGg3L7Ol3XV/Z3G9nrEoFYNLxgqO2IKdTyQ0LTb6xrEcejEDxcUT/W4lmIp3D08FMPS4h8QeLso/FBgNqGB7keDITfggC6H4UFdLM5qQwH9PZhB3ZvE+O+5XtUFHtWXR2ykszXXXF5V7R6LxPtPlTFSwResKfUroVhZ1o+8+JVvEXuHJtJrAewY9ptU+yaPD+cmbaoGJl25kguaeasADHnXpudlObayovl7DCDcE88bzZObytWTYL6elIYNdSd4GrZmokROStqilEnJeVFIrjCvdtN5UIGpEFqzfLW2qozzHoU4+3fiHjP6+RGtGMJcVQ+8rFEJUiZgJ4Os3zNR9rt1+OHVZDj6KAw76XMo0SleW4owE5kCMDORm1e/prXTXgjar/WmC69tapl4Q3wW4LRnml7lG9FMgD+NyhnIFK+KtlXj7yrTfKeivJfqgmmGXBp2ZSnLwvOyfC14WRgN1MUTYOdRZTO+f/E/VgK6zleXK1Yt+Q3XJH9bCkLquuSsei1KzaUbgsawfA4Q8rIuh4Bl1wYk2ESLxSRfXMgEBq83JX9qM5lSLtAWw6Cm0sOQfdFOs8yJJ4rl6EGc5Exzu7y9XsUwAyYguFG6Xie05V4H2b/iJZ99XSETCHxVrNMeElMIAiot9JZ8LXsZwjzhubOUMKJJuO2jCrKm2+IsU9rDFMKA9hVEtG4lcdOklyP+ldiXfMfWdwW7etq0s/I02NQCARXVfQpIVPcYc0UbmPcyyPxNF6yf+UYKmUTAF9tf+XY+OmADwcl3KnaPPjTrLriU/ID7DCDg9SumWTf3CmynIZgBjyjWHMxTsa5HHGuO58lc1yQKtgbcVLDHJArePQgz0V6bKNzq1KlojwkGbHbpGWjXJgp3dtOwOO82WhiQelW0q/m8KeZ3GY8JCK74bf2eVVvyS9ZSRhHXFU8jDEIQsOH9Qa1xM5aGceQo2MyhEPAB8ZI6iewUUUv6zdmpotZt2CF5ReN1gJAzlr34Fe+NlqJazphA+Awg4OeKyW3CNN/QgfbmSyP1iQ6ZRLeyPvEFl7xCHZ90d7NGNbRZaeyetDk+asPoNJ8HzKyUlk2u28eXDjPEcIbEDZeCleKb+WjgIKYWy8BsKwch4IZyv/o/3wgqYRTG3V9xldxarkOc97bLY16IlEfAdYjz0p+FqR5kSVlLQsDEBpliiNK96vGxDHfnBBHEsN/ACvkxAWCzQ8W+JtBP0iT5Id/pIO+Pst5wqbfvuWatlsqY6iHWJ86K1EfA1MKMvkx76bvPn9BZrgfEvBVr8vW0GsizDZvPG+lchxjv6pZhgqUOpdXFvHfrRKWlyJP6p98lxrVTWvAkN4/F9R4Py6UARjFIkaKdHqV1GUuMptBby1JDnO5pvGnuhvneR6ZX8RP+7uzNdYjFh/vopeK7KWariUSh7ZmVTx+F2uFF4pV61HGgHe4b54N1JIcMDBoaLoQK7IaFaTybgrc94vCxntdysmhEUKfiKK6LB17LV30CHPXuuuoYcCgamFdHiT55HDnOW6mP71QaQw1L9ctJYkWUY+mQkFdi0Q2I7VbXA5ea1pBhEyT+hq35HLKtx0JXTHJKj7B0UYgZhCU+KY4WB0ui0OzbI439omCRRDL0UehTXjZKPOy2rL68oBAdMRmXzcFlcdyGVYW9nkVgdqKY/ThAXmyHKhEwrjiOMxdv4wYwmRt0IVZAirXQ4oEfqCZeO1qVqNMrjxoH7CP4/bY4aZLjk+OQybA0zJAQl0wb9DRoH6pOZvZyGrLf3E5G9nIckvge2oui9rJetx+ipPY/QxZFDH3k7brNuPWdRIjjAhZedOyDFm9Vv4xtm4c653a0sYv/UFcfmrIUirpqtIVRTFOWY52opKkWAxvqRbmJpiyG6HYBv3DZpjiRZjK2MIpxQqKUC/Koo0BJn2yOGpQ58U0xatDm51Ux/vtttWl0Cs0xQePps6WpFI1KvjrUFX1sJE9aFtjCGGbYdeqP8RFJjjYG278cCZS9KGov2n2WcZeH0len0hjqvN/GssYdKG4cOndon3pAmdpV+yE6ngUGR2LdAi7UylipXdYVThN9ULWK2VGrxypjtA+dt7FqwKrJGD/5+BriY1i2n4I+flVwsmErARy5P0sdZW1pn30fpfijzgSUaYDg+aLABNoNjrUIpL+gSLYY5AgVHuRQLNcAoFU14nCuZV/V0HHcmnoPpqtK+4M3K1k/dhH0f654+3niRnZrjbfqc+V8PRuFQzhC9dl90vNL+9YqRH4ul017MvW2PpeSbamVidg5NYme7nswNt+gk30P03029Kk+hOt/mbLeP/v+H9kPfzebMnSqD+PvaEOQ8BE0DMajDoO8yU84ii2NIjxBIhLH1AdhbpBnGt9AMQGbENqf4YWhTZQYgEq5Kr9BGBeKROFYjjoE8iedYiATZRDgZqyh3A0ZbG3PpfHegy5iPp37EPxHKQpBv8s+eQjlP16HoUyUIMBJREMD9soQwE6+xhgPipBhIKsf4zyVgggnqx9N2CuDACCrH4Xx6YMwOFEdxQtYhJDhZD0MzaMOgUIZ8RiMow1B7LQ5jPWgCBlaK1KMXy8I2pnrR5RdJwjZ2etRjN+gCBkGlqMY58lqFIBYaxuMdS8I2cW/P2m71dADRFrZYGg4w2B10AsbVF3ibuFZbuK3HB5eHOI7DniWRwzCqN9uaBnp321AM3xiCNbPVND2fXHI0Hc8G23vE0dgngPZFJxHDgGdU8xUZMggCp1xPHeHpR/N9R/yw1P9egjpO4WF5vnEcE9LORjU9TLsoaCkoyZtR8MeMzEPI0wXv3GMq0YnZ9NhHjk+FXwmTsV5Q6+c3qtwDOrhxXNLg8vTJWfNjiMHKWE2MSl4hJ0kIbjrSvRkYPDYE0iLn3aK5LmE3kxw2KslAzb/X9G46cBwgEhcAT4J0er45NPoivURV16sb+tbxOdPR8SgOErUq7WPHLMEYlCUq5goAUbJq6VeEax7AeC45nLJff22PUtEAIE+AF/yTckwv1gzkgYF4Nn+aMMk7y/qOmowvteITwC7ztNcJ3/0ql8dfmFlw1/X0ghzEJBxs1k1sb8odYDauN+awtSIGIEN1yQeiYWFh2kPwyyhJpOlX3IlPGtCPP9ADTF60evxuSr4QlQcnUISrsZolRDpNc49gHsy0yMOh4n0ZkeO9GbkSG/gY6oYiis+cEB55Bw1oDxSjhxQnnJOEVDeMU8TUM5OFFD2cI4WUB5ZxwwoZ0cNKO/cjxFQtryPEFC2/Y8WUPZhYrfZ/bosDrGXHTBWnR07Vm0CDhqrzo4Wq86OHqs2CUeMVe8wp4pV73iniVVnp4lVZ8eLVWcHjlVnh41V7+wOFavOjharzo4Xq84OGqvOThqrzv6DYtW7uqTHqs/h8xZg8Cl77lU70afY/uk5Yq+ZUJFILCxWm4u6qYoDVCnik1Yv3MY8pmb4vXls3eZFTodqJYRP09MtshOmW2QnSLfI0OkWTPOUT6E+ZM9d6ZHyOrLj5nVkiLyOg/S2g3a0GZkm2WkzTbLUTJPz5JSP7HnI4IjpLVl6ektohEi5aNiL/JxNPQ9TM+I9MYepuRVI+0T/AegnTkDKTpyAlJ0qASnDJyB5Z6W43IzAlDbt6xz05JrsNMk12SmTa7KTJtdkB0iuQX8NpB3d6d9OMgapOXks1mh3gCyWgyXYZAdPsLkupq/xmfXD+J00CyijZwGxskQHb7PnrHR/Z9PcDcPHxLPnrIIi33ldaSYIiT3Z850Eyk8i5jxlx815yubkPBEoC2CldZCsqikCaq+FZF0ZVt7wvK4KEmWqBTgrpm6aO9V2xoqQ8pQ9t4UIAj4LY28OZVus29Gbq49May4p99kWgoSndgVu74cj7EfV0XPcsuQct7WoUq5trwK8q/qR4FnVj1BOTa1Zeb1YKK7fi6rRnNIRXPFpst2y/6hsN0xtTpPtFqzJSbPdYrU4SbZbuBKny3aL1OFU2W7BaqRlu214xRAZIn0xVK7b9YZX5xtBXLMPAK84sidhCHxr6vDy3csMrqx//AnRkM+WvJp+BhZs0q+jANW4b3alnawM71rQYUz1sRXhoMS8tBzWTkt5HiVXohT25MrffvuSqIZ7L4qi5I9Mtl9I7/4Wf0AMhCOHdnn2hfE/OORlIX5z6NOoS2I5ctx1wY+d91piT9q+pLsYQUP8yxEXlguZN0JfSM7uMWsrA2ZLodWmVfBnrTczOK18yoot+319CQEOdazJoQ8tEcO3ZaslOFCLNa8bxHBseA4aygtG83Y/hZXPCv5M+bZD/G+bnexrwb+q4O6d/9Wz01oLDvM7/qEdmBA0YAjsyPgV2aGrkDlVAO+E0s8aLcp42yv9tS2IHCH1LVf6FVdaVF20Af9i3JOCLtD7cemILrbnpWCIRdieHDQB+o6rmYmEYOs6vz8vyznAgEUEOilOBU7k0Ckxpz0oLFcNoJrqAM0ZNImCZ1ym14DyJsZ0fXSv79PdhF5dsib+S7OdrS0Bg5CV+LPpfqb1jTu7BwgeHYR5Vy+X3J3YB99WHcMSgZM3rhRb7qav13d/YAmOEKK8q5fv+AMv4bnbruZdUVRQavjYPMLWLB6zbu9+Hfv6eOc6lIwZ/hb7+Y/O7Lf4b310ipvi/uop59297e9zfMDuAAE1MEG4F3esYkj7vjDgVtY5K5FmXVnQa/m6lmum0X5DecCzqcTT1fU7pONQGvB75Hd4u74wFD5TqkZ8n7oz68pSFwY5W/Py0jq8A0LG8tBqh20QY9Zgt4FGpnzF8/vPsrx6EkqjPS0RGAMs+EVZ5/dY4115yLNLn5z2UNjWkADOhVDdwYrQWwBk+MUQrc673Ox+1kloJFcIxjbTL8mrBVnd/WOK/5ShEXsJ5PxnY77iYMu2bMyrS4fHPu6GIuZ7ffcHz9H9yJRAzu0vvRXY98dQOhojftVsStG+rbC1ncoIhE9iuUJsNngxnRZkVcVHWbeN+KnGfAF+oFgq2F+o1Tkmy2Ln3JcHPSUmFjL4STDWsSgZ2qqcDtSOk+aIdclopjmYi9DNDNrf1MJajgJ4+f2mrO9Y+c6dq4DurhBJmcyx0RDPhHvKIL2Px/Kw57CEuJY3mqEHFUcHMETBkQHFznpXHHJUoSUl7KygZeWEMPxWF9p6KA943vM7dkeY2Y3lAc+SoV8MbdFYFsfbZVVLTqjjRBXzf8cXOo1hKyFOs5u6YQcqQwH4bpjUArcP07mO5UFPlTPKZH8vgFwFuhu3RSNO5NtliyLu+9/4I7jvRRH3LvqedAETJcQZjjyTVkS2CAzlsOKXm+sPSN9dcdBxXT+0R7H41ZPmlcI/0R5llPOOs0JUy5uSqRV65uiTRkkpCKz3rWSiTLyMiRZkVWzNf+XohcZeALoqrvtU+nEigwd4tGhWN59JQ/VSKArAKqHFN/6J57VE5Of0m/+WCI4xpM0ZXSGSQpkzOjoM47bNS2qT1bE3xKOEOQlthWwlevtgWmZTCv22ulw11T26TUwNGC7XJSc1hqEAM0hvhke46LcBsO5THSYXLvl3vnok9fe9zBqINZoi1hGnduJIcGuLRxwpuxNjeTDa10aikIZ9YTh2SJ4BWxrIe7Phsp0P3VTsnjKlcoUA5ZtAJON0tt+Ek3fz1+9//f5/gBxmRpfUAAA=" \ No newline at end of file +window.navigationData = "data:application/octet-stream;base64,H4sIAAAAAAAAA82dXXPcNpaG/4v2NvZMHCa746uVZNlxYlsuS/akairlgkh0NyI22QFASe2p/PctfjQbIICDc8Du3rmzVXjfBwQJ4uMcsP/17zPNn/TZy7P/VWzzLC/rpnimivu/5XVV8VyLB6G3Z9+dbZhenb08W9dFU3L1N8U2X7uyX1Vx/9Us+3yl1+XZd2f3oirOXr747ixfibKQvDp7+a+RdV6Wr7jSomJa1JXa+4tKc7lgOYyYyCfIH3/667uRdMGUyD/K+ml7WVcLsWxkp6ESAzYQ+ZLlK35VabmlwvbKmL+oltebpCa01SCnFLzSl5IXvNKCleoTV5u6UpyMDBlBdOM+U3mGFEk4z3OuVC0T2zTshOU3enVb3/M5lzp6IJmXXGqxEDnT5Bvqd8Fy53THkA+S/ZrrfDX/Jps2WHItb7h8EDm/EFWR3n0Rlsga/aJmNX8rR5LUxfZ2u5nzlA0OEO9nrTfny/Y90z0XVNhEHiOpmSiFZP3yqD+ybVmzgkrZKyH/+QMkbWx0S//MWcEluR8EjSD60F2orEEGOX/hUiy2vzzqxG491UMsexLkAPV2Q5lE+YF//8d/f//jCxPa6FU7euedyO7OcaIjjuHM93w7KXq7a0UCNehBgNNbl960pkL6RygSVQLDEwTvuhTxzvrkBOQnrqXgD6ycdcVTF0IFbnjZOtbVjZZM8+U2rQaODaEK/xR69YGtE1t9pyYC60ZP5ptU6M4hBm5HO+9cPgqcKImg5K4E+sQq8VbVJUt8nhxtDPaRyXY5FZ3fRsmwkbca353lJVPq7OVZwTeSt/P/4swe6HWd1yWlFoMkdtmf+FIozeWs13TYJIa359y3klVqUcv166bKiQ94xCmxIvS2gI2Q1TCW93S0IY7hflMNY7OYAYcZo4bgBv+BScHuIntlsJldlR/MWrDykW3VR1k/iILLPXUxPDQg1RbblJ8yh3LT3KlcirtEzl4OkZTiUgcHCRzO5wEw7xpRFsNy4XUt08FhI4Be8Lwu+C+PmggbdaB3eHeAjAtbTWsQGwyWXHvXy6iK2OJ56HO1rfJZ/M4BuANtaXuT+rWs11Z3n6xB0ZXA2MI1czZiJ3NAbFX8PjA7vZfZYjTlUO0etSTVaFafjNnBNfmsuEy84aMUIAg17y3u6AHWH4/6gjOZdj22GKBsmFQ8/YKm8hipW0BfVQ8pmJ0WYEh3xkskeRxAXrcqTxjpDCXgr1gltPg24wZ5HCBe39VSnjhTChLM7t3tWZFBjgPEGydor4VU1Ls0UQMcXRuVajcrPsuSCPNZAMRG8WHdnv50eD0c5u8GdRJIX/KKS6ZrY/bsj6KPBVEh9De70vit5j1gKob2mQcV4hnc++80Se30LK/Xa/M+RZrra18e1WqXXdE5bbej+Z3chgSueKV1+992EhW72Lbo174o7jqVXLwXRVHyRyY5/jJNjtcDGetrx/BP/M+GK3x0zGRDVrGg3L7Ol3XV/Z3G9nrEoFYNLxgqO2IKdTyQ0LTb6xrEcejEDxcUT/W4lmIp3D08FMPS4h8QeLso/FBgNqGB7keDITfggC6H4UFdLM5qQwH9PZhB3ZvE+O+5XtUFHtWXR2ykszXXXF5V7R6LxPtPlTFSwResKfUroVhZ1o+8+JVvEXuHJtJrAewY9ptU+yaPD+cmbaoGJl25kguaeasADHnXpudlObayovl7DCDcE88bzZObytWTYL6elIYNdSd4GrZmokROStqilEnJeVFIrjCvdtN5UIGpEFqzfLW2qozzHoU4+3fiHjP6+RGtGMJcVQ+8rFEJUiZgJ4Os3zNR9rt1+OHVZDj6KAw76XMo0SleW4owE5kCMDORm1e/prXTXgjar/WmC69tapl4Q3wW4LRnml7lG9FMgD+NyhnIFK+KtlXj7yrTfKeivJfqgmmGXBp2ZSnLwvOyfC14WRgN1MUTYOdRZTO+f/E/VgK6zleXK1Yt+Q3XJH9bCkLquuSsei1KzaUbgsawfA4Q8rIuh4Bl1wYk2ESLxSRfXMgEBq83JX9qM5lSLtAWw6Cm0sOQfdFOs8yJJ4rl6EGc5Exzu7y9XsUwAyYguFG6Xie05V4H2b/iJZ99XSETCHxVrNMeElMIAiot9JZ8LXsZwjzhubOUMKJJuO2jCrKm2+IsU9rDFMKA9hVEtG4lcdOklyP+ldiXfMfWdwW7etq0s/I02NQCARXVfQpIVPcYc0UbmPcyyPxNF6yf+UYKmUTAF9tf+XY+OmADwcl3KnaPPjTrLriU/ID7DCDg9SumWTf3CmynIZgBjyjWHMxTsa5HHGuO58lc1yQKtgbcVLDHJArePQgz0V6bKNzq1KlojwkGbHbpGWjXJgp3dtOwOO82WhiQelW0q/m8KeZ3GY8JCK74bf2eVVvyS9ZSRhHXFU8jDEIQsOH9Qa1xM5aGceQo2MyhEPAB8ZI6iewUUUv6zdmpotZt2CF5ReN1gJAzlr34Fe+NlqJazphA+Awg4OeKyW3CNN/QgfbmSyP1iQ6ZRLeyPvEFl7xCHZ90d7NGNbRZaeyetDk+asPoNJ8HzKyUlk2u28eXDjPEcIbEDZeCleKb+WjgIKYWy8BsKwch4IZyv/o/3wgqYRTG3V9xldxarkOc97bLY16IlEfAdYjz0p+FqR5kSVlLQsDEBpliiNK96vGxDHfnBBHEsN/ACvkxAWCzQ8W+JtBP0iT5Id/pIO+Pst5wqbfvuWatlsqY6iHWJ86K1EfA1MKMvkx76bvPn9BZrgfEvBVr8vW0GsizDZvPG+lchxjv6pZhgqUOpdXFvHfrRKWlyJP6p98lxrVTWvAkN4/F9R4Py6UARjFIkaKdHqV1GUuMptBby1JDnO5pvGnuhvneR6ZX8RP+7uzNdYjFh/vopeK7KWariUSh7ZmVTx+F2uFF4pV61HGgHe4b54N1JIcMDBoaLoQK7IaFaTybgrc94vCxntdysmhEUKfiKK6LB17LV30CHPXuuuoYcCgamFdHiT55HDnOW6mP71QaQw1L9ctJYkWUY+mQkFdi0Q2I7VbXA5ea1pBhEyT+hq35HLKtx0JXTHJKj7B0UYgZhCU+KY4WB0ui0OzbI439omCRRDL0UehTXjZKPOy2rL68oBAdMRmXzcFlcdyGVYW9nkVgdqKY/ThAXmyHKhEwrjiOMxdv4wYwmRt0IVZAirXQ4oEfqCZeO1qVqNMrjxoH7CP4/bY4aZLjk+OQybA0zJAQl0wb9DRoH6pOZvZyGrLf3E5G9nIckvge2oui9rJetx+ipPY/QxZFDH3k7brNuPWdRIjjAhZedOyDFm9Vv4xtm4c653a0sYv/UFcfmrIUirpqtIVRTFOWY52opKkWAxvqRbmJpiyG6HYBv3DZpjiRZjK2MIpxQqKUC/Koo0BJn2yOGpQ58U0xatDm51Ux/vtttWl0Cs0xQePps6WpFI1KvjrUFX1sJE9aFtjCGGbYdeqP8RFJjjYG278cCZS9KGov2n2WcZeH0len0hjqvN/GssYdKG4cOndon3pAmdpV+yE6ngUGR2LdAi7UylipXdYVThN9ULWK2VGrxypjtA+dt7FqwKrJGD/5+BriY1i2n4I+flVwsmErARy5P0sdZW1pn30fpfijzgSUaYDg+aLABNoNjrUIpL+gSLYY5AgVHuRQLNcAoFU14nCuZV/V0HHcmnoPpqtK+4M3K1k/dhH0f654+3niRnZrjbfqc+V8PRuFQzhC9dl90vNL+9YqRH4ul017MvW2PpeSbamVidg5NYme7nswNt+gk30P03029Kk+hOt/mbLeP/v+H9kPfzebMnSqD+PvaEOQ8BE0DMajDoO8yU84ii2NIjxBIhLH1AdhbpBnGt9AMQGbENqf4YWhTZQYgEq5Kr9BGBeKROFYjjoE8iedYiATZRDgZqyh3A0ZbG3PpfHegy5iPp37EPxHKQpBv8s+eQjlP16HoUyUIMBJREMD9soQwE6+xhgPipBhIKsf4zyVgggnqx9N2CuDACCrH4Xx6YMwOFEdxQtYhJDhZD0MzaMOgUIZ8RiMow1B7LQ5jPWgCBlaK1KMXy8I2pnrR5RdJwjZ2etRjN+gCBkGlqMY58lqFIBYaxuMdS8I2cW/P2m71dADRFrZYGg4w2B10AsbVF3ibuFZbuK3HB5eHOI7DniWRwzCqN9uaBnp321AM3xiCNbPVND2fXHI0Hc8G23vE0dgngPZFJxHDgGdU8xUZMggCp1xPHeHpR/N9R/yw1P9egjpO4WF5vnEcE9LORjU9TLsoaCkoyZtR8MeMzEPI0wXv3GMq0YnZ9NhHjk+FXwmTsV5Q6+c3qtwDOrhxXNLg8vTJWfNjiMHKWE2MSl4hJ0kIbjrSvRkYPDYE0iLn3aK5LmE3kxw2KslAzb/X9G46cBwgEhcAT4J0er45NPoivURV16sb+tbxOdPR8SgOErUq7WPHLMEYlCUq5goAUbJq6VeEax7AeC45nLJff22PUtEAIE+AF/yTckwv1gzkgYF4Nn+aMMk7y/qOmowvteITwC7ztNcJ3/0ql8dfmFlw1/X0ghzEJBxs1k1sb8odYDauN+awtSIGIEN1yQeiYWFh2kPwyyhJpOlX3IlPGtCPP9ADTF60evxuSr4QlQcnUISrsZolRDpNc49gHsy0yMOh4n0ZkeO9GbkSG/gY6oYiis+cEB55Bw1oDxSjhxQnnJOEVDeMU8TUM5OFFD2cI4WUB5ZxwwoZ0cNKO/cjxFQtryPEFC2/Y8WUPZhYrfZ/bosDrGXHTBWnR07Vm0CDhqrzo4Wq86OHqs2CUeMVe8wp4pV73iniVVnp4lVZ8eLVWcHjlVnh41V7+wOFavOjharzo4Xq84OGqvOThqrzv6DYtW7uqTHqs/h8xZg8Cl77lU70afY/uk5Yq+ZUJFILCxWm4u6qYoDVCnik1Yv3MY8pmb4vXls3eZFTodqJYRP09MtshOmW2QnSLfI0OkWTPOUT6E+ZM9d6ZHyOrLj5nVkiLyOg/S2g3a0GZkm2WkzTbLUTJPz5JSP7HnI4IjpLVl6ektohEi5aNiL/JxNPQ9TM+I9MYepuRVI+0T/AegnTkDKTpyAlJ0qASnDJyB5Z6W43IzAlDbt6xz05JrsNMk12SmTa7KTJtdkB0iuQX8NpB3d6d9OMgapOXks1mh3gCyWgyXYZAdPsLkupq/xmfXD+J00CyijZwGxskQHb7PnrHR/Z9PcDcPHxLPnrIIi33ldaSYIiT3Z850Eyk8i5jxlx815yubkPBEoC2CldZCsqikCaq+FZF0ZVt7wvK4KEmWqBTgrpm6aO9V2xoqQ8pQ9t4UIAj4LY28OZVus29Gbq49May4p99kWgoSndgVu74cj7EfV0XPcsuQct7WoUq5trwK8q/qR4FnVj1BOTa1Zeb1YKK7fi6rRnNIRXPFpst2y/6hsN0xtTpPtFqzJSbPdYrU4SbZbuBKny3aL1OFU2W7BaqRlu214xRAZIn0xVK7b9YZX5xtBXLMPAK84sidhCHxr6vDy3csMrqx//AnRkM+WvJp+BhZs0q+jANW4b3alnawM71rQYUz1sRXhoMS8tBzWTkt5HiVXohT25MrffvuSqIZ7L4qi5I9Mtl9I7/4Wf0AMhCOHdnn2hfE/OORlIX5z6NOoS2I5ctx1wY+d91piT9q+pLsYQUP8yxEXlguZN0JfSM7uMWsrA2ZLodWmVfBnrTczOK18yoot+319CQEOdazJoQ8tEcO3ZaslOFCLNa8bxHBseA4aygtG83Y/hZXPCv5M+bZD/G+bnexrwb+q4O6d/9Wz01oLDvM7/qEdmBA0YAjsyPgV2aGrkDlVAO+E0s8aLcp42yv9tS2IHCH1LVf6FVdaVF20Af9i3JOCLtD7cemILrbnpWCIRdieHDQB+o6rmYmEYOs6vz8vyznAgEUEOilOBU7k0Ckxpz0oLFcNoJrqAM0ZNImCZ1ym14DyJsZ0fXSv79PdhF5dsib+S7OdrS0Bg5CV+LPpfqb1jTu7BwgeHYR5Vy+X3J3YB99WHcMSgZM3rhRb7qav13d/YAmOEKK8q5fv+AMv4bnbruZdUVRQavjYPMLWLB6zbu9+Hfv6eOc6lIwZ/hb7+Y/O7Lf4b310ipvi/uop59297e9zfMDuAAE1MEG4F3esYkj7vjDgVtY5K5FmXVnQa/m6lmum0X5DecCzqcTT1fU7pONQGvB75Hd4u74wFD5TqkZ8n7oz68pCixC25uWldU4H9BvLg54bxPA02G2gQShf8fz+syyvnoTSaE9LBIb7Cn5R1vk91nhXHvLsMiWnnRG2NSSAcyFUd4Yi1OFBhl8M0eq8S8PuJ5iERnKFYBgz/ZK8WpDV3T+m+E8ZGrGXQM5/NubbDLZsy8a8usx37ONuKGK+13d/8Bzdj0wJ5Nz+qFuBfX8MpaPh4FfNphTtjgW2tlMZgfBJLFeIfQUvptOCrKr4KOu2ET/VmI+9DxRLBfsLtTrHJFTsnPvyoKfEhD0GPwmGNRYlQ1uV0zHZcdIcsQQZzTQH0w66SUD781lYy1EAr7TflPUdK9+50xLQ3RUiKZPpNBrimVtPGaT38Vge9hxWC9fyRjP0oOLoAIYoODJ22FnvikOOKrR6hJ0VtIKcEIaf5UJbD+UBz3t+x+4IM7uxPOBZMvSLoS0aS9h4u6xqyQl1nKhi/u/4QqcxbCXEaXZTN+xAZSgA3w2TWuC2XDrXsTzoqXJGmezvBZCrQHfjtmjEiXy7bFHEff9zfgT3vSji3gXaky5gooQ4w+lm0orIFoFRG1b8cnP9Aem7Kw46ruuH9tQVv3rSvFL4J9qjjHLecVaIanlTMrVCzxx90igpBYH1vpVMlImXMdGCrIqt+a8cvdDYC0BXxXWfNT9OZPAAjxbN6uYzaaheCm34s0po8Y1/4nktEak4/T6/JYLDCWlzRleIpFDmjI4Ow7htU5DavHTsDfEoYU5CWyFbid4+mJbZlEK/rS5XTXWPbhNTA0bGdclJjWEowGTRm+ERLvptAKz7VIdJe0v+Sa8eSf0pL7MGYo2miHXEqZ04Etza4hFHyu7EWB4M7LVBJ6RhXxgOE5JnwJYG8t5suGznQzcVu6dMqVwhQPkmEHk3ne034aTY/PX7X7//H3jsjqSC1AAA" \ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.AllFields.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.AllFields.html index 06210a25d7..f030f53bd7 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.AllFields.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.AllFields.html @@ -1,8 +1,8 @@ -AllFields | SAP Cloud SDK for JavaScript - v3.12.1

Represents the selection of all fields. +AllFields | SAP Cloud SDK for JavaScript - v3.12.0

Represents the selection of all fields. This field should be used in the schema of entities.

-

Type Parameters

Constructors

Properties

Type Parameters

Constructors

Properties

_entityConstructor +_fieldName +selectable

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-

Constructors

Properties

_entityConstructor: Constructable<EntityT>
_fieldName: string
selectable: true
\ No newline at end of file +

Constructors

Properties

_entityConstructor: Constructable<EntityT>
_fieldName: string
selectable: true
\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.BatchChangeSet.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.BatchChangeSet.html index 73753c2a81..d20cc3ae76 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.BatchChangeSet.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.BatchChangeSet.html @@ -1,9 +1,9 @@ -BatchChangeSet | SAP Cloud SDK for JavaScript - v3.12.1

Representation of a batch change set, which holds a collection of write operations.

-

Type Parameters

Constructors

Properties

Constructors

Properties

boundary: string
\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.BooleanFilterFunction.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.BooleanFilterFunction.html index 9aed6a0a7a..1440a6b8c8 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.BooleanFilterFunction.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.BooleanFilterFunction.html @@ -1,18 +1,18 @@ -BooleanFilterFunction | SAP Cloud SDK for JavaScript - v3.12.1

Representation of a filter function, that returns a value of type boolean.

-

Type Parameters

Hierarchy (view full)

Constructors

Properties

Methods

Constructors

Properties

functionName: string

Methods

\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.CollectionField.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.CollectionField.html index 15228ed894..aaebd2fe14 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.CollectionField.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.CollectionField.html @@ -1,23 +1,23 @@ -CollectionField | SAP Cloud SDK for JavaScript - v3.12.1

Class CollectionField<EntityT, DeSerializersT, CollectionFieldT, NullableT, SelectableT>

Represents a field of an entity or a complex type, that can have a collection as value.

-

Type Parameters

  • EntityT extends EntityBase

    Type of the entity the field belongs to.

    -
  • DeSerializersT extends DeSerializers

    Type of the (de-)serializers.

    -
  • CollectionFieldT extends EdmTypeShared<"any"> | Record<string, any> = any

    Type of of elements of the collection. This can either be an EDM type or complex type.

    -
  • NullableT extends boolean = false

    Boolean type that represents whether the field is nullable.

    -
  • SelectableT extends boolean = false

    Boolean type that represents whether the field is selectable.

    -

Hierarchy (view full)

Constructors

Properties

_deSerializers: DeSerializersT
_entityConstructor: Constructable<EntityT>
_fieldName: string
_fieldOptions: Required<FieldOptions<NullableT, SelectableT>>

Methods

\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.CollectionFilterFunction.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.CollectionFilterFunction.html index ea886f34da..8b32f34422 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.CollectionFilterFunction.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.CollectionFilterFunction.html @@ -1,19 +1,19 @@ -CollectionFilterFunction | SAP Cloud SDK for JavaScript - v3.12.1

Representation of a filter function, that returns a collection of values.

-

Type Parameters

Hierarchy (view full)

Constructors

Properties

Methods

Constructors

Properties

functionName: string

Methods

\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.ComplexTypeField.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.ComplexTypeField.html index c450a6d03b..c2663eb0fc 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.ComplexTypeField.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.ComplexTypeField.html @@ -1,4 +1,4 @@ -ComplexTypeField | SAP Cloud SDK for JavaScript - v3.12.1

Class ComplexTypeField<EntityT, DeSerializersT, ComplexT, NullableT, SelectableT>Abstract

Represents a complex type property of an entity or a complex type.

+ComplexTypeField | SAP Cloud SDK for JavaScript - v3.12.0

Class ComplexTypeField<EntityT, DeSerializersT, ComplexT, NullableT, SelectableT>Abstract

Represents a complex type property of an entity or a complex type.

ComplexTypeFields are used as static properties of entities and are generated from the metadata, i.e. for each property of an OData entity, that has a complex type, there exists one static instance of ComplexTypeField (or rather one of its subclasses) in the corresponding generated class file. ComplexTypeFields are used to represent the domain of complex or custom structures that can be used in select, filter and order by functions. @@ -6,29 +6,29 @@ can be supplied as argument to the select function, e.g. TimeSheetEntry.TIME_SHEET_DATA_FIELDS. Moreover, classes implementing this abstract class will provide property fields, that can be used for filtering and ordering.

See also: Selectable.

-

Type Parameters

  • EntityT extends EntityBase

    Type of the entity the field belongs to.

    -
  • DeSerializersT extends DeSerializers

    Type of the (de-)serializers.

    -
  • ComplexT = any

    Type of complex type represented by this field.

    -
  • NullableT extends boolean = false

    Boolean type that represents whether the field is nullable.

    -
  • SelectableT extends boolean = false

    Boolean type that represents whether the field is selectable.

    -

Hierarchy (view full)

Constructors

Properties

_entityConstructor: Constructable<EntityT>
_fieldName: string
_fieldOptions: Required<FieldOptions<NullableT, SelectableT>>
complexTypeName?: string

Note that this property is crucial, although not really used. +

Type Parameters

  • EntityT extends EntityBase

    Type of the entity the field belongs to.

    +
  • DeSerializersT extends DeSerializers

    Type of the (de-)serializers.

    +
  • ComplexT = any

    Type of complex type represented by this field.

    +
  • NullableT extends boolean = false

    Boolean type that represents whether the field is nullable.

    +
  • SelectableT extends boolean = false

    Boolean type that represents whether the field is selectable.

    +

Hierarchy (view full)

Constructors

Properties

_entityConstructor: Constructable<EntityT>
_fieldName: string
_fieldOptions: Required<FieldOptions<NullableT, SelectableT>>
complexTypeName?: string

Note that this property is crucial, although not really used. If it is removed this class becomes structural equivalent to e.g. ComplexTypeStringPropertyField which leads to unexpected behavior on the selectable list of objects.

-
deSerializers: DeSerializersT

Methods

  • Gets the path to the complex type property represented by this.

    +
deSerializers: DeSerializersT

Methods

  • Gets the path to the complex type property represented by this.

    Returns string

    The path to the complex type property.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.CountRequestBuilder.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.CountRequestBuilder.html index b52c4bd982..efcb460942 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.CountRequestBuilder.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.CountRequestBuilder.html @@ -1,58 +1,58 @@ -CountRequestBuilder | SAP Cloud SDK for JavaScript - v3.12.1

Class CountRequestBuilder<EntityT, DeSerializersT>

Create an OData request to count entities based on the configuration of the request. +CountRequestBuilder | SAP Cloud SDK for JavaScript - v3.12.0

Class CountRequestBuilder<EntityT, DeSerializersT>

Create an OData request to count entities based on the configuration of the request. A CountRequestBuilder allows only for execution of the request. If you want to apply query parameters like filter, skip or top do it on the GetAllRequestBuilder the count is created from.

-

Type Parameters

Hierarchy (view full)

Constructors

Properties

Methods

  • Add custom headers to the request. Existing headers will be overwritten.

    -

    Parameters

    • headers: Record<string, string>

      Key-value pairs denoting additional custom headers.

      +

Type Parameters

Hierarchy (view full)

Constructors

Properties

Methods

  • Add custom headers to the request. Existing headers will be overwritten.

    +

    Parameters

    • headers: Record<string, string>

      Key-value pairs denoting additional custom headers.

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.

    -

    Parameters

    • queryParameters: Record<string, string>

      Key-value pairs denoting additional custom query parameters to be set in the request.

      +
  • Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.

    +

    Parameters

    • queryParameters: Record<string, string>

      Key-value pairs denoting additional custom query parameters to be set in the request.

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. +

  • Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. If the custom request configuration contains disallowed keys, those will be ignored.

    -

    Parameters

    • requestConfiguration: Record<string, any>

      Key-value pairs denoting additional custom request configuration options to be set in the request.

      +

      Parameters

      • requestConfiguration: Record<string, string>

        Key-value pairs denoting additional custom request configuration options to be set in the request.

      Returns this

      The request builder itself, to facilitate method chaining.

      -
  • Append the given path to the URL. +

  • Append the given path to the URL. This can be used for querying navigation properties of an entity. To execute a request with an appended path use executeRaw to avoid errors during deserialization. When using this, the execute method is omitted from the return type.

    -

    Parameters

    • Rest ...path: string[]

      Path to be appended.

      +

      Parameters

      • Rest ...path: string[]

        Path to be appended.

      Returns Omit<CountRequestBuilder<EntityT, DeSerializersT>, "execute">

      The request builder itself without "execute" function, to facilitate method chaining.

      -
  • Execute request.

    -

    Parameters

    • destination: HttpDestinationOrFetchOptions

      Destination or DestinationFetchOptions to execute the request against.

      +
  • Execute request.

    +

    Parameters

    Returns Promise<number>

    A promise resolving to the number of entities.

    -
  • Set middleware for requests towards the target system given in the destination.

    -

    Parameters

    • middlewares: HttpMiddleware | HttpMiddleware[]

      Middlewares to be applied to the executeHttpRequest().

      +
  • Set middleware for requests towards the target system given in the destination.

    +

    Parameters

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Parameters

    Returns this

  • Create the relative URL based on configuration of the given builder.

    +
  • Parameters

    Returns this

  • Create the relative URL based on configuration of the given builder.

    Returns string

    The relative URL for the request.

    -
  • Replace the default service path with the given custom path. +

  • Replace the default service path with the given custom path. In case of the SAP S/4HANA APIs the basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.

    -

    Parameters

    • basePath: string

      Path to override the default with.

      +

      Parameters

      • basePath: string

        Path to override the default with.

      Returns this

      The request builder itself, to facilitate method chaining.

      -
  • Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.

    +
  • Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Create the URL based on configuration of the given builder.

    -

    Parameters

    • destination: HttpDestinationOrFetchOptions

      Destination or DestinationFetchOptions to execute the request against.

      +
  • Create the URL based on configuration of the given builder.

    +

    Parameters

    Returns Promise<string>

    Promise resolving to the URL for the request.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.CreateRequestBuilderBase.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.CreateRequestBuilderBase.html index aa731375b5..bb36333b73 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.CreateRequestBuilderBase.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.CreateRequestBuilderBase.html @@ -1,81 +1,81 @@ -CreateRequestBuilderBase | SAP Cloud SDK for JavaScript - v3.12.1

Class CreateRequestBuilderBase<EntityT, DeSerializersT>Abstract

Abstract create request class holding the parts shared in OData v2 and v4.

-

Type Parameters

Hierarchy (view full)

Implements

Constructors

Properties

_deSerializers: DeSerializersT

Dummy property to also include the deserializer type in the structure of the entity type.

-
_entity: EntityT

Dummy property whose type makes structurally identical entities distinguishable in TypeScript.

-
deserializer: EntityDeserializer
responseDataAccessor: ResponseDataAccessor
serializer: EntitySerializer

Accessors

  • get entity(): EntityT
  • Returns EntityT

Methods

  • Add custom headers to the request. Existing headers will be overwritten.

    -

    Parameters

    • headers: Record<string, string>

      Key-value pairs denoting additional custom headers.

      +CreateRequestBuilderBase | SAP Cloud SDK for JavaScript - v3.12.0

      Class CreateRequestBuilderBase<EntityT, DeSerializersT>Abstract

      Abstract create request class holding the parts shared in OData v2 and v4.

      +

      Type Parameters

      Hierarchy (view full)

      Implements

      Constructors

      Properties

      _deSerializers: DeSerializersT

      Dummy property to also include the deserializer type in the structure of the entity type.

      +
      _entity: EntityT

      Dummy property whose type makes structurally identical entities distinguishable in TypeScript.

      +
      deserializer: EntityDeserializer
      responseDataAccessor: ResponseDataAccessor
      serializer: EntitySerializer

      Accessors

      • get entity(): EntityT
      • Returns EntityT

      Methods

      • Add custom headers to the request. Existing headers will be overwritten.

        +

        Parameters

        • headers: Record<string, string>

          Key-value pairs denoting additional custom headers.

        Returns this

        The request builder itself, to facilitate method chaining.

        -
      • Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.

        -

        Parameters

        • queryParameters: Record<string, string>

          Key-value pairs denoting additional custom query parameters to be set in the request.

          +
      • Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.

        +

        Parameters

        • queryParameters: Record<string, string>

          Key-value pairs denoting additional custom query parameters to be set in the request.

        Returns this

        The request builder itself, to facilitate method chaining.

        -
      • Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. +

      • Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. If the custom request configuration contains disallowed keys, those will be ignored.

        -

        Parameters

        • requestConfiguration: Record<string, any>

          Key-value pairs denoting additional custom request configuration options to be set in the request.

          +

          Parameters

          • requestConfiguration: Record<string, string>

            Key-value pairs denoting additional custom request configuration options to be set in the request.

          Returns this

          The request builder itself, to facilitate method chaining.

          -
      • Append the given path to the URL. +

      • Append the given path to the URL. This can be used for querying navigation properties of an entity. To execute a request with an appended path use executeRaw to avoid errors during deserialization. When using this, the execute method is omitted from the return type.

        -

        Parameters

        • Rest ...path: string[]

          Path to be appended.

          +

          Parameters

          • Rest ...path: string[]

            Path to be appended.

          Returns Omit<CreateRequestBuilderBase<EntityT, DeSerializersT>, "execute">

          The request builder itself without "execute" function, to facilitate method chaining.

          -
      • Specifies the parent of the entity to create.

        -

        Type Parameters

        Parameters

        • parentEntity: ParentEntityT

          Parent of the entity to create.

          -
        • linkField: Link<ParentEntityT, DeSerializersT, EntityApi<EntityT, any>>

          Static representation of the navigation property that navigates from the parent entity to the child entity.

          +
      • Specifies the parent of the entity to create.

        +

        Type Parameters

        Parameters

        Returns this

        The entity itself, to facilitate method chaining.

        -
      • Execute query.

        -

        Parameters

        • destination: HttpDestinationOrFetchOptions

          Destination or DestinationFetchOptions to execute the request against.

          +
      • Execute query.

        +

        Parameters

        Returns Promise<EntityT>

        A promise resolving to the created entity.

        -
      • Gets identifier for the batch request.

        +
      • Set middleware for requests towards the target system given in the destination.

        -

        Parameters

      • Set middleware for requests towards the target system given in the destination.

        +

        Parameters

        Returns this

        The request builder itself, to facilitate method chaining.

        -
      • Parameters

        Returns this

      • Create the relative URL based on configuration of the given builder.

        +
      • Parameters

        Returns this

      • Create the relative URL based on configuration of the given builder.

        Returns string

        The relative URL for the request.

        -
      • Replace the default service path with the given custom path. +

      • Replace the default service path with the given custom path. In case of the SAP S/4HANA APIs the basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.

        -

        Parameters

        • basePath: string

          Path to override the default with.

          +

          Parameters

          • basePath: string

            Path to override the default with.

          Returns this

          The request builder itself, to facilitate method chaining.

          -
      • Sets user-defined identifier for the batch reference.

        -

        Parameters

        • id: string

          User-defined batch request identifier.

          -

        Returns void

      • Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.

        +
      • Sets user-defined identifier for the batch reference.

        +

        Parameters

        • id: string

          User-defined batch request identifier.

          +

        Returns void

      • Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.

        Returns this

        The request builder itself, to facilitate method chaining.

        -
      • Create the URL based on configuration of the given builder.

        -

        Parameters

        • destination: HttpDestinationOrFetchOptions

          Destination or DestinationFetchOptions to execute the request against.

          +
      • Create the URL based on configuration of the given builder.

        +

        Parameters

        Returns Promise<string>

        Promise resolving to the URL for the request.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.CustomField.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.CustomField.html index 62bf20a626..48f73422b3 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.CustomField.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.CustomField.html @@ -1,25 +1,25 @@ -CustomField | SAP Cloud SDK for JavaScript - v3.12.1

Class CustomField<EntityT, DeSerializersT, NullableT>

If your entity contains fields not present in your service specification you can model them using custom fields. +CustomField | SAP Cloud SDK for JavaScript - v3.12.0

Class CustomField<EntityT, DeSerializersT, NullableT>

If your entity contains fields not present in your service specification you can model them using custom fields. Alternatively you can also generate a client based on a service specification containing all fields.

-

Type Parameters

Hierarchy (view full)

Constructors

Properties

_entityConstructor: Constructable<EntityT>
_fieldName: string
_fieldOptions: Required<FieldOptions<NullableT, false>>

Methods

  • Path to the field to be used in filter and order by queries.

    +

Type Parameters

Hierarchy (view full)

Constructors

Properties

_entityConstructor: Constructable<EntityT>
_fieldName: string
_fieldOptions: Required<FieldOptions<NullableT, false>>

Methods

  • Path to the field to be used in filter and order by queries.

    Returns string

    Path to the field to be used in filter and order by queries.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.DeleteRequestBuilderBase.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.DeleteRequestBuilderBase.html index 7d8be62925..04ced51e12 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.DeleteRequestBuilderBase.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.DeleteRequestBuilderBase.html @@ -1,72 +1,72 @@ -DeleteRequestBuilderBase | SAP Cloud SDK for JavaScript - v3.12.1

Class DeleteRequestBuilderBase<EntityT, DeSerializersT>Abstract

Abstract class to delete an entity holding the shared parts between OData v2 and v4.

-

Type Parameters

Hierarchy (view full)

Implements

Constructors

Properties

_deSerializers: DeSerializersT

Dummy property to also include the deserializer type in the structure of the entity type.

-
_entity: EntityT

Dummy property whose type makes structurally identical entities distinguishable in TypeScript.

-

Methods

  • Add custom headers to the request. Existing headers will be overwritten.

    -

    Parameters

    • headers: Record<string, string>

      Key-value pairs denoting additional custom headers.

      +DeleteRequestBuilderBase | SAP Cloud SDK for JavaScript - v3.12.0

      Class DeleteRequestBuilderBase<EntityT, DeSerializersT>Abstract

      Abstract class to delete an entity holding the shared parts between OData v2 and v4.

      +

      Type Parameters

      Hierarchy (view full)

      Implements

      Constructors

      Properties

      _deSerializers: DeSerializersT

      Dummy property to also include the deserializer type in the structure of the entity type.

      +
      _entity: EntityT

      Dummy property whose type makes structurally identical entities distinguishable in TypeScript.

      +

      Methods

      • Add custom headers to the request. Existing headers will be overwritten.

        +

        Parameters

        • headers: Record<string, string>

          Key-value pairs denoting additional custom headers.

        Returns this

        The request builder itself, to facilitate method chaining.

        -
      • Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.

        -

        Parameters

        • queryParameters: Record<string, string>

          Key-value pairs denoting additional custom query parameters to be set in the request.

          +
      • Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.

        +

        Parameters

        • queryParameters: Record<string, string>

          Key-value pairs denoting additional custom query parameters to be set in the request.

        Returns this

        The request builder itself, to facilitate method chaining.

        -
      • Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. +

      • Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. If the custom request configuration contains disallowed keys, those will be ignored.

        -

        Parameters

        • requestConfiguration: Record<string, any>

          Key-value pairs denoting additional custom request configuration options to be set in the request.

          +

          Parameters

          • requestConfiguration: Record<string, string>

            Key-value pairs denoting additional custom request configuration options to be set in the request.

          Returns this

          The request builder itself, to facilitate method chaining.

          -
      • Append the given path to the URL. +

      • Append the given path to the URL. This can be used for querying navigation properties of an entity. To execute a request with an appended path use executeRaw to avoid errors during deserialization. When using this, the execute method is omitted from the return type.

        -

        Parameters

        • Rest ...path: string[]

          Path to be appended.

          +

          Parameters

          • Rest ...path: string[]

            Path to be appended.

          Returns Omit<DeleteRequestBuilderBase<EntityT, DeSerializersT>, "execute">

          The request builder itself without "execute" function, to facilitate method chaining.

          -
      • Execute query.

        -

        Parameters

        • destination: HttpDestinationOrFetchOptions

          Destination or DestinationFetchOptions to execute the request against.

          +
      • Execute query.

        +

        Parameters

        Returns Promise<void>

        A promise resolving once the entity was deleted.

        -
      • Gets identifier for the batch request.

        +
      • Instructs the request to force an overwrite of the entity by sending an 'If-Match: *' header instead of sending the ETag version identifier.

        +
      • Instructs the request to force an overwrite of the entity by sending an 'If-Match: *' header instead of sending the ETag version identifier.

        Returns this

        The request itself to ease chaining while executing the request.

        -
      • Set middleware for requests towards the target system given in the destination.

        -

        Parameters

        • middlewares: HttpMiddleware | HttpMiddleware[]

          Middlewares to be applied to the executeHttpRequest().

          +
      • Set middleware for requests towards the target system given in the destination.

        +

        Parameters

        Returns this

        The request builder itself, to facilitate method chaining.

        -
      • Parameters

        Returns this

      • Create the relative URL based on configuration of the given builder.

        +
      • Parameters

        Returns this

      • Create the relative URL based on configuration of the given builder.

        Returns string

        The relative URL for the request.

        -
      • Replace the default service path with the given custom path. +

      • Replace the default service path with the given custom path. In case of the SAP S/4HANA APIs the basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.

        -

        Parameters

        • basePath: string

          Path to override the default with.

          +

          Parameters

          • basePath: string

            Path to override the default with.

          Returns this

          The request builder itself, to facilitate method chaining.

          -
      • Sets user-defined identifier for the batch reference.

        -

        Parameters

        • id: string

          User-defined batch request identifier.

          -

        Returns void

      • Parameters

        • eTag: string

        Returns this

      • Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.

        +
      • Sets user-defined identifier for the batch reference.

        +

        Parameters

        • id: string

          User-defined batch request identifier.

          +

        Returns void

      • Parameters

        • eTag: string

        Returns this

      • Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.

        Returns this

        The request builder itself, to facilitate method chaining.

        -
      • Create the URL based on configuration of the given builder.

        -

        Parameters

        • destination: HttpDestinationOrFetchOptions

          Destination or DestinationFetchOptions to execute the request against.

          +
      • Create the URL based on configuration of the given builder.

        +

        Parameters

        Returns Promise<string>

        Promise resolving to the URL for the request.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.EdmTypeField.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.EdmTypeField.html index 37fb0e9d1a..9b29e137ed 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.EdmTypeField.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.EdmTypeField.html @@ -1,41 +1,41 @@ -EdmTypeField | SAP Cloud SDK for JavaScript - v3.12.1

Class EdmTypeField<EntityT, DeSerializersT, EdmT, NullableT, SelectableT>

Represents a property of an OData entity with an EDM type.

+EdmTypeField | SAP Cloud SDK for JavaScript - v3.12.0

Class EdmTypeField<EntityT, DeSerializersT, EdmT, NullableT, SelectableT>

Represents a property of an OData entity with an EDM type.

EdmTypeFields are used as static properties of entities or EDM typed fields of complex type fields. They are generated from the OData metadata, i.e. for each property of an OData entity, that has an EDM type, there is one static instance of EdmTypeField (or rather one of its subclasses) in the corresponding generated class file. EdmTypeFields are used to represent the domain of more or less primitive values that can be used in select, filter and order by functions. For example, when constructing a query on the BusinessPartner entity, an instance of EdmTypeField<BusinessPartner, string> can be supplied as argument to the select function, e.g. BusinessPartner.FIRST_NAME.

See also: Selectable.

-

Type Parameters

  • EntityT extends EntityBase

    Type of the entity the field belongs to.

    -
  • DeSerializersT extends DeSerializers

    Type of the (de-)serializers.

    -
  • EdmT extends EdmTypeShared<"any">

    EDM type of the field.

    -
  • NullableT extends boolean = false

    Boolean type that represents whether the field is nullable.

    -
  • SelectableT extends boolean = false

    Boolean type that represents whether the field is selectable.

    -

Hierarchy (view full)

Implements

Constructors

Properties

_deSerializers: DeSerializersT

Dummy property to also include the deserializer type in the structure of the entity type.

-
_entity: EntityT

Dummy property whose type makes structurally identical entities distinguishable in TypeScript.

-
_entityConstructor: Constructable<EntityT>
_fieldName: string
_fieldOptions: Required<FieldOptions<NullableT, SelectableT>>
edmType: EdmT

Methods

Type Parameters

  • EntityT extends EntityBase

    Type of the entity the field belongs to.

    +
  • DeSerializersT extends DeSerializers

    Type of the (de-)serializers.

    +
  • EdmT extends EdmTypeShared<"any">

    EDM type of the field.

    +
  • NullableT extends boolean = false

    Boolean type that represents whether the field is nullable.

    +
  • SelectableT extends boolean = false

    Boolean type that represents whether the field is selectable.

    +

Hierarchy (view full)

Implements

Constructors

Properties

_deSerializers: DeSerializersT

Dummy property to also include the deserializer type in the structure of the entity type.

+
_entity: EntityT

Dummy property whose type makes structurally identical entities distinguishable in TypeScript.

+
_entityConstructor: Constructable<EntityT>
_fieldName: string
_fieldOptions: Required<FieldOptions<NullableT, SelectableT>>
edmType: EdmT

Methods

  • Path to the field to be used in filter and order by queries.

    +
  • Path to the field to be used in filter and order by queries.

    Returns string

    Path to the field to be used in filter and order by queries.

    -
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.EntityBase.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.EntityBase.html index 053b7e951f..24404e9c71 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.EntityBase.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.EntityBase.html @@ -1,80 +1,80 @@ -EntityBase | SAP Cloud SDK for JavaScript - v3.12.1

Super class for all representations of OData entity types.

-

Hierarchy (view full)

Constructors

  • Internal

    Parameters

    • _entityApi: any

    Returns EntityBase

Properties

_customFields: Record<string, any>

A mapper representing custom fields in an entity. +EntityBase | SAP Cloud SDK for JavaScript - v3.12.0

Super class for all representations of OData entity types.

+

Hierarchy (view full)

Constructors

  • Internal

    Parameters

    • _entityApi: any

    Returns EntityBase

Properties

_customFields: Record<string, any>

A mapper representing custom fields in an entity. Custom fields are represented by their field names and the corresponding values. A custom field can be added or updated using setCustomField method.

-
_entityApi: any
_oDataVersion: any
_versionIdentifier: string

The current ETag version of the entity in the remote system. +

_entityApi: any
_oDataVersion: any
_versionIdentifier: string

The current ETag version of the entity in the remote system. The ETag identified the version of the in the remote system. It will be automatically set in the "if-match" header of update requests and can be set as a custom header for delete requests. When no ETag is provided by the remote system the value of this variable defaults to "*".

-
remoteState: {
    [keys: string]: any;
}

The remote state of the entity. +

remoteState: {
    [keys: string]: any;
}

The remote state of the entity. Remote state refers to the last known state of the entity on the remote system from which it has been retrieved or to which it has been posted. It is stored as map, where the keys are stored in the format of the original OData properties.

-

Type declaration

  • [keys: string]: any
_defaultBasePath: string
_entityName: string
_serviceName: string

Accessors

  • get versionIdentifier(): string
  • ETag version identifier accessor.

    +

    Type declaration

    • [keys: string]: any
_defaultBasePath: string
_entityName: string
_serviceName: string

Accessors

  • get versionIdentifier(): string
  • ETag version identifier accessor.

    Returns string

    The ETag version identifier of the retrieved entity, returns undefined if not retrieved.

    -

Methods

  • Creates an object containing all defined properties, navigation properties and custom fields in the entity.

    -

    Parameters

    • Optional visitedEntities: EntityBase[]

      List of entities to check in case of circular dependencies.

      +

Methods

  • Creates an object containing all defined properties, navigation properties and custom fields in the entity.

    +

    Parameters

    • Optional visitedEntities: EntityBase[]

      List of entities to check in case of circular dependencies.

    Returns Record<string, any>

    EntityBase as an object with all defined entity fields.

    -
  • Parameters

    Returns any

  • Custom field value getter.

    -

    Parameters

    • fieldName: string

      The name of the custom field.

      +
  • Parameters

    Returns any

  • Custom field value getter.

    +

    Parameters

    • fieldName: string

      The name of the custom field.

    Returns any

    The value of the corresponding custom field.

    -
  • Returns a map that contains all entity custom fields.

    +
  • Returns a map that contains all entity custom fields.

    Returns Record<string, any>

    A map of all defined custom fields in the entity.

    -
  • Returns all updated custom field properties compared to the last known remote state.

    +
  • Returns all updated custom field properties compared to the last known remote state.

    Returns Record<string, any>

    An object containing all updated custom properties, with their new values.

    -
  • Returns all changed properties compared to the last known remote state. +

  • Returns all changed properties compared to the last known remote state. The returned properties do not include custom fields. Use getUpdatedCustomFields, if you need custom fields.

    Returns Record<string, any>

    EntityBase with all properties that changed.

    -
  • Returns all changed property names compared to the last known remote state. +

  • Returns all changed property names compared to the last known remote state. The returned properties names do not include custom fields. Use getUpdatedCustomFields, if you need custom fields.

    Returns string[]

    EntityBase with all properties that changed.

    -
  • Validates whether a custom field exists in the entity.

    -

    Parameters

    • fieldName: string

      The name of the custom field to update.

      +
  • Validates whether a custom field exists in the entity.

    +

    Parameters

    • fieldName: string

      The name of the custom field to update.

    Returns boolean

    A boolean value, that indicates whether a custom field is defined in entity.

    -
  • Validates whether a field name does not conflict with an original field name and thus can be defined as custom fields.

    -

    Parameters

    • customFieldName: string

      Field name to check.

      +
  • Validates whether a field name does not conflict with an original field name and thus can be defined as custom fields.

    +

    Parameters

    • customFieldName: string

      Field name to check.

    Returns boolean

    Boolean value that describes whether a field name can be defined as custom field.

    -
  • Type Parameters

    Parameters

    Returns boolean

  • Sets a new custom field in the entity or updates it. +

  • Type Parameters

    Parameters

    Returns boolean

  • Sets a new custom field in the entity or updates it. Throws an error, if the provided custom field name is already defined by an original field in entity.

    -

    Parameters

    • fieldName: string

      The name of the custom field to update.

      -
    • value: any

      The value of the field.

      +

      Parameters

      • fieldName: string

        The name of the custom field to update.

        +
      • value: any

        The value of the field.

      Returns this

      The entity itself, to facilitate method chaining.

      -
  • Sets custom fields on an entity.

    -

    Parameters

    • customFields: Record<string, any>

      Custom fields to set on the entity.

      +
  • Sets custom fields on an entity.

    +

    Parameters

    • customFields: Record<string, any>

      Custom fields to set on the entity.

    Returns this

    The entity itself, to facilitate method chaining.

    -
  • Initializes or sets the remoteState of the entity. +

  • Initializes or sets the remoteState of the entity. This function is called on all read, create and update requests.

    -

    Parameters

    • Optional state: Record<string, any>

      State to be set as remote state.

      +

      Parameters

      • Optional state: Record<string, any>

        State to be set as remote state.

      Returns this

      The entity itself, to facilitate method chaining.

      -
  • Set the ETag version identifier of the retrieved entity.

    -

    Parameters

    • etag: undefined | string

      The returned ETag version of the entity.

      +
  • Set the ETag version identifier of the retrieved entity.

    +

    Parameters

    • etag: undefined | string

      The returned ETag version of the entity.

    Returns this

    The entity itself, to facilitate method chaining.

    -
  • Overwrites the default toJSON method so that all instance variables as well as all custom fields of the entity are returned.

    +
  • Overwrites the default toJSON method so that all instance variables as well as all custom fields of the entity are returned.

    Returns {
        [key: string]: any;
    }

    An object containing all instance variables + custom fields.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    • [key: string]: any
\ No newline at end of file +
  • [key: string]: any
\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.EntityBuilder.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.EntityBuilder.html index 8f491aee64..84a880aafd 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.EntityBuilder.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.EntityBuilder.html @@ -1,19 +1,19 @@ -EntityBuilder | SAP Cloud SDK for JavaScript - v3.12.1

Contains the methods to build an entity.

-

Type Parameters

Constructors

Properties

Methods

Constructors

Properties

_entity: EntityT

Methods

  • Builds the entity.

    +EntityBuilder | SAP Cloud SDK for JavaScript - v3.12.0

    Contains the methods to build an entity.

    +

    Type Parameters

    Constructors

    Properties

    Methods

    Constructors

    Properties

    _entity: EntityT

    Methods

    • Builds the entity.

      Returns EntityT

      The entity.

      -
    • Builds an entity from JSON representation. +

    • Builds an entity from JSON representation. If you have obtained the JSON object as a request payload use the entityDeserializer methods. Note that fields not mappable to a field in the target entity are silently ignored.

      -

      Parameters

      • json: FromJsonType<EntityT>

        Representation of the entity in JSON format.

        +

        Parameters

        Returns EntityT

        EntityBase constructed from JSON representation.

        -
    • Sets the custom fields for the entity.

      -

      Parameters

      • customFields: Record<string, any>

        The custom fields you want to add.

        +
    • Sets the custom fields for the entity.

      +

      Parameters

      • customFields: Record<string, any>

        The custom fields you want to add.

      Returns this

      The entity builder itself for method chaining.

      Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

      -
    \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.EnumField.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.EnumField.html index e80118e3fd..72b9c86d2e 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.EnumField.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.EnumField.html @@ -1,30 +1,30 @@ -EnumField | SAP Cloud SDK for JavaScript - v3.12.1

Class EnumField<EntityT, DeSerializersT, EnumT, NullableT, SelectableT>

Represents a property with an enum value.

-

Type Parameters

  • EntityT extends EntityBase

    Type of the entity the field belongs to.

    -
  • DeSerializersT extends DeSerializers
  • EnumT extends string = string

    Enum type that contains all valid enum entries for this field.

    -
  • NullableT extends boolean = false

    Boolean type that represents whether the field is nullable.

    -
  • SelectableT extends boolean = false

    Boolean type that represents whether the field is selectable.

    -

Hierarchy (view full)

Constructors

Properties

_entityConstructor: Constructable<EntityT>
_fieldName: string
_fieldOptions: Required<FieldOptions<NullableT, SelectableT>>
enumType?: Record<string, EnumT>

Methods

\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.Field.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.Field.html index 5889a7ad01..e1957aad71 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.Field.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.Field.html @@ -1,21 +1,21 @@ -Field | SAP Cloud SDK for JavaScript - v3.12.1

Class Field<EntityT, NullableT, SelectableT>

Abstract representation a property of an OData entity.

+Field | SAP Cloud SDK for JavaScript - v3.12.0

Class Field<EntityT, NullableT, SelectableT>

Abstract representation a property of an OData entity.

Fields are used as static properties of entities or properties of ComplexTypeFields and are generated from the metadata, i.e. for each property of an OData entity, there exists one static instance of Field (or rather one of its subclasses) in the corresponding generated class file. Fields are used to represent the domain of values that can be used in select, filter and order by functions.

See also: Selectable, EdmTypeField, ComplexTypeField.

-

Type Parameters

  • EntityT extends EntityBase

    Type of the entity the field belongs to.

    -
  • NullableT extends boolean = false

    Boolean type that represents whether the field is nullable.

    -
  • SelectableT extends boolean = false

    Boolean type that represents whether the field is selectable.

    -

Hierarchy (view full)

Constructors

Properties

_entityConstructor: Constructable<EntityT>
_fieldName: string
_fieldOptions: Required<FieldOptions<NullableT, SelectableT>>

Methods

  • Path to the field to be used in filter and order by queries.

    +

Type Parameters

  • EntityT extends EntityBase

    Type of the entity the field belongs to.

    +
  • NullableT extends boolean = false

    Boolean type that represents whether the field is nullable.

    +
  • SelectableT extends boolean = false

    Boolean type that represents whether the field is selectable.

    +

Hierarchy (view full)

Constructors

Properties

_entityConstructor: Constructable<EntityT>
_fieldName: string
_fieldOptions: Required<FieldOptions<NullableT, SelectableT>>

Methods

  • Path to the field to be used in filter and order by queries.

    Returns string

    Path to the field to be used in filter and order by queries.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.FieldBuilder.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.FieldBuilder.html index 9d593df164..53f1654a67 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.FieldBuilder.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.FieldBuilder.html @@ -1,32 +1,32 @@ -FieldBuilder | SAP Cloud SDK for JavaScript - v3.12.1

Field builder to orchestrate the creation of the different kinds of fields.

-

Type Parameters

  • FieldOfT extends ConstructorOrField<any>

    Type of the entity or complex type field this field belongs to.

    -
  • DeSerializersT extends DeSerializers

    Type of the (de-)serializers.

    -

Constructors

Properties

fieldOf: FieldOfT

Methods

\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.Filter.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.Filter.html index 19d723503a..1842a93747 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.Filter.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.Filter.html @@ -1,22 +1,22 @@ -Filter | SAP Cloud SDK for JavaScript - v3.12.1

Class Filter<EntityT, DeSerializersT, FieldT>

Represents a filter expression to narrow the data on a GetAllRequestBuilder request for multiple entities that match the specified criteria. +Filter | SAP Cloud SDK for JavaScript - v3.12.0

Class Filter<EntityT, DeSerializersT, FieldT>

Represents a filter expression to narrow the data on a GetAllRequestBuilder request for multiple entities that match the specified criteria. A filter refers to the field of an entity and restricts the request based on an operator and a value. Entity.FIELD_NAME.operator(value).

Example

`Product.NAME.equals('cloud-sdk')` creates a filter for the entity `Product` that matches in case the field `NAME` equals 'cloud-sdk'.

See also: {@link Filterable}.
-

Type Parameters

  • EntityT extends EntityBase

    Type of the entity to be filtered on.

    -
  • DeSerializersT extends DeSerializers
  • FieldT

    Type of the field to be filtered by.

    -

Implements

Constructors

Properties

_deSerializers: DeSerializersT

Dummy property to also include the deserializer type in the structure of the entity type.

-
_entity: EntityT

Entity type of the entity tp be filtered.

+

Type Parameters

  • EntityT extends EntityBase

    Type of the entity to be filtered on.

    +
  • DeSerializersT extends DeSerializers

  • FieldT

    Type of the field to be filtered by.

    +

Implements

Constructors

Properties

_deSerializers: DeSerializersT

Dummy property to also include the deserializer type in the structure of the entity type.

+
_entity: EntityT

Entity type of the entity tp be filtered.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
field: string | FilterFunction<EntityT, FieldT>
operator: FilterOperator
value: FieldT
\ No newline at end of file +
field: string | FilterFunction<EntityT, FieldT>
operator: FilterOperator
value: FieldT
\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.FilterFunction.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.FilterFunction.html index fbaf3a5985..2b099a030f 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.FilterFunction.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.FilterFunction.html @@ -1,20 +1,20 @@ -FilterFunction | SAP Cloud SDK for JavaScript - v3.12.1

Class FilterFunction<EntityT, ReturnT>Abstract

Data structure to represent OData filter functions. +FilterFunction | SAP Cloud SDK for JavaScript - v3.12.0

Class FilterFunction<EntityT, ReturnT>Abstract

Data structure to represent OData filter functions. Use the factory function filterFunction to create instances of FilterFunction.

-

Type Parameters

Hierarchy (view full)

Constructors

Properties

Methods

Constructors

Properties

functionName: string

Methods

  • Creates an instance of Filter for this filter function and the given value using the operator 'eq', i.e. ==.

    -

    Parameters

    • value: ReturnT

      Value to be used in the filter.

      +

Type Parameters

Hierarchy (view full)

Constructors

Properties

Methods

Constructors

Properties

functionName: string

Methods

  • Creates an instance of Filter for this filter function and the given value using the operator 'eq', i.e. ==.

    +

    Parameters

    • value: ReturnT

      Value to be used in the filter.

    Returns Filter<EntityT, any, ReturnT>

    The resulting filter.

    -
  • Creates an instance of Filter for this filter function and the given value using the operator 'ne', i.e. !=.

    -

    Parameters

    • value: ReturnT

      Value to be used in the filter.

      +
  • Creates an instance of Filter for this filter function and the given value using the operator 'ne', i.e. !=.

    +

    Parameters

    • value: ReturnT

      Value to be used in the filter.

    Returns Filter<EntityT, any, ReturnT>

    The resulting filter.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.FilterLambdaExpression.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.FilterLambdaExpression.html index eb09af687e..8bb99c0905 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.FilterLambdaExpression.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.FilterLambdaExpression.html @@ -1,6 +1,6 @@ -FilterLambdaExpression | SAP Cloud SDK for JavaScript - v3.12.1

Class FilterLambdaExpression<EntityT, DeSerializersT>

Class representing a filter expression based on a FilterLambdaOperator.

-

Type Parameters

Constructors

Properties

filters -lambdaOperator +FilterLambdaExpression | SAP Cloud SDK for JavaScript - v3.12.0

Class FilterLambdaExpression<EntityT, DeSerializersT>

Class representing a filter expression based on a FilterLambdaOperator.

+

Type Parameters

Constructors

Properties

filters +lambdaOperator

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-

Constructors

Properties

lambdaOperator: FilterLambdaOperator
\ No newline at end of file +

Constructors

Properties

lambdaOperator: FilterLambdaOperator
\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.FilterLink.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.FilterLink.html index 451487a05f..1e89176e60 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.FilterLink.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.FilterLink.html @@ -1,20 +1,20 @@ -FilterLink | SAP Cloud SDK for JavaScript - v3.12.1

Class FilterLink<EntityT, DeSerializersT, LinkedEntityApiT>

Data structure to represent filter on properties of a navigation property (link). +FilterLink | SAP Cloud SDK for JavaScript - v3.12.0

Class FilterLink<EntityT, DeSerializersT, LinkedEntityApiT>

Data structure to represent filter on properties of a navigation property (link). In OData v2 filtering for navigation properties is ONLY supported for properties with a one-to-one cardinality (OneToOneLink).

Example

In the following filter statement `Entity.requestBuilder().filter(Entity.to_NavProperty.filter(LinkedEntity.property.equals(value)))`,
`Entity.to_NavProperty.filter(LinkedEntity.property.equals(value))` is a `FilterLink`.

In OData v4 filtering is also possible on one-to-many links. See {@link OneToManyLink}.

Type Param: LinkedEntityT

Type of the linked entity which is used in the filter.

-

Type Parameters

Implements

Constructors

Properties

_deSerializers: DeSerializersT

Dummy property to also include the deserializer type in the structure of the entity type.

-
_entity: EntityT

Entity type of the entity tp be filtered.

-
_linkedEntityType: EntityType<LinkedEntityApiT>

Linked entity to be filtered by.

+

Type Parameters

Implements

Constructors

Properties

_deSerializers: DeSerializersT

Dummy property to also include the deserializer type in the structure of the entity type.

+
_entity: EntityT

Entity type of the entity tp be filtered.

+
_linkedEntityType: EntityType<LinkedEntityApiT>

Linked entity to be filtered by.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.FilterList.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.FilterList.html index 97174da092..b1a39f725e 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.FilterList.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.FilterList.html @@ -1,13 +1,13 @@ -FilterList | SAP Cloud SDK for JavaScript - v3.12.1

Data structure to combine Filterables conjunctively and / or disjunctively. A FilterList matches when all filterables within the andFilters match and when at least one filterable within the orFilters matches. Should not be used directly.

-

Type Parameters

Implements

Constructors

Properties

_deSerializers: DeSerializersT

Dummy property to also include the deserializer type in the structure of the entity type.

-
_entity: EntityT

Entity type of the entity tp be filtered.

+FilterList | SAP Cloud SDK for JavaScript - v3.12.0

Data structure to combine Filterables conjunctively and / or disjunctively. A FilterList matches when all filterables within the andFilters match and when at least one filterable within the orFilters matches. Should not be used directly.

+

Type Parameters

Implements

Constructors

Properties

_deSerializers: DeSerializersT

Dummy property to also include the deserializer type in the structure of the entity type.

+
_entity: EntityT

Entity type of the entity tp be filtered.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.GetAllRequestBuilderBase.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.GetAllRequestBuilderBase.html index cb651afabf..e676df7141 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.GetAllRequestBuilderBase.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.GetAllRequestBuilderBase.html @@ -1,83 +1,83 @@ -GetAllRequestBuilderBase | SAP Cloud SDK for JavaScript - v3.12.1

Class GetAllRequestBuilderBase<EntityT, DeSerializersT>Abstract

Base class for the get all request builders GetAllRequestBuilderV2 and GetAllRequestBuilderV4.

-

Type Parameters

Hierarchy (view full)

Constructors

Properties

_deSerializers: DeSerializersT
_entity: EntityT
_entityConstructor: Constructable<EntityT>
dataAccessor: ResponseDataAccessor
entityDeserializer: EntityDeserializer

Methods

  • Add custom headers to the request. Existing headers will be overwritten.

    -

    Parameters

    • headers: Record<string, string>

      Key-value pairs denoting additional custom headers.

      +GetAllRequestBuilderBase | SAP Cloud SDK for JavaScript - v3.12.0

      Class GetAllRequestBuilderBase<EntityT, DeSerializersT>Abstract

      Base class for the get all request builders GetAllRequestBuilderV2 and GetAllRequestBuilderV4.

      +

      Type Parameters

      Hierarchy (view full)

      Constructors

      Properties

      _deSerializers: DeSerializersT
      _entity: EntityT
      _entityConstructor: Constructable<EntityT>
      dataAccessor: ResponseDataAccessor
      entityDeserializer: EntityDeserializer

      Methods

      • Add custom headers to the request. Existing headers will be overwritten.

        +

        Parameters

        • headers: Record<string, string>

          Key-value pairs denoting additional custom headers.

        Returns this

        The request builder itself, to facilitate method chaining.

        -
      • Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.

        -

        Parameters

        • queryParameters: Record<string, string>

          Key-value pairs denoting additional custom query parameters to be set in the request.

          +
      • Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.

        +

        Parameters

        • queryParameters: Record<string, string>

          Key-value pairs denoting additional custom query parameters to be set in the request.

        Returns this

        The request builder itself, to facilitate method chaining.

        -
      • Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. +

      • Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. If the custom request configuration contains disallowed keys, those will be ignored.

        -

        Parameters

        • requestConfiguration: Record<string, any>

          Key-value pairs denoting additional custom request configuration options to be set in the request.

          +

          Parameters

          • requestConfiguration: Record<string, string>

            Key-value pairs denoting additional custom request configuration options to be set in the request.

          Returns this

          The request builder itself, to facilitate method chaining.

          -
      • Append the given path to the URL. +

      • Append the given path to the URL. This can be used for querying navigation properties of an entity. To execute a request with an appended path use executeRaw to avoid errors during deserialization. When using this, the execute method is omitted from the return type.

        -

        Parameters

        • Rest ...path: string[]

          Path to be appended.

          +

          Parameters

          • Rest ...path: string[]

            Path to be appended.

          Returns Omit<GetAllRequestBuilderBase<EntityT, DeSerializersT>, "execute">

          The request builder itself without "execute" function, to facilitate method chaining.

          -
      • Count the number of entities.

        +
      • Execute request.

        -

        Parameters

        • destination: HttpDestinationOrFetchOptions

          Destination or DestinationFetchOptions to execute the request against.

          +
      • Execute request.

        +

        Parameters

        Returns Promise<EntityT[]>

        A promise resolving to the requested entities.

        -
      • Set middleware for requests towards the target system given in the destination.

        -

        Parameters

        • middlewares: HttpMiddleware | HttpMiddleware[]

          Middlewares to be applied to the executeHttpRequest().

          +
      • Set middleware for requests towards the target system given in the destination.

        +

        Parameters

        Returns this

        The request builder itself, to facilitate method chaining.

        -
      • Parameters

        Returns this

      • Add order-by statements to the request.

        -

        Parameters

        • orderBy: OrderableAndOrderableInput<EntityT, DeSerializersT, EntityApi<EntityBase, DeSerializersT>>[]

          OrderBy statements to order the response by.

          +
        • Parameters

          Returns this

      • Create the relative URL based on configuration of the given builder.

        +
      • Returns this

      • Create the relative URL based on configuration of the given builder.

        Returns string

        The relative URL for the request.

        -
      • Restrict the response to the given selection of properties in the request.

        -

        Parameters

        • Rest ...selects: Selectable<EntityT, DeSerializersT>[]

          Fields to select in the request.

          +
      • Restrict the response to the given selection of properties in the request.

        +

        Parameters

        Returns this

        The request builder itself, to facilitate method chaining.

        -
      • Parameters

        Returns this

      • Replace the default service path with the given custom path. +

      • Parameters

        Returns this

      • Replace the default service path with the given custom path. In case of the SAP S/4HANA APIs the basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.

        -

        Parameters

        • basePath: string

          Path to override the default with.

          +

          Parameters

          • basePath: string

            Path to override the default with.

          Returns this

          The request builder itself, to facilitate method chaining.

          -
      • Skip number of entities.

        -

        Parameters

        • skip: number

          Number of matching entities to skip. Useful for paging.

          +
      • Skip number of entities.

        +

        Parameters

        • skip: number

          Number of matching entities to skip. Useful for paging.

        Returns this

        The request builder itself, to facilitate method chaining.

        -
      • Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.

        +
      • Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.

        Returns this

        The request builder itself, to facilitate method chaining.

        -
      • Limit number of returned entities.

        -

        Parameters

        • top: number

          Maximum number of entities to return in the response. Can be less, if less entities match the request.

          +
      • Limit number of returned entities.

        +

        Parameters

        • top: number

          Maximum number of entities to return in the response. Can be less, if less entities match the request.

        Returns this

        The request builder itself, to facilitate method chaining.

        -
      • Create the URL based on configuration of the given builder.

        -

        Parameters

        • destination: HttpDestinationOrFetchOptions

          Destination or DestinationFetchOptions to execute the request against.

          +
      • Create the URL based on configuration of the given builder.

        +

        Parameters

        Returns Promise<string>

        Promise resolving to the URL for the request.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.GetByKeyRequestBuilderBase.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.GetByKeyRequestBuilderBase.html index 264ddf99e9..0411245c3a 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.GetByKeyRequestBuilderBase.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.GetByKeyRequestBuilderBase.html @@ -1,75 +1,75 @@ -GetByKeyRequestBuilderBase | SAP Cloud SDK for JavaScript - v3.12.1

Class GetByKeyRequestBuilderBase<EntityT, DeSerializersT>Abstract

Abstract class to create a get by key request containing the shared functionality for OData v2 and v4.

-

Type Parameters

Hierarchy (view full)

Implements

Constructors

Properties

_deSerializers: DeSerializersT
_entity: EntityT
_entityConstructor: Constructable<EntityT>
dataAccessor: ResponseDataAccessor
entityDeserializer: EntityDeserializer

Methods

  • Add custom headers to the request. Existing headers will be overwritten.

    -

    Parameters

    • headers: Record<string, string>

      Key-value pairs denoting additional custom headers.

      +GetByKeyRequestBuilderBase | SAP Cloud SDK for JavaScript - v3.12.0

      Class GetByKeyRequestBuilderBase<EntityT, DeSerializersT>Abstract

      Abstract class to create a get by key request containing the shared functionality for OData v2 and v4.

      +

      Type Parameters

      Hierarchy (view full)

      Implements

      Constructors

      Properties

      _deSerializers: DeSerializersT
      _entity: EntityT
      _entityConstructor: Constructable<EntityT>
      dataAccessor: ResponseDataAccessor
      entityDeserializer: EntityDeserializer

      Methods

      • Add custom headers to the request. Existing headers will be overwritten.

        +

        Parameters

        • headers: Record<string, string>

          Key-value pairs denoting additional custom headers.

        Returns this

        The request builder itself, to facilitate method chaining.

        -
      • Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.

        -

        Parameters

        • queryParameters: Record<string, string>

          Key-value pairs denoting additional custom query parameters to be set in the request.

          +
      • Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.

        +

        Parameters

        • queryParameters: Record<string, string>

          Key-value pairs denoting additional custom query parameters to be set in the request.

        Returns this

        The request builder itself, to facilitate method chaining.

        -
      • Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. +

      • Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. If the custom request configuration contains disallowed keys, those will be ignored.

        -

        Parameters

        • requestConfiguration: Record<string, any>

          Key-value pairs denoting additional custom request configuration options to be set in the request.

          +

          Parameters

          • requestConfiguration: Record<string, string>

            Key-value pairs denoting additional custom request configuration options to be set in the request.

          Returns this

          The request builder itself, to facilitate method chaining.

          -
      • Append the given path to the URL. +

      • Append the given path to the URL. This can be used for querying navigation properties of an entity. To execute a request with an appended path use executeRaw to avoid errors during deserialization. When using this, the execute method is omitted from the return type.

        -

        Parameters

        • Rest ...path: string[]

          Path to be appended.

          +

          Parameters

          • Rest ...path: string[]

            Path to be appended.

          Returns Omit<GetByKeyRequestBuilderBase<EntityT, DeSerializersT>, "execute">

          The request builder itself without "execute" function, to facilitate method chaining.

          -
      • Execute request.

        -

        Parameters

        • destination: HttpDestinationOrFetchOptions

          Destination or DestinationFetchOptions to execute the request against.

          +
      • Execute request.

        +

        Parameters

        Returns Promise<EntityT>

        A promise resolving to the requested entity.

        -
      • Gets identifier for the batch request.

        +
      • Set middleware for requests towards the target system given in the destination.

        -

        Parameters

      • Set middleware for requests towards the target system given in the destination.

        +

        Parameters

        Returns this

        The request builder itself, to facilitate method chaining.

        -
      • Parameters

        Returns this

      • Create the relative URL based on configuration of the given builder.

        +
      • Parameters

        Returns this

      • Create the relative URL based on configuration of the given builder.

        Returns string

        The relative URL for the request.

        -
      • Restrict the response to the given selection of properties in the request.

        -

        Parameters

        • Rest ...selects: Selectable<EntityT, DeSerializersT>[]

          Fields to select in the request.

          +
      • Restrict the response to the given selection of properties in the request.

        +

        Parameters

        Returns this

        The request builder itself, to facilitate method chaining.

        -
      • Parameters

        Returns this

      • Replace the default service path with the given custom path. +

      • Parameters

        Returns this

      • Replace the default service path with the given custom path. In case of the SAP S/4HANA APIs the basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.

        -

        Parameters

        • basePath: string

          Path to override the default with.

          +

          Parameters

          • basePath: string

            Path to override the default with.

          Returns this

          The request builder itself, to facilitate method chaining.

          -
      • Sets user-defined identifier for the batch reference.

        -

        Parameters

        • id: string

          User-defined batch request identifier.

          -

        Returns void

      • Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.

        +
      • Sets user-defined identifier for the batch reference.

        +

        Parameters

        • id: string

          User-defined batch request identifier.

          +

        Returns void

      • Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.

        Returns this

        The request builder itself, to facilitate method chaining.

        -
      • Create the URL based on configuration of the given builder.

        -

        Parameters

        • destination: HttpDestinationOrFetchOptions

          Destination or DestinationFetchOptions to execute the request against.

          +
      • Create the URL based on configuration of the given builder.

        +

        Parameters

        Returns Promise<string>

        Promise resolving to the URL for the request.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.Link.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.Link.html index d692b2d120..7666decb8f 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.Link.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.Link.html @@ -1,4 +1,4 @@ -Link | SAP Cloud SDK for JavaScript - v3.12.1

Class Link<EntityT, DeSerializersT, LinkedEntityApiT>

Represents a navigation property of an OData entity.

+Link | SAP Cloud SDK for JavaScript - v3.12.0

Class Link<EntityT, DeSerializersT, LinkedEntityApiT>

Represents a navigation property of an OData entity.

OData is a relational data model, i.e. entities can be related to one another. For example, BusinessPartner is in a 1:n relation with BusinessPartnerAddress and in a 1:1 relation with Customer. Like normal properties, navigation properties can be used for selecting (expanding) and filtering. @@ -9,30 +9,30 @@ OData v4 entity: 1:N is a OneToManyLink, 1:0..1 is a OneToOneLink.

See also: Selectable.

Type Param: LinkedEntityT

Type of the entity to be linked to.

-

Type Parameters

Hierarchy (view full)

Implements

Constructors

Properties

_deSerializers: DeSerializersT

Dummy property to also include the deserializer type in the structure of the entity type.

-
_entity: EntityT

Dummy property whose type makes structurally identical entities distinguishable in TypeScript.

-
_fieldName: string
_linkedEntityApi: LinkedEntityApiT

List of selectables on the linked entity.

-

Methods

  • Create a new link based on a given link.

    +

Type Parameters

Hierarchy (view full)

Implements

Constructors

Properties

_deSerializers: DeSerializersT

Dummy property to also include the deserializer type in the structure of the entity type.

+
_entity: EntityT

Dummy property whose type makes structurally identical entities distinguishable in TypeScript.

+
_fieldName: string
_linkedEntityApi: LinkedEntityApiT

List of selectables on the linked entity.

+

Methods

  • Create a new link based on a given link.

    Returns this

    Newly created link.

    -
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.NumberFilterFunction.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.NumberFilterFunction.html index 5337eb9100..b84b945914 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.NumberFilterFunction.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.NumberFilterFunction.html @@ -1,35 +1,35 @@ -NumberFilterFunction | SAP Cloud SDK for JavaScript - v3.12.1

Representation of a filter function, that returns a value of type number. This supports int, double and decimal values.

-

Type Parameters

Hierarchy

  • OrderableFilterFunction<EntityT, number>
    • NumberFilterFunction

Constructors

  • Creates an instance of NumberFilterFunction.

    -

    Type Parameters

    Parameters

    • functionName: string

      Name of the function that returns a numeric value.

      -
    • parameters: FilterFunctionParameterType<EntityT>[]

      Representation of the parameters passed to the filter function.

      -
    • edmType: "Edm.Decimal" | "Edm.Double" | "Edm.Int32"

      Type of the returned numeric value. This influences the formatting of the returned value.

      -

    Returns NumberFilterFunction<EntityT>

Properties

functionName: string

Methods

  • Creates an instance of Filter for this filter function and the given value using the operator 'eq', i.e. ==.

    -

    Parameters

    • value: number

      Value to be used in the filter.

      +NumberFilterFunction | SAP Cloud SDK for JavaScript - v3.12.0

      Representation of a filter function, that returns a value of type number. This supports int, double and decimal values.

      +

      Type Parameters

      Hierarchy

      • OrderableFilterFunction<EntityT, number>
        • NumberFilterFunction

      Constructors

      • Creates an instance of NumberFilterFunction.

        +

        Type Parameters

        Parameters

        • functionName: string

          Name of the function that returns a numeric value.

          +
        • parameters: FilterFunctionParameterType<EntityT>[]

          Representation of the parameters passed to the filter function.

          +
        • edmType: "Edm.Decimal" | "Edm.Double" | "Edm.Int32"

          Type of the returned numeric value. This influences the formatting of the returned value.

          +

        Returns NumberFilterFunction<EntityT>

      Properties

      functionName: string

      Methods

      • Creates an instance of Filter for this filter function and the given value using the operator 'eq', i.e. ==.

        +

        Parameters

        • value: number

          Value to be used in the filter.

        Returns Filter<EntityT, any, number>

        The resulting filter.

        -
      • Creates an instance of Filter for this filter function and the given value using the operator 'ge', i.e. >=.

        -

        Parameters

        • value: number

          Value to be used in the filter.

          +
      • Creates an instance of Filter for this filter function and the given value using the operator 'ge', i.e. >=.

        +

        Parameters

        • value: number

          Value to be used in the filter.

        Returns Filter<EntityT, any, number>

        The resulting filter.

        -
      • Creates an instance of Filter for this filter function and the given value using the operator 'gt', i.e. >.

        -

        Parameters

        • value: number

          Value to be used in the filter.

          +
      • Creates an instance of Filter for this filter function and the given value using the operator 'gt', i.e. >.

        +

        Parameters

        • value: number

          Value to be used in the filter.

        Returns Filter<EntityT, any, number>

        The resulting filter.

        -
      • Creates an instance of Filter for this filter function and the given value using the operator 'le', i.e. <=.

        -

        Parameters

        • value: number

          Value to be used in the filter.

          +
      • Creates an instance of Filter for this filter function and the given value using the operator 'le', i.e. <=.

        +

        Parameters

        • value: number

          Value to be used in the filter.

        Returns Filter<EntityT, any, number>

        The resulting filter.

        -
      • Creates an instance of Filter for this filter function and the given value using the operator 'lt', i.e. <.

        -

        Parameters

        • value: number

          Value to be used in the filter.

          +
      • Creates an instance of Filter for this filter function and the given value using the operator 'lt', i.e. <.

        +

        Parameters

        • value: number

          Value to be used in the filter.

        Returns Filter<EntityT, any, number>

        The resulting filter.

        -
      • Creates an instance of Filter for this filter function and the given value using the operator 'ne', i.e. !=.

        -

        Parameters

        • value: number

          Value to be used in the filter.

          +
      • Creates an instance of Filter for this filter function and the given value using the operator 'ne', i.e. !=.

        +

        Parameters

        • value: number

          Value to be used in the filter.

        Returns Filter<EntityT, any, number>

        The resulting filter.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.ODataBatchRequestConfig.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.ODataBatchRequestConfig.html index 1107c61986..bf9519f2c7 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.ODataBatchRequestConfig.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.ODataBatchRequestConfig.html @@ -1,35 +1,35 @@ -ODataBatchRequestConfig | SAP Cloud SDK for JavaScript - v3.12.1

OData batch request configuration for an entity type.

-

Hierarchy (view full)

Constructors

  • Creates an instance of ODataBatchRequestConfig.

    -

    Parameters

    • defaultBasePath: string

      The default OData service path.

      -
    • Optional boundary: string

      Request boundary for separation of subrequests. Defaults to an autogenerated value.

      -

    Returns ODataBatchRequestConfig

Properties

basePath: string
boundary: string
defaultBasePath: string
defaultHeaders: Record<string, any>
parameterEncoder: ParameterEncoder
payload: string | Record<string, any>
subRequestPathType: BatchSubRequestPathType

Accessors

  • get appendedPaths(): string[]
  • Returns string[]

  • get customHeaders(): Record<string, string>
  • Returns Record<string, string>

  • set customHeaders(headers): void
  • Parameters

    • headers: Record<string, string>

    Returns void

  • get customQueryParameters(): Record<string, string>
  • Returns Record<string, string>

  • set customQueryParameters(queryParameters): void
  • Parameters

    • queryParameters: Record<string, string>

    Returns void

  • get customRequestConfiguration(): Record<string, string>
  • Returns Record<string, string>

  • set customRequestConfiguration(requestConfiguration): void
  • Parameters

    • requestConfiguration: Record<string, string>

    Returns void

  • get fetchCsrfToken(): boolean
  • Returns boolean

  • set fetchCsrfToken(fetchCsrfToken): void
  • Parameters

    • fetchCsrfToken: boolean

    Returns void

  • get middlewares(): HttpMiddleware[]
  • Returns HttpMiddleware[]

  • set middlewares(middlewares): void
  • Parameters

    Returns void

Methods

  • Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.

    -

    Parameters

    • headers: Record<string, string>

      Key-value pairs where the key is the name of a header property and the value is the respective value.

      -

    Returns void

  • Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.

    -

    Parameters

    • queryParameters: Record<string, string>

      Key-value pairs where the key is the name of a query parameter and the value is the respective value.

      -

    Returns void

  • Add custom request configuration to the request.

    -

    Parameters

    • requestConfiguration: Record<string, any>

      Key-value pairs where the key is the name of a request configuration and the value is the respective value.

      +ODataBatchRequestConfig | SAP Cloud SDK for JavaScript - v3.12.0

      OData batch request configuration for an entity type.

      +

      Hierarchy (view full)

      Constructors

      • Creates an instance of ODataBatchRequestConfig.

        +

        Parameters

        • defaultBasePath: string

          The default OData service path.

          +
        • Optional boundary: string

          Request boundary for separation of subrequests. Defaults to an autogenerated value.

          +

        Returns ODataBatchRequestConfig

      Properties

      basePath: string
      boundary: string
      defaultBasePath: string
      defaultHeaders: Record<string, any>
      parameterEncoder: ParameterEncoder
      payload: string | Record<string, any>
      subRequestPathType: BatchSubRequestPathType

      Accessors

      • get appendedPaths(): string[]
      • Returns string[]

      • get customHeaders(): Record<string, string>
      • Returns Record<string, string>

      • set customHeaders(headers): void
      • Parameters

        • headers: Record<string, string>

        Returns void

      • get customQueryParameters(): Record<string, string>
      • Returns Record<string, string>

      • set customQueryParameters(queryParameters): void
      • Parameters

        • queryParameters: Record<string, string>

        Returns void

      • get customRequestConfiguration(): Record<string, string>
      • Returns Record<string, string>

      • set customRequestConfiguration(requestConfiguration): void
      • Parameters

        • requestConfiguration: Record<string, string>

        Returns void

      • get fetchCsrfToken(): boolean
      • Returns boolean

      • set fetchCsrfToken(fetchCsrfToken): void
      • Parameters

        • fetchCsrfToken: boolean

        Returns void

      • get middlewares(): HttpMiddleware[]
      • Returns HttpMiddleware[]

      • set middlewares(middlewares): void
      • Parameters

        Returns void

      Methods

      • Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.

        +

        Parameters

        • headers: Record<string, string>

          Key-value pairs where the key is the name of a header property and the value is the respective value.

          +

        Returns void

      • Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.

        +

        Parameters

        • queryParameters: Record<string, string>

          Key-value pairs where the key is the name of a query parameter and the value is the respective value.

          +

        Returns void

      • Add custom request configuration to the request.

        +

        Parameters

        • requestConfiguration: Record<string, string>

          Key-value pairs where the key is the name of a request configuration and the value is the respective value.

          Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

          -

        Returns void

      • Parameters

        • Rest ...path: string[]

        Returns void

      • Parameters

        • params: Record<string, any>

        Returns Record<string, any>

      • Internal

        Returns Record<string, any>

      • Internal

        Returns string

      • Parameters

        Returns void

      \ No newline at end of file +

    Returns void

  • Parameters

    • Rest ...path: string[]

    Returns void

  • Parameters

    • params: Record<string, any>

    Returns Record<string, any>

  • Internal

    Returns Record<string, any>

  • Internal

    Returns string

  • Parameters

    Returns void

\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.ODataCountRequestConfig.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.ODataCountRequestConfig.html index 1b0fae26e4..118c7cda88 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.ODataCountRequestConfig.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.ODataCountRequestConfig.html @@ -1,33 +1,33 @@ -ODataCountRequestConfig | SAP Cloud SDK for JavaScript - v3.12.1

Class ODataCountRequestConfig<EntityT, DeSerializersT>

OData count request configuration for an entity type.

-

Type Parameters

Hierarchy (view full)

Constructors

Properties

basePath: string
defaultBasePath: string
defaultHeaders: Record<string, any>
parameterEncoder: ParameterEncoder
payload: string | Record<string, any>

Accessors

  • get appendedPaths(): string[]
  • Returns string[]

  • get customHeaders(): Record<string, string>
  • Returns Record<string, string>

  • set customHeaders(headers): void
  • Parameters

    • headers: Record<string, string>

    Returns void

  • get customQueryParameters(): Record<string, string>
  • Returns Record<string, string>

  • set customQueryParameters(queryParameters): void
  • Parameters

    • queryParameters: Record<string, string>

    Returns void

  • get customRequestConfiguration(): Record<string, string>
  • Returns Record<string, string>

  • set customRequestConfiguration(requestConfiguration): void
  • Parameters

    • requestConfiguration: Record<string, string>

    Returns void

  • get fetchCsrfToken(): boolean
  • Returns boolean

  • set fetchCsrfToken(fetchCsrfToken): void
  • Parameters

    • fetchCsrfToken: boolean

    Returns void

  • get middlewares(): HttpMiddleware[]
  • Returns HttpMiddleware[]

  • set middlewares(middlewares): void
  • Parameters

    Returns void

Methods

  • Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.

    -

    Parameters

    • headers: Record<string, string>

      Key-value pairs where the key is the name of a header property and the value is the respective value.

      -

    Returns void

  • Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.

    -

    Parameters

    • queryParameters: Record<string, string>

      Key-value pairs where the key is the name of a query parameter and the value is the respective value.

      -

    Returns void

  • Add custom request configuration to the request.

    -

    Parameters

    • requestConfiguration: Record<string, any>

      Key-value pairs where the key is the name of a request configuration and the value is the respective value.

      +ODataCountRequestConfig | SAP Cloud SDK for JavaScript - v3.12.0

      Class ODataCountRequestConfig<EntityT, DeSerializersT>

      OData count request configuration for an entity type.

      +

      Type Parameters

      Hierarchy (view full)

      Constructors

      Properties

      basePath: string
      defaultBasePath: string
      defaultHeaders: Record<string, any>
      parameterEncoder: ParameterEncoder
      payload: string | Record<string, any>

      Accessors

      • get appendedPaths(): string[]
      • Returns string[]

      • get customHeaders(): Record<string, string>
      • Returns Record<string, string>

      • set customHeaders(headers): void
      • Parameters

        • headers: Record<string, string>

        Returns void

      • get customQueryParameters(): Record<string, string>
      • Returns Record<string, string>

      • set customQueryParameters(queryParameters): void
      • Parameters

        • queryParameters: Record<string, string>

        Returns void

      • get customRequestConfiguration(): Record<string, string>
      • Returns Record<string, string>

      • set customRequestConfiguration(requestConfiguration): void
      • Parameters

        • requestConfiguration: Record<string, string>

        Returns void

      • get fetchCsrfToken(): boolean
      • Returns boolean

      • set fetchCsrfToken(fetchCsrfToken): void
      • Parameters

        • fetchCsrfToken: boolean

        Returns void

      • get middlewares(): HttpMiddleware[]
      • Returns HttpMiddleware[]

      • set middlewares(middlewares): void
      • Parameters

        Returns void

      Methods

      • Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.

        +

        Parameters

        • headers: Record<string, string>

          Key-value pairs where the key is the name of a header property and the value is the respective value.

          +

        Returns void

      • Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.

        +

        Parameters

        • queryParameters: Record<string, string>

          Key-value pairs where the key is the name of a query parameter and the value is the respective value.

          +

        Returns void

      • Add custom request configuration to the request.

        +

        Parameters

        • requestConfiguration: Record<string, string>

          Key-value pairs where the key is the name of a request configuration and the value is the respective value.

          Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

          -

        Returns void

      • Parameters

        • Rest ...path: string[]

        Returns void

      • Parameters

        • params: Record<string, any>

        Returns Record<string, any>

      • Internal

        Returns Record<string, any>

      • Internal

        Returns string

      \ No newline at end of file +

    Returns void

  • Parameters

    • Rest ...path: string[]

    Returns void

  • Parameters

    • params: Record<string, any>

    Returns Record<string, any>

  • Internal

    Returns Record<string, any>

  • Internal

    Returns string

\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.ODataCreateRequestConfig.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.ODataCreateRequestConfig.html index 1d995434e3..dad1057fac 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.ODataCreateRequestConfig.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.ODataCreateRequestConfig.html @@ -1,39 +1,39 @@ -ODataCreateRequestConfig | SAP Cloud SDK for JavaScript - v3.12.1

Class ODataCreateRequestConfig<EntityT, DeSerializersT>

OData create request configuration for an entity type.

-

Type Parameters

Hierarchy (view full)

Constructors

Properties

basePath: string

Field that links the parent entity class to the child entity class.

-
defaultBasePath: string
defaultHeaders: Record<string, any>
parameterEncoder: ParameterEncoder
parentKeys: Record<string, any>

Keys of the parent of the entity to create. Defined only when attempting to create child entities.

-
payload: string | Record<string, any>

Accessors

  • get appendedPaths(): string[]
  • Returns string[]

  • get customHeaders(): Record<string, string>
  • Returns Record<string, string>

  • set customHeaders(headers): void
  • Parameters

    • headers: Record<string, string>

    Returns void

  • get customQueryParameters(): Record<string, string>
  • Returns Record<string, string>

  • set customQueryParameters(queryParameters): void
  • Parameters

    • queryParameters: Record<string, string>

    Returns void

  • get customRequestConfiguration(): Record<string, string>
  • Returns Record<string, string>

  • set customRequestConfiguration(requestConfiguration): void
  • Parameters

    • requestConfiguration: Record<string, string>

    Returns void

  • get fetchCsrfToken(): boolean
  • Returns boolean

  • set fetchCsrfToken(fetchCsrfToken): void
  • Parameters

    • fetchCsrfToken: boolean

    Returns void

  • get middlewares(): HttpMiddleware[]
  • Returns HttpMiddleware[]

  • set middlewares(middlewares): void
  • Parameters

    Returns void

Methods

  • Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.

    -

    Parameters

    • headers: Record<string, string>

      Key-value pairs where the key is the name of a header property and the value is the respective value.

      -

    Returns void

  • Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.

    -

    Parameters

    • queryParameters: Record<string, string>

      Key-value pairs where the key is the name of a query parameter and the value is the respective value.

      -

    Returns void

  • Add custom request configuration to the request.

    -

    Parameters

    • requestConfiguration: Record<string, any>

      Key-value pairs where the key is the name of a request configuration and the value is the respective value.

      +ODataCreateRequestConfig | SAP Cloud SDK for JavaScript - v3.12.0

      Class ODataCreateRequestConfig<EntityT, DeSerializersT>

      OData create request configuration for an entity type.

      +

      Type Parameters

      Hierarchy (view full)

      Constructors

      Properties

      basePath: string

      Field that links the parent entity class to the child entity class.

      +
      defaultBasePath: string
      defaultHeaders: Record<string, any>
      parameterEncoder: ParameterEncoder
      parentKeys: Record<string, any>

      Keys of the parent of the entity to create. Defined only when attempting to create child entities.

      +
      payload: string | Record<string, any>

      Accessors

      • get appendedPaths(): string[]
      • Returns string[]

      • get customHeaders(): Record<string, string>
      • Returns Record<string, string>

      • set customHeaders(headers): void
      • Parameters

        • headers: Record<string, string>

        Returns void

      • get customQueryParameters(): Record<string, string>
      • Returns Record<string, string>

      • set customQueryParameters(queryParameters): void
      • Parameters

        • queryParameters: Record<string, string>

        Returns void

      • get customRequestConfiguration(): Record<string, string>
      • Returns Record<string, string>

      • set customRequestConfiguration(requestConfiguration): void
      • Parameters

        • requestConfiguration: Record<string, string>

        Returns void

      • get fetchCsrfToken(): boolean
      • Returns boolean

      • set fetchCsrfToken(fetchCsrfToken): void
      • Parameters

        • fetchCsrfToken: boolean

        Returns void

      • get middlewares(): HttpMiddleware[]
      • Returns HttpMiddleware[]

      • set middlewares(middlewares): void
      • Parameters

        Returns void

      Methods

      • Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.

        +

        Parameters

        • headers: Record<string, string>

          Key-value pairs where the key is the name of a header property and the value is the respective value.

          +

        Returns void

      • Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.

        +

        Parameters

        • queryParameters: Record<string, string>

          Key-value pairs where the key is the name of a query parameter and the value is the respective value.

          +

        Returns void

      • Add custom request configuration to the request.

        +

        Parameters

        • requestConfiguration: Record<string, string>

          Key-value pairs where the key is the name of a request configuration and the value is the respective value.

          Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

          -

        Returns void

      • Parameters

        • Rest ...path: string[]

        Returns void

      • Parameters

        • params: Record<string, any>

        Returns Record<string, any>

      • Internal

        Returns Record<string, any>

      • Internal

        Returns string

      • Returns string

      \ No newline at end of file +

    Returns void

  • Parameters

    • Rest ...path: string[]

    Returns void

  • Parameters

    • params: Record<string, any>

    Returns Record<string, any>

  • Internal

    Returns Record<string, any>

  • Internal

    Returns string

  • Returns string

\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.ODataDeleteRequestConfig.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.ODataDeleteRequestConfig.html index d852115d89..ecf6bdea37 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.ODataDeleteRequestConfig.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.ODataDeleteRequestConfig.html @@ -1,40 +1,40 @@ -ODataDeleteRequestConfig | SAP Cloud SDK for JavaScript - v3.12.1

Class ODataDeleteRequestConfig<EntityT, DeSerializersT>

OData delete request configuration for an entity type.

-

Type Parameters

Hierarchy (view full)

Implements

Constructors

Properties

basePath: string
defaultBasePath: string
defaultHeaders: Record<string, any>
eTag: string

Version identifier.

-
keys: Record<string, any>

Map containing the key name and value.

-
parameterEncoder: ParameterEncoder
payload: string | Record<string, any>
versionIdentifierIgnored: boolean

Ignore the version identifier if set to true.

-

Accessors

  • get appendedPaths(): string[]
  • Returns string[]

  • get customHeaders(): Record<string, string>
  • Returns Record<string, string>

  • set customHeaders(headers): void
  • Parameters

    • headers: Record<string, string>

    Returns void

  • get customQueryParameters(): Record<string, string>
  • Returns Record<string, string>

  • set customQueryParameters(queryParameters): void
  • Parameters

    • queryParameters: Record<string, string>

    Returns void

  • get customRequestConfiguration(): Record<string, string>
  • Returns Record<string, string>

  • set customRequestConfiguration(requestConfiguration): void
  • Parameters

    • requestConfiguration: Record<string, string>

    Returns void

  • get fetchCsrfToken(): boolean
  • Returns boolean

  • set fetchCsrfToken(fetchCsrfToken): void
  • Parameters

    • fetchCsrfToken: boolean

    Returns void

  • get middlewares(): HttpMiddleware[]
  • Returns HttpMiddleware[]

  • set middlewares(middlewares): void
  • Parameters

    Returns void

Methods

  • Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.

    -

    Parameters

    • headers: Record<string, string>

      Key-value pairs where the key is the name of a header property and the value is the respective value.

      -

    Returns void

  • Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.

    -

    Parameters

    • queryParameters: Record<string, string>

      Key-value pairs where the key is the name of a query parameter and the value is the respective value.

      -

    Returns void

  • Add custom request configuration to the request.

    -

    Parameters

    • requestConfiguration: Record<string, any>

      Key-value pairs where the key is the name of a request configuration and the value is the respective value.

      +ODataDeleteRequestConfig | SAP Cloud SDK for JavaScript - v3.12.0

      Class ODataDeleteRequestConfig<EntityT, DeSerializersT>

      OData delete request configuration for an entity type.

      +

      Type Parameters

      Hierarchy (view full)

      Implements

      Constructors

      Properties

      basePath: string
      defaultBasePath: string
      defaultHeaders: Record<string, any>
      eTag: string

      Version identifier.

      +
      keys: Record<string, any>

      Map containing the key name and value.

      +
      parameterEncoder: ParameterEncoder
      payload: string | Record<string, any>
      versionIdentifierIgnored: boolean

      Ignore the version identifier if set to true.

      +

      Accessors

      • get appendedPaths(): string[]
      • Returns string[]

      • get customHeaders(): Record<string, string>
      • Returns Record<string, string>

      • set customHeaders(headers): void
      • Parameters

        • headers: Record<string, string>

        Returns void

      • get customQueryParameters(): Record<string, string>
      • Returns Record<string, string>

      • set customQueryParameters(queryParameters): void
      • Parameters

        • queryParameters: Record<string, string>

        Returns void

      • get customRequestConfiguration(): Record<string, string>
      • Returns Record<string, string>

      • set customRequestConfiguration(requestConfiguration): void
      • Parameters

        • requestConfiguration: Record<string, string>

        Returns void

      • get fetchCsrfToken(): boolean
      • Returns boolean

      • set fetchCsrfToken(fetchCsrfToken): void
      • Parameters

        • fetchCsrfToken: boolean

        Returns void

      • get middlewares(): HttpMiddleware[]
      • Returns HttpMiddleware[]

      • set middlewares(middlewares): void
      • Parameters

        Returns void

      Methods

      • Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.

        +

        Parameters

        • headers: Record<string, string>

          Key-value pairs where the key is the name of a header property and the value is the respective value.

          +

        Returns void

      • Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.

        +

        Parameters

        • queryParameters: Record<string, string>

          Key-value pairs where the key is the name of a query parameter and the value is the respective value.

          +

        Returns void

      • Add custom request configuration to the request.

        +

        Parameters

        • requestConfiguration: Record<string, string>

          Key-value pairs where the key is the name of a request configuration and the value is the respective value.

          Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

          -

        Returns void

      • Parameters

        • Rest ...path: string[]

        Returns void

      • Parameters

        • params: Record<string, any>

        Returns Record<string, any>

      • Internal

        Returns Record<string, any>

      • Internal

        Returns string

      \ No newline at end of file +

    Returns void

  • Parameters

    • Rest ...path: string[]

    Returns void

  • Parameters

    • params: Record<string, any>

    Returns Record<string, any>

  • Internal

    Returns Record<string, any>

  • Internal

    Returns string

\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.ODataFunctionRequestConfig.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.ODataFunctionRequestConfig.html index 2603e727ec..388f2ed8bf 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.ODataFunctionRequestConfig.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.ODataFunctionRequestConfig.html @@ -1,40 +1,40 @@ -ODataFunctionRequestConfig | SAP Cloud SDK for JavaScript - v3.12.1

Class ODataFunctionRequestConfig<DeSerializersT, ParametersT>Abstract

Function request configuration for an entity type.

-

Type Parameters

  • DeSerializersT extends DeSerializers

    Type of the deserializer use on the request

    -
  • ParametersT

    Type of the parameter to setup a request with

    -

Hierarchy (view full)

Constructors

Properties

basePath: string
defaultBasePath: string
defaultHeaders: Record<string, any>
functionName: string
parameterEncoder: ParameterEncoder
payload: string | Record<string, any>

Accessors

  • get appendedPaths(): string[]
  • Returns string[]

  • get customHeaders(): Record<string, string>
  • Returns Record<string, string>

  • set customHeaders(headers): void
  • Parameters

    • headers: Record<string, string>

    Returns void

  • get customQueryParameters(): Record<string, string>
  • Returns Record<string, string>

  • set customQueryParameters(queryParameters): void
  • Parameters

    • queryParameters: Record<string, string>

    Returns void

  • get customRequestConfiguration(): Record<string, string>
  • Returns Record<string, string>

  • set customRequestConfiguration(requestConfiguration): void
  • Parameters

    • requestConfiguration: Record<string, string>

    Returns void

  • get fetchCsrfToken(): boolean
  • Returns boolean

  • set fetchCsrfToken(fetchCsrfToken): void
  • Parameters

    • fetchCsrfToken: boolean

    Returns void

  • get middlewares(): HttpMiddleware[]
  • Returns HttpMiddleware[]

  • set middlewares(middlewares): void
  • Parameters

    Returns void

Methods

  • Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.

    -

    Parameters

    • headers: Record<string, string>

      Key-value pairs where the key is the name of a header property and the value is the respective value.

      -

    Returns void

  • Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.

    -

    Parameters

    • queryParameters: Record<string, string>

      Key-value pairs where the key is the name of a query parameter and the value is the respective value.

      -

    Returns void

  • Add custom request configuration to the request.

    -

    Parameters

    • requestConfiguration: Record<string, any>

      Key-value pairs where the key is the name of a request configuration and the value is the respective value.

      +ODataFunctionRequestConfig | SAP Cloud SDK for JavaScript - v3.12.0

      Class ODataFunctionRequestConfig<DeSerializersT, ParametersT>Abstract

      Function request configuration for an entity type.

      +

      Type Parameters

      • DeSerializersT extends DeSerializers

        Type of the deserializer use on the request

        +
      • ParametersT

        Type of the parameter to setup a request with

        +

      Hierarchy (view full)

      Constructors

      Properties

      basePath: string
      defaultBasePath: string
      defaultHeaders: Record<string, any>
      functionName: string
      parameterEncoder: ParameterEncoder
      payload: string | Record<string, any>

      Accessors

      • get appendedPaths(): string[]
      • Returns string[]

      • get customHeaders(): Record<string, string>
      • Returns Record<string, string>

      • set customHeaders(headers): void
      • Parameters

        • headers: Record<string, string>

        Returns void

      • get customQueryParameters(): Record<string, string>
      • Returns Record<string, string>

      • set customQueryParameters(queryParameters): void
      • Parameters

        • queryParameters: Record<string, string>

        Returns void

      • get customRequestConfiguration(): Record<string, string>
      • Returns Record<string, string>

      • set customRequestConfiguration(requestConfiguration): void
      • Parameters

        • requestConfiguration: Record<string, string>

        Returns void

      • get fetchCsrfToken(): boolean
      • Returns boolean

      • set fetchCsrfToken(fetchCsrfToken): void
      • Parameters

        • fetchCsrfToken: boolean

        Returns void

      • get middlewares(): HttpMiddleware[]
      • Returns HttpMiddleware[]

      • set middlewares(middlewares): void
      • Parameters

        Returns void

      Methods

      • Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.

        +

        Parameters

        • headers: Record<string, string>

          Key-value pairs where the key is the name of a header property and the value is the respective value.

          +

        Returns void

      • Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.

        +

        Parameters

        • queryParameters: Record<string, string>

          Key-value pairs where the key is the name of a query parameter and the value is the respective value.

          +

        Returns void

      • Add custom request configuration to the request.

        +

        Parameters

        • requestConfiguration: Record<string, string>

          Key-value pairs where the key is the name of a request configuration and the value is the respective value.

          Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

          -

        Returns void

      • Parameters

        • Rest ...path: string[]

        Returns void

      • Parameters

        • params: Record<string, any>

        Returns Record<string, any>

      • Internal

        Returns Record<string, any>

      • Internal

        Returns string

      \ No newline at end of file +

    Returns void

  • Parameters

    • Rest ...path: string[]

    Returns void

  • Parameters

    • params: Record<string, any>

    Returns Record<string, any>

  • Internal

    Returns Record<string, any>

  • Internal

    Returns string

\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.ODataGetAllRequestConfig.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.ODataGetAllRequestConfig.html index 9c9c243797..942728a1f3 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.ODataGetAllRequestConfig.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.ODataGetAllRequestConfig.html @@ -1,45 +1,45 @@ -ODataGetAllRequestConfig | SAP Cloud SDK for JavaScript - v3.12.1

Class ODataGetAllRequestConfig<EntityT, DeSerializersT>

OData getAll request configuration for an entity type.

-

Type Parameters

Hierarchy (view full)

Implements

Constructors

Properties

basePath: string
defaultBasePath: string
defaultHeaders: Record<string, any>

Filter the results based on conditions.

-
orderBy: Orderable<EntityT>[]

Order the results in, e.g., asc or desc order.

-
parameterEncoder: ParameterEncoder
payload: string | Record<string, any>

Select a list of fields on the schema property of the entity api.

-
skip: number

Skip a number of results in the requested set.

-
top: number

Limit the number of results to the given number.

-

Accessors

  • get appendedPaths(): string[]
  • Returns string[]

  • get customHeaders(): Record<string, string>
  • Returns Record<string, string>

  • set customHeaders(headers): void
  • Parameters

    • headers: Record<string, string>

    Returns void

  • get customQueryParameters(): Record<string, string>
  • Returns Record<string, string>

  • set customQueryParameters(queryParameters): void
  • Parameters

    • queryParameters: Record<string, string>

    Returns void

  • get customRequestConfiguration(): Record<string, string>
  • Returns Record<string, string>

  • set customRequestConfiguration(requestConfiguration): void
  • Parameters

    • requestConfiguration: Record<string, string>

    Returns void

  • get fetchCsrfToken(): boolean
  • Returns boolean

  • set fetchCsrfToken(fetchCsrfToken): void
  • Parameters

    • fetchCsrfToken: boolean

    Returns void

  • get middlewares(): HttpMiddleware[]
  • Returns HttpMiddleware[]

  • set middlewares(middlewares): void
  • Parameters

    Returns void

Methods

  • Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.

    -

    Parameters

    • headers: Record<string, string>

      Key-value pairs where the key is the name of a header property and the value is the respective value.

      -

    Returns void

  • Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.

    -

    Parameters

    • queryParameters: Record<string, string>

      Key-value pairs where the key is the name of a query parameter and the value is the respective value.

      -

    Returns void

  • Parameters

    • Rest ...path: string[]

    Returns void

  • Parameters

    • params: Record<string, any>

    Returns Record<string, any>

  • Internal

    Returns Record<string, any>

  • Internal

    Returns string

\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.ODataGetByKeyRequestConfig.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.ODataGetByKeyRequestConfig.html index 06c10c384c..4120083ed6 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.ODataGetByKeyRequestConfig.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.ODataGetByKeyRequestConfig.html @@ -1,39 +1,39 @@ -ODataGetByKeyRequestConfig | SAP Cloud SDK for JavaScript - v3.12.1

Class ODataGetByKeyRequestConfig<EntityT, DeSerializersT>

OData getByKey request configuration for an entity type.

-

Type Parameters

Hierarchy (view full)

Implements

Constructors

Properties

basePath: string
defaultBasePath: string
defaultHeaders: Record<string, any>
keys: Record<string, any>

Map containing the key name and value.

-
parameterEncoder: ParameterEncoder
payload: string | Record<string, any>

Select a list of fields on the schema property of the entity api.

-

Accessors

  • get appendedPaths(): string[]
  • Returns string[]

  • get customHeaders(): Record<string, string>
  • Returns Record<string, string>

  • set customHeaders(headers): void
  • Parameters

    • headers: Record<string, string>

    Returns void

  • get customQueryParameters(): Record<string, string>
  • Returns Record<string, string>

  • set customQueryParameters(queryParameters): void
  • Parameters

    • queryParameters: Record<string, string>

    Returns void

  • get customRequestConfiguration(): Record<string, string>
  • Returns Record<string, string>

  • set customRequestConfiguration(requestConfiguration): void
  • Parameters

    • requestConfiguration: Record<string, string>

    Returns void

  • get fetchCsrfToken(): boolean
  • Returns boolean

  • set fetchCsrfToken(fetchCsrfToken): void
  • Parameters

    • fetchCsrfToken: boolean

    Returns void

  • get middlewares(): HttpMiddleware[]
  • Returns HttpMiddleware[]

  • set middlewares(middlewares): void
  • Parameters

    Returns void

Methods

  • Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.

    -

    Parameters

    • headers: Record<string, string>

      Key-value pairs where the key is the name of a header property and the value is the respective value.

      -

    Returns void

  • Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.

    -

    Parameters

    • queryParameters: Record<string, string>

      Key-value pairs where the key is the name of a query parameter and the value is the respective value.

      -

    Returns void

  • Parameters

    • Rest ...path: string[]

    Returns void

  • Parameters

    • params: Record<string, any>

    Returns Record<string, any>

  • Internal

    Returns Record<string, any>

  • Internal

    Returns string

\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.ODataRequest.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.ODataRequest.html index 6f861632dd..9e57a14284 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.ODataRequest.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.ODataRequest.html @@ -1,52 +1,52 @@ -ODataRequest | SAP Cloud SDK for JavaScript - v3.12.1

OData request configuration for an entity type.

+ODataRequest | SAP Cloud SDK for JavaScript - v3.12.0

OData request configuration for an entity type.

Type Param: EntityT

Type of the entity to setup a request for.

-

Type Parameters

Constructors

Properties

Accessors

  • get destination(): undefined | HttpDestination
  • Returns undefined | HttpDestination

  • set destination(dest): void
  • Parameters

    Returns void

Methods

  • Get all custom headers.

    +

Type Parameters

Constructors

Properties

Accessors

  • get destination(): undefined | HttpDestination
  • Returns undefined | HttpDestination

  • set destination(dest): void
  • Parameters

    Returns void

Methods

  • Get all custom headers.

    Returns Record<string, any>

    Key-value pairs where the key is the name of a header property and the value is the respective value.

    -
  • Get all default headers. If custom headers are set, those take precedence.

    +
  • Get all default headers. If custom headers are set, those take precedence.

    Returns Record<string, any>

    Key-value pairs where the key is the name of a header property and the value is the respective value.

    -
  • Get the eTag related headers, e.g. if-match.

    +
  • Get the eTag related headers, e.g. if-match.

    Returns Record<string, any>

    Key-value pairs where the key is the name of a header property and the value is the respective value.

    -
  • Execute the given request and return the according promise.

    +
  • Execute the given request and return the according promise.

    Returns Promise<HttpResponse>

    Promise resolving to the requested data.

    -
  • Create object containing all headers, including custom headers for the given request.

    +
  • Create object containing all headers, including custom headers for the given request.

    Returns Promise<OriginOptions>

    Key-value pairs where the key is the name of a header property and the value is the respective value.

    -
  • Specifies whether the destination needs a specific authentication or not.

    +
  • Specifies whether the destination needs a specific authentication or not.

    Returns boolean

    A boolean value that specifies whether the destination needs authentication or not.

    -
  • Get query parameters as string. Leads with ? if there are parameters to return.

    +
  • Get query parameters as string. Leads with ? if there are parameters to return.

    Returns string

    Query parameter string.

    -
  • Returns the relative URL to a specific OData resource.

    -

    Parameters

    • Optional includeBasePath: boolean

      Whether or not to include the base path in the URL.

      +
  • Returns the relative URL to a specific OData resource.

    +

    Parameters

    • Optional includeBasePath: boolean

      Whether or not to include the base path in the URL.

    Returns string

    The relative URL of the resource.

    -
  • Returns the service URL relative to the url of the destination for a given OData request.

    +
  • Returns the service URL relative to the url of the destination for a given OData request.

    Returns string

    The relative URL of the service the given entity belongs to.

    -
  • Constructs a URL relative to the destination.

    -

    Parameters

    • Optional includeBasePath: boolean

      Whether or not to include the base path in the URL.

      -
    • Optional includeQueryParameters: boolean

      Whether or not to include the query parameters in the URL.

      +
  • Constructs a URL relative to the destination.

    +

    Parameters

    • Optional includeBasePath: boolean

      Whether or not to include the base path in the URL.

      +
    • Optional includeQueryParameters: boolean

      Whether or not to include the query parameters in the URL.

    Returns string

    The relative URL for the request.

    -
  • Returns the URL to a specific OData .resource, i.e. the entity collection.

    +
  • Returns the URL to a specific OData .resource, i.e. the entity collection.

    Returns string

    The URL of the resource.

    -
  • Returns the service URL for a given OData request.

    +
  • Returns the service URL for a given OData request.

    Returns string

    The URL of the service the given entity belongs to.

    -
  • Constructs an absolute URL for the given request.

    +
  • Constructs an absolute URL for the given request.

    Returns string

    The absolute URL for the request.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.ODataRequestConfig.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.ODataRequestConfig.html index 4cf9843a45..833cb5b47e 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.ODataRequestConfig.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.ODataRequestConfig.html @@ -1,33 +1,33 @@ -ODataRequestConfig | SAP Cloud SDK for JavaScript - v3.12.1

Parent class for all OData request configs like getAll, delete or count.

-

Hierarchy (view full)

Constructors

  • Creates an instance of ODataRequest.

    -

    Parameters

    • method: RequestMethodType

      HTTP method of the request.

      -
    • defaultBasePath: string

      Default path of the according service.

      -
    • Optional defaultHeaders: Record<string, any>

      The default headers of the given request as an object.

      -

    Returns ODataRequestConfig

Properties

basePath: string
defaultBasePath: string
defaultHeaders: Record<string, any>
parameterEncoder: ParameterEncoder
payload: string | Record<string, any>

Accessors

  • get appendedPaths(): string[]
  • Returns string[]

  • get customHeaders(): Record<string, string>
  • Returns Record<string, string>

  • set customHeaders(headers): void
  • Parameters

    • headers: Record<string, string>

    Returns void

  • get customQueryParameters(): Record<string, string>
  • Returns Record<string, string>

  • set customQueryParameters(queryParameters): void
  • Parameters

    • queryParameters: Record<string, string>

    Returns void

  • get customRequestConfiguration(): Record<string, string>
  • Returns Record<string, string>

  • set customRequestConfiguration(requestConfiguration): void
  • Parameters

    • requestConfiguration: Record<string, string>

    Returns void

  • get fetchCsrfToken(): boolean
  • Returns boolean

  • set fetchCsrfToken(fetchCsrfToken): void
  • Parameters

    • fetchCsrfToken: boolean

    Returns void

  • get middlewares(): HttpMiddleware[]
  • Returns HttpMiddleware[]

  • set middlewares(middlewares): void
  • Parameters

    Returns void

Methods

  • Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.

    -

    Parameters

    • headers: Record<string, string>

      Key-value pairs where the key is the name of a header property and the value is the respective value.

      -

    Returns void

  • Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.

    -

    Parameters

    • queryParameters: Record<string, string>

      Key-value pairs where the key is the name of a query parameter and the value is the respective value.

      -

    Returns void

  • Add custom request configuration to the request.

    -

    Parameters

    • requestConfiguration: Record<string, any>

      Key-value pairs where the key is the name of a request configuration and the value is the respective value.

      +ODataRequestConfig | SAP Cloud SDK for JavaScript - v3.12.0

      Parent class for all OData request configs like getAll, delete or count.

      +

      Hierarchy (view full)

      Constructors

      • Creates an instance of ODataRequest.

        +

        Parameters

        • method: RequestMethodType

          HTTP method of the request.

          +
        • defaultBasePath: string

          Default path of the according service.

          +
        • Optional defaultHeaders: Record<string, any>

          The default headers of the given request as an object.

          +

        Returns ODataRequestConfig

      Properties

      basePath: string
      defaultBasePath: string
      defaultHeaders: Record<string, any>
      parameterEncoder: ParameterEncoder
      payload: string | Record<string, any>

      Accessors

      • get appendedPaths(): string[]
      • Returns string[]

      • get customHeaders(): Record<string, string>
      • Returns Record<string, string>

      • set customHeaders(headers): void
      • Parameters

        • headers: Record<string, string>

        Returns void

      • get customQueryParameters(): Record<string, string>
      • Returns Record<string, string>

      • set customQueryParameters(queryParameters): void
      • Parameters

        • queryParameters: Record<string, string>

        Returns void

      • get customRequestConfiguration(): Record<string, string>
      • Returns Record<string, string>

      • set customRequestConfiguration(requestConfiguration): void
      • Parameters

        • requestConfiguration: Record<string, string>

        Returns void

      • get fetchCsrfToken(): boolean
      • Returns boolean

      • set fetchCsrfToken(fetchCsrfToken): void
      • Parameters

        • fetchCsrfToken: boolean

        Returns void

      • get middlewares(): HttpMiddleware[]
      • Returns HttpMiddleware[]

      • set middlewares(middlewares): void
      • Parameters

        Returns void

      Methods

      • Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.

        +

        Parameters

        • headers: Record<string, string>

          Key-value pairs where the key is the name of a header property and the value is the respective value.

          +

        Returns void

      • Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.

        +

        Parameters

        • queryParameters: Record<string, string>

          Key-value pairs where the key is the name of a query parameter and the value is the respective value.

          +

        Returns void

      • Add custom request configuration to the request.

        +

        Parameters

        • requestConfiguration: Record<string, string>

          Key-value pairs where the key is the name of a request configuration and the value is the respective value.

          Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

          -

        Returns void

      • Parameters

        • Rest ...path: string[]

        Returns void

      • Parameters

        • params: Record<string, any>

        Returns Record<string, any>

      • Internal

        Returns Record<string, any>

      • Internal

        Returns string

      \ No newline at end of file +

    Returns void

  • Parameters

    • Rest ...path: string[]

    Returns void

  • Parameters

    • params: Record<string, any>

    Returns Record<string, any>

  • Internal

    Returns Record<string, any>

  • Internal

    Returns string

\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.ODataUpdateRequestConfig.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.ODataUpdateRequestConfig.html index fe3ea2aff6..a97aa56b46 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.ODataUpdateRequestConfig.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.ODataUpdateRequestConfig.html @@ -1,41 +1,41 @@ -ODataUpdateRequestConfig | SAP Cloud SDK for JavaScript - v3.12.1

Class ODataUpdateRequestConfig<EntityT, DeSerializersT>

OData update request configuration for an entity type.

-

Type Parameters

Hierarchy (view full)

Implements

Constructors

Properties

basePath: string
defaultBasePath: string
defaultHeaders: Record<string, any>
eTag: string

Version identifier.

-
keys: Record<string, any>

Map containing the key name and value.

-
parameterEncoder: ParameterEncoder
payload: string | Record<string, any>
versionIdentifierIgnored: boolean

Ignore the version identifier if set to true.

-

Accessors

  • get appendedPaths(): string[]
  • Returns string[]

  • get customHeaders(): Record<string, string>
  • Returns Record<string, string>

  • set customHeaders(headers): void
  • Parameters

    • headers: Record<string, string>

    Returns void

  • get customQueryParameters(): Record<string, string>
  • Returns Record<string, string>

  • set customQueryParameters(queryParameters): void
  • Parameters

    • queryParameters: Record<string, string>

    Returns void

  • get customRequestConfiguration(): Record<string, string>
  • Returns Record<string, string>

  • set customRequestConfiguration(requestConfiguration): void
  • Parameters

    • requestConfiguration: Record<string, string>

    Returns void

  • get fetchCsrfToken(): boolean
  • Returns boolean

  • set fetchCsrfToken(fetchCsrfToken): void
  • Parameters

    • fetchCsrfToken: boolean

    Returns void

  • get middlewares(): HttpMiddleware[]
  • Returns HttpMiddleware[]

  • set middlewares(middlewares): void
  • Parameters

    Returns void

Methods

  • Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.

    -

    Parameters

    • headers: Record<string, string>

      Key-value pairs where the key is the name of a header property and the value is the respective value.

      -

    Returns void

  • Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.

    -

    Parameters

    • queryParameters: Record<string, string>

      Key-value pairs where the key is the name of a query parameter and the value is the respective value.

      -

    Returns void

  • Add custom request configuration to the request.

    -

    Parameters

    • requestConfiguration: Record<string, any>

      Key-value pairs where the key is the name of a request configuration and the value is the respective value.

      +ODataUpdateRequestConfig | SAP Cloud SDK for JavaScript - v3.12.0

      Class ODataUpdateRequestConfig<EntityT, DeSerializersT>

      OData update request configuration for an entity type.

      +

      Type Parameters

      Hierarchy (view full)

      Implements

      Constructors

      Properties

      basePath: string
      defaultBasePath: string
      defaultHeaders: Record<string, any>
      eTag: string

      Version identifier.

      +
      keys: Record<string, any>

      Map containing the key name and value.

      +
      parameterEncoder: ParameterEncoder
      payload: string | Record<string, any>
      versionIdentifierIgnored: boolean

      Ignore the version identifier if set to true.

      +

      Accessors

      • get appendedPaths(): string[]
      • Returns string[]

      • get customHeaders(): Record<string, string>
      • Returns Record<string, string>

      • set customHeaders(headers): void
      • Parameters

        • headers: Record<string, string>

        Returns void

      • get customQueryParameters(): Record<string, string>
      • Returns Record<string, string>

      • set customQueryParameters(queryParameters): void
      • Parameters

        • queryParameters: Record<string, string>

        Returns void

      • get customRequestConfiguration(): Record<string, string>
      • Returns Record<string, string>

      • set customRequestConfiguration(requestConfiguration): void
      • Parameters

        • requestConfiguration: Record<string, string>

        Returns void

      • get fetchCsrfToken(): boolean
      • Returns boolean

      • set fetchCsrfToken(fetchCsrfToken): void
      • Parameters

        • fetchCsrfToken: boolean

        Returns void

      • get middlewares(): HttpMiddleware[]
      • Returns HttpMiddleware[]

      • set middlewares(middlewares): void
      • Parameters

        Returns void

      Methods

      • Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.

        +

        Parameters

        • headers: Record<string, string>

          Key-value pairs where the key is the name of a header property and the value is the respective value.

          +

        Returns void

      • Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.

        +

        Parameters

        • queryParameters: Record<string, string>

          Key-value pairs where the key is the name of a query parameter and the value is the respective value.

          +

        Returns void

      • Add custom request configuration to the request.

        +

        Parameters

        • requestConfiguration: Record<string, string>

          Key-value pairs where the key is the name of a request configuration and the value is the respective value.

          Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

          -

        Returns void

      • Parameters

        • Rest ...path: string[]

        Returns void

      • Parameters

        • params: Record<string, any>

        Returns Record<string, any>

      • Internal

        Returns Record<string, any>

      • Internal

        Returns string

      • Returns void

      \ No newline at end of file +

    Returns void

  • Parameters

    • Rest ...path: string[]

    Returns void

  • Parameters

    • params: Record<string, any>

    Returns Record<string, any>

  • Internal

    Returns Record<string, any>

  • Internal

    Returns string

  • Returns void

\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.OneToManyLink.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.OneToManyLink.html index 085e72100d..46c0a45415 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.OneToManyLink.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.OneToManyLink.html @@ -1,49 +1,49 @@ -OneToManyLink | SAP Cloud SDK for JavaScript - v3.12.1

Class OneToManyLink<EntityT, DeSerializersT, LinkedEntityApiT>

Represents a one to many relation for OData v4 entities. +OneToManyLink | SAP Cloud SDK for JavaScript - v3.12.0

Class OneToManyLink<EntityT, DeSerializersT, LinkedEntityApiT>

Represents a one to many relation for OData v4 entities. For OData v2 entities the Link is used to represent one to many relation. See Link for more information.

-

Type Parameters

Hierarchy (view full)

Constructors

Properties

_deSerializers: DeSerializersT

Dummy property to also include the deserializer type in the structure of the entity type.

-
_entity: EntityT

Dummy property whose type makes structurally identical entities distinguishable in TypeScript.

-
_fieldName: string
_linkedEntityApi: LinkedEntityApiT

List of selectables on the linked entity.

-
_skip: number
_top: number

Methods

  • Create a new link based on a given link.

    +

Type Parameters

Hierarchy (view full)

Constructors

Properties

_deSerializers: DeSerializersT

Dummy property to also include the deserializer type in the structure of the entity type.

+
_entity: EntityT

Dummy property whose type makes structurally identical entities distinguishable in TypeScript.

+
_fieldName: string
_linkedEntityApi: LinkedEntityApiT

List of selectables on the linked entity.

+
_skip: number
_top: number

Methods

  • Create a new link based on a given link.

    Returns this

    Newly created link.

    -
  • Add order-by statements to the request.

    -

    Parameters

    • Rest ...orderBy: Orderable<EntityType<LinkedEntityApiT>>[]

      OrderBy statements to order the response by.

      +
  • Add order-by statements to the request.

    +

    Parameters

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Skip number of entities.

    -

    Parameters

    • skip: number

      Number of matching entities to skip. Useful for paging.

      +
  • Skip number of entities.

    +

    Parameters

    • skip: number

      Number of matching entities to skip. Useful for paging.

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Number of returned entities.

    -

    Parameters

    • top: number

      Maximum number of entities to return in the response. Can be less, if less entities match the request.

      +
  • Number of returned entities.

    +

    Parameters

    • top: number

      Maximum number of entities to return in the response. Can be less, if less entities match the request.

    Returns this

    The request builder itself, to facilitate method chaining.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.OneToOneLink.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.OneToOneLink.html index 81d8c0899d..39dc9daeaf 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.OneToOneLink.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.OneToOneLink.html @@ -1,43 +1,43 @@ -OneToOneLink | SAP Cloud SDK for JavaScript - v3.12.1

Class OneToOneLink<EntityT, DeSerializersT, LinkedEntityApiT>

Represents a link from one entity to one other linked entity (as opposed to a list of linked entities). In OData v2 a OneToOneLink can be used to filter and order a selection on an entity based on filters and orders on a linked entity.

+OneToOneLink | SAP Cloud SDK for JavaScript - v3.12.0

Class OneToOneLink<EntityT, DeSerializersT, LinkedEntityApiT>

Represents a link from one entity to one other linked entity (as opposed to a list of linked entities). In OData v2 a OneToOneLink can be used to filter and order a selection on an entity based on filters and orders on a linked entity.

Type Param: LinkedEntityT

Type of the entity to be linked to.

-

Type Parameters

Hierarchy (view full)

Constructors

Properties

_deSerializers: DeSerializersT

Dummy property to also include the deserializer type in the structure of the entity type.

-
_entity: EntityT

Dummy property whose type makes structurally identical entities distinguishable in TypeScript.

-
_fieldName: string
_linkedEntityApi: LinkedEntityApiT

List of selectables on the linked entity.

-

Filterables to apply to the given entity based on the linked entity.

-

List of criteria of the linked entity to order the given entity by with descending priority.

-

Methods

  • Create a new link based on a given link.

    +

Type Parameters

Hierarchy (view full)

Constructors

Properties

_deSerializers: DeSerializersT

Dummy property to also include the deserializer type in the structure of the entity type.

+
_entity: EntityT

Dummy property whose type makes structurally identical entities distinguishable in TypeScript.

+
_fieldName: string
_linkedEntityApi: LinkedEntityApiT

List of selectables on the linked entity.

+

Filterables to apply to the given entity based on the linked entity.

+

List of criteria of the linked entity to order the given entity by with descending priority.

+

Methods

  • Create a new link based on a given link.

    Returns this

    Newly created link.

    -
  • Create order statements for the OData request based on the linked entity. The given statements have descending priority.

    -

    Parameters

  • Create order statements for the OData request based on the linked entity. The given statements have descending priority.

    +

    Parameters

    Returns OrderLink<EntityT, LinkedEntityApiT>

    Newly created order link.

    Example

    Entity.requestBuilder()
    .getAll()
    .orderBy(Entity.TO_LINKED_ENTITY.orderBy(asc(LinkedEntity.PROPERTY1), desc(LinkedEntity.PROPERTY2)));
    -
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.OperationParameter.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.OperationParameter.html index bf9a8d16c2..933fa3c6e8 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.OperationParameter.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.OperationParameter.html @@ -1,12 +1,12 @@ -OperationParameter | SAP Cloud SDK for JavaScript - v3.12.1

Internal representation of operation parameters. It adds metadata to the value.

-

Type Parameters

  • ValueT

    Type of the value.

    -

Constructors

Properties

Constructors

Properties

originalName: string
value: ValueT
\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.OperationRequestBuilderBase.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.OperationRequestBuilderBase.html index 18d90445fc..033ac633e0 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.OperationRequestBuilderBase.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.OperationRequestBuilderBase.html @@ -1,68 +1,68 @@ -OperationRequestBuilderBase | SAP Cloud SDK for JavaScript - v3.12.1

Class OperationRequestBuilderBase<DeSerializersT, ReturnT, RequestConfigT>Abstract

Create OData request to execute an action or function.

-

Type Parameters

  • DeSerializersT extends DeSerializers

    Type of the (de-)serializers.

    -
  • ReturnT

    Type of the function return value.

    -
  • RequestConfigT extends ODataRequestConfig

    Type of the request config.

    -

Hierarchy (view full)

Implements

Constructors

Properties

_deSerializers: DeSerializersT
requestConfig: RequestConfigT
responseTransformer: ((data) => ReturnT)

Type declaration

Methods

  • Add custom headers to the request. Existing headers will be overwritten.

    -

    Parameters

    • headers: Record<string, string>

      Key-value pairs denoting additional custom headers.

      +OperationRequestBuilderBase | SAP Cloud SDK for JavaScript - v3.12.0

      Class OperationRequestBuilderBase<DeSerializersT, ReturnT, RequestConfigT>Abstract

      Create OData request to execute an action or function.

      +

      Type Parameters

      • DeSerializersT extends DeSerializers

        Type of the (de-)serializers.

        +
      • ReturnT

        Type of the function return value.

        +
      • RequestConfigT extends ODataRequestConfig

        Type of the request config.

        +

      Hierarchy (view full)

      Implements

      Constructors

      Properties

      _deSerializers: DeSerializersT
      requestConfig: RequestConfigT
      responseTransformer: ((data) => ReturnT)

      Type declaration

      Methods

      • Add custom headers to the request. Existing headers will be overwritten.

        +

        Parameters

        • headers: Record<string, string>

          Key-value pairs denoting additional custom headers.

        Returns this

        The request builder itself, to facilitate method chaining.

        -
      • Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.

        -

        Parameters

        • queryParameters: Record<string, string>

          Key-value pairs denoting additional custom query parameters to be set in the request.

          +
      • Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.

        +

        Parameters

        • queryParameters: Record<string, string>

          Key-value pairs denoting additional custom query parameters to be set in the request.

        Returns this

        The request builder itself, to facilitate method chaining.

        -
      • Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. +

      • Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. If the custom request configuration contains disallowed keys, those will be ignored.

        -

        Parameters

        • requestConfiguration: Record<string, any>

          Key-value pairs denoting additional custom request configuration options to be set in the request.

          +

          Parameters

          • requestConfiguration: Record<string, string>

            Key-value pairs denoting additional custom request configuration options to be set in the request.

          Returns this

          The request builder itself, to facilitate method chaining.

          -
      • Append the given path to the URL. This can be used for querying navigation properties of an entity. To execute a request with an appended path use executeRaw to avoid errors during deserialization. When using this, the execute method is omitted from the return type.

        -

        Parameters

        • Rest ...path: string[]

          Path to be appended.

          +

          Parameters

          • Rest ...path: string[]

            Path to be appended.

          Returns Omit<OperationRequestBuilderBase<DeSerializersT, ReturnT, RequestConfigT>, "execute">

          The request builder itself without "execute" function, to facilitate method chaining.

          -
      • Execute request.

        -

        Parameters

        • destination: HttpDestinationOrFetchOptions

          Destination or DestinationFetchOptions to execute the request against.

          -
        • Optional dataAccessor: ((data) => any)

          A function to modify the received response data.

          -
            • (data): any
            • Parameters

              • data: any

              Returns any

        Returns Promise<ReturnT>

        A promise resolving to the requested return type.

        -
      • Execute request.

        +

        Parameters

        • destination: HttpDestinationOrFetchOptions

          Destination or DestinationFetchOptions to execute the request against.

          +
        • Optional dataAccessor: ((data) => any)

          A function to modify the received response data.

          +
            • (data): any
            • Parameters

              • data: any

              Returns any

        Returns Promise<ReturnT>

        A promise resolving to the requested return type.

        +
      • Gets identifier for the batch request.

        +
      • Set middleware for requests towards the target system given in the destination.

        -

        Parameters

      • Set middleware for requests towards the target system given in the destination.

        +

        Parameters

        Returns this

        The request builder itself, to facilitate method chaining.

        -
      • Parameters

        Returns this

      • Create the relative URL based on configuration of the given builder.

        +
      • Parameters

        Returns this

      • Create the relative URL based on configuration of the given builder.

        Returns string

        The relative URL for the request.

        -
      • Replace the default service path with the given custom path. +

      • Replace the default service path with the given custom path. In case of the SAP S/4HANA APIs the basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.

        -

        Parameters

        • basePath: string

          Path to override the default with.

          +

          Parameters

          • basePath: string

            Path to override the default with.

          Returns this

          The request builder itself, to facilitate method chaining.

          -
      • Sets user-defined identifier for the batch reference.

        -

        Parameters

        • id: string

          User-defined batch request identifier.

          -

        Returns void

      • Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.

        +
      • Sets user-defined identifier for the batch reference.

        +

        Parameters

        • id: string

          User-defined batch request identifier.

          +

        Returns void

      • Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.

        Returns this

        The request builder itself, to facilitate method chaining.

        -
      • Create the URL based on configuration of the given builder.

        -

        Parameters

        • destination: HttpDestinationOrFetchOptions

          Destination or DestinationFetchOptions to execute the request against.

          +
      • Create the URL based on configuration of the given builder.

        +

        Parameters

        Returns Promise<string>

        Promise resolving to the URL for the request.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.Order.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.Order.html index d3933a14ee..c54e3bc827 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.Order.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.Order.html @@ -1,14 +1,14 @@ -Order | SAP Cloud SDK for JavaScript - v3.12.1

OData queries take this to determine the order of results.

-

Type Parameters

Implements

Constructors

  • Creates an instance of Order.

    -

    Type Parameters

    Parameters

    • _fieldName: string

      Field to order by.

      -
    • Optional orderType: OrderType

      Type of ordering, can be 'asc' for ascending or 'desc' for descending.

      -

    Returns Order<EntityT>

Properties

_deSerializers: any

Dummy property to also include the deserializer type in the structure of the entity type.

-
_entity: EntityT

Dummy property whose type makes structurally identical entities distinguishable in TypeScript.

+Order | SAP Cloud SDK for JavaScript - v3.12.0

OData queries take this to determine the order of results.

+

Type Parameters

Implements

Constructors

  • Creates an instance of Order.

    +

    Type Parameters

    Parameters

    • _fieldName: string

      Field to order by.

      +
    • Optional orderType: OrderType

      Type of ordering, can be 'asc' for ascending or 'desc' for descending.

      +

    Returns Order<EntityT>

Properties

_deSerializers: any

Dummy property to also include the deserializer type in the structure of the entity type.

+
_entity: EntityT

Dummy property whose type makes structurally identical entities distinguishable in TypeScript.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
_entityConstructor: Constructable<EntityT>
_fieldName: string
orderType: OrderType
\ No newline at end of file +
_entityConstructor: Constructable<EntityT>
_fieldName: string
orderType: OrderType
\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.OrderLink.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.OrderLink.html index 6ad0f3f354..d55923fc70 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.OrderLink.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.OrderLink.html @@ -1,13 +1,13 @@ -OrderLink | SAP Cloud SDK for JavaScript - v3.12.1

Link to represent an order by on a linked entity.

+OrderLink | SAP Cloud SDK for JavaScript - v3.12.0

Link to represent an order by on a linked entity.

Type Param: LinkedEntityT

Type of the entity to link to.

-

Type Parameters

Constructors

Properties

Constructors

Type Parameters

Constructors

Properties

Constructors

Properties

entityType: EntityT
linkedEntityType: EntityType<LinkedEntityApiT>
\ No newline at end of file +

Returns OrderLink<EntityT, LinkedEntityApiT>

Properties

entityType: EntityT
linkedEntityType: EntityType<LinkedEntityApiT>
\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.OrderableEdmTypeField.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.OrderableEdmTypeField.html index a118d0808a..f933447ed0 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.OrderableEdmTypeField.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.OrderableEdmTypeField.html @@ -1,50 +1,50 @@ -OrderableEdmTypeField | SAP Cloud SDK for JavaScript - v3.12.1

Class OrderableEdmTypeField<EntityT, DeSerializersT, EdmT, NullableT, SelectableT>

EdmTypeField, that represents a property with an EDM type, that can be compared with greaterThan, greaterOrEqual, lessThan and lessOrEqual.

-

Type Parameters

  • EntityT extends EntityBase

    Type of the entity the field belongs to.

    -
  • DeSerializersT extends DeSerializers
  • EdmT extends EdmTypeShared<"any">

    EDM type of the field.

    -
  • NullableT extends boolean = false

    Boolean type that represents whether the field is nullable.

    -
  • SelectableT extends boolean = false

    Boolean type that represents whether the field is selectable.

    -

Hierarchy (view full)

Constructors

Properties

_deSerializers: DeSerializersT

Dummy property to also include the deserializer type in the structure of the entity type.

-
_entity: EntityT

Dummy property whose type makes structurally identical entities distinguishable in TypeScript.

-
_entityConstructor: Constructable<EntityT>
_fieldName: string
_fieldOptions: Required<FieldOptions<NullableT, SelectableT>>
edmType: EdmT

Methods

\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.RequestBuilder.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.RequestBuilder.html index ae89834851..ebe9531ea2 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.RequestBuilder.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.RequestBuilder.html @@ -1,9 +1,9 @@ -RequestBuilder | SAP Cloud SDK for JavaScript - v3.12.1

Class RequestBuilder<EntityT, DeSerializersT>Abstract

Represents a request builder for a given entity API.

-

Type Parameters

Implements

Constructors

Properties

Constructors

Properties

_deSerializers: DeSerializersT

Dummy property to also include the deserializer type in the structure of the entity type.

-
_entity: EntityT

Dummy property whose type makes structurally identical entities distinguishable in TypeScript.

+RequestBuilder | SAP Cloud SDK for JavaScript - v3.12.0

Class RequestBuilder<EntityT, DeSerializersT>Abstract

Represents a request builder for a given entity API.

+

Type Parameters

Implements

Constructors

Properties

Constructors

Properties

_deSerializers: DeSerializersT

Dummy property to also include the deserializer type in the structure of the entity type.

+
_entity: EntityT

Dummy property whose type makes structurally identical entities distinguishable in TypeScript.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.StringFilterFunction.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.StringFilterFunction.html index 1d746d89b8..423a2a843d 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.StringFilterFunction.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.StringFilterFunction.html @@ -1,34 +1,34 @@ -StringFilterFunction | SAP Cloud SDK for JavaScript - v3.12.1

Representation of a filter function, that returns a value of type string.

-

Type Parameters

Hierarchy

  • OrderableFilterFunction<EntityT, string>
    • StringFilterFunction

Constructors

  • Creates an instance of StringFilterFunction.

    -

    Type Parameters

    Parameters

    • functionName: string

      Name of the function that returns a string value.

      -
    • parameters: FilterFunctionParameterType<EntityT>[]

      Representation of the parameters passed to the filter function.

      -

    Returns StringFilterFunction<EntityT>

Properties

functionName: string

Methods

  • Creates an instance of Filter for this filter function and the given value using the operator 'eq', i.e. ==.

    -

    Parameters

    • value: string

      Value to be used in the filter.

      +StringFilterFunction | SAP Cloud SDK for JavaScript - v3.12.0

      Representation of a filter function, that returns a value of type string.

      +

      Type Parameters

      Hierarchy

      • OrderableFilterFunction<EntityT, string>
        • StringFilterFunction

      Constructors

      • Creates an instance of StringFilterFunction.

        +

        Type Parameters

        Parameters

        • functionName: string

          Name of the function that returns a string value.

          +
        • parameters: FilterFunctionParameterType<EntityT>[]

          Representation of the parameters passed to the filter function.

          +

        Returns StringFilterFunction<EntityT>

      Properties

      functionName: string

      Methods

      • Creates an instance of Filter for this filter function and the given value using the operator 'eq', i.e. ==.

        +

        Parameters

        • value: string

          Value to be used in the filter.

        Returns Filter<EntityT, any, string>

        The resulting filter.

        -
      • Creates an instance of Filter for this filter function and the given value using the operator 'ge', i.e. >=.

        -

        Parameters

        • value: string

          Value to be used in the filter.

          +
      • Creates an instance of Filter for this filter function and the given value using the operator 'ge', i.e. >=.

        +

        Parameters

        • value: string

          Value to be used in the filter.

        Returns Filter<EntityT, any, string>

        The resulting filter.

        -
      • Creates an instance of Filter for this filter function and the given value using the operator 'gt', i.e. >.

        -

        Parameters

        • value: string

          Value to be used in the filter.

          +
      • Creates an instance of Filter for this filter function and the given value using the operator 'gt', i.e. >.

        +

        Parameters

        • value: string

          Value to be used in the filter.

        Returns Filter<EntityT, any, string>

        The resulting filter.

        -
      • Creates an instance of Filter for this filter function and the given value using the operator 'le', i.e. <=.

        -

        Parameters

        • value: string

          Value to be used in the filter.

          +
      • Creates an instance of Filter for this filter function and the given value using the operator 'le', i.e. <=.

        +

        Parameters

        • value: string

          Value to be used in the filter.

        Returns Filter<EntityT, any, string>

        The resulting filter.

        -
      • Creates an instance of Filter for this filter function and the given value using the operator 'lt', i.e. <.

        -

        Parameters

        • value: string

          Value to be used in the filter.

          +
      • Creates an instance of Filter for this filter function and the given value using the operator 'lt', i.e. <.

        +

        Parameters

        • value: string

          Value to be used in the filter.

        Returns Filter<EntityT, any, string>

        The resulting filter.

        -
      • Creates an instance of Filter for this filter function and the given value using the operator 'ne', i.e. !=.

        -

        Parameters

        • value: string

          Value to be used in the filter.

          +
      • Creates an instance of Filter for this filter function and the given value using the operator 'ne', i.e. !=.

        +

        Parameters

        • value: string

          Value to be used in the filter.

        Returns Filter<EntityT, any, string>

        The resulting filter.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.UnaryFilter.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.UnaryFilter.html index 85497f49ce..a73ae053c2 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.UnaryFilter.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.UnaryFilter.html @@ -1,6 +1,6 @@ -UnaryFilter | SAP Cloud SDK for JavaScript - v3.12.1

Class representing a unary filter which is a filter containing just a single argument e.g. not.

-

Type Parameters

Constructors

Properties

operator -singleOperand +UnaryFilter | SAP Cloud SDK for JavaScript - v3.12.0

Class representing a unary filter which is a filter containing just a single argument e.g. not.

+

Type Parameters

Constructors

Properties

operator +singleOperand

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-

Constructors

Properties

operator: "not"
\ No newline at end of file +

Constructors

Properties

operator: "not"
\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.UpdateRequestBuilderBase.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.UpdateRequestBuilderBase.html index edeecc5f12..c061f43ee7 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.UpdateRequestBuilderBase.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_common.UpdateRequestBuilderBase.html @@ -1,93 +1,93 @@ -UpdateRequestBuilderBase | SAP Cloud SDK for JavaScript - v3.12.1

Class UpdateRequestBuilderBase<EntityT, DeSerializersT>Abstract

Abstract class to create OData query to update an entity containing methods shared for OData v2 and v4.

-

Type Parameters

Hierarchy (view full)

Implements

Constructors

  • Creates an instance of UpdateRequestBuilder.

    -

    Type Parameters

    • EntityT extends EntityBase
    • DeSerializersT extends DeSerializers<any, any, any, any, any, any, any, any, any, any, any, any, any, any>

    Parameters

    • _entityApi: EntityApi<EntityT, DeSerializersT>

      Entity API for building and executing the request.

      -
    • _entity: EntityT

      Entity to be updated.

      -
    • oDataUri: ODataUri<DeSerializersT>

      URI conversion functions.

      -
    • entitySerializer: EntitySerializer

      Entity serializer.

      -
    • extractODataEtag: ((json) => undefined | string)

      Extractor for ETag from payload.

      -
        • (json): undefined | string
        • Parameters

          • json: Record<string, any>

          Returns undefined | string

    • payloadManipulator: ((body) => Record<string, any>)

      Manipulator for the payload.

      -
        • (body): Record<string, any>
        • Parameters

          • body: Record<string, any>

          Returns Record<string, any>

    Returns UpdateRequestBuilderBase<EntityT, DeSerializersT>

Properties

_deSerializers: DeSerializersT

Dummy property to also include the deserializer type in the structure of the entity type.

-
_entity: EntityT

Dummy property whose type makes structurally identical entities distinguishable in TypeScript.

-
entitySerializer: EntitySerializer
extractODataEtag: ((json) => undefined | string)

Type declaration

    • (json): undefined | string
    • Parameters

      • json: Record<string, any>

      Returns undefined | string

payloadManipulator: ((body) => Record<string, any>)

Type declaration

    • (body): Record<string, any>
    • Parameters

      • body: Record<string, any>

      Returns Record<string, any>

Accessors

  • get entity(): EntityT
  • Returns EntityT

Methods

  • Add custom headers to the request. Existing headers will be overwritten.

    -

    Parameters

    • headers: Record<string, string>

      Key-value pairs denoting additional custom headers.

      +UpdateRequestBuilderBase | SAP Cloud SDK for JavaScript - v3.12.0

      Class UpdateRequestBuilderBase<EntityT, DeSerializersT>Abstract

      Abstract class to create OData query to update an entity containing methods shared for OData v2 and v4.

      +

      Type Parameters

      Hierarchy (view full)

      Implements

      Constructors

      • Creates an instance of UpdateRequestBuilder.

        +

        Type Parameters

        • EntityT extends EntityBase

        • DeSerializersT extends DeSerializers<any, any, any, any, any, any, any, any, any, any, any, any, any, any>

        Parameters

        • _entityApi: EntityApi<EntityT, DeSerializersT>

          Entity API for building and executing the request.

          +
        • _entity: EntityT

          Entity to be updated.

          +
        • oDataUri: ODataUri<DeSerializersT>

          URI conversion functions.

          +
        • entitySerializer: EntitySerializer

          Entity serializer.

          +
        • extractODataEtag: ((json) => undefined | string)

          Extractor for ETag from payload.

          +
            • (json): undefined | string
            • Parameters

              • json: Record<string, any>

              Returns undefined | string

        • payloadManipulator: ((body) => Record<string, any>)

          Manipulator for the payload.

          +
            • (body): Record<string, any>
            • Parameters

              • body: Record<string, any>

              Returns Record<string, any>

        Returns UpdateRequestBuilderBase<EntityT, DeSerializersT>

      Properties

      _deSerializers: DeSerializersT

      Dummy property to also include the deserializer type in the structure of the entity type.

      +
      _entity: EntityT

      Dummy property whose type makes structurally identical entities distinguishable in TypeScript.

      +
      entitySerializer: EntitySerializer
      extractODataEtag: ((json) => undefined | string)

      Type declaration

        • (json): undefined | string
        • Parameters

          • json: Record<string, any>

          Returns undefined | string

      payloadManipulator: ((body) => Record<string, any>)

      Type declaration

        • (body): Record<string, any>
        • Parameters

          • body: Record<string, any>

          Returns Record<string, any>

      Accessors

      • get entity(): EntityT
      • Returns EntityT

      Methods

      • Add custom headers to the request. Existing headers will be overwritten.

        +

        Parameters

        • headers: Record<string, string>

          Key-value pairs denoting additional custom headers.

        Returns this

        The request builder itself, to facilitate method chaining.

        -
      • Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.

        -

        Parameters

        • queryParameters: Record<string, string>

          Key-value pairs denoting additional custom query parameters to be set in the request.

          +
      • Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.

        +

        Parameters

        • queryParameters: Record<string, string>

          Key-value pairs denoting additional custom query parameters to be set in the request.

        Returns this

        The request builder itself, to facilitate method chaining.

        -
      • Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. +

      • Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. If the custom request configuration contains disallowed keys, those will be ignored.

        -

        Parameters

        • requestConfiguration: Record<string, any>

          Key-value pairs denoting additional custom request configuration options to be set in the request.

          +

          Parameters

          • requestConfiguration: Record<string, string>

            Key-value pairs denoting additional custom request configuration options to be set in the request.

          Returns this

          The request builder itself, to facilitate method chaining.

          -
      • Append the given path to the URL. +

      • Append the given path to the URL. This can be used for querying navigation properties of an entity. To execute a request with an appended path use executeRaw to avoid errors during deserialization. When using this, the execute method is omitted from the return type.

        -

        Parameters

        • Rest ...path: string[]

          Path to be appended.

          +

          Parameters

          • Rest ...path: string[]

            Path to be appended.

          Returns Omit<UpdateRequestBuilderBase<EntityT, DeSerializersT>, "execute">

          The request builder itself without "execute" function, to facilitate method chaining.

          -
      • Gets identifier for the batch request.

        +
      • Returns Record<string, any>

      • Instructs the request to force an overwrite of the entity by sending an 'If-Match: *' header instead of sending the ETag version identifier.

        +
      • Returns Record<string, any>

      • Instructs the request to force an overwrite of the entity by sending an 'If-Match: *' header instead of sending the ETag version identifier.

        Returns this

        The request itself to ease chaining while executing the request.

        -
      • Parameters

        • obj: any

        Returns boolean

      • Set middleware for requests towards the target system given in the destination.

        -

        Parameters

        • middlewares: HttpMiddleware | HttpMiddleware[]

          Middlewares to be applied to the executeHttpRequest().

          +
      • Parameters

        • obj: any

        Returns boolean

      • Set middleware for requests towards the target system given in the destination.

        +

        Parameters

        Returns this

        The request builder itself, to facilitate method chaining.

        -
      • Parameters

        Returns this

      • Create the relative URL based on configuration of the given builder.

        +
      • Parameters

        Returns this

      • Create the relative URL based on configuration of the given builder.

        Returns string

        The relative URL for the request.

        -
      • Explicitly configure 'PUT' as the method of the update request. By default, only the properties that have changed compared to the last known remote state are sent using 'PATCH', while with 'PUT', the whole entity is sent.

        +
      • Explicitly configure 'PUT' as the method of the update request. By default, only the properties that have changed compared to the last known remote state are sent using 'PATCH', while with 'PUT', the whole entity is sent.

        Returns this

        The entity itself, to facilitate method chaining.

        -
      • Replace the default service path with the given custom path. +

      • Replace the default service path with the given custom path. In case of the SAP S/4HANA APIs the basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.

        -

        Parameters

        • basePath: string

          Path to override the default with.

          +

          Parameters

          • basePath: string

            Path to override the default with.

          Returns this

          The request builder itself, to facilitate method chaining.

          -
      • Sets user-defined identifier for the batch reference.

        -

        Parameters

        • id: string

          User-defined batch request identifier.

          -

        Returns void

      • Sets entity fields to ignore by the update request.

        -

        Parameters

        • Rest ...fields: Selectable<EntityT, DeSerializersT>[]

          Enumeration of the fields to be ignored.

          +
      • Sets user-defined identifier for the batch reference.

        +

        Parameters

        • id: string

          User-defined batch request identifier.

          +

        Returns void

      • Sets entity fields to ignore by the update request.

        +

        Parameters

        Returns this

        The entity itself, to facilitate method chaining.

        -
      • Parameters

        Returns this

      • Sets required entity keys for the update request.

        -

        Parameters

        • Rest ...fields: Selectable<EntityT, DeSerializersT>[]

          Enumeration of the fields to be required.

          +
        • Parameters

          Returns this

      • Sets required entity keys for the update request.

        +

        Parameters

        Returns this

        The entity itself, to facilitate method chaining.

        -
      • Parameters

        Returns this

      • Sets ETag version identifier of the entity to update.

        -

        Parameters

        • etag: string

          Custom ETag version identifier to be sent in the header of the request.

          +
        • Parameters

          Returns this

      • Sets ETag version identifier of the entity to update.

        +

        Parameters

        • etag: string

          Custom ETag version identifier to be sent in the header of the request.

        Returns this

        The request itself to ease chaining while executing the request.

        -
      • Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.

        +
      • Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.

        Returns this

        The request builder itself, to facilitate method chaining.

        -
      • Create the URL based on configuration of the given builder.

        -

        Parameters

        • destination: HttpDestinationOrFetchOptions

          Destination or DestinationFetchOptions to execute the request against.

          +
      • Create the URL based on configuration of the given builder.

        +

        Parameters

        Returns Promise<string>

        Promise resolving to the URL for the request.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v2.CountRequestBuilder.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v2.CountRequestBuilder.html index 3dc4fdbdda..36b9d12399 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v2.CountRequestBuilder.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v2.CountRequestBuilder.html @@ -1,59 +1,59 @@ -CountRequestBuilder | SAP Cloud SDK for JavaScript - v3.12.1

Class CountRequestBuilder<EntityT, DeSerializersT>

Create an OData request to count entities based on the configuration of the request. +CountRequestBuilder | SAP Cloud SDK for JavaScript - v3.12.0

Class CountRequestBuilder<EntityT, DeSerializersT>

Create an OData request to count entities based on the configuration of the request. A CountRequestBuilder allows only for execution of the request. If you want to apply query parameters like filter, skip or top do it on the GetAllRequestBuilder the count is created from.

-

Type Parameters

Hierarchy (view full)

Constructors

Properties

Methods

  • Add custom headers to the request. Existing headers will be overwritten.

    -

    Parameters

    • headers: Record<string, string>

      Key-value pairs denoting additional custom headers.

      +

Type Parameters

Hierarchy (view full)

Constructors

Properties

Methods

  • Add custom headers to the request. Existing headers will be overwritten.

    +

    Parameters

    • headers: Record<string, string>

      Key-value pairs denoting additional custom headers.

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.

    -

    Parameters

    • queryParameters: Record<string, string>

      Key-value pairs denoting additional custom query parameters to be set in the request.

      +
  • Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.

    +

    Parameters

    • queryParameters: Record<string, string>

      Key-value pairs denoting additional custom query parameters to be set in the request.

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. +

  • Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. If the custom request configuration contains disallowed keys, those will be ignored.

    -

    Parameters

    • requestConfiguration: Record<string, any>

      Key-value pairs denoting additional custom request configuration options to be set in the request.

      +

      Parameters

      • requestConfiguration: Record<string, string>

        Key-value pairs denoting additional custom request configuration options to be set in the request.

      Returns this

      The request builder itself, to facilitate method chaining.

      -
  • Append the given path to the URL. This can be used for querying navigation properties of an entity. To execute a request with an appended path use executeRaw to avoid errors during deserialization. When using this, the execute method is omitted from the return type.

    -

    Parameters

    • Rest ...path: string[]

      Path to be appended.

      +

      Parameters

      • Rest ...path: string[]

        Path to be appended.

      Returns Omit<CountRequestBuilder<EntityT, DeSerializersT>, "execute">

      The request builder itself without "execute" function, to facilitate method chaining.

      -
  • Execute request.

    -

    Parameters

  • Execute request.

    +

    Parameters

    Returns Promise<number>

    A promise resolving to the number of entities.

    -
  • Set middleware for requests towards the target system given in the destination.

    -

    Parameters

  • Set middleware for requests towards the target system given in the destination.

    +

    Parameters

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Parameters

    Returns this

  • Create the relative URL based on configuration of the given builder.

    +
  • Parameters

    Returns this

  • Create the relative URL based on configuration of the given builder.

    Returns string

    The relative URL for the request.

    -
  • Replace the default service path with the given custom path. +

  • Replace the default service path with the given custom path. In case of the SAP S/4HANA APIs the basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.

    -

    Parameters

    • basePath: string

      Path to override the default with.

      +

      Parameters

      • basePath: string

        Path to override the default with.

      Returns this

      The request builder itself, to facilitate method chaining.

      -
  • Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.

    +
  • Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Create the URL based on configuration of the given builder.

    -

    Parameters

  • Create the URL based on configuration of the given builder.

    +

    Parameters

    Returns Promise<string>

    Promise resolving to the URL for the request.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v2.CreateRequestBuilder.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v2.CreateRequestBuilder.html index 2a76842673..f003a0edb7 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v2.CreateRequestBuilder.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v2.CreateRequestBuilder.html @@ -1,77 +1,77 @@ -CreateRequestBuilder | SAP Cloud SDK for JavaScript - v3.12.1

Class CreateRequestBuilder<EntityT, DeSerializersT>

Create OData request to create an entity.

-

Type Parameters

Hierarchy (view full)

Implements

Constructors

Properties

_deSerializers: DeSerializersT

Dummy property to also include the deserializer type in the structure of the entity type.

-
_entity: EntityT

Dummy property whose type makes structurally identical entities distinguishable in TypeScript.

-
deserializer: EntityDeserializer
responseDataAccessor: ResponseDataAccessor
serializer: EntitySerializer

Accessors

  • get entity(): EntityT
  • Returns EntityT

Methods

\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v2.CustomField.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v2.CustomField.html index d3f681cc87..287b2dfaf1 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v2.CustomField.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v2.CustomField.html @@ -1,27 +1,27 @@ -CustomField | SAP Cloud SDK for JavaScript - v3.12.1

Class CustomField<EntityT, DeSerializersT, NullableT>

If your entity contains fields not present in your service specification you can model them using custom fields. +CustomField | SAP Cloud SDK for JavaScript - v3.12.0

Class CustomField<EntityT, DeSerializersT, NullableT>

If your entity contains fields not present in your service specification you can model them using custom fields. Alternatively you can also generate a client based on a service specification containing all fields.

-

Type Parameters

Hierarchy (view full)

Constructors

Properties

_entityConstructor: Constructable<EntityT>
_fieldName: string
_fieldOptions: Required<FieldOptions<NullableT, false>>

Methods

  • Path to the field to be used in filter and order by queries.

    +

Type Parameters

Hierarchy (view full)

Constructors

Properties

_entityConstructor: Constructable<EntityT>
_fieldName: string
_fieldOptions: Required<FieldOptions<NullableT, false>>

Methods

  • Path to the field to be used in filter and order by queries.

    Returns string

    Path to the field to be used in filter and order by queries.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v2.DeleteRequestBuilder.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v2.DeleteRequestBuilder.html index a7798b65bf..3a252ea6ba 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v2.DeleteRequestBuilder.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v2.DeleteRequestBuilder.html @@ -1,74 +1,74 @@ -DeleteRequestBuilder | SAP Cloud SDK for JavaScript - v3.12.1

Class DeleteRequestBuilder<EntityT, DeSerializersT>

Create OData query to delete an entity.

-

Type Parameters

Hierarchy (view full)

Constructors

Properties

_deSerializers: DeSerializersT

Dummy property to also include the deserializer type in the structure of the entity type.

-
_entity: EntityT

Dummy property whose type makes structurally identical entities distinguishable in TypeScript.

-

Methods

\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v2.Entity.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v2.Entity.html index cbd45c94f9..19caeda819 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v2.Entity.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v2.Entity.html @@ -1,80 +1,80 @@ -Entity | SAP Cloud SDK for JavaScript - v3.12.1

Super class for all representations of OData v2 entity types.

-

Hierarchy (view full)

Constructors

Properties

_customFields: Record<string, any>

A mapper representing custom fields in an entity. +Entity | SAP Cloud SDK for JavaScript - v3.12.0

Super class for all representations of OData v2 entity types.

+

Hierarchy (view full)

Constructors

Properties

_customFields: Record<string, any>

A mapper representing custom fields in an entity. Custom fields are represented by their field names and the corresponding values. A custom field can be added or updated using setCustomField method.

-
_entityApi: any
_oDataVersion: "v2"
_versionIdentifier: string

The current ETag version of the entity in the remote system. +

_entityApi: any
_oDataVersion: "v2"
_versionIdentifier: string

The current ETag version of the entity in the remote system. The ETag identified the version of the in the remote system. It will be automatically set in the "if-match" header of update requests and can be set as a custom header for delete requests. When no ETag is provided by the remote system the value of this variable defaults to "*".

-
remoteState: {
    [keys: string]: any;
}

The remote state of the entity. +

remoteState: {
    [keys: string]: any;
}

The remote state of the entity. Remote state refers to the last known state of the entity on the remote system from which it has been retrieved or to which it has been posted. It is stored as map, where the keys are stored in the format of the original OData properties.

-

Type declaration

  • [keys: string]: any
_defaultBasePath: string
_entityName: string
_serviceName: string

Accessors

  • get versionIdentifier(): string
  • ETag version identifier accessor.

    +

    Type declaration

    • [keys: string]: any
_defaultBasePath: string
_entityName: string
_serviceName: string

Accessors

  • get versionIdentifier(): string
  • ETag version identifier accessor.

    Returns string

    The ETag version identifier of the retrieved entity, returns undefined if not retrieved.

    -

Methods

  • Creates an object containing all defined properties, navigation properties and custom fields in the entity.

    -

    Parameters

    • Optional visitedEntities: EntityBase[]

      List of entities to check in case of circular dependencies.

      +

Methods

  • Creates an object containing all defined properties, navigation properties and custom fields in the entity.

    +

    Parameters

    • Optional visitedEntities: EntityBase[]

      List of entities to check in case of circular dependencies.

    Returns Record<string, any>

    EntityBase as an object with all defined entity fields.

    -
  • Parameters

    Returns any

  • Custom field value getter.

    -

    Parameters

    • fieldName: string

      The name of the custom field.

      +
  • Parameters

    Returns any

  • Custom field value getter.

    +

    Parameters

    • fieldName: string

      The name of the custom field.

    Returns any

    The value of the corresponding custom field.

    -
  • Returns a map that contains all entity custom fields.

    +
  • Returns a map that contains all entity custom fields.

    Returns Record<string, any>

    A map of all defined custom fields in the entity.

    -
  • Returns all updated custom field properties compared to the last known remote state.

    +
  • Returns all updated custom field properties compared to the last known remote state.

    Returns Record<string, any>

    An object containing all updated custom properties, with their new values.

    -
  • Returns all changed properties compared to the last known remote state. +

  • Returns all changed properties compared to the last known remote state. The returned properties do not include custom fields. Use getUpdatedCustomFields, if you need custom fields.

    Returns Record<string, any>

    EntityBase with all properties that changed.

    -
  • Returns all changed property names compared to the last known remote state. +

  • Returns all changed property names compared to the last known remote state. The returned properties names do not include custom fields. Use getUpdatedCustomFields, if you need custom fields.

    Returns string[]

    EntityBase with all properties that changed.

    -
  • Validates whether a custom field exists in the entity.

    -

    Parameters

    • fieldName: string

      The name of the custom field to update.

      +
  • Validates whether a custom field exists in the entity.

    +

    Parameters

    • fieldName: string

      The name of the custom field to update.

    Returns boolean

    A boolean value, that indicates whether a custom field is defined in entity.

    -
  • Validates whether a field name does not conflict with an original field name and thus can be defined as custom fields.

    -

    Parameters

    • customFieldName: string

      Field name to check.

      +
  • Validates whether a field name does not conflict with an original field name and thus can be defined as custom fields.

    +

    Parameters

    • customFieldName: string

      Field name to check.

    Returns boolean

    Boolean value that describes whether a field name can be defined as custom field.

    -
  • Sets a new custom field in the entity or updates it. +

  • Sets a new custom field in the entity or updates it. Throws an error, if the provided custom field name is already defined by an original field in entity.

    -

    Parameters

    • fieldName: string

      The name of the custom field to update.

      -
    • value: any

      The value of the field.

      +

      Parameters

      • fieldName: string

        The name of the custom field to update.

        +
      • value: any

        The value of the field.

      Returns this

      The entity itself, to facilitate method chaining.

      -
  • Sets custom fields on an entity.

    -

    Parameters

    • customFields: Record<string, any>

      Custom fields to set on the entity.

      +
  • Sets custom fields on an entity.

    +

    Parameters

    • customFields: Record<string, any>

      Custom fields to set on the entity.

    Returns this

    The entity itself, to facilitate method chaining.

    -
  • Initializes or sets the remoteState of the entity. +

  • Initializes or sets the remoteState of the entity. This function is called on all read, create and update requests.

    -

    Parameters

    • Optional state: Record<string, any>

      State to be set as remote state.

      +

      Parameters

      • Optional state: Record<string, any>

        State to be set as remote state.

      Returns this

      The entity itself, to facilitate method chaining.

      -
  • Set the ETag version identifier of the retrieved entity.

    -

    Parameters

  • Set the ETag version identifier of the retrieved entity.

    +

    Parameters

    • etag: undefined | string

      The returned ETag version of the entity.

    Returns this

    The entity itself, to facilitate method chaining.

    -
  • Overwrites the default toJSON method so that all instance variables as well as all custom fields of the entity are returned.

    +
  • Overwrites the default toJSON method so that all instance variables as well as all custom fields of the entity are returned.

    Returns {
        [key: string]: any;
    }

    An object containing all instance variables + custom fields.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    • [key: string]: any
\ No newline at end of file +
  • [key: string]: any
\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v2.GetAllRequestBuilder.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v2.GetAllRequestBuilder.html index 714240761e..0f69def836 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v2.GetAllRequestBuilder.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v2.GetAllRequestBuilder.html @@ -1,87 +1,87 @@ -GetAllRequestBuilder | SAP Cloud SDK for JavaScript - v3.12.1

Class GetAllRequestBuilder<EntityT, DeSerializersT>

Represents an object that is related to an entity. +GetAllRequestBuilder | SAP Cloud SDK for JavaScript - v3.12.0

Class GetAllRequestBuilder<EntityT, DeSerializersT>

Represents an object that is related to an entity. Objects that have the same structure would be represented by the same type in TypeScript. This interface allows to identify equal structures as different structures if they are related to different entities.

-

Type Parameters

Hierarchy (view full)

Implements

Constructors

Properties

_deSerializers: DeSerializersT

Dummy property to also include the deserializer type in the structure of the entity type.

-
_entity: EntityT

Dummy property whose type makes structurally identical entities distinguishable in TypeScript.

-
_entityConstructor: Constructable<EntityT>
dataAccessor: ResponseDataAccessor
entityDeserializer: EntityDeserializer

Methods

  • Add custom headers to the request. Existing headers will be overwritten.

    -

    Parameters

    • headers: Record<string, string>

      Key-value pairs denoting additional custom headers.

      +

Type Parameters

Hierarchy (view full)

Implements

Constructors

Properties

_deSerializers: DeSerializersT

Dummy property to also include the deserializer type in the structure of the entity type.

+
_entity: EntityT

Dummy property whose type makes structurally identical entities distinguishable in TypeScript.

+
_entityConstructor: Constructable<EntityT>
dataAccessor: ResponseDataAccessor
entityDeserializer: EntityDeserializer

Methods

  • Add custom headers to the request. Existing headers will be overwritten.

    +

    Parameters

    • headers: Record<string, string>

      Key-value pairs denoting additional custom headers.

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.

    -

    Parameters

    • queryParameters: Record<string, string>

      Key-value pairs denoting additional custom query parameters to be set in the request.

      +
  • Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.

    +

    Parameters

    • queryParameters: Record<string, string>

      Key-value pairs denoting additional custom query parameters to be set in the request.

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. +

  • Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. If the custom request configuration contains disallowed keys, those will be ignored.

    -

    Parameters

    • requestConfiguration: Record<string, any>

      Key-value pairs denoting additional custom request configuration options to be set in the request.

      +

      Parameters

      • requestConfiguration: Record<string, string>

        Key-value pairs denoting additional custom request configuration options to be set in the request.

      Returns this

      The request builder itself, to facilitate method chaining.

      -
  • Append the given path to the URL. This can be used for querying navigation properties of an entity. To execute a request with an appended path use executeRaw to avoid errors during deserialization. When using this, the execute method is omitted from the return type.

    -

    Parameters

    • Rest ...path: string[]

      Path to be appended.

      +

      Parameters

      • Rest ...path: string[]

        Path to be appended.

      Returns Omit<GetAllRequestBuilder<EntityT, DeSerializersT>, "execute">

      The request builder itself without "execute" function, to facilitate method chaining.

      -
  • Execute request.

    +

    Parameters

    Returns Promise<EntityT[]>

    A promise resolving to the requested entities.

    -
  • Add filter statements to the request.

    +

    Parameters

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Parameters

    Returns this

  • Set middleware for requests towards the target system given in the destination.

    -

    Parameters

    • middlewares: HttpMiddleware | HttpMiddleware[]

      Middlewares to be applied to the executeHttpRequest().

      +
    • Parameters

      Returns this

  • Set middleware for requests towards the target system given in the destination.

    +

    Parameters

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Parameters

    Returns this

  • Create the relative URL based on configuration of the given builder.

    Returns string

    The relative URL for the request.

    -
  • Restrict the response to the given selection of properties in the request.

    -

    Parameters

  • Restrict the response to the given selection of properties in the request.

    +

    Parameters

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Parameters

    Returns this

  • Replace the default service path with the given custom path. In case of the SAP S/4HANA APIs the basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.

    -

    Parameters

    • basePath: string

      Path to override the default with.

      +

      Parameters

      • basePath: string

        Path to override the default with.

      Returns this

      The request builder itself, to facilitate method chaining.

      -
  • Skip number of entities.

    -

    Parameters

    • skip: number

      Number of matching entities to skip. Useful for paging.

      +
  • Skip number of entities.

    +

    Parameters

    • skip: number

      Number of matching entities to skip. Useful for paging.

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.

    +
  • Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Limit number of returned entities.

    -

    Parameters

    • top: number

      Maximum number of entities to return in the response. Can be less, if less entities match the request.

      +
  • Limit number of returned entities.

    +

    Parameters

    • top: number

      Maximum number of entities to return in the response. Can be less, if less entities match the request.

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Create the URL based on configuration of the given builder.

    -

    Parameters

  • Create the URL based on configuration of the given builder.

    +

    Parameters

    Returns Promise<string>

    Promise resolving to the URL for the request.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v2.GetByKeyRequestBuilder.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v2.GetByKeyRequestBuilder.html index be00830747..35bce5ed89 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v2.GetByKeyRequestBuilder.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v2.GetByKeyRequestBuilder.html @@ -1,76 +1,76 @@ -GetByKeyRequestBuilder | SAP Cloud SDK for JavaScript - v3.12.1

Class GetByKeyRequestBuilder<EntityT, DeSerializersT>

Create an OData request to get a single entity based on its key properties. +GetByKeyRequestBuilder | SAP Cloud SDK for JavaScript - v3.12.0

Class GetByKeyRequestBuilder<EntityT, DeSerializersT>

Create an OData request to get a single entity based on its key properties. The properties available in the response can be restricted by creating a selection, where no selection is equal to selecting all fields. Note that navigational properties are automatically expanded if they included in a select.

-

Type Parameters

Hierarchy (view full)

Implements

Constructors

Properties

_deSerializers: DeSerializersT

Dummy property to also include the deserializer type in the structure of the entity type.

-
_entity: EntityT

Dummy property whose type makes structurally identical entities distinguishable in TypeScript.

-
_entityConstructor: Constructable<EntityT>
dataAccessor: ResponseDataAccessor
entityDeserializer: EntityDeserializer

Methods

  • Add custom headers to the request. Existing headers will be overwritten.

    -

    Parameters

    • headers: Record<string, string>

      Key-value pairs denoting additional custom headers.

      +

Type Parameters

Hierarchy (view full)

Implements

Constructors

Properties

_deSerializers: DeSerializersT

Dummy property to also include the deserializer type in the structure of the entity type.

+
_entity: EntityT

Dummy property whose type makes structurally identical entities distinguishable in TypeScript.

+
_entityConstructor: Constructable<EntityT>
dataAccessor: ResponseDataAccessor
entityDeserializer: EntityDeserializer

Methods

  • Add custom headers to the request. Existing headers will be overwritten.

    +

    Parameters

    • headers: Record<string, string>

      Key-value pairs denoting additional custom headers.

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.

    -

    Parameters

    • queryParameters: Record<string, string>

      Key-value pairs denoting additional custom query parameters to be set in the request.

      +
  • Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.

    +

    Parameters

    • queryParameters: Record<string, string>

      Key-value pairs denoting additional custom query parameters to be set in the request.

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. +

  • Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. If the custom request configuration contains disallowed keys, those will be ignored.

    -

    Parameters

    • requestConfiguration: Record<string, any>

      Key-value pairs denoting additional custom request configuration options to be set in the request.

      +

      Parameters

      • requestConfiguration: Record<string, string>

        Key-value pairs denoting additional custom request configuration options to be set in the request.

      Returns this

      The request builder itself, to facilitate method chaining.

      -
  • Append the given path to the URL. This can be used for querying navigation properties of an entity. To execute a request with an appended path use executeRaw to avoid errors during deserialization. When using this, the execute method is omitted from the return type.

    -

    Parameters

  • Execute request.

    +

    Parameters

    Returns Promise<EntityT>

    A promise resolving to the requested entity.

    -
  • Set middleware for requests towards the target system given in the destination.

    -

    Parameters

  • Set middleware for requests towards the target system given in the destination.

    +

    Parameters

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Parameters

    Returns this

  • Create the relative URL based on configuration of the given builder.

    +
  • Parameters

    Returns this

  • Create the relative URL based on configuration of the given builder.

    Returns string

    The relative URL for the request.

    -
  • Restrict the response to the given selection of properties in the request.

    +

    Parameters

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Parameters

    Returns this

  • Replace the default service path with the given custom path. In case of the SAP S/4HANA APIs the basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.

    -

    Parameters

    • basePath: string

      Path to override the default with.

      +

      Parameters

      • basePath: string

        Path to override the default with.

      Returns this

      The request builder itself, to facilitate method chaining.

      -
  • Sets user-defined identifier for the batch reference.

    -

    Parameters

    • id: string

      User-defined batch request identifier.

      -

    Returns void

  • Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.

    +
  • Sets user-defined identifier for the batch reference.

    +

    Parameters

    • id: string

      User-defined batch request identifier.

      +

    Returns void

  • Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Create the URL based on configuration of the given builder.

    +

    Parameters

    Returns Promise<string>

    Promise resolving to the URL for the request.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v2.ODataBatchRequestBuilder.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v2.ODataBatchRequestBuilder.html index e2523cc8c8..1f1f2d2360 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v2.ODataBatchRequestBuilder.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v2.ODataBatchRequestBuilder.html @@ -1,61 +1,61 @@ -ODataBatchRequestBuilder | SAP Cloud SDK for JavaScript - v3.12.1

Create a batch request to invoke multiple requests as a batch. The batch request builder accepts retrieve requests, i.e. getAll and getByKey requests and change sets, which in turn can contain create, update or delete requests. +ODataBatchRequestBuilder | SAP Cloud SDK for JavaScript - v3.12.0

Create a batch request to invoke multiple requests as a batch. The batch request builder accepts retrieve requests, i.e. getAll and getByKey requests and change sets, which in turn can contain create, update or delete requests. The retrieve and change sets will be executed in order, while the order within a change set can vary.

-

Type Parameters

Hierarchy

Constructors

Properties

deSerializers: undefined | DeSerializersT
defaultBasePath: string

Methods

  • Add custom headers to the request. Existing headers will be overwritten.

    -

    Parameters

    • headers: Record<string, string>

      Key-value pairs denoting additional custom headers.

      +

Type Parameters

Hierarchy

Constructors

Properties

deSerializers: undefined | DeSerializersT
defaultBasePath: string

Methods

  • Add custom headers to the request. Existing headers will be overwritten.

    +

    Parameters

    • headers: Record<string, string>

      Key-value pairs denoting additional custom headers.

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.

    -

    Parameters

    • queryParameters: Record<string, string>

      Key-value pairs denoting additional custom query parameters to be set in the request.

      +
  • Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.

    +

    Parameters

    • queryParameters: Record<string, string>

      Key-value pairs denoting additional custom query parameters to be set in the request.

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. +

  • Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. If the custom request configuration contains disallowed keys, those will be ignored.

    -

    Parameters

    • requestConfiguration: Record<string, any>

      Key-value pairs denoting additional custom request configuration options to be set in the request.

      +

      Parameters

      • requestConfiguration: Record<string, string>

        Key-value pairs denoting additional custom request configuration options to be set in the request.

      Returns this

      The request builder itself, to facilitate method chaining.

      -
  • Append the given path to the URL. +

  • Append the given path to the URL. This can be used for querying navigation properties of an entity. To execute a request with an appended path use executeRaw to avoid errors during deserialization. When using this, the execute method is omitted from the return type.

    -

    Parameters

    • Rest ...path: string[]

      Path to be appended.

      +

      Parameters

      • Rest ...path: string[]

        Path to be appended.

      Returns Omit<ODataBatchRequestBuilder<DeSerializersT>, "execute">

      The request builder itself without "execute" function, to facilitate method chaining.

      -
  • Execute the given request and return the according promise. Please notice: The sub-requests may fail even the main request is successful.

    -

    Parameters

    • destination: HttpDestinationOrFetchOptions

      Targeted destination or DestinationFetchOptions on which the request is performed.

      +
  • Execute the given request and return the according promise. Please notice: The sub-requests may fail even the main request is successful.

    +

    Parameters

    Returns Promise<BatchResponse<DeSerializersT>[]>

    Promise resolving to the requested data.

    -
  • Set middleware for requests towards the target system given in the destination.

    -

    Parameters

    • middlewares: HttpMiddleware | HttpMiddleware[]

      Middlewares to be applied to the executeHttpRequest().

      +
  • Set middleware for requests towards the target system given in the destination.

    +

    Parameters

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Parameters

    Returns this

  • Create the relative URL based on configuration of the given builder.

    +
  • Parameters

    Returns this

  • Create the relative URL based on configuration of the given builder.

    Returns string

    The relative URL for the request.

    -
  • Replace the default service path with the given custom path. +

  • Replace the default service path with the given custom path. In case of the SAP S/4HANA APIs the basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.

    -

    Parameters

    • basePath: string

      Path to override the default with.

      +

      Parameters

      • basePath: string

        Path to override the default with.

      Returns this

      The request builder itself, to facilitate method chaining.

      -
  • Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.

    +
  • Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Create the URL based on configuration of the given builder.

    -

    Parameters

    • destination: HttpDestinationOrFetchOptions

      Destination or DestinationFetchOptions to execute the request against.

      +
  • Create the URL based on configuration of the given builder.

    +

    Parameters

    Returns Promise<string>

    Promise resolving to the URL for the request.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
  • Parameters

    Returns this

\ No newline at end of file +
  • Parameters

    Returns this

\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v2.ODataFunctionRequestConfig.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v2.ODataFunctionRequestConfig.html index f920b59535..40582105e2 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v2.ODataFunctionRequestConfig.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v2.ODataFunctionRequestConfig.html @@ -1,40 +1,40 @@ -ODataFunctionRequestConfig | SAP Cloud SDK for JavaScript - v3.12.1

Class ODataFunctionRequestConfig<DeSerializersT, ParametersT>

Function request configuration for an entity type.

-

Type Parameters

  • DeSerializersT extends DeSerializers

    Type of the deserializer use on the request

    -
  • ParametersT

    Type of the parameter to setup a request with

    -

Hierarchy (view full)

Constructors

Properties

basePath: string
defaultBasePath: string
defaultHeaders: Record<string, any>
functionName: string
parameterEncoder: ParameterEncoder
payload: string | Record<string, any>

Accessors

  • get appendedPaths(): string[]
  • Returns string[]

  • get customHeaders(): Record<string, string>
  • Returns Record<string, string>

  • set customHeaders(headers): void
  • Parameters

    • headers: Record<string, string>

    Returns void

  • get customQueryParameters(): Record<string, string>
  • Returns Record<string, string>

  • set customQueryParameters(queryParameters): void
  • Parameters

    • queryParameters: Record<string, string>

    Returns void

  • get customRequestConfiguration(): Record<string, string>
  • Returns Record<string, string>

  • set customRequestConfiguration(requestConfiguration): void
  • Parameters

    • requestConfiguration: Record<string, string>

    Returns void

  • get fetchCsrfToken(): boolean
  • Returns boolean

  • set fetchCsrfToken(fetchCsrfToken): void
  • Parameters

    • fetchCsrfToken: boolean

    Returns void

  • get middlewares(): HttpMiddleware[]
  • Returns HttpMiddleware[]

  • set middlewares(middlewares): void
  • Parameters

    Returns void

Methods

  • Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.

    -

    Parameters

    • headers: Record<string, string>

      Key-value pairs where the key is the name of a header property and the value is the respective value.

      -

    Returns void

  • Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.

    -

    Parameters

    • queryParameters: Record<string, string>

      Key-value pairs where the key is the name of a query parameter and the value is the respective value.

      -

    Returns void

  • Parameters

    • Rest ...path: string[]

    Returns void

  • Internal

    Returns Record<string, any>

\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v2.OperationRequestBuilder.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v2.OperationRequestBuilder.html index ff77ac6507..439aa068d6 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v2.OperationRequestBuilder.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v2.OperationRequestBuilder.html @@ -1,71 +1,71 @@ -OperationRequestBuilder | SAP Cloud SDK for JavaScript - v3.12.1

Class OperationRequestBuilder<DeSerializersT, ParametersT, ReturnT>

Create OData request to execute an operation. +OperationRequestBuilder | SAP Cloud SDK for JavaScript - v3.12.0

Class OperationRequestBuilder<DeSerializersT, ParametersT, ReturnT>

Create OData request to execute an operation. For v2, only function, but not action, is supported.

-

Type Parameters

  • DeSerializersT extends DeSerializers
  • ParametersT

    Type of the function import parameters.

    -
  • ReturnT

    Type of the function import return value.

    -

Hierarchy (view full)

Constructors

Properties

_deSerializers: DeSerializersT
responseTransformer: ((data) => ReturnT)

Type declaration

Methods

  • Add custom headers to the request. Existing headers will be overwritten.

    -

    Parameters

    • headers: Record<string, string>

      Key-value pairs denoting additional custom headers.

      +

Type Parameters

  • DeSerializersT extends DeSerializers

  • ParametersT

    Type of the function import parameters.

    +
  • ReturnT

    Type of the function import return value.

    +

Hierarchy (view full)

Constructors

Properties

_deSerializers: DeSerializersT
responseTransformer: ((data) => ReturnT)

Type declaration

Methods

  • Add custom headers to the request. Existing headers will be overwritten.

    +

    Parameters

    • headers: Record<string, string>

      Key-value pairs denoting additional custom headers.

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.

    -

    Parameters

    • queryParameters: Record<string, string>

      Key-value pairs denoting additional custom query parameters to be set in the request.

      +
  • Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.

    +

    Parameters

    • queryParameters: Record<string, string>

      Key-value pairs denoting additional custom query parameters to be set in the request.

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. +

  • Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. If the custom request configuration contains disallowed keys, those will be ignored.

    -

    Parameters

    • requestConfiguration: Record<string, any>

      Key-value pairs denoting additional custom request configuration options to be set in the request.

      +

      Parameters

      • requestConfiguration: Record<string, string>

        Key-value pairs denoting additional custom request configuration options to be set in the request.

      Returns this

      The request builder itself, to facilitate method chaining.

      -
  • Append the given path to the URL. This can be used for querying navigation properties of an entity. To execute a request with an appended path use executeRaw to avoid errors during deserialization. When using this, the execute method is omitted from the return type.

    -

    Parameters

  • Execute request.

    -

    Parameters

    • destination: HttpDestinationOrFetchOptions

      Destination or DestinationFetchOptions to execute the request against.

      -
    • Optional dataAccessor: ((data) => any)

      A function to modify the received response data.

      -
        • (data): any
        • Parameters

          • data: any

          Returns any

    Returns Promise<ReturnT>

    A promise resolving to the requested return type.

    -
  • Execute request.

    +

    Parameters

    • destination: HttpDestinationOrFetchOptions

      Destination or DestinationFetchOptions to execute the request against.

      +
    • Optional dataAccessor: ((data) => any)

      A function to modify the received response data.

      +
        • (data): any
        • Parameters

          • data: any

          Returns any

    Returns Promise<ReturnT>

    A promise resolving to the requested return type.

    +
  • Set middleware for requests towards the target system given in the destination.

    -

    Parameters

  • Set middleware for requests towards the target system given in the destination.

    +

    Parameters

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Parameters

    Returns this

  • Create the relative URL based on configuration of the given builder.

    +
  • Parameters

    Returns this

  • Create the relative URL based on configuration of the given builder.

    Returns string

    The relative URL for the request.

    -
  • Replace the default service path with the given custom path. +

  • Replace the default service path with the given custom path. In case of the SAP S/4HANA APIs the basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.

    -

    Parameters

    • basePath: string

      Path to override the default with.

      +

      Parameters

      • basePath: string

        Path to override the default with.

      Returns this

      The request builder itself, to facilitate method chaining.

      -
  • Sets user-defined identifier for the batch reference.

    -

    Parameters

    • id: string

      User-defined batch request identifier.

      -

    Returns void

  • Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.

    +
  • Sets user-defined identifier for the batch reference.

    +

    Parameters

    • id: string

      User-defined batch request identifier.

      +

    Returns void

  • Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Create the URL based on configuration of the given builder.

    +

    Parameters

    Returns Promise<string>

    Promise resolving to the URL for the request.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v2.UpdateRequestBuilder.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v2.UpdateRequestBuilder.html index c381be65e0..895dbd22c9 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v2.UpdateRequestBuilder.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v2.UpdateRequestBuilder.html @@ -1,97 +1,97 @@ -UpdateRequestBuilder | SAP Cloud SDK for JavaScript - v3.12.1

Class UpdateRequestBuilder<EntityT, DeSerializersT>

Create OData query to update an entity.

-

Type Parameters

Hierarchy (view full)

Implements

Constructors

Properties

_deSerializers: DeSerializersT

Dummy property to also include the deserializer type in the structure of the entity type.

-
_entity: EntityT

Dummy property whose type makes structurally identical entities distinguishable in TypeScript.

-
entitySerializer: EntitySerializer
extractODataEtag: ((json) => undefined | string)

Type declaration

    • (json): undefined | string
    • Parameters

      • json: Record<string, any>

      Returns undefined | string

payloadManipulator: ((body) => Record<string, any>)

Type declaration

    • (body): Record<string, any>
    • Parameters

      • body: Record<string, any>

      Returns Record<string, any>

Accessors

  • get entity(): EntityT
  • Returns EntityT

Methods

\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.ActionImportParameter.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.ActionImportParameter.html index dabc69dd93..1b4d859199 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.ActionImportParameter.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.ActionImportParameter.html @@ -1,11 +1,11 @@ -ActionImportParameter | SAP Cloud SDK for JavaScript - v3.12.1

Deprecated

Since 3.3.0. Use OperationParameter instead.

-

Type Parameters

  • ValueT

Constructors

Properties

Constructors

Properties

originalName: string
value: ValueT
\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.ActionImportRequestBuilder.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.ActionImportRequestBuilder.html index b4b996ace9..f0dd3f82c4 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.ActionImportRequestBuilder.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.ActionImportRequestBuilder.html @@ -1,61 +1,61 @@ -ActionImportRequestBuilder | SAP Cloud SDK for JavaScript - v3.12.1

Class ActionImportRequestBuilder<DeSerializersT, ParametersT, ReturnT>

Deprecated

Since 3.3.0. Use OperationRequestBuilder instead.

-

Type Parameters

Hierarchy (view full)

Constructors

Properties

_deSerializers: DeSerializersT
requestConfig: ODataRequestConfig
responseTransformer: ((data) => ReturnT)

Type declaration

Methods

\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.BoundActionImportRequestBuilder.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.BoundActionImportRequestBuilder.html index 24a5026280..2dba59a95e 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.BoundActionImportRequestBuilder.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.BoundActionImportRequestBuilder.html @@ -1,61 +1,61 @@ -BoundActionImportRequestBuilder | SAP Cloud SDK for JavaScript - v3.12.1

Class BoundActionImportRequestBuilder<EntityT, DeSerializersT, ParametersT, ReturnT>

Deprecated

Since 3.3.0. Use OperationRequestBuilder instead.

-

Type Parameters

Hierarchy (view full)

Constructors

Properties

_deSerializers: DeSerializersT
responseTransformer: ((data) => ReturnT)

Type declaration

Methods

\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.BoundFunctionImportRequestBuilder.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.BoundFunctionImportRequestBuilder.html index 18318e2ddd..d62fbfde51 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.BoundFunctionImportRequestBuilder.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.BoundFunctionImportRequestBuilder.html @@ -1,61 +1,61 @@ -BoundFunctionImportRequestBuilder | SAP Cloud SDK for JavaScript - v3.12.1

Class BoundFunctionImportRequestBuilder<EntityT, DeSerializersT, ParametersT, ReturnT>

Deprecated

Since 3.3.0. Use OperationRequestBuilder instead.

-

Type Parameters

Hierarchy (view full)

Constructors

Properties

_deSerializers: DeSerializersT
responseTransformer: ((data) => ReturnT)

Type declaration

Methods

\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.BoundOperationRequestBuilder.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.BoundOperationRequestBuilder.html index ed7388b346..5a78ff785f 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.BoundOperationRequestBuilder.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.BoundOperationRequestBuilder.html @@ -1,63 +1,63 @@ -BoundOperationRequestBuilder | SAP Cloud SDK for JavaScript - v3.12.1

Class BoundOperationRequestBuilder<EntityT, DeSerializersT, ParametersT, ReturnT>

Create bound OData request to execute an operation.

-

Type Parameters

  • EntityT extends EntityBase
  • DeSerializersT extends DeSerializers
  • ParametersT

    Type of the operation parameters.

    -
  • ReturnT

    Type of the operation return value.

    -

Hierarchy (view full)

Constructors

Properties

_deSerializers: DeSerializersT
responseTransformer: ((data) => ReturnT)

Type declaration

Methods

\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.CountRequestBuilder.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.CountRequestBuilder.html index 397fbceb62..078d393fe6 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.CountRequestBuilder.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.CountRequestBuilder.html @@ -1,59 +1,59 @@ -CountRequestBuilder | SAP Cloud SDK for JavaScript - v3.12.1

Class CountRequestBuilder<EntityT, DeSerializersT>

Create an OData request to count entities based on the configuration of the request. +CountRequestBuilder | SAP Cloud SDK for JavaScript - v3.12.0

Class CountRequestBuilder<EntityT, DeSerializersT>

Create an OData request to count entities based on the configuration of the request. A CountRequestBuilder allows only for execution of the request. If you want to apply query parameters like filter, skip or top do it on the GetAllRequestBuilder the count is created from.

-

Type Parameters

Hierarchy (view full)

Constructors

Properties

Methods

  • Add custom headers to the request. Existing headers will be overwritten.

    -

    Parameters

    • headers: Record<string, string>

      Key-value pairs denoting additional custom headers.

      +

Type Parameters

Hierarchy (view full)

Constructors

Properties

Methods

  • Add custom headers to the request. Existing headers will be overwritten.

    +

    Parameters

    • headers: Record<string, string>

      Key-value pairs denoting additional custom headers.

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.

    -

    Parameters

    • queryParameters: Record<string, string>

      Key-value pairs denoting additional custom query parameters to be set in the request.

      +
  • Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.

    +

    Parameters

    • queryParameters: Record<string, string>

      Key-value pairs denoting additional custom query parameters to be set in the request.

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. +

  • Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. If the custom request configuration contains disallowed keys, those will be ignored.

    -

    Parameters

    • requestConfiguration: Record<string, any>

      Key-value pairs denoting additional custom request configuration options to be set in the request.

      +

      Parameters

      • requestConfiguration: Record<string, string>

        Key-value pairs denoting additional custom request configuration options to be set in the request.

      Returns this

      The request builder itself, to facilitate method chaining.

      -
  • Append the given path to the URL. This can be used for querying navigation properties of an entity. To execute a request with an appended path use executeRaw to avoid errors during deserialization. When using this, the execute method is omitted from the return type.

    -

    Parameters

    • Rest ...path: string[]

      Path to be appended.

      +

      Parameters

      • Rest ...path: string[]

        Path to be appended.

      Returns Omit<CountRequestBuilder<EntityT, DeSerializersT>, "execute">

      The request builder itself without "execute" function, to facilitate method chaining.

      -
  • Execute request.

    -

    Parameters

  • Execute request.

    +

    Parameters

    Returns Promise<number>

    A promise resolving to the number of entities.

    -
  • Set middleware for requests towards the target system given in the destination.

    -

    Parameters

  • Set middleware for requests towards the target system given in the destination.

    +

    Parameters

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Parameters

    Returns this

  • Create the relative URL based on configuration of the given builder.

    +
  • Parameters

    Returns this

  • Create the relative URL based on configuration of the given builder.

    Returns string

    The relative URL for the request.

    -
  • Replace the default service path with the given custom path. +

  • Replace the default service path with the given custom path. In case of the SAP S/4HANA APIs the basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.

    -

    Parameters

    • basePath: string

      Path to override the default with.

      +

      Parameters

      • basePath: string

        Path to override the default with.

      Returns this

      The request builder itself, to facilitate method chaining.

      -
  • Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.

    +
  • Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Create the URL based on configuration of the given builder.

    -

    Parameters

  • Create the URL based on configuration of the given builder.

    +

    Parameters

    Returns Promise<string>

    Promise resolving to the URL for the request.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.CreateRequestBuilder.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.CreateRequestBuilder.html index ab89b2003b..201b6f7cfb 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.CreateRequestBuilder.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.CreateRequestBuilder.html @@ -1,77 +1,77 @@ -CreateRequestBuilder | SAP Cloud SDK for JavaScript - v3.12.1

Class CreateRequestBuilder<EntityT, DeSerializersT>

Create OData request to create an entity.

-

Type Parameters

Hierarchy (view full)

Implements

Constructors

Properties

_deSerializers: DeSerializersT

Dummy property to also include the deserializer type in the structure of the entity type.

-
_entity: EntityT

Dummy property whose type makes structurally identical entities distinguishable in TypeScript.

-
deserializer: EntityDeserializer
responseDataAccessor: ResponseDataAccessor
serializer: EntitySerializer

Accessors

  • get entity(): EntityT
  • Returns EntityT

Methods

\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.CustomField.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.CustomField.html index 90370182a7..4d95c10601 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.CustomField.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.CustomField.html @@ -1,28 +1,28 @@ -CustomField | SAP Cloud SDK for JavaScript - v3.12.1

Class CustomField<EntityT, DeSerializersT, NullableT>

If your entity contains fields not present in your service specification you can model them using custom fields. +CustomField | SAP Cloud SDK for JavaScript - v3.12.0

Class CustomField<EntityT, DeSerializersT, NullableT>

If your entity contains fields not present in your service specification you can model them using custom fields. Alternatively you can also generate a client based on a service specification containing all fields.

-

Type Parameters

Hierarchy (view full)

Constructors

Properties

_entityConstructor: Constructable<EntityT>
_fieldName: string
_fieldOptions: Required<FieldOptions<NullableT, false>>
fieldBuilder: FieldBuilder<Constructable<EntityT>, any>

Methods

  • Path to the field to be used in filter and order by queries.

    +

Type Parameters

Hierarchy (view full)

Constructors

Properties

_entityConstructor: Constructable<EntityT>
_fieldName: string
_fieldOptions: Required<FieldOptions<NullableT, false>>
fieldBuilder: FieldBuilder<Constructable<EntityT>, any>

Methods

  • Path to the field to be used in filter and order by queries.

    Returns string

    Path to the field to be used in filter and order by queries.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.DateFilterFunction.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.DateFilterFunction.html index 4bc384905d..46e20d980c 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.DateFilterFunction.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.DateFilterFunction.html @@ -1,34 +1,34 @@ -DateFilterFunction | SAP Cloud SDK for JavaScript - v3.12.1

Representation of a filter function, that returns a value of type date. This supports DateTimeOffset values.

-

Type Parameters

Hierarchy

  • OrderableFilterFunction<EntityT, moment.Moment>
    • DateFilterFunction

Constructors

  • Creates an instance of DateFilterFunction.

    -

    Type Parameters

    Parameters

    • functionName: string

      Name of the function that returns a numeric value.

      -
    • parameters: FilterFunctionParameterType<EntityT>[]

      Representation of the parameters passed to the filter function.

      -

    Returns DateFilterFunction<EntityT>

Properties

functionName: string

Methods

  • Creates an instance of Filter for this filter function and the given value using the operator 'eq', i.e. ==.

    -

    Parameters

    • value: Moment

      Value to be used in the filter.

      +DateFilterFunction | SAP Cloud SDK for JavaScript - v3.12.0

      Representation of a filter function, that returns a value of type date. This supports DateTimeOffset values.

      +

      Type Parameters

      Hierarchy

      • OrderableFilterFunction<EntityT, moment.Moment>
        • DateFilterFunction

      Constructors

      • Creates an instance of DateFilterFunction.

        +

        Type Parameters

        Parameters

        • functionName: string

          Name of the function that returns a numeric value.

          +
        • parameters: FilterFunctionParameterType<EntityT>[]

          Representation of the parameters passed to the filter function.

          +

        Returns DateFilterFunction<EntityT>

      Properties

      functionName: string

      Methods

      • Creates an instance of Filter for this filter function and the given value using the operator 'eq', i.e. ==.

        +

        Parameters

        • value: Moment

          Value to be used in the filter.

        Returns Filter<EntityT, any, Moment>

        The resulting filter.

        -
      • Creates an instance of Filter for this filter function and the given value using the operator 'ge', i.e. >=.

        -

        Parameters

        • value: Moment

          Value to be used in the filter.

          +
      • Creates an instance of Filter for this filter function and the given value using the operator 'ge', i.e. >=.

        +

        Parameters

        • value: Moment

          Value to be used in the filter.

        Returns Filter<EntityT, any, Moment>

        The resulting filter.

        -
      • Creates an instance of Filter for this filter function and the given value using the operator 'gt', i.e. >.

        -

        Parameters

        • value: Moment

          Value to be used in the filter.

          +
      • Creates an instance of Filter for this filter function and the given value using the operator 'gt', i.e. >.

        +

        Parameters

        • value: Moment

          Value to be used in the filter.

        Returns Filter<EntityT, any, Moment>

        The resulting filter.

        -
      • Creates an instance of Filter for this filter function and the given value using the operator 'le', i.e. <=.

        -

        Parameters

        • value: Moment

          Value to be used in the filter.

          +
      • Creates an instance of Filter for this filter function and the given value using the operator 'le', i.e. <=.

        +

        Parameters

        • value: Moment

          Value to be used in the filter.

        Returns Filter<EntityT, any, Moment>

        The resulting filter.

        -
      • Creates an instance of Filter for this filter function and the given value using the operator 'lt', i.e. <.

        -

        Parameters

        • value: Moment

          Value to be used in the filter.

          +
      • Creates an instance of Filter for this filter function and the given value using the operator 'lt', i.e. <.

        +

        Parameters

        • value: Moment

          Value to be used in the filter.

        Returns Filter<EntityT, any, Moment>

        The resulting filter.

        -
      • Creates an instance of Filter for this filter function and the given value using the operator 'ne', i.e. !=.

        -

        Parameters

        • value: Moment

          Value to be used in the filter.

          +
      • Creates an instance of Filter for this filter function and the given value using the operator 'ne', i.e. !=.

        +

        Parameters

        • value: Moment

          Value to be used in the filter.

        Returns Filter<EntityT, any, Moment>

        The resulting filter.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.DeleteRequestBuilder.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.DeleteRequestBuilder.html index fccf45c8e1..e047d495df 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.DeleteRequestBuilder.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.DeleteRequestBuilder.html @@ -1,74 +1,74 @@ -DeleteRequestBuilder | SAP Cloud SDK for JavaScript - v3.12.1

Class DeleteRequestBuilder<EntityT, DeSerializersT>

Create OData query to delete an entity.

-

Type Parameters

Hierarchy (view full)

Constructors

Properties

_deSerializers: DeSerializersT

Dummy property to also include the deserializer type in the structure of the entity type.

-
_entity: EntityT

Dummy property whose type makes structurally identical entities distinguishable in TypeScript.

-

Methods

\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.Entity.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.Entity.html index d39116fe41..b98c97e4b1 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.Entity.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.Entity.html @@ -1,80 +1,80 @@ -Entity | SAP Cloud SDK for JavaScript - v3.12.1

Super class for all representations of OData v4 entity types.

-

Hierarchy (view full)

Constructors

Properties

_customFields: Record<string, any>

A mapper representing custom fields in an entity. +Entity | SAP Cloud SDK for JavaScript - v3.12.0

Super class for all representations of OData v4 entity types.

+

Hierarchy (view full)

Constructors

Properties

_customFields: Record<string, any>

A mapper representing custom fields in an entity. Custom fields are represented by their field names and the corresponding values. A custom field can be added or updated using setCustomField method.

-
_entityApi: any
_oDataVersion: "v4"
_versionIdentifier: string

The current ETag version of the entity in the remote system. +

_entityApi: any
_oDataVersion: "v4"
_versionIdentifier: string

The current ETag version of the entity in the remote system. The ETag identified the version of the in the remote system. It will be automatically set in the "if-match" header of update requests and can be set as a custom header for delete requests. When no ETag is provided by the remote system the value of this variable defaults to "*".

-
remoteState: {
    [keys: string]: any;
}

The remote state of the entity. +

remoteState: {
    [keys: string]: any;
}

The remote state of the entity. Remote state refers to the last known state of the entity on the remote system from which it has been retrieved or to which it has been posted. It is stored as map, where the keys are stored in the format of the original OData properties.

-

Type declaration

  • [keys: string]: any
_defaultBasePath: string
_entityName: string
_serviceName: string

Accessors

  • get versionIdentifier(): string
  • ETag version identifier accessor.

    +

    Type declaration

    • [keys: string]: any
_defaultBasePath: string
_entityName: string
_serviceName: string

Accessors

  • get versionIdentifier(): string
  • ETag version identifier accessor.

    Returns string

    The ETag version identifier of the retrieved entity, returns undefined if not retrieved.

    -

Methods

  • Creates an object containing all defined properties, navigation properties and custom fields in the entity.

    -

    Parameters

    • Optional visitedEntities: EntityBase[]

      List of entities to check in case of circular dependencies.

      +

Methods

  • Creates an object containing all defined properties, navigation properties and custom fields in the entity.

    +

    Parameters

    • Optional visitedEntities: EntityBase[]

      List of entities to check in case of circular dependencies.

    Returns Record<string, any>

    EntityBase as an object with all defined entity fields.

    -
  • Parameters

    Returns any

  • Custom field value getter.

    -

    Parameters

    • fieldName: string

      The name of the custom field.

      +
  • Parameters

    Returns any

  • Custom field value getter.

    +

    Parameters

    • fieldName: string

      The name of the custom field.

    Returns any

    The value of the corresponding custom field.

    -
  • Returns a map that contains all entity custom fields.

    +
  • Returns a map that contains all entity custom fields.

    Returns Record<string, any>

    A map of all defined custom fields in the entity.

    -
  • Returns all updated custom field properties compared to the last known remote state.

    +
  • Returns all updated custom field properties compared to the last known remote state.

    Returns Record<string, any>

    An object containing all updated custom properties, with their new values.

    -
  • Returns all changed properties compared to the last known remote state. +

  • Returns all changed properties compared to the last known remote state. The returned properties do not include custom fields. Use getUpdatedCustomFields, if you need custom fields.

    Returns Record<string, any>

    EntityBase with all properties that changed.

    -
  • Returns all changed property names compared to the last known remote state. +

  • Returns all changed property names compared to the last known remote state. The returned properties names do not include custom fields. Use getUpdatedCustomFields, if you need custom fields.

    Returns string[]

    EntityBase with all properties that changed.

    -
  • Validates whether a custom field exists in the entity.

    -

    Parameters

    • fieldName: string

      The name of the custom field to update.

      +
  • Validates whether a custom field exists in the entity.

    +

    Parameters

    • fieldName: string

      The name of the custom field to update.

    Returns boolean

    A boolean value, that indicates whether a custom field is defined in entity.

    -
  • Validates whether a field name does not conflict with an original field name and thus can be defined as custom fields.

    -

    Parameters

    • customFieldName: string

      Field name to check.

      +
  • Validates whether a field name does not conflict with an original field name and thus can be defined as custom fields.

    +

    Parameters

    • customFieldName: string

      Field name to check.

    Returns boolean

    Boolean value that describes whether a field name can be defined as custom field.

    -
  • Sets a new custom field in the entity or updates it. +

  • Sets a new custom field in the entity or updates it. Throws an error, if the provided custom field name is already defined by an original field in entity.

    -

    Parameters

    • fieldName: string

      The name of the custom field to update.

      -
    • value: any

      The value of the field.

      +

      Parameters

      • fieldName: string

        The name of the custom field to update.

        +
      • value: any

        The value of the field.

      Returns this

      The entity itself, to facilitate method chaining.

      -
  • Sets custom fields on an entity.

    -

    Parameters

    • customFields: Record<string, any>

      Custom fields to set on the entity.

      +
  • Sets custom fields on an entity.

    +

    Parameters

    • customFields: Record<string, any>

      Custom fields to set on the entity.

    Returns this

    The entity itself, to facilitate method chaining.

    -
  • Initializes or sets the remoteState of the entity. +

  • Initializes or sets the remoteState of the entity. This function is called on all read, create and update requests.

    -

    Parameters

    • Optional state: Record<string, any>

      State to be set as remote state.

      +

      Parameters

      • Optional state: Record<string, any>

        State to be set as remote state.

      Returns this

      The entity itself, to facilitate method chaining.

      -
  • Set the ETag version identifier of the retrieved entity.

    -

    Parameters

  • Set the ETag version identifier of the retrieved entity.

    +

    Parameters

    • etag: undefined | string

      The returned ETag version of the entity.

    Returns this

    The entity itself, to facilitate method chaining.

    -
  • Overwrites the default toJSON method so that all instance variables as well as all custom fields of the entity are returned.

    +
  • Overwrites the default toJSON method so that all instance variables as well as all custom fields of the entity are returned.

    Returns {
        [key: string]: any;
    }

    An object containing all instance variables + custom fields.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    • [key: string]: any
\ No newline at end of file +
  • [key: string]: any
\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.FunctionImportRequestBuilder.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.FunctionImportRequestBuilder.html index 683f783c38..46ff4556bf 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.FunctionImportRequestBuilder.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.FunctionImportRequestBuilder.html @@ -1,61 +1,61 @@ -FunctionImportRequestBuilder | SAP Cloud SDK for JavaScript - v3.12.1

Class FunctionImportRequestBuilder<DeSerializersT, ParametersT, ReturnT>

Deprecated

Since 3.3.0. Use OperationRequestBuilder instead.

-

Type Parameters

Hierarchy (view full)

Constructors

Properties

_deSerializers: DeSerializersT
requestConfig: ODataRequestConfig
responseTransformer: ((data) => ReturnT)

Type declaration

Methods

\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.GetAllRequestBuilder.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.GetAllRequestBuilder.html index 8502be9c7d..8b0ca561ee 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.GetAllRequestBuilder.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.GetAllRequestBuilder.html @@ -1,88 +1,88 @@ -GetAllRequestBuilder | SAP Cloud SDK for JavaScript - v3.12.1

Class GetAllRequestBuilder<EntityT, DeSerializersT>

Represents an object that is related to an entity. +GetAllRequestBuilder | SAP Cloud SDK for JavaScript - v3.12.0

Class GetAllRequestBuilder<EntityT, DeSerializersT>

Represents an object that is related to an entity. Objects that have the same structure would be represented by the same type in TypeScript. This interface allows to identify equal structures as different structures if they are related to different entities.

-

Type Parameters

Hierarchy (view full)

Implements

Constructors

Properties

_deSerializers: DeSerializersT

Dummy property to also include the deserializer type in the structure of the entity type.

-
_entity: EntityT

Dummy property whose type makes structurally identical entities distinguishable in TypeScript.

-
_entityConstructor: Constructable<EntityT>
dataAccessor: ResponseDataAccessor
entityDeserializer: EntityDeserializer

Methods

  • Add custom headers to the request. Existing headers will be overwritten.

    -

    Parameters

    • headers: Record<string, string>

      Key-value pairs denoting additional custom headers.

      +

Type Parameters

Hierarchy (view full)

Implements

Constructors

Properties

_deSerializers: DeSerializersT

Dummy property to also include the deserializer type in the structure of the entity type.

+
_entity: EntityT

Dummy property whose type makes structurally identical entities distinguishable in TypeScript.

+
_entityConstructor: Constructable<EntityT>
dataAccessor: ResponseDataAccessor
entityDeserializer: EntityDeserializer

Methods

  • Add custom headers to the request. Existing headers will be overwritten.

    +

    Parameters

    • headers: Record<string, string>

      Key-value pairs denoting additional custom headers.

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.

    -

    Parameters

    • queryParameters: Record<string, string>

      Key-value pairs denoting additional custom query parameters to be set in the request.

      +
  • Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.

    +

    Parameters

    • queryParameters: Record<string, string>

      Key-value pairs denoting additional custom query parameters to be set in the request.

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. +

  • Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. If the custom request configuration contains disallowed keys, those will be ignored.

    -

    Parameters

    • requestConfiguration: Record<string, any>

      Key-value pairs denoting additional custom request configuration options to be set in the request.

      +

      Parameters

      • requestConfiguration: Record<string, string>

        Key-value pairs denoting additional custom request configuration options to be set in the request.

      Returns this

      The request builder itself, to facilitate method chaining.

      -
  • Append the given path to the URL. This can be used for querying navigation properties of an entity. To execute a request with an appended path use executeRaw to avoid errors during deserialization. When using this, the execute method is omitted from the return type.

    -

    Parameters

    • Rest ...path: string[]

      Path to be appended.

      +

      Parameters

      • Rest ...path: string[]

        Path to be appended.

      Returns Omit<GetAllRequestBuilder<EntityT, DeSerializersT>, "execute">

      The request builder itself without "execute" function, to facilitate method chaining.

      -
  • Execute request.

    +

    Parameters

    Returns Promise<EntityT[]>

    A promise resolving to the requested entities.

    -
  • Add filter statements to the request.

    +

    Parameters

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Set middleware for requests towards the target system given in the destination.

    -

    Parameters

    • middlewares: HttpMiddleware | HttpMiddleware[]

      Middlewares to be applied to the executeHttpRequest().

      +
  • Set middleware for requests towards the target system given in the destination.

    +

    Parameters

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Parameters

    Returns this

  • Create the relative URL based on configuration of the given builder.

    Returns string

    The relative URL for the request.

    -
  • Restrict the response to the given selection of properties in the request.

    -

    Parameters

  • Restrict the response to the given selection of properties in the request.

    +

    Parameters

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Parameters

    Returns this

  • Replace the default service path with the given custom path. In case of the SAP S/4HANA APIs the basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.

    -

    Parameters

    • basePath: string

      Path to override the default with.

      +

      Parameters

      • basePath: string

        Path to override the default with.

      Returns this

      The request builder itself, to facilitate method chaining.

      -
  • Skip number of entities.

    -

    Parameters

    • skip: number

      Number of matching entities to skip. Useful for paging.

      +
  • Skip number of entities.

    +

    Parameters

    • skip: number

      Number of matching entities to skip. Useful for paging.

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.

    +
  • Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Limit number of returned entities.

    -

    Parameters

    • top: number

      Maximum number of entities to return in the response. Can be less, if less entities match the request.

      +
  • Limit number of returned entities.

    +

    Parameters

    • top: number

      Maximum number of entities to return in the response. Can be less, if less entities match the request.

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Create the URL based on configuration of the given builder.

    -

    Parameters

  • Create the URL based on configuration of the given builder.

    +

    Parameters

    Returns Promise<string>

    Promise resolving to the URL for the request.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.GetByKeyRequestBuilder.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.GetByKeyRequestBuilder.html index a9fb558843..6e889cfe91 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.GetByKeyRequestBuilder.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.GetByKeyRequestBuilder.html @@ -1,78 +1,78 @@ -GetByKeyRequestBuilder | SAP Cloud SDK for JavaScript - v3.12.1

Class GetByKeyRequestBuilder<EntityT, DeSerializersT>

Create an OData request to get a single entity based on its key properties. +GetByKeyRequestBuilder | SAP Cloud SDK for JavaScript - v3.12.0

Class GetByKeyRequestBuilder<EntityT, DeSerializersT>

Create an OData request to get a single entity based on its key properties. The properties available in the response can be restricted by creating a selection, where no selection is equal to selecting all fields of the entity. Navigational properties need to be expanded explicitly by GetAllRequestBuilder.expand. Where no selection is equal to selecting all fields.

-

Type Parameters

Hierarchy (view full)

Implements

Constructors

Properties

_deSerializers: DeSerializersT

Dummy property to also include the deserializer type in the structure of the entity type.

-
_entity: EntityT

Dummy property whose type makes structurally identical entities distinguishable in TypeScript.

-
_entityConstructor: Constructable<EntityT>
dataAccessor: ResponseDataAccessor
entityDeserializer: EntityDeserializer

Methods

  • Add custom headers to the request. Existing headers will be overwritten.

    -

    Parameters

    • headers: Record<string, string>

      Key-value pairs denoting additional custom headers.

      +

Type Parameters

Hierarchy (view full)

Implements

Constructors

Properties

_deSerializers: DeSerializersT

Dummy property to also include the deserializer type in the structure of the entity type.

+
_entity: EntityT

Dummy property whose type makes structurally identical entities distinguishable in TypeScript.

+
_entityConstructor: Constructable<EntityT>
dataAccessor: ResponseDataAccessor
entityDeserializer: EntityDeserializer

Methods

  • Add custom headers to the request. Existing headers will be overwritten.

    +

    Parameters

    • headers: Record<string, string>

      Key-value pairs denoting additional custom headers.

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.

    -

    Parameters

    • queryParameters: Record<string, string>

      Key-value pairs denoting additional custom query parameters to be set in the request.

      +
  • Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.

    +

    Parameters

    • queryParameters: Record<string, string>

      Key-value pairs denoting additional custom query parameters to be set in the request.

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. +

  • Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. If the custom request configuration contains disallowed keys, those will be ignored.

    -

    Parameters

    • requestConfiguration: Record<string, any>

      Key-value pairs denoting additional custom request configuration options to be set in the request.

      +

      Parameters

      • requestConfiguration: Record<string, string>

        Key-value pairs denoting additional custom request configuration options to be set in the request.

      Returns this

      The request builder itself, to facilitate method chaining.

      -
  • Append the given path to the URL. This can be used for querying navigation properties of an entity. To execute a request with an appended path use executeRaw to avoid errors during deserialization. When using this, the execute method is omitted from the return type.

    -

    Parameters

  • Execute request.

    +

    Parameters

    Returns Promise<EntityT>

    A promise resolving to the requested entity.

    -
  • Set middleware for requests towards the target system given in the destination.

    -

    Parameters

  • Set middleware for requests towards the target system given in the destination.

    +

    Parameters

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Parameters

    Returns this

  • Create the relative URL based on configuration of the given builder.

    +
  • Parameters

    Returns this

  • Create the relative URL based on configuration of the given builder.

    Returns string

    The relative URL for the request.

    -
  • Restrict the response to the given selection of properties in the request.

    +

    Parameters

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Parameters

    Returns this

  • Replace the default service path with the given custom path. In case of the SAP S/4HANA APIs the basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.

    -

    Parameters

    • basePath: string

      Path to override the default with.

      +

      Parameters

      • basePath: string

        Path to override the default with.

      Returns this

      The request builder itself, to facilitate method chaining.

      -
  • Sets user-defined identifier for the batch reference.

    -

    Parameters

    • id: string

      User-defined batch request identifier.

      -

    Returns void

  • Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.

    +
  • Sets user-defined identifier for the batch reference.

    +

    Parameters

    • id: string

      User-defined batch request identifier.

      +

    Returns void

  • Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Create the URL based on configuration of the given builder.

    +

    Parameters

    Returns Promise<string>

    Promise resolving to the URL for the request.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.ODataActionRequestConfig.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.ODataActionRequestConfig.html index f50ef34b33..8aad686acc 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.ODataActionRequestConfig.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.ODataActionRequestConfig.html @@ -1,39 +1,39 @@ -ODataActionRequestConfig | SAP Cloud SDK for JavaScript - v3.12.1

Class ODataActionRequestConfig<DeSerializersT, ParametersT>

Action request configuration for an entity type.

-

Type Parameters

  • DeSerializersT extends DeSerializers

    Type of the deserializer use on the request

    -
  • ParametersT

    Type of the parameter to setup a request with

    -

Hierarchy (view full)

Constructors

Properties

actionName: string
basePath: string
defaultBasePath: string
defaultHeaders: Record<string, any>
parameterEncoder: ParameterEncoder
payload: string | Record<string, any>

Accessors

  • get appendedPaths(): string[]
  • Returns string[]

  • get customHeaders(): Record<string, string>
  • Returns Record<string, string>

  • set customHeaders(headers): void
  • Parameters

    • headers: Record<string, string>

    Returns void

  • get customQueryParameters(): Record<string, string>
  • Returns Record<string, string>

  • set customQueryParameters(queryParameters): void
  • Parameters

    • queryParameters: Record<string, string>

    Returns void

  • get customRequestConfiguration(): Record<string, string>
  • Returns Record<string, string>

  • set customRequestConfiguration(requestConfiguration): void
  • Parameters

    • requestConfiguration: Record<string, string>

    Returns void

  • get fetchCsrfToken(): boolean
  • Returns boolean

  • set fetchCsrfToken(fetchCsrfToken): void
  • Parameters

    • fetchCsrfToken: boolean

    Returns void

  • get middlewares(): HttpMiddleware[]
  • Returns HttpMiddleware[]

  • set middlewares(middlewares): void
  • Parameters

    Returns void

Methods

  • Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.

    -

    Parameters

    • headers: Record<string, string>

      Key-value pairs where the key is the name of a header property and the value is the respective value.

      -

    Returns void

  • Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.

    -

    Parameters

    • queryParameters: Record<string, string>

      Key-value pairs where the key is the name of a query parameter and the value is the respective value.

      -

    Returns void

  • Add custom request configuration to the request.

    -

    Parameters

    • requestConfiguration: Record<string, any>

      Key-value pairs where the key is the name of a request configuration and the value is the respective value.

      +ODataActionRequestConfig | SAP Cloud SDK for JavaScript - v3.12.0

      Class ODataActionRequestConfig<DeSerializersT, ParametersT>

      Action request configuration for an entity type.

      +

      Type Parameters

      • DeSerializersT extends DeSerializers

        Type of the deserializer use on the request

        +
      • ParametersT

        Type of the parameter to setup a request with

        +

      Hierarchy (view full)

      Constructors

      Properties

      actionName: string
      basePath: string
      defaultBasePath: string
      defaultHeaders: Record<string, any>
      parameterEncoder: ParameterEncoder
      payload: string | Record<string, any>

      Accessors

      • get appendedPaths(): string[]
      • Returns string[]

      • get customHeaders(): Record<string, string>
      • Returns Record<string, string>

      • set customHeaders(headers): void
      • Parameters

        • headers: Record<string, string>

        Returns void

      • get customQueryParameters(): Record<string, string>
      • Returns Record<string, string>

      • set customQueryParameters(queryParameters): void
      • Parameters

        • queryParameters: Record<string, string>

        Returns void

      • get customRequestConfiguration(): Record<string, string>
      • Returns Record<string, string>

      • set customRequestConfiguration(requestConfiguration): void
      • Parameters

        • requestConfiguration: Record<string, string>

        Returns void

      • get fetchCsrfToken(): boolean
      • Returns boolean

      • set fetchCsrfToken(fetchCsrfToken): void
      • Parameters

        • fetchCsrfToken: boolean

        Returns void

      • get middlewares(): HttpMiddleware[]
      • Returns HttpMiddleware[]

      • set middlewares(middlewares): void
      • Parameters

        Returns void

      Methods

      • Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.

        +

        Parameters

        • headers: Record<string, string>

          Key-value pairs where the key is the name of a header property and the value is the respective value.

          +

        Returns void

      • Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.

        +

        Parameters

        • queryParameters: Record<string, string>

          Key-value pairs where the key is the name of a query parameter and the value is the respective value.

          +

        Returns void

      • Add custom request configuration to the request.

        +

        Parameters

        • requestConfiguration: Record<string, string>

          Key-value pairs where the key is the name of a request configuration and the value is the respective value.

          Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

          -

        Returns void

      • Parameters

        • Rest ...path: string[]

        Returns void

      • Parameters

        • params: Record<string, any>

        Returns Record<string, any>

      • Internal

        Returns Record<string, any>

      • Internal

        Returns string

      \ No newline at end of file +

    Returns void

  • Parameters

    • Rest ...path: string[]

    Returns void

  • Parameters

    • params: Record<string, any>

    Returns Record<string, any>

  • Internal

    Returns Record<string, any>

  • Internal

    Returns string

\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.ODataBatchRequestBuilder.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.ODataBatchRequestBuilder.html index 379b4ceeb9..d9728ee2c9 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.ODataBatchRequestBuilder.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.ODataBatchRequestBuilder.html @@ -1,61 +1,61 @@ -ODataBatchRequestBuilder | SAP Cloud SDK for JavaScript - v3.12.1

Create a batch request to invoke multiple requests as a batch. The batch request builder accepts retrieve requests, i.e. getAll and getByKey requests and change sets, which in turn can contain create, update or delete requests. +ODataBatchRequestBuilder | SAP Cloud SDK for JavaScript - v3.12.0

Create a batch request to invoke multiple requests as a batch. The batch request builder accepts retrieve requests, i.e. getAll and getByKey requests and change sets, which in turn can contain create, update or delete requests. The retrieve and change sets will be executed in order, while the order within a change set can vary.

-

Type Parameters

Hierarchy

Constructors

Properties

deSerializers: undefined | DeSerializersT
defaultBasePath: string

Methods

  • Add custom headers to the request. Existing headers will be overwritten.

    -

    Parameters

    • headers: Record<string, string>

      Key-value pairs denoting additional custom headers.

      +

Type Parameters

Hierarchy

Constructors

Properties

deSerializers: undefined | DeSerializersT
defaultBasePath: string

Methods

  • Add custom headers to the request. Existing headers will be overwritten.

    +

    Parameters

    • headers: Record<string, string>

      Key-value pairs denoting additional custom headers.

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.

    -

    Parameters

    • queryParameters: Record<string, string>

      Key-value pairs denoting additional custom query parameters to be set in the request.

      +
  • Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.

    +

    Parameters

    • queryParameters: Record<string, string>

      Key-value pairs denoting additional custom query parameters to be set in the request.

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. +

  • Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. If the custom request configuration contains disallowed keys, those will be ignored.

    -

    Parameters

    • requestConfiguration: Record<string, any>

      Key-value pairs denoting additional custom request configuration options to be set in the request.

      +

      Parameters

      • requestConfiguration: Record<string, string>

        Key-value pairs denoting additional custom request configuration options to be set in the request.

      Returns this

      The request builder itself, to facilitate method chaining.

      -
  • Append the given path to the URL. +

  • Append the given path to the URL. This can be used for querying navigation properties of an entity. To execute a request with an appended path use executeRaw to avoid errors during deserialization. When using this, the execute method is omitted from the return type.

    -

    Parameters

    • Rest ...path: string[]

      Path to be appended.

      +

      Parameters

      • Rest ...path: string[]

        Path to be appended.

      Returns Omit<ODataBatchRequestBuilder<DeSerializersT>, "execute">

      The request builder itself without "execute" function, to facilitate method chaining.

      -
  • Execute the given request and return the according promise. Please notice: The sub-requests may fail even the main request is successful.

    -

    Parameters

    • destination: HttpDestinationOrFetchOptions

      Targeted destination or DestinationFetchOptions on which the request is performed.

      +
  • Execute the given request and return the according promise. Please notice: The sub-requests may fail even the main request is successful.

    +

    Parameters

    Returns Promise<BatchResponse<DeSerializersT>[]>

    Promise resolving to the requested data.

    -
  • Set middleware for requests towards the target system given in the destination.

    -

    Parameters

    • middlewares: HttpMiddleware | HttpMiddleware[]

      Middlewares to be applied to the executeHttpRequest().

      +
  • Set middleware for requests towards the target system given in the destination.

    +

    Parameters

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Parameters

    Returns this

  • Create the relative URL based on configuration of the given builder.

    +
  • Parameters

    Returns this

  • Create the relative URL based on configuration of the given builder.

    Returns string

    The relative URL for the request.

    -
  • Replace the default service path with the given custom path. +

  • Replace the default service path with the given custom path. In case of the SAP S/4HANA APIs the basePath defaults to /sap/opu/odata/sap/<SERVICE_NAME> and can be overwritten here.

    -

    Parameters

    • basePath: string

      Path to override the default with.

      +

      Parameters

      • basePath: string

        Path to override the default with.

      Returns this

      The request builder itself, to facilitate method chaining.

      -
  • Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.

    +
  • Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.

    Returns this

    The request builder itself, to facilitate method chaining.

    -
  • Create the URL based on configuration of the given builder.

    -

    Parameters

    • destination: HttpDestinationOrFetchOptions

      Destination or DestinationFetchOptions to execute the request against.

      +
  • Create the URL based on configuration of the given builder.

    +

    Parameters

    Returns Promise<string>

    Promise resolving to the URL for the request.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
  • Parameters

    Returns this

\ No newline at end of file +
  • Parameters

    Returns this

\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.ODataBoundActionImportRequestConfig.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.ODataBoundActionImportRequestConfig.html index dff913b74c..d1d44ad48a 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.ODataBoundActionImportRequestConfig.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.ODataBoundActionImportRequestConfig.html @@ -1,36 +1,36 @@ -ODataBoundActionImportRequestConfig | SAP Cloud SDK for JavaScript - v3.12.1

Class ODataBoundActionImportRequestConfig<EntityT, DeSerializersT, ParametersT>

Deprecated

Since 3.3.0. Use ODataBoundActionRequestConfig instead.

-

Type Parameters

Hierarchy (view full)

Constructors

Properties

actionName: string
basePath: string
defaultBasePath: string
defaultHeaders: Record<string, any>
keys: Record<string, any>

Map containing the key name and value.

-
parameterEncoder: ParameterEncoder
payload: string | Record<string, any>

Accessors

  • get appendedPaths(): string[]
  • Returns string[]

  • get customHeaders(): Record<string, string>
  • Returns Record<string, string>

  • set customHeaders(headers): void
  • Parameters

    • headers: Record<string, string>

    Returns void

  • get customQueryParameters(): Record<string, string>
  • Returns Record<string, string>

  • set customQueryParameters(queryParameters): void
  • Parameters

    • queryParameters: Record<string, string>

    Returns void

  • get customRequestConfiguration(): Record<string, string>
  • Returns Record<string, string>

  • set customRequestConfiguration(requestConfiguration): void
  • Parameters

    • requestConfiguration: Record<string, string>

    Returns void

  • get fetchCsrfToken(): boolean
  • Returns boolean

  • set fetchCsrfToken(fetchCsrfToken): void
  • Parameters

    • fetchCsrfToken: boolean

    Returns void

  • get middlewares(): HttpMiddleware[]
  • Returns HttpMiddleware[]

  • set middlewares(middlewares): void
  • Parameters

    Returns void

Methods

  • Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.

    -

    Parameters

    • headers: Record<string, string>

      Key-value pairs where the key is the name of a header property and the value is the respective value.

      -

    Returns void

  • Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.

    -

    Parameters

    • queryParameters: Record<string, string>

      Key-value pairs where the key is the name of a query parameter and the value is the respective value.

      -

    Returns void

  • Parameters

    • Rest ...path: string[]

    Returns void

\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.ODataBoundActionRequestConfig.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.ODataBoundActionRequestConfig.html index eb70d5aa31..ad98000ed9 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.ODataBoundActionRequestConfig.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.ODataBoundActionRequestConfig.html @@ -1,37 +1,37 @@ -ODataBoundActionRequestConfig | SAP Cloud SDK for JavaScript - v3.12.1

Class ODataBoundActionRequestConfig<EntityT, DeSerializersT, ParametersT>

Action request configuration for an entity type.

-

Type Parameters

  • EntityT extends EntityBase
  • DeSerializersT extends DeSerializers

    Type of the deserializer use on the request

    -
  • ParametersT

    Type of the parameter to setup a request with

    -

Hierarchy (view full)

Implements

Constructors

Properties

actionName: string
basePath: string
defaultBasePath: string
defaultHeaders: Record<string, any>
keys: Record<string, any>

Map containing the key name and value.

-
parameterEncoder: ParameterEncoder
payload: string | Record<string, any>

Accessors

  • get appendedPaths(): string[]
  • Returns string[]

  • get customHeaders(): Record<string, string>
  • Returns Record<string, string>

  • set customHeaders(headers): void
  • Parameters

    • headers: Record<string, string>

    Returns void

  • get customQueryParameters(): Record<string, string>
  • Returns Record<string, string>

  • set customQueryParameters(queryParameters): void
  • Parameters

    • queryParameters: Record<string, string>

    Returns void

  • get customRequestConfiguration(): Record<string, string>
  • Returns Record<string, string>

  • set customRequestConfiguration(requestConfiguration): void
  • Parameters

    • requestConfiguration: Record<string, string>

    Returns void

  • get fetchCsrfToken(): boolean
  • Returns boolean

  • set fetchCsrfToken(fetchCsrfToken): void
  • Parameters

    • fetchCsrfToken: boolean

    Returns void

  • get middlewares(): HttpMiddleware[]
  • Returns HttpMiddleware[]

  • set middlewares(middlewares): void
  • Parameters

    Returns void

Methods

  • Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.

    -

    Parameters

    • headers: Record<string, string>

      Key-value pairs where the key is the name of a header property and the value is the respective value.

      -

    Returns void

  • Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.

    -

    Parameters

    • queryParameters: Record<string, string>

      Key-value pairs where the key is the name of a query parameter and the value is the respective value.

      -

    Returns void

  • Parameters

    • Rest ...path: string[]

    Returns void

  • Internal

    Returns Record<string, any>

\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.ODataBoundFunctionRequestConfig.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.ODataBoundFunctionRequestConfig.html index 2aa247a2e9..56084eff68 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.ODataBoundFunctionRequestConfig.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.ODataBoundFunctionRequestConfig.html @@ -1,37 +1,37 @@ -ODataBoundFunctionRequestConfig | SAP Cloud SDK for JavaScript - v3.12.1

Class ODataBoundFunctionRequestConfig<EntityT, DeSerializersT, ParametersT>

Function request configuration for an entity type.

-

Type Parameters

  • EntityT extends EntityBase
  • DeSerializersT extends DeSerializers

    Type of the deserializer use on the request

    -
  • ParametersT

    Type of the parameter to setup a request with

    -

Hierarchy (view full)

Implements

Constructors

Properties

basePath: string
defaultBasePath: string
defaultHeaders: Record<string, any>
functionName: string
keys: Record<string, any>

Map containing the key name and value.

-
parameterEncoder: ParameterEncoder
payload: string | Record<string, any>

Accessors

  • get appendedPaths(): string[]
  • Returns string[]

  • get customHeaders(): Record<string, string>
  • Returns Record<string, string>

  • set customHeaders(headers): void
  • Parameters

    • headers: Record<string, string>

    Returns void

  • get customQueryParameters(): Record<string, string>
  • Returns Record<string, string>

  • set customQueryParameters(queryParameters): void
  • Parameters

    • queryParameters: Record<string, string>

    Returns void

  • get customRequestConfiguration(): Record<string, string>
  • Returns Record<string, string>

  • set customRequestConfiguration(requestConfiguration): void
  • Parameters

    • requestConfiguration: Record<string, string>

    Returns void

  • get fetchCsrfToken(): boolean
  • Returns boolean

  • set fetchCsrfToken(fetchCsrfToken): void
  • Parameters

    • fetchCsrfToken: boolean

    Returns void

  • get middlewares(): HttpMiddleware[]
  • Returns HttpMiddleware[]

  • set middlewares(middlewares): void
  • Parameters

    Returns void

Methods

  • Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.

    -

    Parameters

    • headers: Record<string, string>

      Key-value pairs where the key is the name of a header property and the value is the respective value.

      -

    Returns void

  • Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.

    -

    Parameters

    • queryParameters: Record<string, string>

      Key-value pairs where the key is the name of a query parameter and the value is the respective value.

      -

    Returns void

  • Parameters

    • Rest ...path: string[]

    Returns void

  • Internal

    Returns Record<string, any>

\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.ODataFunctionRequestConfig.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.ODataFunctionRequestConfig.html index dcc0c66235..dabd274a04 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.ODataFunctionRequestConfig.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.ODataFunctionRequestConfig.html @@ -1,40 +1,40 @@ -ODataFunctionRequestConfig | SAP Cloud SDK for JavaScript - v3.12.1

Class ODataFunctionRequestConfig<DeSerializersT, ParametersT>

Function request configuration for an entity type.

-

Type Parameters

  • DeSerializersT extends DeSerializers

    Type of the deserializer use on the request

    -
  • ParametersT

    Type of the parameter to setup a request with

    -

Hierarchy (view full)

Constructors

Properties

basePath: string
defaultBasePath: string
defaultHeaders: Record<string, any>
functionName: string
parameterEncoder: ParameterEncoder
payload: string | Record<string, any>

Accessors

  • get appendedPaths(): string[]
  • Returns string[]

  • get customHeaders(): Record<string, string>
  • Returns Record<string, string>

  • set customHeaders(headers): void
  • Parameters

    • headers: Record<string, string>

    Returns void

  • get customQueryParameters(): Record<string, string>
  • Returns Record<string, string>

  • set customQueryParameters(queryParameters): void
  • Parameters

    • queryParameters: Record<string, string>

    Returns void

  • get customRequestConfiguration(): Record<string, string>
  • Returns Record<string, string>

  • set customRequestConfiguration(requestConfiguration): void
  • Parameters

    • requestConfiguration: Record<string, string>

    Returns void

  • get fetchCsrfToken(): boolean
  • Returns boolean

  • set fetchCsrfToken(fetchCsrfToken): void
  • Parameters

    • fetchCsrfToken: boolean

    Returns void

  • get middlewares(): HttpMiddleware[]
  • Returns HttpMiddleware[]

  • set middlewares(middlewares): void
  • Parameters

    Returns void

Methods

  • Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.

    -

    Parameters

    • headers: Record<string, string>

      Key-value pairs where the key is the name of a header property and the value is the respective value.

      -

    Returns void

  • Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.

    -

    Parameters

    • queryParameters: Record<string, string>

      Key-value pairs where the key is the name of a query parameter and the value is the respective value.

      -

    Returns void

  • Parameters

    • Rest ...path: string[]

    Returns void

  • Internal

    Returns Record<string, any>

\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.OperationRequestBuilder.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.OperationRequestBuilder.html index c125f2c044..fbdbbc8d2f 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.OperationRequestBuilder.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.OperationRequestBuilder.html @@ -1,70 +1,70 @@ -OperationRequestBuilder | SAP Cloud SDK for JavaScript - v3.12.1

Class OperationRequestBuilder<DeSerializersT, ParametersT, ReturnT>

Create OData request to execute an operation.

-

Type Parameters

  • DeSerializersT extends DeSerializers
  • ParametersT

    Type of the operation parameters.

    -
  • ReturnT

    Type of the operation return value.

    -

Hierarchy (view full)

Constructors

Properties

_deSerializers: DeSerializersT
requestConfig: ODataRequestConfig
responseTransformer: ((data) => ReturnT)

Type declaration

Methods

\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.UpdateRequestBuilder.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.UpdateRequestBuilder.html index 1c7a9e1436..4fa37847f2 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.UpdateRequestBuilder.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_odata_v4.UpdateRequestBuilder.html @@ -1,97 +1,97 @@ -UpdateRequestBuilder | SAP Cloud SDK for JavaScript - v3.12.1

Class UpdateRequestBuilder<EntityT, DeSerializersT>

Create OData query to update an entity.

-

Type Parameters

Hierarchy (view full)

Implements

Constructors

Properties

_deSerializers: DeSerializersT

Dummy property to also include the deserializer type in the structure of the entity type.

-
_entity: EntityT

Dummy property whose type makes structurally identical entities distinguishable in TypeScript.

-
entitySerializer: EntitySerializer
extractODataEtag: ((json) => undefined | string)

Type declaration

    • (json): undefined | string
    • Parameters

      • json: Record<string, any>

      Returns undefined | string

payloadManipulator: ((body) => Record<string, any>)

Type declaration

    • (body): Record<string, any>
    • Parameters

      • body: Record<string, any>

      Returns Record<string, any>

Accessors

  • get entity(): EntityT
  • Returns EntityT

Methods

\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_openapi.OpenApiRequestBuilder.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_openapi.OpenApiRequestBuilder.html index 4f62d9a60b..b1b02306c3 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_openapi.OpenApiRequestBuilder.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_openapi.OpenApiRequestBuilder.html @@ -1,35 +1,35 @@ -OpenApiRequestBuilder | SAP Cloud SDK for JavaScript - v3.12.1

Request builder for OpenAPI requests.

-

Type Parameters

  • ResponseT = any

    Type of the response for the request.

    -

Constructors

  • Create an instance of OpenApiRequestBuilder.

    -

    Type Parameters

    • ResponseT = any

    Parameters

    • method: Method

      HTTP method of the request to be built.

      -
    • pathPattern: string

      Path for the request containing path parameter references as in the OpenAPI specification.

      -
    • Optional parameters: OpenApiRequestParameters

      Query parameters and or body to pass to the request.

      -

    Returns OpenApiRequestBuilder<ResponseT>

Properties

method: Method

Methods

  • Add custom headers to the request. If a header field with the given name already exists it is overwritten.

    -

    Parameters

    • headers: Record<string, string>

      Key-value pairs denoting additional custom headers.

      +OpenApiRequestBuilder | SAP Cloud SDK for JavaScript - v3.12.0

      Request builder for OpenAPI requests.

      +

      Type Parameters

      • ResponseT = any

        Type of the response for the request.

        +

      Constructors

      • Create an instance of OpenApiRequestBuilder.

        +

        Type Parameters

        • ResponseT = any

        Parameters

        • method: Method

          HTTP method of the request to be built.

          +
        • pathPattern: string

          Path for the request containing path parameter references as in the OpenAPI specification.

          +
        • Optional parameters: OpenApiRequestParameters

          Query parameters and or body to pass to the request.

          +

        Returns OpenApiRequestBuilder<ResponseT>

      Properties

      method: Method

      Methods

      • Add custom headers to the request. If a header field with the given name already exists it is overwritten.

        +

        Parameters

        • headers: Record<string, string>

          Key-value pairs denoting additional custom headers.

        Returns this

        The request builder itself, to facilitate method chaining.

        -
      • Add custom request configuration to the request. Typically, this is used when specifying response type for downloading files. +

      • Add custom request configuration to the request. Typically, this is used when specifying response type for downloading files. If the custom request configuration contains keys in this list @sap-cloud-sdk/http-client!defaultDisallowedKeys, they will be removed.

        -

        Parameters

        • requestConfiguration: Record<string, any>

          Key-value pairs denoting additional custom request configuration options to be set in the request.

          +

          Parameters

          • requestConfiguration: Record<string, string>

            Key-value pairs denoting additional custom request configuration options to be set in the request.

          Returns this

          The request builder itself, to facilitate method chaining.

          -
      • Execute request and get the response data. Use this to conveniently access the data of a service without technical information about the response.

        -

        Parameters

        • destination: HttpDestinationOrFetchOptions

          Destination or DestinationFetchOptions to execute the request against.

          +
      • Execute request and get the response data. Use this to conveniently access the data of a service without technical information about the response.

        +

        Parameters

        Returns Promise<ResponseT>

        A promise resolving to the requested return type.

        -
      • Set middleware for requests towards the target system given in the destination.

        -

        Parameters

        • middlewares: HttpMiddleware | HttpMiddleware[]

          Middlewares to be applied to the executeHttpRequest().

          +
      • Set middleware for requests towards the target system given in the destination.

        +

        Parameters

        Returns this

        The request builder itself, to facilitate method chaining.

        -
      • Parameters

        Returns this

      • Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.

        +
      • Parameters

        Returns this

      • Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.

        Returns this

        The request builder itself, to facilitate method chaining.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_util.ErrorWithCause.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_util.ErrorWithCause.html index e8ab97de0e..bc3235a0ca 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_util.ErrorWithCause.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_util.ErrorWithCause.html @@ -1,23 +1,25 @@ -ErrorWithCause | SAP Cloud SDK for JavaScript - v3.12.1

Represents an error that was caused by another error.

-

Hierarchy

  • Error
    • ErrorWithCause

Constructors

Properties

cause: Error

Original error, causing this error.

-
message: string
name: string
stack?: string
prepareStackTrace?: ((err, stackTraces) => any)

Optional override for formatting stack traces

-

Type declaration

    • (err, stackTraces): any
    • Parameters

      • err: Error
      • stackTraces: CallSite[]

      Returns any

stackTraceLimit: number

Accessors

\ No newline at end of file diff --git a/knowledge-base/api-reference/classes/sap_cloud_sdk_util.UniqueNameGenerator.html b/knowledge-base/api-reference/classes/sap_cloud_sdk_util.UniqueNameGenerator.html index 53846a232b..e9d5b92c94 100644 --- a/knowledge-base/api-reference/classes/sap_cloud_sdk_util.UniqueNameGenerator.html +++ b/knowledge-base/api-reference/classes/sap_cloud_sdk_util.UniqueNameGenerator.html @@ -1,48 +1,48 @@ -UniqueNameGenerator | SAP Cloud SDK for JavaScript - v3.12.1

Holds state on already used names and provides new names if there are naming conflicts.

-

Constructors

  • Creates an instance of UniqueNameGenerator.

    -

    Parameters

    • Optional indexSeparator: string

      The separator to be used when adding an index.

      -
    • Optional usedNames: readonly string[]

      Sets the already used names considered in the finding process.

      -

    Returns UniqueNameGenerator

Methods

  • Adds the name(s) to the already used names.

    -

    Parameters

    • Rest ...names: string[]

      Names to be added.

      -

    Returns void

  • Generate a unique name by appending an index separated by the indexSeparator if necessary, e.g. if MyName is already taken MyName_1 will be found by default. +UniqueNameGenerator | SAP Cloud SDK for JavaScript - v3.12.0

    Holds state on already used names and provides new names if there are naming conflicts.

    +

    Constructors

    • Creates an instance of UniqueNameGenerator.

      +

      Parameters

      • Optional indexSeparator: string

        The separator to be used when adding an index.

        +
      • Optional usedNames: readonly string[]

        Sets the already used names considered in the finding process.

        +

      Returns UniqueNameGenerator

    Methods

    • Adds the name(s) to the already used names.

      +

      Parameters

      • Rest ...names: string[]

        Names to be added.

        +

      Returns void

    • Generate a unique name by appending an index separated by the indexSeparator if necessary, e.g. if MyName is already taken MyName_1 will be found by default. The generated name is added to the used names. If the name is already unique nothing is appended.

      -

      Parameters

      • name: string

        The name to get a unique name from.

        -
      • Optional caseSensitive: boolean

        Whether to check the already used names in a case sensitive manner.

        +

        Parameters

        • name: string

          The name to get a unique name from.

          +
        • Optional caseSensitive: boolean

          Whether to check the already used names in a case sensitive manner.

        Returns string

        A unique name.

        -
    • Generate unique names by appending an index separated by the indexSeparator if necessary, while respecting the given suffixes. +

    • Generate unique names by appending an index separated by the indexSeparator if necessary, while respecting the given suffixes. If the name is already unique nothing is appended. The generated names are added to the used names. Each given suffix is appended to the unique name in the result. The resulting names are also checked for uniqueness. All names in the result have the same number suffix.

      -

      Parameters

      • name: string

        The name to get a unique name from.

        -
      • suffixes: string[]

        Additional name of suffixes to be considered for the finding process, as well as the output.

        -
      • Optional caseSensitive: boolean

        Whether to check the already used names in a case sensitive manner.

        +

        Parameters

        • name: string

          The name to get a unique name from.

          +
        • suffixes: string[]

          Additional name of suffixes to be considered for the finding process, as well as the output.

          +
        • Optional caseSensitive: boolean

          Whether to check the already used names in a case sensitive manner.

        Returns string[]

        A list of unique names. The length of this array is one plus the number of suffixes provided. The first entry corresponds to the given name.

        Example

        if `MyName` and `MyName_1MySuffix` is already taken, `[MyName_2, MyName_2MySuffix]` will be generated by default.
         
        -
    • Generate a unique name by appending an index separated by the indexSeparator if necessary, e.g. if MyName is already taken MyName_1 will be found by default. +

    • Generate a unique name by appending an index separated by the indexSeparator if necessary, e.g. if MyName is already taken MyName_1 will be found by default. If the name is already unique nothing is appended.

      -

      Parameters

      • name: string

        The name to get a unique name from.

        -
      • Optional caseSensitive: boolean

        Whether to check the already used names in a case sensitive manner.

        +

        Parameters

        • name: string

          The name to get a unique name from.

          +
        • Optional caseSensitive: boolean

          Whether to check the already used names in a case sensitive manner.

        Returns string

        A unique name.

        -
    • Generate unique names by appending an index separated by the indexSeparator if necessary, while respecting the given suffixes. +

    • Generate unique names by appending an index separated by the indexSeparator if necessary, while respecting the given suffixes. If the name is already unique nothing is appended. Each given suffix is appended to the unique name in the result. The resulting names are also checked for uniqueness. All names in the result have the same number suffix.

      -

      Parameters

      • name: string

        The name to get a unique name from.

        -
      • suffixes: string[]

        Additional name of suffixes to be considered for the finding process, as well as the output.

        -
      • Optional caseSensitive: boolean

        Whether to check the already used names in a case sensitive manner.

        +

        Parameters

        • name: string

          The name to get a unique name from.

          +
        • suffixes: string[]

          Additional name of suffixes to be considered for the finding process, as well as the output.

          +
        • Optional caseSensitive: boolean

          Whether to check the already used names in a case sensitive manner.

        Returns string[]

        A list of unique names. The length of this array is one plus the number of suffixes provided. The first entry corresponds to the given name.

        Example

        if `MyName` and `MyName_1MySuffix` is already taken, `[MyName_2, MyName_2MySuffix]` will be generated by default.
         

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
    \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.alwaysProvider.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.alwaysProvider.html index 7b7536c853..86c964877a 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.alwaysProvider.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.alwaysProvider.html @@ -1,6 +1,6 @@ -alwaysProvider | SAP Cloud SDK for JavaScript - v3.12.1
  • Constraints the selection to provider destinations.

    -

    Parameters

    • allDestinations: AllDestinations

      Retrieved destinations.

      -
    • destinationName: string

      Name of the destination to retrieve.

      +alwaysProvider | SAP Cloud SDK for JavaScript - v3.12.0
      • Constraints the selection to provider destinations.

        +

        Parameters

        • allDestinations: AllDestinations

          Retrieved destinations.

          +
        • destinationName: string

          Name of the destination to retrieve.

        Returns Destination | null

        The destination to retrieve, returns null, if no matched provider destination is found.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.alwaysSubscriber.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.alwaysSubscriber.html index 7a7f4ba669..e07e5021c6 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.alwaysSubscriber.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.alwaysSubscriber.html @@ -1,6 +1,6 @@ -alwaysSubscriber | SAP Cloud SDK for JavaScript - v3.12.1
  • Constraints the selection to subscriber destinations.

    -

    Parameters

    • allDestinations: AllDestinations

      Retrieved destinations.

      -
    • destinationName: string

      Name of the destination to retrieve.

      +alwaysSubscriber | SAP Cloud SDK for JavaScript - v3.12.0
      • Constraints the selection to subscriber destinations.

        +

        Parameters

        • allDestinations: AllDestinations

          Retrieved destinations.

          +
        • destinationName: string

          Name of the destination to retrieve.

        Returns Destination | null

        The destination to retrieve, returns null, if no matched subscriber destination is found.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.assertHttpDestination.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.assertHttpDestination.html index 77e4c6441c..782ed04c31 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.assertHttpDestination.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.assertHttpDestination.html @@ -1,5 +1,5 @@ -assertHttpDestination | SAP Cloud SDK for JavaScript - v3.12.1
  • Assertion that the Destination is a HttpDestination. +assertHttpDestination | SAP Cloud SDK for JavaScript - v3.12.0

    • Assertion that the Destination is a HttpDestination. This method comes in handy when you retrieved a destination from the destination service and need to check if it is a HttpDestination.

      -

      Parameters

      • destination: Destination | HttpDestination

        Destination or HttpDestination.

        +

        Parameters

        • destination: Destination | HttpDestination

          Destination or HttpDestination.

          Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

          -

        Returns asserts destination is HttpDestination

    \ No newline at end of file +

Returns asserts destination is HttpDestination

\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.buildHeadersForDestination.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.buildHeadersForDestination.html index 33564a33ed..f8fdf7ca04 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.buildHeadersForDestination.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.buildHeadersForDestination.html @@ -1,5 +1,5 @@ -buildHeadersForDestination | SAP Cloud SDK for JavaScript - v3.12.1
  • Build a request header object, that contains authentication headers and SAP specific headers like 'sap-client', from a given destination.

    -

    Parameters

    • destination: Destination

      The given destination that contains e.g., authentication and SAP client information.

      +buildHeadersForDestination | SAP Cloud SDK for JavaScript - v3.12.0
      • Build a request header object, that contains authentication headers and SAP specific headers like 'sap-client', from a given destination.

        +

        Parameters

        • destination: Destination

          The given destination that contains e.g., authentication and SAP client information.

        Returns Promise<Record<string, string>>

        A request header object, built from the given destination.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.decodeJwt.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.decodeJwt.html index 840226e23e..047ffbfc4a 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.decodeJwt.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.decodeJwt.html @@ -1,5 +1,5 @@ -decodeJwt | SAP Cloud SDK for JavaScript - v3.12.1
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.destinationForServiceBinding.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.destinationForServiceBinding.html index 9697573024..6cecb271c8 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.destinationForServiceBinding.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.destinationForServiceBinding.html @@ -1,9 +1,9 @@ -destinationForServiceBinding | SAP Cloud SDK for JavaScript - v3.12.1
  • Tries to build a destination from a service binding with the given name. +destinationForServiceBinding | SAP Cloud SDK for JavaScript - v3.12.0

    • Tries to build a destination from a service binding with the given name. Throws an error if no services are bound at all, no service with the given name can be found, or the service type is not supported. The last error can be circumvent by using the second parameter to provide a custom function that transforms a service binding to a destination.

      -

      Parameters

    \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.getAgentConfig.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.getAgentConfig.html index 57b819dac2..ed341114dd 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.getAgentConfig.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.getAgentConfig.html @@ -1,8 +1,8 @@ -getAgentConfig | SAP Cloud SDK for JavaScript - v3.12.1
  • Returns the http or https-agent config depending on the destination URL. +getAgentConfig | SAP Cloud SDK for JavaScript - v3.12.0

    • Returns the http or https-agent config depending on the destination URL. If the destination contains a proxy configuration, the agent will be a proxy-agent. If not it will be the default http-agent coming from node.

      -

      Parameters

      • destination: HttpDestination

        Determining which kind of configuration is returned.

        +

        Parameters

        • destination: HttpDestination

          Determining which kind of configuration is returned.

        Returns HttpAgentConfig | HttpsAgentConfig

        The HTTP or HTTPS agent configuration.

        Deprecated

        Temporarily replaced by getAgentConfigAsync, will change its default behavior to be asynchronous in next major release.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
    \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.getAgentConfigAsync.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.getAgentConfigAsync.html index ce9d55a0ca..0f5d624dd5 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.getAgentConfigAsync.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.getAgentConfigAsync.html @@ -1,8 +1,8 @@ -getAgentConfigAsync | SAP Cloud SDK for JavaScript - v3.12.1
  • Will be renamed to getAgentConfig in the next major release. +getAgentConfigAsync | SAP Cloud SDK for JavaScript - v3.12.0

    • Will be renamed to getAgentConfig in the next major release. Returns a promise of the http or https-agent config depending on the destination URL. If the destination contains a proxy configuration, the agent will be a proxy-agent. If not it will be the default http-agent coming from node.

      -

      Parameters

      • destination: HttpDestination

        Determining which kind of configuration is returned.

        +

        Parameters

        • destination: HttpDestination

          Determining which kind of configuration is returned.

        Returns Promise<HttpAgentConfig | HttpsAgentConfig>

        A promise of the HTTP or HTTPS agent configuration.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
    \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.getAllDestinationsFromDestinationService.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.getAllDestinationsFromDestinationService.html index fef43e6352..46f7d2c618 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.getAllDestinationsFromDestinationService.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.getAllDestinationsFromDestinationService.html @@ -1,6 +1,6 @@ -getAllDestinationsFromDestinationService | SAP Cloud SDK for JavaScript - v3.12.1
  • Fetches all destinations from the destination service which match the token. +getAllDestinationsFromDestinationService | SAP Cloud SDK for JavaScript - v3.12.0

    • Fetches all destinations from the destination service which match the token. With a subscriber token it fetches all subscriber destinations, otherwise all provider destinations.

      -

      Parameters

      • Optional options: AllDestinationOptions

        The options to fetch all destinations.

        +

        Parameters

        Returns Promise<DestinationWithoutToken[]>

        A promise of an array of all destinations without authTokens from the destination service, on success.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
    \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.getClientCredentialsToken.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.getClientCredentialsToken.html index 5997e078f8..09cfa84033 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.getClientCredentialsToken.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.getClientCredentialsToken.html @@ -1,6 +1,6 @@ -getClientCredentialsToken | SAP Cloud SDK for JavaScript - v3.12.1
  • Make a client credentials request against the XSUAA service.

    -

    Parameters

\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.getDestination.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.getDestination.html index 1f00304d3a..b0083c76a2 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.getDestination.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.getDestination.html @@ -1,4 +1,4 @@ -getDestination | SAP Cloud SDK for JavaScript - v3.12.1
  • Builds a destination from one of three sources (in the given order):

    +getDestination | SAP Cloud SDK for JavaScript - v3.12.0
    • Builds a destination from one of three sources (in the given order):

      • from the environment variable "destinations".
      • from service bindings.
      • @@ -6,7 +6,7 @@

      If you want to get a destination only from a specific source, use the corresponding function directly (getDestinationFromEnvByName, destinationForServiceBinding, getDestinationFromDestinationService).

      -

      Parameters

    \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.getDestinationFromDestinationService.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.getDestinationFromDestinationService.html index 7be5ead704..dbdbd9be44 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.getDestinationFromDestinationService.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.getDestinationFromDestinationService.html @@ -1,8 +1,8 @@ -getDestinationFromDestinationService | SAP Cloud SDK for JavaScript - v3.12.1
  • Retrieves a destination with the given name from the Cloud Foundry destination service. +getDestinationFromDestinationService | SAP Cloud SDK for JavaScript - v3.12.0

    • Retrieves a destination with the given name from the Cloud Foundry destination service. Returns null, if no destination can be found. Requires the following service bindings: destination, XSUAA By default, selects subscriber over provider and instance over subaccount destinations.

      -

      Parameters

      • options: DestinationFetchOptions

        Configuration for how to retrieve destinations from the destination service.

        +

        Parameters

        Returns Promise<Destination | null>

        A promise returning the requested destination on success.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
    \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.getDestinationFromServiceBinding.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.getDestinationFromServiceBinding.html index 9283a854b7..653feb7b28 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.getDestinationFromServiceBinding.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.getDestinationFromServiceBinding.html @@ -1,7 +1,7 @@ -getDestinationFromServiceBinding | SAP Cloud SDK for JavaScript - v3.12.1
  • Tries to build a destination from a service binding with the given name. +getDestinationFromServiceBinding | SAP Cloud SDK for JavaScript - v3.12.0

    • Tries to build a destination from a service binding with the given name. Throws an error if no services are bound at all, no service with the given name can be found, or the service type is not supported. The last error can be circumvent by using the second parameter to provide a custom function that transforms a service binding to a destination.

      -

      Parameters

    \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.getUserToken.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.getUserToken.html index d250085078..6f663f9f4a 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.getUserToken.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.getUserToken.html @@ -1,6 +1,6 @@ -getUserToken | SAP Cloud SDK for JavaScript - v3.12.1
  • Make a user token request against the XSUAA service.

    -

    Parameters

    • service: Service

      Service as it is defined in the environment variable.

      -
    • userJwt: string

      User JWT.

      +getUserToken | SAP Cloud SDK for JavaScript - v3.12.0
      • Make a user token request against the XSUAA service.

        +

        Parameters

        • service: Service

          Service as it is defined in the environment variable.

          +
        • userJwt: string

          User JWT.

        Returns Promise<string>

        User token.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.isHttpDestination.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.isHttpDestination.html index 343f5d11cc..382a7d860e 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.isHttpDestination.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.isHttpDestination.html @@ -1,5 +1,5 @@ -isHttpDestination | SAP Cloud SDK for JavaScript - v3.12.1
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.jwtBearerToken.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.jwtBearerToken.html index ef358f9d6a..8b3387084a 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.jwtBearerToken.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.jwtBearerToken.html @@ -1,8 +1,8 @@ -jwtBearerToken | SAP Cloud SDK for JavaScript - v3.12.1
  • Returns a jwt bearer token that can be used to call the given service. +jwtBearerToken | SAP Cloud SDK for JavaScript - v3.12.0

    • Returns a jwt bearer token that can be used to call the given service. The token is fetched via a JWT bearer token grant using the user token + client credentials.

      Throws an error if there is no instance of the given service type or the XSUAA service, or if the request to the XSUAA service fails.

      -

      Parameters

      • jwt: string

        The JWT of the user for whom the access token should be fetched.

        -
      • service: string | Service

        The type of the service or an instance of Service.

        +

        Parameters

        • jwt: string

          The JWT of the user for whom the access token should be fetched.

          +
        • service: string | Service

          The type of the service or an instance of Service.

        Returns Promise<string>

        A jwt bearer token.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
    \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.parseDestination.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.parseDestination.html index 0e07c77969..31b55784ba 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.parseDestination.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.parseDestination.html @@ -1,7 +1,7 @@ -parseDestination | SAP Cloud SDK for JavaScript - v3.12.1
  • Takes a JSON object returned by any of the calls to the destination service and returns an SDK compatible destination object. +parseDestination | SAP Cloud SDK for JavaScript - v3.12.0

    • Takes a JSON object returned by any of the calls to the destination service and returns an SDK compatible destination object. This function only accepts destination configurations of type 'HTTP' and will error if no 'URL' is given. TODO: deprecated: Remove from public api in version 4. (Check if related types can also be removed from public api).

      -

      Parameters

    \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.parseProxyEnv.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.parseProxyEnv.html index d57a5665d4..4718fe0d77 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.parseProxyEnv.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.parseProxyEnv.html @@ -1,7 +1,7 @@ -parseProxyEnv | SAP Cloud SDK for JavaScript - v3.12.1
  • Parses the environment variable for the web proxy and extracts the values considering defaults like http for the protocol and 80 or 443 for the port. +parseProxyEnv | SAP Cloud SDK for JavaScript - v3.12.0

    • Parses the environment variable for the web proxy and extracts the values considering defaults like http for the protocol and 80 or 443 for the port. The general pattern to be parsed is protocol://user:password@host:port, where everything besides the host is optional. Special characters in the user and password need to be percent encoded.

      -

      Parameters

      • proxyEnvValue: string

        Environment variable which is parsed.

        +

        Parameters

        • proxyEnvValue: string

          Environment variable which is parsed.

        Returns ProxyConfiguration | undefined

        Configuration with default values or undefined if the parsing failed.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
    \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.registerDestination.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.registerDestination.html index aa361a184c..7f60e6a298 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.registerDestination.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.registerDestination.html @@ -1,7 +1,7 @@ -registerDestination | SAP Cloud SDK for JavaScript - v3.12.1
  • Registers a destination in a cache for later usage.

    +registerDestination | SAP Cloud SDK for JavaScript - v3.12.0
    • Registers a destination in a cache for later usage.

      If a destination with the same key is already in the cache, it is replaced. The key is built using the getDestinationCacheKey method.

      -

      Parameters

      • destination: DestinationWithName

        A destination to add to the destinations cache.

        -
      • Optional options: RegisterDestinationOptions

        Options how to cache the destination.

        +

        Parameters

        • destination: DestinationWithName

          A destination to add to the destinations cache.

          +
        • Optional options: RegisterDestinationOptions

          Options how to cache the destination.

          Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

          -

        Returns Promise<void>

    \ No newline at end of file +

Returns Promise<void>

\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.retrieveJwt.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.retrieveJwt.html index ac966262a1..9d6691b480 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.retrieveJwt.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.retrieveJwt.html @@ -1,5 +1,5 @@ -retrieveJwt | SAP Cloud SDK for JavaScript - v3.12.1
  • Retrieve JWT from a request that is based on the node IncomingMessage. Fails if no authorization header is given or has the wrong format. Expected format is 'Bearer '.

    -

    Parameters

    • req: IncomingMessage

      Request to retrieve the JWT from.

      +retrieveJwt | SAP Cloud SDK for JavaScript - v3.12.0
      • Retrieve JWT from a request that is based on the node IncomingMessage. Fails if no authorization header is given or has the wrong format. Expected format is 'Bearer '.

        +

        Parameters

        • req: IncomingMessage

          Request to retrieve the JWT from.

        Returns string | undefined

        JWT found in header.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.sanitizeDestination.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.sanitizeDestination.html index 66510bff25..a56e5fd3fe 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.sanitizeDestination.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.sanitizeDestination.html @@ -1,5 +1,5 @@ -sanitizeDestination | SAP Cloud SDK for JavaScript - v3.12.1
  • Takes an existing or a parsed destination and returns an SDK compatible destination object.

    -

    Parameters

    • destination: Record<string, any>

      An object that adheres to the Destination interface.

      +sanitizeDestination | SAP Cloud SDK for JavaScript - v3.12.0
      • Takes an existing or a parsed destination and returns an SDK compatible destination object.

        +

        Parameters

        • destination: Record<string, any>

          An object that adheres to the Destination interface.

        Returns Destination

        An SDK compatible destination object.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.serviceToken.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.serviceToken.html index 6c38108774..9ecaeb5512 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.serviceToken.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.serviceToken.html @@ -1,10 +1,10 @@ -serviceToken | SAP Cloud SDK for JavaScript - v3.12.1
  • Returns an access token that can be used to call the given service. The token is fetched via a client credentials grant with the credentials of the given service. +serviceToken | SAP Cloud SDK for JavaScript - v3.12.0

    • Returns an access token that can be used to call the given service. The token is fetched via a client credentials grant with the credentials of the given service. If multiple instances of the provided service exist, the first instance will be selected. When a JWT is passed, the tenant of the JWT will be used when performing the grant. When no JWT is passed, the grant will be performed using the provider tenant.

      Throws an error if there is no instance of the given service type or the XSUAA service, or if the request to the XSUAA service fails.

      -

      Parameters

      • service: string | Service

        The type of the service or an instance of Service.

        -
      • Optional options: CachingOptions & {
            jwt?: string | JwtPayload;
            xsuaaCredentials?: XsuaaServiceCredentials;
        }

        Options to influence caching behavior (see CachingOptions) and a JWT. By default, caching and usage of a circuit breaker are enabled.

        +

        Parameters

        Returns Promise<string>

        Access token.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
    \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.setDestinationCache.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.setDestinationCache.html index 5b31f5f601..82e5936acd 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.setDestinationCache.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.setDestinationCache.html @@ -1,6 +1,6 @@ -setDestinationCache | SAP Cloud SDK for JavaScript - v3.12.1

Returns void

\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.subscriberFirst.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.subscriberFirst.html index 6e72c21554..10dbda7eef 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.subscriberFirst.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.subscriberFirst.html @@ -1,6 +1,6 @@ -subscriberFirst | SAP Cloud SDK for JavaScript - v3.12.1
  • Prioritizes the selection of subscriber destinations.

    -

    Parameters

    • allDestinations: AllDestinations

      Retrieved destinations.

      -
    • destinationName: string

      Name of the destination to retrieve.

      +subscriberFirst | SAP Cloud SDK for JavaScript - v3.12.0
      • Prioritizes the selection of subscriber destinations.

        +

        Parameters

        • allDestinations: AllDestinations

          Retrieved destinations.

          +
        • destinationName: string

          Name of the destination to retrieve.

        Returns Destination | null

        The destination to retrieve, returns null if no matched destination is found.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.toDestinationNameUrl.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.toDestinationNameUrl.html index b8d1c29307..e126a38a18 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.toDestinationNameUrl.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.toDestinationNameUrl.html @@ -1,5 +1,5 @@ -toDestinationNameUrl | SAP Cloud SDK for JavaScript - v3.12.1
  • Transform destination to string containing destination information.

    -

    Parameters

    • destination: DestinationOrFetchOptions

      Either destination object or destinationName and Jwt.

      +toDestinationNameUrl | SAP Cloud SDK for JavaScript - v3.12.0
      • Transform destination to string containing destination information.

        +

        Parameters

        Returns string

        String containing information on the destination.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.useOrFetchDestination.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.useOrFetchDestination.html index e3b4b4628f..d82cbb4623 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.useOrFetchDestination.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_connectivity.useOrFetchDestination.html @@ -1,4 +1,4 @@ -useOrFetchDestination | SAP Cloud SDK for JavaScript - v3.12.1
  • Returns the parameter if it is a destination, calls getDestination otherwise (which will try to fetch the destination +useOrFetchDestination | SAP Cloud SDK for JavaScript - v3.12.0

    • Returns the parameter if it is a destination, calls getDestination otherwise (which will try to fetch the destination from the Cloud Foundry destination service).

      Fetching a destination requires:

        @@ -6,7 +6,7 @@
      • A binding to a destination service instance.

      If either of the prerequisites is not met or one of the services returns an error, this function will either throw an error or return a promise that rejects.

      -

      Parameters

      • destination: DestinationOrFetchOptions

        A destination or the necessary parameters to fetch one.

        +

        Parameters

        Returns Promise<Destination | null>

        A promise resolving to the requested destination on success.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
    \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_generator.generate.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_generator.generate.html index 06ed2b2516..39f705e7ee 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_generator.generate.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_generator.generate.html @@ -1,6 +1,6 @@ -generate | SAP Cloud SDK for JavaScript - v3.12.1
  • Main entry point for the OData client generation. +generate | SAP Cloud SDK for JavaScript - v3.12.0

    • Main entry point for the OData client generation. Generates models and API files.

      -

      Parameters

      • options: GeneratorOptions & {
            config?: string;
        }

        Options to configure generation.

        +

        Parameters

        • options: GeneratorOptions & {
              config?: string;
          }

          Options to configure generation.

        Returns Promise<void>

        A promise to void.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
    \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_http_client.buildHttpRequest.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_http_client.buildHttpRequest.html index 647115f12f..6de2cb35bc 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_http_client.buildHttpRequest.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_http_client.buildHttpRequest.html @@ -1,6 +1,6 @@ -buildHttpRequest | SAP Cloud SDK for JavaScript - v3.12.1
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_http_client.csrf.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_http_client.csrf.html index bd2b10e654..5e704b469b 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_http_client.csrf.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_http_client.csrf.html @@ -1,6 +1,6 @@ -csrf | SAP Cloud SDK for JavaScript - v3.12.1
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_http_client.encodeAllParameters.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_http_client.encodeAllParameters.html index 6b6b454a14..7326f36271 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_http_client.encodeAllParameters.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_http_client.encodeAllParameters.html @@ -1,5 +1,5 @@ -encodeAllParameters | SAP Cloud SDK for JavaScript - v3.12.1
  • Encoder for encoding all query parameters (key and value) using encodeURIComponent.

    -

    Parameters

\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_http_client.executeHttpRequest.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_http_client.executeHttpRequest.html index 686e6605cd..2dd331297b 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_http_client.executeHttpRequest.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_http_client.executeHttpRequest.html @@ -1,7 +1,7 @@ -executeHttpRequest | SAP Cloud SDK for JavaScript - v3.12.1
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_http_client.executeHttpRequestWithOrigin.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_http_client.executeHttpRequestWithOrigin.html index 6e449b919a..73aeca3280 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_http_client.executeHttpRequestWithOrigin.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_http_client.executeHttpRequestWithOrigin.html @@ -1,4 +1,4 @@ -executeHttpRequestWithOrigin | SAP Cloud SDK for JavaScript - v3.12.1
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_mail_client.sendMail.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_mail_client.sendMail.html index e18675c753..0a610f7d97 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_mail_client.sendMail.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_mail_client.sendMail.html @@ -1,10 +1,10 @@ -sendMail | SAP Cloud SDK for JavaScript - v3.12.1
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_common.and.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_common.and.html index ce78495616..c2e50a7c9b 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_common.and.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_common.and.html @@ -1,6 +1,6 @@ -and | SAP Cloud SDK for JavaScript - v3.12.1
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_common.asc.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_common.asc.html index 8339725091..8eec80cc61 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_common.asc.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_common.asc.html @@ -1,6 +1,6 @@ -asc | SAP Cloud SDK for JavaScript - v3.12.1
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_common.desc.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_common.desc.html index c6b044934e..246c830bf6 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_common.desc.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_common.desc.html @@ -1,6 +1,6 @@ -desc | SAP Cloud SDK for JavaScript - v3.12.1
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_common.entityBuilder-1.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_common.entityBuilder-1.html index 9fe5014714..7ce84d280c 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_common.entityBuilder-1.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_common.entityBuilder-1.html @@ -1,5 +1,5 @@ -entityBuilder | SAP Cloud SDK for JavaScript - v3.12.1
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_common.entityDeserializer-1.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_common.entityDeserializer-1.html index 10e4fb7bd5..1a6a612686 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_common.entityDeserializer-1.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_common.entityDeserializer-1.html @@ -1,8 +1,8 @@ -entityDeserializer | SAP Cloud SDK for JavaScript - v3.12.1
  • Constructs an entityDeserializer given the OData v2 or v4 specific methods. +entityDeserializer | SAP Cloud SDK for JavaScript - v3.12.0

    • Constructs an entityDeserializer given the OData v2 or v4 specific methods. The concrete deserializers are created in odata/v2/entity-deserializer.ts and odata/v4/entity-deserializer.ts.

      -

      Type Parameters

      • T extends DeSerializers<any, any, any, any, any, any, any, any, any, any, any, any, any, any>

      Parameters

      • deSerializers: T

        (De-)serializers used for transformation.

        -
      • extractODataETag: ((json) => undefined | string)

        Extractor for the ETag.

        -
          • (json): undefined | string
          • Parameters

            • json: Record<string, any>

            Returns undefined | string

      • extractDataFromOneToManyLink: ((data) => any[])

        Extractor for data related to one to many links.

        -
          • (data): any[]
          • Parameters

            • data: any

            Returns any[]

      Returns EntityDeserializer

      An entity deserializer as defined by EntityDeserializer.

      +

    Type Parameters

    • T extends DeSerializers<any, any, any, any, any, any, any, any, any, any, any, any, any, any>

    Parameters

    • deSerializers: T

      (De-)serializers used for transformation.

      +
    • extractODataETag: ((json) => undefined | string)

      Extractor for the ETag.

      +
        • (json): undefined | string
        • Parameters

          • json: Record<string, any>

          Returns undefined | string

    • extractDataFromOneToManyLink: ((data) => any[])

      Extractor for data related to one to many links.

      +
        • (data): any[]
        • Parameters

          • data: any

          Returns any[]

    Returns EntityDeserializer

    An entity deserializer as defined by EntityDeserializer.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_common.entitySerializer-1.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_common.entitySerializer-1.html index e30d94919b..bf841d095e 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_common.entitySerializer-1.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_common.entitySerializer-1.html @@ -1,6 +1,6 @@ -entitySerializer | SAP Cloud SDK for JavaScript - v3.12.1
  • Constructs an entitySerializer given the OData v2 or v4 specific tsToEdm method. +entitySerializer | SAP Cloud SDK for JavaScript - v3.12.0

    • Constructs an entitySerializer given the OData v2 or v4 specific tsToEdm method. The concrete serializers are created in odata/v2/entity-serializer.ts and odata/v4/entity-serializer.ts.

      -

      Parameters

      • deSerializers: DeSerializers<any, any, any, any, any, any, any, any, any, any, any, any, any, any>

        (De-)serializers used for transformation.

        +

        Parameters

        • deSerializers: DeSerializers<any, any, any, any, any, any, any, any, any, any, any, any, any, any>

          (De-)serializers used for transformation.

        Returns EntitySerializer

        A entity serializer as defined by EntitySerializer.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
    \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_common.filterFunction-1.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_common.filterFunction-1.html index 699bd0d466..8395029928 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_common.filterFunction-1.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_common.filterFunction-1.html @@ -1,2 +1,2 @@

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-filterFunction | SAP Cloud SDK for JavaScript - v3.12.1
\ No newline at end of file +filterFunction | SAP Cloud SDK for JavaScript - v3.12.0
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_common.isOrderableEdmType.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_common.isOrderableEdmType.html index 494fd51d48..5e1cb858a5 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_common.isOrderableEdmType.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_common.isOrderableEdmType.html @@ -1,5 +1,5 @@ -isOrderableEdmType | SAP Cloud SDK for JavaScript - v3.12.1
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_common.not.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_common.not.html index ee5b62b74a..43d824c9ed 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_common.not.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_common.not.html @@ -1,5 +1,5 @@ -not | SAP Cloud SDK for JavaScript - v3.12.1
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_common.or.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_common.or.html index 2fb65a3094..34668839f9 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_common.or.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_common.or.html @@ -1,8 +1,8 @@ -or | SAP Cloud SDK for JavaScript - v3.12.1
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_common.throwErrorWhenReturnTypeIsUnionType.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_common.throwErrorWhenReturnTypeIsUnionType.html index 7c1eb1b8b6..c747c73b52 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_common.throwErrorWhenReturnTypeIsUnionType.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_common.throwErrorWhenReturnTypeIsUnionType.html @@ -1,5 +1,5 @@ -throwErrorWhenReturnTypeIsUnionType | SAP Cloud SDK for JavaScript - v3.12.1
  • Throws an error.

    -

    Parameters

    • data: any

      Data.

      -
    • functionActionName: string

      FunctionActionName.

      +throwErrorWhenReturnTypeIsUnionType | SAP Cloud SDK for JavaScript - v3.12.0
      • Throws an error.

        +

        Parameters

        • data: any

          Data.

          +
        • functionActionName: string

          FunctionActionName.

          Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

          -

        Returns never

      \ No newline at end of file +

    Returns never

\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_common.transformVariadicArgumentToArray.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_common.transformVariadicArgumentToArray.html index 96f147ed5c..2bf3d3b342 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_common.transformVariadicArgumentToArray.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_common.transformVariadicArgumentToArray.html @@ -1,10 +1,10 @@ -transformVariadicArgumentToArray | SAP Cloud SDK for JavaScript - v3.12.1
  • We want to provide methods which accept a variable single number of elements and arrays. +transformVariadicArgumentToArray | SAP Cloud SDK for JavaScript - v3.12.0

    • We want to provide methods which accept a variable single number of elements and arrays. The overloaded signature to achieve this is:

      function doSomething(array: T[])
      function doSomething(...varArgs: T[])
      function doSomething(first: undefined | T | T[], ...rest: T[]) {
      //implementation
      }

      This wrapper methods makes it easy build an array from the input.

      -

      Type Parameters

      • T

      Parameters

      • firstOrArray: undefined | T | T[]

        Either an array, the first element of the var args or undefined, if no argument was given.

        -
      • rest: T[]

        Second to last element, if var args were used, empty array, if the first argument is an array.

        +

        Type Parameters

        • T

        Parameters

        • firstOrArray: undefined | T | T[]

          Either an array, the first element of the var args or undefined, if no argument was given.

          +
        • rest: T[]

          Second to last element, if var args were used, empty array, if the first argument is an array.

        Returns T[]

        Array from the input or empty array if no input was given.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
    \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.edmToTs.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.edmToTs.html index 19bb83fc29..daf6ef23cf 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.edmToTs.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.edmToTs.html @@ -1,7 +1,7 @@ -edmToTs | SAP Cloud SDK for JavaScript - v3.12.1
  • Convert a value from EDM format to TypeScript. This function is typically used when deserializing an OData response.

    -

    Parameters

    • value: any

      The original value with EDM format.

      -
    • edmType: EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4

      The EDM type of that value.

      -
    • deSerializers: DeSerializers<any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any>

      (De-)serializers used for transformation.

      +edmToTs | SAP Cloud SDK for JavaScript - v3.12.0
      • Convert a value from EDM format to TypeScript. This function is typically used when deserializing an OData response.

        +

        Parameters

        Returns any

        Deserialized value.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.entityDeserializer.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.entityDeserializer.html index 2cc559d301..a5ea42a020 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.entityDeserializer.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.entityDeserializer.html @@ -1,6 +1,6 @@ -entityDeserializer | SAP Cloud SDK for JavaScript - v3.12.1
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.filterFunctions.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.filterFunctions.html index 4e225093fe..11fd2517d0 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.filterFunctions.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.filterFunctions.html @@ -1,5 +1,5 @@ -filterFunctions | SAP Cloud SDK for JavaScript - v3.12.1
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.length.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.length.html index 696affa06e..2ded51f030 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.length.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.length.html @@ -1,3 +1,3 @@ -length | SAP Cloud SDK for JavaScript - v3.12.1
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.mergeDefaultDeSerializersWith.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.mergeDefaultDeSerializersWith.html index e6c033347e..a519c5fe44 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.mergeDefaultDeSerializersWith.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.mergeDefaultDeSerializersWith.html @@ -1,6 +1,6 @@ -mergeDefaultDeSerializersWith | SAP Cloud SDK for JavaScript - v3.12.1
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.replace.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.replace.html index 2ee8243a3c..9044a2a4a8 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.replace.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.replace.html @@ -1,7 +1,7 @@ -replace | SAP Cloud SDK for JavaScript - v3.12.1
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.substring.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.substring.html index 9da899a819..205c9608ee 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.substring.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.substring.html @@ -1,3 +1,3 @@ -substring | SAP Cloud SDK for JavaScript - v3.12.1
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.substringOf.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.substringOf.html index 69dcc6d460..22aecb8f88 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.substringOf.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.substringOf.html @@ -1,6 +1,6 @@ -substringOf | SAP Cloud SDK for JavaScript - v3.12.1
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.transformReturnValueForComplexType.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.transformReturnValueForComplexType.html index 9c8453ce8d..3688b4bb23 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.transformReturnValueForComplexType.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.transformReturnValueForComplexType.html @@ -1,6 +1,6 @@ -transformReturnValueForComplexType | SAP Cloud SDK for JavaScript - v3.12.1
  • Transform the payload of the OData response to a complex type by using given deserialization function.

    -

    Type Parameters

    • ReturnT

    Parameters

    • data: any

      The OData payload.

      -
    • builderFn: ((data) => ReturnT)

      The deserialization function for transforming the payload.

      -

    Returns ReturnT

    The transformed value.

    +transformReturnValueForComplexType | SAP Cloud SDK for JavaScript - v3.12.0
    • Transform the payload of the OData response to a complex type by using given deserialization function.

      +

      Type Parameters

      • ReturnT

      Parameters

      • data: any

        The OData payload.

        +
      • builderFn: ((data) => ReturnT)

        The deserialization function for transforming the payload.

        +

      Returns ReturnT

      The transformed value.

      Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

      -
    \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.transformReturnValueForComplexTypeList.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.transformReturnValueForComplexTypeList.html index 6d0007fad7..2141a4409f 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.transformReturnValueForComplexTypeList.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.transformReturnValueForComplexTypeList.html @@ -1,6 +1,6 @@ -transformReturnValueForComplexTypeList | SAP Cloud SDK for JavaScript - v3.12.1
  • Transform the payload of the OData response to complex type array by using given deserialization function.

    -

    Type Parameters

    • ReturnT

    Parameters

    • data: any

      The OData payload.

      -
    • builderFn: ((data) => ReturnT)

      The deserialization function for transforming the payload.

      -

    Returns ReturnT[]

    The transformed value.

    +transformReturnValueForComplexTypeList | SAP Cloud SDK for JavaScript - v3.12.0
    • Transform the payload of the OData response to complex type array by using given deserialization function.

      +

      Type Parameters

      • ReturnT

      Parameters

      • data: any

        The OData payload.

        +
      • builderFn: ((data) => ReturnT)

        The deserialization function for transforming the payload.

        +

      Returns ReturnT[]

      The transformed value.

      Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

      -
    \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.transformReturnValueForEdmType.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.transformReturnValueForEdmType.html index fcf6f4ff41..317622e4c2 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.transformReturnValueForEdmType.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.transformReturnValueForEdmType.html @@ -1,6 +1,6 @@ -transformReturnValueForEdmType | SAP Cloud SDK for JavaScript - v3.12.1
  • Transform the payload of the OData response to edm type by using given deserialization function.

    -

    Type Parameters

    • ReturnT

    Parameters

    • data: any

      The OData payload.

      -
    • builderFn: ((data) => ReturnT)

      The deserialization function for transforming the payload.

      -

    Returns ReturnT

    The transformed value.

    +transformReturnValueForEdmType | SAP Cloud SDK for JavaScript - v3.12.0
    • Transform the payload of the OData response to edm type by using given deserialization function.

      +

      Type Parameters

      • ReturnT

      Parameters

      • data: any

        The OData payload.

        +
      • builderFn: ((data) => ReturnT)

        The deserialization function for transforming the payload.

        +

      Returns ReturnT

      The transformed value.

      Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

      -
    \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.transformReturnValueForEdmTypeList.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.transformReturnValueForEdmTypeList.html index c5d9fbbf6c..5b381dd7e4 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.transformReturnValueForEdmTypeList.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.transformReturnValueForEdmTypeList.html @@ -1,6 +1,6 @@ -transformReturnValueForEdmTypeList | SAP Cloud SDK for JavaScript - v3.12.1
  • Transform the payload of the OData response to edm type array by using given deserialization function.

    -

    Type Parameters

    • ReturnT

    Parameters

    • data: any

      The OData payload.

      -
    • builderFn: ((data) => ReturnT)

      The deserialization function for transforming the payload.

      -

    Returns ReturnT[]

    The transformed value.

    +transformReturnValueForEdmTypeList | SAP Cloud SDK for JavaScript - v3.12.0
    • Transform the payload of the OData response to edm type array by using given deserialization function.

      +

      Type Parameters

      • ReturnT

      Parameters

      • data: any

        The OData payload.

        +
      • builderFn: ((data) => ReturnT)

        The deserialization function for transforming the payload.

        +

      Returns ReturnT[]

      The transformed value.

      Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

      -
    \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.transformReturnValueForEntity.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.transformReturnValueForEntity.html index 2e1cb610a0..ab1471709d 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.transformReturnValueForEntity.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.transformReturnValueForEntity.html @@ -1,6 +1,6 @@ -transformReturnValueForEntity | SAP Cloud SDK for JavaScript - v3.12.1
  • Transform the payload of an OData response to an entity by using the given (de-)serializers.

    -

    Type Parameters

    • ReturnT extends Entity
    • DeSerializersT extends DeSerializers<any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any>

    Parameters

    • data: any

      The OData payload.

      -
    • entityApi: EntityApi<ReturnT, DeSerializersT>

      Entity API that holds the (de-)serializers.

      +transformReturnValueForEntity | SAP Cloud SDK for JavaScript - v3.12.0
      • Transform the payload of an OData response to an entity by using the given (de-)serializers.

        +

        Type Parameters

        • ReturnT extends Entity

        • DeSerializersT extends DeSerializers<any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any>

        Parameters

        Returns ReturnT

        The transformed value.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.transformReturnValueForEntityList.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.transformReturnValueForEntityList.html index 5b8df12f64..92b6d0e28c 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.transformReturnValueForEntityList.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.transformReturnValueForEntityList.html @@ -1,6 +1,6 @@ -transformReturnValueForEntityList | SAP Cloud SDK for JavaScript - v3.12.1
  • Transform the payload of the OData response to array of entities by using given (de-)serializers.

    -

    Type Parameters

    • ReturnT extends Entity
    • DeSerializersT extends DeSerializers<any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any>

    Parameters

    • data: any

      The OData payload.

      -
    • entityApi: EntityApi<ReturnT, DeSerializersT>

      Entity API that holds the (de-)serializers.

      +transformReturnValueForEntityList | SAP Cloud SDK for JavaScript - v3.12.0
      • Transform the payload of the OData response to array of entities by using given (de-)serializers.

        +

        Type Parameters

        • ReturnT extends Entity

        • DeSerializersT extends DeSerializers<any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any>

        Parameters

        Returns ReturnT[]

        The transformed value.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.transformReturnValueForUndefined.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.transformReturnValueForUndefined.html index 8727535255..010ede83e2 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.transformReturnValueForUndefined.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v2.transformReturnValueForUndefined.html @@ -1,7 +1,7 @@ -transformReturnValueForUndefined | SAP Cloud SDK for JavaScript - v3.12.1
  • Transform the payload of the OData response to undefined. +transformReturnValueForUndefined | SAP Cloud SDK for JavaScript - v3.12.0

    • Transform the payload of the OData response to undefined. This function is used in function imports, when no values need to be returned.

      -

      Type Parameters

      • ReturnT

      Parameters

      • data: any

        The OData payload.

        -
      • builderFn: ((data) => ReturnT)

        The deserialization function for transforming the payload.

        -

      Returns ReturnT

      The transformed value.

      +

    Type Parameters

    • ReturnT

    Parameters

    • data: any

      The OData payload.

      +
    • builderFn: ((data) => ReturnT)

      The deserialization function for transforming the payload.

      +

    Returns ReturnT

    The transformed value.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.all.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.all.html index 88905aa3be..6302bb5b64 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.all.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.all.html @@ -1,5 +1,5 @@ -all | SAP Cloud SDK for JavaScript - v3.12.1
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.any.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.any.html index 978d460fe6..cdda633b43 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.any.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.any.html @@ -1,5 +1,5 @@ -any | SAP Cloud SDK for JavaScript - v3.12.1
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.contains.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.contains.html index c69ce3f734..7e7ab8b5cd 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.contains.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.contains.html @@ -1,6 +1,6 @@ -contains | SAP Cloud SDK for JavaScript - v3.12.1
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.edmToTs.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.edmToTs.html index 46a6ef702c..428a31bdb9 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.edmToTs.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.edmToTs.html @@ -1,7 +1,7 @@ -edmToTs | SAP Cloud SDK for JavaScript - v3.12.1
  • Convert a value with edm format to one with typescript format. This function is typically used when deserializing an OData response.

    -

    Parameters

    • value: any

      The original value with edm format.

      -
    • edmType: EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4

      The edm type of that value.

      -
    • deSerializers: DeSerializers<any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any>

      (De-)serializers used for transformation.

      +edmToTs | SAP Cloud SDK for JavaScript - v3.12.0
      • Convert a value with edm format to one with typescript format. This function is typically used when deserializing an OData response.

        +

        Parameters

        Returns any

        Deserialized value.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.entityDeserializer.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.entityDeserializer.html index 4b18358668..2a37ae3349 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.entityDeserializer.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.entityDeserializer.html @@ -1,6 +1,6 @@ -entityDeserializer | SAP Cloud SDK for JavaScript - v3.12.1
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.filterFunction.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.filterFunction.html index bdbcf7ba76..50096582d7 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.filterFunction.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.filterFunction.html @@ -1,42 +1,42 @@ -filterFunction | SAP Cloud SDK for JavaScript - v3.12.1
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.filterFunctions.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.filterFunctions.html index b2009f923a..999094c536 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.filterFunctions.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.filterFunctions.html @@ -1,5 +1,5 @@ -filterFunctions | SAP Cloud SDK for JavaScript - v3.12.1
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.fractionalSeconds.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.fractionalSeconds.html index 177a70f7e0..44f64885cf 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.fractionalSeconds.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.fractionalSeconds.html @@ -1,5 +1,5 @@ -fractionalSeconds | SAP Cloud SDK for JavaScript - v3.12.1
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.hasSubsequence.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.hasSubsequence.html index da54d10334..2adaacad83 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.hasSubsequence.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.hasSubsequence.html @@ -1,6 +1,6 @@ -hasSubsequence | SAP Cloud SDK for JavaScript - v3.12.1
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.hasSubset.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.hasSubset.html index a9cbdaffb2..2edfb86248 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.hasSubset.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.hasSubset.html @@ -1,6 +1,6 @@ -hasSubset | SAP Cloud SDK for JavaScript - v3.12.1
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.matchesPattern.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.matchesPattern.html index 147218ac2f..0ed50eb975 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.matchesPattern.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.matchesPattern.html @@ -1,6 +1,6 @@ -matchesPattern | SAP Cloud SDK for JavaScript - v3.12.1
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.maxDateTime.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.maxDateTime.html index 86460b7add..60f6144f36 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.maxDateTime.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.maxDateTime.html @@ -1,4 +1,4 @@ -maxDateTime | SAP Cloud SDK for JavaScript - v3.12.1
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.mergeDefaultDeSerializersWith.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.mergeDefaultDeSerializersWith.html index 7edce7b5a8..951eda9eb3 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.mergeDefaultDeSerializersWith.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.mergeDefaultDeSerializersWith.html @@ -1,6 +1,6 @@ -mergeDefaultDeSerializersWith | SAP Cloud SDK for JavaScript - v3.12.1
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.minDateTime.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.minDateTime.html index d19ac7e108..4dc2dec187 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.minDateTime.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.minDateTime.html @@ -1,4 +1,4 @@ -minDateTime | SAP Cloud SDK for JavaScript - v3.12.1
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.now.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.now.html index 56691e9934..61408fdf9a 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.now.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.now.html @@ -1,4 +1,4 @@ -now | SAP Cloud SDK for JavaScript - v3.12.1
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.totalOffsetMinutes.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.totalOffsetMinutes.html index 7c431c5d4d..02769a61e4 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.totalOffsetMinutes.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.totalOffsetMinutes.html @@ -1,5 +1,5 @@ -totalOffsetMinutes | SAP Cloud SDK for JavaScript - v3.12.1
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.transformReturnValueForComplexType.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.transformReturnValueForComplexType.html index b4e3443e77..56d6966b09 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.transformReturnValueForComplexType.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.transformReturnValueForComplexType.html @@ -1,6 +1,6 @@ -transformReturnValueForComplexType | SAP Cloud SDK for JavaScript - v3.12.1
  • Transform the payload of the OData response to a complex type by using given deserialization function.

    -

    Type Parameters

    • ReturnT

    Parameters

    • data: any

      The OData payload.

      -
    • builderFn: ((data) => ReturnT)

      The deserialization function for transforming the payload.

      -

    Returns ReturnT

    The transformed value.

    +transformReturnValueForComplexType | SAP Cloud SDK for JavaScript - v3.12.0
    • Transform the payload of the OData response to a complex type by using given deserialization function.

      +

      Type Parameters

      • ReturnT

      Parameters

      • data: any

        The OData payload.

        +
      • builderFn: ((data) => ReturnT)

        The deserialization function for transforming the payload.

        +

      Returns ReturnT

      The transformed value.

      Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

      -
    \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.transformReturnValueForComplexTypeList.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.transformReturnValueForComplexTypeList.html index bc7393ea58..964499500e 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.transformReturnValueForComplexTypeList.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.transformReturnValueForComplexTypeList.html @@ -1,6 +1,6 @@ -transformReturnValueForComplexTypeList | SAP Cloud SDK for JavaScript - v3.12.1
  • Transform the payload of the OData response to complex type array by using given deserialization function.

    -

    Type Parameters

    • ReturnT

    Parameters

    • data: any

      The OData payload.

      -
    • builderFn: ((data) => ReturnT)

      The deserialization function for transforming the payload.

      -

    Returns ReturnT[]

    The transformed value.

    +transformReturnValueForComplexTypeList | SAP Cloud SDK for JavaScript - v3.12.0
    • Transform the payload of the OData response to complex type array by using given deserialization function.

      +

      Type Parameters

      • ReturnT

      Parameters

      • data: any

        The OData payload.

        +
      • builderFn: ((data) => ReturnT)

        The deserialization function for transforming the payload.

        +

      Returns ReturnT[]

      The transformed value.

      Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

      -
    \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.transformReturnValueForEdmType.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.transformReturnValueForEdmType.html index 4aaa958085..4b2b82cb0a 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.transformReturnValueForEdmType.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.transformReturnValueForEdmType.html @@ -1,6 +1,6 @@ -transformReturnValueForEdmType | SAP Cloud SDK for JavaScript - v3.12.1
  • Transform the payload of the OData response to edm type by using given deserialization function.

    -

    Type Parameters

    • ReturnT

    Parameters

    • data: any

      The OData payload.

      -
    • builderFn: ((data) => ReturnT)

      The deserialization function for transforming the payload.

      -

    Returns ReturnT

    The transformed value.

    +transformReturnValueForEdmType | SAP Cloud SDK for JavaScript - v3.12.0
    • Transform the payload of the OData response to edm type by using given deserialization function.

      +

      Type Parameters

      • ReturnT

      Parameters

      • data: any

        The OData payload.

        +
      • builderFn: ((data) => ReturnT)

        The deserialization function for transforming the payload.

        +

      Returns ReturnT

      The transformed value.

      Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

      -
    \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.transformReturnValueForEdmTypeList.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.transformReturnValueForEdmTypeList.html index 0cedae9073..feefb61880 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.transformReturnValueForEdmTypeList.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.transformReturnValueForEdmTypeList.html @@ -1,6 +1,6 @@ -transformReturnValueForEdmTypeList | SAP Cloud SDK for JavaScript - v3.12.1
  • Transform the payload of the OData response to edm type array by using given deserialization function.

    -

    Type Parameters

    • ReturnT

    Parameters

    • data: any

      The OData payload.

      -
    • builderFn: ((data) => ReturnT)

      The deserialization function for transforming the payload.

      -

    Returns ReturnT[]

    The transformed value.

    +transformReturnValueForEdmTypeList | SAP Cloud SDK for JavaScript - v3.12.0
    • Transform the payload of the OData response to edm type array by using given deserialization function.

      +

      Type Parameters

      • ReturnT

      Parameters

      • data: any

        The OData payload.

        +
      • builderFn: ((data) => ReturnT)

        The deserialization function for transforming the payload.

        +

      Returns ReturnT[]

      The transformed value.

      Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

      -
    \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.transformReturnValueForEntity.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.transformReturnValueForEntity.html index 4bd77063e1..1b0f44df5b 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.transformReturnValueForEntity.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.transformReturnValueForEntity.html @@ -1,6 +1,6 @@ -transformReturnValueForEntity | SAP Cloud SDK for JavaScript - v3.12.1
  • Transform the payload of an OData response to an entity by using the given (de-)serializers.

    -

    Type Parameters

    • ReturnT extends Entity
    • DeSerializersT extends DeSerializers<any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any>

    Parameters

    • data: any

      The OData payload.

      -
    • entityApi: EntityApi<ReturnT, DeSerializersT>

      Entity API that holds the (de-)serializers.

      +transformReturnValueForEntity | SAP Cloud SDK for JavaScript - v3.12.0
      • Transform the payload of an OData response to an entity by using the given (de-)serializers.

        +

        Type Parameters

        • ReturnT extends Entity

        • DeSerializersT extends DeSerializers<any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any>

        Parameters

        Returns ReturnT

        The transformed value.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.transformReturnValueForEntityList.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.transformReturnValueForEntityList.html index 1125c2e93d..f1952238e0 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.transformReturnValueForEntityList.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.transformReturnValueForEntityList.html @@ -1,6 +1,6 @@ -transformReturnValueForEntityList | SAP Cloud SDK for JavaScript - v3.12.1
  • Transform the payload of the OData response to array of entities by using given (de-)serializers.

    -

    Type Parameters

    • ReturnT extends Entity
    • DeSerializersT extends DeSerializers<any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any>

    Parameters

    • data: any

      The OData payload.

      -
    • entityApi: EntityApi<ReturnT, DeSerializersT>

      Entity API that holds the (de-)serializers.

      +transformReturnValueForEntityList | SAP Cloud SDK for JavaScript - v3.12.0
      • Transform the payload of the OData response to array of entities by using given (de-)serializers.

        +

        Type Parameters

        • ReturnT extends Entity

        • DeSerializersT extends DeSerializers<any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any, any>

        Parameters

        Returns ReturnT[]

        The transformed value.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.transformReturnValueForUndefined.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.transformReturnValueForUndefined.html index 239d0333a4..cf66d6b776 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.transformReturnValueForUndefined.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_odata_v4.transformReturnValueForUndefined.html @@ -1,7 +1,7 @@ -transformReturnValueForUndefined | SAP Cloud SDK for JavaScript - v3.12.1
  • Transform the payload of the OData response to undefined. +transformReturnValueForUndefined | SAP Cloud SDK for JavaScript - v3.12.0

    • Transform the payload of the OData response to undefined. This function is used in function imports, when no values need to be returned.

      -

      Type Parameters

      • ReturnT

      Parameters

      • data: any

        The OData payload.

        -
      • builderFn: ((data) => ReturnT)

        The deserialization function for transforming the payload.

        -

      Returns ReturnT

      The transformed value.

      +

    Type Parameters

    • ReturnT

    Parameters

    • data: any

      The OData payload.

      +
    • builderFn: ((data) => ReturnT)

      The deserialization function for transforming the payload.

      +

    Returns ReturnT

    The transformed value.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_openapi_generator.generate.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_openapi_generator.generate.html index 7e5393984a..e046452c2a 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_openapi_generator.generate.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_openapi_generator.generate.html @@ -1,6 +1,6 @@ -generate | SAP Cloud SDK for JavaScript - v3.12.1
  • Main entry point for the OpenAPI client generation. +generate | SAP Cloud SDK for JavaScript - v3.12.0

    • Main entry point for the OpenAPI client generation. Generates models and API files.

      -

      Parameters

      • options: CommonGeneratorOptions & {
            config?: string;
        }

        Options to configure generation.

        +

        Parameters

        Returns Promise<void>

        A promise to void.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
    \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_resilience.circuitBreaker.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_resilience.circuitBreaker.html index 0c793fb109..c6f8d4fce9 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_resilience.circuitBreaker.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_resilience.circuitBreaker.html @@ -1,4 +1,4 @@ -circuitBreaker | SAP Cloud SDK for JavaScript - v3.12.1
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_resilience.circuitBreakerHttp.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_resilience.circuitBreakerHttp.html index 597be1a66f..f61fe5e8f5 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_resilience.circuitBreakerHttp.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_resilience.circuitBreakerHttp.html @@ -1,5 +1,5 @@ -circuitBreakerHttp | SAP Cloud SDK for JavaScript - v3.12.1
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_resilience.resilience.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_resilience.resilience.html index d9df1ab060..4722ab5f51 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_resilience.resilience.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_resilience.resilience.html @@ -1,7 +1,7 @@ -resilience | SAP Cloud SDK for JavaScript - v3.12.1
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_resilience.retry.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_resilience.retry.html index a29f6c8aa1..603a339584 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_resilience.retry.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_resilience.retry.html @@ -1,5 +1,5 @@ -retry | SAP Cloud SDK for JavaScript - v3.12.1
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_resilience.timeout.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_resilience.timeout.html index 2d8530bcc6..9ee5aa3075 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_resilience.timeout.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_resilience.timeout.html @@ -1,5 +1,5 @@ -timeout | SAP Cloud SDK for JavaScript - v3.12.1
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_test_util.getTestDestinationByAlias.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_test_util.getTestDestinationByAlias.html index 7bb1fa5058..0b4ba963cc 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_test_util.getTestDestinationByAlias.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_test_util.getTestDestinationByAlias.html @@ -1,12 +1,12 @@ -getTestDestinationByAlias | SAP Cloud SDK for JavaScript - v3.12.1
  • Loads a destination matching the provided alias stored in systems.json and credentials.json. +getTestDestinationByAlias | SAP Cloud SDK for JavaScript - v3.12.0

    • Loads a destination matching the provided alias stored in systems.json and credentials.json. By default, this function starts looking in the directory the test process has been started in (i.e. '.') and traverses the file hierarchy upwards until it finds a systems.json and credentials.json file. Alternatively, you can supply paths to the systems and the credentials file directly.

      Throws an error when no systems.json can be found, the alias does not match any of the available destinations, the JSON is malformed or one of the supplied paths is invalid. Does not throw an error when no credentials.json can be found, but will print a warning.

      -

      Parameters

      • alias: string

        The alias identifying the destination.

        -
      • Optional options: GetTestDestinationOptions

        References to the systems.json and credentials.json files.

        +

        Parameters

        • alias: string

          The alias identifying the destination.

          +
        • Optional options: GetTestDestinationOptions

          References to the systems.json and credentials.json files.

        Returns Destination

        An array of destinations.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
    \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_test_util.getTestDestinations.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_test_util.getTestDestinations.html index eaecc63af9..b2df506059 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_test_util.getTestDestinations.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_test_util.getTestDestinations.html @@ -1,10 +1,10 @@ -getTestDestinations | SAP Cloud SDK for JavaScript - v3.12.1
  • Loads all destinations stored in systems.json and credentials.json files.

    +getTestDestinations | SAP Cloud SDK for JavaScript - v3.12.0
    • Loads all destinations stored in systems.json and credentials.json files.

      By default, this functions starts looking in the directory the test process has been started in (i.e. '.') and traverses the file hierarchy upwards until it finds a systems.json and credentials.json file. Alternatively, you can supply paths to the systems and the credentials file directly.

      Throws an error when no systems.json can be found, the JSON is malformed or one of the supplied paths is invalid. Does not throw an error when no credentials.json can be found, but will print a warning.

      -

      Parameters

      • Optional options: GetTestDestinationOptions

        References to the systems.json and credentials.json files.

        +

        Parameters

        Returns Destination[]

        An array of destinations.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
    \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_test_util.mockAllTestDestinations.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_test_util.mockAllTestDestinations.html index 5fc60c5fc2..75eeaa727e 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_test_util.mockAllTestDestinations.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_test_util.mockAllTestDestinations.html @@ -1,5 +1,5 @@ -mockAllTestDestinations | SAP Cloud SDK for JavaScript - v3.12.1
  • Add all destinations from the systems.json and credentials.json files to the destinations environment variable.

    +mockAllTestDestinations | SAP Cloud SDK for JavaScript - v3.12.0
    • Add all destinations from the systems.json and credentials.json files to the destinations environment variable.

      Throws an error if a destination with the same name as the given test destinations already exists.

      -

      Parameters

      • Optional options: GetTestDestinationOptions

        References to the systems.json and credentials.json files.

        +

        Parameters

        • Optional options: GetTestDestinationOptions

          References to the systems.json and credentials.json files.

          Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

          -

        Returns void

    \ No newline at end of file +

Returns void

\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_test_util.mockTestDestination.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_test_util.mockTestDestination.html index 201661d075..41291afb98 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_test_util.mockTestDestination.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_test_util.mockTestDestination.html @@ -1,6 +1,6 @@ -mockTestDestination | SAP Cloud SDK for JavaScript - v3.12.1
  • Add a destination with the given name from the systems.json and credentials.json files to the destinations environment variable.

    +mockTestDestination | SAP Cloud SDK for JavaScript - v3.12.0
    • Add a destination with the given name from the systems.json and credentials.json files to the destinations environment variable.

      Throws an error if a destination with the same name as the given test destination already exists.

      -

      Parameters

      • name: string

        Name of the test destination to add to the destinations environment variable.

        -
      • Optional options: GetTestDestinationOptions

        References to the systems.json and credentials.json files.

        +

        Parameters

        • name: string

          Name of the test destination to add to the destinations environment variable.

          +
        • Optional options: GetTestDestinationOptions

          References to the systems.json and credentials.json files.

          Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

          -

        Returns void

    \ No newline at end of file +

Returns void

\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_test_util.setTestDestination.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_test_util.setTestDestination.html index 4c2840e303..48817af83e 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_test_util.setTestDestination.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_test_util.setTestDestination.html @@ -1,5 +1,5 @@ -setTestDestination | SAP Cloud SDK for JavaScript - v3.12.1
  • Set a given destination in the destinations environment variable.

    +setTestDestination | SAP Cloud SDK for JavaScript - v3.12.0
    • Set a given destination in the destinations environment variable.

      Throws an error if a destination with the same name as the given test destination already exists.

      -

      Parameters

      • destination: Destination

        Test destination to add to the destinations environment variable.

        +

        Parameters

        • destination: Destination

          Test destination to add to the destinations environment variable.

          Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

          -

        Returns void

    \ No newline at end of file +

Returns void

\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_test_util.unmockAllTestDestinations.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_test_util.unmockAllTestDestinations.html index ba46c75b7d..cc1e0adad0 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_test_util.unmockAllTestDestinations.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_test_util.unmockAllTestDestinations.html @@ -1,4 +1,4 @@ -unmockAllTestDestinations | SAP Cloud SDK for JavaScript - v3.12.1
  • Removes all test destinations stored in systems.json and credentials.json files or added through setTestDestination() from the destinations environment variable.

    +unmockAllTestDestinations | SAP Cloud SDK for JavaScript - v3.12.0
    • Removes all test destinations stored in systems.json and credentials.json files or added through setTestDestination() from the destinations environment variable.

      This function should be called to invert the behavior of mockAllTestDestinations() and other add single mocked destination functions.

      Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

      -

      Returns void

    \ No newline at end of file +

    Returns void

\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_test_util.unmockTestDestination.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_test_util.unmockTestDestination.html index f7a611badf..18c89ac6bc 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_test_util.unmockTestDestination.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_test_util.unmockTestDestination.html @@ -1,5 +1,5 @@ -unmockTestDestination | SAP Cloud SDK for JavaScript - v3.12.1
  • Removes a destination with the given name from the destinations environment variable. If the given destination name is not found calling this function has no effect. +unmockTestDestination | SAP Cloud SDK for JavaScript - v3.12.0

    • Removes a destination with the given name from the destinations environment variable. If the given destination name is not found calling this function has no effect. This function should be called to invert the behavior of mockTestDestination() and setTestDestination().

      -

      Parameters

      • name: string

        Name of the mocked destination to remove.

        +

        Parameters

        • name: string

          Name of the mocked destination to remove.

          Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

          -

        Returns void

    \ No newline at end of file +

Returns void

\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.assoc.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.assoc.html index 1c6533592b..5d4166227a 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.assoc.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.assoc.html @@ -1,9 +1,8 @@ -assoc | SAP Cloud SDK for JavaScript - v3.12.1
  • Adds a key value pair to the given objects and returns a shallow copy. +assoc | SAP Cloud SDK for JavaScript - v3.12.0

    • Adds a key value pair to the given objects and returns a shallow copy. If the key is already present it will be overwritten.

      -

      Type Parameters

      • T

      Parameters

      • key: string

        Key to be added.

        -
      • value: any

        Value to be added.

        -
      • obj: T

        Object the key value pair is added to.

        +

        Type Parameters

        • T

        Parameters

        • key: string

          Key to be added.

          +
        • value: any

          Value to be added.

          +
        • obj: T

          Object the key value pair is added to.

        Returns T & {
            [key: string]: any;
        }

        The object with the key value pair added.

        -

        Deprecated

        Since v3.12.1. Will not be replaced.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
    \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.camelCase.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.camelCase.html index fdda418aeb..29bef35a2f 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.camelCase.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.camelCase.html @@ -1,5 +1,5 @@ -camelCase | SAP Cloud SDK for JavaScript - v3.12.1
  • Convert a string to camelCase. This format used e.g. for properties on entity class instances.

    -

    Parameters

    • str: string

      The string to be transformed.

      +camelCase | SAP Cloud SDK for JavaScript - v3.12.0
      • Convert a string to camelCase. This format used e.g. for properties on entity class instances.

        +

        Parameters

        • str: string

          The string to be transformed.

        Returns string

        The transformed string.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.caps.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.caps.html index 813a50aac9..fa358b17b5 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.caps.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.caps.html @@ -1,5 +1,5 @@ -caps | SAP Cloud SDK for JavaScript - v3.12.1
  • Returns the OData version in capital letters so V2 or V4.

    -

    Parameters

    • oDataVersion: any

      OData version in lower case: 'v2' or 'v4'.

      +caps | SAP Cloud SDK for JavaScript - v3.12.0
      • Returns the OData version in capital letters so V2 or V4.

        +

        Parameters

        • oDataVersion: any

          OData version in lower case: 'v2' or 'v4'.

        Returns "V2" | "V4"

        'V2' or 'V4'.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.checkUrlExists.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.checkUrlExists.html index 677e3f8bcf..dc585cf079 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.checkUrlExists.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.checkUrlExists.html @@ -1,5 +1,5 @@ -checkUrlExists | SAP Cloud SDK for JavaScript - v3.12.1
  • Checks whether a URL is existing via a head request.

    -

    Parameters

    • url: string

      URL to be checked.

      +checkUrlExists | SAP Cloud SDK for JavaScript - v3.12.0
      • Checks whether a URL is existing via a head request.

        +

        Parameters

        • url: string

          URL to be checked.

        Returns Promise<number>

        Promise - resolves if the URL exists.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.codeBlock.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.codeBlock.html index 46b598324d..2ac95e4ed6 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.codeBlock.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.codeBlock.html @@ -1,10 +1,10 @@ -codeBlock | SAP Cloud SDK for JavaScript - v3.12.1
  • Experimental

    This API is experimental and might change in newer versions. Use with caution. +codeBlock | SAP Cloud SDK for JavaScript - v3.12.0

    • Experimental

      This API is experimental and might change in newer versions. Use with caution. Transform strings and arguments to a string formatted as a code block, keeping the indentation of sub code blocks. Use in tagged templates, e.g.:

      codeBlock`Code with ${arguments} and more code;`
       
      -

      Parameters

      • strings: TemplateStringsArray

        Strings in the tagged template. In the example above that would be ['Code with ', ' and more code;'].

        -
      • Rest ...args: any[]

        Arguments in the tagged template. In the example above that would be the resolved value for arguments;.

        +

        Parameters

        • strings: TemplateStringsArray

          Strings in the tagged template. In the example above that would be ['Code with ', ' and more code;'].

          +
        • Rest ...args: any[]

          Arguments in the tagged template. In the example above that would be the resolved value for arguments;.

        Returns string

        A string formatted as code block.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
    \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.createLogger.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.createLogger.html index 71f21203da..076737d743 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.createLogger.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.createLogger.html @@ -1,4 +1,4 @@ -createLogger | SAP Cloud SDK for JavaScript - v3.12.1
  • Create a logger for the given message context, if available.

    +createLogger | SAP Cloud SDK for JavaScript - v3.12.0
    • Create a logger for the given message context, if available.

      Usage: To create a logger in your module, it is recommended to pass a module identifier that will be logged as messageContext for all messages from this logger: const logger = createLogger('my-module');. Not setting any module identifier will retrieve the default logger. @@ -11,7 +11,7 @@

      You will find these information under the custom_fields key in your Cloud Foundry logs.

      To retrieve a logger after its creation use getLogger. If you want to change the log level of a logger use setLogLevel.

      -

      Parameters

      • Optional messageContext: string | MessageContextObj & LoggerOptions

        Either a key for the message context of all messages produced by the logger or an object with additional keys to set in the message.

        +

        Parameters

        • Optional messageContext: string | MessageContextObj & LoggerOptions

          Either a key for the message context of all messages produced by the logger or an object with additional keys to set in the message.

        Returns Logger

        A newly created or an already existing logger for the given context.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
    \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.disableExceptionLogger.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.disableExceptionLogger.html index 705e6b5700..2454ab2630 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.disableExceptionLogger.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.disableExceptionLogger.html @@ -1,3 +1,3 @@ -disableExceptionLogger | SAP Cloud SDK for JavaScript - v3.12.1
  • Disable logging of exceptions. Enabled by default.

    +disableExceptionLogger | SAP Cloud SDK for JavaScript - v3.12.0
    • Disable logging of exceptions. Enabled by default.

      Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

      -

      Returns void

    \ No newline at end of file +

    Returns void

\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.documentationBlock.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.documentationBlock.html index a0a31c6ef3..41bcaf8a69 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.documentationBlock.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.documentationBlock.html @@ -1,12 +1,12 @@ -documentationBlock | SAP Cloud SDK for JavaScript - v3.12.1
  • Experimental

    This API is experimental and might change in newer versions. Use with caution. +documentationBlock | SAP Cloud SDK for JavaScript - v3.12.0

    • Experimental

      This API is experimental and might change in newer versions. Use with caution. Transform strings and arguments to a string formatted as a documentation block. The formatting is block like so no leading or trailing spaces. New lines in the beginning and end are also removed. Use in tagged templates, e.g.:

      documentationBlock`Docs with ${arguments} and more content;`
       
      -

      Parameters

      • strings: TemplateStringsArray

        Strings in the tagged template. In the example above that would be ['Docs with ', ' and more content;'].

        -
      • Rest ...args: string[]

        Arguments in the tagged template. In the example above that would be the resolved value for arguments;.

        +

        Parameters

        • strings: TemplateStringsArray

          Strings in the tagged template. In the example above that would be ['Docs with ', ' and more content;'].

          +
        • Rest ...args: string[]

          Arguments in the tagged template. In the example above that would be the resolved value for arguments;.

        Returns string

        A string formatted as documentation block.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
    \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.enableExceptionLogger.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.enableExceptionLogger.html index 6396ec700d..c11d650b2b 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.enableExceptionLogger.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.enableExceptionLogger.html @@ -1,3 +1,3 @@ -enableExceptionLogger | SAP Cloud SDK for JavaScript - v3.12.1
  • Enable logging of exceptions. Enabled by default.

    +enableExceptionLogger | SAP Cloud SDK for JavaScript - v3.12.0
    • Enable logging of exceptions. Enabled by default.

      Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

      -

      Returns void

    \ No newline at end of file +

    Returns void

\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.encodeBase64.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.encodeBase64.html index 6e59ecf58b..cd85759154 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.encodeBase64.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.encodeBase64.html @@ -1,5 +1,5 @@ -encodeBase64 | SAP Cloud SDK for JavaScript - v3.12.1
  • Encode a string to a base64 encoded string.

    -

    Parameters

    • str: string

      String to encode.

      +encodeBase64 | SAP Cloud SDK for JavaScript - v3.12.0
      • Encode a string to a base64 encoded string.

        +

        Parameters

        • str: string

          String to encode.

        Returns string

        Base64 encoded string.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.equal.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.equal.html index e44196138c..297c0e3ed7 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.equal.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.equal.html @@ -1,9 +1,9 @@ -equal | SAP Cloud SDK for JavaScript - v3.12.1
  • Checks whether the two items contain the same content. +equal | SAP Cloud SDK for JavaScript - v3.12.0

    • Checks whether the two items contain the same content. When both of them are arrays, the elements and the order are checked, see equalArrays. When both of them are objects, the key/value pairs are checked, see equalObjects. In other cases, triple equals is used.

      -

      Type Parameters

      • T

      Parameters

      • item1: T

        The first item.

        -
      • item2: T

        The second item.

        +

        Type Parameters

        • T

        Parameters

        • item1: T

          The first item.

          +
        • item2: T

          The second item.

        Returns boolean

        A boolean, indicating all the items equal to each other.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
    \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.equalArrays.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.equalArrays.html index 240fdae9b3..abea2adbfd 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.equalArrays.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.equalArrays.html @@ -1,6 +1,6 @@ -equalArrays | SAP Cloud SDK for JavaScript - v3.12.1
  • Checks whether the elements of two arrays are the same with the same order.

    -

    Type Parameters

    • T

    Parameters

\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.equalObjects.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.equalObjects.html index 06ff2b8ef3..6914de3d3a 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.equalObjects.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.equalObjects.html @@ -1,6 +1,6 @@ -equalObjects | SAP Cloud SDK for JavaScript - v3.12.1
  • Checks whether the keys and values of two objects are equal.

    -

    Parameters

    • obj1: Record<string, any>

      The first object.

      -
    • obj2: Record<string, any>

      The second object.

      +equalObjects | SAP Cloud SDK for JavaScript - v3.12.0
      • Checks whether the keys and values of two objects are equal.

        +

        Parameters

        • obj1: Record<string, any>

          The first object.

          +
        • obj2: Record<string, any>

          The second object.

        Returns boolean

        A boolean, indicating whether the two objects are equal to each other.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.exclude.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.exclude.html index 599b5ec6b5..33f54eafda 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.exclude.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.exclude.html @@ -1,7 +1,7 @@ -exclude | SAP Cloud SDK for JavaScript - v3.12.1
  • Create a shallow copy of the given object, that does not contain the given keys. +exclude | SAP Cloud SDK for JavaScript - v3.12.0

    • Create a shallow copy of the given object, that does not contain the given keys. Non existing keys in the source object are ignored.

      -

      Type Parameters

      • T extends Record<string, unknown>

      Parameters

      • keys: string[]

        Properties to be selected.

        -
      • obj: T

        Object from which the values are taken.

        +

        Type Parameters

        • T extends Record<string, unknown>

        Parameters

        • keys: string[]

          Properties to be selected.

          +
        • obj: T

          Object from which the values are taken.

        Returns Partial<T>

        An object with the selected keys and corresponding values.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
    \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.filterDuplicates.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.filterDuplicates.html index 5e548fd933..c76b840a90 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.filterDuplicates.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.filterDuplicates.html @@ -1,6 +1,6 @@ -filterDuplicates | SAP Cloud SDK for JavaScript - v3.12.1
  • Filter an array by removing duplicates and keeping the left most occurrence. By default this compares by identity.

    -

    Type Parameters

    • T

    Parameters

    • arr: T[]

      Array to remove duplicates from.

      -
    • comparator: ((left, right) => boolean) = ...

      Optional comparator function, indicating whether two items are equal and therefore handled as duplicates. Defaults to identity.

      -
        • (left, right): boolean
        • Parameters

          • left: T
          • right: T

          Returns boolean

    Returns T[]

    A filtered array containing no duplicates.

    +filterDuplicates | SAP Cloud SDK for JavaScript - v3.12.0
    • Filter an array by removing duplicates and keeping the left most occurrence. By default this compares by identity.

      +

      Type Parameters

      • T

      Parameters

      • arr: T[]

        Array to remove duplicates from.

        +
      • comparator: ((left, right) => boolean) = ...

        Optional comparator function, indicating whether two items are equal and therefore handled as duplicates. Defaults to identity.

        +
          • (left, right): boolean
          • Parameters

            • left: T
            • right: T

            Returns boolean

      Returns T[]

      A filtered array containing no duplicates.

      Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

      -
    \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.filterDuplicatesRight.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.filterDuplicatesRight.html index abefc8f8f8..96afb49d39 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.filterDuplicatesRight.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.filterDuplicatesRight.html @@ -1,6 +1,6 @@ -filterDuplicatesRight | SAP Cloud SDK for JavaScript - v3.12.1
  • Filter an array by removing duplicates and keeping the right most occurrence. By default this compares by identity.

    -

    Type Parameters

    • T

    Parameters

    • arr: T[]

      Array to remove duplicates from.

      -
    • comparator: ((left, right) => boolean) = ...

      Optional comparator function, indicating whether two items are equal and therefore handled as duplicates. Defaults to identity.

      -
        • (left, right): boolean
        • Parameters

          • left: T
          • right: T

          Returns boolean

    Returns T[]

    A filtered array containing no duplicates.

    +filterDuplicatesRight | SAP Cloud SDK for JavaScript - v3.12.0
    • Filter an array by removing duplicates and keeping the right most occurrence. By default this compares by identity.

      +

      Type Parameters

      • T

      Parameters

      • arr: T[]

        Array to remove duplicates from.

        +
      • comparator: ((left, right) => boolean) = ...

        Optional comparator function, indicating whether two items are equal and therefore handled as duplicates. Defaults to identity.

        +
          • (left, right): boolean
          • Parameters

            • left: T
            • right: T

            Returns boolean

      Returns T[]

      A filtered array containing no duplicates.

      Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

      -
    \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.findProjectRoot.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.findProjectRoot.html index 39933adbc1..08a1a5515c 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.findProjectRoot.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.findProjectRoot.html @@ -1,2 +1,2 @@

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-findProjectRoot | SAP Cloud SDK for JavaScript - v3.12.1
  • Internal

    Parameters

    • path: string
    • lastPath: string = path

    Returns string

\ No newline at end of file +findProjectRoot | SAP Cloud SDK for JavaScript - v3.12.0
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.finishAll.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.finishAll.html index be3989bdfd..73e0fe4cc6 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.finishAll.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.finishAll.html @@ -1,7 +1,7 @@ -finishAll | SAP Cloud SDK for JavaScript - v3.12.1
  • Await all promises and resolve if non of them failed. +finishAll | SAP Cloud SDK for JavaScript - v3.12.0

    • Await all promises and resolve if non of them failed. Reject if at least one of them was rejected, but only once all of them are finished. Throws an error consisting of a list of reasons.

      -

      Parameters

      • promises: Promise<any>[]

        Promises to settle.

        -
      • Optional errorMessage: string

        Message to use as introductory text of the error if an error occurs.

        +

        Parameters

        • promises: Promise<any>[]

          Promises to settle.

          +
        • Optional errorMessage: string

          Message to use as introductory text of the error if an error occurs.

          Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

          -

        Returns Promise<void>

    \ No newline at end of file +

Returns Promise<void>

\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.first.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.first.html index 04008f668c..619b88235a 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.first.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.first.html @@ -1,5 +1,5 @@ -first | SAP Cloud SDK for JavaScript - v3.12.1
  • Get the first item from an array. Returns undefined, if the array is empty.

    -

    Type Parameters

    • T

    Parameters

\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.flat.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.flat.html index d47808c577..f84fc1909a 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.flat.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.flat.html @@ -1,5 +1,5 @@ -flat | SAP Cloud SDK for JavaScript - v3.12.1
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.flatten.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.flatten.html index 88848f93e5..002df3108c 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.flatten.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.flatten.html @@ -1,6 +1,6 @@ -flatten | SAP Cloud SDK for JavaScript - v3.12.1
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.formatJson.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.formatJson.html index d6453a669c..b89a5bc4a4 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.formatJson.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.formatJson.html @@ -1,5 +1,5 @@ -formatJson | SAP Cloud SDK for JavaScript - v3.12.1
  • Convert a JSON object to a string using formatting in line with the prettier with indentation and new line at the end.

    -

    Parameters

    • json: any

      Object to be stringified.

      +formatJson | SAP Cloud SDK for JavaScript - v3.12.0
      • Convert a JSON object to a string using formatting in line with the prettier with indentation and new line at the end.

        +

        Parameters

        • json: any

          Object to be stringified.

        Returns string

        The JSON object as string.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.getGlobalLogFormat.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.getGlobalLogFormat.html index e61f3ac258..9e70467aaf 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.getGlobalLogFormat.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.getGlobalLogFormat.html @@ -1,4 +1,4 @@ -getGlobalLogFormat | SAP Cloud SDK for JavaScript - v3.12.1
  • Get the global log format of the container.

    +getGlobalLogFormat | SAP Cloud SDK for JavaScript - v3.12.0
    • Get the global log format of the container.

      Returns Format | undefined

      The global log format, or undefined when not defined.

      Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

      -
    \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.getGlobalLogLevel.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.getGlobalLogLevel.html index 0437d4ad69..417753085a 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.getGlobalLogLevel.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.getGlobalLogLevel.html @@ -1,4 +1,4 @@ -getGlobalLogLevel | SAP Cloud SDK for JavaScript - v3.12.1
  • Get the global log level of the container.

    +getGlobalLogLevel | SAP Cloud SDK for JavaScript - v3.12.0
    • Get the global log level of the container.

      Returns string | undefined

      The global log level, or undefined when not defined.

      Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

      -
    \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.getLogger.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.getLogger.html index 856ae283a3..095f4a87bc 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.getLogger.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.getLogger.html @@ -1,5 +1,5 @@ -getLogger | SAP Cloud SDK for JavaScript - v3.12.1
  • Get logger for a given message context, if available.

    -

    Parameters

    • Optional messageContext: string

      A key for the message context of all messages produced by the logger.

      +getLogger | SAP Cloud SDK for JavaScript - v3.12.0
      • Get logger for a given message context, if available.

        +

        Parameters

        • Optional messageContext: string

          A key for the message context of all messages produced by the logger.

        Returns Logger | undefined

        The logger for the given messageContext if it was created before.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.getMessageOrStack.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.getMessageOrStack.html index 58beec62ff..b68114faed 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.getMessageOrStack.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.getMessageOrStack.html @@ -1,5 +1,5 @@ -getMessageOrStack | SAP Cloud SDK for JavaScript - v3.12.1
  • Internal

    Gets the stack of the given error if available, otherwise the message.

    -

    Parameters

    • info: TransformableInfo

      Object to be transformed.

      +getMessageOrStack | SAP Cloud SDK for JavaScript - v3.12.0
      • Internal

        Gets the stack of the given error if available, otherwise the message.

        +

        Parameters

        • info: TransformableInfo

          Object to be transformed.

        Returns string

        The message string to be used.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.identity.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.identity.html index a8555f4e5b..f6872aafae 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.identity.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.identity.html @@ -1,5 +1,5 @@ -identity | SAP Cloud SDK for JavaScript - v3.12.1
  • Identity function.

    -

    Type Parameters

    • T

    Parameters

    • value: T

      Any value.

      +identity | SAP Cloud SDK for JavaScript - v3.12.0
      • Identity function.

        +

        Type Parameters

        • T

        Parameters

        • value: T

          Any value.

        Returns T

        The given value.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.isErrorWithCause.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.isErrorWithCause.html index fa85a2a104..598339d429 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.isErrorWithCause.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.isErrorWithCause.html @@ -1,5 +1,5 @@ -isErrorWithCause | SAP Cloud SDK for JavaScript - v3.12.1
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.isNullish.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.isNullish.html index 13cd3f9b14..93b4deb5cc 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.isNullish.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.isNullish.html @@ -1,5 +1,5 @@ -isNullish | SAP Cloud SDK for JavaScript - v3.12.1
  • Checks whether a value is either null or undefined.

    -

    Parameters

    • val: any

      Value to check.

      +isNullish | SAP Cloud SDK for JavaScript - v3.12.0
      • Checks whether a value is either null or undefined.

        +

        Parameters

        • val: any

          Value to check.

        Returns val is undefined | null

        true for null or undefined, false otherwise.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.kebabCase.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.kebabCase.html index 76a52ffc0d..af38e89f03 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.kebabCase.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.kebabCase.html @@ -1,5 +1,5 @@ -kebabCase | SAP Cloud SDK for JavaScript - v3.12.1
  • Convert a string to kebab case. This format is used e.g. for file names.

    -

    Parameters

    • str: string

      The string to be transformed.

      +kebabCase | SAP Cloud SDK for JavaScript - v3.12.0
      • Convert a string to kebab case. This format is used e.g. for file names.

        +

        Parameters

        • str: string

          The string to be transformed.

        Returns string

        The transformed string.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.last.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.last.html index cd995df954..f444f97f3e 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.last.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.last.html @@ -1,5 +1,5 @@ -last | SAP Cloud SDK for JavaScript - v3.12.1
  • Get the last item from an array. Returns undefined, if the array is empty.

    -

    Type Parameters

    • T

    Parameters

\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.mergeIgnoreCase.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.mergeIgnoreCase.html index 23e571e9ec..9dbe978407 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.mergeIgnoreCase.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.mergeIgnoreCase.html @@ -1,8 +1,8 @@ -mergeIgnoreCase | SAP Cloud SDK for JavaScript - v3.12.1
  • Create an object by merging the right object into a shallow copy of the left object ignoring casing, but keeping the right casing. Keys present both objects will be present in the merged object.

    -

    Type Parameters

    • LeftT extends Record<string, any>
    • RightT extends Record<string, any>

    Parameters

    • Optional left: LeftT

      Object to merge.

      -
    • Optional right: RightT

      Object to merge. The casing of the keys of this object takes precedence.

      +mergeIgnoreCase | SAP Cloud SDK for JavaScript - v3.12.0
      • Create an object by merging the right object into a shallow copy of the left object ignoring casing, but keeping the right casing. Keys present both objects will be present in the merged object.

        +

        Type Parameters

        • LeftT extends Record<string, any>

        • RightT extends Record<string, any>

        Parameters

        • Optional left: LeftT

          Object to merge.

          +
        • Optional right: RightT

          Object to merge. The casing of the keys of this object takes precedence.

        Returns Record<string, any>

        • An object containing all keys from both objects, where entries present in the right object are replaced. Note that the casing used by right will be used.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.mergeLeftIgnoreCase.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.mergeLeftIgnoreCase.html index 379894b973..bd338e50e4 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.mergeLeftIgnoreCase.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.mergeLeftIgnoreCase.html @@ -1,8 +1,8 @@ -mergeLeftIgnoreCase | SAP Cloud SDK for JavaScript - v3.12.1
  • Create an object by merging the right object into a shallow copy of the left object ignoring casing, but keeping the right casing. Only keys present in the left object will be present in the merged object.

    -

    Type Parameters

    • LeftT extends Record<string, any>
    • RightT extends Record<string, any>

    Parameters

    • Optional left: LeftT

      Object to merge into. They keys of this object will be present in the returned object.

      -
    • Optional right: RightT

      Object to merge. Only keys in left will be considered for merging.

      +mergeLeftIgnoreCase | SAP Cloud SDK for JavaScript - v3.12.0
      • Create an object by merging the right object into a shallow copy of the left object ignoring casing, but keeping the right casing. Only keys present in the left object will be present in the merged object.

        +

        Type Parameters

        • LeftT extends Record<string, any>

        • RightT extends Record<string, any>

        Parameters

        • Optional left: LeftT

          Object to merge into. They keys of this object will be present in the returned object.

          +
        • Optional right: RightT

          Object to merge. Only keys in left will be considered for merging.

        Returns Record<string, any>

        • An object containing all keys from the left object, where entries present in the right object are replaced. Note that the casing used by right will be used.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.muteLoggers.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.muteLoggers.html index 28d0510b65..56a4ca857a 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.muteLoggers.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.muteLoggers.html @@ -1,3 +1,3 @@ -muteLoggers | SAP Cloud SDK for JavaScript - v3.12.1
  • Mute all logger output created by the SAP Cloud SDK Logger. This also applies to future loggers created. Useful for tests.

    +muteLoggers | SAP Cloud SDK for JavaScript - v3.12.0
    • Mute all logger output created by the SAP Cloud SDK Logger. This also applies to future loggers created. Useful for tests.

      Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

      -

      Returns void

    \ No newline at end of file +

    Returns void

\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.partition.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.partition.html index 3a453dddef..c5dad35521 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.partition.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.partition.html @@ -1,6 +1,6 @@ -partition | SAP Cloud SDK for JavaScript - v3.12.1
  • Split an array into two based on a condition.

    -

    Type Parameters

    • T

    Parameters

    • arr: T[]

      Array to partition.

      -
    • condition: ((item) => boolean)

      Function to determine to where to put each item.

      -
        • (item): boolean
        • Parameters

          • item: T

          Returns boolean

    Returns [T[], T[]]

    A two dimensional array containing two arrays, where the first one includes all items where the given condition was met and the second one includes all items where it was not met.

    +partition | SAP Cloud SDK for JavaScript - v3.12.0
    • Split an array into two based on a condition.

      +

      Type Parameters

      • T

      Parameters

      • arr: T[]

        Array to partition.

        +
      • condition: ((item) => boolean)

        Function to determine to where to put each item.

        +
          • (item): boolean
          • Parameters

            • item: T

            Returns boolean

      Returns [T[], T[]]

      A two dimensional array containing two arrays, where the first one includes all items where the given condition was met and the second one includes all items where it was not met.

      Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

      -
    \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.pascalCase.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.pascalCase.html index 62dade8b36..2b838e4d02 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.pascalCase.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.pascalCase.html @@ -1,5 +1,5 @@ -pascalCase | SAP Cloud SDK for JavaScript - v3.12.1
  • Convert a string to pascal case. This format is used e.g. for types.

    -

    Parameters

    • str: string

      The string to be transformed.

      +pascalCase | SAP Cloud SDK for JavaScript - v3.12.0
      • Convert a string to pascal case. This format is used e.g. for types.

        +

        Parameters

        • str: string

          The string to be transformed.

        Returns string

        The transformed string.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.pick.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.pick.html index 09692b273a..f3b8bfdd65 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.pick.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.pick.html @@ -1,7 +1,7 @@ -pick | SAP Cloud SDK for JavaScript - v3.12.1
  • Create a shallow copy of the given object, that contains the given keys. +pick | SAP Cloud SDK for JavaScript - v3.12.0

    • Create a shallow copy of the given object, that contains the given keys. Non existing keys in the source object are ignored.

      -

      Type Parameters

      • T extends Record<string, unknown>

      Parameters

      • keys: string[]

        Properties to be selected.

        -
      • obj: T

        Object from which the values are taken.

        +

        Type Parameters

        • T extends Record<string, unknown>

        Parameters

        • keys: string[]

          Properties to be selected.

          +
        • obj: T

          Object from which the values are taken.

        Returns Partial<T>

        An object with the selected keys and corresponding values.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
    \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.pickIgnoreCase.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.pickIgnoreCase.html index 49ad71b823..7d3b4949b3 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.pickIgnoreCase.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.pickIgnoreCase.html @@ -1,9 +1,9 @@ -pickIgnoreCase | SAP Cloud SDK for JavaScript - v3.12.1
  • Create a shallow copy of the given object, that contains the given keys, independent of casing. +pickIgnoreCase | SAP Cloud SDK for JavaScript - v3.12.0

    • Create a shallow copy of the given object, that contains the given keys, independent of casing. Non existing keys in the source object are ignored.

      -

      Type Parameters

      • T extends Record<string, any>

      Parameters

      • Optional obj: T

        Object to pick the given key from.

        -
      • Rest ...keys: string[]

        Keys of the pair to be picked.

        +

        Type Parameters

        • T extends Record<string, any>

        Parameters

        • Optional obj: T

          Object to pick the given key from.

          +
        • Rest ...keys: string[]

          Keys of the pair to be picked.

        Returns Partial<Pick<T, typeof keys[number]>>

        • An object containing the given key-value pairs in its original case or an empty object if none of them are found.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
    \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.pickNonNullish.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.pickNonNullish.html index 74d5898a52..af1d2ae9d9 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.pickNonNullish.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.pickNonNullish.html @@ -1,7 +1,7 @@ -pickNonNullish | SAP Cloud SDK for JavaScript - v3.12.1
  • Create a shallow copy of the given object, that contains all entries with non-nullish values.

    -

    Type Parameters

    • T extends Record<string, any>

    Parameters

    • Optional obj: T

      An object to pick from.

      +pickNonNullish | SAP Cloud SDK for JavaScript - v3.12.0
      • Create a shallow copy of the given object, that contains all entries with non-nullish values.

        +

        Type Parameters

        • T extends Record<string, any>

        Parameters

        • Optional obj: T

          An object to pick from.

        Returns Partial<T>

        • A filtered object containing only keys with non-nullish values.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.pickValueIgnoreCase.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.pickValueIgnoreCase.html index ba34460d2b..e9c7fe10dd 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.pickValueIgnoreCase.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.pickValueIgnoreCase.html @@ -1,6 +1,6 @@ -pickValueIgnoreCase | SAP Cloud SDK for JavaScript - v3.12.1
  • Returns the value of an object based on the given key, independent of casing.

    -

    Type Parameters

    • T extends Record<string, any>

    Parameters

    • obj: undefined | T

      Object to be searched for the given key.

      -
    • key: string

      Key of the value to pick.

      +pickValueIgnoreCase | SAP Cloud SDK for JavaScript - v3.12.0
      • Returns the value of an object based on the given key, independent of casing.

        +

        Type Parameters

        • T extends Record<string, any>

        Parameters

        • obj: undefined | T

          Object to be searched for the given key.

          +
        • key: string

          Key of the value to pick.

        Returns any | undefined

        The value of for the given key or undefined, if not available.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.propertyExists.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.propertyExists.html index adaad25a4e..3af744ce38 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.propertyExists.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.propertyExists.html @@ -1,6 +1,6 @@ -propertyExists | SAP Cloud SDK for JavaScript - v3.12.1
  • Checks if a chain of properties exists on the given object.

    -

    Parameters

    • obj: Record<string, any>

      The object to be checked.

      -
    • Rest ...properties: string[]

      Chained properties.

      +propertyExists | SAP Cloud SDK for JavaScript - v3.12.0
      • Checks if a chain of properties exists on the given object.

        +

        Parameters

        • obj: Record<string, any>

          The object to be checked.

          +
        • Rest ...properties: string[]

          Chained properties.

        Returns boolean

        true if the property chain leads to a truthy value, false otherwise.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.readJSON.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.readJSON.html index 8ecf8b9ab4..14bcf9b6ca 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.readJSON.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.readJSON.html @@ -1,5 +1,5 @@ -readJSON | SAP Cloud SDK for JavaScript - v3.12.1
  • Read a JSON file from the file system.

    -

    Parameters

\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.removeFileExtension.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.removeFileExtension.html index e45cad330b..fcda948172 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.removeFileExtension.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.removeFileExtension.html @@ -1,5 +1,5 @@ -removeFileExtension | SAP Cloud SDK for JavaScript - v3.12.1
  • Remove file extension from a string, e.g. remove 'test.jpg' would return 'test'.

    -

    Parameters

    • fileName: string

      File name to remove the file extension from.

      +removeFileExtension | SAP Cloud SDK for JavaScript - v3.12.0
      • Remove file extension from a string, e.g. remove 'test.jpg' would return 'test'.

        +

        Parameters

        • fileName: string

          File name to remove the file extension from.

        Returns string

        File name without extension.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.removeLeadingSlashes.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.removeLeadingSlashes.html index 232e9a7c72..34af0a4f32 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.removeLeadingSlashes.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.removeLeadingSlashes.html @@ -1,2 +1,2 @@

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-removeLeadingSlashes | SAP Cloud SDK for JavaScript - v3.12.1
  • Internal

    Parameters

    • path: string

    Returns string

\ No newline at end of file +removeLeadingSlashes | SAP Cloud SDK for JavaScript - v3.12.0
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.removeSlashes.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.removeSlashes.html index 9cc672270e..20d399e4b1 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.removeSlashes.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.removeSlashes.html @@ -1,2 +1,2 @@

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-removeSlashes | SAP Cloud SDK for JavaScript - v3.12.1
  • Internal

    Parameters

    • path: string

    Returns string

\ No newline at end of file +removeSlashes | SAP Cloud SDK for JavaScript - v3.12.0
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.removeTrailingSlashes.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.removeTrailingSlashes.html index 8f1a8df134..1aa459924b 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.removeTrailingSlashes.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.removeTrailingSlashes.html @@ -1,2 +1,2 @@

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-removeTrailingSlashes | SAP Cloud SDK for JavaScript - v3.12.1
  • Internal

    Parameters

    • path: string

    Returns string

\ No newline at end of file +removeTrailingSlashes | SAP Cloud SDK for JavaScript - v3.12.0
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.renameKeys.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.renameKeys.html index d5f29802d0..a38e892bdd 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.renameKeys.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.renameKeys.html @@ -1,8 +1,8 @@ -renameKeys | SAP Cloud SDK for JavaScript - v3.12.1
  • Takes an object and returns a new object whose keys are renamed according to the provided key mapping. +renameKeys | SAP Cloud SDK for JavaScript - v3.12.0

    • Takes an object and returns a new object whose keys are renamed according to the provided key mapping. Any keys in the input object not present in the key mapping will be present in the output object as-is. If a key in the key mapping is not present in the input object, the output object will contain the key with value "undefined".

      -

      Parameters

      • keyMapping: Record<string, string>

        An object mapping keys of the input object to keys of the output object.

        -
      • obj: Record<string, any>

        The input object.

        +

        Parameters

        • keyMapping: Record<string, string>

          An object mapping keys of the input object to keys of the output object.

          +
        • obj: Record<string, any>

          The input object.

        Returns Record<string, any>

        An object with renamed keys.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
    \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.resetCustomLogFormats.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.resetCustomLogFormats.html index f3482a64e6..59c76ccfdd 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.resetCustomLogFormats.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.resetCustomLogFormats.html @@ -1,3 +1,3 @@ -resetCustomLogFormats | SAP Cloud SDK for JavaScript - v3.12.1
  • Reset all the custom log formats for loggers and message context.

    +resetCustomLogFormats | SAP Cloud SDK for JavaScript - v3.12.0
    • Reset all the custom log formats for loggers and message context.

      Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

      -

      Returns void

    \ No newline at end of file +

    Returns void

\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.resetCustomLogLevels.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.resetCustomLogLevels.html index 7e71751174..40593b1dab 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.resetCustomLogLevels.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.resetCustomLogLevels.html @@ -1,3 +1,3 @@ -resetCustomLogLevels | SAP Cloud SDK for JavaScript - v3.12.1
  • Reset all the custom log levels for loggers and message context.

    +resetCustomLogLevels | SAP Cloud SDK for JavaScript - v3.12.0
    • Reset all the custom log levels for loggers and message context.

      Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

      -

      Returns void

    \ No newline at end of file +

    Returns void

\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.sanitizeRecord.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.sanitizeRecord.html index 452b019226..261b890ddc 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.sanitizeRecord.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.sanitizeRecord.html @@ -1,8 +1,8 @@ -sanitizeRecord | SAP Cloud SDK for JavaScript - v3.12.1
  • Potentially sensitive keys will be matched case-insensitive and as substrings. +sanitizeRecord | SAP Cloud SDK for JavaScript - v3.12.0

    • Potentially sensitive keys will be matched case-insensitive and as substrings. Matches will be replaced with a placeholder string.

      -

      Type Parameters

      • T = any

      Parameters

      • input: Record<string, T>

        The record to be sanitized.

        -
      • Optional replacementString: string

        The placeholder string.

        -
      • Optional sensitiveKeys: string[]

        The list of keys to be replaced. This overrides the default list.

        +

        Type Parameters

        • T = any

        Parameters

        • input: Record<string, T>

          The record to be sanitized.

          +
        • Optional replacementString: string

          The placeholder string.

          +
        • Optional sensitiveKeys: string[]

          The list of keys to be replaced. This overrides the default list.

        Returns Record<string, T>

        The sanitized copy of the input record.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
    \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.setGlobalLogFormat.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.setGlobalLogFormat.html index e3eace40c9..5497410b10 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.setGlobalLogFormat.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.setGlobalLogFormat.html @@ -1,5 +1,5 @@ -setGlobalLogFormat | SAP Cloud SDK for JavaScript - v3.12.1
  • Change the global log format of the container which will set default format for all active loggers. +setGlobalLogFormat | SAP Cloud SDK for JavaScript - v3.12.0

    • Change the global log format of the container which will set default format for all active loggers. e.g., to set the global log format to local call setGlobalLogLevel(logFormat.local) or use a custom log format.

      -

      Parameters

      • format: Format

        The log format to set the global log format to.

        +

        Parameters

        • format: Format

          The log format to set the global log format to.

          Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

          -

        Returns void

    \ No newline at end of file +

Returns void

\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.setGlobalLogLevel.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.setGlobalLogLevel.html index 34300d9fb5..a362a8fe63 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.setGlobalLogLevel.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.setGlobalLogLevel.html @@ -1,5 +1,5 @@ -setGlobalLogLevel | SAP Cloud SDK for JavaScript - v3.12.1
  • Change the global log level of the container which will set default level for all active loggers. +setGlobalLogLevel | SAP Cloud SDK for JavaScript - v3.12.0

    • Change the global log level of the container which will set default level for all active loggers. e.g., to set the global log level call setGlobalLogLevel('debug').

      -

      Parameters

      • level: LogLevel

        The log level to set the global log level to.

        +

        Parameters

        • level: LogLevel

          The log level to set the global log level to.

          Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

          -

        Returns void

    \ No newline at end of file +

Returns void

\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.setGlobalTransports.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.setGlobalTransports.html index ed5ef4b7a7..862dcc00b1 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.setGlobalTransports.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.setGlobalTransports.html @@ -1,5 +1,5 @@ -setGlobalTransports | SAP Cloud SDK for JavaScript - v3.12.1
  • Change the global transport of the container which will set default transport for all active loggers. +setGlobalTransports | SAP Cloud SDK for JavaScript - v3.12.0

    • Change the global transport of the container which will set default transport for all active loggers. e.g., to set the global transport call setGlobalTransports(httpTransport).

      -

      Parameters

      • customTransports: TransportStream | TransportStream[]

        The transport to set the global transport to. Both single transport and an array with multiple transports are supported.

        +

        Parameters

        • customTransports: TransportStream | TransportStream[]

          The transport to set the global transport to. Both single transport and an array with multiple transports are supported.

          Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

          -

        Returns void

    \ No newline at end of file +

Returns void

\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.setLogFormat.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.setLogFormat.html index c1cd026689..16dd9983b0 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.setLogFormat.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.setLogFormat.html @@ -1,6 +1,6 @@ -setLogFormat | SAP Cloud SDK for JavaScript - v3.12.1
  • Change the log format of a logger based on its message context. +setLogFormat | SAP Cloud SDK for JavaScript - v3.12.0

    • Change the log format of a logger based on its message context. e.g., to set the log format for the destination accessor module of the SDK to local, simply call setLogFormat(logFormat.local, 'destination-accessor').

      -

      Parameters

      • format: Format

        Format to set the logger to. Use logFormat to get the pre-defined log formats or use a custom log format.

        -
      • Optional messageContextOrLogger: string | Logger

        Message context of the logger to change the log level for or the logger itself.

        +

        Parameters

        • format: Format

          Format to set the logger to. Use logFormat to get the pre-defined log formats or use a custom log format.

          +
        • Optional messageContextOrLogger: string | Logger

          Message context of the logger to change the log level for or the logger itself.

          Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

          -

        Returns void

    \ No newline at end of file +

Returns void

\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.setLogLevel.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.setLogLevel.html index 7a689101af..2ca0efe98b 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.setLogLevel.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.setLogLevel.html @@ -1,6 +1,6 @@ -setLogLevel | SAP Cloud SDK for JavaScript - v3.12.1
  • Change the log level of a logger based on its message context. +setLogLevel | SAP Cloud SDK for JavaScript - v3.12.0

    • Change the log level of a logger based on its message context. e.g., to set the log level for the destination accessor module of the SDK to debug, simply call setLogLevel('debug', 'destination-accessor').

      -

      Parameters

      • level: "" | LogLevel

        Level to set the logger to. Use an empty string '' as level to unset context level.

        -
      • Optional messageContextOrLogger: string | Logger

        Message context of the logger to change the log level for or the logger itself.

        +

        Parameters

        • level: "" | LogLevel

          Level to set the logger to. Use an empty string '' as level to unset context level.

          +
        • Optional messageContextOrLogger: string | Logger

          Message context of the logger to change the log level for or the logger itself.

          Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

          -

        Returns void

    \ No newline at end of file +

Returns void

\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.splitInChunks.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.splitInChunks.html index ac0f24bae6..b64e586004 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.splitInChunks.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.splitInChunks.html @@ -1,6 +1,6 @@ -splitInChunks | SAP Cloud SDK for JavaScript - v3.12.1
  • Split the given array in chunks.

    -

    Type Parameters

    • T

    Parameters

\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.titleFormat.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.titleFormat.html index 1fd253a677..96e4f66602 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.titleFormat.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.titleFormat.html @@ -1,5 +1,5 @@ -titleFormat | SAP Cloud SDK for JavaScript - v3.12.1
  • Convert a string to a human readable format, e.g. it transforms to_BusinessPartner to To Business Partner.

    -

    Parameters

    • str: string

      The string to be transformed.

      +titleFormat | SAP Cloud SDK for JavaScript - v3.12.0
      • Convert a string to a human readable format, e.g. it transforms to_BusinessPartner to To Business Partner.

        +

        Parameters

        • str: string

          The string to be transformed.

        Returns string

        The transformed string.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.toSanitizedObject.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.toSanitizedObject.html index 2986cb20a8..36fcafd717 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.toSanitizedObject.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.toSanitizedObject.html @@ -1,8 +1,8 @@ -toSanitizedObject | SAP Cloud SDK for JavaScript - v3.12.1
  • Create an object based on the given key and value if neither key nor value are nullish.

    -

    Parameters

    • key: string

      Name of the header.

      -
    • value: any

      Value of the header.

      +toSanitizedObject | SAP Cloud SDK for JavaScript - v3.12.0
      • Create an object based on the given key and value if neither key nor value are nullish.

        +

        Parameters

        • key: string

          Name of the header.

          +
        • value: any

          Value of the header.

        Returns Record<string, any>

        • An object containing the given key and value of an empty object.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.transformVariadicArgumentToArray.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.transformVariadicArgumentToArray.html index d58d78223a..4edeffb31c 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.transformVariadicArgumentToArray.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.transformVariadicArgumentToArray.html @@ -1,10 +1,10 @@ -transformVariadicArgumentToArray | SAP Cloud SDK for JavaScript - v3.12.1
  • We want to provide methods which accept a variable single number of elements and arrays. +transformVariadicArgumentToArray | SAP Cloud SDK for JavaScript - v3.12.0

    • We want to provide methods which accept a variable single number of elements and arrays. The overloaded signature to achieve this is:

      function doSomething(array: T[])
      function doSomething(...varArgs: T[])
      function doSomething(first: undefined | T | T[], ...rest: T[]) {
      //implementation
      }

      This wrapper methods makes it easy build an array from the input.

      -

      Type Parameters

      • T

      Parameters

      • firstOrArray: undefined | T | T[]

        Either an array, the first element of the var args or undefined, if no argument was given.

        -
      • rest: T[]

        Second to last element, if var args were used, empty array, if the first argument is an array.

        +

        Type Parameters

        • T

        Parameters

        • firstOrArray: undefined | T | T[]

          Either an array, the first element of the var args or undefined, if no argument was given.

          +
        • rest: T[]

          Second to last element, if var args were used, empty array, if the first argument is an array.

        Returns T[]

        Array from the input or empty array if no input was given.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
    \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.trim.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.trim.html index 281c37bc2d..899048aba3 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.trim.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.trim.html @@ -1,5 +1,5 @@ -trim | SAP Cloud SDK for JavaScript - v3.12.1
  • Remove whitespace from the left and right side of a string.

    -

    Parameters

    • string: string

      String to trim.

      +trim | SAP Cloud SDK for JavaScript - v3.12.0
      • Remove whitespace from the left and right side of a string.

        +

        Parameters

        • string: string

          String to trim.

        Returns string

        String without outer whitespace.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.trimLeft.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.trimLeft.html index ca45295a91..dec44768d2 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.trimLeft.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.trimLeft.html @@ -1,5 +1,5 @@ -trimLeft | SAP Cloud SDK for JavaScript - v3.12.1
  • Remove whitespace from the left side of a string.

    -

    Parameters

    • string: string

      String to trim.

      +trimLeft | SAP Cloud SDK for JavaScript - v3.12.0
      • Remove whitespace from the left side of a string.

        +

        Parameters

        • string: string

          String to trim.

        Returns string

        String without whitespace on the left side.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.trimRight.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.trimRight.html index 0fc9231ca3..27c8420032 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.trimRight.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.trimRight.html @@ -1,5 +1,5 @@ -trimRight | SAP Cloud SDK for JavaScript - v3.12.1
  • Remove whitespace from the right side of a string.

    -

    Parameters

    • string: string

      String to trim.

      +trimRight | SAP Cloud SDK for JavaScript - v3.12.0
      • Remove whitespace from the right side of a string.

        +

        Parameters

        • string: string

          String to trim.

        Returns string

        String without whitespace on the right side.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.unique.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.unique.html index 3ebf682710..88845b5fd9 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.unique.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.unique.html @@ -1,5 +1,5 @@ -unique | SAP Cloud SDK for JavaScript - v3.12.1
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.unmuteLoggers.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.unmuteLoggers.html index b5d7f5d5f0..fc62b93acb 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.unmuteLoggers.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.unmuteLoggers.html @@ -1,3 +1,3 @@ -unmuteLoggers | SAP Cloud SDK for JavaScript - v3.12.1
  • Unmute all logger output created by the SAP Cloud SDK Logger. This also applies to future loggers created. Useful for tests.

    +unmuteLoggers | SAP Cloud SDK for JavaScript - v3.12.0
    • Unmute all logger output created by the SAP Cloud SDK Logger. This also applies to future loggers created. Useful for tests.

      Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

      -

      Returns void

    \ No newline at end of file +

    Returns void

\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.upperCaseSnakeCase.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.upperCaseSnakeCase.html index e060e427aa..3177d5299f 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.upperCaseSnakeCase.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.upperCaseSnakeCase.html @@ -1,5 +1,5 @@ -upperCaseSnakeCase | SAP Cloud SDK for JavaScript - v3.12.1
  • Convert a string to the uppercase snake case. This format is used e.g. for static properties on entity classes.

    -

    Parameters

    • str: string

      The string to be transformed.

      +upperCaseSnakeCase | SAP Cloud SDK for JavaScript - v3.12.0
      • Convert a string to the uppercase snake case. This format is used e.g. for static properties on entity classes.

        +

        Parameters

        • str: string

          The string to be transformed.

        Returns string

        The input string in the case used by static methods on entity-classes.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.zip.html b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.zip.html index 32eb712015..48a430cc85 100644 --- a/knowledge-base/api-reference/functions/sap_cloud_sdk_util.zip.html +++ b/knowledge-base/api-reference/functions/sap_cloud_sdk_util.zip.html @@ -1,8 +1,8 @@ -zip | SAP Cloud SDK for JavaScript - v3.12.1
  • Merge two arrays by alternately adding inserting values from both arrays, starting from the left.

    -

    Type Parameters

    • T

    Parameters

    • left: T[]

      Array to start alternately merging from.

      -
    • right: T[]

      Second array to merge.

      +zip | SAP Cloud SDK for JavaScript - v3.12.0
      • Merge two arrays by alternately adding inserting values from both arrays, starting from the left.

        +

        Type Parameters

        • T

        Parameters

        • left: T[]

          Array to start alternately merging from.

          +
        • right: T[]

          Second array to merge.

        Returns T[]

        Zipped array.

        Example

        `zip([1, 2], [3, 4, 5, 6])` results in `[1, 3, 2, 4, 5, 6]`.
         

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/hierarchy.html b/knowledge-base/api-reference/hierarchy.html index fe50980b18..7db74a218b 100644 --- a/knowledge-base/api-reference/hierarchy.html +++ b/knowledge-base/api-reference/hierarchy.html @@ -1,2 +1,2 @@

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-SAP Cloud SDK for JavaScript - v3.12.1

SAP Cloud SDK for JavaScript - v3.12.1

Class Hierarchy

\ No newline at end of file +SAP Cloud SDK for JavaScript - v3.12.0

SAP Cloud SDK for JavaScript - v3.12.0

Class Hierarchy

\ No newline at end of file diff --git a/knowledge-base/api-reference/index.html b/knowledge-base/api-reference/index.html index e4939d3137..3635569f2a 100644 --- a/knowledge-base/api-reference/index.html +++ b/knowledge-base/api-reference/index.html @@ -1,4 +1,4 @@ -SAP Cloud SDK for JavaScript - v3.12.1

SAP Cloud SDK for JavaScript - v3.12.1

Version: 3.12.1

The SAP Cloud SDK for JavaScript consists of multiple libraries to enable you to write side-by-side extensions on SAP Business Technology Platform.

+SAP Cloud SDK for JavaScript - v3.12.0

SAP Cloud SDK for JavaScript - v3.12.0

Version: 3.12.0

The SAP Cloud SDK for JavaScript consists of multiple libraries to enable you to write side-by-side extensions on SAP Business Technology Platform.

Links

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.AllDestinations.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.AllDestinations.html index d4b06b7660..3527fbecab 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.AllDestinations.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.AllDestinations.html @@ -1,8 +1,8 @@ -AllDestinations | SAP Cloud SDK for JavaScript - v3.12.1

Collection of all destinations from the provider and subscriber account. +AllDestinations | SAP Cloud SDK for JavaScript - v3.12.0

Collection of all destinations from the provider and subscriber account. The used DestinationSelectionStrategy will decide which destination is selected in the end.

-
interface AllDestinations {
    provider: DestinationsByType;
    subscriber: DestinationsByType;
}

Properties

Properties

Collection of all destinations from the provider account.

-
subscriber: DestinationsByType

Collection of all destinations from the subscriber account.

+
interface AllDestinations {
    provider: DestinationsByType;
    subscriber: DestinationsByType;
}

Properties

Properties

Collection of all destinations from the provider account.

+
subscriber: DestinationsByType

Collection of all destinations from the subscriber account.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.BasicProxyConfiguration.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.BasicProxyConfiguration.html index 4853d84614..76020b2fdb 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.BasicProxyConfiguration.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.BasicProxyConfiguration.html @@ -1,9 +1,9 @@ -BasicProxyConfiguration | SAP Cloud SDK for JavaScript - v3.12.1

Standard proxy configuration without additional headers nor authorization info.

-
interface BasicProxyConfiguration {
    host: string;
    port: number;
    protocol: Protocol;
}

Hierarchy (view full)

Properties

Properties

host: string

The host of the proxy.

-
port: number

The port of the proxy.

-
protocol: Protocol

The protocol used by the proxy.

+BasicProxyConfiguration | SAP Cloud SDK for JavaScript - v3.12.0

Standard proxy configuration without additional headers nor authorization info.

+
interface BasicProxyConfiguration {
    host: string;
    port: number;
    protocol: Protocol;
}

Hierarchy (view full)

Properties

Properties

host: string

The host of the proxy.

+
port: number

The port of the proxy.

+
protocol: Protocol

The protocol used by the proxy.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.CacheEntry.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.CacheEntry.html index ddf6ee3062..e283f525d1 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.CacheEntry.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.CacheEntry.html @@ -1,7 +1,7 @@ -CacheEntry | SAP Cloud SDK for JavaScript - v3.12.1

Representation of a cached object.

-
interface CacheEntry<T> {
    entry: T;
    expires?: number;
}

Type Parameters

  • T

Properties

Properties

entry: T

The cache entry.

-
expires?: number

The expiration time of the cache entry in milliseconds.

+CacheEntry | SAP Cloud SDK for JavaScript - v3.12.0

Representation of a cached object.

+
interface CacheEntry<T> {
    entry: T;
    expires?: number;
}

Type Parameters

  • T

Properties

Properties

entry: T

The cache entry.

+
expires?: number

The expiration time of the cache entry in milliseconds.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.CachingOptions.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.CachingOptions.html index 95ad49ccf8..76e02d280c 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.CachingOptions.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.CachingOptions.html @@ -1,5 +1,5 @@ -CachingOptions | SAP Cloud SDK for JavaScript - v3.12.1

Options to enable caching when fetching destinations.

-
interface CachingOptions {
    useCache?: boolean;
}

Properties

Properties

useCache?: boolean

A boolean value that indicates whether to read destinations from cache.

+CachingOptions | SAP Cloud SDK for JavaScript - v3.12.0

Options to enable caching when fetching destinations.

+
interface CachingOptions {
    useCache?: boolean;
}

Properties

Properties

useCache?: boolean

A boolean value that indicates whether to read destinations from cache.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.ClientCredentialsResponse.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.ClientCredentialsResponse.html index 66ef903073..41468626c2 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.ClientCredentialsResponse.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.ClientCredentialsResponse.html @@ -1,13 +1,13 @@ -ClientCredentialsResponse | SAP Cloud SDK for JavaScript - v3.12.1

Represents the response to a client credentials request.

-
interface ClientCredentialsResponse {
    access_token: string;
    expires_in: number;
    jti: string;
    scope: string;
    token_type: string;
}

Properties

access_token: string

Token to access the service.

-
expires_in: number

The number of seconds until the access token expires.

-
jti: string

Token id.

-
scope: string

Scopes associated with the token.

-
token_type: string

Type of the token, e.g., Bearer.

+ClientCredentialsResponse | SAP Cloud SDK for JavaScript - v3.12.0

Represents the response to a client credentials request.

+
interface ClientCredentialsResponse {
    access_token: string;
    expires_in: number;
    jti: string;
    scope: string;
    token_type: string;
}

Properties

access_token: string

Token to access the service.

+
expires_in: number

The number of seconds until the access token expires.

+
jti: string

Token id.

+
scope: string

Scopes associated with the token.

+
token_type: string

Type of the token, e.g., Bearer.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.Destination.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.Destination.html index 6627015bd5..868b7c79bf 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.Destination.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.Destination.html @@ -1,74 +1,74 @@ -Destination | SAP Cloud SDK for JavaScript - v3.12.1

A resolved destination containing information needed to execute requests, such as the system URL.

+Destination | SAP Cloud SDK for JavaScript - v3.12.0

A resolved destination containing information needed to execute requests, such as the system URL.

You can create a destination as a local object when supplying all necessary information, or it could be retrieved from the destination service on SAP Business Technology Platform (via DestinationFetchOptions). When creating a local object representing a destination, you need to supply at least the url and, if required by the target system, valid credentials with username and password.

-
interface Destination {
    authTokens?: null | DestinationAuthToken[];
    authentication?: AuthenticationType;
    certificates?: DestinationCertificate[];
    clientId?: string;
    clientSecret?: string;
    cloudConnectorLocationId?: string;
    forwardAuthToken?: boolean;
    headers?: Record<string, any>;
    isTestDestination?: boolean;
    isTrustingAllCertificates?: boolean;
    jwks?: string;
    jwksUri?: string;
    keyStoreName?: string;
    keyStorePassword?: string;
    mtls?: boolean;
    name?: null | string;
    originalProperties?: {
        [key: string]: any;
    };
    password?: null | string;
    proxyConfiguration?: ProxyConfiguration;
    proxyType?: DestinationProxyType;
    queryParameters?: Record<string, any>;
    sapClient?: null | string;
    systemUser?: string;
    tokenServicePassword?: string;
    tokenServiceUrl?: string;
    tokenServiceUser?: string;
    trustStoreCertificate?: DestinationCertificate;
    type?: "HTTP" | "LDAP" | "MAIL" | "RFC";
    url?: string;
    username?: null | string;
}

Properties

authTokens?: null | DestinationAuthToken[]

Authentication tokens returned from destination service on SAP Business Technology Platform.

-
authentication?: AuthenticationType

Type of authentication to use.

+
interface Destination {
    authTokens?: null | DestinationAuthToken[];
    authentication?: AuthenticationType;
    certificates?: DestinationCertificate[];
    clientId?: string;
    clientSecret?: string;
    cloudConnectorLocationId?: string;
    forwardAuthToken?: boolean;
    headers?: Record<string, any>;
    isTestDestination?: boolean;
    isTrustingAllCertificates?: boolean;
    jwks?: string;
    jwksUri?: string;
    keyStoreName?: string;
    keyStorePassword?: string;
    mtls?: boolean;
    name?: null | string;
    originalProperties?: {
        [key: string]: any;
    };
    password?: null | string;
    proxyConfiguration?: ProxyConfiguration;
    proxyType?: DestinationProxyType;
    queryParameters?: Record<string, any>;
    sapClient?: null | string;
    systemUser?: string;
    tokenServicePassword?: string;
    tokenServiceUrl?: string;
    tokenServiceUser?: string;
    trustStoreCertificate?: DestinationCertificate;
    type?: "HTTP" | "LDAP" | "MAIL" | "RFC";
    url?: string;
    username?: null | string;
}

Properties

authTokens?: null | DestinationAuthToken[]

Authentication tokens returned from destination service on SAP Business Technology Platform.

+
authentication?: AuthenticationType

Type of authentication to use.

Defaults to NoAuthentication, unless username and password are provided, in which case the default is BasicAuthentication.

-
certificates?: DestinationCertificate[]

Array of certificates used for authentication type ClientCertificateAuthentication.

-
clientId?: string

Client Id used to retrieve access token for "OAuth2ClientCredentials", "OAuth2UserTokenExchange" and "OAuth2JWTBearer" authentication.

-
clientSecret?: string

Client Secret used to retrieve access token for "OAuth2ClientCredentials", "OAuth2UserTokenExchange" and "OAuth2JWTBearer" authentication.

-
cloudConnectorLocationId?: string

Location ID of the Cloud Connector to be used for connection to an On-Premise system. Optional. Corresponds to property "CloudConnectorLocationId" in the additional properties of a destination.

-
forwardAuthToken?: boolean

If set to true the auth token provided to the request execution is forwarded to the destination target.

-
headers?: Record<string, any>

Additional headers to be used for calls against the destination, originally defined by URL.headers.<header-name>. +

certificates?: DestinationCertificate[]

Array of certificates used for authentication type ClientCertificateAuthentication.

+
clientId?: string

Client Id used to retrieve access token for "OAuth2ClientCredentials", "OAuth2UserTokenExchange" and "OAuth2JWTBearer" authentication.

+
clientSecret?: string

Client Secret used to retrieve access token for "OAuth2ClientCredentials", "OAuth2UserTokenExchange" and "OAuth2JWTBearer" authentication.

+
cloudConnectorLocationId?: string

Location ID of the Cloud Connector to be used for connection to an On-Premise system. Optional. Corresponds to property "CloudConnectorLocationId" in the additional properties of a destination.

+
forwardAuthToken?: boolean

If set to true the auth token provided to the request execution is forwarded to the destination target.

+
headers?: Record<string, any>

Additional headers to be used for calls against the destination, originally defined by URL.headers.<header-name>. The keys of this object denote the names of the headers and the values their values.

-
isTestDestination?: boolean

Flag indicating whether the destination is for test purpose. Should be "undefined" or "false" for non-mocked destinations.

-
isTrustingAllCertificates?: boolean

Flag indicating whether all certificates should be accepted when communicating with the destination. Should not be "true" in production.

-
jwks?: string

Base64-encoded JSON web key set, containing the signing keys which are used to validate the JWT provided in the X-User-Token header. +

isTestDestination?: boolean

Flag indicating whether the destination is for test purpose. Should be "undefined" or "false" for non-mocked destinations.

+
isTrustingAllCertificates?: boolean

Flag indicating whether all certificates should be accepted when communicating with the destination. Should not be "true" in production.

+
jwks?: string

Base64-encoded JSON web key set, containing the signing keys which are used to validate the JWT provided in the X-User-Token header. This field is used to authenticate the destination using a JWT without JKU.

-
jwksUri?: string

URI of the JSON web key set, containing the signing keys which are used to validate the JWT provided in the X-User-Token header. +

jwksUri?: string

URI of the JSON web key set, containing the signing keys which are used to validate the JWT provided in the X-User-Token header. This field is used to authenticate the destination using a JWT without JKU.

-
keyStoreName?: string

Name of the key store/certificate to be used for ClientCertificateAuthentication.

-
keyStorePassword?: string

Password of the key store/certificate to be used for ClientCertificateAuthentication.

-
mtls?: boolean

Destination has automatic mTLS handling on CloudFoundry.

+
keyStoreName?: string

Name of the key store/certificate to be used for ClientCertificateAuthentication.

+
keyStorePassword?: string

Password of the key store/certificate to be used for ClientCertificateAuthentication.

+
mtls?: boolean

Destination has automatic mTLS handling on CloudFoundry.

If this option is set to true, the CloudFoundry instance identity will be automatically used for TLS secured HTTP requests.

-
name?: null | string

Name of the destination retrieved from SAP Business Technology Platform.

-
originalProperties?: {
    [key: string]: any;
}

Further properties of the destination as defined in destination service on SAP Business Technology Platform, possibly empty.

-

Type declaration

  • [key: string]: any
password?: null | string

Password to use for basic authentication, optional if other means of authentication shall be used.

-
proxyConfiguration?: ProxyConfiguration

ProxyConfiguration for on-premise connectivity and http(s) web proxies. Is present if proxyType of the destination equals "OnPremise" or environment variables [http_proxy] or [https_proxy] are set See ProxyConfiguration.

-

Proxy type to specify whether the target resides on-premise (not used).

-
queryParameters?: Record<string, any>

Additional query parameters to be used for calls against the destination, originally defined by URL.queries.<query-parameter-name>. +

name?: null | string

Name of the destination retrieved from SAP Business Technology Platform.

+
originalProperties?: {
    [key: string]: any;
}

Further properties of the destination as defined in destination service on SAP Business Technology Platform, possibly empty.

+

Type declaration

  • [key: string]: any
password?: null | string

Password to use for basic authentication, optional if other means of authentication shall be used.

+
proxyConfiguration?: ProxyConfiguration

ProxyConfiguration for on-premise connectivity and http(s) web proxies. Is present if proxyType of the destination equals "OnPremise" or environment variables [http_proxy] or [https_proxy] are set See ProxyConfiguration.

+

Proxy type to specify whether the target resides on-premise (not used).

+
queryParameters?: Record<string, any>

Additional query parameters to be used for calls against the destination, originally defined by URL.queries.<query-parameter-name>. The keys of this object denote the names of the query parameters and the values their values.

-
sapClient?: null | string

Client to target in an SAP system, will be added as HTTP header sap-client if set.

-
systemUser?: string

System user to be used for OAuth2SAMLBearerAssertion authentication type.

-
tokenServicePassword?: string

Password for tokenServiceUser (if required).

-
tokenServiceUrl?: string

URL to retrieve access token for "OAuth2ClientCredentials", "OAuth2UserTokenExchange" and "OAuth2JWTBearer" authentication.

-
tokenServiceUser?: string

User for basic authentication to OAuth server (if required).

-
trustStoreCertificate?: DestinationCertificate

Trusted certificate for https requests used by the destination. Only relevant for self-signed certificates where trust needs to be enabled in the client.

-
type?: "HTTP" | "LDAP" | "MAIL" | "RFC"

The type of the destination, defaults to 'HTTP'. The SAP Cloud SDK only understands destinations of type 'HTTP' and 'MAIL'.

-
url?: string

Base URL for calls to this destination. +

sapClient?: null | string

Client to target in an SAP system, will be added as HTTP header sap-client if set.

+
systemUser?: string

System user to be used for OAuth2SAMLBearerAssertion authentication type.

+
tokenServicePassword?: string

Password for tokenServiceUser (if required).

+
tokenServiceUrl?: string

URL to retrieve access token for "OAuth2ClientCredentials", "OAuth2UserTokenExchange" and "OAuth2JWTBearer" authentication.

+
tokenServiceUser?: string

User for basic authentication to OAuth server (if required).

+
trustStoreCertificate?: DestinationCertificate

Trusted certificate for https requests used by the destination. Only relevant for self-signed certificates where trust needs to be enabled in the client.

+
type?: "HTTP" | "LDAP" | "MAIL" | "RFC"

The type of the destination, defaults to 'HTTP'. The SAP Cloud SDK only understands destinations of type 'HTTP' and 'MAIL'.

+
url?: string

Base URL for calls to this destination. The URL has to define the protocol, like http:// or https://, and a host. The path for requests against this destination will be appended to the path defined in the URL as a new path segment.

-
username?: null | string

Username to use for basic authentication, optional if other means of authentication shall be used.

+
username?: null | string

Username to use for basic authentication, optional if other means of authentication shall be used.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.DestinationAccessorOptions.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.DestinationAccessorOptions.html index 2c9ce2900b..32d0398dcd 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.DestinationAccessorOptions.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.DestinationAccessorOptions.html @@ -1,27 +1,27 @@ -DestinationAccessorOptions | SAP Cloud SDK for JavaScript - v3.12.1

Options to configure the behavior of the destination accessor.

+DestinationAccessorOptions | SAP Cloud SDK for JavaScript - v3.12.0

Options to configure the behavior of the destination accessor.

interface DestinationAccessorOptions {
    iasToXsuaaTokenExchange?: boolean;
    iss?: string;
    jwt?: string;
    refreshToken?: string;
    selectionStrategy?: DestinationSelectionStrategy;
}

Properties

iasToXsuaaTokenExchange?: boolean

Option to enable/disable the IAS token to XSUAA token exchange.

-
iss?: string

This property is only considered in case no jwt is provided. +

interface DestinationAccessorOptions {
    iasToXsuaaTokenExchange?: boolean;
    iss?: string;
    jwt?: string;
    refreshToken?: string;
    selectionStrategy?: DestinationSelectionStrategy;
}

Properties

iasToXsuaaTokenExchange?: boolean

Option to enable/disable the IAS token to XSUAA token exchange.

+
iss?: string

This property is only considered in case no jwt is provided. It is meant for situations where you do not have a token e.g. background processes. The value for iss is the issuer field of a JWT e.g. https://.localhost:8080/uaa/oauth/token.

ATTENTION: If this property is used, no validation of the provided subdomain value is done. This is differs from how the jwt is handled. So be careful that the used value is not manipulated and breaks the tenant isolation of your application.

-
jwt?: string

The user token of the current request.

+
jwt?: string

The user token of the current request.

ATTENTION: The property is mandatory in the following cases:

  • User-dependent authentication flow is used, e.g., OAuth2UserTokenExchange, OAuth2JWTBearer, OAuth2SAMLBearerAssertion, SAMLAssertion or PrincipalPropagation.
  • Multi-tenant scenarios with destinations maintained in the subscriber account. This case is implied if the selectionStrategy is set to alwaysSubscriber.
-
refreshToken?: string

The token is used to request an access token from an OAuth server. +

refreshToken?: string

The token is used to request an access token from an OAuth server. The value is mandatory for authentication type OAuth2RefreshToken and is ignored for other authentication types. The value must be provided in a refresh token format.

selectionStrategy?: DestinationSelectionStrategy

Method that implements the selection strategy of the retrieved destination. Uses subscriberFirst per default. Use the selector helper DestinationSelectionStrategies to select the appropriate selection strategy.

+
selectionStrategy?: DestinationSelectionStrategy

Method that implements the selection strategy of the retrieved destination. Uses subscriberFirst per default. Use the selector helper DestinationSelectionStrategies to select the appropriate selection strategy.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.DestinationAuthToken.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.DestinationAuthToken.html index dd91bc1162..ee77cad7a0 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.DestinationAuthToken.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.DestinationAuthToken.html @@ -1,13 +1,13 @@ -DestinationAuthToken | SAP Cloud SDK for JavaScript - v3.12.1

Represents authentication token returned from destination service.

-
interface DestinationAuthToken {
    error: null | string;
    expiresIn?: string;
    http_header: {
        key: string;
        value: string;
    };
    type: string;
    value: string;
}

Properties

error: null | string

Potential error of token retrieval in the destination service.

-
expiresIn?: string

The number of seconds until the access token expires.

-
http_header: {
    key: string;
    value: string;
}

An object containing ready-to-use key-value pairs like Authorization : Bearer U29tZVRva2VuVmFsdWU=.

-

Type declaration

  • key: string
  • value: string
type: string

Type of the token, e.g., Bearer.

-
value: string

Value of the token.

+DestinationAuthToken | SAP Cloud SDK for JavaScript - v3.12.0

Represents authentication token returned from destination service.

+
interface DestinationAuthToken {
    error: null | string;
    expiresIn?: string;
    http_header: {
        key: string;
        value: string;
    };
    type: string;
    value: string;
}

Properties

error: null | string

Potential error of token retrieval in the destination service.

+
expiresIn?: string

The number of seconds until the access token expires.

+
http_header: {
    key: string;
    value: string;
}

An object containing ready-to-use key-value pairs like Authorization : Bearer U29tZVRva2VuVmFsdWU=.

+

Type declaration

  • key: string
  • value: string
type: string

Type of the token, e.g., Bearer.

+
value: string

Value of the token.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.DestinationCertificate.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.DestinationCertificate.html index 74135aa556..9129ffcf00 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.DestinationCertificate.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.DestinationCertificate.html @@ -1,9 +1,9 @@ -DestinationCertificate | SAP Cloud SDK for JavaScript - v3.12.1

Represents a certificate attached to a destination.

-
interface DestinationCertificate {
    content: string;
    name: string;
    type: string;
}

Properties

Properties

content: string

Content of the certificate as base64 encoded binary.

-
name: string

Name of the certificate file.

-
type: string

Type of the certificate.

+DestinationCertificate | SAP Cloud SDK for JavaScript - v3.12.0

Represents a certificate attached to a destination.

+
interface DestinationCertificate {
    content: string;
    name: string;
    type: string;
}

Properties

Properties

content: string

Content of the certificate as base64 encoded binary.

+
name: string

Name of the certificate file.

+
type: string

Type of the certificate.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.DestinationConfiguration.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.DestinationConfiguration.html index 9b41ae7a82..b16bac04f7 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.DestinationConfiguration.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.DestinationConfiguration.html @@ -1,39 +1,39 @@ -DestinationConfiguration | SAP Cloud SDK for JavaScript - v3.12.1

Configuration of a destination as it is available through the destination service.

-
interface DestinationConfiguration {
    Authentication?: AuthenticationType;
    Name?: string;
    Password?: string;
    ProxyType?: string;
    SystemUser?: string;
    TrustAll?: string;
    Type?: "HTTP" | "LDAP" | "MAIL" | "RFC";
    URL?: string;
    User?: string;
    clientId?: string;
    clientSecret?: string;
    sap-client?: string;
    tokenServicePass?: string;
    tokenServiceURL?: string;
    tokenServiceURLType?: "Common" | "Dedicated;";
    tokenServiceUsername?: string;
    [key: string]: any;
}

Indexable

[key: string]: any

Properties

Authentication?: AuthenticationType

Represents the authentication type of a destination.

-
Name?: string

Name of the destination.

-
Password?: string

Password in case of basic authentication destinations.

-
ProxyType?: string

ProxyType of the destination, e.g., Internet or OnPremise.

-
SystemUser?: string

Deprecated option of the destination service to fix a user in OnPremise principal propagation.

-
TrustAll?: string

Value of the TrustAll property of the destination.

-
Type?: "HTTP" | "LDAP" | "MAIL" | "RFC"

Type of the destination.

-
URL?: string

URL of the destination.

-
User?: string

Username in case of basic authentication destinations.

-
clientId?: string

ClientId to retrieve an auth token from the token service endpoint.

-
clientSecret?: string

ClientSecret to retrieve an auth token from the token service endpoint.

-
sap-client?: string

sap-client defined in the destination.

-
tokenServicePass?: string

Password to retrieve an auth token from the endpoint.

-
tokenServiceURL?: string

URL of the token service endpoint to retrieve access token. +DestinationConfiguration | SAP Cloud SDK for JavaScript - v3.12.0

Configuration of a destination as it is available through the destination service.

+
interface DestinationConfiguration {
    Authentication?: AuthenticationType;
    Name?: string;
    Password?: string;
    ProxyType?: string;
    SystemUser?: string;
    TrustAll?: string;
    Type?: "HTTP" | "LDAP" | "MAIL" | "RFC";
    URL?: string;
    User?: string;
    clientId?: string;
    clientSecret?: string;
    sap-client?: string;
    tokenServicePass?: string;
    tokenServiceURL?: string;
    tokenServiceURLType?: "Common" | "Dedicated;";
    tokenServiceUsername?: string;
    [key: string]: any;
}

Indexable

[key: string]: any

Properties

Authentication?: AuthenticationType

Represents the authentication type of a destination.

+
Name?: string

Name of the destination.

+
Password?: string

Password in case of basic authentication destinations.

+
ProxyType?: string

ProxyType of the destination, e.g., Internet or OnPremise.

+
SystemUser?: string

Deprecated option of the destination service to fix a user in OnPremise principal propagation.

+
TrustAll?: string

Value of the TrustAll property of the destination.

+
Type?: "HTTP" | "LDAP" | "MAIL" | "RFC"

Type of the destination.

+
URL?: string

URL of the destination.

+
User?: string

Username in case of basic authentication destinations.

+
clientId?: string

ClientId to retrieve an auth token from the token service endpoint.

+
clientSecret?: string

ClientSecret to retrieve an auth token from the token service endpoint.

+
sap-client?: string

sap-client defined in the destination.

+
tokenServicePass?: string

Password to retrieve an auth token from the endpoint.

+
tokenServiceURL?: string

URL of the token service endpoint to retrieve access token. This may contain placeholders in multi-tenant scenarios.

See

SAML Bearer Assertion Authentication. In most cases the XSUAA will be used here.

-
tokenServiceURLType?: "Common" | "Dedicated;"

Decides if the token service subdomain is fixed or adjusted in multi-tenant scenarios.

+
tokenServiceURLType?: "Common" | "Dedicated;"

Decides if the token service subdomain is fixed or adjusted in multi-tenant scenarios.

tokenServiceUsername?: string

Fixed username to retrieve an auth token from the endpoint.

+
tokenServiceUsername?: string

Fixed username to retrieve an auth token from the endpoint.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.DestinationFetchOptions.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.DestinationFetchOptions.html index d64c9fcb8a..4eee44bd20 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.DestinationFetchOptions.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.DestinationFetchOptions.html @@ -1,4 +1,4 @@ -DestinationFetchOptions | SAP Cloud SDK for JavaScript - v3.12.1

Declaration of a destination to be retrieved from an environment variable or from the destination service on SAP Business Technology Platform, including all DestinationOptions.

+DestinationFetchOptions | SAP Cloud SDK for JavaScript - v3.12.0

Declaration of a destination to be retrieved from an environment variable or from the destination service on SAP Business Technology Platform, including all DestinationOptions.

Use an object of this interface to specify which destination shall be used when executing a request. The destination will be retrieved via its DestinationFetchOptions.destinationName according to the following algorithm:

    @@ -7,41 +7,41 @@ Additionally, you can set DestinationOptions for objects of this interface. For more information check out our documentation: https://sap.github.io/cloud-sdk/docs/js/features/connectivity/destination.
-
interface DestinationFetchOptions {
    cacheVerificationKeys?: boolean;
    destinationName: string;
    iasToXsuaaTokenExchange?: boolean;
    isolationStrategy?: IsolationStrategy;
    iss?: string;
    jwt?: string;
    refreshToken?: string;
    retry?: boolean;
    selectionStrategy?: DestinationSelectionStrategy;
    useCache?: boolean;
}

Hierarchy (view full)

Properties

cacheVerificationKeys?: boolean

The verification keys are cached if set to true.

-
destinationName: string

Name of the destination to retrieve, mandatory.

-
iasToXsuaaTokenExchange?: boolean

Option to enable/disable the IAS token to XSUAA token exchange.

-
isolationStrategy?: IsolationStrategy

The isolation strategy used for caching destinations. For the available options, see IsolationStrategy. +

interface DestinationFetchOptions {
    cacheVerificationKeys?: boolean;
    destinationName: string;
    iasToXsuaaTokenExchange?: boolean;
    isolationStrategy?: IsolationStrategy;
    iss?: string;
    jwt?: string;
    refreshToken?: string;
    retry?: boolean;
    selectionStrategy?: DestinationSelectionStrategy;
    useCache?: boolean;
}

Hierarchy (view full)

Properties

cacheVerificationKeys?: boolean

The verification keys are cached if set to true.

+
destinationName: string

Name of the destination to retrieve, mandatory.

+
iasToXsuaaTokenExchange?: boolean

Option to enable/disable the IAS token to XSUAA token exchange.

+
isolationStrategy?: IsolationStrategy

The isolation strategy used for caching destinations. For the available options, see IsolationStrategy. By default, 'tenant-user' is set.

-
iss?: string

This property is only considered in case no jwt is provided. +

iss?: string

This property is only considered in case no jwt is provided. It is meant for situations where you do not have a token e.g. background processes. The value for iss is the issuer field of a JWT e.g. https://.localhost:8080/uaa/oauth/token.

ATTENTION: If this property is used, no validation of the provided subdomain value is done. This is differs from how the jwt is handled. So be careful that the used value is not manipulated and breaks the tenant isolation of your application.

-
jwt?: string

The user token of the current request.

+
jwt?: string

The user token of the current request.

ATTENTION: The property is mandatory in the following cases:

  • User-dependent authentication flow is used, e.g., OAuth2UserTokenExchange, OAuth2JWTBearer, OAuth2SAMLBearerAssertion, SAMLAssertion or PrincipalPropagation.
  • Multi-tenant scenarios with destinations maintained in the subscriber account. This case is implied if the selectionStrategy is set to alwaysSubscriber.
-
refreshToken?: string

The token is used to request an access token from an OAuth server. +

refreshToken?: string

The token is used to request an access token from an OAuth server. The value is mandatory for authentication type OAuth2RefreshToken and is ignored for other authentication types. The value must be provided in a refresh token format.

retry?: boolean

The call to destination/{name} sometimes also performs a token exchange. Such calls can be flaky due to an unstable token exchange endpoint. +

retry?: boolean

The call to destination/{name} sometimes also performs a token exchange. Such calls can be flaky due to an unstable token exchange endpoint. This parameter enables 3 retries on the destination by name calls. By default, the retry is disabled.

-
selectionStrategy?: DestinationSelectionStrategy

Method that implements the selection strategy of the retrieved destination. Uses subscriberFirst per default. Use the selector helper DestinationSelectionStrategies to select the appropriate selection strategy.

-
useCache?: boolean

A boolean value that indicates whether to read destinations from cache.

+
selectionStrategy?: DestinationSelectionStrategy

Method that implements the selection strategy of the retrieved destination. Uses subscriberFirst per default. Use the selector helper DestinationSelectionStrategies to select the appropriate selection strategy.

+
useCache?: boolean

A boolean value that indicates whether to read destinations from cache.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.DestinationForServiceBindingOptions.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.DestinationForServiceBindingOptions.html index 6a2b3b5c18..e3262a99ae 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.DestinationForServiceBindingOptions.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.DestinationForServiceBindingOptions.html @@ -1,5 +1,5 @@ -DestinationForServiceBindingOptions | SAP Cloud SDK for JavaScript - v3.12.1

Options to customize the behavior of getDestinationFromServiceBinding.

-
interface DestinationForServiceBindingOptions {
    serviceBindingTransformFn?: ServiceBindingTransformFunction;
}

Properties

serviceBindingTransformFn?: ServiceBindingTransformFunction

Custom transformation function to control how a Destination is built from the given Service.

+DestinationForServiceBindingOptions | SAP Cloud SDK for JavaScript - v3.12.0

Options to customize the behavior of getDestinationFromServiceBinding.

+
interface DestinationForServiceBindingOptions {
    serviceBindingTransformFn?: ServiceBindingTransformFunction;
}

Properties

serviceBindingTransformFn?: ServiceBindingTransformFunction

Custom transformation function to control how a Destination is built from the given Service.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.DestinationJson.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.DestinationJson.html index 9e98138ff3..8dee25f9f6 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.DestinationJson.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.DestinationJson.html @@ -1,9 +1,9 @@ -DestinationJson | SAP Cloud SDK for JavaScript - v3.12.1

Destination configuration alongside auth tokens and certificates.

-
interface DestinationJson {
    authTokens?: Record<string, string>[];
    certificates?: Record<string, string>[];
    destinationConfiguration: DestinationConfiguration;
    [key: string]: any;
}

Indexable

[key: string]: any

Properties

authTokens?: Record<string, string>[]

Authentication tokens as they are available through the destination service.

-
certificates?: Record<string, string>[]

Certificates for authentication as they are available through the destination service.

-
destinationConfiguration: DestinationConfiguration

Configuration of a destination as it is available through the destination service.

+DestinationJson | SAP Cloud SDK for JavaScript - v3.12.0

Destination configuration alongside auth tokens and certificates.

+
interface DestinationJson {
    authTokens?: Record<string, string>[];
    certificates?: Record<string, string>[];
    destinationConfiguration: DestinationConfiguration;
    [key: string]: any;
}

Indexable

[key: string]: any

Properties

authTokens?: Record<string, string>[]

Authentication tokens as they are available through the destination service.

+
certificates?: Record<string, string>[]

Certificates for authentication as they are available through the destination service.

+
destinationConfiguration: DestinationConfiguration

Configuration of a destination as it is available through the destination service.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.DestinationsByType.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.DestinationsByType.html index 8998311344..600737bab7 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.DestinationsByType.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.DestinationsByType.html @@ -1,8 +1,8 @@ -DestinationsByType | SAP Cloud SDK for JavaScript - v3.12.1

Collection of all destinations from an account. +DestinationsByType | SAP Cloud SDK for JavaScript - v3.12.0

Collection of all destinations from an account. For a given account a destination can originate from the destination service instance or subaccount.

-
interface DestinationsByType {
    instance: Destination[];
    subaccount: Destination[];
}

Properties

Properties

instance: Destination[]

Collection of destinations from the destination service instance.

-
subaccount: Destination[]

Collection of destinations from the subaccount.

+
interface DestinationsByType {
    instance: Destination[];
    subaccount: Destination[];
}

Properties

Properties

instance: Destination[]

Collection of destinations from the destination service instance.

+
subaccount: Destination[]

Collection of destinations from the subaccount.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.HttpAgentConfig.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.HttpAgentConfig.html index 705621bbdb..d458a1bcfb 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.HttpAgentConfig.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.HttpAgentConfig.html @@ -1,5 +1,5 @@ -HttpAgentConfig | SAP Cloud SDK for JavaScript - v3.12.1

Interface for the http-agent within the Axios request config.

-
interface HttpAgentConfig {
    httpAgent: Agent;
}

Properties

Properties

httpAgent: Agent

HTTP agent either the node default or an HTTP proxy agent if needed.

+HttpAgentConfig | SAP Cloud SDK for JavaScript - v3.12.0

Interface for the http-agent within the Axios request config.

+
interface HttpAgentConfig {
    httpAgent: Agent;
}

Properties

Properties

httpAgent: Agent

HTTP agent either the node default or an HTTP proxy agent if needed.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.HttpsAgentConfig.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.HttpsAgentConfig.html index bf040d7d00..c5c86ba329 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.HttpsAgentConfig.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.HttpsAgentConfig.html @@ -1,5 +1,5 @@ -HttpsAgentConfig | SAP Cloud SDK for JavaScript - v3.12.1

Interface for the https-agent within the Axios request config.

-
interface HttpsAgentConfig {
    httpsAgent: Agent;
}

Properties

Properties

httpsAgent: Agent

HTTPS agent either the node default or an HTTPS proxy agent if needed.

+HttpsAgentConfig | SAP Cloud SDK for JavaScript - v3.12.0

Interface for the https-agent within the Axios request config.

+
interface HttpsAgentConfig {
    httpsAgent: Agent;
}

Properties

Properties

httpsAgent: Agent

HTTPS agent either the node default or an HTTPS proxy agent if needed.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.JwtPayload.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.JwtPayload.html index fd04d018b9..a07bd6e4ee 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.JwtPayload.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.JwtPayload.html @@ -1,17 +1,17 @@ -JwtPayload | SAP Cloud SDK for JavaScript - v3.12.1

This is copied from @types/jsonwebtoken.

-
interface JwtPayload {
    aud?: string | string[];
    exp?: number;
    iat?: number;
    iss?: string;
    jti?: string;
    nbf?: number;
    sub?: string;
    [key: string]: any;
}

Indexable

[key: string]: any

Properties

Properties

aud?: string | string[]
exp?: number
iat?: number
iss?: string
jti?: string
nbf?: number
sub?: string

Standard claims https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.

+JwtPayload | SAP Cloud SDK for JavaScript - v3.12.0

This is copied from @types/jsonwebtoken.

+
interface JwtPayload {
    aud?: string | string[];
    exp?: number;
    iat?: number;
    iss?: string;
    jti?: string;
    nbf?: number;
    sub?: string;
    [key: string]: any;
}

Indexable

[key: string]: any

Properties

Properties

aud?: string | string[]
exp?: number
iat?: number
iss?: string
jti?: string
nbf?: number
sub?: string

Standard claims https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.ProxyConfiguration.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.ProxyConfiguration.html index 12d7c0b9e1..73512a123f 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.ProxyConfiguration.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.ProxyConfiguration.html @@ -1,4 +1,4 @@ -ProxyConfiguration | SAP Cloud SDK for JavaScript - v3.12.1

Proxy settings for connecting to an on-premise destination via connectivity proxy or web proxies. +ProxyConfiguration | SAP Cloud SDK for JavaScript - v3.12.0

Proxy settings for connecting to an on-premise destination via connectivity proxy or web proxies. The ProxyConfiguration is undefined in most cases. The logic for setting it is as follows:

  • If the destination has proxy type "OnPremise" the connectivity service proxy is used.
  • @@ -8,15 +8,15 @@ For user and password non alphanumeric characters need to be percent-encoded. Note: The [no_proxy] environment variables contains a list of URLs for which no proxy will be used even if [http_proxy, https_proxy] are set. Wildcards like *.some.domain.com are not supported while checking the no_proxy env.

    -
interface ProxyConfiguration {
    headers?: ProxyConfigurationHeaders;
    host: string;
    port: number;
    protocol: Protocol;
    proxy-authorization?: string;
}

Hierarchy (view full)

Properties

HTTP headers to be added to a request if tunneled through the proxy.

-
host: string

The host of the proxy.

-
port: number

The port of the proxy.

-
protocol: Protocol

The protocol used by the proxy.

-
proxy-authorization?: string

A JWT for proxy authorization, which is used when HTTP headers are not applicable, e.g., using socket protocols.

+
interface ProxyConfiguration {
    headers?: ProxyConfigurationHeaders;
    host: string;
    port: number;
    protocol: Protocol;
    proxy-authorization?: string;
}

Hierarchy (view full)

Properties

HTTP headers to be added to a request if tunneled through the proxy.

+
host: string

The host of the proxy.

+
port: number

The port of the proxy.

+
protocol: Protocol

The protocol used by the proxy.

+
proxy-authorization?: string

A JWT for proxy authorization, which is used when HTTP headers are not applicable, e.g., using socket protocols.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.ProxyConfigurationHeaders.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.ProxyConfigurationHeaders.html index b220e71a9f..20537b9da1 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.ProxyConfigurationHeaders.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.ProxyConfigurationHeaders.html @@ -1,7 +1,7 @@ -ProxyConfigurationHeaders | SAP Cloud SDK for JavaScript - v3.12.1

Represents the request headers when using a proxy like the connectivity proxy to reach On-Premise systems.

-
interface ProxyConfigurationHeaders {
    Proxy-Authorization: string;
    SAP-Connectivity-Authentication?: string;
    [header: string]: string | undefined;
}

Indexable

[header: string]: string | undefined

Properties

Proxy-Authorization: string

Proxy-Authorization header sent to the proxy.

-
SAP-Connectivity-Authentication?: string

SAP-Connectivity-Authentication header sent via the proxy to the target system containing the propagated user.

+ProxyConfigurationHeaders | SAP Cloud SDK for JavaScript - v3.12.0

Represents the request headers when using a proxy like the connectivity proxy to reach On-Premise systems.

+
interface ProxyConfigurationHeaders {
    Proxy-Authorization: string;
    SAP-Connectivity-Authentication?: string;
    [header: string]: string | undefined;
}

Indexable

[header: string]: string | undefined

Properties

Proxy-Authorization: string

Proxy-Authorization header sent to the proxy.

+
SAP-Connectivity-Authentication?: string

SAP-Connectivity-Authentication header sent via the proxy to the target system containing the propagated user.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.Service.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.Service.html index 6b62eda59a..07823f9df6 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.Service.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.Service.html @@ -1,11 +1,11 @@ -Service | SAP Cloud SDK for JavaScript - v3.12.1

Unspecific representation of a service as read from VCAP_SERVICES (for Cloud Foundry) or mounted secrets (for K8S).

-
interface Service {
    credentials: ServiceCredentials;
    label: string;
    name: string;
    tags: string[];
    [other: string]: any;
}

Indexable

[other: string]: any

Properties

Properties

credentials: ServiceCredentials

The service credentials.

-
label: string

The label of the service.

-
name: string

The name of the service.

-
tags: string[]

The tags of the service.

+Service | SAP Cloud SDK for JavaScript - v3.12.0

Unspecific representation of a service as read from VCAP_SERVICES (for Cloud Foundry) or mounted secrets (for K8S).

+
interface Service {
    credentials: ServiceCredentials;
    label: string;
    name: string;
    tags: string[];
    [other: string]: any;
}

Indexable

[other: string]: any

Properties

Properties

credentials: ServiceCredentials

The service credentials.

+
label: string

The label of the service.

+
name: string

The name of the service.

+
tags: string[]

The tags of the service.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.VerifyJwtOptions.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.VerifyJwtOptions.html index ee497874f5..1429201e45 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.VerifyJwtOptions.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_connectivity.VerifyJwtOptions.html @@ -1,5 +1,5 @@ -VerifyJwtOptions | SAP Cloud SDK for JavaScript - v3.12.1

Options to control certain aspects of JWT verification behavior.

-
interface VerifyJwtOptions {
    cacheVerificationKeys?: boolean;
}

Properties

cacheVerificationKeys?: boolean

The verification keys are cached if set to true.

+VerifyJwtOptions | SAP Cloud SDK for JavaScript - v3.12.0

Options to control certain aspects of JWT verification behavior.

+
interface VerifyJwtOptions {
    cacheVerificationKeys?: boolean;
}

Properties

cacheVerificationKeys?: boolean

The verification keys are cached if set to true.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_generator.GeneratorOptions.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_generator.GeneratorOptions.html index b17dee5b5a..f39cc4f83a 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_generator.GeneratorOptions.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_generator.GeneratorOptions.html @@ -1,46 +1,46 @@ -GeneratorOptions | SAP Cloud SDK for JavaScript - v3.12.1

Options to configure OData client generation when using the generator programmatically.

-
interface GeneratorOptions {
    clearOutputDir?: boolean;
    include?: string;
    input: string;
    metadata?: boolean;
    optionsPerService?: string;
    outputDir: string;
    overwrite?: boolean;
    packageJson?: boolean;
    prettierConfig?: string;
    readme?: boolean;
    skipValidation?: boolean;
    transpilationProcesses?: number;
    transpile?: boolean;
    tsconfig?: string;
    useSwagger?: boolean;
    verbose?: boolean;
}

Hierarchy (view full)

Properties

clearOutputDir?: boolean

Delete EVERYTHING in the specified output directory before generating code.

-
include?: string

Include files matching the given glob into the root of each generated client directory.

-
input: string

Specify the path to the directory or file containing the service definition(s) to generate clients for. +GeneratorOptions | SAP Cloud SDK for JavaScript - v3.12.0

Options to configure OData client generation when using the generator programmatically.

+
interface GeneratorOptions {
    clearOutputDir?: boolean;
    include?: string;
    input: string;
    metadata?: boolean;
    optionsPerService?: string;
    outputDir: string;
    overwrite?: boolean;
    packageJson?: boolean;
    prettierConfig?: string;
    readme?: boolean;
    skipValidation?: boolean;
    transpilationProcesses?: number;
    transpile?: boolean;
    tsconfig?: string;
    useSwagger?: boolean;
    verbose?: boolean;
}

Hierarchy (view full)

Properties

clearOutputDir?: boolean

Delete EVERYTHING in the specified output directory before generating code.

+
include?: string

Include files matching the given glob into the root of each generated client directory.

+
input: string

Specify the path to the directory or file containing the service definition(s) to generate clients for. Throws an error if the path does not exist.

-
metadata?: boolean

Hidden option only for internal usage - generate metadata for API hub integration.

-
optionsPerService?: string

Configuration file to ensure consistent names between multiple generation runs with updated / changed metadata files. +

metadata?: boolean

Hidden option only for internal usage - generate metadata for API hub integration.

+
optionsPerService?: string

Configuration file to ensure consistent names between multiple generation runs with updated / changed metadata files. The configuration allows to set a directoryName and npmPackageName for every service, identified by the path to the original file. It also makes sure that names do not change between generator runs. If a directory is passed, a options-per-service.json file is read/created in this directory.

-
outputDir: string

Directory to save the generated code in.

-
overwrite?: boolean

Exit when encountering a file that already exists. +

outputDir: string

Directory to save the generated code in.

+
overwrite?: boolean

Exit when encountering a file that already exists. When set to true, it will be overwritten instead. Note, that compared to the clearOutputDir option, this will not delete outdated files.

-
packageJson?: boolean

Generate a package.json file, specifying dependencies and scripts for compiling.

-
prettierConfig?: string

Specify the path to the prettier config. If not given a default config will be used for the generated sources.

-
readme?: boolean

Generate default README.md files in the client directories.

-
skipValidation?: boolean

Generation will stop if objects need renaming due to non-unique conditions or conflicts to JavaScript keywords. +

packageJson?: boolean

Generate a package.json file, specifying dependencies and scripts for compiling.

+
prettierConfig?: string

Specify the path to the prettier config. If not given a default config will be used for the generated sources.

+
readme?: boolean

Generate default README.md files in the client directories.

+
skipValidation?: boolean

Generation will stop if objects need renaming due to non-unique conditions or conflicts to JavaScript keywords. If you enable this option, conflicts are resolved by appending postfixes like '_1".

-
transpilationProcesses?: number

Number of node processes used for transpilation of JavaScript files.

-
transpile?: boolean

When enabled, generates transpiled .js, .js.map, and .d.ts files. +

transpilationProcesses?: number

Number of node processes used for transpilation of JavaScript files.

+
transpile?: boolean

When enabled, generates transpiled .js, .js.map, and .d.ts files. By default, only .ts files are generated.

-
tsconfig?: string

Replace the default tsconfig.json by passing a path to a custom configuration. +

tsconfig?: string

Replace the default tsconfig.json by passing a path to a custom configuration. By default, a tsconfig.json is only generated when transpilation is enabled (transpile). If a directory is passed, a tsconfig.json file is read from this directory.

-
useSwagger?: boolean

If set to true, swagger definitions (JSON) are used for generation.

-
verbose?: boolean

By default, only errors, warnings and important info logs will be displayed. +

useSwagger?: boolean

If set to true, swagger definitions (JSON) are used for generation.

+
verbose?: boolean

By default, only errors, warnings and important info logs will be displayed. If set to true, all logs will be displayed.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_generator_common.CommonGeneratorOptions.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_generator_common.CommonGeneratorOptions.html index 111baa9b35..1bda5fd3ce 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_generator_common.CommonGeneratorOptions.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_generator_common.CommonGeneratorOptions.html @@ -1,42 +1,42 @@ -CommonGeneratorOptions | SAP Cloud SDK for JavaScript - v3.12.1

Generator options shared by the OData and OpenApi generator.

-
interface CommonGeneratorOptions {
    clearOutputDir?: boolean;
    include?: string;
    input: string;
    metadata?: boolean;
    optionsPerService?: string;
    outputDir: string;
    overwrite?: boolean;
    packageJson?: boolean;
    prettierConfig?: string;
    readme?: boolean;
    skipValidation?: boolean;
    transpile?: boolean;
    tsconfig?: string;
    verbose?: boolean;
}

Hierarchy (view full)

Properties

clearOutputDir?: boolean

Delete EVERYTHING in the specified output directory before generating code.

-
include?: string

Include files matching the given glob into the root of each generated client directory.

-
input: string

Specify the path to the directory or file containing the service definition(s) to generate clients for. +CommonGeneratorOptions | SAP Cloud SDK for JavaScript - v3.12.0

Generator options shared by the OData and OpenApi generator.

+
interface CommonGeneratorOptions {
    clearOutputDir?: boolean;
    include?: string;
    input: string;
    metadata?: boolean;
    optionsPerService?: string;
    outputDir: string;
    overwrite?: boolean;
    packageJson?: boolean;
    prettierConfig?: string;
    readme?: boolean;
    skipValidation?: boolean;
    transpile?: boolean;
    tsconfig?: string;
    verbose?: boolean;
}

Hierarchy (view full)

Properties

clearOutputDir?: boolean

Delete EVERYTHING in the specified output directory before generating code.

+
include?: string

Include files matching the given glob into the root of each generated client directory.

+
input: string

Specify the path to the directory or file containing the service definition(s) to generate clients for. Throws an error if the path does not exist.

-
metadata?: boolean

Hidden option only for internal usage - generate metadata for API hub integration.

-
optionsPerService?: string

Configuration file to ensure consistent names between multiple generation runs with updated / changed metadata files. +

metadata?: boolean

Hidden option only for internal usage - generate metadata for API hub integration.

+
optionsPerService?: string

Configuration file to ensure consistent names between multiple generation runs with updated / changed metadata files. The configuration allows to set a directoryName and npmPackageName for every service, identified by the path to the original file. It also makes sure that names do not change between generator runs. If a directory is passed, a options-per-service.json file is read/created in this directory.

-
outputDir: string

Directory to save the generated code in.

-
overwrite?: boolean

Exit when encountering a file that already exists. +

outputDir: string

Directory to save the generated code in.

+
overwrite?: boolean

Exit when encountering a file that already exists. When set to true, it will be overwritten instead. Note, that compared to the clearOutputDir option, this will not delete outdated files.

-
packageJson?: boolean

Generate a package.json file, specifying dependencies and scripts for compiling.

-
prettierConfig?: string

Specify the path to the prettier config. If not given a default config will be used for the generated sources.

-
readme?: boolean

Generate default README.md files in the client directories.

-
skipValidation?: boolean

Generation will stop if objects need renaming due to non-unique conditions or conflicts to JavaScript keywords. +

packageJson?: boolean

Generate a package.json file, specifying dependencies and scripts for compiling.

+
prettierConfig?: string

Specify the path to the prettier config. If not given a default config will be used for the generated sources.

+
readme?: boolean

Generate default README.md files in the client directories.

+
skipValidation?: boolean

Generation will stop if objects need renaming due to non-unique conditions or conflicts to JavaScript keywords. If you enable this option, conflicts are resolved by appending postfixes like '_1".

-
transpile?: boolean

When enabled, generates transpiled .js, .js.map, and .d.ts files. +

transpile?: boolean

When enabled, generates transpiled .js, .js.map, and .d.ts files. By default, only .ts files are generated.

-
tsconfig?: string

Replace the default tsconfig.json by passing a path to a custom configuration. +

tsconfig?: string

Replace the default tsconfig.json by passing a path to a custom configuration. By default, a tsconfig.json is only generated when transpilation is enabled (transpile). If a directory is passed, a tsconfig.json file is read from this directory.

-
verbose?: boolean

By default, only errors, warnings and important info logs will be displayed. +

verbose?: boolean

By default, only errors, warnings and important info logs will be displayed. If set to true, all logs will be displayed.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_http_client.CsrfMiddlewareOptions.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_http_client.CsrfMiddlewareOptions.html index 56be2a96ff..d67e72bb5f 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_http_client.CsrfMiddlewareOptions.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_http_client.CsrfMiddlewareOptions.html @@ -1,9 +1,9 @@ -CsrfMiddlewareOptions | SAP Cloud SDK for JavaScript - v3.12.1

Options for middleware to fetch CSRF tokens.

-
interface CsrfMiddlewareOptions {
    method?: Method;
    middleware?: HttpMiddleware[];
    url?: string;
}

Properties

Properties

method?: Method

Method used for the token fetching. Default is head.

-
middleware?: HttpMiddleware[]

Middlewares added to the token retrieval request.

-
url?: string

URL used for the token fetching. Default is the resource path without parameters.

+CsrfMiddlewareOptions | SAP Cloud SDK for JavaScript - v3.12.0

Options for middleware to fetch CSRF tokens.

+
interface CsrfMiddlewareOptions {
    method?: Method;
    middleware?: HttpMiddleware[];
    url?: string;
}

Properties

Properties

method?: Method

Method used for the token fetching. Default is head.

+
middleware?: HttpMiddleware[]

Middlewares added to the token retrieval request.

+
url?: string

URL used for the token fetching. Default is the resource path without parameters.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_http_client.DestinationHttpRequestConfig.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_http_client.DestinationHttpRequestConfig.html index 4bc75bb015..57cdd5d001 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_http_client.DestinationHttpRequestConfig.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_http_client.DestinationHttpRequestConfig.html @@ -1,15 +1,15 @@ -DestinationHttpRequestConfig | SAP Cloud SDK for JavaScript - v3.12.1

Represents the request configuration, that was inferred from a destination.

-
interface DestinationHttpRequestConfig {
    baseURL: string;
    headers: Record<string, string>;
    httpAgent?: Agent;
    httpsAgent?: Agent;
    params?: Record<string, string>;
    proxy?: false | BasicProxyConfiguration;
}

Properties

baseURL: string

Will be prepended to HttpRequestConfigBase#url unless url is absolute.

-
headers: Record<string, string>

Additional headers to be sent.

-
httpAgent?: Agent

Agent to be used when performing HTTP requests.

-
httpsAgent?: Agent

Agent to be used when performing HTTPS requests.

-
params?: Record<string, string>

URL parameters to be sent with the request.

-
proxy?: false | BasicProxyConfiguration

Proxy configuration, when going through a proxy like the SAP Cloud Connector.

+DestinationHttpRequestConfig | SAP Cloud SDK for JavaScript - v3.12.0

Represents the request configuration, that was inferred from a destination.

+
interface DestinationHttpRequestConfig {
    baseURL: string;
    headers: Record<string, string>;
    httpAgent?: Agent;
    httpsAgent?: Agent;
    params?: Record<string, string>;
    proxy?: false | BasicProxyConfiguration;
}

Properties

baseURL: string

Will be prepended to HttpRequestConfigBase#url unless url is absolute.

+
headers: Record<string, string>

Additional headers to be sent.

+
httpAgent?: Agent

Agent to be used when performing HTTP requests.

+
httpsAgent?: Agent

Agent to be used when performing HTTPS requests.

+
params?: Record<string, string>

URL parameters to be sent with the request.

+
proxy?: false | BasicProxyConfiguration

Proxy configuration, when going through a proxy like the SAP Cloud Connector.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_http_client.HttpMiddlewareContext.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_http_client.HttpMiddlewareContext.html index b0e51326bf..052a91fa08 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_http_client.HttpMiddlewareContext.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_http_client.HttpMiddlewareContext.html @@ -1,11 +1,11 @@ -HttpMiddlewareContext | SAP Cloud SDK for JavaScript - v3.12.1

Context for HttpRequests of the middleware.

-
interface HttpMiddlewareContext {
    destinationName?: string;
    jwt?: string;
    tenantId: undefined | string;
    uri: string;
}

Hierarchy (view full)

Properties

destinationName?: string

Destination name used in the request.

-
jwt?: string

JWT used in the request.

-
tenantId: undefined | string

Tenant identifier.

-
uri: string

URI of the function passed to the middleware.

+HttpMiddlewareContext | SAP Cloud SDK for JavaScript - v3.12.0

Context for HttpRequests of the middleware.

+
interface HttpMiddlewareContext {
    destinationName?: string;
    jwt?: string;
    tenantId: undefined | string;
    uri: string;
}

Hierarchy (view full)

Properties

destinationName?: string

Destination name used in the request.

+
jwt?: string

JWT used in the request.

+
tenantId: undefined | string

Tenant identifier.

+
uri: string

URI of the function passed to the middleware.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_http_client.HttpRequestConfigBase.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_http_client.HttpRequestConfigBase.html index 3ebe3ea0c9..ade7c6f745 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_http_client.HttpRequestConfigBase.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_http_client.HttpRequestConfigBase.html @@ -1,24 +1,24 @@ -HttpRequestConfigBase | SAP Cloud SDK for JavaScript - v3.12.1

Represents an HTTP request config. This is the basis for actual request configurations and request configurations with origins.

-
interface HttpRequestConfigBase {
    data?: any;
    httpAgent?: any;
    httpsAgent?: any;
    maxContentLength?: number;
    method: Method;
    middleware?: HttpMiddleware[];
    parameterEncoder?: ParameterEncoder;
    proxy?: false;
    url?: string;
    [key: string]: any;
}

Indexable

[key: string]: any

Properties

data?: any

Data sent in the request body.

-
httpAgent?: any

The custom agent used when performing http requests.

-
httpsAgent?: any

The custom agent used when performing https requests.

-
maxContentLength?: number

The max size of the http response content in bytes.

-
method: Method

The request method used when making the request.

-
middleware?: HttpMiddleware[]

Middleware @sap-cloud-sdk/resilience!Middleware to be applied to the request. +HttpRequestConfigBase | SAP Cloud SDK for JavaScript - v3.12.0

Represents an HTTP request config. This is the basis for actual request configurations and request configurations with origins.

+
interface HttpRequestConfigBase {
    data?: any;
    httpAgent?: any;
    httpsAgent?: any;
    maxContentLength?: number;
    method: Method;
    middleware?: HttpMiddleware[];
    parameterEncoder?: ParameterEncoder;
    proxy?: false;
    url?: string;
    [key: string]: any;
}

Indexable

[key: string]: any

Properties

data?: any

Data sent in the request body.

+
httpAgent?: any

The custom agent used when performing http requests.

+
httpsAgent?: any

The custom agent used when performing https requests.

+
maxContentLength?: number

The max size of the http response content in bytes.

+
method: Method

The request method used when making the request.

+
middleware?: HttpMiddleware[]

Middleware @sap-cloud-sdk/resilience!Middleware to be applied to the request. The request context is set using @sap-cloud-sdk/http-client!HttpMiddlewareContext.

-
parameterEncoder?: ParameterEncoder

Encoder for the query parameters key and values. Per default parameters and keys are percent encoded.

-
proxy?: false

Set this to false to disable the proxy. +

parameterEncoder?: ParameterEncoder

Encoder for the query parameters key and values. Per default parameters and keys are percent encoded.

+
proxy?: false

Set this to false to disable the proxy. To configure the proxy you can add a @sap-cloud-sdk/connectivity!ProxyConfiguration to your destination.

-
url?: string

Server URL that will be used for the request. +

url?: string

Server URL that will be used for the request. Relative url can be used together with DestinationHttpRequestConfig#baseURL.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_http_client.HttpRequestOptions.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_http_client.HttpRequestOptions.html index d3036a6a17..1d66aa9a0d 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_http_client.HttpRequestOptions.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_http_client.HttpRequestOptions.html @@ -1,8 +1,8 @@ -HttpRequestOptions | SAP Cloud SDK for JavaScript - v3.12.1

Options to configure the behavior when sending HTTP requests. +HttpRequestOptions | SAP Cloud SDK for JavaScript - v3.12.0

Options to configure the behavior when sending HTTP requests. For example, whether the CSRF token is fetched automatically.

-
interface HttpRequestOptions {
    fetchCsrfToken?: boolean;
}

Properties

Properties

fetchCsrfToken?: boolean

A boolean value that indicates whether to fetch the csrf token for a non-get request. +

interface HttpRequestOptions {
    fetchCsrfToken?: boolean;
}

Properties

Properties

fetchCsrfToken?: boolean

A boolean value that indicates whether to fetch the csrf token for a non-get request. For a get request, the csrf token is not fetched and this option is ignored. By default, the value is true.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_http_client.HttpResponse.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_http_client.HttpResponse.html index 8aa2180c47..5a62965287 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_http_client.HttpResponse.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_http_client.HttpResponse.html @@ -1,8 +1,8 @@ -HttpResponse | SAP Cloud SDK for JavaScript - v3.12.1

Represents an HTTP response, that contains response code, headers, payload and the original request. +HttpResponse | SAP Cloud SDK for JavaScript - v3.12.0

Represents an HTTP response, that contains response code, headers, payload and the original request. This interface is compatible with AxiosResponse.

-
interface HttpResponse {
    data: any;
    headers: any;
    request: any;
    status: number;
    [otherKey: string]: any;
}

Hierarchy

  • KnownHttpResponseFields
    • HttpResponse

Indexable

[otherKey: string]: any

Properties

interface HttpResponse {
    data: any;
    headers: any;
    request: any;
    status: number;
    [otherKey: string]: any;
}

Hierarchy

  • KnownHttpResponseFields
    • HttpResponse

Indexable

[otherKey: string]: any

Properties

data +headers +request +status

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-

Properties

data: any
headers: any
request: any
status: number
\ No newline at end of file +

Properties

data: any
headers: any
request: any
status: number
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_http_client.OriginOptions.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_http_client.OriginOptions.html index b3006bf90b..92425a072b 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_http_client.OriginOptions.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_http_client.OriginOptions.html @@ -1,8 +1,8 @@ -OriginOptions | SAP Cloud SDK for JavaScript - v3.12.1

This interface is used for defining e.g., headers and query parameters with origin information. +OriginOptions | SAP Cloud SDK for JavaScript - v3.12.0

This interface is used for defining e.g., headers and query parameters with origin information. Options defined in custom take precedence over requestConfig.

-
interface OriginOptions {
    custom?: Record<string, any>;
    requestConfig?: Record<string, any>;
}

Properties

Properties

custom?: Record<string, any>

Header or parameters properties set explicitly, which take precedence over requestConfig.

-
requestConfig?: Record<string, any>

Header or parameter properties originating from the request config.

+
interface OriginOptions {
    custom?: Record<string, any>;
    requestConfig?: Record<string, any>;
}

Properties

Properties

custom?: Record<string, any>

Header or parameters properties set explicitly, which take precedence over requestConfig.

+
requestConfig?: Record<string, any>

Header or parameter properties originating from the request config.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_mail_client.Address.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_mail_client.Address.html index 02a1aee377..ce65a1ac31 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_mail_client.Address.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_mail_client.Address.html @@ -1,8 +1,8 @@ -Address | SAP Cloud SDK for JavaScript - v3.12.1

Represents an e-mail address. +Address | SAP Cloud SDK for JavaScript - v3.12.0

Represents an e-mail address. This interface is compatible with Mail.Address of nodemailer.

-
interface Address {
    address: string;
    name: string;
}

Properties

Properties

address: string

E-mail address of the recipient, e.g. sender@server.com.

-
name: string

Name of the recipient.

+
interface Address {
    address: string;
    name: string;
}

Properties

Properties

address: string

E-mail address of the recipient, e.g. sender@server.com.

+
name: string

Name of the recipient.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_mail_client.Attachment.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_mail_client.Attachment.html index b3afd29076..f7827533ff 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_mail_client.Attachment.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_mail_client.Attachment.html @@ -1,24 +1,24 @@ -Attachment | SAP Cloud SDK for JavaScript - v3.12.1

Represents an attachment. +Attachment | SAP Cloud SDK for JavaScript - v3.12.0

Represents an attachment. This interface is compatible with Attachment of nodemailer.

-
interface Attachment {
    cid?: string;
    content?: string | Readable | Buffer;
    contentDisposition?: "attachment" | "inline";
    contentTransferEncoding?: false | "base64" | "7bit" | "quoted-printable";
    contentType?: string;
    encoding?: string;
    filename?: string | false;
    headers?: Headers;
    path?: string | Url;
    raw?: string | Readable | Buffer | AttachmentLike;
}

Hierarchy (view full)

Properties

cid?: string

Optional content id for using inline images in HTML message source. Using cid sets the default contentDisposition to 'inline' and moves the attachment into a multipart/related MIME node, so use it only if you actually want to use this attachment as an embedded image.

-
content?: string | Readable | Buffer

Contents of the attachment stored in a string, buffer or stream.

-
contentDisposition?: "attachment" | "inline"

Content disposition type of the attachment. Defaults to attachment.

-
contentTransferEncoding?: false | "base64" | "7bit" | "quoted-printable"

Encoding for the attachment transfer. Will be derived from the contentType property, if not set. Example values: quoted-printable, base64. If it is unset then base64 encoding is used for the attachment. If set to false, the previous default applies (base64 for most, 7bit for text).

-
contentType?: string

Content type of the attachment. Will be derived from the filename property, if not set.

-
encoding?: string

Encoding used to encode the content to a buffer. Example values: base64, hex, binary etc. Useful if you want to use binary attachments in a JSON formatted e-mail object.

-
filename?: string | false

Filename to be reported as the name of the attached file, use of unicode is allowed. If you do not want to use a filename, set this value to false, otherwise a filename is generated automatically.

-
headers?: Headers

Additional headers to be sent with the attachment.

-
path?: string | Url

File path or URL (data URIs are allowed as well) if you want to read a file instead of including it (better for larger attachments).

-
raw?: string | Readable | Buffer | AttachmentLike

A raw value that overrides entire node content in the MIME message. If used, all other options set for this node are ignored.

+
interface Attachment {
    cid?: string;
    content?: string | Readable | Buffer;
    contentDisposition?: "attachment" | "inline";
    contentTransferEncoding?: false | "base64" | "7bit" | "quoted-printable";
    contentType?: string;
    encoding?: string;
    filename?: string | false;
    headers?: Headers;
    path?: string | Url;
    raw?: string | Readable | Buffer | AttachmentLike;
}

Hierarchy (view full)

Properties

cid?: string

Optional content id for using inline images in HTML message source. Using cid sets the default contentDisposition to 'inline' and moves the attachment into a multipart/related MIME node, so use it only if you actually want to use this attachment as an embedded image.

+
content?: string | Readable | Buffer

Contents of the attachment stored in a string, buffer or stream.

+
contentDisposition?: "attachment" | "inline"

Content disposition type of the attachment. Defaults to attachment.

+
contentTransferEncoding?: false | "base64" | "7bit" | "quoted-printable"

Encoding for the attachment transfer. Will be derived from the contentType property, if not set. Example values: quoted-printable, base64. If it is unset then base64 encoding is used for the attachment. If set to false, the previous default applies (base64 for most, 7bit for text).

+
contentType?: string

Content type of the attachment. Will be derived from the filename property, if not set.

+
encoding?: string

Encoding used to encode the content to a buffer. Example values: base64, hex, binary etc. Useful if you want to use binary attachments in a JSON formatted e-mail object.

+
filename?: string | false

Filename to be reported as the name of the attached file, use of unicode is allowed. If you do not want to use a filename, set this value to false, otherwise a filename is generated automatically.

+
headers?: Headers

Additional headers to be sent with the attachment.

+
path?: string | Url

File path or URL (data URIs are allowed as well) if you want to read a file instead of including it (better for larger attachments).

+
raw?: string | Readable | Buffer | AttachmentLike

A raw value that overrides entire node content in the MIME message. If used, all other options set for this node are ignored.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_mail_client.AttachmentLike.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_mail_client.AttachmentLike.html index a723dfd397..d72f75614f 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_mail_client.AttachmentLike.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_mail_client.AttachmentLike.html @@ -1,8 +1,8 @@ -AttachmentLike | SAP Cloud SDK for JavaScript - v3.12.1

Represents the structure of an attachment. +AttachmentLike | SAP Cloud SDK for JavaScript - v3.12.0

Represents the structure of an attachment. This interface is compatible with AttachmentLike of nodemailer.

-
interface AttachmentLike {
    content?: string | Readable | Buffer;
    path?: string | Url;
}

Hierarchy (view full)

Properties

Properties

content?: string | Readable | Buffer

Contents of the attachment stored in a string, buffer or stream.

-
path?: string | Url

File path or URL (data URIs are allowed as well) if you want to read a file instead of including it (better for larger attachments).

+
interface AttachmentLike {
    content?: string | Readable | Buffer;
    path?: string | Url;
}

Hierarchy (view full)

Properties

Properties

content?: string | Readable | Buffer

Contents of the attachment stored in a string, buffer or stream.

+
path?: string | Url

File path or URL (data URIs are allowed as well) if you want to read a file instead of including it (better for larger attachments).

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_mail_client.Envelope.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_mail_client.Envelope.html index 09335011c9..7b13ff8531 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_mail_client.Envelope.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_mail_client.Envelope.html @@ -1,8 +1,8 @@ -Envelope | SAP Cloud SDK for JavaScript - v3.12.1

Represents an envelope that contains the e-mail addresses of the sender and the recipients. +Envelope | SAP Cloud SDK for JavaScript - v3.12.0

Represents an envelope that contains the e-mail addresses of the sender and the recipients. This interface is compatible with MimeNode.Envelope of nodemailer.

-
interface Envelope {
    from: string | false;
    to: string[];
}

Properties

from -to -

Properties

from: string | false

E-mail address of the sender or false if it should not be shown.

-
to: string[]

Array of e-mail addresses of recipients.

+
interface Envelope {
    from: string | false;
    to: string[];
}

Properties

from +to +

Properties

from: string | false

E-mail address of the sender or false if it should not be shown.

+
to: string[]

Array of e-mail addresses of recipients.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_mail_client.MailClientOptions.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_mail_client.MailClientOptions.html index bb212e9a03..8caa648801 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_mail_client.MailClientOptions.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_mail_client.MailClientOptions.html @@ -1,33 +1,33 @@ -MailClientOptions | SAP Cloud SDK for JavaScript - v3.12.1

Represents options of the mail client.

-
interface MailClientOptions {
    connection?: Socket;
    connectionTimeout?: number;
    debug?: boolean;
    greetingTimeout?: number;
    ignoreTLS?: boolean;
    logger?: boolean;
    opportunisticTLS?: boolean;
    proxy?: string;
    requireTLS?: boolean;
    sdkOptions?: SDKOptions;
    secure?: boolean;
    socket?: Socket;
    socketTimeout?: number;
    tls?: ConnectionOptions;
}

Hierarchy (view full)

Properties

connection?: Socket

Connected socket to use instead of creating and connecting a new one. If secure option is true, then socket is upgraded from plain text to cipher text.

-
connectionTimeout?: number

How many milliseconds to wait for the connection to establish.

-
debug?: boolean

If set to true, then logs SMTP traffic and message content, otherwise logs only transaction events.

-
greetingTimeout?: number

How many milliseconds to wait for the greeting after connection is established.

-
ignoreTLS?: boolean

Turns off STARTTLS support if true.

-
logger?: boolean

If set to true then logs to console. If value is not set or is false then nothing is logged.

-
opportunisticTLS?: boolean

Tries to use STARTTLS and continues normally if it fails.

-
proxy?: string

A proxy URL used for connecting the SMTP server. This value will be forwarded to the underlying nodemailer lib, so it handles the proxy job for the SDK.

-
requireTLS?: boolean

Forces the client to use STARTTLS. Returns an error if upgrading the connection is not possible or fails.

-
sdkOptions?: SDKOptions

Defines whether mails are sent in parallel.

-
secure?: boolean

Defines if the connection should use SSL (if true) or not (if false).

-
socket?: Socket

Initialized socket to use instead of creating a new one.

-
socketTimeout?: number

How many milliseconds of inactivity to allow.

-
tls?: ConnectionOptions

Defines additional options to be passed to the socket constructor.

+MailClientOptions | SAP Cloud SDK for JavaScript - v3.12.0

Represents options of the mail client.

+
interface MailClientOptions {
    connection?: Socket;
    connectionTimeout?: number;
    debug?: boolean;
    greetingTimeout?: number;
    ignoreTLS?: boolean;
    logger?: boolean;
    opportunisticTLS?: boolean;
    proxy?: string;
    requireTLS?: boolean;
    sdkOptions?: SDKOptions;
    secure?: boolean;
    socket?: Socket;
    socketTimeout?: number;
    tls?: ConnectionOptions;
}

Hierarchy (view full)

Properties

connection?: Socket

Connected socket to use instead of creating and connecting a new one. If secure option is true, then socket is upgraded from plain text to cipher text.

+
connectionTimeout?: number

How many milliseconds to wait for the connection to establish.

+
debug?: boolean

If set to true, then logs SMTP traffic and message content, otherwise logs only transaction events.

+
greetingTimeout?: number

How many milliseconds to wait for the greeting after connection is established.

+
ignoreTLS?: boolean

Turns off STARTTLS support if true.

+
logger?: boolean

If set to true then logs to console. If value is not set or is false then nothing is logged.

+
opportunisticTLS?: boolean

Tries to use STARTTLS and continues normally if it fails.

+
proxy?: string

A proxy URL used for connecting the SMTP server. This value will be forwarded to the underlying nodemailer lib, so it handles the proxy job for the SDK.

+
requireTLS?: boolean

Forces the client to use STARTTLS. Returns an error if upgrading the connection is not possible or fails.

+
sdkOptions?: SDKOptions

Defines whether mails are sent in parallel.

+
secure?: boolean

Defines if the connection should use SSL (if true) or not (if false).

+
socket?: Socket

Initialized socket to use instead of creating a new one.

+
socketTimeout?: number

How many milliseconds of inactivity to allow.

+
tls?: ConnectionOptions

Defines additional options to be passed to the socket constructor.

Example

{ rejectUnauthorized: `true` }
 

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_mail_client.MailConfig.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_mail_client.MailConfig.html index dc0b14b2ed..f482f64a9f 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_mail_client.MailConfig.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_mail_client.MailConfig.html @@ -1,32 +1,32 @@ -MailConfig | SAP Cloud SDK for JavaScript - v3.12.1

Represents configurations for sending an e-mail. +MailConfig | SAP Cloud SDK for JavaScript - v3.12.0

Represents configurations for sending an e-mail. This interface is compatible with Mail.Options of nodemailer.

-
interface MailConfig {
    attachments?: Attachment[];
    bcc?: string | Address | (string | Address)[];
    cc?: string | Address | (string | Address)[];
    date?: string | Date;
    encoding?: string;
    from?: string | Address;
    headers?: Headers;
    html?: string | Readable | Buffer | AttachmentLike;
    priority?: "high" | "normal" | "low";
    replyTo?: string | Address;
    sender?: string | Address;
    subject?: string;
    text?: string | Readable | Buffer | AttachmentLike;
    to?: string | Address | (string | Address)[];
}

Properties

attachments?: Attachment[]

Array of attachment objects.

-
bcc?: string | Address | (string | Address)[]

Comma separated list or array of recipients e-mail addresses that will appear in the "Bcc:" field.

-
cc?: string | Address | (string | Address)[]

Comma separated list or array of recipients' e-mail addresses that will appear in the "Cc:" field.

-
date?: string | Date

Date value, current UTC string will be used if not set.

-
encoding?: string

Transfer encoding for the textual parts.

-
from?: string | Address

The e-mail address of the sender. E-mail addresses can be plain 'sender@server.com' or formatted 'Sender Name sender@server.com'.

-
headers?: Headers

Object or array with additional headers.

-
html?: string | Readable | Buffer | AttachmentLike

The HTML version of the message.

-
priority?: "high" | "normal" | "low"

Priority of the e-mail.

-
replyTo?: string | Address

E-mail address that will appear in the "Reply-To:" field.

-
sender?: string | Address

E-mail address that will appear in the "Sender:" field.

-
subject?: string

Subject of the e-mail.

-
text?: string | Readable | Buffer | AttachmentLike

Plaintext version of the message.

-
to?: string | Address | (string | Address)[]

Comma separated list or array of recipients' e-mail addresses that will appear in the "To:" field.

+
interface MailConfig {
    attachments?: Attachment[];
    bcc?: string | Address | (string | Address)[];
    cc?: string | Address | (string | Address)[];
    date?: string | Date;
    encoding?: string;
    from?: string | Address;
    headers?: Headers;
    html?: string | Readable | Buffer | AttachmentLike;
    priority?: "high" | "normal" | "low";
    replyTo?: string | Address;
    sender?: string | Address;
    subject?: string;
    text?: string | Readable | Buffer | AttachmentLike;
    to?: string | Address | (string | Address)[];
}

Properties

attachments?: Attachment[]

Array of attachment objects.

+
bcc?: string | Address | (string | Address)[]

Comma separated list or array of recipients e-mail addresses that will appear in the "Bcc:" field.

+
cc?: string | Address | (string | Address)[]

Comma separated list or array of recipients' e-mail addresses that will appear in the "Cc:" field.

+
date?: string | Date

Date value, current UTC string will be used if not set.

+
encoding?: string

Transfer encoding for the textual parts.

+
from?: string | Address

The e-mail address of the sender. E-mail addresses can be plain 'sender@server.com' or formatted 'Sender Name sender@server.com'.

+
headers?: Headers

Object or array with additional headers.

+
html?: string | Readable | Buffer | AttachmentLike

The HTML version of the message.

+
priority?: "high" | "normal" | "low"

Priority of the e-mail.

+
replyTo?: string | Address

E-mail address that will appear in the "Reply-To:" field.

+
sender?: string | Address

E-mail address that will appear in the "Sender:" field.

+
subject?: string

Subject of the e-mail.

+
text?: string | Readable | Buffer | AttachmentLike

Plaintext version of the message.

+
to?: string | Address | (string | Address)[]

Comma separated list or array of recipients' e-mail addresses that will appear in the "To:" field.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_mail_client.MailResponse.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_mail_client.MailResponse.html index 9c68f56a06..7210a09331 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_mail_client.MailResponse.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_mail_client.MailResponse.html @@ -1,14 +1,14 @@ -MailResponse | SAP Cloud SDK for JavaScript - v3.12.1

Represents the response from the mail server. +MailResponse | SAP Cloud SDK for JavaScript - v3.12.0

Represents the response from the mail server. This interface is compatible with SMTPTransport.SentMessageInfo of nodemailer.

-
interface MailResponse {
    accepted?: (string | Address)[];
    envelope?: Envelope;
    pending?: (string | Address)[];
    rejected?: (string | Address)[];
    response?: string;
}

Properties

accepted?: (string | Address)[]

Array of e-mail addresses that accepted the requests.

-
envelope?: Envelope

Envelope that contains the sender and recipients info.

-
pending?: (string | Address)[]

Array of e-mail addresses that are processing the requests.

-
rejected?: (string | Address)[]

Array of e-mail addresses that rejected the requests.

-
response?: string

Other response message from the mail server.

+
interface MailResponse {
    accepted?: (string | Address)[];
    envelope?: Envelope;
    pending?: (string | Address)[];
    rejected?: (string | Address)[];
    response?: string;
}

Properties

accepted?: (string | Address)[]

Array of e-mail addresses that accepted the requests.

+
envelope?: Envelope

Envelope that contains the sender and recipients info.

+
pending?: (string | Address)[]

Array of e-mail addresses that are processing the requests.

+
rejected?: (string | Address)[]

Array of e-mail addresses that rejected the requests.

+
response?: string

Other response message from the mail server.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_mail_client.SDKOptions.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_mail_client.SDKOptions.html index 39a3f645e4..3927f9ed6f 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_mail_client.SDKOptions.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_mail_client.SDKOptions.html @@ -1,5 +1,5 @@ -SDKOptions | SAP Cloud SDK for JavaScript - v3.12.1

Represents options for sending mails provided by the SDK. For example whether the mails are sent in parallel.

-
interface SDKOptions {
    parallel?: boolean;
}

Properties

Properties

parallel?: boolean

Option to define the strategy of sending emails. The emails will be sent in parallel when set to true, otherwise in sequential. The default value is true.

+SDKOptions | SAP Cloud SDK for JavaScript - v3.12.0

Represents options for sending mails provided by the SDK. For example whether the mails are sent in parallel.

+
interface SDKOptions {
    parallel?: boolean;
}

Properties

Properties

parallel?: boolean

Option to define the strategy of sending emails. The emails will be sent in parallel when set to true, otherwise in sequential. The default value is true.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_mail_client.SmtpTransportOptions.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_mail_client.SmtpTransportOptions.html index 8765fdd873..d9fee3d08b 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_mail_client.SmtpTransportOptions.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_mail_client.SmtpTransportOptions.html @@ -1,32 +1,32 @@ -SmtpTransportOptions | SAP Cloud SDK for JavaScript - v3.12.1

Represents options for setting up the SMTP connection. +SmtpTransportOptions | SAP Cloud SDK for JavaScript - v3.12.0

Represents options for setting up the SMTP connection. This interface is compatible with SMTPConnection.Options of nodemailer.

-
interface SmtpTransportOptions {
    connection?: Socket;
    connectionTimeout?: number;
    debug?: boolean;
    greetingTimeout?: number;
    ignoreTLS?: boolean;
    logger?: boolean;
    opportunisticTLS?: boolean;
    proxy?: string;
    requireTLS?: boolean;
    secure?: boolean;
    socket?: Socket;
    socketTimeout?: number;
    tls?: ConnectionOptions;
}

Hierarchy (view full)

Properties

connection?: Socket

Connected socket to use instead of creating and connecting a new one. If secure option is true, then socket is upgraded from plain text to cipher text.

-
connectionTimeout?: number

How many milliseconds to wait for the connection to establish.

-
debug?: boolean

If set to true, then logs SMTP traffic and message content, otherwise logs only transaction events.

-
greetingTimeout?: number

How many milliseconds to wait for the greeting after connection is established.

-
ignoreTLS?: boolean

Turns off STARTTLS support if true.

-
logger?: boolean

If set to true then logs to console. If value is not set or is false then nothing is logged.

-
opportunisticTLS?: boolean

Tries to use STARTTLS and continues normally if it fails.

-
proxy?: string

A proxy URL used for connecting the SMTP server. This value will be forwarded to the underlying nodemailer lib, so it handles the proxy job for the SDK.

-
requireTLS?: boolean

Forces the client to use STARTTLS. Returns an error if upgrading the connection is not possible or fails.

-
secure?: boolean

Defines if the connection should use SSL (if true) or not (if false).

-
socket?: Socket

Initialized socket to use instead of creating a new one.

-
socketTimeout?: number

How many milliseconds of inactivity to allow.

-
tls?: ConnectionOptions

Defines additional options to be passed to the socket constructor.

+
interface SmtpTransportOptions {
    connection?: Socket;
    connectionTimeout?: number;
    debug?: boolean;
    greetingTimeout?: number;
    ignoreTLS?: boolean;
    logger?: boolean;
    opportunisticTLS?: boolean;
    proxy?: string;
    requireTLS?: boolean;
    secure?: boolean;
    socket?: Socket;
    socketTimeout?: number;
    tls?: ConnectionOptions;
}

Hierarchy (view full)

Properties

connection?: Socket

Connected socket to use instead of creating and connecting a new one. If secure option is true, then socket is upgraded from plain text to cipher text.

+
connectionTimeout?: number

How many milliseconds to wait for the connection to establish.

+
debug?: boolean

If set to true, then logs SMTP traffic and message content, otherwise logs only transaction events.

+
greetingTimeout?: number

How many milliseconds to wait for the greeting after connection is established.

+
ignoreTLS?: boolean

Turns off STARTTLS support if true.

+
logger?: boolean

If set to true then logs to console. If value is not set or is false then nothing is logged.

+
opportunisticTLS?: boolean

Tries to use STARTTLS and continues normally if it fails.

+
proxy?: string

A proxy URL used for connecting the SMTP server. This value will be forwarded to the underlying nodemailer lib, so it handles the proxy job for the SDK.

+
requireTLS?: boolean

Forces the client to use STARTTLS. Returns an error if upgrading the connection is not possible or fails.

+
secure?: boolean

Defines if the connection should use SSL (if true) or not (if false).

+
socket?: Socket

Initialized socket to use instead of creating a new one.

+
socketTimeout?: number

How many milliseconds of inactivity to allow.

+
tls?: ConnectionOptions

Defines additional options to be passed to the socket constructor.

Example

{ rejectUnauthorized: `true` }
 

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.BatchReference.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.BatchReference.html index dfff0a5f1a..b3df6e406c 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.BatchReference.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.BatchReference.html @@ -1,5 +1,5 @@ -BatchReference | SAP Cloud SDK for JavaScript - v3.12.1

Interface implemented by OData requests needing identifier to reference an entity for a batch request like create, delete, getByKey, update or bound actions/functions.

-
interface BatchReference {
    id: string;
}

Properties

id -

Properties

id: string

Batch reference identifier.

+BatchReference | SAP Cloud SDK for JavaScript - v3.12.0

Interface implemented by OData requests needing identifier to reference an entity for a batch request like create, delete, getByKey, update or bound actions/functions.

+
interface BatchReference {
    id: string;
}

Properties

id +

Properties

id: string

Batch reference identifier.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.ComplexTypeNamespace.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.ComplexTypeNamespace.html index b800229609..afd16dd32e 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.ComplexTypeNamespace.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.ComplexTypeNamespace.html @@ -1,5 +1,5 @@ -ComplexTypeNamespace | SAP Cloud SDK for JavaScript - v3.12.1

Interface to represent meta information on the _propertyMetadata property of a complex type.

-
interface ComplexTypeNamespace<ComplexT> {
    _propertyMetadata: PropertyMetadata<ComplexT>[];
}

Type Parameters

  • ComplexT

Properties

Properties

_propertyMetadata: PropertyMetadata<ComplexT>[]

Metadata like Edm.Type of the complex type properties.

+ComplexTypeNamespace | SAP Cloud SDK for JavaScript - v3.12.0

Interface to represent meta information on the _propertyMetadata property of a complex type.

+
interface ComplexTypeNamespace<ComplexT> {
    _propertyMetadata: PropertyMetadata<ComplexT>[];
}

Type Parameters

  • ComplexT

Properties

Properties

_propertyMetadata: PropertyMetadata<ComplexT>[]

Metadata like Edm.Type of the complex type properties.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.Constructable.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.Constructable.html index 7e6d7c8559..64fa03ea5d 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.Constructable.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.Constructable.html @@ -1,10 +1,10 @@ -Constructable | SAP Cloud SDK for JavaScript - v3.12.1

Represents the static API of an entity.

-
interface Constructable<EntityT> {
    new Constructablenew (...args): EntityT;
    _defaultBasePath: string;
    _entityName: string;
    _keys: string[];
}

Type Parameters

Constructors

Properties

Constructors

  • Parameters

    • Rest ...args: any[]

    Returns EntityT

Properties

_defaultBasePath: string

Base path as specified in the options-per-service.json, e.g., /sap/opu/odata/sap/API_COMMON_SRV.

-
_entityName: string

Name of the entity.

-
_keys: string[]

Names of the key properties of the entity.

+Constructable | SAP Cloud SDK for JavaScript - v3.12.0

Represents the static API of an entity.

+
interface Constructable<EntityT> {
    new Constructablenew (...args): EntityT;
    _defaultBasePath: string;
    _entityName: string;
    _keys: string[];
}

Type Parameters

Constructors

Properties

Constructors

  • Parameters

    • Rest ...args: any[]

    Returns EntityT

Properties

_defaultBasePath: string

Base path as specified in the options-per-service.json, e.g., /sap/opu/odata/sap/API_COMMON_SRV.

+
_entityName: string

Name of the entity.

+
_keys: string[]

Names of the key properties of the entity.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.DeSerializer.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.DeSerializer.html index 07b5b4d3de..02762b0668 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.DeSerializer.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.DeSerializer.html @@ -1,19 +1,30 @@ -DeSerializer | SAP Cloud SDK for JavaScript - v3.12.1

Represents a set of functions for serialization, deserialization and optionally serialization for URIs. +DeSerializer | SAP Cloud SDK for JavaScript - v3.12.0

Represents a set of functions for serialization, deserialization and optionally serialization for URIs. The return type of the deserialize function is the type of the input to the serialize and serializeToUri functions.

-
interface DeSerializer<DeserializedT> {
    deserialize: ((value) => DeserializedT);
    serialize: ((value) => any);
    serializeToUri?: ((value, serialize) => string);
}

Type Parameters

  • DeserializedT

    The return type of deserialize and input of serialize and serializeToUri.

    -

Properties

deserialize: ((value) => DeserializedT)

Function to deserialize a value which is usually a string.

-

Type declaration

Returns

Deserialized value.

-
serialize: ((value) => any)

Function to serialize a value.

-

Type declaration

    • (value): any
    • Parameters

      Returns any

Returns

Serialized value.

-
serializeToUri?: ((value, serialize) => string)

Function to serialize a value for use in a URI. +

interface DeSerializer<DeserializedT> {
    deserialize: ((value) => DeserializedT);
    serialize: ((value) => any);
    serializeToUri?: ((value, serialize) => string);
}

Type Parameters

  • DeserializedT

    The return type of deserialize and input of serialize and serializeToUri.

    +

Properties

deserialize: ((value) => DeserializedT)

Function to deserialize a value which is usually a string.

+

Type declaration

    • (value): DeserializedT
    • Function to deserialize a value which is usually a string.

      +

      Parameters

      • value: any

        Serialized value to deserialize.

        +

      Returns DeserializedT

      Deserialized value.

      +

Param: value

Serialized value to deserialize.

+

Returns

Deserialized value.

+
serialize: ((value) => any)

Function to serialize a value.

+

Type declaration

    • (value): any
    • Function to serialize a value.

      +

      Parameters

      Returns any

      Serialized value.

      +

Param: value

Deserialized value to serialize.

+

Returns

Serialized value.

+
serializeToUri?: ((value, serialize) => string)

Function to serialize a value for use in a URI. This function is optional. If not specified, the serialize function will be used.

-

Type declaration

    • (value, serialize): string
    • Parameters

      • value: DeserializedT

        Deserialized value to serialize.

        -
      • serialize: ((value) => any)

        A reference to the serialize function which is usually used to serialize the payload.

        -

      Returns string

Returns

Serialized value for URIs.

+

Type declaration

    • (value, serialize): string
    • Function to serialize a value for use in a URI. +This function is optional. If not specified, the serialize function will be used.

      +

      Parameters

      • value: DeserializedT

        Deserialized value to serialize.

        +
      • serialize: ((value) => any)

        A reference to the serialize function which is usually used to serialize the payload.

        +

      Returns string

      Serialized value for URIs.

      +

Param: value

Deserialized value to serialize.

+

Param: serialize

A reference to the serialize function which is usually used to serialize the payload.

+

Returns

Serialized value for URIs.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.DeSerializers.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.DeSerializers.html index 925e1d1773..362be437b7 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.DeSerializers.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.DeSerializers.html @@ -1,31 +1,31 @@ -DeSerializers | SAP Cloud SDK for JavaScript - v3.12.1

Interface DeSerializers<BinaryT, BooleanT, ByteT, DecimalT, DoubleT, FloatT, Int16T, Int32T, Int64T, GuidT, SByteT, SingleT, StringT, AnyT>

Represents a set of functions that determine (de-)serialization per EDM type.

-

Type Parameters

  • BinaryT = any
  • BooleanT = any
  • ByteT = any
  • DecimalT = any
  • DoubleT = any
  • FloatT = any
  • Int16T = any
  • Int32T = any
  • Int64T = any
  • GuidT = any
  • SByteT = any
  • SingleT = any
  • StringT = any
  • AnyT = any

Hierarchy (view full)

Properties

Edm.Any: DeSerializer<AnyT>

DeSerializer for Edm.Any to the generic type AnyT.

-
Edm.Binary: DeSerializer<BinaryT>

DeSerializer for Edm.Binary to the generic type BinaryT.

-
Edm.Boolean: DeSerializer<BooleanT>

DeSerializer for Edm.Boolean to the generic type BooleanT.

-
Edm.Byte: DeSerializer<ByteT>

DeSerializer for Edm.Byte to the generic type ByteT.

-
Edm.Decimal: DeSerializer<DecimalT>

DeSerializer for Edm.Decimal to the generic type DecimalT.

-
Edm.Double: DeSerializer<DoubleT>

DeSerializer for Edm.Double to the generic type DoubleT.

-
Edm.Float: DeSerializer<FloatT>

DeSerializer for Edm.Float to the generic type FloatT.

-
Edm.Guid: DeSerializer<GuidT>

DeSerializer for Edm.Guid to the generic type GuidT.

-
Edm.Int16: DeSerializer<Int16T>

DeSerializer for Edm.Int16 to the generic type Int16T.

-
Edm.Int32: DeSerializer<Int32T>

DeSerializer for Edm.Int32 to the generic type Int32T.

-
Edm.Int64: DeSerializer<Int64T>

DeSerializer for Edm.Int64 to the generic type Int64T.

-
Edm.SByte: DeSerializer<SByteT>

DeSerializer for Edm.SByte to the generic type SByteT.

-
Edm.Single: DeSerializer<SingleT>

DeSerializer for Edm.Single to the generic type SingleT.

-
Edm.String: DeSerializer<StringT>

DeSerializer for Edm.String to the generic type StringT.

+DeSerializers | SAP Cloud SDK for JavaScript - v3.12.0

Interface DeSerializers<BinaryT, BooleanT, ByteT, DecimalT, DoubleT, FloatT, Int16T, Int32T, Int64T, GuidT, SByteT, SingleT, StringT, AnyT>

Represents a set of functions that determine (de-)serialization per EDM type.

+

Type Parameters

  • BinaryT = any

  • BooleanT = any

  • ByteT = any

  • DecimalT = any

  • DoubleT = any

  • FloatT = any

  • Int16T = any

  • Int32T = any

  • Int64T = any

  • GuidT = any

  • SByteT = any

  • SingleT = any

  • StringT = any

  • AnyT = any

Hierarchy (view full)

Properties

Edm.Any: DeSerializer<AnyT>

DeSerializer for Edm.Any to the generic type AnyT.

+
Edm.Binary: DeSerializer<BinaryT>

DeSerializer for Edm.Binary to the generic type BinaryT.

+
Edm.Boolean: DeSerializer<BooleanT>

DeSerializer for Edm.Boolean to the generic type BooleanT.

+
Edm.Byte: DeSerializer<ByteT>

DeSerializer for Edm.Byte to the generic type ByteT.

+
Edm.Decimal: DeSerializer<DecimalT>

DeSerializer for Edm.Decimal to the generic type DecimalT.

+
Edm.Double: DeSerializer<DoubleT>

DeSerializer for Edm.Double to the generic type DoubleT.

+
Edm.Float: DeSerializer<FloatT>

DeSerializer for Edm.Float to the generic type FloatT.

+
Edm.Guid: DeSerializer<GuidT>

DeSerializer for Edm.Guid to the generic type GuidT.

+
Edm.Int16: DeSerializer<Int16T>

DeSerializer for Edm.Int16 to the generic type Int16T.

+
Edm.Int32: DeSerializer<Int32T>

DeSerializer for Edm.Int32 to the generic type Int32T.

+
Edm.Int64: DeSerializer<Int64T>

DeSerializer for Edm.Int64 to the generic type Int64T.

+
Edm.SByte: DeSerializer<SByteT>

DeSerializer for Edm.SByte to the generic type SByteT.

+
Edm.Single: DeSerializer<SingleT>

DeSerializer for Edm.Single to the generic type SingleT.

+
Edm.String: DeSerializer<StringT>

DeSerializer for Edm.String to the generic type StringT.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.EntityApi.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.EntityApi.html index 2b922c0456..8b2357b41d 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.EntityApi.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.EntityApi.html @@ -1,15 +1,15 @@ -EntityApi | SAP Cloud SDK for JavaScript - v3.12.1

Interface EntityApi<EntityT, DeSerializersT>

Represents the API of an entity, including its request and entity builders as well as its schema.

+EntityApi | SAP Cloud SDK for JavaScript - v3.12.0

Interface EntityApi<EntityT, DeSerializersT>

Represents the API of an entity, including its request and entity builders as well as its schema.

Type Param: JsonT

Type of the entity without methods.

-

Type Parameters

Properties

deSerializers: DeSerializersT

Set of functions that determine (de-)serialization per EDM type.

-
entityConstructor: Constructable<EntityT>

Constructor function for the entity.

-
schema: Record<string, any>

Schema of the entity api.

+

Type Parameters

Properties

deSerializers: DeSerializersT

Set of functions that determine (de-)serialization per EDM type.

+
entityConstructor: Constructable<EntityT>

Constructor function for the entity.

+
schema: Record<string, any>

Schema of the entity api.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-

Methods

\ No newline at end of file +

Methods

\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.EntityDeserializer.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.EntityDeserializer.html index 14239a380e..ed0f417c8c 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.EntityDeserializer.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.EntityDeserializer.html @@ -1,7 +1,9 @@ -EntityDeserializer | SAP Cloud SDK for JavaScript - v3.12.1

Interface representing the return type of the builder function entityDeserializer.

-
interface EntityDeserializer {
    deserializeComplexType: ((json, complexType) => any);
    deserializeEntity: (<EntityT>(json, entityApi, requestHeader?) => EntityT);
}

Properties

deserializeComplexType: ((json, complexType) => any)

Method to deserialize the full entity from JSON to the complex type property.

-

Type declaration

    • (json, complexType): any
    • Parameters

      Returns any

deserializeEntity: (<EntityT>(json, entityApi, requestHeader?) => EntityT)

Method to deserialize the full entity from JSON to an entity object.

+EntityDeserializer | SAP Cloud SDK for JavaScript - v3.12.0

Interface representing the return type of the builder function entityDeserializer.

+
interface EntityDeserializer {
    deserializeComplexType: ((json, complexType) => any);
    deserializeEntity: (<EntityT>(json, entityApi, requestHeader?) => EntityT);
}

Properties

deserializeComplexType: ((json, complexType) => any)

Method to deserialize the full entity from JSON to the complex type property.

+

Type declaration

    • (json, complexType): any
    • Method to deserialize the full entity from JSON to the complex type property.

      +

      Parameters

      Returns any

deserializeEntity: (<EntityT>(json, entityApi, requestHeader?) => EntityT)

Method to deserialize the full entity from JSON to an entity object.

+

Type declaration

    • <EntityT>(json, entityApi, requestHeader?): EntityT
    • Method to deserialize the full entity from JSON to an entity object.

      Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

      -

      Type declaration

\ No newline at end of file +

Type Parameters

Parameters

Returns EntityT

\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.EntityIdentifiable.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.EntityIdentifiable.html index 67d887a010..b7d36c3390 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.EntityIdentifiable.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.EntityIdentifiable.html @@ -1,9 +1,9 @@ -EntityIdentifiable | SAP Cloud SDK for JavaScript - v3.12.1

Represents an object that is related to an entity. +EntityIdentifiable | SAP Cloud SDK for JavaScript - v3.12.0

Represents an object that is related to an entity. Objects that have the same structure would be represented by the same type in TypeScript. This interface allows to identify equal structures as different structures if they are related to different entities.

-
interface EntityIdentifiable<T, DeSerializersT> {
    _deSerializers: DeSerializersT;
    _entity: T;
}

Type Parameters

Implemented by

Properties

Properties

_deSerializers: DeSerializersT

Dummy property to also include the deserializer type in the structure of the entity type.

-
_entity: T

Dummy property whose type makes structurally identical entities distinguishable in TypeScript.

+
interface EntityIdentifiable<T, DeSerializersT> {
    _deSerializers: DeSerializersT;
    _entity: T;
}

Type Parameters

Implemented by

Properties

Properties

_deSerializers: DeSerializersT

Dummy property to also include the deserializer type in the structure of the entity type.

+
_entity: T

Dummy property whose type makes structurally identical entities distinguishable in TypeScript.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.EntitySerializer.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.EntitySerializer.html index 166deac8c5..90336dd266 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.EntitySerializer.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.EntitySerializer.html @@ -1,9 +1,12 @@ -EntitySerializer | SAP Cloud SDK for JavaScript - v3.12.1

Interface representing the return type of the builder function entitySerializer.

-
interface EntitySerializer {
    serializeComplexType: (<ComplexTypeNamespaceT>(fieldValue, complexTypeNameSpace) => any);
    serializeEntity: (<EntityT>(entity, entityApi, diff?) => Record<string, any>);
    serializeEntityNonCustomFields: (<EntityT>(entity, entityApi) => Record<string, any>);
}

Properties

serializeComplexType: (<ComplexTypeNamespaceT>(fieldValue, complexTypeNameSpace) => any)

Method to serialize a complex type to JSON.

-

Type declaration

serializeEntity: (<EntityT>(entity, entityApi, diff?) => Record<string, any>)

Converts an instance of an entity class into a JSON payload to be sent to an OData service.

-

Type declaration

    • <EntityT>(entity, entityApi, diff?): Record<string, any>
    • Type Parameters

      Parameters

      Returns Record<string, any>

serializeEntityNonCustomFields: (<EntityT>(entity, entityApi) => Record<string, any>)

Like EntitySerializer#serializeEntity ignoring custom fields.

+EntitySerializer | SAP Cloud SDK for JavaScript - v3.12.0

Interface representing the return type of the builder function entitySerializer.

+
interface EntitySerializer {
    serializeComplexType: (<ComplexTypeNamespaceT>(fieldValue, complexTypeNameSpace) => any);
    serializeEntity: (<EntityT>(entity, entityApi, diff?) => Record<string, any>);
    serializeEntityNonCustomFields: (<EntityT>(entity, entityApi) => Record<string, any>);
}

Properties

serializeComplexType: (<ComplexTypeNamespaceT>(fieldValue, complexTypeNameSpace) => any)

Method to serialize a complex type to JSON.

+

Type declaration

serializeEntity: (<EntityT>(entity, entityApi, diff?) => Record<string, any>)

Converts an instance of an entity class into a JSON payload to be sent to an OData service.

+

Type declaration

    • <EntityT>(entity, entityApi, diff?): Record<string, any>
    • Converts an instance of an entity class into a JSON payload to be sent to an OData service.

      +

      Type Parameters

      Parameters

      Returns Record<string, any>

serializeEntityNonCustomFields: (<EntityT>(entity, entityApi) => Record<string, any>)

Like EntitySerializer#serializeEntity ignoring custom fields.

+

Type declaration

    • <EntityT>(entity, entityApi): Record<string, any>
    • Like EntitySerializer#serializeEntity ignoring custom fields.

      Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

      -

      Type declaration

\ No newline at end of file +

Type Parameters

Parameters

Returns Record<string, any>

\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.ErrorResponse.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.ErrorResponse.html index 3d2783348b..94ac63f800 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.ErrorResponse.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.ErrorResponse.html @@ -1,13 +1,13 @@ -ErrorResponse | SAP Cloud SDK for JavaScript - v3.12.1

Represents an erroneous response to a retrieve or change set request within a batch request.

-
interface ErrorResponse {
    body: Record<string, any>;
    httpCode: number;
    isError: (() => this is ErrorResponse);
    isReadResponse: (() => this is ReadResponse<any>);
    isSuccess: (() => this is ReadResponse<any> | WriteResponses<any>);
    isWriteResponses: (() => this is WriteResponses<any>);
    responseType: "ErrorResponse";
}

Hierarchy

  • BatchResponseTypeGuards<any>
    • ErrorResponse

Properties

body: Record<string, any>

HTTP raw body.

-
httpCode: number

HTTP response status code.

-
isError: (() => this is ErrorResponse)

Type declaration

isReadResponse: (() => this is ReadResponse<any>)

Type declaration

isSuccess: (() => this is ReadResponse<any> | WriteResponses<any>)

Type declaration

isWriteResponses: (() => this is WriteResponses<any>)

Type declaration

responseType: "ErrorResponse"

Tag for identifying the type of a batch response.

+ErrorResponse | SAP Cloud SDK for JavaScript - v3.12.0

Represents an erroneous response to a retrieve or change set request within a batch request.

+
interface ErrorResponse {
    body: Record<string, any>;
    httpCode: number;
    isError: (() => this is ErrorResponse);
    isReadResponse: (() => this is ReadResponse<any>);
    isSuccess: (() => this is ReadResponse<any> | WriteResponses<any>);
    isWriteResponses: (() => this is WriteResponses<any>);
    responseType: "ErrorResponse";
}

Hierarchy

  • BatchResponseTypeGuards<any>
    • ErrorResponse

Properties

body: Record<string, any>

HTTP raw body.

+
httpCode: number

HTTP response status code.

+
isError: (() => this is ErrorResponse)

Type declaration

isReadResponse: (() => this is ReadResponse<any>)

Type declaration

isSuccess: (() => this is ReadResponse<any> | WriteResponses<any>)

Type declaration

isWriteResponses: (() => this is WriteResponses<any>)

Type declaration

responseType: "ErrorResponse"

Tag for identifying the type of a batch response.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.FieldOptions.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.FieldOptions.html index e7ed2e6278..677c98612d 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.FieldOptions.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.FieldOptions.html @@ -1,7 +1,7 @@ -FieldOptions | SAP Cloud SDK for JavaScript - v3.12.1

Interface FieldOptions<NullableT, SelectableT>

Optional settings for fields.

-
interface FieldOptions<NullableT, SelectableT> {
    isNullable?: NullableT;
    isSelectable?: SelectableT;
}

Type Parameters

  • NullableT extends boolean = false
  • SelectableT extends boolean = false

Properties

isNullable?: NullableT

Whether the value of the field can be null.

-
isSelectable?: SelectableT

Whether the field can be reference in a .select statement.

+FieldOptions | SAP Cloud SDK for JavaScript - v3.12.0

Interface FieldOptions<NullableT, SelectableT>

Optional settings for fields.

+
interface FieldOptions<NullableT, SelectableT> {
    isNullable?: NullableT;
    isSelectable?: SelectableT;
}

Type Parameters

  • NullableT extends boolean = false

  • SelectableT extends boolean = false

Properties

isNullable?: NullableT

Whether the value of the field can be null.

+
isSelectable?: SelectableT

Whether the field can be reference in a .select statement.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.FilterFunctionsType.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.FilterFunctionsType.html index 5539bfbc90..d1c576c204 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.FilterFunctionsType.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.FilterFunctionsType.html @@ -1,41 +1,61 @@ -FilterFunctionsType | SAP Cloud SDK for JavaScript - v3.12.1

Interface containing all filter functions like startsWith, toUpper or floor.

-
interface FilterFunctionsType {
    ceiling: (<EntityT>(num, returnType?) => NumberFilterFunction<EntityT>);
    concat: (<EntityT>(str1, str2) => StringFilterFunction<EntityT>);
    day: (<EntityT>(date) => NumberFilterFunction<EntityT>);
    endsWith: (<EntityT>(str, suffix) => BooleanFilterFunction<EntityT>);
    floor: (<EntityT>(num, returnType?) => NumberFilterFunction<EntityT>);
    hour: (<EntityT>(date) => NumberFilterFunction<EntityT>);
    indexOf: (<EntityT>(str, substr) => NumberFilterFunction<EntityT>);
    isOf: {
        <EntityT>(type): BooleanFilterFunction<EntityT>;
        <EntityT>(expression, type): BooleanFilterFunction<EntityT>;
    };
    length: (<EntityT>(str) => NumberFilterFunction<EntityT>);
    minute: (<EntityT>(date) => NumberFilterFunction<EntityT>);
    month: (<EntityT>(date) => NumberFilterFunction<EntityT>);
    round: (<EntityT>(num, returnType?) => NumberFilterFunction<EntityT>);
    second: (<EntityT>(date) => NumberFilterFunction<EntityT>);
    startsWith: (<EntityT>(str, prefix) => BooleanFilterFunction<EntityT>);
    substring: (<EntityT>(str, pos, len?) => StringFilterFunction<EntityT>);
    toLower: (<EntityT>(str) => StringFilterFunction<EntityT>);
    toUpper: (<EntityT>(str) => StringFilterFunction<EntityT>);
    trim: (<EntityT>(str) => StringFilterFunction<EntityT>);
    year: (<EntityT>(date) => NumberFilterFunction<EntityT>);
}

Properties

ceiling: (<EntityT>(num, returnType?) => NumberFilterFunction<EntityT>)

Build a filter function to ceil a number. Evaluates to double or decimal, defaults to double.

-

Type declaration

concat: (<EntityT>(str1, str2) => StringFilterFunction<EntityT>)

Build a filter function to concatenate two strings. Evaluates to string.

-

Type declaration

Build a filter function to get the day of a date. Evaluates to int.

-

Type declaration

endsWith: (<EntityT>(str, suffix) => BooleanFilterFunction<EntityT>)

Build a filter function to test whether a string ends with another. Evaluates to boolean.

-

Type declaration

floor: (<EntityT>(num, returnType?) => NumberFilterFunction<EntityT>)

Build a filter function to floor a number. Evaluates to double or decimal, defaults to double.

-

Type declaration

Build a filter function to get the hour of a date. Evaluates to int.

-

Type declaration

indexOf: (<EntityT>(str, substr) => NumberFilterFunction<EntityT>)

Build a filter function to get the start index of a substring. Evaluates to int.

-

Type declaration

isOf: {
    <EntityT>(type): BooleanFilterFunction<EntityT>;
    <EntityT>(expression, type): BooleanFilterFunction<EntityT>;
}

Build a filter function to test whether a selection or a field is of a given type. Evaluates to boolean.

-

Type declaration

length: (<EntityT>(str) => NumberFilterFunction<EntityT>)

Build a filter function to get the length of a string. Evaluates to int.

-

Type declaration

minute: (<EntityT>(date) => NumberFilterFunction<EntityT>)

Build a filter function to get the minute of a date. Evaluates to int.

-

Type declaration

month: (<EntityT>(date) => NumberFilterFunction<EntityT>)

Build a filter function to get the month of a date. Evaluates to int.

-

Type declaration

round: (<EntityT>(num, returnType?) => NumberFilterFunction<EntityT>)

Build a filter function to round a number. Evaluates to double or decimal, defaults to double.

-

Type declaration

second: (<EntityT>(date) => NumberFilterFunction<EntityT>)

Build a filter function to get the second of a date. Evaluates to int.

-

Type declaration

startsWith: (<EntityT>(str, prefix) => BooleanFilterFunction<EntityT>)

Build a filter function to test whether a string starts with another. Evaluates to boolean.

-

Type declaration

substring: (<EntityT>(str, pos, len?) => StringFilterFunction<EntityT>)

Build a filter function to get a substring starting from a designated position. Evaluates to string.

-

Type declaration

toLower: (<EntityT>(str) => StringFilterFunction<EntityT>)

Build a filter function to transform a string to lower case. Evaluates to string.

-

Type declaration

toUpper: (<EntityT>(str) => StringFilterFunction<EntityT>)

Build a filter function to transform a string to upper case. Evaluates to string.

-

Type declaration

Build a filter function to trim whitespace from a string. Evaluates to string.

-

Type declaration

Build a filter function to get the year of a date. Evaluates to int.

+FilterFunctionsType | SAP Cloud SDK for JavaScript - v3.12.0

Interface containing all filter functions like startsWith, toUpper or floor.

+
interface FilterFunctionsType {
    ceiling: (<EntityT>(num, returnType?) => NumberFilterFunction<EntityT>);
    concat: (<EntityT>(str1, str2) => StringFilterFunction<EntityT>);
    day: (<EntityT>(date) => NumberFilterFunction<EntityT>);
    endsWith: (<EntityT>(str, suffix) => BooleanFilterFunction<EntityT>);
    floor: (<EntityT>(num, returnType?) => NumberFilterFunction<EntityT>);
    hour: (<EntityT>(date) => NumberFilterFunction<EntityT>);
    indexOf: (<EntityT>(str, substr) => NumberFilterFunction<EntityT>);
    isOf: {
        <EntityT>(type): BooleanFilterFunction<EntityT>;
        <EntityT>(expression, type): BooleanFilterFunction<EntityT>;
    };
    length: (<EntityT>(str) => NumberFilterFunction<EntityT>);
    minute: (<EntityT>(date) => NumberFilterFunction<EntityT>);
    month: (<EntityT>(date) => NumberFilterFunction<EntityT>);
    round: (<EntityT>(num, returnType?) => NumberFilterFunction<EntityT>);
    second: (<EntityT>(date) => NumberFilterFunction<EntityT>);
    startsWith: (<EntityT>(str, prefix) => BooleanFilterFunction<EntityT>);
    substring: (<EntityT>(str, pos, len?) => StringFilterFunction<EntityT>);
    toLower: (<EntityT>(str) => StringFilterFunction<EntityT>);
    toUpper: (<EntityT>(str) => StringFilterFunction<EntityT>);
    trim: (<EntityT>(str) => StringFilterFunction<EntityT>);
    year: (<EntityT>(date) => NumberFilterFunction<EntityT>);
}

Properties

ceiling: (<EntityT>(num, returnType?) => NumberFilterFunction<EntityT>)

Build a filter function to ceil a number. Evaluates to double or decimal, defaults to double.

+

Type declaration

concat: (<EntityT>(str1, str2) => StringFilterFunction<EntityT>)

Build a filter function to concatenate two strings. Evaluates to string.

+

Type declaration

Build a filter function to get the day of a date. Evaluates to int.

+

Type declaration

endsWith: (<EntityT>(str, suffix) => BooleanFilterFunction<EntityT>)

Build a filter function to test whether a string ends with another. Evaluates to boolean.

+

Type declaration

floor: (<EntityT>(num, returnType?) => NumberFilterFunction<EntityT>)

Build a filter function to floor a number. Evaluates to double or decimal, defaults to double.

+

Type declaration

Build a filter function to get the hour of a date. Evaluates to int.

+

Type declaration

indexOf: (<EntityT>(str, substr) => NumberFilterFunction<EntityT>)

Build a filter function to get the start index of a substring. Evaluates to int.

+

Type declaration

isOf: {
    <EntityT>(type): BooleanFilterFunction<EntityT>;
    <EntityT>(expression, type): BooleanFilterFunction<EntityT>;
}

Build a filter function to test whether a selection or a field is of a given type. Evaluates to boolean.

+

Type declaration

length: (<EntityT>(str) => NumberFilterFunction<EntityT>)

Build a filter function to get the length of a string. Evaluates to int.

+

Type declaration

minute: (<EntityT>(date) => NumberFilterFunction<EntityT>)

Build a filter function to get the minute of a date. Evaluates to int.

+

Type declaration

month: (<EntityT>(date) => NumberFilterFunction<EntityT>)

Build a filter function to get the month of a date. Evaluates to int.

+

Type declaration

round: (<EntityT>(num, returnType?) => NumberFilterFunction<EntityT>)

Build a filter function to round a number. Evaluates to double or decimal, defaults to double.

+

Type declaration

second: (<EntityT>(date) => NumberFilterFunction<EntityT>)

Build a filter function to get the second of a date. Evaluates to int.

+

Type declaration

startsWith: (<EntityT>(str, prefix) => BooleanFilterFunction<EntityT>)

Build a filter function to test whether a string starts with another. Evaluates to boolean.

+

Type declaration

substring: (<EntityT>(str, pos, len?) => StringFilterFunction<EntityT>)

Build a filter function to get a substring starting from a designated position. Evaluates to string.

+

Type declaration

toLower: (<EntityT>(str) => StringFilterFunction<EntityT>)

Build a filter function to transform a string to lower case. Evaluates to string.

+

Type declaration

toUpper: (<EntityT>(str) => StringFilterFunction<EntityT>)

Build a filter function to transform a string to upper case. Evaluates to string.

+

Type declaration

Build a filter function to trim whitespace from a string. Evaluates to string.

+

Type declaration

Build a filter function to get the year of a date. Evaluates to int.

+

Type declaration

\ No newline at end of file +

Type Parameters

Parameters

Returns NumberFilterFunction<EntityT>

\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.ODataUri.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.ODataUri.html index 2907bae577..3f3a22455f 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.ODataUri.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.ODataUri.html @@ -1,11 +1,11 @@ -ODataUri | SAP Cloud SDK for JavaScript - v3.12.1

Union of necessary methods for the OData URI conversion. +ODataUri | SAP Cloud SDK for JavaScript - v3.12.0

Union of necessary methods for the OData URI conversion. In v2/uri-conversion/odata-uri.ts and v4/uri-conversion/odata-uri.ts the instance for v2 and v4 are created.

-
interface ODataUri<DeSerializersT> {
    convertToUriFormat(value, edmType): string;
    getEntityKeys<EntityT>(entity, entityApi): Record<string, any>;
    getExpand<EntityT>(selects, expands, entityApi): Partial<{
        expand: string;
    }>;
    getFilter<EntityT>(filter, entityApi): Partial<{
        filter: string;
    }>;
    getOrderBy<EntityT>(orderBy): Partial<{
        orderby: string;
    }>;
    getResourcePathForKeys<EntityT>(keys, _entityApi): string;
    getSelect<EntityT>(selects): Partial<{
        select: string;
    }>;
}

Type Parameters

Methods

interface ODataUri<DeSerializersT> {
    convertToUriFormat(value, edmType): string;
    getEntityKeys<EntityT>(entity, entityApi): Record<string, any>;
    getExpand<EntityT>(selects, expands, entityApi): Partial<{
        expand: string;
    }>;
    getFilter<EntityT>(filter, entityApi): Partial<{
        filter: string;
    }>;
    getOrderBy<EntityT>(orderBy): Partial<{
        orderby: string;
    }>;
    getResourcePathForKeys<EntityT>(keys, _entityApi): string;
    getSelect<EntityT>(selects): Partial<{
        select: string;
    }>;
}

Type Parameters

Methods

convertToUriFormat +getEntityKeys +getExpand +getFilter +getOrderBy +getResourcePathForKeys +getSelect

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-

Methods

  • Type Parameters

    Parameters

    Returns Record<string, any>

  • Type Parameters

    Parameters

    Returns Partial<{
        orderby: string;
    }>

  • Type Parameters

    Parameters

    Returns string

  • Type Parameters

    Parameters

    Returns Partial<{
        select: string;
    }>

\ No newline at end of file +

Methods

  • Type Parameters

    Parameters

    Returns Record<string, any>

  • Type Parameters

    Parameters

    Returns Partial<{
        orderby: string;
    }>

  • Type Parameters

    Parameters

    Returns string

  • Type Parameters

    Parameters

    Returns Partial<{
        select: string;
    }>

\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.PropertyMetadata.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.PropertyMetadata.html index 77b7b3dd83..2d2711e3cd 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.PropertyMetadata.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.PropertyMetadata.html @@ -1,11 +1,11 @@ -PropertyMetadata | SAP Cloud SDK for JavaScript - v3.12.1

Interface to represent meta information on a property of a complex type.

-
interface PropertyMetadata<ComplexT> {
    isCollection?: boolean;
    name: keyof ComplexT;
    originalName: string;
    type: EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4 | ComplexTypeNamespace<any>;
}

Type Parameters

  • ComplexT = any

Properties

isCollection?: boolean

If true, the property is a collection property.

-
name: keyof ComplexT

Name of the complex type property.

-
originalName: string

Original name of the complex type property.

-

Type of the complex type property.

+PropertyMetadata | SAP Cloud SDK for JavaScript - v3.12.0

Interface to represent meta information on a property of a complex type.

+
interface PropertyMetadata<ComplexT> {
    isCollection?: boolean;
    name: keyof ComplexT;
    originalName: string;
    type: EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4 | ComplexTypeNamespace<any>;
}

Type Parameters

  • ComplexT = any

Properties

isCollection?: boolean

If true, the property is a collection property.

+
name: keyof ComplexT

Name of the complex type property.

+
originalName: string

Original name of the complex type property.

+

Type of the complex type property.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.ReadResponse.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.ReadResponse.html index b409ba1152..eb21280184 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.ReadResponse.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.ReadResponse.html @@ -1,19 +1,21 @@ -ReadResponse | SAP Cloud SDK for JavaScript - v3.12.1

Represents a response to a retrieve request within a batch request.

-
interface ReadResponse<DeSerializersT> {
    as: (<EntityT>(entityApi) => EntityT[]);
    body: Record<string, any>;
    httpCode: number;
    isError: (() => this is ErrorResponse);
    isReadResponse: (() => this is ReadResponse<DeSerializersT>);
    isSuccess: (() => this is ReadResponse<DeSerializersT> | WriteResponses<DeSerializersT>);
    isWriteResponses: (() => this is WriteResponses<DeSerializersT>);
    responseType: "ReadResponse";
    type: EntityApi<EntityBase, DeSerializersT>;
}

Type Parameters

  • DeSerializersT extends DeSerializers

    Type of the (de-)serializers.

    -

Hierarchy

Properties

as: (<EntityT>(entityApi) => EntityT[])

Transform the raw data into an instance of an entity represented by the given entity API. +ReadResponse | SAP Cloud SDK for JavaScript - v3.12.0

Represents a response to a retrieve request within a batch request.

+
interface ReadResponse<DeSerializersT> {
    as: (<EntityT>(entityApi) => EntityT[]);
    body: Record<string, any>;
    httpCode: number;
    isError: (() => this is ErrorResponse);
    isReadResponse: (() => this is ReadResponse<DeSerializersT>);
    isSuccess: (() => this is ReadResponse<DeSerializersT> | WriteResponses<DeSerializersT>);
    isWriteResponses: (() => this is WriteResponses<DeSerializersT>);
    responseType: "ReadResponse";
    type: EntityApi<EntityBase, DeSerializersT>;
}

Type Parameters

  • DeSerializersT extends DeSerializers

    Type of the (de-)serializers.

    +

Hierarchy

Properties

as: (<EntityT>(entityApi) => EntityT[])

Transform the raw data into an instance of an entity represented by the given entity API. Note, this method transforms the raw data to an array of entities, even if the original request was a GetByKeyRequestBuilder.

-

Type declaration

body: Record<string, any>

HTTP raw body.

-
httpCode: number

HTTP response status code.

-
isError: (() => this is ErrorResponse)

Type declaration

isReadResponse: (() => this is ReadResponse<DeSerializersT>)

Type declaration

isWriteResponses: (() => this is WriteResponses<DeSerializersT>)

Type declaration

responseType: "ReadResponse"

Tag for identifying the type of a batch response.

-

EntityApi of the response data. Can be undefined for function/action imports or not mappable entities.

+

Type declaration

    • <EntityT>(entityApi): EntityT[]
    • Transform the raw data into an instance of an entity represented by the given entity API. +Note, this method transforms the raw data to an array of entities, even if the original request was a GetByKeyRequestBuilder.

      +

      Type Parameters

      Parameters

      Returns EntityT[]

body: Record<string, any>

HTTP raw body.

+
httpCode: number

HTTP response status code.

+
isError: (() => this is ErrorResponse)

Type declaration

isReadResponse: (() => this is ReadResponse<DeSerializersT>)

Type declaration

isWriteResponses: (() => this is WriteResponses<DeSerializersT>)

Type declaration

responseType: "ReadResponse"

Tag for identifying the type of a batch response.

+

EntityApi of the response data. Can be undefined for function/action imports or not mappable entities.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.ResponseDataAccessor.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.ResponseDataAccessor.html index 919ad9190b..103e4958fb 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.ResponseDataAccessor.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.ResponseDataAccessor.html @@ -1,15 +1,22 @@ -ResponseDataAccessor | SAP Cloud SDK for JavaScript - v3.12.1

Interface containing the functions to extract the data from the response object. +ResponseDataAccessor | SAP Cloud SDK for JavaScript - v3.12.0

Interface containing the functions to extract the data from the response object. For example the getCollectionResult extracts the data from data.d.results per default but this needs to be adjusted in some situations.

-
interface ResponseDataAccessor {
    getCollectionResult: ((data) => any[]);
    getLinkedCollectionResult: ((data) => any[]);
    getSingleResult: ((data) => Record<string, any>);
    isCollectionResult: ((data) => boolean);
}

Properties

getCollectionResult: ((data) => any[])

A function that extracts array data from the response object. +

interface ResponseDataAccessor {
    getCollectionResult: ((data) => any[]);
    getLinkedCollectionResult: ((data) => any[]);
    getSingleResult: ((data) => Record<string, any>);
    isCollectionResult: ((data) => boolean);
}

Properties

getCollectionResult: ((data) => any[])

A function that extracts array data from the response object. The data is extracted per default from data.d.results.

-

Type declaration

    • (data): any[]
    • Parameters

      • data: any

      Returns any[]

getLinkedCollectionResult: ((data) => any[])

Extract the collection data from the one-to-many link response. +

Type declaration

    • (data): any[]
    • A function that extracts array data from the response object. +The data is extracted per default from data.d.results.

      +

      Parameters

      • data: any

      Returns any[]

getLinkedCollectionResult: ((data) => any[])

Extract the collection data from the one-to-many link response. +If the data does not contain a collection, an empty array is returned.

+

Type declaration

    • (data): any[]
    • Extract the collection data from the one-to-many link response. If the data does not contain a collection, an empty array is returned.

      -

      Type declaration

        • (data): any[]
        • Parameters

          • data: any

          Returns any[]

getSingleResult: ((data) => Record<string, any>)

A function that extracts object data from the response object. +

Parameters

  • data: any

Returns any[]

getSingleResult: ((data) => Record<string, any>)

A function that extracts object data from the response object. +The data is extracted by default from data.d.results.

+

Type declaration

    • (data): Record<string, any>
    • A function that extracts object data from the response object. The data is extracted by default from data.d.results.

      -

      Type declaration

        • (data): Record<string, any>
        • Parameters

          • data: any

          Returns Record<string, any>

isCollectionResult: ((data) => boolean)

Checks if the response is an array-like object.

+

Parameters

  • data: any

Returns Record<string, any>

isCollectionResult: ((data) => boolean)

Checks if the response is an array-like object.

+

Type declaration

    • (data): boolean
    • Checks if the response is an array-like object.

      Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

      -

      Type declaration

        • (data): boolean
        • Parameters

          • data: any

          Returns boolean

\ No newline at end of file +

Parameters

  • data: any

Returns boolean

\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.Time.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.Time.html index 1e9535355b..2905dfcfd3 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.Time.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.Time.html @@ -1,9 +1,9 @@ -Time | SAP Cloud SDK for JavaScript - v3.12.1

Interface to represent Time or Duration.

-
interface Time {
    hours: number;
    minutes: number;
    seconds: number;
}

Properties

Properties

hours: number

The number of hours.

-
minutes: number

The number of minutes.

-
seconds: number

The number of seconds.

+Time | SAP Cloud SDK for JavaScript - v3.12.0

Interface to represent Time or Duration.

+
interface Time {
    hours: number;
    minutes: number;
    seconds: number;
}

Properties

Properties

hours: number

The number of hours.

+
minutes: number

The number of minutes.

+
seconds: number

The number of seconds.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.WithBatchReference.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.WithBatchReference.html index 2ff167891a..712695ea84 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.WithBatchReference.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.WithBatchReference.html @@ -1,7 +1,9 @@ -WithBatchReference | SAP Cloud SDK for JavaScript - v3.12.1

Interface implemented by OData requests defining the getter and setter for the batch reference.

-
interface WithBatchReference {
    getBatchReference: (() => BatchReference);
    setBatchId: ((id) => void);
}

Implemented by

Properties

getBatchReference: (() => BatchReference)

Getter for the batch reference.

-

Type declaration

setBatchId: ((id) => void)

Setter for the batch reference.

+WithBatchReference | SAP Cloud SDK for JavaScript - v3.12.0

Interface implemented by OData requests defining the getter and setter for the batch reference.

+
interface WithBatchReference {
    getBatchReference: (() => BatchReference);
    setBatchId: ((id) => void);
}

Implemented by

Properties

getBatchReference: (() => BatchReference)

Getter for the batch reference.

+

Type declaration

setBatchId: ((id) => void)

Setter for the batch reference.

+

Type declaration

    • (id): void
    • Setter for the batch reference.

      Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

      -

      Type declaration

        • (id): void
        • Parameters

          • id: string

          Returns void

\ No newline at end of file +

Parameters

  • id: string

Returns void

\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.WithETag.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.WithETag.html index bd82451a2f..ff9e90052e 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.WithETag.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.WithETag.html @@ -1,7 +1,7 @@ -WithETag | SAP Cloud SDK for JavaScript - v3.12.1

Interface implemented by OData requests needing ETagsto avoid conflicts in the persisted data like update or delete.

-
interface WithETag {
    eTag: string;
    versionIdentifierIgnored: boolean;
}

Implemented by

Properties

eTag: string

Version identifier.

-
versionIdentifierIgnored: boolean

Ignore the version identifier if set to true.

+WithETag | SAP Cloud SDK for JavaScript - v3.12.0

Interface implemented by OData requests needing ETagsto avoid conflicts in the persisted data like update or delete.

+
interface WithETag {
    eTag: string;
    versionIdentifierIgnored: boolean;
}

Implemented by

Properties

eTag: string

Version identifier.

+
versionIdentifierIgnored: boolean

Ignore the version identifier if set to true.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.WithGetAllRestrictions.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.WithGetAllRestrictions.html index 1bc7d355e5..422b725e77 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.WithGetAllRestrictions.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.WithGetAllRestrictions.html @@ -1,13 +1,13 @@ -WithGetAllRestrictions | SAP Cloud SDK for JavaScript - v3.12.1

Interface WithGetAllRestrictions<EntityT, DeSerializersT>

Interface representing options on a getAll request like top or orderBy.

-
interface WithGetAllRestrictions<EntityT, DeSerializersT> {
    filter: Filterable<EntityT, DeSerializersT>;
    orderBy: Orderable<EntityT, EntityApi<EntityBase, DefaultDeSerializers>>[];
    selects: Selectable<EntityT, DeSerializersT>[];
    skip: number;
    top: number;
}

Type Parameters

Hierarchy (view full)

Implemented by

Properties

Properties

Filter the results based on conditions.

-

Order the results in, e.g., asc or desc order.

-

Select a list of fields on the schema property of the entity api.

-
skip: number

Skip a number of results in the requested set.

-
top: number

Limit the number of results to the given number.

+WithGetAllRestrictions | SAP Cloud SDK for JavaScript - v3.12.0

Interface WithGetAllRestrictions<EntityT, DeSerializersT>

Interface representing options on a getAll request like top or orderBy.

+
interface WithGetAllRestrictions<EntityT, DeSerializersT> {
    filter: Filterable<EntityT, DeSerializersT>;
    orderBy: Orderable<EntityT, EntityApi<EntityBase, DefaultDeSerializers>>[];
    selects: Selectable<EntityT, DeSerializersT>[];
    skip: number;
    top: number;
}

Type Parameters

Hierarchy (view full)

Implemented by

Properties

Properties

Filter the results based on conditions.

+

Order the results in, e.g., asc or desc order.

+

Select a list of fields on the schema property of the entity api.

+
skip: number

Skip a number of results in the requested set.

+
top: number

Limit the number of results to the given number.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.WithKeys.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.WithKeys.html index 86edcd7647..54a339473c 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.WithKeys.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.WithKeys.html @@ -1,5 +1,5 @@ -WithKeys | SAP Cloud SDK for JavaScript - v3.12.1

Interface implemented by OData requests needing keys to identify an entity like getByKey, delete or update.

-
interface WithKeys {
    keys: Record<string, any>;
}

Implemented by

Properties

Properties

keys: Record<string, any>

Map containing the key name and value.

+WithKeys | SAP Cloud SDK for JavaScript - v3.12.0

Interface implemented by OData requests needing keys to identify an entity like getByKey, delete or update.

+
interface WithKeys {
    keys: Record<string, any>;
}

Implemented by

Properties

Properties

keys: Record<string, any>

Map containing the key name and value.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.WithSelection.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.WithSelection.html index d6750adcc3..594d29b8ff 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.WithSelection.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.WithSelection.html @@ -1,5 +1,5 @@ -WithSelection | SAP Cloud SDK for JavaScript - v3.12.1

Interface WithSelection<EntityT, DeSerializersT>

Interface implemented by OData requests returning data like getAll or getByKey.

-
interface WithSelection<EntityT, DeSerializersT> {
    selects: Selectable<EntityT, DeSerializersT>[];
}

Type Parameters

Hierarchy (view full)

Implemented by

Properties

Properties

Select a list of fields on the schema property of the entity api.

+WithSelection | SAP Cloud SDK for JavaScript - v3.12.0

Interface WithSelection<EntityT, DeSerializersT>

Interface implemented by OData requests returning data like getAll or getByKey.

+
interface WithSelection<EntityT, DeSerializersT> {
    selects: Selectable<EntityT, DeSerializersT>[];
}

Type Parameters

Hierarchy (view full)

Implemented by

Properties

Properties

Select a list of fields on the schema property of the entity api.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.WriteResponse.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.WriteResponse.html index 4f9028b290..ebe2ac2b9d 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.WriteResponse.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.WriteResponse.html @@ -1,15 +1,17 @@ -WriteResponse | SAP Cloud SDK for JavaScript - v3.12.1

Represents a single subresponse to a changeset request within a batch request.

-
interface WriteResponse<DeSerializersT> {
    as?: (<EntityT>(entityApi) => EntityT);
    body?: Record<string, any>;
    httpCode: number;
    responseType: "WriteResponse";
    type?: EntityApi<EntityBase, DeSerializersT>;
}

Type Parameters

  • DeSerializersT extends DeSerializers

    Type of the (de-)serializers.

    -

Properties

as?: (<EntityT>(entityApi) => EntityT)

Transform the raw string body into an instance of the given constructor. +WriteResponse | SAP Cloud SDK for JavaScript - v3.12.0

Represents a single subresponse to a changeset request within a batch request.

+
interface WriteResponse<DeSerializersT> {
    as?: (<EntityT>(entityApi) => EntityT);
    body?: Record<string, any>;
    httpCode: number;
    responseType: "WriteResponse";
    type?: EntityApi<EntityBase, DeSerializersT>;
}

Type Parameters

  • DeSerializersT extends DeSerializers

    Type of the (de-)serializers.

    +

Properties

as?: (<EntityT>(entityApi) => EntityT)

Transform the raw string body into an instance of the given constructor. Note that the response may not exist, so you should only call this method if you know that there is data.

-

Type declaration

body?: Record<string, any>

HTTP raw body.

-
httpCode: number

HTTP response status code.

-
responseType: "WriteResponse"

Tag for identifying the type of a batch response.

-

EntityApi of the response data. Can be undefined for function/action imports or not mappable entities.

+

Type declaration

    • <EntityT>(entityApi): EntityT
    • Transform the raw string body into an instance of the given constructor. +Note that the response may not exist, so you should only call this method if you know that there is data.

      +

      Type Parameters

      Parameters

      Returns EntityT

body?: Record<string, any>

HTTP raw body.

+
httpCode: number

HTTP response status code.

+
responseType: "WriteResponse"

Tag for identifying the type of a batch response.

+

EntityApi of the response data. Can be undefined for function/action imports or not mappable entities.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.WriteResponses.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.WriteResponses.html index afffc2c112..af10362529 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.WriteResponses.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_common.WriteResponses.html @@ -1,10 +1,10 @@ -WriteResponses | SAP Cloud SDK for JavaScript - v3.12.1

Represents the list of responses for a change set in a batch request.

-
interface WriteResponses<DeSerializersT> {
    isError: (() => this is ErrorResponse);
    isReadResponse: (() => this is ReadResponse<DeSerializersT>);
    isSuccess: (() => this is WriteResponses<DeSerializersT> | ReadResponse<DeSerializersT>);
    isWriteResponses: (() => this is WriteResponses<DeSerializersT>);
    responses: WriteResponse<DeSerializersT>[];
}

Type Parameters

  • DeSerializersT extends DeSerializers

    Type of the (de-)serializers.

    -

Hierarchy

Properties

isError: (() => this is ErrorResponse)

Type declaration

isReadResponse: (() => this is ReadResponse<DeSerializersT>)

Type declaration

isWriteResponses: (() => this is WriteResponses<DeSerializersT>)

Type declaration

List of responses for a change set in a batch request.

+WriteResponses | SAP Cloud SDK for JavaScript - v3.12.0

Represents the list of responses for a change set in a batch request.

+
interface WriteResponses<DeSerializersT> {
    isError: (() => this is ErrorResponse);
    isReadResponse: (() => this is ReadResponse<DeSerializersT>);
    isSuccess: (() => this is WriteResponses<DeSerializersT> | ReadResponse<DeSerializersT>);
    isWriteResponses: (() => this is WriteResponses<DeSerializersT>);
    responses: WriteResponse<DeSerializersT>[];
}

Type Parameters

  • DeSerializersT extends DeSerializers

    Type of the (de-)serializers.

    +

Hierarchy

Properties

isError: (() => this is ErrorResponse)

Type declaration

isReadResponse: (() => this is ReadResponse<DeSerializersT>)

Type declaration

isWriteResponses: (() => this is WriteResponses<DeSerializersT>)

Type declaration

List of responses for a change set in a batch request.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_v2.DeSerializers.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_v2.DeSerializers.html index 4498e5dc33..b15e08cc27 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_v2.DeSerializers.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_v2.DeSerializers.html @@ -1,37 +1,37 @@ -DeSerializers | SAP Cloud SDK for JavaScript - v3.12.1

Interface DeSerializers<BinaryT, BooleanT, ByteT, DecimalT, DoubleT, FloatT, Int16T, Int32T, Int64T, GuidT, SByteT, SingleT, StringT, AnyT, DateTimeT, DateTimeOffsetT, TimeT>

Represents a set of functions that determine (de-)serialization per EDM type.

-

Type Parameters

  • BinaryT = any
  • BooleanT = any
  • ByteT = any
  • DecimalT = any
  • DoubleT = any
  • FloatT = any
  • Int16T = any
  • Int32T = any
  • Int64T = any
  • GuidT = any
  • SByteT = any
  • SingleT = any
  • StringT = any
  • AnyT = any
  • DateTimeT = any
  • DateTimeOffsetT = any
  • TimeT = any

Hierarchy (view full)

Properties

Edm.Any: DeSerializer<AnyT>

DeSerializer for Edm.Any to the generic type AnyT.

-
Edm.Binary: DeSerializer<BinaryT>

DeSerializer for Edm.Binary to the generic type BinaryT.

-
Edm.Boolean: DeSerializer<BooleanT>

DeSerializer for Edm.Boolean to the generic type BooleanT.

-
Edm.Byte: DeSerializer<ByteT>

DeSerializer for Edm.Byte to the generic type ByteT.

-
Edm.DateTime: DeSerializer<DateTimeT>

DeSerializer for Edm.DateTime to the generic type DateTimeT.

-
Edm.DateTimeOffset: DeSerializer<DateTimeOffsetT>

DeSerializer for Edm.DateTimeOffset to the generic type DateTimeOffsetT.

-
Edm.Decimal: DeSerializer<DecimalT>

DeSerializer for Edm.Decimal to the generic type DecimalT.

-
Edm.Double: DeSerializer<DoubleT>

DeSerializer for Edm.Double to the generic type DoubleT.

-
Edm.Float: DeSerializer<FloatT>

DeSerializer for Edm.Float to the generic type FloatT.

-
Edm.Guid: DeSerializer<GuidT>

DeSerializer for Edm.Guid to the generic type GuidT.

-
Edm.Int16: DeSerializer<Int16T>

DeSerializer for Edm.Int16 to the generic type Int16T.

-
Edm.Int32: DeSerializer<Int32T>

DeSerializer for Edm.Int32 to the generic type Int32T.

-
Edm.Int64: DeSerializer<Int64T>

DeSerializer for Edm.Int64 to the generic type Int64T.

-
Edm.SByte: DeSerializer<SByteT>

DeSerializer for Edm.SByte to the generic type SByteT.

-
Edm.Single: DeSerializer<SingleT>

DeSerializer for Edm.Single to the generic type SingleT.

-
Edm.String: DeSerializer<StringT>

DeSerializer for Edm.String to the generic type StringT.

-
Edm.Time: DeSerializer<TimeT>

DeSerializer for Edm.Time to the generic type TimeT.

+DeSerializers | SAP Cloud SDK for JavaScript - v3.12.0

Interface DeSerializers<BinaryT, BooleanT, ByteT, DecimalT, DoubleT, FloatT, Int16T, Int32T, Int64T, GuidT, SByteT, SingleT, StringT, AnyT, DateTimeT, DateTimeOffsetT, TimeT>

Represents a set of functions that determine (de-)serialization per EDM type.

+

Type Parameters

  • BinaryT = any

  • BooleanT = any

  • ByteT = any

  • DecimalT = any

  • DoubleT = any

  • FloatT = any

  • Int16T = any

  • Int32T = any

  • Int64T = any

  • GuidT = any

  • SByteT = any

  • SingleT = any

  • StringT = any

  • AnyT = any

  • DateTimeT = any

  • DateTimeOffsetT = any

  • TimeT = any

Hierarchy (view full)

Properties

Edm.Any: DeSerializer<AnyT>

DeSerializer for Edm.Any to the generic type AnyT.

+
Edm.Binary: DeSerializer<BinaryT>

DeSerializer for Edm.Binary to the generic type BinaryT.

+
Edm.Boolean: DeSerializer<BooleanT>

DeSerializer for Edm.Boolean to the generic type BooleanT.

+
Edm.Byte: DeSerializer<ByteT>

DeSerializer for Edm.Byte to the generic type ByteT.

+
Edm.DateTime: DeSerializer<DateTimeT>

DeSerializer for Edm.DateTime to the generic type DateTimeT.

+
Edm.DateTimeOffset: DeSerializer<DateTimeOffsetT>

DeSerializer for Edm.DateTimeOffset to the generic type DateTimeOffsetT.

+
Edm.Decimal: DeSerializer<DecimalT>

DeSerializer for Edm.Decimal to the generic type DecimalT.

+
Edm.Double: DeSerializer<DoubleT>

DeSerializer for Edm.Double to the generic type DoubleT.

+
Edm.Float: DeSerializer<FloatT>

DeSerializer for Edm.Float to the generic type FloatT.

+
Edm.Guid: DeSerializer<GuidT>

DeSerializer for Edm.Guid to the generic type GuidT.

+
Edm.Int16: DeSerializer<Int16T>

DeSerializer for Edm.Int16 to the generic type Int16T.

+
Edm.Int32: DeSerializer<Int32T>

DeSerializer for Edm.Int32 to the generic type Int32T.

+
Edm.Int64: DeSerializer<Int64T>

DeSerializer for Edm.Int64 to the generic type Int64T.

+
Edm.SByte: DeSerializer<SByteT>

DeSerializer for Edm.SByte to the generic type SByteT.

+
Edm.Single: DeSerializer<SingleT>

DeSerializer for Edm.Single to the generic type SingleT.

+
Edm.String: DeSerializer<StringT>

DeSerializer for Edm.String to the generic type StringT.

+
Edm.Time: DeSerializer<TimeT>

DeSerializer for Edm.Time to the generic type TimeT.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_v2.ErrorResponse.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_v2.ErrorResponse.html index 76954e6a6a..baa0ce49c8 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_v2.ErrorResponse.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_v2.ErrorResponse.html @@ -1,13 +1,13 @@ -ErrorResponse | SAP Cloud SDK for JavaScript - v3.12.1

Represents an erroneous response to a retrieve or change set request within a batch request.

-
interface ErrorResponse {
    body: Record<string, any>;
    httpCode: number;
    isError: (() => this is ErrorResponse);
    isReadResponse: (() => this is ReadResponseCommon<any>);
    isSuccess: (() => this is ReadResponseCommon<any> | WriteResponsesCommon<any>);
    isWriteResponses: (() => this is WriteResponsesCommon<any>);
    responseType: "ErrorResponse";
}

Hierarchy

  • BatchResponseTypeGuards<any>
    • ErrorResponse

Properties

body: Record<string, any>

HTTP raw body.

-
httpCode: number

HTTP response status code.

-
isError: (() => this is ErrorResponse)

Type declaration

isReadResponse: (() => this is ReadResponseCommon<any>)

Type declaration

isSuccess: (() => this is ReadResponseCommon<any> | WriteResponsesCommon<any>)

Type declaration

isWriteResponses: (() => this is WriteResponsesCommon<any>)

Type declaration

responseType: "ErrorResponse"

Tag for identifying the type of a batch response.

+ErrorResponse | SAP Cloud SDK for JavaScript - v3.12.0

Represents an erroneous response to a retrieve or change set request within a batch request.

+
interface ErrorResponse {
    body: Record<string, any>;
    httpCode: number;
    isError: (() => this is ErrorResponse);
    isReadResponse: (() => this is ReadResponseCommon<any>);
    isSuccess: (() => this is ReadResponseCommon<any> | WriteResponsesCommon<any>);
    isWriteResponses: (() => this is WriteResponsesCommon<any>);
    responseType: "ErrorResponse";
}

Hierarchy

  • BatchResponseTypeGuards<any>
    • ErrorResponse

Properties

body: Record<string, any>

HTTP raw body.

+
httpCode: number

HTTP response status code.

+
isError: (() => this is ErrorResponse)

Type declaration

isReadResponse: (() => this is ReadResponseCommon<any>)

Type declaration

isSuccess: (() => this is ReadResponseCommon<any> | WriteResponsesCommon<any>)

Type declaration

isWriteResponses: (() => this is WriteResponsesCommon<any>)

Type declaration

responseType: "ErrorResponse"

Tag for identifying the type of a batch response.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_v2.ReadResponseCommon.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_v2.ReadResponseCommon.html index 339ff74b1a..90d5115f0e 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_v2.ReadResponseCommon.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_v2.ReadResponseCommon.html @@ -1,19 +1,21 @@ -ReadResponseCommon | SAP Cloud SDK for JavaScript - v3.12.1

Represents a response to a retrieve request within a batch request.

-
interface ReadResponseCommon<DeSerializersT> {
    as: (<EntityT>(entityApi) => EntityT[]);
    body: Record<string, any>;
    httpCode: number;
    isError: (() => this is ErrorResponse);
    isReadResponse: (() => this is ReadResponseCommon<DeSerializersT>);
    isSuccess: (() => this is ReadResponseCommon<DeSerializersT> | WriteResponsesCommon<DeSerializersT>);
    isWriteResponses: (() => this is WriteResponsesCommon<DeSerializersT>);
    responseType: "ReadResponse";
    type: EntityApi<EntityBase, DeSerializersT>;
}

Type Parameters

  • DeSerializersT extends DeSerializers

    Type of the (de-)serializers.

    -

Hierarchy

Properties

as: (<EntityT>(entityApi) => EntityT[])

Transform the raw data into an instance of an entity represented by the given entity API. +ReadResponseCommon | SAP Cloud SDK for JavaScript - v3.12.0

Represents a response to a retrieve request within a batch request.

+
interface ReadResponseCommon<DeSerializersT> {
    as: (<EntityT>(entityApi) => EntityT[]);
    body: Record<string, any>;
    httpCode: number;
    isError: (() => this is ErrorResponse);
    isReadResponse: (() => this is ReadResponseCommon<DeSerializersT>);
    isSuccess: (() => this is ReadResponseCommon<DeSerializersT> | WriteResponsesCommon<DeSerializersT>);
    isWriteResponses: (() => this is WriteResponsesCommon<DeSerializersT>);
    responseType: "ReadResponse";
    type: EntityApi<EntityBase, DeSerializersT>;
}

Type Parameters

  • DeSerializersT extends DeSerializers

    Type of the (de-)serializers.

    +

Hierarchy

Properties

as: (<EntityT>(entityApi) => EntityT[])

Transform the raw data into an instance of an entity represented by the given entity API. Note, this method transforms the raw data to an array of entities, even if the original request was a GetByKeyRequestBuilder.

-

Type declaration

body: Record<string, any>

HTTP raw body.

-
httpCode: number

HTTP response status code.

-
isError: (() => this is ErrorResponse)

Type declaration

isReadResponse: (() => this is ReadResponseCommon<DeSerializersT>)

Type declaration

isWriteResponses: (() => this is WriteResponsesCommon<DeSerializersT>)

Type declaration

responseType: "ReadResponse"

Tag for identifying the type of a batch response.

-

EntityApi of the response data. Can be undefined for function/action imports or not mappable entities.

+

Type declaration

    • <EntityT>(entityApi): EntityT[]
    • Transform the raw data into an instance of an entity represented by the given entity API. +Note, this method transforms the raw data to an array of entities, even if the original request was a GetByKeyRequestBuilder.

      +

      Type Parameters

      Parameters

      Returns EntityT[]

body: Record<string, any>

HTTP raw body.

+
httpCode: number

HTTP response status code.

+
isError: (() => this is ErrorResponse)

Type declaration

isReadResponse: (() => this is ReadResponseCommon<DeSerializersT>)

Type declaration

isWriteResponses: (() => this is WriteResponsesCommon<DeSerializersT>)

Type declaration

responseType: "ReadResponse"

Tag for identifying the type of a batch response.

+

EntityApi of the response data. Can be undefined for function/action imports or not mappable entities.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_v2.WriteResponseCommon.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_v2.WriteResponseCommon.html index 0b6bf846e5..cf5f2514d1 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_v2.WriteResponseCommon.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_v2.WriteResponseCommon.html @@ -1,15 +1,17 @@ -WriteResponseCommon | SAP Cloud SDK for JavaScript - v3.12.1

Represents a single subresponse to a changeset request within a batch request.

-
interface WriteResponseCommon<DeSerializersT> {
    as?: (<EntityT>(entityApi) => EntityT);
    body?: Record<string, any>;
    httpCode: number;
    responseType: "WriteResponse";
    type?: EntityApi<EntityBase, DeSerializersT>;
}

Type Parameters

  • DeSerializersT extends DeSerializers

    Type of the (de-)serializers.

    -

Properties

as?: (<EntityT>(entityApi) => EntityT)

Transform the raw string body into an instance of the given constructor. +WriteResponseCommon | SAP Cloud SDK for JavaScript - v3.12.0

Represents a single subresponse to a changeset request within a batch request.

+
interface WriteResponseCommon<DeSerializersT> {
    as?: (<EntityT>(entityApi) => EntityT);
    body?: Record<string, any>;
    httpCode: number;
    responseType: "WriteResponse";
    type?: EntityApi<EntityBase, DeSerializersT>;
}

Type Parameters

  • DeSerializersT extends DeSerializers

    Type of the (de-)serializers.

    +

Properties

as?: (<EntityT>(entityApi) => EntityT)

Transform the raw string body into an instance of the given constructor. Note that the response may not exist, so you should only call this method if you know that there is data.

-

Type declaration

body?: Record<string, any>

HTTP raw body.

-
httpCode: number

HTTP response status code.

-
responseType: "WriteResponse"

Tag for identifying the type of a batch response.

-

EntityApi of the response data. Can be undefined for function/action imports or not mappable entities.

+

Type declaration

    • <EntityT>(entityApi): EntityT
    • Transform the raw string body into an instance of the given constructor. +Note that the response may not exist, so you should only call this method if you know that there is data.

      +

      Type Parameters

      Parameters

      Returns EntityT

body?: Record<string, any>

HTTP raw body.

+
httpCode: number

HTTP response status code.

+
responseType: "WriteResponse"

Tag for identifying the type of a batch response.

+

EntityApi of the response data. Can be undefined for function/action imports or not mappable entities.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_v2.WriteResponsesCommon.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_v2.WriteResponsesCommon.html index 9a03cb89b6..c84273492e 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_v2.WriteResponsesCommon.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_v2.WriteResponsesCommon.html @@ -1,10 +1,10 @@ -WriteResponsesCommon | SAP Cloud SDK for JavaScript - v3.12.1

Represents the list of responses for a change set in a batch request.

-
interface WriteResponsesCommon<DeSerializersT> {
    isError: (() => this is ErrorResponse);
    isReadResponse: (() => this is ReadResponseCommon<DeSerializersT>);
    isSuccess: (() => this is WriteResponsesCommon<DeSerializersT> | ReadResponseCommon<DeSerializersT>);
    isWriteResponses: (() => this is WriteResponsesCommon<DeSerializersT>);
    responses: WriteResponseCommon<DeSerializersT>[];
}

Type Parameters

  • DeSerializersT extends DeSerializers

    Type of the (de-)serializers.

    -

Hierarchy

Properties

isError: (() => this is ErrorResponse)

Type declaration

isReadResponse: (() => this is ReadResponseCommon<DeSerializersT>)

Type declaration

isWriteResponses: (() => this is WriteResponsesCommon<DeSerializersT>)

Type declaration

List of responses for a change set in a batch request.

+WriteResponsesCommon | SAP Cloud SDK for JavaScript - v3.12.0

Represents the list of responses for a change set in a batch request.

+
interface WriteResponsesCommon<DeSerializersT> {
    isError: (() => this is ErrorResponse);
    isReadResponse: (() => this is ReadResponseCommon<DeSerializersT>);
    isSuccess: (() => this is WriteResponsesCommon<DeSerializersT> | ReadResponseCommon<DeSerializersT>);
    isWriteResponses: (() => this is WriteResponsesCommon<DeSerializersT>);
    responses: WriteResponseCommon<DeSerializersT>[];
}

Type Parameters

  • DeSerializersT extends DeSerializers

    Type of the (de-)serializers.

    +

Hierarchy

Properties

isError: (() => this is ErrorResponse)

Type declaration

isReadResponse: (() => this is ReadResponseCommon<DeSerializersT>)

Type declaration

isWriteResponses: (() => this is WriteResponsesCommon<DeSerializersT>)

Type declaration

List of responses for a change set in a batch request.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_v4.DeSerializers.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_v4.DeSerializers.html index 735ad74f8d..d605609c06 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_v4.DeSerializers.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_odata_v4.DeSerializers.html @@ -1,41 +1,41 @@ -DeSerializers | SAP Cloud SDK for JavaScript - v3.12.1

Interface DeSerializers<BinaryT, BooleanT, ByteT, DecimalT, DoubleT, FloatT, Int16T, Int32T, Int64T, GuidT, SByteT, SingleT, StringT, AnyT, DateT, DateTimeOffsetT, DurationT, TimeOfDayT, EnumT>

Represents a set of functions that determine (de-)serialization per EDM type.

-

Type Parameters

  • BinaryT = any
  • BooleanT = any
  • ByteT = any
  • DecimalT = any
  • DoubleT = any
  • FloatT = any
  • Int16T = any
  • Int32T = any
  • Int64T = any
  • GuidT = any
  • SByteT = any
  • SingleT = any
  • StringT = any
  • AnyT = any
  • DateT = any
  • DateTimeOffsetT = any
  • DurationT = any
  • TimeOfDayT = any
  • EnumT = any

Hierarchy (view full)

Properties

Edm.Any: DeSerializer<AnyT>

DeSerializer for Edm.Any to the generic type AnyT.

-
Edm.Binary: DeSerializer<BinaryT>

DeSerializer for Edm.Binary to the generic type BinaryT.

-
Edm.Boolean: DeSerializer<BooleanT>

DeSerializer for Edm.Boolean to the generic type BooleanT.

-
Edm.Byte: DeSerializer<ByteT>

DeSerializer for Edm.Byte to the generic type ByteT.

-
Edm.Date: DeSerializer<DateT>

DeSerializer for Edm.DateTime to the generic type DateTimeT.

-
Edm.DateTimeOffset: DeSerializer<DateTimeOffsetT>

DeSerializer for Edm.DateTimeOffset to the generic type DateTimeOffsetT.

-
Edm.Decimal: DeSerializer<DecimalT>

DeSerializer for Edm.Decimal to the generic type DecimalT.

-
Edm.Double: DeSerializer<DoubleT>

DeSerializer for Edm.Double to the generic type DoubleT.

-
Edm.Duration: DeSerializer<DurationT>

DeSerializer for Edm.Duration to the generic type DurationT.

-
Edm.Enum: DeSerializer<EnumT>

DeSerializer for Edm.Enum to the generic type EnumT.

-
Edm.Float: DeSerializer<FloatT>

DeSerializer for Edm.Float to the generic type FloatT.

-
Edm.Guid: DeSerializer<GuidT>

DeSerializer for Edm.Guid to the generic type GuidT.

-
Edm.Int16: DeSerializer<Int16T>

DeSerializer for Edm.Int16 to the generic type Int16T.

-
Edm.Int32: DeSerializer<Int32T>

DeSerializer for Edm.Int32 to the generic type Int32T.

-
Edm.Int64: DeSerializer<Int64T>

DeSerializer for Edm.Int64 to the generic type Int64T.

-
Edm.SByte: DeSerializer<SByteT>

DeSerializer for Edm.SByte to the generic type SByteT.

-
Edm.Single: DeSerializer<SingleT>

DeSerializer for Edm.Single to the generic type SingleT.

-
Edm.String: DeSerializer<StringT>

DeSerializer for Edm.String to the generic type StringT.

-
Edm.TimeOfDay: DeSerializer<TimeOfDayT>

DeSerializer for Edm.TimeOfDay to the generic type TimeOfDayT.

+DeSerializers | SAP Cloud SDK for JavaScript - v3.12.0

Interface DeSerializers<BinaryT, BooleanT, ByteT, DecimalT, DoubleT, FloatT, Int16T, Int32T, Int64T, GuidT, SByteT, SingleT, StringT, AnyT, DateT, DateTimeOffsetT, DurationT, TimeOfDayT, EnumT>

Represents a set of functions that determine (de-)serialization per EDM type.

+

Type Parameters

  • BinaryT = any

  • BooleanT = any

  • ByteT = any

  • DecimalT = any

  • DoubleT = any

  • FloatT = any

  • Int16T = any

  • Int32T = any

  • Int64T = any

  • GuidT = any

  • SByteT = any

  • SingleT = any

  • StringT = any

  • AnyT = any

  • DateT = any

  • DateTimeOffsetT = any

  • DurationT = any

  • TimeOfDayT = any

  • EnumT = any

Hierarchy (view full)

Properties

Edm.Any: DeSerializer<AnyT>

DeSerializer for Edm.Any to the generic type AnyT.

+
Edm.Binary: DeSerializer<BinaryT>

DeSerializer for Edm.Binary to the generic type BinaryT.

+
Edm.Boolean: DeSerializer<BooleanT>

DeSerializer for Edm.Boolean to the generic type BooleanT.

+
Edm.Byte: DeSerializer<ByteT>

DeSerializer for Edm.Byte to the generic type ByteT.

+
Edm.Date: DeSerializer<DateT>

DeSerializer for Edm.DateTime to the generic type DateTimeT.

+
Edm.DateTimeOffset: DeSerializer<DateTimeOffsetT>

DeSerializer for Edm.DateTimeOffset to the generic type DateTimeOffsetT.

+
Edm.Decimal: DeSerializer<DecimalT>

DeSerializer for Edm.Decimal to the generic type DecimalT.

+
Edm.Double: DeSerializer<DoubleT>

DeSerializer for Edm.Double to the generic type DoubleT.

+
Edm.Duration: DeSerializer<DurationT>

DeSerializer for Edm.Duration to the generic type DurationT.

+
Edm.Enum: DeSerializer<EnumT>

DeSerializer for Edm.Enum to the generic type EnumT.

+
Edm.Float: DeSerializer<FloatT>

DeSerializer for Edm.Float to the generic type FloatT.

+
Edm.Guid: DeSerializer<GuidT>

DeSerializer for Edm.Guid to the generic type GuidT.

+
Edm.Int16: DeSerializer<Int16T>

DeSerializer for Edm.Int16 to the generic type Int16T.

+
Edm.Int32: DeSerializer<Int32T>

DeSerializer for Edm.Int32 to the generic type Int32T.

+
Edm.Int64: DeSerializer<Int64T>

DeSerializer for Edm.Int64 to the generic type Int64T.

+
Edm.SByte: DeSerializer<SByteT>

DeSerializer for Edm.SByte to the generic type SByteT.

+
Edm.Single: DeSerializer<SingleT>

DeSerializer for Edm.Single to the generic type SingleT.

+
Edm.String: DeSerializer<StringT>

DeSerializer for Edm.String to the generic type StringT.

+
Edm.TimeOfDay: DeSerializer<TimeOfDayT>

DeSerializer for Edm.TimeOfDay to the generic type TimeOfDayT.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_openapi.OpenApiRequestParameters.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_openapi.OpenApiRequestParameters.html index d197af38b9..be0fcee533 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_openapi.OpenApiRequestParameters.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_openapi.OpenApiRequestParameters.html @@ -1,9 +1,9 @@ -OpenApiRequestParameters | SAP Cloud SDK for JavaScript - v3.12.1

Type of the request parameters to be passed to OpenApiRequestBuilder.

-
interface OpenApiRequestParameters {
    body?: any;
    pathParameters?: Record<string, any>;
    queryParameters?: Record<string, any>;
}

Properties

body?: any

Request body typically used with "create" and "update" operations (POST, PUT, PATCH).

-
pathParameters?: Record<string, any>

Collection of path parameters.

-
queryParameters?: Record<string, any>

Collection of query parameters.

+OpenApiRequestParameters | SAP Cloud SDK for JavaScript - v3.12.0

Type of the request parameters to be passed to OpenApiRequestBuilder.

+
interface OpenApiRequestParameters {
    body?: any;
    pathParameters?: Record<string, any>;
    queryParameters?: Record<string, any>;
}

Properties

body?: any

Request body typically used with "create" and "update" operations (POST, PUT, PATCH).

+
pathParameters?: Record<string, any>

Collection of path parameters.

+
queryParameters?: Record<string, any>

Collection of query parameters.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_resilience.MiddlewareContext.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_resilience.MiddlewareContext.html index c8aef8af9a..4d39f97c0b 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_resilience.MiddlewareContext.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_resilience.MiddlewareContext.html @@ -1,7 +1,7 @@ -MiddlewareContext | SAP Cloud SDK for JavaScript - v3.12.1

Minimal Context of the middleware.

-
interface MiddlewareContext<ArgumentT> {
    tenantId: undefined | string;
    uri: string;
}

Type Parameters

  • ArgumentT

Hierarchy (view full)

Properties

Properties

tenantId: undefined | string

Tenant identifier.

-
uri: string

URI of the function passed to the middleware.

+MiddlewareContext | SAP Cloud SDK for JavaScript - v3.12.0

Minimal Context of the middleware.

+
interface MiddlewareContext<ArgumentT> {
    tenantId: undefined | string;
    uri: string;
}

Type Parameters

  • ArgumentT

Hierarchy (view full)

Properties

Properties

tenantId: undefined | string

Tenant identifier.

+
uri: string

URI of the function passed to the middleware.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_resilience.MiddlewareOptions.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_resilience.MiddlewareOptions.html index 835a979c6d..93e6e61fb0 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_resilience.MiddlewareOptions.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_resilience.MiddlewareOptions.html @@ -1,7 +1,7 @@ -MiddlewareOptions | SAP Cloud SDK for JavaScript - v3.12.1

Interface MiddlewareOptions<ArgumentT, ReturnT, ContextT>

Input parameter of a middleware.

-
interface MiddlewareOptions<ArgumentT, ReturnT, ContextT> {
    context: ContextT;
    fn: MiddlewareFunction<ArgumentT, ReturnT>;
}

Type Parameters

Properties

Properties

context: ContextT

Context of the execution e.g. the request context or URL.

-

Initial function enriched by the middleware e.g. axios request getting a timeout.

+MiddlewareOptions | SAP Cloud SDK for JavaScript - v3.12.0

Interface MiddlewareOptions<ArgumentT, ReturnT, ContextT>

Input parameter of a middleware.

+
interface MiddlewareOptions<ArgumentT, ReturnT, ContextT> {
    context: ContextT;
    fn: MiddlewareFunction<ArgumentT, ReturnT>;
}

Type Parameters

Properties

Properties

context: ContextT

Context of the execution e.g. the request context or URL.

+

Initial function enriched by the middleware e.g. axios request getting a timeout.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_resilience.ResilienceOptions.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_resilience.ResilienceOptions.html index b30d1b4343..9ffa987bc1 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_resilience.ResilienceOptions.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_resilience.ResilienceOptions.html @@ -1,14 +1,14 @@ -ResilienceOptions | SAP Cloud SDK for JavaScript - v3.12.1

Interface for Resilience Options.

-
interface ResilienceOptions {
    circuitBreaker?: boolean;
    retry?: number | boolean;
    timeout?: number | boolean;
}

Properties

circuitBreaker?: boolean

Option for circuit breaker middleware. +ResilienceOptions | SAP Cloud SDK for JavaScript - v3.12.0

Interface for Resilience Options.

+
interface ResilienceOptions {
    circuitBreaker?: boolean;
    retry?: number | boolean;
    timeout?: number | boolean;
}

Properties

circuitBreaker?: boolean

Option for circuit breaker middleware. True by default. Set false to disable.

-
retry?: number | boolean

Option for retry middleware. +

retry?: number | boolean

Option for retry middleware. False by default. If set to true, the number of retries is 3. Assign a different value to set custom number of reties.

-
timeout?: number | boolean

Option for timeout middleware. +

timeout?: number | boolean

Option for timeout middleware. True by default, with a 10000 milliseconds timeout. Assign a different value to set a custom timeout.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_test_util.GetTestDestinationOptions.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_test_util.GetTestDestinationOptions.html index 38dab51326..f850585659 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_test_util.GetTestDestinationOptions.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_test_util.GetTestDestinationOptions.html @@ -1,7 +1,7 @@ -GetTestDestinationOptions | SAP Cloud SDK for JavaScript - v3.12.1

An interface to define systems.json and credentials.json for loading destinations.

-
interface GetTestDestinationOptions {
    credentialsFilePath?: string;
    systemsFilePath?: string;
}

Properties

credentialsFilePath?: string

The path of the credentials.json file.

-
systemsFilePath?: string

The path of the systems.json file.

+GetTestDestinationOptions | SAP Cloud SDK for JavaScript - v3.12.0

An interface to define systems.json and credentials.json for loading destinations.

+
interface GetTestDestinationOptions {
    credentialsFilePath?: string;
    systemsFilePath?: string;
}

Properties

credentialsFilePath?: string

The path of the credentials.json file.

+
systemsFilePath?: string

The path of the systems.json file.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_util.LoggerOptions.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_util.LoggerOptions.html index eece0df1ec..f7cec1e04c 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_util.LoggerOptions.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_util.LoggerOptions.html @@ -1,5 +1,5 @@ -LoggerOptions | SAP Cloud SDK for JavaScript - v3.12.1

Configurable logger options.

-
interface LoggerOptions {
    level?: LogLevel;
}

Properties

Properties

level?: LogLevel

The log level of the logger.

+LoggerOptions | SAP Cloud SDK for JavaScript - v3.12.0

Configurable logger options.

+
interface LoggerOptions {
    level?: LogLevel;
}

Properties

Properties

level?: LogLevel

The log level of the logger.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_util.MessageContextObj.html b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_util.MessageContextObj.html index 18a3aac680..c61e6c7d05 100644 --- a/knowledge-base/api-reference/interfaces/sap_cloud_sdk_util.MessageContextObj.html +++ b/knowledge-base/api-reference/interfaces/sap_cloud_sdk_util.MessageContextObj.html @@ -1,5 +1,5 @@ -MessageContextObj | SAP Cloud SDK for JavaScript - v3.12.1

Log message context for a logger with additional custom data.

-
interface MessageContextObj {
    messageContext?: string;
    [key: string]: any;
}

Indexable

[key: string]: any

Properties

Properties

messageContext?: string

Name of the message context.

+MessageContextObj | SAP Cloud SDK for JavaScript - v3.12.0

Log message context for a logger with additional custom data.

+
interface MessageContextObj {
    messageContext?: string;
    [key: string]: any;
}

Indexable

[key: string]: any

Properties

Properties

messageContext?: string

Name of the message context.

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/modules/sap_cloud_sdk_connectivity.html b/knowledge-base/api-reference/modules/sap_cloud_sdk_connectivity.html index 2bb9588d8d..140025c436 100644 --- a/knowledge-base/api-reference/modules/sap_cloud_sdk_connectivity.html +++ b/knowledge-base/api-reference/modules/sap_cloud_sdk_connectivity.html @@ -1,4 +1,4 @@ -@sap-cloud-sdk/connectivity | SAP Cloud SDK for JavaScript - v3.12.1
+@sap-cloud-sdk/connectivity | SAP Cloud SDK for JavaScript - v3.12.0

SAP Cloud SDK for JavaScript Logo

@@ -29,73 +29,73 @@

License

The SAP Cloud SDK is released under the Apache License Version 2.0.

-

Index

Interfaces

Type Aliases

Variables

Functions

Index

Interfaces

Type Aliases

Variables

Functions

\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/modules/sap_cloud_sdk_generator.html b/knowledge-base/api-reference/modules/sap_cloud_sdk_generator.html index c40bbb47e5..98eb620794 100644 --- a/knowledge-base/api-reference/modules/sap_cloud_sdk_generator.html +++ b/knowledge-base/api-reference/modules/sap_cloud_sdk_generator.html @@ -1,4 +1,4 @@ -@sap-cloud-sdk/generator | SAP Cloud SDK for JavaScript - v3.12.1
+@sap-cloud-sdk/generator | SAP Cloud SDK for JavaScript - v3.12.0

SAP Cloud SDK for JavaScript Logo

@@ -34,7 +34,7 @@

License

The SAP Cloud SDK is released under the Apache License Version 2.0.

-

Index

Interfaces

Functions

Index

Interfaces

Functions

generate

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/modules/sap_cloud_sdk_generator_common.html b/knowledge-base/api-reference/modules/sap_cloud_sdk_generator_common.html index 2ed0e3cf84..34bc6345f6 100644 --- a/knowledge-base/api-reference/modules/sap_cloud_sdk_generator_common.html +++ b/knowledge-base/api-reference/modules/sap_cloud_sdk_generator_common.html @@ -1,4 +1,4 @@ -@sap-cloud-sdk/generator-common | SAP Cloud SDK for JavaScript - v3.12.1
+@sap-cloud-sdk/generator-common | SAP Cloud SDK for JavaScript - v3.12.0

SAP Cloud SDK for JavaScript Logo

@@ -25,6 +25,6 @@

License

The SAP Cloud SDK is released under the Apache License Version 2.0.

-

Index

Interfaces

Index

Interfaces

CommonGeneratorOptions

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/modules/sap_cloud_sdk_http_client.html b/knowledge-base/api-reference/modules/sap_cloud_sdk_http_client.html index 29808576b3..65f6b5deac 100644 --- a/knowledge-base/api-reference/modules/sap_cloud_sdk_http_client.html +++ b/knowledge-base/api-reference/modules/sap_cloud_sdk_http_client.html @@ -1,4 +1,4 @@ -@sap-cloud-sdk/http-client | SAP Cloud SDK for JavaScript - v3.12.1
+@sap-cloud-sdk/http-client | SAP Cloud SDK for JavaScript - v3.12.0
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/modules/sap_cloud_sdk_mail_client.html b/knowledge-base/api-reference/modules/sap_cloud_sdk_mail_client.html index c4edb0a29e..266321ae74 100644 --- a/knowledge-base/api-reference/modules/sap_cloud_sdk_mail_client.html +++ b/knowledge-base/api-reference/modules/sap_cloud_sdk_mail_client.html @@ -1,4 +1,4 @@ -@sap-cloud-sdk/mail-client | SAP Cloud SDK for JavaScript - v3.12.1
+@sap-cloud-sdk/mail-client | SAP Cloud SDK for JavaScript - v3.12.0

SAP Cloud SDK for JavaScript Logo

@@ -29,16 +29,16 @@

License

The SAP Cloud SDK is released under the Apache License Version 2.0.

-

Index

Interfaces

Type Aliases

Functions

Index

Interfaces

Type Aliases

Functions

sendMail

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/modules/sap_cloud_sdk_odata_common.html b/knowledge-base/api-reference/modules/sap_cloud_sdk_odata_common.html index e7e6404b5b..2462da5a70 100644 --- a/knowledge-base/api-reference/modules/sap_cloud_sdk_odata_common.html +++ b/knowledge-base/api-reference/modules/sap_cloud_sdk_odata_common.html @@ -1,4 +1,4 @@ -@sap-cloud-sdk/odata-common | SAP Cloud SDK for JavaScript - v3.12.1
+@sap-cloud-sdk/odata-common | SAP Cloud SDK for JavaScript - v3.12.0

SAP Cloud SDK for JavaScript Logo

@@ -26,136 +26,136 @@

License

The SAP Cloud SDK is released under the Apache License Version 2.0.

-

Index

Classes

Interfaces

Type Aliases

Variables

Functions

Index

Classes

Interfaces

Type Aliases

Variables

Functions

\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/modules/sap_cloud_sdk_odata_v2.html b/knowledge-base/api-reference/modules/sap_cloud_sdk_odata_v2.html index dc16c33c3b..7b017678e4 100644 --- a/knowledge-base/api-reference/modules/sap_cloud_sdk_odata_v2.html +++ b/knowledge-base/api-reference/modules/sap_cloud_sdk_odata_v2.html @@ -1,4 +1,4 @@ -@sap-cloud-sdk/odata-v2 | SAP Cloud SDK for JavaScript - v3.12.1
+@sap-cloud-sdk/odata-v2 | SAP Cloud SDK for JavaScript - v3.12.0

SAP Cloud SDK for JavaScript Logo

@@ -24,76 +24,76 @@

License

The SAP Cloud SDK is released under the Apache License Version 2.0.

-

References

Classes

Interfaces

Type Aliases

Variables

Functions

References

Re-exports AllFields
Re-exports BatchChangeSet
Re-exports ComplexTypeField
Re-exports Constructable
Re-exports ConstructorOrField
Renames and re-exports CustomOrDefaultType
Re-exports DeSerializer
Renames and re-exports DeSerializers
Re-exports DeserializedType
Re-exports EdmTypeField
Re-exports EntityApi
Re-exports EntityBase
Re-exports EntityBuilder
Re-exports EntityBuilderType
Re-exports FieldBuilder
Re-exports FieldOptions
Re-exports Link
Re-exports OneToManyLink
Re-exports OneToOneLink
Re-exports OperationParameter
Re-exports OrderableEdmTypeField
Re-exports PropertyMetadata
Re-exports RequestBuilder
Re-exports Time
Re-exports and
Re-exports asc
Re-exports desc
Re-exports entityBuilder
Re-exports not
Re-exports or
Re-exports throwErrorWhenReturnTypeIsUnionType
Re-exports transformVariadicArgumentToArray
\ No newline at end of file +

References

Re-exports AllFields
Re-exports BatchChangeSet
Re-exports ComplexTypeField
Re-exports Constructable
Re-exports ConstructorOrField
Renames and re-exports CustomOrDefaultType
Re-exports DeSerializer
Renames and re-exports DeSerializers
Re-exports DeserializedType
Re-exports EdmTypeField
Re-exports EntityApi
Re-exports EntityBase
Re-exports EntityBuilder
Re-exports EntityBuilderType
Re-exports FieldBuilder
Re-exports FieldOptions
Re-exports Link
Re-exports OneToManyLink
Re-exports OneToOneLink
Re-exports OperationParameter
Re-exports OrderableEdmTypeField
Re-exports PropertyMetadata
Re-exports RequestBuilder
Re-exports Time
Re-exports and
Re-exports asc
Re-exports desc
Re-exports entityBuilder
Re-exports not
Re-exports or
Re-exports throwErrorWhenReturnTypeIsUnionType
Re-exports transformVariadicArgumentToArray
\ No newline at end of file diff --git a/knowledge-base/api-reference/modules/sap_cloud_sdk_odata_v4.html b/knowledge-base/api-reference/modules/sap_cloud_sdk_odata_v4.html index 3d862800a4..aa6c7df608 100644 --- a/knowledge-base/api-reference/modules/sap_cloud_sdk_odata_v4.html +++ b/knowledge-base/api-reference/modules/sap_cloud_sdk_odata_v4.html @@ -1,4 +1,4 @@ -@sap-cloud-sdk/odata-v4 | SAP Cloud SDK for JavaScript - v3.12.1
+@sap-cloud-sdk/odata-v4 | SAP Cloud SDK for JavaScript - v3.12.0

SAP Cloud SDK for JavaScript Logo

@@ -24,95 +24,95 @@

License

The SAP Cloud SDK is released under the Apache License Version 2.0.

-

References

Classes

Interfaces

Type Aliases

Variables

Functions

References

Classes

Interfaces

Type Aliases

Variables

Functions

References

Re-exports AllFields
Re-exports BatchChangeSet
Re-exports CollectionField
Re-exports ComplexTypeField
Re-exports Constructable
Re-exports ConstructorOrField
Renames and re-exports CustomOrDefaultType
Re-exports DeSerializer
Renames and re-exports DeSerializers
Re-exports DeserializedType
Re-exports EdmTypeField
Re-exports EntityApi
Re-exports EntityBase
Re-exports EntityBuilder
Re-exports EntityBuilderType
Re-exports EnumField
Re-exports FieldBuilder
Re-exports FieldOptions
Re-exports Link
Re-exports OneToManyLink
Re-exports OneToOneLink
Re-exports OperationParameter
Re-exports OrderableEdmTypeField
Re-exports PropertyMetadata
Re-exports RequestBuilder
Re-exports Time
Re-exports and
Re-exports asc
Re-exports desc
Re-exports entityBuilder
Re-exports not
Re-exports or
Re-exports throwErrorWhenReturnTypeIsUnionType
Re-exports transformVariadicArgumentToArray
\ No newline at end of file +

References

Re-exports AllFields
Re-exports BatchChangeSet
Re-exports CollectionField
Re-exports ComplexTypeField
Re-exports Constructable
Re-exports ConstructorOrField
Renames and re-exports CustomOrDefaultType
Re-exports DeSerializer
Renames and re-exports DeSerializers
Re-exports DeserializedType
Re-exports EdmTypeField
Re-exports EntityApi
Re-exports EntityBase
Re-exports EntityBuilder
Re-exports EntityBuilderType
Re-exports EnumField
Re-exports FieldBuilder
Re-exports FieldOptions
Re-exports Link
Re-exports OneToManyLink
Re-exports OneToOneLink
Re-exports OperationParameter
Re-exports OrderableEdmTypeField
Re-exports PropertyMetadata
Re-exports RequestBuilder
Re-exports Time
Re-exports and
Re-exports asc
Re-exports desc
Re-exports entityBuilder
Re-exports not
Re-exports or
Re-exports throwErrorWhenReturnTypeIsUnionType
Re-exports transformVariadicArgumentToArray
\ No newline at end of file diff --git a/knowledge-base/api-reference/modules/sap_cloud_sdk_openapi.html b/knowledge-base/api-reference/modules/sap_cloud_sdk_openapi.html index a5fd0a8780..165d93411f 100644 --- a/knowledge-base/api-reference/modules/sap_cloud_sdk_openapi.html +++ b/knowledge-base/api-reference/modules/sap_cloud_sdk_openapi.html @@ -1,4 +1,4 @@ -@sap-cloud-sdk/openapi | SAP Cloud SDK for JavaScript - v3.12.1
+@sap-cloud-sdk/openapi | SAP Cloud SDK for JavaScript - v3.12.0

SAP Cloud SDK for JavaScript Logo

@@ -29,7 +29,7 @@

License

The SAP Cloud SDK is released under the Apache License Version 2.0.

-

Index

Classes

Interfaces

Index

Classes

Interfaces

OpenApiRequestParameters

Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

-
\ No newline at end of file +
\ No newline at end of file diff --git a/knowledge-base/api-reference/modules/sap_cloud_sdk_openapi_generator.html b/knowledge-base/api-reference/modules/sap_cloud_sdk_openapi_generator.html index 4261466dba..ae9cbecab2 100644 --- a/knowledge-base/api-reference/modules/sap_cloud_sdk_openapi_generator.html +++ b/knowledge-base/api-reference/modules/sap_cloud_sdk_openapi_generator.html @@ -1,4 +1,4 @@ -@sap-cloud-sdk/openapi-generator | SAP Cloud SDK for JavaScript - v3.12.1
+@sap-cloud-sdk/openapi-generator | SAP Cloud SDK for JavaScript - v3.12.0

SAP Cloud SDK for JavaScript Logo

@@ -37,7 +37,7 @@
  • Sample repository
  • License

    The SAP Cloud SDK is released under the Apache License Version 2.0.

    -

    Index

    Type Aliases

    Functions

    Index

    Type Aliases

    Functions

    generate

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/modules/sap_cloud_sdk_resilience.html b/knowledge-base/api-reference/modules/sap_cloud_sdk_resilience.html index 02b8f2d0ce..ed494b8896 100644 --- a/knowledge-base/api-reference/modules/sap_cloud_sdk_resilience.html +++ b/knowledge-base/api-reference/modules/sap_cloud_sdk_resilience.html @@ -1,4 +1,4 @@ -@sap-cloud-sdk/resilience | SAP Cloud SDK for JavaScript - v3.12.1
    +@sap-cloud-sdk/resilience | SAP Cloud SDK for JavaScript - v3.12.0

    SAP Cloud SDK for JavaScript Logo

    @@ -31,15 +31,15 @@

    License

    The SAP Cloud SDK is released under the Apache License Version 2.0.

    -

    Index

    Interfaces

    Type Aliases

    Functions

    Index

    Interfaces

    Type Aliases

    Functions

    circuitBreaker +circuitBreakerHttp +resilience +retry +timeout

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/modules/sap_cloud_sdk_temporal_de_serializers.html b/knowledge-base/api-reference/modules/sap_cloud_sdk_temporal_de_serializers.html index dd3a189713..55b37f7aec 100644 --- a/knowledge-base/api-reference/modules/sap_cloud_sdk_temporal_de_serializers.html +++ b/knowledge-base/api-reference/modules/sap_cloud_sdk_temporal_de_serializers.html @@ -1,4 +1,4 @@ -@sap-cloud-sdk/temporal-de-serializers | SAP Cloud SDK for JavaScript - v3.12.1

    Module @sap-cloud-sdk/temporal-de-serializers

    +@sap-cloud-sdk/temporal-de-serializers | SAP Cloud SDK for JavaScript - v3.12.0

    Module @sap-cloud-sdk/temporal-de-serializers

    SAP Cloud SDK for JavaScript Logo

    @@ -29,7 +29,7 @@

    License

    The SAP Cloud SDK is released under the Apache License Version 2.0.

    -

    Index

    Variables

    Index

    Variables

    temporalDeSerializersV2 +temporalDeSerializersV4

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/modules/sap_cloud_sdk_test_util.html b/knowledge-base/api-reference/modules/sap_cloud_sdk_test_util.html index 0706fa5494..876a340680 100644 --- a/knowledge-base/api-reference/modules/sap_cloud_sdk_test_util.html +++ b/knowledge-base/api-reference/modules/sap_cloud_sdk_test_util.html @@ -1,4 +1,4 @@ -@sap-cloud-sdk/test-util | SAP Cloud SDK for JavaScript - v3.12.1
    +@sap-cloud-sdk/test-util | SAP Cloud SDK for JavaScript - v3.12.0
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/modules/sap_cloud_sdk_util.html b/knowledge-base/api-reference/modules/sap_cloud_sdk_util.html index a2a16f8227..e5782b2595 100644 --- a/knowledge-base/api-reference/modules/sap_cloud_sdk_util.html +++ b/knowledge-base/api-reference/modules/sap_cloud_sdk_util.html @@ -1,4 +1,4 @@ -@sap-cloud-sdk/util | SAP Cloud SDK for JavaScript - v3.12.1
    +@sap-cloud-sdk/util | SAP Cloud SDK for JavaScript - v3.12.0

    SAP Cloud SDK for JavaScript Logo

    @@ -31,85 +31,85 @@

    License

    The SAP Cloud SDK is released under the Apache License Version 2.0.

    -

    Index

    Classes

    Interfaces

    Type Aliases

    Variables

    Functions

    Index

    Classes

    Interfaces

    Type Aliases

    Variables

    Functions

    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.AllDestinationOptions.html b/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.AllDestinationOptions.html index 94e29c34ca..1a7a4449c9 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.AllDestinationOptions.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.AllDestinationOptions.html @@ -1,3 +1,3 @@ -AllDestinationOptions | SAP Cloud SDK for JavaScript - v3.12.1
    AllDestinationOptions: Omit<DestinationOptions, "selectionStrategy" | "isolationStrategy">

    Options used to fetch all destinations.

    +AllDestinationOptions | SAP Cloud SDK for JavaScript - v3.12.0
    AllDestinationOptions: Omit<DestinationOptions, "selectionStrategy" | "isolationStrategy">

    Options used to fetch all destinations.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.AuthenticationType.html b/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.AuthenticationType.html index 02f443075d..6a0e44845c 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.AuthenticationType.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.AuthenticationType.html @@ -1,3 +1,3 @@ -AuthenticationType | SAP Cloud SDK for JavaScript - v3.12.1
    AuthenticationType: "PrincipalPropagation" | "NoAuthentication" | "BasicAuthentication" | "SAMLAssertion" | "OAuth2SAMLBearerAssertion" | "OAuth2ClientCredentials" | "OAuth2UserTokenExchange" | "ClientCertificateAuthentication" | "OAuth2JWTBearer" | "OAuth2Password" | "OAuth2RefreshToken"

    Represents the authentication type of a destination.

    +AuthenticationType | SAP Cloud SDK for JavaScript - v3.12.0
    AuthenticationType: "PrincipalPropagation" | "NoAuthentication" | "BasicAuthentication" | "SAMLAssertion" | "OAuth2SAMLBearerAssertion" | "OAuth2ClientCredentials" | "OAuth2UserTokenExchange" | "ClientCertificateAuthentication" | "OAuth2JWTBearer" | "OAuth2Password" | "OAuth2RefreshToken"

    Represents the authentication type of a destination.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.DestinationCacheInterface.html b/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.DestinationCacheInterface.html index 8f763874eb..4cfcbba553 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.DestinationCacheInterface.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.DestinationCacheInterface.html @@ -1,4 +1,4 @@ -DestinationCacheInterface | SAP Cloud SDK for JavaScript - v3.12.1
    DestinationCacheInterface: AsyncCacheInterface<Destination>

    Type to implement custom destination caching. +DestinationCacheInterface | SAP Cloud SDK for JavaScript - v3.12.0

    DestinationCacheInterface: AsyncCacheInterface<Destination>

    Type to implement custom destination caching. To use a custom cache, call setDestinationCache and pass a cache instance that implements this interface.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.DestinationOptions.html b/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.DestinationOptions.html index 9c926b2a51..f8f1c7fd95 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.DestinationOptions.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.DestinationOptions.html @@ -1,3 +1,3 @@ -DestinationOptions | SAP Cloud SDK for JavaScript - v3.12.1

    Options used when fetching destinations. Encompasses DestinationAccessorOptions, DestinationRetrievalOptions and VerifyJwtOptions.

    +DestinationOptions | SAP Cloud SDK for JavaScript - v3.12.0

    Options used when fetching destinations. Encompasses DestinationAccessorOptions, DestinationRetrievalOptions and VerifyJwtOptions.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.DestinationOrFetchOptions.html b/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.DestinationOrFetchOptions.html index 67e02c5ad0..10414b0694 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.DestinationOrFetchOptions.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.DestinationOrFetchOptions.html @@ -1,3 +1,3 @@ -DestinationOrFetchOptions | SAP Cloud SDK for JavaScript - v3.12.1

    Type that is either a HttpDestination or (XOR) & DestinationForServiceBindingOptions.

    +DestinationOrFetchOptions | SAP Cloud SDK for JavaScript - v3.12.0

    Type that is either a HttpDestination or (XOR) & DestinationForServiceBindingOptions.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.DestinationProxyType.html b/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.DestinationProxyType.html index 433c6b7685..61743f86f4 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.DestinationProxyType.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.DestinationProxyType.html @@ -1,3 +1,3 @@ -DestinationProxyType | SAP Cloud SDK for JavaScript - v3.12.1
    DestinationProxyType: "OnPremise" | "Internet" | "PrivateLink" | null

    Represents the proxy type on a destination.

    +DestinationProxyType | SAP Cloud SDK for JavaScript - v3.12.0
    DestinationProxyType: "OnPremise" | "Internet" | "PrivateLink" | null

    Represents the proxy type on a destination.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.DestinationRetrievalOptions.html b/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.DestinationRetrievalOptions.html index 1fcb22a218..90df2f1b02 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.DestinationRetrievalOptions.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.DestinationRetrievalOptions.html @@ -1,8 +1,8 @@ -DestinationRetrievalOptions | SAP Cloud SDK for JavaScript - v3.12.1
    DestinationRetrievalOptions: CachingOptions & {
        isolationStrategy?: IsolationStrategy;
        retry?: boolean;
    }

    Options to use while fetching destinations. Encompasses both CachingOptions and isolation strategy.

    +DestinationRetrievalOptions | SAP Cloud SDK for JavaScript - v3.12.0
    DestinationRetrievalOptions: CachingOptions & {
        isolationStrategy?: IsolationStrategy;
        retry?: boolean;
    }

    Options to use while fetching destinations. Encompasses both CachingOptions and isolation strategy.

    Type declaration

    • Optional isolationStrategy?: IsolationStrategy

      The isolation strategy used for caching destinations. For the available options, see IsolationStrategy. By default, 'tenant-user' is set.

    • Optional retry?: boolean

      The call to destination/{name} sometimes also performs a token exchange. Such calls can be flaky due to an unstable token exchange endpoint. This parameter enables 3 retries on the destination by name calls. By default, the retry is disabled.

      Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.DestinationSelectionStrategy.html b/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.DestinationSelectionStrategy.html index f72f69ba99..e96100de10 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.DestinationSelectionStrategy.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.DestinationSelectionStrategy.html @@ -1,4 +1,4 @@ -DestinationSelectionStrategy | SAP Cloud SDK for JavaScript - v3.12.1
    DestinationSelectionStrategy: ((allDestinations, destinationName) => Destination | null)

    Function to implement the selection strategy of the retrieved destination. +DestinationSelectionStrategy | SAP Cloud SDK for JavaScript - v3.12.0

    DestinationSelectionStrategy: ((allDestinations, destinationName) => Destination | null)

    Function to implement the selection strategy of the retrieved destination. Use the built-in strategies defined in DestinationSelectionStrategies or make your own function.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -

    Type declaration

    \ No newline at end of file +

    Type declaration

    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.DestinationWithName.html b/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.DestinationWithName.html index 7b9e251375..ccfc8839bd 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.DestinationWithName.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.DestinationWithName.html @@ -1,3 +1,3 @@ -DestinationWithName | SAP Cloud SDK for JavaScript - v3.12.1
    DestinationWithName: Destination & {
        name: string;
    }

    Represents a destination with a name property.

    +DestinationWithName | SAP Cloud SDK for JavaScript - v3.12.0
    DestinationWithName: Destination & {
        name: string;
    }

    Represents a destination with a name property.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -

    Type declaration

    • name: string
    \ No newline at end of file +

    Type declaration

    • name: string
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.DestinationWithoutToken.html b/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.DestinationWithoutToken.html index 5f32bbc4b3..03fe932e2a 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.DestinationWithoutToken.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.DestinationWithoutToken.html @@ -1,3 +1,3 @@ -DestinationWithoutToken | SAP Cloud SDK for JavaScript - v3.12.1
    DestinationWithoutToken: Omit<Destination, "authTokens">

    A Destination which does not contain | authTokens.

    +DestinationWithoutToken | SAP Cloud SDK for JavaScript - v3.12.0
    DestinationWithoutToken: Omit<Destination, "authTokens">

    A Destination which does not contain | authTokens.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.HttpDestination.html b/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.HttpDestination.html index 1c9bca1487..0ef9ad7c4d 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.HttpDestination.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.HttpDestination.html @@ -1,3 +1,3 @@ -HttpDestination | SAP Cloud SDK for JavaScript - v3.12.1
    HttpDestination: Destination & {
        url: string;
    }

    Destination for HTTP request where the URL is mandatory.

    +HttpDestination | SAP Cloud SDK for JavaScript - v3.12.0
    HttpDestination: Destination & {
        url: string;
    }

    Destination for HTTP request where the URL is mandatory.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -

    Type declaration

    • url: string
    \ No newline at end of file +

    Type declaration

    • url: string
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.HttpDestinationOrFetchOptions.html b/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.HttpDestinationOrFetchOptions.html index be005ae958..e028bef6eb 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.HttpDestinationOrFetchOptions.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.HttpDestinationOrFetchOptions.html @@ -1,3 +1,3 @@ -HttpDestinationOrFetchOptions | SAP Cloud SDK for JavaScript - v3.12.1

    Type that is either a HttpDestination or (XOR) & DestinationForServiceBindingOptions.

    +HttpDestinationOrFetchOptions | SAP Cloud SDK for JavaScript - v3.12.0

    Type that is either a HttpDestination or (XOR) & DestinationForServiceBindingOptions.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.IsolationStrategy.html b/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.IsolationStrategy.html index b1197f1373..9d65a2722a 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.IsolationStrategy.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.IsolationStrategy.html @@ -1,4 +1,4 @@ -IsolationStrategy | SAP Cloud SDK for JavaScript - v3.12.1
    IsolationStrategy: "tenant" | "tenant-user"

    Represents the isolation strategy in the destination cache. +IsolationStrategy | SAP Cloud SDK for JavaScript - v3.12.0

    IsolationStrategy: "tenant" | "tenant-user"

    Represents the isolation strategy in the destination cache. The available strategies are isolation by tenant or isolation by tenant and user.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.PartialDestinationFetchOptions.html b/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.PartialDestinationFetchOptions.html index f577fca6db..d719e13048 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.PartialDestinationFetchOptions.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.PartialDestinationFetchOptions.html @@ -1,7 +1,7 @@ -PartialDestinationFetchOptions | SAP Cloud SDK for JavaScript - v3.12.1
    PartialDestinationFetchOptions: {
        jwt?: JwtPayload;
    } & CachingOptions

    Type declaration

    • Optional jwt?: JwtPayload

      The JWT used to fetch destinations. +PartialDestinationFetchOptions | SAP Cloud SDK for JavaScript - v3.12.0

      PartialDestinationFetchOptions: {
          jwt?: JwtPayload;
      } & CachingOptions

      Type declaration

      • Optional jwt?: JwtPayload

        The JWT used to fetch destinations. The use of JwtPayload is deprecated since v3.4.0 and will be removed in the next major version update. Use string instead.

      Deprecated

      Since v3.4.0. Use either ServiceBindingTransformOptions or getDestinationFromServiceBinding. Represents partial options to fetch destinations.

      Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

      -
      \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.Protocol.html b/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.Protocol.html index 7129c27ba8..2ffcc929c0 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.Protocol.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.Protocol.html @@ -1,3 +1,3 @@ -Protocol | SAP Cloud SDK for JavaScript - v3.12.1
    Protocol: "http" | "https" | "socks"

    Supported web protocols for requests made by the SAP Cloud SDK.

    +Protocol | SAP Cloud SDK for JavaScript - v3.12.0
    Protocol: "http" | "https" | "socks"

    Supported web protocols for requests made by the SAP Cloud SDK.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.RegisterDestinationOptions.html b/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.RegisterDestinationOptions.html index 3f281d9f9b..001aea49d6 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.RegisterDestinationOptions.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.RegisterDestinationOptions.html @@ -1,3 +1,3 @@ -RegisterDestinationOptions | SAP Cloud SDK for JavaScript - v3.12.1
    RegisterDestinationOptions: Pick<DestinationFetchOptions, "jwt" | "isolationStrategy"> & {
        inferMtls?: boolean;
        useMtlsCache?: boolean;
    }

    Represents options to configure how a destination should be registered.

    +RegisterDestinationOptions | SAP Cloud SDK for JavaScript - v3.12.0
    RegisterDestinationOptions: Pick<DestinationFetchOptions, "jwt" | "isolationStrategy"> & {
        inferMtls?: boolean;
        useMtlsCache?: boolean;
    }

    Represents options to configure how a destination should be registered.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -

    Type declaration

    • Optional inferMtls?: boolean
    • Optional useMtlsCache?: boolean
    \ No newline at end of file +

    Type declaration

    • Optional inferMtls?: boolean
    • Optional useMtlsCache?: boolean
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.ServiceBindingTransformFunction.html b/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.ServiceBindingTransformFunction.html index 21e7eb863a..45b604980c 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.ServiceBindingTransformFunction.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.ServiceBindingTransformFunction.html @@ -1,3 +1,3 @@ -ServiceBindingTransformFunction | SAP Cloud SDK for JavaScript - v3.12.1
    ServiceBindingTransformFunction: ((service, options?) => Promise<Destination>)

    Type of the function to transform the service binding.

    +ServiceBindingTransformFunction | SAP Cloud SDK for JavaScript - v3.12.0
    ServiceBindingTransformFunction: ((service, options?) => Promise<Destination>)

    Type of the function to transform the service binding.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -

    Type declaration

    \ No newline at end of file +

    Type declaration

    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.ServiceBindingTransformOptions.html b/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.ServiceBindingTransformOptions.html index 3285b2fa53..3034cc80d2 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.ServiceBindingTransformOptions.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.ServiceBindingTransformOptions.html @@ -1,4 +1,4 @@ -ServiceBindingTransformOptions | SAP Cloud SDK for JavaScript - v3.12.1
    ServiceBindingTransformOptions: {
        jwt?: JwtPayload;
    } & CachingOptions

    Represents options passed to the service binding transform function.

    +ServiceBindingTransformOptions | SAP Cloud SDK for JavaScript - v3.12.0
    ServiceBindingTransformOptions: {
        jwt?: JwtPayload;
    } & CachingOptions

    Represents options passed to the service binding transform function.

    Type declaration

    • Optional jwt?: JwtPayload

      The JWT payload used to fetch destinations.

      Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

      -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.ServiceCredentials.html b/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.ServiceCredentials.html index 9e2aacd7d2..200813cd78 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.ServiceCredentials.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.ServiceCredentials.html @@ -1,3 +1,3 @@ -ServiceCredentials | SAP Cloud SDK for JavaScript - v3.12.1
    ServiceCredentials: {
        clientid: string;
        [other: string]: any;
    } & ({
        clientsecret: string;
    } | {
        certificate: string;
        key: string;
    })

    Unspecific representation of a service's credentials as read from VCAP_SERVICES (for Cloud Foundry) or mounted secrets (for K8S).

    +ServiceCredentials | SAP Cloud SDK for JavaScript - v3.12.0
    ServiceCredentials: {
        clientid: string;
        [other: string]: any;
    } & ({
        clientsecret: string;
    } | {
        certificate: string;
        key: string;
    })

    Unspecific representation of a service's credentials as read from VCAP_SERVICES (for Cloud Foundry) or mounted secrets (for K8S).

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -

    Type declaration

    • [other: string]: any
    • clientid: string
    \ No newline at end of file +

    Type declaration

    • [other: string]: any
    • clientid: string
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.XsuaaServiceCredentials.html b/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.XsuaaServiceCredentials.html index fbed96edf6..0b2ad4559c 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.XsuaaServiceCredentials.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_connectivity.XsuaaServiceCredentials.html @@ -1,3 +1,3 @@ -XsuaaServiceCredentials | SAP Cloud SDK for JavaScript - v3.12.1
    XsuaaServiceCredentials: ServiceCredentials & {
        identityzone: string;
        identityzoneid: string;
        sburl: string;
        tenantid: string;
        tenantmode: string;
        uaadomain: string;
        url: string;
        verificationkey: string;
        xsappname: string;
    }

    Credentials for the XSUAA service.

    +XsuaaServiceCredentials | SAP Cloud SDK for JavaScript - v3.12.0
    XsuaaServiceCredentials: ServiceCredentials & {
        identityzone: string;
        identityzoneid: string;
        sburl: string;
        tenantid: string;
        tenantmode: string;
        uaadomain: string;
        url: string;
        verificationkey: string;
        xsappname: string;
    }

    Credentials for the XSUAA service.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -

    Type declaration

    • identityzone: string
    • identityzoneid: string
    • sburl: string
    • tenantid: string
    • tenantmode: string
    • uaadomain: string
    • url: string
    • verificationkey: string
    • xsappname: string
    \ No newline at end of file +

    Type declaration

    • identityzone: string
    • identityzoneid: string
    • sburl: string
    • tenantid: string
    • tenantmode: string
    • uaadomain: string
    • url: string
    • verificationkey: string
    • xsappname: string
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_http_client.HttpMiddleware.html b/knowledge-base/api-reference/types/sap_cloud_sdk_http_client.HttpMiddleware.html index 9365f4658b..fa6862ed74 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_http_client.HttpMiddleware.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_http_client.HttpMiddleware.html @@ -1,3 +1,3 @@ -HttpMiddleware | SAP Cloud SDK for JavaScript - v3.12.1

    Middleware for http requests.

    +HttpMiddleware | SAP Cloud SDK for JavaScript - v3.12.0

    Middleware for http requests.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_http_client.HttpMiddlewareOptions.html b/knowledge-base/api-reference/types/sap_cloud_sdk_http_client.HttpMiddlewareOptions.html index 3d231b56b8..30e1d4a06c 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_http_client.HttpMiddlewareOptions.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_http_client.HttpMiddlewareOptions.html @@ -1,3 +1,3 @@ -HttpMiddlewareOptions | SAP Cloud SDK for JavaScript - v3.12.1

    Options for http middleware.

    +HttpMiddlewareOptions | SAP Cloud SDK for JavaScript - v3.12.0

    Options for http middleware.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_http_client.HttpRequestConfig.html b/knowledge-base/api-reference/types/sap_cloud_sdk_http_client.HttpRequestConfig.html index 96e099c8b6..1c15c716a7 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_http_client.HttpRequestConfig.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_http_client.HttpRequestConfig.html @@ -1,3 +1,3 @@ -HttpRequestConfig | SAP Cloud SDK for JavaScript - v3.12.1
    HttpRequestConfig: HttpRequestConfigBase & {
        headers?: Record<string, any>;
        params?: Record<string, any>;
    }

    This interface is compatible with RawAxiosRequestConfig.

    +HttpRequestConfig | SAP Cloud SDK for JavaScript - v3.12.0
    HttpRequestConfig: HttpRequestConfigBase & {
        headers?: Record<string, any>;
        params?: Record<string, any>;
    }

    This interface is compatible with RawAxiosRequestConfig.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -

    Type declaration

    • Optional headers?: Record<string, any>
    • Optional params?: Record<string, any>
    \ No newline at end of file +

    Type declaration

    • Optional headers?: Record<string, any>
    • Optional params?: Record<string, any>
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_http_client.HttpRequestConfigWithOrigin.html b/knowledge-base/api-reference/types/sap_cloud_sdk_http_client.HttpRequestConfigWithOrigin.html index 173cef7c1b..d302cbbf07 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_http_client.HttpRequestConfigWithOrigin.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_http_client.HttpRequestConfigWithOrigin.html @@ -1,4 +1,4 @@ -HttpRequestConfigWithOrigin | SAP Cloud SDK for JavaScript - v3.12.1
    HttpRequestConfigWithOrigin: HttpRequestConfigBase & {
        headers?: OriginOptions;
        params?: OriginOptions;
    }

    This interface is similar to HttpRequestConfig. In addition, the headers and params can be defined with "origin" information.

    +HttpRequestConfigWithOrigin | SAP Cloud SDK for JavaScript - v3.12.0
    HttpRequestConfigWithOrigin: HttpRequestConfigBase & {
        headers?: OriginOptions;
        params?: OriginOptions;
    }

    This interface is similar to HttpRequestConfig. In addition, the headers and params can be defined with "origin" information.

    Type declaration

    See

    OriginOptions

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_http_client.Method.html b/knowledge-base/api-reference/types/sap_cloud_sdk_http_client.Method.html index af32b5b24d..580da91df8 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_http_client.Method.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_http_client.Method.html @@ -1,3 +1,3 @@ -Method | SAP Cloud SDK for JavaScript - v3.12.1
    Method: "get" | "GET" | "delete" | "DELETE" | "head" | "HEAD" | "options" | "OPTIONS" | "post" | "POST" | "put" | "PUT" | "patch" | "PATCH"

    HTTP Methods supported by the http-client.

    +Method | SAP Cloud SDK for JavaScript - v3.12.0
    Method: "get" | "GET" | "delete" | "DELETE" | "head" | "HEAD" | "options" | "OPTIONS" | "post" | "POST" | "put" | "PUT" | "patch" | "PATCH"

    HTTP Methods supported by the http-client.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_http_client.ParameterEncoder.html b/knowledge-base/api-reference/types/sap_cloud_sdk_http_client.ParameterEncoder.html index a599419420..8258e0680d 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_http_client.ParameterEncoder.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_http_client.ParameterEncoder.html @@ -1,3 +1,3 @@ -ParameterEncoder | SAP Cloud SDK for JavaScript - v3.12.1
    ParameterEncoder: ((parameter) => Record<string, any>)

    Type of the parameter encoder.

    +ParameterEncoder | SAP Cloud SDK for JavaScript - v3.12.0
    ParameterEncoder: ((parameter) => Record<string, any>)

    Type of the parameter encoder.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -

    Type declaration

      • (parameter): Record<string, any>
      • Parameters

        • parameter: Record<string, any>

        Returns Record<string, any>

    \ No newline at end of file +

    Type declaration

      • (parameter): Record<string, any>
      • Parameters

        • parameter: Record<string, any>

        Returns Record<string, any>

    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_mail_client.Headers.html b/knowledge-base/api-reference/types/sap_cloud_sdk_mail_client.Headers.html index f6181fe22a..c8490e12a1 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_mail_client.Headers.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_mail_client.Headers.html @@ -1,5 +1,5 @@ -Headers | SAP Cloud SDK for JavaScript - v3.12.1
    Headers: {
        [key: string]: string | string[] | {
            prepared: boolean;
            value: string;
        };
    } | {
        key: string;
        value: string;
    }[]

    Represents an object or array of additional header fields. +Headers | SAP Cloud SDK for JavaScript - v3.12.0

    Headers: {
        [key: string]: string | string[] | {
            prepared: boolean;
            value: string;
        };
    } | {
        key: string;
        value: string;
    }[]

    Represents an object or array of additional header fields. Prepared header values that are not folded or encoded by Nodemailer. This type is compatible with Headers of nodemailer.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -

    Type declaration

    • [key: string]: string | string[] | {
          prepared: boolean;
          value: string;
      }
    \ No newline at end of file +

    Type declaration

    • [key: string]: string | string[] | {
          prepared: boolean;
          value: string;
      }
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.BatchSubRequestPathType.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.BatchSubRequestPathType.html index a5e9f3c9ab..f613030281 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.BatchSubRequestPathType.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.BatchSubRequestPathType.html @@ -1,3 +1,3 @@ -BatchSubRequestPathType | SAP Cloud SDK for JavaScript - v3.12.1
    BatchSubRequestPathType: "absolute" | "relativeToService" | "relativeToEntity" | "noPath"

    The path in the sub request should be serialized as an absolute or relative URL.

    +BatchSubRequestPathType | SAP Cloud SDK for JavaScript - v3.12.0
    BatchSubRequestPathType: "absolute" | "relativeToService" | "relativeToEntity" | "noPath"

    The path in the sub request should be serialized as an absolute or relative URL.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.ChangesetBuilderTypes.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.ChangesetBuilderTypes.html index 1ade14d667..7a056fbcfe 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.ChangesetBuilderTypes.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.ChangesetBuilderTypes.html @@ -1,4 +1,4 @@ -ChangesetBuilderTypes | SAP Cloud SDK for JavaScript - v3.12.1

    Some function imports contain not serializable entities and the execute() method is removed from them. +ChangesetBuilderTypes | SAP Cloud SDK for JavaScript - v3.12.0

    Some function imports contain not serializable entities and the execute() method is removed from them. Since the execute method is not needed in batch the execute it is removed from all function imports.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -

    Type Parameters

    \ No newline at end of file +

    Type Parameters

    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.CollectionFieldType.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.CollectionFieldType.html index 48cf362670..87c2ce4a9d 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.CollectionFieldType.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.CollectionFieldType.html @@ -1,5 +1,5 @@ -CollectionFieldType | SAP Cloud SDK for JavaScript - v3.12.1

    Convenience type to reflect the type of the instances of a collection field. +CollectionFieldType | SAP Cloud SDK for JavaScript - v3.12.0

    Convenience type to reflect the type of the instances of a collection field. The actual type of the elements for complex type collections is ComplexTypeNamespace.

    -

    Type Parameters

    • CollectionFieldT extends EdmTypeShared<"any"> | Record<string, any>

      Type of of elements of the collection. This can either be an EDM type or complex type.

      +

      Type Parameters

      • CollectionFieldT extends EdmTypeShared<"any"> | Record<string, any>

        Type of of elements of the collection. This can either be an EDM type or complex type.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.ComplexTypeFieldConstructor.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.ComplexTypeFieldConstructor.html index 2ccebd7b8d..dd6147cebe 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.ComplexTypeFieldConstructor.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.ComplexTypeFieldConstructor.html @@ -1,3 +1,3 @@ -ComplexTypeFieldConstructor | SAP Cloud SDK for JavaScript - v3.12.1

    Type alias ComplexTypeFieldConstructor<ComplexTypeFieldT, EntityT, DeSerializersT, ComplexT, NullableT, SelectableT>

    ComplexTypeFieldConstructor<ComplexTypeFieldT, EntityT, DeSerializersT, ComplexT, NullableT, SelectableT>: (new (fieldName, fieldOf, deSerializers, fieldOptions?) => ComplexTypeFieldT)

    Constructor function creating a ComplexTypeField.

    +ComplexTypeFieldConstructor | SAP Cloud SDK for JavaScript - v3.12.0

    Type alias ComplexTypeFieldConstructor<ComplexTypeFieldT, EntityT, DeSerializersT, ComplexT, NullableT, SelectableT>

    ComplexTypeFieldConstructor<ComplexTypeFieldT, EntityT, DeSerializersT, ComplexT, NullableT, SelectableT>: (new (fieldName, fieldOf, deSerializers, fieldOptions?) => ComplexTypeFieldT)

    Constructor function creating a ComplexTypeField.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -

    Type Parameters

    Type declaration

    \ No newline at end of file +

    Type Parameters

    Type declaration

    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.ComplexTypePropertyFields.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.ComplexTypePropertyFields.html index 5557f00bb5..59f6fb4865 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.ComplexTypePropertyFields.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.ComplexTypePropertyFields.html @@ -1,4 +1,4 @@ -ComplexTypePropertyFields | SAP Cloud SDK for JavaScript - v3.12.1
    ComplexTypePropertyFields<EntityT>: EdmTypeField<EntityT, any, any, boolean, false> | OrderableEdmTypeField<EntityT, any, any, boolean, false>

    A complex type contains multiple properties. +ComplexTypePropertyFields | SAP Cloud SDK for JavaScript - v3.12.0

    ComplexTypePropertyFields<EntityT>: EdmTypeField<EntityT, any, any, boolean, false> | OrderableEdmTypeField<EntityT, any, any, boolean, false>

    A complex type contains multiple properties. This type represents the possible types of these properties.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -

    Type Parameters

    \ No newline at end of file +

    Type Parameters

    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.ConstructorOrField.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.ConstructorOrField.html index d715ec3572..bc42f21d68 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.ConstructorOrField.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.ConstructorOrField.html @@ -1,3 +1,3 @@ -ConstructorOrField | SAP Cloud SDK for JavaScript - v3.12.1
    ConstructorOrField<EntityT, ComplexT>: Constructable<EntityT> | ComplexTypeField<EntityT, DeSerializers, ComplexT, boolean, boolean>

    Union type to represent the parent of a field. This can either be an entity constructor or a complex type field.

    +ConstructorOrField | SAP Cloud SDK for JavaScript - v3.12.0
    ConstructorOrField<EntityT, ComplexT>: Constructable<EntityT> | ComplexTypeField<EntityT, DeSerializers, ComplexT, boolean, boolean>

    Union type to represent the parent of a field. This can either be an entity constructor or a complex type field.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -

    Type Parameters

    \ No newline at end of file +

    Type Parameters

    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.CustomOrDefaultType.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.CustomOrDefaultType.html index ae2a8411f7..1ad660ac1f 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.CustomOrDefaultType.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.CustomOrDefaultType.html @@ -1,7 +1,7 @@ -CustomOrDefaultType | SAP Cloud SDK for JavaScript - v3.12.1

    Type alias CustomOrDefaultType<CustomDeSerializerT, EdmT, DefaultDeSerializersT>

    CustomOrDefaultType<CustomDeSerializerT, EdmT, DefaultDeSerializersT>: EdmT extends keyof CustomDeSerializerT
        ? CustomDeSerializerT[EdmT] extends DeSerializer<infer CustomT> | undefined
            ? CustomT
            : DeserializedType<DefaultDeSerializersT, EdmT>
        : DeserializedType<DefaultDeSerializersT, EdmT>

    Infers the deserialized type for an EDM type, based on custom (de-)serializers. +CustomOrDefaultType | SAP Cloud SDK for JavaScript - v3.12.0

    Type alias CustomOrDefaultType<CustomDeSerializerT, EdmT, DefaultDeSerializersT>

    CustomOrDefaultType<CustomDeSerializerT, EdmT, DefaultDeSerializersT>: EdmT extends keyof CustomDeSerializerT
        ? CustomDeSerializerT[EdmT] extends DeSerializer<infer CustomT> | undefined
            ? CustomT
            : DeserializedType<DefaultDeSerializersT, EdmT>
        : DeserializedType<DefaultDeSerializersT, EdmT>

    Infers the deserialized type for an EDM type, based on custom (de-)serializers. If the custom (de-)serializers specify a type for the given EDM type, this type is inferred. Otherwise the given DefaultType is used.

    -

    Type Parameters

    • CustomDeSerializerT

      Type of the custom (de-)serializers.

      -
    • EdmT

      The EDM type to infer the type for.

      +

      Type Parameters

      • CustomDeSerializerT

        Type of the custom (de-)serializers.

        +
      • EdmT

        The EDM type to infer the type for.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      • DefaultDeSerializersT extends DefaultDeSerializers
    \ No newline at end of file +
  • DefaultDeSerializersT extends DefaultDeSerializers

  • \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.DefaultDeSerializers.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.DefaultDeSerializers.html index 9f3e0a3c19..4a8fe921e7 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.DefaultDeSerializers.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.DefaultDeSerializers.html @@ -1,3 +1,3 @@ -DefaultDeSerializers | SAP Cloud SDK for JavaScript - v3.12.1
    DefaultDeSerializers: DeSerializers<string, boolean, number, BigNumber, number, number, number, number, BigNumber, string, number, number, string, any>

    Type of the default (de-)serializers.

    +DefaultDeSerializers | SAP Cloud SDK for JavaScript - v3.12.0
    DefaultDeSerializers: DeSerializers<string, boolean, number, BigNumber, number, number, number, number, BigNumber, string, number, number, string, any>

    Type of the default (de-)serializers.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.DeserializedType.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.DeserializedType.html index 46f8ca53f6..c00b6175f7 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.DeserializedType.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.DeserializedType.html @@ -1,5 +1,5 @@ -DeserializedType | SAP Cloud SDK for JavaScript - v3.12.1

    Type alias DeserializedType<DeSerializersT, EdmT>

    DeserializedType<DeSerializersT, EdmT>: EdmT extends keyof DeSerializersT
        ? DeSerializersT[EdmT] extends DeSerializer<infer DeserializedT>
            ? DeserializedT
            : any
        : any

    Infers the deserialized type for an EDM type from the given (de-)serializers type.

    -

    Type Parameters

    • DeSerializersT extends DeSerializers

      Type of the (de-)serializers.

      -
    • EdmT

      Return type of the deserialize function for the given EDM type.

      +DeserializedType | SAP Cloud SDK for JavaScript - v3.12.0

      Type alias DeserializedType<DeSerializersT, EdmT>

      DeserializedType<DeSerializersT, EdmT>: EdmT extends keyof DeSerializersT
          ? DeSerializersT[EdmT] extends DeSerializer<infer DeserializedT>
              ? DeserializedT
              : any
          : any

      Infers the deserialized type for an EDM type from the given (de-)serializers type.

      +

      Type Parameters

      • DeSerializersT extends DeSerializers

        Type of the (de-)serializers.

        +
      • EdmT

        Return type of the deserialize function for the given EDM type.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.EdmTypeCommon.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.EdmTypeCommon.html index 8918ba2006..c3e68f560b 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.EdmTypeCommon.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.EdmTypeCommon.html @@ -1,3 +1,3 @@ -EdmTypeCommon | SAP Cloud SDK for JavaScript - v3.12.1

    Includes all EDM types which are shared between OData version 2 and 4.

    +EdmTypeCommon | SAP Cloud SDK for JavaScript - v3.12.0

    Includes all EDM types which are shared between OData version 2 and 4.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.EdmTypeDifferentConverters.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.EdmTypeDifferentConverters.html index 1461c775ad..a68295fb04 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.EdmTypeDifferentConverters.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.EdmTypeDifferentConverters.html @@ -1,3 +1,3 @@ -EdmTypeDifferentConverters | SAP Cloud SDK for JavaScript - v3.12.1
    EdmTypeDifferentConverters: "Edm.DateTimeOffset"

    Includes all EDM types that have different converters for OData version 2 and 4.

    +EdmTypeDifferentConverters | SAP Cloud SDK for JavaScript - v3.12.0
    EdmTypeDifferentConverters: "Edm.DateTimeOffset"

    Includes all EDM types that have different converters for OData version 2 and 4.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.EdmTypeSameConverters.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.EdmTypeSameConverters.html index 69466d07ee..ab9ec8110e 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.EdmTypeSameConverters.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.EdmTypeSameConverters.html @@ -1,3 +1,3 @@ -EdmTypeSameConverters | SAP Cloud SDK for JavaScript - v3.12.1
    EdmTypeSameConverters: "Edm.String" | "Edm.Boolean" | "Edm.Decimal" | "Edm.Double" | "Edm.Single" | "Edm.Float" | "Edm.Int16" | "Edm.Int32" | "Edm.Int64" | "Edm.SByte" | "Edm.Binary" | "Edm.Guid" | "Edm.Byte" | "Edm.Any"

    PLEASER REVIEW.

    +EdmTypeSameConverters | SAP Cloud SDK for JavaScript - v3.12.0
    EdmTypeSameConverters: "Edm.String" | "Edm.Boolean" | "Edm.Decimal" | "Edm.Double" | "Edm.Single" | "Edm.Float" | "Edm.Int16" | "Edm.Int32" | "Edm.Int64" | "Edm.SByte" | "Edm.Binary" | "Edm.Guid" | "Edm.Byte" | "Edm.Any"

    PLEASER REVIEW.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.EdmTypeShared.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.EdmTypeShared.html index 2ac1ca06b5..64a165e496 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.EdmTypeShared.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.EdmTypeShared.html @@ -1,4 +1,4 @@ -EdmTypeShared | SAP Cloud SDK for JavaScript - v3.12.1

    Represents all valid EDM types for one OData version (either v2 or v4). +EdmTypeShared | SAP Cloud SDK for JavaScript - v3.12.0

    Represents all valid EDM types for one OData version (either v2 or v4). Currently, due to an issue in TypeScript, this includes all valid types for OData v2 and v4.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -

    Type Parameters

    \ No newline at end of file +

    Type Parameters

    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.EntityBuilderType.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.EntityBuilderType.html index fa4e279372..f8e9bef960 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.EntityBuilderType.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.EntityBuilderType.html @@ -1,3 +1,3 @@ -EntityBuilderType | SAP Cloud SDK for JavaScript - v3.12.1

    Type alias EntityBuilderType<EntityT, DeSerializersT>

    EntityBuilderType<EntityT, DeSerializersT>: {
        [property in keyof Required<Omit<EntityT, keyof EntityBase>>]: ((value) => EntityBuilderType<EntityT, DeSerializersT>)
    } & EntityBuilder<EntityT, DeSerializersT>

    Entity builder type with check for EntityT.

    +EntityBuilderType | SAP Cloud SDK for JavaScript - v3.12.0

    Type alias EntityBuilderType<EntityT, DeSerializersT>

    EntityBuilderType<EntityT, DeSerializersT>: {
        [property in keyof Required<Omit<EntityT, keyof EntityBase>>]: ((value) => EntityBuilderType<EntityT, DeSerializersT>)
    } & EntityBuilder<EntityT, DeSerializersT>

    Entity builder type with check for EntityT.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -

    Type Parameters

    \ No newline at end of file +

    Type Parameters

    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.EntityType.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.EntityType.html index 7de83a2817..85b7104b5c 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.EntityType.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.EntityType.html @@ -1,3 +1,3 @@ -EntityType | SAP Cloud SDK for JavaScript - v3.12.1
    EntityType<forExtraction>: forExtraction extends EntityApi<infer EntityT, any>
        ? EntityT
        : never

    Helper type to extract the type of an entity from an API so EntityType<MyPetApi> is Dog.

    +EntityType | SAP Cloud SDK for JavaScript - v3.12.0
    EntityType<forExtraction>: forExtraction extends EntityApi<infer EntityT, any>
        ? EntityT
        : never

    Helper type to extract the type of an entity from an API so EntityType<MyPetApi> is Dog.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -

    Type Parameters

    • forExtraction
    \ No newline at end of file +

    Type Parameters

    • forExtraction

    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.EntityTypeFromFieldOf.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.EntityTypeFromFieldOf.html index 9c7d732e23..16b02acac3 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.EntityTypeFromFieldOf.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.EntityTypeFromFieldOf.html @@ -1,3 +1,3 @@ -EntityTypeFromFieldOf | SAP Cloud SDK for JavaScript - v3.12.1
    EntityTypeFromFieldOf<FieldOfT>: FieldOfT extends ConstructorOrField<infer EntityT>
        ? EntityT
        : never

    Helper type to extract the entity from a field so EntityTypeFromFieldOf<EdmTypeField> is MyEntity.

    +EntityTypeFromFieldOf | SAP Cloud SDK for JavaScript - v3.12.0
    EntityTypeFromFieldOf<FieldOfT>: FieldOfT extends ConstructorOrField<infer EntityT>
        ? EntityT
        : never

    Helper type to extract the entity from a field so EntityTypeFromFieldOf<EdmTypeField> is MyEntity.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -

    Type Parameters

    \ No newline at end of file +

    Type Parameters

    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.ExclusiveEdmTypeV2.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.ExclusiveEdmTypeV2.html index 4f05da14cd..02df9fcc53 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.ExclusiveEdmTypeV2.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.ExclusiveEdmTypeV2.html @@ -1,3 +1,3 @@ -ExclusiveEdmTypeV2 | SAP Cloud SDK for JavaScript - v3.12.1
    ExclusiveEdmTypeV2: "Edm.DateTime" | "Edm.Time"

    Exclusive EDM types for OData v2.

    +ExclusiveEdmTypeV2 | SAP Cloud SDK for JavaScript - v3.12.0
    ExclusiveEdmTypeV2: "Edm.DateTime" | "Edm.Time"

    Exclusive EDM types for OData v2.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.ExclusiveEdmTypeV4.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.ExclusiveEdmTypeV4.html index d0623cc0ac..be09f2f8b3 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.ExclusiveEdmTypeV4.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.ExclusiveEdmTypeV4.html @@ -1,3 +1,3 @@ -ExclusiveEdmTypeV4 | SAP Cloud SDK for JavaScript - v3.12.1
    ExclusiveEdmTypeV4: "Edm.Date" | "Edm.Duration" | "Edm.TimeOfDay" | "Edm.Enum"

    Exclusive EDM types for OData v4.

    +ExclusiveEdmTypeV4 | SAP Cloud SDK for JavaScript - v3.12.0
    ExclusiveEdmTypeV4: "Edm.Date" | "Edm.Duration" | "Edm.TimeOfDay" | "Edm.Enum"

    Exclusive EDM types for OData v4.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.Expandable.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.Expandable.html index 3f2b3a8f18..ed5454c72c 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.Expandable.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.Expandable.html @@ -1,4 +1,4 @@ -Expandable | SAP Cloud SDK for JavaScript - v3.12.1

    Type alias Expandable<EntityT, DeSerializersT, LinkedEntityApiT>

    Represents everything that can be used in an .expand statement. Only relevant for OData v4 requests.

    -

    Type Parameters

    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.FieldTypeByEdmType.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.FieldTypeByEdmType.html index 22c9326d3f..f6c1466bcc 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.FieldTypeByEdmType.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.FieldTypeByEdmType.html @@ -1,5 +1,5 @@ -FieldTypeByEdmType | SAP Cloud SDK for JavaScript - v3.12.1

    Type alias FieldTypeByEdmType<T, EdmT, NullableT>

    Convenience type that maps the given EDM type to a field type. It also considers whether the field is nullable.

    -

    Type Parameters

    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.FilterFunctionParameterType.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.FilterFunctionParameterType.html index 9cf9697c56..db78fef43e 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.FilterFunctionParameterType.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.FilterFunctionParameterType.html @@ -1,3 +1,3 @@ -FilterFunctionParameterType | SAP Cloud SDK for JavaScript - v3.12.1

    Type of a parameter of a filter function. This can either be a primitive type, a reference to a field or another filter function.

    +FilterFunctionParameterType | SAP Cloud SDK for JavaScript - v3.12.0

    Type of a parameter of a filter function. This can either be a primitive type, a reference to a field or another filter function.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -

    Type Parameters

    \ No newline at end of file +

    Type Parameters

    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.FilterFunctionPrimitiveParameterType.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.FilterFunctionPrimitiveParameterType.html index 8a4a3dc6d3..5b119d0f1d 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.FilterFunctionPrimitiveParameterType.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.FilterFunctionPrimitiveParameterType.html @@ -1,3 +1,3 @@ -FilterFunctionPrimitiveParameterType | SAP Cloud SDK for JavaScript - v3.12.1
    FilterFunctionPrimitiveParameterType: number | string | moment.Moment

    Primitive type of a parameter of a filter function.

    +FilterFunctionPrimitiveParameterType | SAP Cloud SDK for JavaScript - v3.12.0
    FilterFunctionPrimitiveParameterType: number | string | moment.Moment

    Primitive type of a parameter of a filter function.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.FilterFunctionTypes.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.FilterFunctionTypes.html index 8b5a8414e0..3b9f0be2d4 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.FilterFunctionTypes.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.FilterFunctionTypes.html @@ -1,3 +1,3 @@ -FilterFunctionTypes | SAP Cloud SDK for JavaScript - v3.12.1
    FilterFunctionTypes: typeof __type | typeof __type | typeof __type | typeof __type | typeof __type | typeof __type | typeof __type | typeof __type | typeof __type | typeof __type | typeof __type | typeof __type | typeof __type | typeof __type | typeof __type | typeof __type | typeof __type | typeof __type | typeof __type

    Union type of all the possible filter functions contained in FilterFunctionsType.

    +FilterFunctionTypes | SAP Cloud SDK for JavaScript - v3.12.0
    FilterFunctionTypes: typeof __type | typeof __type | typeof __type | typeof __type | typeof __type | typeof __type | typeof __type | typeof __type | typeof __type | typeof __type | typeof __type | typeof __type | typeof __type | typeof __type | typeof __type | typeof __type | typeof __type | typeof __type | typeof __type

    Union type of all the possible filter functions contained in FilterFunctionsType.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.FilterLambdaOperator.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.FilterLambdaOperator.html index 4c53ca7811..4383e2cdc5 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.FilterLambdaOperator.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.FilterLambdaOperator.html @@ -1,4 +1,4 @@ -FilterLambdaOperator | SAP Cloud SDK for JavaScript - v3.12.1
    FilterLambdaOperator: "any" | "all"

    Possible operators used to filter one to many relations in OData v4. +FilterLambdaOperator | SAP Cloud SDK for JavaScript - v3.12.0

    FilterLambdaOperator: "any" | "all"

    Possible operators used to filter one to many relations in OData v4. Values are any or all.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.FilterOperator.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.FilterOperator.html index 3f54e3e66d..a495d4bfa0 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.FilterOperator.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.FilterOperator.html @@ -1,3 +1,3 @@ -FilterOperator | SAP Cloud SDK for JavaScript - v3.12.1

    Union type of the filter operators for string, boolean and number types.

    +FilterOperator | SAP Cloud SDK for JavaScript - v3.12.0

    Union type of the filter operators for string, boolean and number types.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.FilterOperatorBoolean.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.FilterOperatorBoolean.html index de5df8f2ed..04f0b9c914 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.FilterOperatorBoolean.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.FilterOperatorBoolean.html @@ -1,4 +1,4 @@ -FilterOperatorBoolean | SAP Cloud SDK for JavaScript - v3.12.1
    FilterOperatorBoolean: "eq" | "ne"

    Union type representing all filter operations for boolean properties. +FilterOperatorBoolean | SAP Cloud SDK for JavaScript - v3.12.0

    FilterOperatorBoolean: "eq" | "ne"

    Union type representing all filter operations for boolean properties. Possible values are eq and ne.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.FilterOperatorNumber.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.FilterOperatorNumber.html index ea2d191659..370045b9bf 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.FilterOperatorNumber.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.FilterOperatorNumber.html @@ -1,3 +1,3 @@ -FilterOperatorNumber | SAP Cloud SDK for JavaScript - v3.12.1
    FilterOperatorNumber: "eq" | "ne" | "lt" | "le" | "gt" | "ge"

    Union type representing all filter operations for number properties like le or gt.

    +FilterOperatorNumber | SAP Cloud SDK for JavaScript - v3.12.0
    FilterOperatorNumber: "eq" | "ne" | "lt" | "le" | "gt" | "ge"

    Union type representing all filter operations for number properties like le or gt.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.FilterOperatorString.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.FilterOperatorString.html index d38a642e72..8aec55d4a8 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.FilterOperatorString.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.FilterOperatorString.html @@ -1,3 +1,3 @@ -FilterOperatorString | SAP Cloud SDK for JavaScript - v3.12.1
    FilterOperatorString: "eq" | "ne" | "lt" | "le" | "gt" | "ge"

    Union type representing all filter operations for string properties like eq or ne.

    +FilterOperatorString | SAP Cloud SDK for JavaScript - v3.12.0
    FilterOperatorString: "eq" | "ne" | "lt" | "le" | "gt" | "ge"

    Union type representing all filter operations for string properties like eq or ne.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.Filterable.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.Filterable.html index 3e03e87a6a..0e89682933 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.Filterable.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.Filterable.html @@ -1,4 +1,4 @@ -Filterable | SAP Cloud SDK for JavaScript - v3.12.1

    Type alias Filterable<EntityT, DeSerializersT, LinkedEntityApiT>

    A union of all types that can be used for filtering.

    -

    Type Parameters

    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.FromJsonType.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.FromJsonType.html index 9d3ac60a0b..7f7471e129 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.FromJsonType.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.FromJsonType.html @@ -1,6 +1,6 @@ -FromJsonType | SAP Cloud SDK for JavaScript - v3.12.1
    FromJsonType<JsonT>: {
        [key: string]: any;
    } & {
        [P in keyof PureEntityType<JsonT>]?: PureEntityType<JsonT>[P] extends (infer U)[] | null | undefined
            ? U extends Record<string, any>
                ? FromJsonType<U>[]
                : PureEntityType<JsonT>[P]
            : PureEntityType<JsonT>[P] extends Record<string, any> | null | undefined
                ? FromJsonType<PureEntityType<JsonT>[P]> | null | undefined
                : PureEntityType<JsonT>[P]
    }

    Type to describe possible inputs for .fromJson. +FromJsonType | SAP Cloud SDK for JavaScript - v3.12.0

    FromJsonType<JsonT>: {
        [key: string]: any;
    } & {
        [P in keyof PureEntityType<JsonT>]?: PureEntityType<JsonT>[P] extends (infer U)[] | null | undefined
            ? U extends Record<string, any>
                ? FromJsonType<U>[]
                : PureEntityType<JsonT>[P]
            : PureEntityType<JsonT>[P] extends Record<string, any> | null | undefined
                ? FromJsonType<PureEntityType<JsonT>[P]> | null | undefined
                : PureEntityType<JsonT>[P]
    }

    Type to describe possible inputs for .fromJson. This is based on the JSON type of an entity and allows all properties to be optional recursively. It also allows setting unknown properties, which will be treated as custom fields.

    -

    Type Parameters

    • JsonT

      JSON type of the entity.

      +

      Type Parameters

      • JsonT

        JSON type of the entity.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -

      Type declaration

      • [key: string]: any
    \ No newline at end of file +

    Type declaration

    • [key: string]: any
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.FunctionImportParameters.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.FunctionImportParameters.html index 61f160f590..685c555ae6 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.FunctionImportParameters.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.FunctionImportParameters.html @@ -1,3 +1,3 @@ -FunctionImportParameters | SAP Cloud SDK for JavaScript - v3.12.1
    FunctionImportParameters<ParametersT>: OperationParameters<ParametersT>

    Type Parameters

    • ParametersT

    Deprecated

    Since 3.3.0. Use OperationParameters instead.

    +FunctionImportParameters | SAP Cloud SDK for JavaScript - v3.12.0
    FunctionImportParameters<ParametersT>: OperationParameters<ParametersT>

    Type Parameters

    • ParametersT

    Deprecated

    Since 3.3.0. Use OperationParameters instead.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.IsSelectableField.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.IsSelectableField.html index 3295f82787..eb3d375fab 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.IsSelectableField.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.IsSelectableField.html @@ -1,4 +1,4 @@ -IsSelectableField | SAP Cloud SDK for JavaScript - v3.12.1
    IsSelectableField<FieldOfT>: FieldOfT extends Constructable<any>
        ? true
        : false

    Convenience type to determine whether a field should be selectable. If the given FieldOfT is the type of an entity, it is selectable.

    -

    Type Parameters

    • FieldOfT extends ConstructorOrField<any>

      Type of the entity or complex type field this field belongs to.

      +IsSelectableField | SAP Cloud SDK for JavaScript - v3.12.0
      IsSelectableField<FieldOfT>: FieldOfT extends Constructable<any>
          ? true
          : false

      Convenience type to determine whether a field should be selectable. If the given FieldOfT is the type of an entity, it is selectable.

      +

      Type Parameters

      • FieldOfT extends ConstructorOrField<any>

        Type of the entity or complex type field this field belongs to.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.NonNullishType.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.NonNullishType.html index 5ac7e8e899..0e572cc12a 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.NonNullishType.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.NonNullishType.html @@ -1,3 +1,3 @@ -NonNullishType | SAP Cloud SDK for JavaScript - v3.12.1
    NonNullishType<T>: Exclude<T, NullishTypes>

    Exclude all nullish types from the given type so NonNullishType<TypeA | TypeB | undefined> is TypeA | TypeB.

    +NonNullishType | SAP Cloud SDK for JavaScript - v3.12.0
    NonNullishType<T>: Exclude<T, NullishTypes>

    Exclude all nullish types from the given type so NonNullishType<TypeA | TypeB | undefined> is TypeA | TypeB.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -

    Type Parameters

    • T
    \ No newline at end of file +

    Type Parameters

    • T

    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.NullableFieldType.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.NullableFieldType.html index 7ff0f94d5a..daab1174c2 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.NullableFieldType.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.NullableFieldType.html @@ -1,5 +1,5 @@ -NullableFieldType | SAP Cloud SDK for JavaScript - v3.12.1
    NullableFieldType<FieldT, NullableT>: NullableT extends true
        ? FieldT | null
        : FieldT

    Convenience type that maps the given field type to a new type that is either nullable or not, depending on the given NullableT.

    -

    Type Parameters

    • FieldT

      Field type of the field.

      -
    • NullableT extends boolean

      Boolean type that represents whether the field is nullable.

      +NullableFieldType | SAP Cloud SDK for JavaScript - v3.12.0
      NullableFieldType<FieldT, NullableT>: NullableT extends true
          ? FieldT | null
          : FieldT

      Convenience type that maps the given field type to a new type that is either nullable or not, depending on the given NullableT.

      +

      Type Parameters

      • FieldT

        Field type of the field.

        +
      • NullableT extends boolean

        Boolean type that represents whether the field is nullable.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
      \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.NullishTypes.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.NullishTypes.html index 1d3cd90a1f..d2eb2a388f 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.NullishTypes.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.NullishTypes.html @@ -1,3 +1,3 @@ -NullishTypes | SAP Cloud SDK for JavaScript - v3.12.1
    NullishTypes: null | undefined

    Union type of null and undefined.

    +NullishTypes | SAP Cloud SDK for JavaScript - v3.12.0
    NullishTypes: null | undefined

    Union type of null and undefined.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.ODataVersionOf.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.ODataVersionOf.html index 7441238b4a..3d8d74fd22 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.ODataVersionOf.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.ODataVersionOf.html @@ -1,3 +1,3 @@ -ODataVersionOf | SAP Cloud SDK for JavaScript - v3.12.1
    ODataVersionOf<T>: T["_oDataVersion"]

    Helper type to extract the @sap-cloud-sdk/util!ODataVersion from a given entity so ODataVersionOf is v2.

    +ODataVersionOf | SAP Cloud SDK for JavaScript - v3.12.0
    ODataVersionOf<T>: T["_oDataVersion"]

    Helper type to extract the @sap-cloud-sdk/util!ODataVersion from a given entity so ODataVersionOf is v2.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -

    Type Parameters

    \ No newline at end of file +

    Type Parameters

    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.OperationParameters.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.OperationParameters.html index 20798550d3..ffbfeac6cb 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.OperationParameters.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.OperationParameters.html @@ -1,4 +1,4 @@ -OperationParameters | SAP Cloud SDK for JavaScript - v3.12.1
    OperationParameters<ParametersT>: {
        [K in keyof ParametersT]: OperationParameter<ParametersT[K]>
    }

    Internal representation of all parameters of an operation as a map.

    -

    Type Parameters

    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.OrderType.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.OrderType.html index a8b65aa7b0..7c56e9a870 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.OrderType.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.OrderType.html @@ -1,3 +1,3 @@ -OrderType | SAP Cloud SDK for JavaScript - v3.12.1
    OrderType: "asc" | "desc"

    Is either ascending or descending.

    +OrderType | SAP Cloud SDK for JavaScript - v3.12.0
    OrderType: "asc" | "desc"

    Is either ascending or descending.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.Orderable.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.Orderable.html index db48e9ebc3..f08fc1f174 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.Orderable.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.Orderable.html @@ -1,4 +1,4 @@ -Orderable | SAP Cloud SDK for JavaScript - v3.12.1

    Type alias Orderable<EntityT, LinkedEntityApiT>

    A union of all types that can be used for ordering.

    -

    Type Parameters

    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.OrderableAndOrderableInput.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.OrderableAndOrderableInput.html index 514b2ca892..9a2e8ba416 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.OrderableAndOrderableInput.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.OrderableAndOrderableInput.html @@ -1,4 +1,4 @@ -OrderableAndOrderableInput | SAP Cloud SDK for JavaScript - v3.12.1

    Type alias OrderableAndOrderableInput<EntityT, DeSerializersT, LinkedEntityApiT, LinkedEntityApiTOptional>

    A union of Orderable and OrderableInput.

    -

    Type Parameters

    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.OrderableEdmType.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.OrderableEdmType.html index 5e8dd4c644..13ece9e14c 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.OrderableEdmType.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.OrderableEdmType.html @@ -1,3 +1,3 @@ -OrderableEdmType | SAP Cloud SDK for JavaScript - v3.12.1
    OrderableEdmType: "Edm.Decimal" | "Edm.Double" | "Edm.Single" | "Edm.Float" | "Edm.Int16" | "Edm.Int32" | "Edm.Int64" | "Edm.SByte" | "Edm.Byte" | "Edm.DateTime" | "Edm.DateTimeOffset" | "Edm.Time" | "Edm.Date" | "Edm.Duration" | "Edm.TimeOfDay" | "Edm.String" | "Edm.Boolean" | "Edm.Guid"

    EDM types that can be compared with greaterThan, greaterOrEqual, lessThan and lessOrEqual.

    +OrderableEdmType | SAP Cloud SDK for JavaScript - v3.12.0
    OrderableEdmType: "Edm.Decimal" | "Edm.Double" | "Edm.Single" | "Edm.Float" | "Edm.Int16" | "Edm.Int32" | "Edm.Int64" | "Edm.SByte" | "Edm.Byte" | "Edm.DateTime" | "Edm.DateTimeOffset" | "Edm.Time" | "Edm.Date" | "Edm.Duration" | "Edm.TimeOfDay" | "Edm.String" | "Edm.Boolean" | "Edm.Guid"

    EDM types that can be compared with greaterThan, greaterOrEqual, lessThan and lessOrEqual.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.OrderableInput.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.OrderableInput.html index 521fbc8206..b7ac3b661d 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.OrderableInput.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.OrderableInput.html @@ -1,4 +1,4 @@ -OrderableInput | SAP Cloud SDK for JavaScript - v3.12.1

    Type alias OrderableInput<EntityT, DeSerializersT, LinkedEntityApiT>

    A union of all types that can be used as input for ordering.

    -

    Type Parameters

    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.PureEntityType.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.PureEntityType.html index 0d17387704..741ba072f2 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.PureEntityType.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.PureEntityType.html @@ -1,3 +1,3 @@ -PureEntityType | SAP Cloud SDK for JavaScript - v3.12.1
    PureEntityType<T>: Omit<NonNullishType<T>, keyof EntityBase>

    Omits all nullish properties as well as all properties of the EntityBase from a given type.

    +PureEntityType | SAP Cloud SDK for JavaScript - v3.12.0
    PureEntityType<T>: Omit<NonNullishType<T>, keyof EntityBase>

    Omits all nullish properties as well as all properties of the EntityBase from a given type.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -

    Type Parameters

    • T
    \ No newline at end of file +

    Type Parameters

    • T

    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.RequestMethodType.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.RequestMethodType.html index 9ff87f1ff9..13aedade7c 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.RequestMethodType.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.RequestMethodType.html @@ -1,3 +1,3 @@ -RequestMethodType | SAP Cloud SDK for JavaScript - v3.12.1
    RequestMethodType: "get" | "post" | "patch" | "delete" | "put"

    Set of possible request methods.

    +RequestMethodType | SAP Cloud SDK for JavaScript - v3.12.0
    RequestMethodType: "get" | "post" | "patch" | "delete" | "put"

    Set of possible request methods.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.Selectable.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.Selectable.html index a14d178a11..1800059032 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.Selectable.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.Selectable.html @@ -1,3 +1,3 @@ -Selectable | SAP Cloud SDK for JavaScript - v3.12.1

    Type alias Selectable<EntityT, DeSerializersT>

    Selectable<EntityT, DeSerializersT>: ODataVersionOf<EntityT> extends "v2"
        ? SimpleTypeFields<EntityT> | Link<EntityT, DeSerializersT, EntityApi<EntityBase, DeSerializersT>> | ComplexTypeField<EntityT, DeSerializersT, any, boolean, boolean> | CustomField<EntityT, any, boolean> | CollectionField<EntityT, DeSerializersT, any, boolean, boolean> | AllFields<EntityT>
        : ODataVersionOf<EntityT> extends "v4"
            ? SimpleTypeFields<EntityT> | ComplexTypeField<EntityT, DeSerializersT, any, boolean, boolean> | CustomField<EntityT, DeSerializersT, boolean> | CollectionField<EntityT, DeSerializersT, any, boolean, boolean> | AllFields<EntityT>
            : never

    Union type of all selectable fields.

    +Selectable | SAP Cloud SDK for JavaScript - v3.12.0

    Type alias Selectable<EntityT, DeSerializersT>

    Selectable<EntityT, DeSerializersT>: ODataVersionOf<EntityT> extends "v2"
        ? SimpleTypeFields<EntityT> | Link<EntityT, DeSerializersT, EntityApi<EntityBase, DeSerializersT>> | ComplexTypeField<EntityT, DeSerializersT, any, boolean, boolean> | CustomField<EntityT, any, boolean> | CollectionField<EntityT, DeSerializersT, any, boolean, boolean> | AllFields<EntityT>
        : ODataVersionOf<EntityT> extends "v4"
            ? SimpleTypeFields<EntityT> | ComplexTypeField<EntityT, DeSerializersT, any, boolean, boolean> | CustomField<EntityT, DeSerializersT, boolean> | CollectionField<EntityT, DeSerializersT, any, boolean, boolean> | AllFields<EntityT>
            : never

    Union type of all selectable fields.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -

    Type Parameters

    \ No newline at end of file +

    Type Parameters

    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.SimpleTypeFields.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.SimpleTypeFields.html index cbe5304d22..a0c3bd4986 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.SimpleTypeFields.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_common.SimpleTypeFields.html @@ -1,3 +1,3 @@ -SimpleTypeFields | SAP Cloud SDK for JavaScript - v3.12.1
    SimpleTypeFields<EntityT>: EdmTypeField<EntityT, any, any, boolean, true> | OrderableEdmTypeField<EntityT, any, any, boolean, true>

    Helper type to unite the EdmTypeField and OrderableEdmTypeField which are appearing often together.

    +SimpleTypeFields | SAP Cloud SDK for JavaScript - v3.12.0
    SimpleTypeFields<EntityT>: EdmTypeField<EntityT, any, any, boolean, true> | OrderableEdmTypeField<EntityT, any, any, boolean, true>

    Helper type to unite the EdmTypeField and OrderableEdmTypeField which are appearing often together.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -

    Type Parameters

    \ No newline at end of file +

    Type Parameters

    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_v2.BatchResponse.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_v2.BatchResponse.html index b08c39b345..8eb9103b90 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_v2.BatchResponse.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_v2.BatchResponse.html @@ -1,3 +1,3 @@ -BatchResponse | SAP Cloud SDK for JavaScript - v3.12.1

    Union of the possible batch responses: ReadResponseCommon, WriteResponsesCommon and @sap-cloud-sdk/odata-common!ErrorResponse.

    +BatchResponse | SAP Cloud SDK for JavaScript - v3.12.0

    Union of the possible batch responses: ReadResponseCommon, WriteResponsesCommon and @sap-cloud-sdk/odata-common!ErrorResponse.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -

    Type Parameters

    \ No newline at end of file +

    Type Parameters

    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_v2.CustomDeSerializers.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_v2.CustomDeSerializers.html index ed859e73a3..c21f376929 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_v2.CustomDeSerializers.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_v2.CustomDeSerializers.html @@ -1,3 +1,3 @@ -CustomDeSerializers | SAP Cloud SDK for JavaScript - v3.12.1
    CustomDeSerializers<T>: DeSerializers<CustomOrDefaultType<T, "Edm.Binary">, CustomOrDefaultType<T, "Edm.Boolean">, CustomOrDefaultType<T, "Edm.Byte">, CustomOrDefaultType<T, "Edm.Decimal">, CustomOrDefaultType<T, "Edm.Double">, CustomOrDefaultType<T, "Edm.Float">, CustomOrDefaultType<T, "Edm.Int16">, CustomOrDefaultType<T, "Edm.Int32">, CustomOrDefaultType<T, "Edm.Int64">, CustomOrDefaultType<T, "Edm.Guid">, CustomOrDefaultType<T, "Edm.SByte">, CustomOrDefaultType<T, "Edm.Single">, CustomOrDefaultType<T, "Edm.String">, CustomOrDefaultType<T, "Edm.Any">, CustomOrDefaultType<T, "Edm.DateTime">, CustomOrDefaultType<T, "Edm.DateTimeOffset">, CustomOrDefaultType<T, "Edm.Time">>

    Type of the full set of (de-)serialization functions, that include custom (de-)serializers (aka. default (de-)serializers type merged with custom (de-)serializers type).

    +CustomDeSerializers | SAP Cloud SDK for JavaScript - v3.12.0
    CustomDeSerializers<T>: DeSerializers<CustomOrDefaultType<T, "Edm.Binary">, CustomOrDefaultType<T, "Edm.Boolean">, CustomOrDefaultType<T, "Edm.Byte">, CustomOrDefaultType<T, "Edm.Decimal">, CustomOrDefaultType<T, "Edm.Double">, CustomOrDefaultType<T, "Edm.Float">, CustomOrDefaultType<T, "Edm.Int16">, CustomOrDefaultType<T, "Edm.Int32">, CustomOrDefaultType<T, "Edm.Int64">, CustomOrDefaultType<T, "Edm.Guid">, CustomOrDefaultType<T, "Edm.SByte">, CustomOrDefaultType<T, "Edm.Single">, CustomOrDefaultType<T, "Edm.String">, CustomOrDefaultType<T, "Edm.Any">, CustomOrDefaultType<T, "Edm.DateTime">, CustomOrDefaultType<T, "Edm.DateTimeOffset">, CustomOrDefaultType<T, "Edm.Time">>

    Type of the full set of (de-)serialization functions, that include custom (de-)serializers (aka. default (de-)serializers type merged with custom (de-)serializers type).

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -

    Type Parameters

    • T
    \ No newline at end of file +

    Type Parameters

    • T

    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_v2.CustomOrDefaultType.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_v2.CustomOrDefaultType.html index 8643b71ddd..4b32cdebf4 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_v2.CustomOrDefaultType.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_v2.CustomOrDefaultType.html @@ -1,7 +1,7 @@ -CustomOrDefaultType | SAP Cloud SDK for JavaScript - v3.12.1

    Type alias CustomOrDefaultType<CustomDeSerializerT, EdmT>

    Infers the deserialized type for an EDM type, based on custom (de-)serializers. +CustomOrDefaultType | SAP Cloud SDK for JavaScript - v3.12.0

    Type alias CustomOrDefaultType<CustomDeSerializerT, EdmT>

    Infers the deserialized type for an EDM type, based on custom (de-)serializers. If the custom (de-)serializers specify a type for the given EDM type, this type is inferred. Otherwise the given DefaultType is used.

    -

    Type Parameters

    • CustomDeSerializerT

      Type of the custom (de-)serializers.

      -
    • EdmT

      The EDM type to infer the type for.

      +

      Type Parameters

      • CustomDeSerializerT

        Type of the custom (de-)serializers.

        +
      • EdmT

        The EDM type to infer the type for.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_v2.DefaultDeSerializers.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_v2.DefaultDeSerializers.html index 4f89fd119a..100fb355b0 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_v2.DefaultDeSerializers.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_v2.DefaultDeSerializers.html @@ -1,3 +1,3 @@ -DefaultDeSerializers | SAP Cloud SDK for JavaScript - v3.12.1
    DefaultDeSerializers: DeSerializers<string, boolean, number, BigNumber, number, number, number, number, BigNumber, string, number, number, string, any, moment.Moment, moment.Moment, Time>

    Type of the default (de-)serializers.

    +DefaultDeSerializers | SAP Cloud SDK for JavaScript - v3.12.0
    DefaultDeSerializers: DeSerializers<string, boolean, number, BigNumber, number, number, number, number, BigNumber, string, number, number, string, any, moment.Moment, moment.Moment, Time>

    Type of the default (de-)serializers.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_v2.FilterFunctionsType.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_v2.FilterFunctionsType.html index e6b948db98..d3840a8e31 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_v2.FilterFunctionsType.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_v2.FilterFunctionsType.html @@ -1,3 +1,3 @@ -FilterFunctionsType | SAP Cloud SDK for JavaScript - v3.12.1
    FilterFunctionsType: FilterFunctionsType & {
        replace: typeof replace;
        substringOf: typeof substringOf;
    }

    Extending the common filter function by the OData v2 specific onessubstringOf and replace.

    +FilterFunctionsType | SAP Cloud SDK for JavaScript - v3.12.0
    FilterFunctionsType: FilterFunctionsType & {
        replace: typeof replace;
        substringOf: typeof substringOf;
    }

    Extending the common filter function by the OData v2 specific onessubstringOf and replace.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -

    Type declaration

    \ No newline at end of file +

    Type declaration

    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_v4.ActionImportParameters.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_v4.ActionImportParameters.html index d7629e3b9e..a520272e87 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_v4.ActionImportParameters.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_v4.ActionImportParameters.html @@ -1,3 +1,3 @@ -ActionImportParameters | SAP Cloud SDK for JavaScript - v3.12.1
    ActionImportParameters<ParametersT>: {
        [K in keyof ParametersT]: ActionImportParameter<ParametersT[K]>
    }

    Type Parameters

    • ParametersT

    Deprecated

    Since 3.3.0. Use OperationParameter instead.

    +ActionImportParameters | SAP Cloud SDK for JavaScript - v3.12.0
    ActionImportParameters<ParametersT>: {
        [K in keyof ParametersT]: ActionImportParameter<ParametersT[K]>
    }

    Type Parameters

    • ParametersT

    Deprecated

    Since 3.3.0. Use OperationParameter instead.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_v4.BatchResponse.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_v4.BatchResponse.html index 432b272ff5..fef4353431 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_v4.BatchResponse.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_v4.BatchResponse.html @@ -1,3 +1,3 @@ -BatchResponse | SAP Cloud SDK for JavaScript - v3.12.1

    Union of the possible batch responses: ReadResponseCommon, WriteResponsesCommon and @sap-cloud-sdk/odata-common!ErrorResponse.

    +BatchResponse | SAP Cloud SDK for JavaScript - v3.12.0

    Union of the possible batch responses: ReadResponseCommon, WriteResponsesCommon and @sap-cloud-sdk/odata-common!ErrorResponse.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -

    Type Parameters

    \ No newline at end of file +

    Type Parameters

    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_v4.CustomDeSerializers.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_v4.CustomDeSerializers.html index b88780db78..55f9497c4f 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_v4.CustomDeSerializers.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_v4.CustomDeSerializers.html @@ -1,3 +1,3 @@ -CustomDeSerializers | SAP Cloud SDK for JavaScript - v3.12.1
    CustomDeSerializers<T>: DeSerializers<CustomOrDefaultType<T, "Edm.Binary">, CustomOrDefaultType<T, "Edm.Boolean">, CustomOrDefaultType<T, "Edm.Byte">, CustomOrDefaultType<T, "Edm.Decimal">, CustomOrDefaultType<T, "Edm.Double">, CustomOrDefaultType<T, "Edm.Float">, CustomOrDefaultType<T, "Edm.Int16">, CustomOrDefaultType<T, "Edm.Int32">, CustomOrDefaultType<T, "Edm.Int64">, CustomOrDefaultType<T, "Edm.Guid">, CustomOrDefaultType<T, "Edm.SByte">, CustomOrDefaultType<T, "Edm.Single">, CustomOrDefaultType<T, "Edm.String">, CustomOrDefaultType<T, "Edm.Any">, CustomOrDefaultType<T, "Edm.DateTime">, CustomOrDefaultType<T, "Edm.DateTimeOffset">, CustomOrDefaultType<T, "Edm.Time">>

    Type of the full set of (de-)serialization functions, that include custom (de-)serializers (aka. default (de-)serializers type merged with custom (de-)serializers type).

    +CustomDeSerializers | SAP Cloud SDK for JavaScript - v3.12.0
    CustomDeSerializers<T>: DeSerializers<CustomOrDefaultType<T, "Edm.Binary">, CustomOrDefaultType<T, "Edm.Boolean">, CustomOrDefaultType<T, "Edm.Byte">, CustomOrDefaultType<T, "Edm.Decimal">, CustomOrDefaultType<T, "Edm.Double">, CustomOrDefaultType<T, "Edm.Float">, CustomOrDefaultType<T, "Edm.Int16">, CustomOrDefaultType<T, "Edm.Int32">, CustomOrDefaultType<T, "Edm.Int64">, CustomOrDefaultType<T, "Edm.Guid">, CustomOrDefaultType<T, "Edm.SByte">, CustomOrDefaultType<T, "Edm.Single">, CustomOrDefaultType<T, "Edm.String">, CustomOrDefaultType<T, "Edm.Any">, CustomOrDefaultType<T, "Edm.DateTime">, CustomOrDefaultType<T, "Edm.DateTimeOffset">, CustomOrDefaultType<T, "Edm.Time">>

    Type of the full set of (de-)serialization functions, that include custom (de-)serializers (aka. default (de-)serializers type merged with custom (de-)serializers type).

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -

    Type Parameters

    • T
    \ No newline at end of file +

    Type Parameters

    • T

    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_v4.CustomOrDefaultType.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_v4.CustomOrDefaultType.html index 51f38ae4ad..87572fc87c 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_v4.CustomOrDefaultType.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_v4.CustomOrDefaultType.html @@ -1,7 +1,7 @@ -CustomOrDefaultType | SAP Cloud SDK for JavaScript - v3.12.1

    Type alias CustomOrDefaultType<CustomDeSerializerT, EdmT>

    Infers the deserialized type for an EDM type, based on custom (de-)serializers. +CustomOrDefaultType | SAP Cloud SDK for JavaScript - v3.12.0

    Type alias CustomOrDefaultType<CustomDeSerializerT, EdmT>

    Infers the deserialized type for an EDM type, based on custom (de-)serializers. If the custom (de-)serializers specify a type for the given EDM type, this type is inferred. Otherwise the given DefaultType is used.

    -

    Type Parameters

    • CustomDeSerializerT

      Type of the custom (de-)serializers.

      -
    • EdmT

      The EDM type to infer the type for.

      +

      Type Parameters

      • CustomDeSerializerT

        Type of the custom (de-)serializers.

        +
      • EdmT

        The EDM type to infer the type for.

        Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

        -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_v4.DefaultDeSerializers.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_v4.DefaultDeSerializers.html index 8ee3a1ee57..fe3889626b 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_v4.DefaultDeSerializers.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_v4.DefaultDeSerializers.html @@ -1,3 +1,3 @@ -DefaultDeSerializers | SAP Cloud SDK for JavaScript - v3.12.1
    DefaultDeSerializers: DeSerializers<string, boolean, number, BigNumber, number, number, number, number, BigNumber, string, number, number, string, any, moment.Moment, moment.Moment, moment.Duration, Time, any>

    Type of the default (de-)serializers.

    +DefaultDeSerializers | SAP Cloud SDK for JavaScript - v3.12.0
    DefaultDeSerializers: DeSerializers<string, boolean, number, BigNumber, number, number, number, number, BigNumber, string, number, number, string, any, moment.Moment, moment.Moment, moment.Duration, Time, any>

    Type of the default (de-)serializers.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_v4.FilterFunctionTypes.html b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_v4.FilterFunctionTypes.html index bcd878daa7..c84f43d533 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_odata_v4.FilterFunctionTypes.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_odata_v4.FilterFunctionTypes.html @@ -1,3 +1,3 @@ -FilterFunctionTypes | SAP Cloud SDK for JavaScript - v3.12.1
    FilterFunctionTypes: FilterFunctionsType & {
        contains: typeof contains;
        fractionalSeconds: typeof fractionalSeconds;
        hasSubsequence: typeof hasSubsequence;
        hasSubset: typeof hasSubset;
        matchesPattern: typeof matchesPattern;
        maxDateTime: typeof maxDateTime;
        minDateTime: typeof minDateTime;
        now: typeof now;
        totalOffsetMinutes: typeof totalOffsetMinutes;
    }

    Extending the common filter function by the OData v4 specification for example contains or matchesPattern.

    +FilterFunctionTypes | SAP Cloud SDK for JavaScript - v3.12.0
    FilterFunctionTypes: FilterFunctionsType & {
        contains: typeof contains;
        fractionalSeconds: typeof fractionalSeconds;
        hasSubsequence: typeof hasSubsequence;
        hasSubset: typeof hasSubset;
        matchesPattern: typeof matchesPattern;
        maxDateTime: typeof maxDateTime;
        minDateTime: typeof minDateTime;
        now: typeof now;
        totalOffsetMinutes: typeof totalOffsetMinutes;
    }

    Extending the common filter function by the OData v4 specification for example contains or matchesPattern.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -

    Type declaration

    \ No newline at end of file +

    Type declaration

    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_openapi_generator.GeneratorOptions.html b/knowledge-base/api-reference/types/sap_cloud_sdk_openapi_generator.GeneratorOptions.html index 72c76d5ac0..7b71611338 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_openapi_generator.GeneratorOptions.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_openapi_generator.GeneratorOptions.html @@ -1,3 +1,3 @@ -GeneratorOptions | SAP Cloud SDK for JavaScript - v3.12.1
    GeneratorOptions: CommonGeneratorOptions

    Options to configure OData client generation when using the generator programmatically.

    +GeneratorOptions | SAP Cloud SDK for JavaScript - v3.12.0
    GeneratorOptions: CommonGeneratorOptions

    Options to configure OData client generation when using the generator programmatically.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_resilience.Middleware.html b/knowledge-base/api-reference/types/sap_cloud_sdk_resilience.Middleware.html index 88124949fe..98833fb268 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_resilience.Middleware.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_resilience.Middleware.html @@ -1,5 +1,5 @@ -Middleware | SAP Cloud SDK for JavaScript - v3.12.1

    Type alias Middleware<ArgumentT, ReturnT, ContextT>

    Middleware type - This function takes some initial function and returns a function. +Middleware | SAP Cloud SDK for JavaScript - v3.12.0

    Type alias Middleware<ArgumentT, ReturnT, ContextT>

    Middleware type - This function takes some initial function and returns a function. The input containing the initial function and some context information e.g. axios request and the request context. It returns a new functions with some additional feature e.g. timeout.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -

    Type Parameters

    \ No newline at end of file +

    Type Parameters

    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_resilience.MiddlewareFunction.html b/knowledge-base/api-reference/types/sap_cloud_sdk_resilience.MiddlewareFunction.html index 8a62ecea22..a228b01114 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_resilience.MiddlewareFunction.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_resilience.MiddlewareFunction.html @@ -1,3 +1,3 @@ -MiddlewareFunction | SAP Cloud SDK for JavaScript - v3.12.1

    Type alias MiddlewareFunction<ArgumentT, ReturnT>

    MiddlewareFunction<ArgumentT, ReturnT>: ((arg) => Promise<ReturnT>)

    Function around which the middlewares are added.

    +MiddlewareFunction | SAP Cloud SDK for JavaScript - v3.12.0

    Type alias MiddlewareFunction<ArgumentT, ReturnT>

    MiddlewareFunction<ArgumentT, ReturnT>: ((arg) => Promise<ReturnT>)

    Function around which the middlewares are added.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -

    Type Parameters

    • ArgumentT
    • ReturnT

    Type declaration

    \ No newline at end of file +

    Type Parameters

    • ArgumentT

    • ReturnT

    Type declaration

    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_util.LogLevel.html b/knowledge-base/api-reference/types/sap_cloud_sdk_util.LogLevel.html index e9694733de..3672b2fd87 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_util.LogLevel.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_util.LogLevel.html @@ -1,3 +1,3 @@ -LogLevel | SAP Cloud SDK for JavaScript - v3.12.1
    LogLevel: "error" | "warn" | "info" | "verbose" | "debug" | "silly"

    Npm log levels used for the SAP Cloud SDK logger.

    +LogLevel | SAP Cloud SDK for JavaScript - v3.12.0
    LogLevel: "error" | "warn" | "info" | "verbose" | "debug" | "silly"

    Npm log levels used for the SAP Cloud SDK logger.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_util.ODataVersion.html b/knowledge-base/api-reference/types/sap_cloud_sdk_util.ODataVersion.html index 5221cfd878..2f951e8a29 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_util.ODataVersion.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_util.ODataVersion.html @@ -1,3 +1,3 @@ -ODataVersion | SAP Cloud SDK for JavaScript - v3.12.1
    ODataVersion: "v2" | "v4"

    Denotes the OData version.

    +ODataVersion | SAP Cloud SDK for JavaScript - v3.12.0
    ODataVersion: "v2" | "v4"

    Denotes the OData version.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_util.Without.html b/knowledge-base/api-reference/types/sap_cloud_sdk_util.Without.html index fec9c9e0b6..40eff20a20 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_util.Without.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_util.Without.html @@ -1,4 +1,4 @@ -Without | SAP Cloud SDK for JavaScript - v3.12.1
    Without<T>: {
        [P in keyof T]?: never
    }

    A type which sets all properties of a generic type to never. +Without | SAP Cloud SDK for JavaScript - v3.12.0

    Without<T>: {
        [P in keyof T]?: never
    }

    A type which sets all properties of a generic type to never. Used in the exclusive or type Xor.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -

    Type Parameters

    • T
    \ No newline at end of file +

    Type Parameters

    • T

    \ No newline at end of file diff --git a/knowledge-base/api-reference/types/sap_cloud_sdk_util.Xor.html b/knowledge-base/api-reference/types/sap_cloud_sdk_util.Xor.html index db602d9609..339a267f73 100644 --- a/knowledge-base/api-reference/types/sap_cloud_sdk_util.Xor.html +++ b/knowledge-base/api-reference/types/sap_cloud_sdk_util.Xor.html @@ -1,4 +1,4 @@ -Xor | SAP Cloud SDK for JavaScript - v3.12.1
    Xor<T, U>: Without<T> & U | Without<U> & T

    XOR of two types containing keys with different names. +Xor | SAP Cloud SDK for JavaScript - v3.12.0

    Xor<T, U>: Without<T> & U | Without<U> & T

    XOR of two types containing keys with different names. If the two types show an overlap the type is never.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -

    Type Parameters

    • T
    • U
    \ No newline at end of file +

    Type Parameters

    • T

    • U

    \ No newline at end of file diff --git a/knowledge-base/api-reference/variables/sap_cloud_sdk_connectivity.DestinationSelectionStrategies.html b/knowledge-base/api-reference/variables/sap_cloud_sdk_connectivity.DestinationSelectionStrategies.html index ad6f7d2897..d3e7c7badf 100644 --- a/knowledge-base/api-reference/variables/sap_cloud_sdk_connectivity.DestinationSelectionStrategies.html +++ b/knowledge-base/api-reference/variables/sap_cloud_sdk_connectivity.DestinationSelectionStrategies.html @@ -1,3 +1,3 @@ -DestinationSelectionStrategies | SAP Cloud SDK for JavaScript - v3.12.1
    DestinationSelectionStrategies: {
        alwaysProvider: typeof alwaysProvider;
        alwaysSubscriber: typeof alwaysSubscriber;
        subscriberFirst: typeof subscriberFirst;
    }

    Selector of destination selection strategies. See alwaysProvider, alwaysSubscriber and subscriberFirst for more information available selection strategies.

    +DestinationSelectionStrategies | SAP Cloud SDK for JavaScript - v3.12.0
    DestinationSelectionStrategies: {
        alwaysProvider: typeof alwaysProvider;
        alwaysSubscriber: typeof alwaysSubscriber;
        subscriberFirst: typeof subscriberFirst;
    }

    Selector of destination selection strategies. See alwaysProvider, alwaysSubscriber and subscriberFirst for more information available selection strategies.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -

    Type declaration

    \ No newline at end of file +

    Type declaration

    \ No newline at end of file diff --git a/knowledge-base/api-reference/variables/sap_cloud_sdk_http_client.defaultDisallowedKeys.html b/knowledge-base/api-reference/variables/sap_cloud_sdk_http_client.defaultDisallowedKeys.html index 132c97b703..db4115a75f 100644 --- a/knowledge-base/api-reference/variables/sap_cloud_sdk_http_client.defaultDisallowedKeys.html +++ b/knowledge-base/api-reference/variables/sap_cloud_sdk_http_client.defaultDisallowedKeys.html @@ -1,3 +1,3 @@ -defaultDisallowedKeys | SAP Cloud SDK for JavaScript - v3.12.1
    defaultDisallowedKeys: string[]

    A list of request config keys that are not allowed to be customized by default.

    +defaultDisallowedKeys | SAP Cloud SDK for JavaScript - v3.12.0
    defaultDisallowedKeys: string[]

    A list of request config keys that are not allowed to be customized by default.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/variables/sap_cloud_sdk_odata_common.ActionFunctionImportRequestBuilderBase.html b/knowledge-base/api-reference/variables/sap_cloud_sdk_odata_common.ActionFunctionImportRequestBuilderBase.html index fff4842bc4..50fa50664c 100644 --- a/knowledge-base/api-reference/variables/sap_cloud_sdk_odata_common.ActionFunctionImportRequestBuilderBase.html +++ b/knowledge-base/api-reference/variables/sap_cloud_sdk_odata_common.ActionFunctionImportRequestBuilderBase.html @@ -1,3 +1,3 @@ -ActionFunctionImportRequestBuilderBase | SAP Cloud SDK for JavaScript - v3.12.1
    ActionFunctionImportRequestBuilderBase: typeof OperationRequestBuilderBase

    Deprecated

    Since 3.3.0. Use OperationRequestBuilderBase instead.

    +ActionFunctionImportRequestBuilderBase | SAP Cloud SDK for JavaScript - v3.12.0
    ActionFunctionImportRequestBuilderBase: typeof OperationRequestBuilderBase

    Deprecated

    Since 3.3.0. Use OperationRequestBuilderBase instead.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/variables/sap_cloud_sdk_odata_common.FunctionImportParameter.html b/knowledge-base/api-reference/variables/sap_cloud_sdk_odata_common.FunctionImportParameter.html index 355090f601..b3af1cbc6f 100644 --- a/knowledge-base/api-reference/variables/sap_cloud_sdk_odata_common.FunctionImportParameter.html +++ b/knowledge-base/api-reference/variables/sap_cloud_sdk_odata_common.FunctionImportParameter.html @@ -1,3 +1,3 @@ -FunctionImportParameter | SAP Cloud SDK for JavaScript - v3.12.1
    FunctionImportParameter: typeof OperationParameter

    Deprecated

    Since 3.3.0. Use OperationParameter instead.

    +FunctionImportParameter | SAP Cloud SDK for JavaScript - v3.12.0
    FunctionImportParameter: typeof OperationParameter

    Deprecated

    Since 3.3.0. Use OperationParameter instead.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/variables/sap_cloud_sdk_odata_common.ODataFunctionImportRequestConfig.html b/knowledge-base/api-reference/variables/sap_cloud_sdk_odata_common.ODataFunctionImportRequestConfig.html index 57fc11555e..b2820d6968 100644 --- a/knowledge-base/api-reference/variables/sap_cloud_sdk_odata_common.ODataFunctionImportRequestConfig.html +++ b/knowledge-base/api-reference/variables/sap_cloud_sdk_odata_common.ODataFunctionImportRequestConfig.html @@ -1,3 +1,3 @@ -ODataFunctionImportRequestConfig | SAP Cloud SDK for JavaScript - v3.12.1
    ODataFunctionImportRequestConfig: typeof ODataFunctionRequestConfig

    Deprecated

    Since 3.3.0. Use ODataFunctionRequestConfig instead.

    +ODataFunctionImportRequestConfig | SAP Cloud SDK for JavaScript - v3.12.0
    ODataFunctionImportRequestConfig: typeof ODataFunctionRequestConfig

    Deprecated

    Since 3.3.0. Use ODataFunctionRequestConfig instead.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/variables/sap_cloud_sdk_odata_v2.FunctionImportRequestBuilder.html b/knowledge-base/api-reference/variables/sap_cloud_sdk_odata_v2.FunctionImportRequestBuilder.html index 01f5ed98ef..cf9130cde5 100644 --- a/knowledge-base/api-reference/variables/sap_cloud_sdk_odata_v2.FunctionImportRequestBuilder.html +++ b/knowledge-base/api-reference/variables/sap_cloud_sdk_odata_v2.FunctionImportRequestBuilder.html @@ -1,3 +1,3 @@ -FunctionImportRequestBuilder | SAP Cloud SDK for JavaScript - v3.12.1
    FunctionImportRequestBuilder: typeof OperationRequestBuilder

    Deprecated

    Since 3.3.0. Use OperationRequestBuilder instead.

    +FunctionImportRequestBuilder | SAP Cloud SDK for JavaScript - v3.12.0
    FunctionImportRequestBuilder: typeof OperationRequestBuilder

    Deprecated

    Since 3.3.0. Use OperationRequestBuilder instead.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/variables/sap_cloud_sdk_odata_v2.ODataFunctionImportRequestConfig.html b/knowledge-base/api-reference/variables/sap_cloud_sdk_odata_v2.ODataFunctionImportRequestConfig.html index f6ef7a3350..408dbd7b1f 100644 --- a/knowledge-base/api-reference/variables/sap_cloud_sdk_odata_v2.ODataFunctionImportRequestConfig.html +++ b/knowledge-base/api-reference/variables/sap_cloud_sdk_odata_v2.ODataFunctionImportRequestConfig.html @@ -1,3 +1,3 @@ -ODataFunctionImportRequestConfig | SAP Cloud SDK for JavaScript - v3.12.1
    ODataFunctionImportRequestConfig: typeof ODataFunctionRequestConfig

    Deprecated

    Since 3.3.0. Use ODataFunctionRequestConfig instead.

    +ODataFunctionImportRequestConfig | SAP Cloud SDK for JavaScript - v3.12.0
    ODataFunctionImportRequestConfig: typeof ODataFunctionRequestConfig

    Deprecated

    Since 3.3.0. Use ODataFunctionRequestConfig instead.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/variables/sap_cloud_sdk_odata_v2.defaultDeSerializers-1.html b/knowledge-base/api-reference/variables/sap_cloud_sdk_odata_v2.defaultDeSerializers-1.html index 1f974cf049..eb1f3306ca 100644 --- a/knowledge-base/api-reference/variables/sap_cloud_sdk_odata_v2.defaultDeSerializers-1.html +++ b/knowledge-base/api-reference/variables/sap_cloud_sdk_odata_v2.defaultDeSerializers-1.html @@ -1,3 +1,3 @@ -defaultDeSerializers | SAP Cloud SDK for JavaScript - v3.12.1
    defaultDeSerializers: DefaultDeSerializers

    The default (de-)serializers.

    +defaultDeSerializers | SAP Cloud SDK for JavaScript - v3.12.0
    defaultDeSerializers: DefaultDeSerializers

    The default (de-)serializers.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/variables/sap_cloud_sdk_odata_v4.ODataActionImportRequestConfig.html b/knowledge-base/api-reference/variables/sap_cloud_sdk_odata_v4.ODataActionImportRequestConfig.html index c14a907278..2ba1bf255d 100644 --- a/knowledge-base/api-reference/variables/sap_cloud_sdk_odata_v4.ODataActionImportRequestConfig.html +++ b/knowledge-base/api-reference/variables/sap_cloud_sdk_odata_v4.ODataActionImportRequestConfig.html @@ -1,3 +1,3 @@ -ODataActionImportRequestConfig | SAP Cloud SDK for JavaScript - v3.12.1
    ODataActionImportRequestConfig: typeof ODataActionRequestConfig

    Deprecated

    Since 3.3.0. Use ODataActionRequestConfig instead.

    +ODataActionImportRequestConfig | SAP Cloud SDK for JavaScript - v3.12.0
    ODataActionImportRequestConfig: typeof ODataActionRequestConfig

    Deprecated

    Since 3.3.0. Use ODataActionRequestConfig instead.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/variables/sap_cloud_sdk_odata_v4.ODataFunctionImportRequestConfig.html b/knowledge-base/api-reference/variables/sap_cloud_sdk_odata_v4.ODataFunctionImportRequestConfig.html index 1bd9c7454a..f2fd794d4b 100644 --- a/knowledge-base/api-reference/variables/sap_cloud_sdk_odata_v4.ODataFunctionImportRequestConfig.html +++ b/knowledge-base/api-reference/variables/sap_cloud_sdk_odata_v4.ODataFunctionImportRequestConfig.html @@ -1,3 +1,3 @@ -ODataFunctionImportRequestConfig | SAP Cloud SDK for JavaScript - v3.12.1
    ODataFunctionImportRequestConfig: typeof ODataFunctionRequestConfig

    Deprecated

    Since 3.3.0. Use ODataFunctionRequestConfig instead.

    +ODataFunctionImportRequestConfig | SAP Cloud SDK for JavaScript - v3.12.0
    ODataFunctionImportRequestConfig: typeof ODataFunctionRequestConfig

    Deprecated

    Since 3.3.0. Use ODataFunctionRequestConfig instead.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/variables/sap_cloud_sdk_odata_v4.OdataBoundFunctionImportRequestConfig.html b/knowledge-base/api-reference/variables/sap_cloud_sdk_odata_v4.OdataBoundFunctionImportRequestConfig.html index 6ebbe5fe59..b5d2c42766 100644 --- a/knowledge-base/api-reference/variables/sap_cloud_sdk_odata_v4.OdataBoundFunctionImportRequestConfig.html +++ b/knowledge-base/api-reference/variables/sap_cloud_sdk_odata_v4.OdataBoundFunctionImportRequestConfig.html @@ -1,3 +1,3 @@ -OdataBoundFunctionImportRequestConfig | SAP Cloud SDK for JavaScript - v3.12.1
    OdataBoundFunctionImportRequestConfig: typeof ODataBoundFunctionRequestConfig

    Deprecated

    Since 3.3.0. Use ODataBoundFunctionRequestConfig instead.

    +OdataBoundFunctionImportRequestConfig | SAP Cloud SDK for JavaScript - v3.12.0
    OdataBoundFunctionImportRequestConfig: typeof ODataBoundFunctionRequestConfig

    Deprecated

    Since 3.3.0. Use ODataBoundFunctionRequestConfig instead.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/variables/sap_cloud_sdk_odata_v4.defaultDeSerializers-1.html b/knowledge-base/api-reference/variables/sap_cloud_sdk_odata_v4.defaultDeSerializers-1.html index b7e588567f..bd7b6cdeb2 100644 --- a/knowledge-base/api-reference/variables/sap_cloud_sdk_odata_v4.defaultDeSerializers-1.html +++ b/knowledge-base/api-reference/variables/sap_cloud_sdk_odata_v4.defaultDeSerializers-1.html @@ -1,3 +1,3 @@ -defaultDeSerializers | SAP Cloud SDK for JavaScript - v3.12.1
    defaultDeSerializers: DefaultDeSerializers

    The default (de-)serializers.

    +defaultDeSerializers | SAP Cloud SDK for JavaScript - v3.12.0
    defaultDeSerializers: DefaultDeSerializers

    The default (de-)serializers.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/variables/sap_cloud_sdk_temporal_de_serializers.temporalDeSerializersV2.html b/knowledge-base/api-reference/variables/sap_cloud_sdk_temporal_de_serializers.temporalDeSerializersV2.html index cbc95aebf5..e47fcf0045 100644 --- a/knowledge-base/api-reference/variables/sap_cloud_sdk_temporal_de_serializers.temporalDeSerializersV2.html +++ b/knowledge-base/api-reference/variables/sap_cloud_sdk_temporal_de_serializers.temporalDeSerializersV2.html @@ -1,3 +1,3 @@ -temporalDeSerializersV2 | SAP Cloud SDK for JavaScript - v3.12.1
    temporalDeSerializersV2: {
        Edm.DateTime: DeSerializer<Temporal.PlainDateTime>;
        Edm.DateTimeOffset: DeSerializer<Temporal.ZonedDateTime>;
        Edm.Time: DeSerializer<Temporal.PlainTime>;
    }

    Temporal (de-)serializers for Odata-v2.

    +temporalDeSerializersV2 | SAP Cloud SDK for JavaScript - v3.12.0
    temporalDeSerializersV2: {
        Edm.DateTime: DeSerializer<Temporal.PlainDateTime>;
        Edm.DateTimeOffset: DeSerializer<Temporal.ZonedDateTime>;
        Edm.Time: DeSerializer<Temporal.PlainTime>;
    }

    Temporal (de-)serializers for Odata-v2.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -

    Type declaration

    \ No newline at end of file +

    Type declaration

    \ No newline at end of file diff --git a/knowledge-base/api-reference/variables/sap_cloud_sdk_temporal_de_serializers.temporalDeSerializersV4.html b/knowledge-base/api-reference/variables/sap_cloud_sdk_temporal_de_serializers.temporalDeSerializersV4.html index 3af4865ec6..f701678941 100644 --- a/knowledge-base/api-reference/variables/sap_cloud_sdk_temporal_de_serializers.temporalDeSerializersV4.html +++ b/knowledge-base/api-reference/variables/sap_cloud_sdk_temporal_de_serializers.temporalDeSerializersV4.html @@ -1,3 +1,3 @@ -temporalDeSerializersV4 | SAP Cloud SDK for JavaScript - v3.12.1
    temporalDeSerializersV4: {
        Edm.Date: DeSerializer<Temporal.PlainDate>;
        Edm.DateTimeOffset: DeSerializer<Temporal.ZonedDateTime>;
        Edm.Duration: DeSerializer<Temporal.Duration>;
        Edm.TimeOfDay: DeSerializer<Temporal.PlainTime>;
    }

    Temporal (de-)serializers for Odata-v4.

    +temporalDeSerializersV4 | SAP Cloud SDK for JavaScript - v3.12.0
    temporalDeSerializersV4: {
        Edm.Date: DeSerializer<Temporal.PlainDate>;
        Edm.DateTimeOffset: DeSerializer<Temporal.ZonedDateTime>;
        Edm.Duration: DeSerializer<Temporal.Duration>;
        Edm.TimeOfDay: DeSerializer<Temporal.PlainTime>;
    }

    Temporal (de-)serializers for Odata-v4.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -

    Type declaration

    \ No newline at end of file +

    Type declaration

    \ No newline at end of file diff --git a/knowledge-base/api-reference/variables/sap_cloud_sdk_util.cloudSdkExceptionLogger.html b/knowledge-base/api-reference/variables/sap_cloud_sdk_util.cloudSdkExceptionLogger.html index b940a52710..43cd987820 100644 --- a/knowledge-base/api-reference/variables/sap_cloud_sdk_util.cloudSdkExceptionLogger.html +++ b/knowledge-base/api-reference/variables/sap_cloud_sdk_util.cloudSdkExceptionLogger.html @@ -1,3 +1,3 @@ -cloudSdkExceptionLogger | SAP Cloud SDK for JavaScript - v3.12.1
    cloudSdkExceptionLogger: Logger

    Default logger for the SAP Cloud SDK for unhandled exceptions.

    +cloudSdkExceptionLogger | SAP Cloud SDK for JavaScript - v3.12.0
    cloudSdkExceptionLogger: Logger

    Default logger for the SAP Cloud SDK for unhandled exceptions.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/variables/sap_cloud_sdk_util.kibana.html b/knowledge-base/api-reference/variables/sap_cloud_sdk_util.kibana.html index b3841e18ff..be54c8ad3b 100644 --- a/knowledge-base/api-reference/variables/sap_cloud_sdk_util.kibana.html +++ b/knowledge-base/api-reference/variables/sap_cloud_sdk_util.kibana.html @@ -1,3 +1,3 @@ -kibana | SAP Cloud SDK for JavaScript - v3.12.1
    kibana: Format

    Format for logging in Kibana.

    +kibana | SAP Cloud SDK for JavaScript - v3.12.0
    kibana: Format

    Format for logging in Kibana.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/variables/sap_cloud_sdk_util.local.html b/knowledge-base/api-reference/variables/sap_cloud_sdk_util.local.html index d99d51955e..6e76a08654 100644 --- a/knowledge-base/api-reference/variables/sap_cloud_sdk_util.local.html +++ b/knowledge-base/api-reference/variables/sap_cloud_sdk_util.local.html @@ -1,3 +1,3 @@ -local | SAP Cloud SDK for JavaScript - v3.12.1
    local: Format

    Format for local logging.

    +local | SAP Cloud SDK for JavaScript - v3.12.0
    local: Format

    Format for local logging.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/variables/sap_cloud_sdk_util.logFormat.html b/knowledge-base/api-reference/variables/sap_cloud_sdk_util.logFormat.html index a9cec8ec66..eb6baf7c35 100644 --- a/knowledge-base/api-reference/variables/sap_cloud_sdk_util.logFormat.html +++ b/knowledge-base/api-reference/variables/sap_cloud_sdk_util.logFormat.html @@ -1,3 +1,3 @@ -logFormat | SAP Cloud SDK for JavaScript - v3.12.1
    logFormat: {
        kibana: Format;
        local: Format;
    }

    Log formats provided by the util package.

    +logFormat | SAP Cloud SDK for JavaScript - v3.12.0
    logFormat: {
        kibana: Format;
        local: Format;
    }

    Log formats provided by the util package.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -

    Type declaration

    • kibana: Format
    • local: Format
    \ No newline at end of file +

    Type declaration

    • kibana: Format
    • local: Format
    \ No newline at end of file diff --git a/knowledge-base/api-reference/variables/sap_cloud_sdk_util.unixEOL.html b/knowledge-base/api-reference/variables/sap_cloud_sdk_util.unixEOL.html index 6bbf2a29c4..1b2cd6973a 100644 --- a/knowledge-base/api-reference/variables/sap_cloud_sdk_util.unixEOL.html +++ b/knowledge-base/api-reference/variables/sap_cloud_sdk_util.unixEOL.html @@ -1,5 +1,5 @@ -unixEOL | SAP Cloud SDK for JavaScript - v3.12.1
    unixEOL: "\n" = "\n"

    Within all files generated by the SDK we use the unix style end of line delimiter. +unixEOL | SAP Cloud SDK for JavaScript - v3.12.0

    unixEOL: "\n" = "\n"

    Within all files generated by the SDK we use the unix style end of line delimiter. We do not consider if the generator is executed on windows or unix systems. It will always be \n to have consistent clients between operating systems.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/knowledge-base/api-reference/variables/sap_cloud_sdk_util.webEOL.html b/knowledge-base/api-reference/variables/sap_cloud_sdk_util.webEOL.html index 8d90068d53..eb522605dd 100644 --- a/knowledge-base/api-reference/variables/sap_cloud_sdk_util.webEOL.html +++ b/knowledge-base/api-reference/variables/sap_cloud_sdk_util.webEOL.html @@ -1,3 +1,3 @@ -webEOL | SAP Cloud SDK for JavaScript - v3.12.1
    webEOL: "\r\n" = "\r\n"

    For request payloads, etc., it is convention to use the \r\n new line.

    +webEOL | SAP Cloud SDK for JavaScript - v3.12.0
    webEOL: "\r\n" = "\r\n"

    For request payloads, etc., it is convention to use the \r\n new line.

    Copyright Ⓒ 2024 SAP SE or an SAP affiliate company. All rights reserved.

    -
    \ No newline at end of file +
    \ No newline at end of file diff --git a/package.json b/package.json index db7a53d8df..a34d15931b 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "sap-cloud-sdk", - "version": "3.12.1", + "version": "3.12.0", "private": true, "sideEffects": false, "packageManager": "yarn@1.22.18", diff --git a/packages/connectivity/CHANGELOG.md b/packages/connectivity/CHANGELOG.md index 4243348454..8c1a5396cb 100644 --- a/packages/connectivity/CHANGELOG.md +++ b/packages/connectivity/CHANGELOG.md @@ -1,13 +1,5 @@ # @sap-cloud-sdk/connectivity -## 3.12.1 - -### Patch Changes - -- 64341b1: [Fixed Issue] Fix `fetchDestinationWithoutTokenRetrieval` to correctly return instance and subaccount destinations. - - @sap-cloud-sdk/resilience@3.12.1 - - @sap-cloud-sdk/util@3.12.1 - ## 3.12.0 ### Minor Changes diff --git a/packages/connectivity/package.json b/packages/connectivity/package.json index 9282e97cd3..75a3d9105c 100644 --- a/packages/connectivity/package.json +++ b/packages/connectivity/package.json @@ -1,6 +1,6 @@ { "name": "@sap-cloud-sdk/connectivity", - "version": "3.12.1", + "version": "3.12.0", "description": "SAP Cloud SDK for JavaScript connectivity", "homepage": "https://sap.github.io/cloud-sdk/docs/js/overview", "license": "Apache-2.0", @@ -37,8 +37,8 @@ "readme": "ts-node ../../scripts/replace-common-readme.ts" }, "dependencies": { - "@sap-cloud-sdk/resilience": "^3.12.1", - "@sap-cloud-sdk/util": "^3.12.1", + "@sap-cloud-sdk/resilience": "^3.12.0", + "@sap-cloud-sdk/util": "^3.12.0", "@sap/xsenv": "^4.2.0", "@sap/xssec": "^3.6.1", "async-retry": "^1.3.3", diff --git a/packages/eslint-config/CHANGELOG.md b/packages/eslint-config/CHANGELOG.md index 3b61f4c577..155e066f8a 100644 --- a/packages/eslint-config/CHANGELOG.md +++ b/packages/eslint-config/CHANGELOG.md @@ -1,7 +1,5 @@ # @sap-cloud-sdk/eslint-config -## 3.12.1 - ## 3.12.0 ## 3.11.0 diff --git a/packages/eslint-config/package.json b/packages/eslint-config/package.json index 7a2b124282..053793ee90 100644 --- a/packages/eslint-config/package.json +++ b/packages/eslint-config/package.json @@ -1,6 +1,6 @@ { "name": "@sap-cloud-sdk/eslint-config", - "version": "3.12.1", + "version": "3.12.0", "description": "eslint config for the SAP Cloud SDK", "homepage": "https://sap.github.io/cloud-sdk/docs/js/overview", "license": "Apache-2.0", diff --git a/packages/generator-common/CHANGELOG.md b/packages/generator-common/CHANGELOG.md index fd12683cab..5a3a4dad98 100644 --- a/packages/generator-common/CHANGELOG.md +++ b/packages/generator-common/CHANGELOG.md @@ -1,11 +1,5 @@ # @sap-cloud-sdk/generator-common -## 3.12.1 - -### Patch Changes - -- @sap-cloud-sdk/util@3.12.1 - ## 3.12.0 ### Patch Changes diff --git a/packages/generator-common/package.json b/packages/generator-common/package.json index fa77e36e4c..392c8e24f1 100644 --- a/packages/generator-common/package.json +++ b/packages/generator-common/package.json @@ -1,6 +1,6 @@ { "name": "@sap-cloud-sdk/generator-common", - "version": "3.12.1", + "version": "3.12.0", "description": "SAP Cloud SDK for JavaScript common functions of OData client generator and OpenAPI clint generator.", "homepage": "https://sap.github.io/cloud-sdk/docs/js/overview", "license": "Apache-2.0", @@ -37,7 +37,7 @@ "readme": "ts-node ../../scripts/replace-common-readme.ts" }, "dependencies": { - "@sap-cloud-sdk/util": "^3.12.1", + "@sap-cloud-sdk/util": "^3.12.0", "fast-levenshtein": "~3.0.0", "fs-extra": "^11.2.0", "glob": "^10.3.10", diff --git a/packages/generator/CHANGELOG.md b/packages/generator/CHANGELOG.md index adf28e9cfd..d1f72c6dc2 100644 --- a/packages/generator/CHANGELOG.md +++ b/packages/generator/CHANGELOG.md @@ -1,16 +1,5 @@ # @sap-cloud-sdk/generator -## 3.12.1 - -### Patch Changes - -- Updated dependencies [7e93fd7] - - @sap-cloud-sdk/odata-common@3.12.1 - - @sap-cloud-sdk/generator-common@3.12.1 - - @sap-cloud-sdk/odata-v2@3.12.1 - - @sap-cloud-sdk/odata-v4@3.12.1 - - @sap-cloud-sdk/util@3.12.1 - ## 3.12.0 ### Patch Changes diff --git a/packages/generator/package.json b/packages/generator/package.json index 5a666e0084..02a472aa49 100644 --- a/packages/generator/package.json +++ b/packages/generator/package.json @@ -1,6 +1,6 @@ { "name": "@sap-cloud-sdk/generator", - "version": "3.12.1", + "version": "3.12.0", "description": "SAP Cloud SDK for JavaScript OData client generator", "homepage": "https://sap.github.io/cloud-sdk/docs/js/overview", "license": "Apache-2.0", @@ -40,11 +40,11 @@ "readme": "ts-node ../../scripts/replace-common-readme.ts" }, "dependencies": { - "@sap-cloud-sdk/generator-common": "^3.12.1", - "@sap-cloud-sdk/odata-common": "^3.12.1", - "@sap-cloud-sdk/odata-v2": "^3.12.1", - "@sap-cloud-sdk/odata-v4": "^3.12.1", - "@sap-cloud-sdk/util": "^3.12.1", + "@sap-cloud-sdk/generator-common": "^3.12.0", + "@sap-cloud-sdk/odata-common": "^3.12.0", + "@sap-cloud-sdk/odata-v2": "^3.12.0", + "@sap-cloud-sdk/odata-v4": "^3.12.0", + "@sap-cloud-sdk/util": "^3.12.0", "@types/fs-extra": "^11.0.4", "fast-xml-parser": "^4.3.5", "fs-extra": "^11.2.0", diff --git a/packages/http-client/CHANGELOG.md b/packages/http-client/CHANGELOG.md index 8147e6fb5b..237a145d35 100644 --- a/packages/http-client/CHANGELOG.md +++ b/packages/http-client/CHANGELOG.md @@ -1,14 +1,5 @@ # @sap-cloud-sdk/http-client -## 3.12.1 - -### Patch Changes - -- Updated dependencies [64341b1] - - @sap-cloud-sdk/connectivity@3.12.1 - - @sap-cloud-sdk/resilience@3.12.1 - - @sap-cloud-sdk/util@3.12.1 - ## 3.12.0 ### Patch Changes diff --git a/packages/http-client/package.json b/packages/http-client/package.json index 44fa6f397d..f7ca8a8ff0 100644 --- a/packages/http-client/package.json +++ b/packages/http-client/package.json @@ -1,6 +1,6 @@ { "name": "@sap-cloud-sdk/http-client", - "version": "3.12.1", + "version": "3.12.0", "description": "SAP Cloud SDK for JavaScript http-client", "homepage": "https://sap.github.io/cloud-sdk/docs/js/overview", "license": "Apache-2.0", @@ -37,9 +37,9 @@ "readme": "ts-node ../../scripts/replace-common-readme.ts" }, "dependencies": { - "@sap-cloud-sdk/connectivity": "^3.12.1", - "@sap-cloud-sdk/resilience": "^3.12.1", - "@sap-cloud-sdk/util": "^3.12.1", + "@sap-cloud-sdk/connectivity": "^3.12.0", + "@sap-cloud-sdk/resilience": "^3.12.0", + "@sap-cloud-sdk/util": "^3.12.0", "axios": "^1.6.7" }, "devDependencies": { diff --git a/packages/mail-client/CHANGELOG.md b/packages/mail-client/CHANGELOG.md index d52238f139..4c234b4fef 100644 --- a/packages/mail-client/CHANGELOG.md +++ b/packages/mail-client/CHANGELOG.md @@ -1,13 +1,5 @@ # @sap-cloud-sdk/mail-client -## 3.12.1 - -### Patch Changes - -- Updated dependencies [64341b1] - - @sap-cloud-sdk/connectivity@3.12.1 - - @sap-cloud-sdk/util@3.12.1 - ## 3.12.0 ### Patch Changes diff --git a/packages/mail-client/package.json b/packages/mail-client/package.json index 6fd9e4bbb8..70f65255b8 100644 --- a/packages/mail-client/package.json +++ b/packages/mail-client/package.json @@ -1,6 +1,6 @@ { "name": "@sap-cloud-sdk/mail-client", - "version": "3.12.1", + "version": "3.12.0", "description": "SAP Cloud SDK for JavaScript e-mail client", "homepage": "https://sap.github.io/cloud-sdk/docs/js/overview", "license": "Apache-2.0", @@ -38,8 +38,8 @@ "readme": "ts-node ../../scripts/replace-common-readme.ts" }, "dependencies": { - "@sap-cloud-sdk/connectivity": "^3.12.1", - "@sap-cloud-sdk/util": "^3.12.1", + "@sap-cloud-sdk/connectivity": "^3.12.0", + "@sap-cloud-sdk/util": "^3.12.0", "nodemailer": "6.9.11", "socks": "2.8.1" }, diff --git a/packages/odata-common/CHANGELOG.md b/packages/odata-common/CHANGELOG.md index 32f1a65670..05a446fd7d 100644 --- a/packages/odata-common/CHANGELOG.md +++ b/packages/odata-common/CHANGELOG.md @@ -1,15 +1,5 @@ # @sap-cloud-sdk/odata-common -## 3.12.1 - -### Patch Changes - -- 7e93fd7: [Fixed Issue] Fix type in `addCustomRequestConfiguration` method to accept values of type `any`. -- Updated dependencies [64341b1] - - @sap-cloud-sdk/connectivity@3.12.1 - - @sap-cloud-sdk/http-client@3.12.1 - - @sap-cloud-sdk/util@3.12.1 - ## 3.12.0 ### Patch Changes diff --git a/packages/odata-common/package.json b/packages/odata-common/package.json index 264ee9afe1..c93a57155f 100644 --- a/packages/odata-common/package.json +++ b/packages/odata-common/package.json @@ -1,6 +1,6 @@ { "name": "@sap-cloud-sdk/odata-common", - "version": "3.12.1", + "version": "3.12.0", "description": "SAP Cloud SDK for JavaScript common functions of OData client generator and OpenAPI clint generator.", "homepage": "https://sap.github.io/cloud-sdk/docs/js/overview", "license": "Apache-2.0", @@ -37,9 +37,9 @@ "readme": "ts-node ../../scripts/replace-common-readme.ts" }, "dependencies": { - "@sap-cloud-sdk/connectivity": "^3.12.1", - "@sap-cloud-sdk/http-client": "^3.12.1", - "@sap-cloud-sdk/util": "^3.12.1", + "@sap-cloud-sdk/connectivity": "^3.12.0", + "@sap-cloud-sdk/http-client": "^3.12.0", + "@sap-cloud-sdk/util": "^3.12.0", "bignumber.js": "^9.1.2", "moment": "^2.30.1", "uuid": "^9.0.1", @@ -47,6 +47,6 @@ }, "devDependencies": { "typescript": "~5.3.3", - "@sap-cloud-sdk/test-services-odata-common": "^3.12.1" + "@sap-cloud-sdk/test-services-odata-common": "^3.12.0" } } diff --git a/packages/odata-v2/CHANGELOG.md b/packages/odata-v2/CHANGELOG.md index fa7925baef..1091989830 100644 --- a/packages/odata-v2/CHANGELOG.md +++ b/packages/odata-v2/CHANGELOG.md @@ -1,16 +1,5 @@ # @sap-cloud-sdk/odata-v2 -## 3.12.1 - -### Patch Changes - -- Updated dependencies [7e93fd7] -- Updated dependencies [64341b1] - - @sap-cloud-sdk/odata-common@3.12.1 - - @sap-cloud-sdk/connectivity@3.12.1 - - @sap-cloud-sdk/http-client@3.12.1 - - @sap-cloud-sdk/util@3.12.1 - ## 3.12.0 ### Patch Changes diff --git a/packages/odata-v2/package.json b/packages/odata-v2/package.json index 75d62347f6..8e86d7f05b 100644 --- a/packages/odata-v2/package.json +++ b/packages/odata-v2/package.json @@ -1,6 +1,6 @@ { "name": "@sap-cloud-sdk/odata-v2", - "version": "3.12.1", + "version": "3.12.0", "description": "SAP Cloud SDK for JavaScript common functions of OData client generator and OpenAPI clint generator.", "homepage": "https://sap.github.io/cloud-sdk/docs/js/overview", "license": "Apache-2.0", @@ -37,17 +37,17 @@ "readme": "ts-node ../../scripts/replace-common-readme.ts" }, "dependencies": { - "@sap-cloud-sdk/connectivity": "^3.12.1", - "@sap-cloud-sdk/http-client": "^3.12.1", - "@sap-cloud-sdk/odata-common": "^3.12.1", - "@sap-cloud-sdk/util": "^3.12.1", + "@sap-cloud-sdk/connectivity": "^3.12.0", + "@sap-cloud-sdk/http-client": "^3.12.0", + "@sap-cloud-sdk/odata-common": "^3.12.0", + "@sap-cloud-sdk/util": "^3.12.0", "bignumber.js": "^9.1.2", "moment": "^2.30.1", "uuid": "^9.0.1" }, "devDependencies": { - "@sap-cloud-sdk/test-services-odata-v2": "^3.12.1", - "@sap-cloud-sdk/resilience": "^3.12.1", + "@sap-cloud-sdk/test-services-odata-v2": "^3.12.0", + "@sap-cloud-sdk/resilience": "^3.12.0", "nock": "^13.5.4", "typescript": "~5.3.3" } diff --git a/packages/odata-v4/CHANGELOG.md b/packages/odata-v4/CHANGELOG.md index b7ffb1e781..266332f59e 100644 --- a/packages/odata-v4/CHANGELOG.md +++ b/packages/odata-v4/CHANGELOG.md @@ -1,16 +1,5 @@ # @sap-cloud-sdk/odata-v4 -## 3.12.1 - -### Patch Changes - -- Updated dependencies [7e93fd7] -- Updated dependencies [64341b1] - - @sap-cloud-sdk/odata-common@3.12.1 - - @sap-cloud-sdk/connectivity@3.12.1 - - @sap-cloud-sdk/http-client@3.12.1 - - @sap-cloud-sdk/util@3.12.1 - ## 3.12.0 ### Patch Changes diff --git a/packages/odata-v4/package.json b/packages/odata-v4/package.json index a49134952e..fe0dbee85c 100644 --- a/packages/odata-v4/package.json +++ b/packages/odata-v4/package.json @@ -1,6 +1,6 @@ { "name": "@sap-cloud-sdk/odata-v4", - "version": "3.12.1", + "version": "3.12.0", "description": "SAP Cloud SDK for JavaScript common functions of OData client generator and OpenAPI clint generator.", "homepage": "https://sap.github.io/cloud-sdk/docs/js/overview", "license": "Apache-2.0", @@ -37,16 +37,16 @@ "readme": "ts-node ../../scripts/replace-common-readme.ts" }, "dependencies": { - "@sap-cloud-sdk/connectivity": "^3.12.1", - "@sap-cloud-sdk/http-client": "^3.12.1", - "@sap-cloud-sdk/odata-common": "^3.12.1", - "@sap-cloud-sdk/util": "^3.12.1", + "@sap-cloud-sdk/connectivity": "^3.12.0", + "@sap-cloud-sdk/http-client": "^3.12.0", + "@sap-cloud-sdk/odata-common": "^3.12.0", + "@sap-cloud-sdk/util": "^3.12.0", "bignumber.js": "^9.1.2", "moment": "^2.30.1", "uuid": "^9.0.1" }, "devDependencies": { - "@sap-cloud-sdk/test-services-odata-v4": "^3.12.1", + "@sap-cloud-sdk/test-services-odata-v4": "^3.12.0", "nock": "^13.5.4", "typescript": "~5.3.3" } diff --git a/packages/openapi-generator/CHANGELOG.md b/packages/openapi-generator/CHANGELOG.md index 3bc38f5115..54edace46a 100644 --- a/packages/openapi-generator/CHANGELOG.md +++ b/packages/openapi-generator/CHANGELOG.md @@ -1,14 +1,5 @@ # @sap-cloud-sdk/openapi-generator -## 3.12.1 - -### Patch Changes - -- Updated dependencies [7e93fd7] - - @sap-cloud-sdk/openapi@3.12.1 - - @sap-cloud-sdk/generator-common@3.12.1 - - @sap-cloud-sdk/util@3.12.1 - ## 3.12.0 ### Patch Changes diff --git a/packages/openapi-generator/package.json b/packages/openapi-generator/package.json index 9b4f456685..b750f53305 100644 --- a/packages/openapi-generator/package.json +++ b/packages/openapi-generator/package.json @@ -1,6 +1,6 @@ { "name": "@sap-cloud-sdk/openapi-generator", - "version": "3.12.1", + "version": "3.12.0", "description": "SAP Cloud SDK for JavaScript OpenAPI client generator", "homepage": "https://sap.github.io/cloud-sdk/docs/js/overview", "license": "Apache-2.0", @@ -38,9 +38,9 @@ }, "dependencies": { "@apidevtools/swagger-parser": "^10.0.3", - "@sap-cloud-sdk/generator-common": "^3.12.1", - "@sap-cloud-sdk/openapi": "^3.12.1", - "@sap-cloud-sdk/util": "^3.12.1", + "@sap-cloud-sdk/generator-common": "^3.12.0", + "@sap-cloud-sdk/openapi": "^3.12.0", + "@sap-cloud-sdk/util": "^3.12.0", "js-yaml": "^4.0.0", "openapi-types": "^12.1.3", "swagger2openapi": "^7.0.4" diff --git a/packages/openapi/CHANGELOG.md b/packages/openapi/CHANGELOG.md index 5bbbc35372..f1f3d5f452 100644 --- a/packages/openapi/CHANGELOG.md +++ b/packages/openapi/CHANGELOG.md @@ -1,16 +1,5 @@ # @sap-cloud-sdk/openapi -## 3.12.1 - -### Patch Changes - -- 7e93fd7: [Fixed Issue] Fix type in `addCustomRequestConfiguration` method to accept values of type `any`. -- Updated dependencies [64341b1] - - @sap-cloud-sdk/connectivity@3.12.1 - - @sap-cloud-sdk/http-client@3.12.1 - - @sap-cloud-sdk/resilience@3.12.1 - - @sap-cloud-sdk/util@3.12.1 - ## 3.12.0 ### Patch Changes diff --git a/packages/openapi/package.json b/packages/openapi/package.json index c6dafdd9a7..8f48457f97 100644 --- a/packages/openapi/package.json +++ b/packages/openapi/package.json @@ -1,6 +1,6 @@ { "name": "@sap-cloud-sdk/openapi", - "version": "3.12.1", + "version": "3.12.0", "description": "SAP Cloud SDK for JavaScript openapi", "homepage": "https://sap.github.io/cloud-sdk/docs/js/overview", "license": "Apache-2.0", @@ -37,10 +37,10 @@ "readme": "ts-node ../../scripts/replace-common-readme.ts" }, "dependencies": { - "@sap-cloud-sdk/connectivity": "^3.12.1", - "@sap-cloud-sdk/http-client": "^3.12.1", - "@sap-cloud-sdk/resilience": "^3.12.1", - "@sap-cloud-sdk/util": "^3.12.1", + "@sap-cloud-sdk/connectivity": "^3.12.0", + "@sap-cloud-sdk/http-client": "^3.12.0", + "@sap-cloud-sdk/resilience": "^3.12.0", + "@sap-cloud-sdk/util": "^3.12.0", "axios": "^1.6.7" }, "devDependencies": { diff --git a/packages/resilience/CHANGELOG.md b/packages/resilience/CHANGELOG.md index 31a37417cf..6d5e6b1e12 100644 --- a/packages/resilience/CHANGELOG.md +++ b/packages/resilience/CHANGELOG.md @@ -1,11 +1,5 @@ # @sap-cloud-sdk/resilience -## 3.12.1 - -### Patch Changes - -- @sap-cloud-sdk/util@3.12.1 - ## 3.12.0 ### Patch Changes diff --git a/packages/resilience/package.json b/packages/resilience/package.json index 51a90cdc32..8b4c821048 100644 --- a/packages/resilience/package.json +++ b/packages/resilience/package.json @@ -1,6 +1,6 @@ { "name": "@sap-cloud-sdk/resilience", - "version": "3.12.1", + "version": "3.12.0", "description": "SAP Cloud SDK for JavaScript resilience", "homepage": "https://sap.github.io/cloud-sdk/docs/js/overview", "license": "Apache-2.0", @@ -38,7 +38,7 @@ "readme": "ts-node ../../scripts/replace-common-readme.ts" }, "dependencies": { - "@sap-cloud-sdk/util": "^3.12.1", + "@sap-cloud-sdk/util": "^3.12.0", "async-retry": "^1.3.3", "axios": "^1.6.7", "opossum": "^8.1.3" diff --git a/packages/temporal-de-serializers/CHANGELOG.md b/packages/temporal-de-serializers/CHANGELOG.md index e810f7e5d5..322ed430f9 100644 --- a/packages/temporal-de-serializers/CHANGELOG.md +++ b/packages/temporal-de-serializers/CHANGELOG.md @@ -1,12 +1,5 @@ # @sap-cloud-sdk/temporal-de-serializers -## 3.12.1 - -### Patch Changes - -- Updated dependencies [7e93fd7] - - @sap-cloud-sdk/odata-common@3.12.1 - ## 3.12.0 ### Patch Changes diff --git a/packages/temporal-de-serializers/package.json b/packages/temporal-de-serializers/package.json index b30ed2d639..b22673a604 100644 --- a/packages/temporal-de-serializers/package.json +++ b/packages/temporal-de-serializers/package.json @@ -1,6 +1,6 @@ { "name": "@sap-cloud-sdk/temporal-de-serializers", - "version": "3.12.1", + "version": "3.12.0", "description": "SAP Cloud SDK for JavaScript temporal-based middleware for date/time (de-)serialization", "homepage": "https://sap.github.io/cloud-sdk/docs/js/overview", "license": "Apache-2.0", @@ -38,7 +38,7 @@ }, "dependencies": { "@js-temporal/polyfill": "^0.4.4", - "@sap-cloud-sdk/odata-common": "^3.12.1" + "@sap-cloud-sdk/odata-common": "^3.12.0" }, "devDependencies": { "typescript": "~5.3.3" diff --git a/packages/test-util/CHANGELOG.md b/packages/test-util/CHANGELOG.md index c0a86ff4de..207109e744 100644 --- a/packages/test-util/CHANGELOG.md +++ b/packages/test-util/CHANGELOG.md @@ -1,13 +1,5 @@ # @sap-cloud-sdk/test-util -## 3.12.1 - -### Patch Changes - -- Updated dependencies [64341b1] - - @sap-cloud-sdk/connectivity@3.12.1 - - @sap-cloud-sdk/util@3.12.1 - ## 3.12.0 ### Patch Changes diff --git a/packages/test-util/package.json b/packages/test-util/package.json index 7ff315495c..6d44cb64ca 100644 --- a/packages/test-util/package.json +++ b/packages/test-util/package.json @@ -1,6 +1,6 @@ { "name": "@sap-cloud-sdk/test-util", - "version": "3.12.1", + "version": "3.12.0", "description": "SAP Cloud SDK for JavaScript test utilities", "homepage": "https://sap.github.io/cloud-sdk/docs/js/overview", "license": "Apache-2.0", @@ -34,8 +34,8 @@ "readme": "ts-node ../../scripts/replace-common-readme.ts" }, "dependencies": { - "@sap-cloud-sdk/connectivity": "^3.12.1", - "@sap-cloud-sdk/util": "^3.12.1" + "@sap-cloud-sdk/connectivity": "^3.12.0", + "@sap-cloud-sdk/util": "^3.12.0" }, "devDependencies": { "mock-fs": "^5.2.0", diff --git a/packages/util/CHANGELOG.md b/packages/util/CHANGELOG.md index 05652288e9..670c88bf34 100644 --- a/packages/util/CHANGELOG.md +++ b/packages/util/CHANGELOG.md @@ -1,7 +1,5 @@ # @sap-cloud-sdk/util -## 3.12.1 - ## 3.12.0 ## 3.11.0 diff --git a/packages/util/package.json b/packages/util/package.json index 7caeb263b2..7d84ed6784 100644 --- a/packages/util/package.json +++ b/packages/util/package.json @@ -1,6 +1,6 @@ { "name": "@sap-cloud-sdk/util", - "version": "3.12.1", + "version": "3.12.0", "description": "SAP Cloud SDK for JavaScript general utilities", "homepage": "https://sap.github.io/cloud-sdk/docs/js/overview", "license": "Apache-2.0", diff --git a/test-packages/e2e-tests/CHANGELOG.md b/test-packages/e2e-tests/CHANGELOG.md index ccd5bf288b..584ea5e234 100644 --- a/test-packages/e2e-tests/CHANGELOG.md +++ b/test-packages/e2e-tests/CHANGELOG.md @@ -1,7 +1,5 @@ # @sap-cloud-sdk/e2e-tests -## 3.12.1 - ## 3.12.0 ## 3.11.0 diff --git a/test-packages/e2e-tests/package.json b/test-packages/e2e-tests/package.json index 528b5e00e6..f7b417603a 100644 --- a/test-packages/e2e-tests/package.json +++ b/test-packages/e2e-tests/package.json @@ -1,6 +1,6 @@ { "name": "@sap-cloud-sdk/e2e-tests", - "version": "3.12.1", + "version": "3.12.0", "description": "End to end tests of the SAP Cloud SDK for JavaScript", "homepage": "https://sap.github.io/cloud-sdk/docs/js/overview", "license": "Apache-2.0", @@ -25,15 +25,15 @@ }, "devDependencies": { "@apidevtools/swagger-parser": "^10.1.0", - "@sap-cloud-sdk/connectivity": "^3.12.1", - "@sap-cloud-sdk/generator": "^3.12.1", - "@sap-cloud-sdk/http-client": "^3.12.1", - "@sap-cloud-sdk/mail-client": "^3.12.1", - "@sap-cloud-sdk/odata-common": "^3.12.1", - "@sap-cloud-sdk/odata-v4": "^3.12.1", - "@sap-cloud-sdk/test-services-e2e": "^3.12.1", - "@sap-cloud-sdk/test-services-openapi": "^3.12.1", - "@sap-cloud-sdk/util": "^3.12.1", + "@sap-cloud-sdk/connectivity": "^3.12.0", + "@sap-cloud-sdk/generator": "^3.12.0", + "@sap-cloud-sdk/http-client": "^3.12.0", + "@sap-cloud-sdk/mail-client": "^3.12.0", + "@sap-cloud-sdk/odata-common": "^3.12.0", + "@sap-cloud-sdk/odata-v4": "^3.12.0", + "@sap-cloud-sdk/test-services-e2e": "^3.12.0", + "@sap-cloud-sdk/test-services-openapi": "^3.12.0", + "@sap-cloud-sdk/util": "^3.12.0", "@sap/cds": "^7.7.1", "@sap/cds-dk": "7.7.1", "axios": "^1.6.7", diff --git a/test-packages/integration-tests/CHANGELOG.md b/test-packages/integration-tests/CHANGELOG.md index 2835ac65ee..571e7aabd0 100644 --- a/test-packages/integration-tests/CHANGELOG.md +++ b/test-packages/integration-tests/CHANGELOG.md @@ -1,18 +1,5 @@ # @sap-cloud-sdk/integration-tests -## 3.12.1 - -### Patch Changes - -- Updated dependencies [64341b1] - - @sap-cloud-sdk/connectivity@3.12.1 - - @sap-cloud-sdk/http-client@3.12.1 - - @sap-cloud-sdk/mail-client@3.12.1 - - @sap-cloud-sdk/test-util@3.12.1 - - @sap-cloud-sdk/util@3.12.1 - - @sap-cloud-sdk/test-services-odata-v2@3.12.1 - - @sap-cloud-sdk/test-services-odata-v4@3.12.1 - ## 3.12.0 ### Patch Changes diff --git a/test-packages/integration-tests/package.json b/test-packages/integration-tests/package.json index df11601405..7a845008bb 100644 --- a/test-packages/integration-tests/package.json +++ b/test-packages/integration-tests/package.json @@ -1,6 +1,6 @@ { "name": "@sap-cloud-sdk/integration-tests", - "version": "3.12.1", + "version": "3.12.0", "description": "SAP Cloud SDK for JavaScript integration tests", "homepage": "https://sap.github.io/cloud-sdk/docs/js/overview", "license": "Apache-2.0", @@ -15,21 +15,21 @@ "check:dependencies": "depcheck . --ignores=@sap-cloud-sdk/generator,@sap-cloud-sdk/openapi-generator" }, "dependencies": { - "@sap-cloud-sdk/connectivity": "^3.12.1", - "@sap-cloud-sdk/http-client": "^3.12.1", - "@sap-cloud-sdk/mail-client": "^3.12.1", - "@sap-cloud-sdk/test-services-odata-v2": "^3.12.1", - "@sap-cloud-sdk/test-services-odata-v4": "^3.12.1", - "@sap-cloud-sdk/test-util": "^3.12.1", - "@sap-cloud-sdk/util": "^3.12.1", + "@sap-cloud-sdk/connectivity": "^3.12.0", + "@sap-cloud-sdk/http-client": "^3.12.0", + "@sap-cloud-sdk/mail-client": "^3.12.0", + "@sap-cloud-sdk/test-services-odata-v2": "^3.12.0", + "@sap-cloud-sdk/test-services-odata-v4": "^3.12.0", + "@sap-cloud-sdk/test-util": "^3.12.0", + "@sap-cloud-sdk/util": "^3.12.0", "@sap/xssec": "^3.6.1", "axios": "^1.6.7" }, "devDependencies": { - "@sap-cloud-sdk/generator": "^3.12.1", - "@sap-cloud-sdk/odata-common": "^3.12.1", - "@sap-cloud-sdk/odata-v2": "^3.12.1", - "@sap-cloud-sdk/openapi-generator": "^3.12.1", + "@sap-cloud-sdk/generator": "^3.12.0", + "@sap-cloud-sdk/odata-common": "^3.12.0", + "@sap-cloud-sdk/odata-v2": "^3.12.0", + "@sap-cloud-sdk/openapi-generator": "^3.12.0", "bignumber.js": "^9.1.2", "moment": "^2.30.1", "execa": "^5.0.0", diff --git a/test-packages/self-tests/CHANGELOG.md b/test-packages/self-tests/CHANGELOG.md index c7a97b16a8..9bae1851f7 100644 --- a/test-packages/self-tests/CHANGELOG.md +++ b/test-packages/self-tests/CHANGELOG.md @@ -1,7 +1,5 @@ # @sap-cloud-sdk/self-tests -## 3.12.1 - ## 3.12.0 ## 3.11.0 diff --git a/test-packages/self-tests/package.json b/test-packages/self-tests/package.json index b6cfbc2dbc..49a071a859 100644 --- a/test-packages/self-tests/package.json +++ b/test-packages/self-tests/package.json @@ -1,6 +1,6 @@ { "name": "@sap-cloud-sdk/self-tests", - "version": "3.12.1", + "version": "3.12.0", "description": "Self tests to ensure test tools are working in the SAP Cloud SDK for JavaScript.", "homepage": "https://sap.github.io/cloud-sdk/docs/js/overview", "license": "Apache-2.0", diff --git a/test-packages/test-services-e2e/CHANGELOG.md b/test-packages/test-services-e2e/CHANGELOG.md index 14371c7cf9..bf7ab8c17c 100644 --- a/test-packages/test-services-e2e/CHANGELOG.md +++ b/test-packages/test-services-e2e/CHANGELOG.md @@ -1,7 +1,5 @@ # @sap-cloud-sdk/test-services-e2e -## 3.12.1 - ## 3.12.0 ## 3.11.0 diff --git a/test-packages/test-services-e2e/package.json b/test-packages/test-services-e2e/package.json index f6d5fd26d4..7cd45c8efb 100644 --- a/test-packages/test-services-e2e/package.json +++ b/test-packages/test-services-e2e/package.json @@ -1,6 +1,6 @@ { "name": "@sap-cloud-sdk/test-services-e2e", - "version": "3.12.1", + "version": "3.12.0", "description": "Custom Services for testing", "files": [ "**/*.js", diff --git a/test-packages/test-services-odata-common/CHANGELOG.md b/test-packages/test-services-odata-common/CHANGELOG.md index d9cb7017fd..9ce8cc3a94 100644 --- a/test-packages/test-services-odata-common/CHANGELOG.md +++ b/test-packages/test-services-odata-common/CHANGELOG.md @@ -1,7 +1,5 @@ # @sap-cloud-sdk/test-services-odata-common -## 3.12.1 - ## 3.12.0 ## 3.11.0 diff --git a/test-packages/test-services-odata-common/package.json b/test-packages/test-services-odata-common/package.json index f83dfd7ef6..c2b32f522a 100644 --- a/test-packages/test-services-odata-common/package.json +++ b/test-packages/test-services-odata-common/package.json @@ -1,6 +1,6 @@ { "name": "@sap-cloud-sdk/test-services-odata-common", - "version": "3.12.1", + "version": "3.12.0", "description": "Custom Services for testing", "files": [ "**/*.js", @@ -25,7 +25,7 @@ "moment": "^2.30.1" }, "devDependencies": { - "@sap-cloud-sdk/generator-common": "^3.12.1" + "@sap-cloud-sdk/generator-common": "^3.12.0" }, "peerDependencies": { "@sap-cloud-sdk/generator": "^3.0.0", diff --git a/test-packages/test-services-odata-v2/CHANGELOG.md b/test-packages/test-services-odata-v2/CHANGELOG.md index 99b4bb9de0..e36eed0940 100644 --- a/test-packages/test-services-odata-v2/CHANGELOG.md +++ b/test-packages/test-services-odata-v2/CHANGELOG.md @@ -1,7 +1,5 @@ # @sap-cloud-sdk/test-services-odata-v2 -## 3.12.1 - ## 3.12.0 ## 3.11.0 diff --git a/test-packages/test-services-odata-v2/package.json b/test-packages/test-services-odata-v2/package.json index 14c1c0e201..99f7de98e6 100644 --- a/test-packages/test-services-odata-v2/package.json +++ b/test-packages/test-services-odata-v2/package.json @@ -1,6 +1,6 @@ { "name": "@sap-cloud-sdk/test-services-odata-v2", - "version": "3.12.1", + "version": "3.12.0", "description": "Custom Services for testing", "files": [ "**/*.js", diff --git a/test-packages/test-services-odata-v4/CHANGELOG.md b/test-packages/test-services-odata-v4/CHANGELOG.md index 9b861d1700..488a560a22 100644 --- a/test-packages/test-services-odata-v4/CHANGELOG.md +++ b/test-packages/test-services-odata-v4/CHANGELOG.md @@ -1,7 +1,5 @@ # @sap-cloud-sdk/test-services-odata-v4 -## 3.12.1 - ## 3.12.0 ## 3.11.0 diff --git a/test-packages/test-services-odata-v4/package.json b/test-packages/test-services-odata-v4/package.json index a0525c4d7e..ef7f5483a2 100644 --- a/test-packages/test-services-odata-v4/package.json +++ b/test-packages/test-services-odata-v4/package.json @@ -1,6 +1,6 @@ { "name": "@sap-cloud-sdk/test-services-odata-v4", - "version": "3.12.1", + "version": "3.12.0", "description": "Custom Services for testing", "files": [ "**/*.js", diff --git a/test-packages/test-services-openapi/CHANGELOG.md b/test-packages/test-services-openapi/CHANGELOG.md index b9a9a8090a..1843829111 100644 --- a/test-packages/test-services-openapi/CHANGELOG.md +++ b/test-packages/test-services-openapi/CHANGELOG.md @@ -1,12 +1,5 @@ # @sap-cloud-sdk/test-services-openapi -## 3.12.1 - -### Patch Changes - -- @sap-cloud-sdk/openapi-generator@3.12.1 -- @sap-cloud-sdk/util@3.12.1 - ## 3.12.0 ### Patch Changes diff --git a/test-packages/test-services-openapi/no-schema-service/package.json b/test-packages/test-services-openapi/no-schema-service/package.json index 618a96956a..84a65c9670 100644 --- a/test-packages/test-services-openapi/no-schema-service/package.json +++ b/test-packages/test-services-openapi/no-schema-service/package.json @@ -18,7 +18,7 @@ "compile": "npx tsc" }, "dependencies": { - "@sap-cloud-sdk/openapi": "^3.12.1" + "@sap-cloud-sdk/openapi": "^3.12.0" }, "devDependencies": { "typescript": "~4.1.2" diff --git a/test-packages/test-services-openapi/package.json b/test-packages/test-services-openapi/package.json index 5ae3932aa1..014b0055fb 100644 --- a/test-packages/test-services-openapi/package.json +++ b/test-packages/test-services-openapi/package.json @@ -1,6 +1,6 @@ { "name": "@sap-cloud-sdk/test-services-openapi", - "version": "3.12.1", + "version": "3.12.0", "description": "Custom Services for testing", "files": [ "**/*.js", @@ -21,7 +21,7 @@ }, "license": "Apache-2.0", "dependencies": { - "@sap-cloud-sdk/openapi-generator": "^3.12.1", - "@sap-cloud-sdk/util": "^3.12.1" + "@sap-cloud-sdk/openapi-generator": "^3.12.0", + "@sap-cloud-sdk/util": "^3.12.0" } } diff --git a/test-packages/test-services-openapi/swagger-yaml-service/package.json b/test-packages/test-services-openapi/swagger-yaml-service/package.json index b93e9c35d6..9690ce5d9c 100644 --- a/test-packages/test-services-openapi/swagger-yaml-service/package.json +++ b/test-packages/test-services-openapi/swagger-yaml-service/package.json @@ -18,7 +18,7 @@ "compile": "npx tsc" }, "dependencies": { - "@sap-cloud-sdk/openapi": "^3.12.1" + "@sap-cloud-sdk/openapi": "^3.12.0" }, "devDependencies": { "typescript": "~4.1.2" diff --git a/test-packages/test-services-openapi/test-service/package.json b/test-packages/test-services-openapi/test-service/package.json index 6a403a3965..09062738d4 100644 --- a/test-packages/test-services-openapi/test-service/package.json +++ b/test-packages/test-services-openapi/test-service/package.json @@ -18,7 +18,7 @@ "compile": "npx tsc" }, "dependencies": { - "@sap-cloud-sdk/openapi": "^3.12.1" + "@sap-cloud-sdk/openapi": "^3.12.0" }, "devDependencies": { "typescript": "~4.1.2" diff --git a/test-packages/type-tests/CHANGELOG.md b/test-packages/type-tests/CHANGELOG.md index ae4ce271ba..b2445fb815 100644 --- a/test-packages/type-tests/CHANGELOG.md +++ b/test-packages/type-tests/CHANGELOG.md @@ -1,7 +1,5 @@ # @sap-cloud-sdk/type-tests -## 3.12.1 - ## 3.12.0 ## 3.11.0 diff --git a/test-packages/type-tests/package.json b/test-packages/type-tests/package.json index ac04fc0329..c1bd6067c9 100644 --- a/test-packages/type-tests/package.json +++ b/test-packages/type-tests/package.json @@ -1,6 +1,6 @@ { "name": "@sap-cloud-sdk/type-tests", - "version": "3.12.1", + "version": "3.12.0", "description": "Tests to ensure correct types in the SAP Cloud SDK for JavaScript.", "homepage": "https://sap.github.io/cloud-sdk/docs/js/overview", "license": "Apache-2.0", @@ -16,16 +16,16 @@ }, "devDependencies": { "tsd": "^0.30.7", - "@sap-cloud-sdk/connectivity": "^3.12.1", - "@sap-cloud-sdk/generator": "^3.12.1", - "@sap-cloud-sdk/http-client": "^3.12.1", - "@sap-cloud-sdk/mail-client": "^3.12.1", - "@sap-cloud-sdk/odata-common": "^3.12.1", - "@sap-cloud-sdk/odata-v2": "^3.12.1", - "@sap-cloud-sdk/odata-v4": "^3.12.1", - "@sap-cloud-sdk/temporal-de-serializers": "^3.12.1", - "@sap-cloud-sdk/test-services-odata-v2": "^3.12.1", - "@sap-cloud-sdk/test-services-odata-v4": "^3.12.1", + "@sap-cloud-sdk/connectivity": "^3.12.0", + "@sap-cloud-sdk/generator": "^3.12.0", + "@sap-cloud-sdk/http-client": "^3.12.0", + "@sap-cloud-sdk/mail-client": "^3.12.0", + "@sap-cloud-sdk/odata-common": "^3.12.0", + "@sap-cloud-sdk/odata-v2": "^3.12.0", + "@sap-cloud-sdk/odata-v4": "^3.12.0", + "@sap-cloud-sdk/temporal-de-serializers": "^3.12.0", + "@sap-cloud-sdk/test-services-odata-v2": "^3.12.0", + "@sap-cloud-sdk/test-services-odata-v4": "^3.12.0", "@types/jsonwebtoken": "^9.0.6" } }