From 90705119dff1e61cefd90cfe179908106c834f04 Mon Sep 17 00:00:00 2001 From: cloud-sdk-js Date: Mon, 7 Oct 2024 09:36:47 +0000 Subject: [PATCH] Update SAP Cloud SDK for JavaScript API documentation --- .../api/v3/classes/sap_cloud_sdk_odata_common.AllFields.html | 4 ++-- .../v3/classes/sap_cloud_sdk_odata_common.BatchChangeSet.html | 4 ++-- .../sap_cloud_sdk_odata_common.BooleanFilterFunction.html | 4 ++-- .../classes/sap_cloud_sdk_odata_common.CollectionField.html | 4 ++-- .../sap_cloud_sdk_odata_common.CollectionFilterFunction.html | 4 ++-- .../classes/sap_cloud_sdk_odata_common.ComplexTypeField.html | 4 ++-- .../sap_cloud_sdk_odata_common.CountRequestBuilder.html | 4 ++-- .../sap_cloud_sdk_odata_common.CreateRequestBuilderBase.html | 4 ++-- .../v3/classes/sap_cloud_sdk_odata_common.CustomField.html | 4 ++-- .../sap_cloud_sdk_odata_common.DeleteRequestBuilderBase.html | 4 ++-- .../v3/classes/sap_cloud_sdk_odata_common.EdmTypeField.html | 4 ++-- .../api/v3/classes/sap_cloud_sdk_odata_common.EntityBase.html | 4 ++-- .../v3/classes/sap_cloud_sdk_odata_common.EntityBuilder.html | 4 ++-- .../api/v3/classes/sap_cloud_sdk_odata_common.EnumField.html | 4 ++-- static/api/v3/classes/sap_cloud_sdk_odata_common.Field.html | 4 ++-- .../v3/classes/sap_cloud_sdk_odata_common.FieldBuilder.html | 4 ++-- static/api/v3/classes/sap_cloud_sdk_odata_common.Filter.html | 4 ++-- .../v3/classes/sap_cloud_sdk_odata_common.FilterFunction.html | 4 ++-- .../sap_cloud_sdk_odata_common.FilterLambdaExpression.html | 4 ++-- .../api/v3/classes/sap_cloud_sdk_odata_common.FilterLink.html | 4 ++-- .../api/v3/classes/sap_cloud_sdk_odata_common.FilterList.html | 4 ++-- .../sap_cloud_sdk_odata_common.GetAllRequestBuilderBase.html | 4 ++-- ...sap_cloud_sdk_odata_common.GetByKeyRequestBuilderBase.html | 4 ++-- static/api/v3/classes/sap_cloud_sdk_odata_common.Link.html | 4 ++-- .../sap_cloud_sdk_odata_common.NumberFilterFunction.html | 4 ++-- .../sap_cloud_sdk_odata_common.ODataBatchRequestConfig.html | 4 ++-- .../sap_cloud_sdk_odata_common.ODataCountRequestConfig.html | 4 ++-- .../sap_cloud_sdk_odata_common.ODataCreateRequestConfig.html | 4 ++-- .../sap_cloud_sdk_odata_common.ODataDeleteRequestConfig.html | 4 ++-- ...sap_cloud_sdk_odata_common.ODataFunctionRequestConfig.html | 4 ++-- .../sap_cloud_sdk_odata_common.ODataGetAllRequestConfig.html | 4 ++-- ...sap_cloud_sdk_odata_common.ODataGetByKeyRequestConfig.html | 4 ++-- .../v3/classes/sap_cloud_sdk_odata_common.ODataRequest.html | 4 ++-- .../sap_cloud_sdk_odata_common.ODataRequestConfig.html | 4 ++-- .../sap_cloud_sdk_odata_common.ODataUpdateRequestConfig.html | 4 ++-- .../v3/classes/sap_cloud_sdk_odata_common.OneToManyLink.html | 4 ++-- .../v3/classes/sap_cloud_sdk_odata_common.OneToOneLink.html | 4 ++-- .../sap_cloud_sdk_odata_common.OperationParameter.html | 4 ++-- ...ap_cloud_sdk_odata_common.OperationRequestBuilderBase.html | 4 ++-- static/api/v3/classes/sap_cloud_sdk_odata_common.Order.html | 4 ++-- .../api/v3/classes/sap_cloud_sdk_odata_common.OrderLink.html | 4 ++-- .../sap_cloud_sdk_odata_common.OrderableEdmTypeField.html | 4 ++-- .../v3/classes/sap_cloud_sdk_odata_common.RequestBuilder.html | 4 ++-- .../sap_cloud_sdk_odata_common.StringFilterFunction.html | 4 ++-- .../v3/classes/sap_cloud_sdk_odata_common.UnaryFilter.html | 4 ++-- .../sap_cloud_sdk_odata_common.UpdateRequestBuilderBase.html | 4 ++-- .../classes/sap_cloud_sdk_odata_v2.CountRequestBuilder.html | 4 ++-- .../classes/sap_cloud_sdk_odata_v2.CreateRequestBuilder.html | 4 ++-- static/api/v3/classes/sap_cloud_sdk_odata_v2.CustomField.html | 4 ++-- .../classes/sap_cloud_sdk_odata_v2.DeleteRequestBuilder.html | 4 ++-- static/api/v3/classes/sap_cloud_sdk_odata_v2.Entity.html | 4 ++-- .../classes/sap_cloud_sdk_odata_v2.GetAllRequestBuilder.html | 4 ++-- .../sap_cloud_sdk_odata_v2.GetByKeyRequestBuilder.html | 4 ++-- .../sap_cloud_sdk_odata_v2.ODataBatchRequestBuilder.html | 4 ++-- .../sap_cloud_sdk_odata_v2.ODataFunctionRequestConfig.html | 4 ++-- .../sap_cloud_sdk_odata_v2.OperationRequestBuilder.html | 4 ++-- .../classes/sap_cloud_sdk_odata_v2.UpdateRequestBuilder.html | 4 ++-- .../classes/sap_cloud_sdk_odata_v4.ActionImportParameter.html | 4 ++-- .../sap_cloud_sdk_odata_v4.ActionImportRequestBuilder.html | 4 ++-- ...ap_cloud_sdk_odata_v4.BoundActionImportRequestBuilder.html | 4 ++-- ..._cloud_sdk_odata_v4.BoundFunctionImportRequestBuilder.html | 4 ++-- .../sap_cloud_sdk_odata_v4.BoundOperationRequestBuilder.html | 4 ++-- .../classes/sap_cloud_sdk_odata_v4.CountRequestBuilder.html | 4 ++-- .../classes/sap_cloud_sdk_odata_v4.CreateRequestBuilder.html | 4 ++-- static/api/v3/classes/sap_cloud_sdk_odata_v4.CustomField.html | 4 ++-- .../v3/classes/sap_cloud_sdk_odata_v4.DateFilterFunction.html | 4 ++-- .../classes/sap_cloud_sdk_odata_v4.DeleteRequestBuilder.html | 4 ++-- static/api/v3/classes/sap_cloud_sdk_odata_v4.Entity.html | 4 ++-- .../sap_cloud_sdk_odata_v4.FunctionImportRequestBuilder.html | 4 ++-- .../classes/sap_cloud_sdk_odata_v4.GetAllRequestBuilder.html | 4 ++-- .../sap_cloud_sdk_odata_v4.GetByKeyRequestBuilder.html | 4 ++-- .../sap_cloud_sdk_odata_v4.ODataActionRequestConfig.html | 4 ++-- .../sap_cloud_sdk_odata_v4.ODataBatchRequestBuilder.html | 4 ++-- ...loud_sdk_odata_v4.ODataBoundActionImportRequestConfig.html | 4 ++-- .../sap_cloud_sdk_odata_v4.ODataBoundActionRequestConfig.html | 4 ++-- ...ap_cloud_sdk_odata_v4.ODataBoundFunctionRequestConfig.html | 4 ++-- .../sap_cloud_sdk_odata_v4.ODataFunctionRequestConfig.html | 4 ++-- .../sap_cloud_sdk_odata_v4.OperationRequestBuilder.html | 4 ++-- .../classes/sap_cloud_sdk_odata_v4.UpdateRequestBuilder.html | 4 ++-- .../classes/sap_cloud_sdk_openapi.OpenApiRequestBuilder.html | 4 ++-- static/api/v3/classes/sap_cloud_sdk_util.ErrorWithCause.html | 4 ++-- .../v3/classes/sap_cloud_sdk_util.UniqueNameGenerator.html | 4 ++-- .../functions/sap_cloud_sdk_connectivity.alwaysProvider.html | 4 ++-- .../sap_cloud_sdk_connectivity.alwaysSubscriber.html | 4 ++-- .../sap_cloud_sdk_connectivity.assertHttpDestination.html | 4 ++-- ...sap_cloud_sdk_connectivity.buildHeadersForDestination.html | 4 ++-- .../v3/functions/sap_cloud_sdk_connectivity.decodeJwt.html | 4 ++-- ...p_cloud_sdk_connectivity.destinationForServiceBinding.html | 4 ++-- .../functions/sap_cloud_sdk_connectivity.getAgentConfig.html | 4 ++-- .../sap_cloud_sdk_connectivity.getAgentConfigAsync.html | 4 ++-- ...connectivity.getAllDestinationsFromDestinationService.html | 4 ++-- .../sap_cloud_sdk_connectivity.getClientCredentialsToken.html | 4 ++-- .../functions/sap_cloud_sdk_connectivity.getDestination.html | 4 ++-- ...sdk_connectivity.getDestinationFromDestinationService.html | 4 ++-- ...oud_sdk_connectivity.getDestinationFromServiceBinding.html | 4 ++-- .../sap_cloud_sdk_connectivity.getServiceBinding.html | 4 ++-- .../v3/functions/sap_cloud_sdk_connectivity.getTenantId.html | 4 ++-- .../v3/functions/sap_cloud_sdk_connectivity.getUserToken.html | 4 ++-- .../sap_cloud_sdk_connectivity.isHttpDestination.html | 4 ++-- .../functions/sap_cloud_sdk_connectivity.jwtBearerToken.html | 4 ++-- .../sap_cloud_sdk_connectivity.parseDestination.html | 4 ++-- .../functions/sap_cloud_sdk_connectivity.parseProxyEnv.html | 4 ++-- .../sap_cloud_sdk_connectivity.registerDestination.html | 4 ++-- .../v3/functions/sap_cloud_sdk_connectivity.retrieveJwt.html | 4 ++-- .../sap_cloud_sdk_connectivity.sanitizeDestination.html | 4 ++-- .../v3/functions/sap_cloud_sdk_connectivity.serviceToken.html | 4 ++-- .../sap_cloud_sdk_connectivity.setDestinationCache.html | 4 ++-- .../functions/sap_cloud_sdk_connectivity.subscriberFirst.html | 4 ++-- .../sap_cloud_sdk_connectivity.toDestinationNameUrl.html | 4 ++-- ...sdk_connectivity.transformServiceBindingToDestination.html | 4 ++-- .../sap_cloud_sdk_connectivity.useOrFetchDestination.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_generator.generate.html | 4 ++-- .../functions/sap_cloud_sdk_http_client.buildHttpRequest.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_http_client.csrf.html | 4 ++-- .../sap_cloud_sdk_http_client.encodeAllParameters.html | 4 ++-- .../sap_cloud_sdk_http_client.executeHttpRequest.html | 4 ++-- ...ap_cloud_sdk_http_client.executeHttpRequestWithOrigin.html | 4 ++-- .../api/v3/functions/sap_cloud_sdk_mail_client.sendMail.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_odata_common.and.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_odata_common.asc.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_odata_common.desc.html | 4 ++-- .../functions/sap_cloud_sdk_odata_common.entityBuilder-1.html | 4 ++-- .../sap_cloud_sdk_odata_common.entityDeserializer-1.html | 4 ++-- .../sap_cloud_sdk_odata_common.entitySerializer-1.html | 4 ++-- .../sap_cloud_sdk_odata_common.filterFunction-1.html | 2 +- .../sap_cloud_sdk_odata_common.isOrderableEdmType.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_odata_common.not.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_odata_common.or.html | 4 ++-- ..._sdk_odata_common.throwErrorWhenReturnTypeIsUnionType.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_odata_v2.edmToTs.html | 4 ++-- .../functions/sap_cloud_sdk_odata_v2.entityDeserializer.html | 4 ++-- .../v3/functions/sap_cloud_sdk_odata_v2.filterFunctions.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_odata_v2.length.html | 4 ++-- .../sap_cloud_sdk_odata_v2.mergeDefaultDeSerializersWith.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_odata_v2.replace.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_odata_v2.substring.html | 4 ++-- .../api/v3/functions/sap_cloud_sdk_odata_v2.substringOf.html | 4 ++-- ...cloud_sdk_odata_v2.transformReturnValueForComplexType.html | 4 ++-- ...d_sdk_odata_v2.transformReturnValueForComplexTypeList.html | 4 ++-- ...sap_cloud_sdk_odata_v2.transformReturnValueForEdmType.html | 4 ++-- ...cloud_sdk_odata_v2.transformReturnValueForEdmTypeList.html | 4 ++-- .../sap_cloud_sdk_odata_v2.transformReturnValueForEntity.html | 4 ++-- ..._cloud_sdk_odata_v2.transformReturnValueForEntityList.html | 4 ++-- ...p_cloud_sdk_odata_v2.transformReturnValueForUndefined.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_odata_v4.all.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_odata_v4.any.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_odata_v4.contains.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_odata_v4.edmToTs.html | 4 ++-- .../functions/sap_cloud_sdk_odata_v4.entityDeserializer.html | 4 ++-- .../v3/functions/sap_cloud_sdk_odata_v4.filterFunction.html | 2 +- .../v3/functions/sap_cloud_sdk_odata_v4.filterFunctions.html | 4 ++-- .../functions/sap_cloud_sdk_odata_v4.fractionalSeconds.html | 4 ++-- .../v3/functions/sap_cloud_sdk_odata_v4.hasSubsequence.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_odata_v4.hasSubset.html | 4 ++-- .../v3/functions/sap_cloud_sdk_odata_v4.matchesPattern.html | 4 ++-- .../api/v3/functions/sap_cloud_sdk_odata_v4.maxDateTime.html | 4 ++-- .../sap_cloud_sdk_odata_v4.mergeDefaultDeSerializersWith.html | 4 ++-- .../api/v3/functions/sap_cloud_sdk_odata_v4.minDateTime.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_odata_v4.now.html | 4 ++-- .../functions/sap_cloud_sdk_odata_v4.totalOffsetMinutes.html | 4 ++-- ...cloud_sdk_odata_v4.transformReturnValueForComplexType.html | 4 ++-- ...d_sdk_odata_v4.transformReturnValueForComplexTypeList.html | 4 ++-- ...sap_cloud_sdk_odata_v4.transformReturnValueForEdmType.html | 4 ++-- ...cloud_sdk_odata_v4.transformReturnValueForEdmTypeList.html | 4 ++-- .../sap_cloud_sdk_odata_v4.transformReturnValueForEntity.html | 4 ++-- ..._cloud_sdk_odata_v4.transformReturnValueForEntityList.html | 4 ++-- ...p_cloud_sdk_odata_v4.transformReturnValueForUndefined.html | 4 ++-- .../functions/sap_cloud_sdk_openapi_generator.generate.html | 4 ++-- .../v3/functions/sap_cloud_sdk_resilience.circuitBreaker.html | 4 ++-- .../sap_cloud_sdk_resilience.circuitBreakerHttp.html | 4 ++-- .../api/v3/functions/sap_cloud_sdk_resilience.resilience.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_resilience.retry.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_resilience.timeout.html | 4 ++-- .../sap_cloud_sdk_test_util.getTestDestinationByAlias.html | 4 ++-- .../sap_cloud_sdk_test_util.getTestDestinations.html | 4 ++-- .../sap_cloud_sdk_test_util.mockAllTestDestinations.html | 4 ++-- .../sap_cloud_sdk_test_util.mockTestDestination.html | 4 ++-- .../functions/sap_cloud_sdk_test_util.setTestDestination.html | 4 ++-- .../sap_cloud_sdk_test_util.unmockAllTestDestinations.html | 4 ++-- .../sap_cloud_sdk_test_util.unmockTestDestination.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_util.assoc.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_util.camelCase.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_util.caps.html | 4 ++-- .../api/v3/functions/sap_cloud_sdk_util.checkUrlExists.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_util.codeBlock.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_util.createLogger.html | 4 ++-- .../functions/sap_cloud_sdk_util.disableExceptionLogger.html | 4 ++-- .../v3/functions/sap_cloud_sdk_util.documentationBlock.html | 4 ++-- .../functions/sap_cloud_sdk_util.enableExceptionLogger.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_util.encodeBase64.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_util.equal.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_util.equalArrays.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_util.equalObjects.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_util.exclude.html | 4 ++-- .../api/v3/functions/sap_cloud_sdk_util.filterDuplicates.html | 4 ++-- .../functions/sap_cloud_sdk_util.filterDuplicatesRight.html | 4 ++-- .../api/v3/functions/sap_cloud_sdk_util.findProjectRoot.html | 2 +- static/api/v3/functions/sap_cloud_sdk_util.finishAll.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_util.first.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_util.flat.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_util.flatten.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_util.formatJson.html | 4 ++-- .../v3/functions/sap_cloud_sdk_util.getGlobalLogFormat.html | 4 ++-- .../v3/functions/sap_cloud_sdk_util.getGlobalLogLevel.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_util.getLogger.html | 4 ++-- .../v3/functions/sap_cloud_sdk_util.getMessageOrStack.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_util.identity.html | 4 ++-- .../api/v3/functions/sap_cloud_sdk_util.isErrorWithCause.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_util.isNullish.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_util.kebabCase.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_util.last.html | 4 ++-- .../api/v3/functions/sap_cloud_sdk_util.mergeIgnoreCase.html | 4 ++-- .../v3/functions/sap_cloud_sdk_util.mergeLeftIgnoreCase.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_util.muteLoggers.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_util.partition.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_util.pascalCase.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_util.pick.html | 4 ++-- .../api/v3/functions/sap_cloud_sdk_util.pickIgnoreCase.html | 4 ++-- .../api/v3/functions/sap_cloud_sdk_util.pickNonNullish.html | 4 ++-- .../v3/functions/sap_cloud_sdk_util.pickValueIgnoreCase.html | 4 ++-- .../api/v3/functions/sap_cloud_sdk_util.propertyExists.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_util.readJSON.html | 4 ++-- .../v3/functions/sap_cloud_sdk_util.removeFileExtension.html | 4 ++-- .../v3/functions/sap_cloud_sdk_util.removeLeadingSlashes.html | 2 +- static/api/v3/functions/sap_cloud_sdk_util.removeSlashes.html | 2 +- .../functions/sap_cloud_sdk_util.removeTrailingSlashes.html | 2 +- static/api/v3/functions/sap_cloud_sdk_util.renameKeys.html | 4 ++-- .../functions/sap_cloud_sdk_util.resetCustomLogFormats.html | 4 ++-- .../v3/functions/sap_cloud_sdk_util.resetCustomLogLevels.html | 4 ++-- .../api/v3/functions/sap_cloud_sdk_util.sanitizeRecord.html | 4 ++-- .../v3/functions/sap_cloud_sdk_util.setGlobalLogFormat.html | 4 ++-- .../v3/functions/sap_cloud_sdk_util.setGlobalLogLevel.html | 4 ++-- .../v3/functions/sap_cloud_sdk_util.setGlobalTransports.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_util.setLogFormat.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_util.setLogLevel.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_util.splitInChunks.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_util.titleFormat.html | 4 ++-- .../v3/functions/sap_cloud_sdk_util.toSanitizedObject.html | 4 ++-- .../sap_cloud_sdk_util.transformVariadicArgumentToArray.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_util.trim.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_util.trimLeft.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_util.trimRight.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_util.unique.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_util.unmuteLoggers.html | 4 ++-- .../v3/functions/sap_cloud_sdk_util.upperCaseSnakeCase.html | 4 ++-- static/api/v3/functions/sap_cloud_sdk_util.zip.html | 4 ++-- static/api/v3/hierarchy.html | 2 +- static/api/v3/index.html | 4 ++-- .../sap_cloud_sdk_connectivity.AllDestinations.html | 4 ++-- .../sap_cloud_sdk_connectivity.BasicProxyConfiguration.html | 4 ++-- .../v3/interfaces/sap_cloud_sdk_connectivity.CacheEntry.html | 4 ++-- .../interfaces/sap_cloud_sdk_connectivity.CachingOptions.html | 4 ++-- .../sap_cloud_sdk_connectivity.ClientCredentialsResponse.html | 4 ++-- .../v3/interfaces/sap_cloud_sdk_connectivity.Destination.html | 4 ++-- ...sap_cloud_sdk_connectivity.DestinationAccessorOptions.html | 4 ++-- .../sap_cloud_sdk_connectivity.DestinationAuthToken.html | 4 ++-- .../sap_cloud_sdk_connectivity.DestinationCertificate.html | 4 ++-- .../sap_cloud_sdk_connectivity.DestinationConfiguration.html | 4 ++-- .../sap_cloud_sdk_connectivity.DestinationFetchOptions.html | 4 ++-- ..._sdk_connectivity.DestinationForServiceBindingOptions.html | 4 ++-- .../sap_cloud_sdk_connectivity.DestinationJson.html | 4 ++-- .../sap_cloud_sdk_connectivity.DestinationsByType.html | 4 ++-- .../sap_cloud_sdk_connectivity.HttpAgentConfig.html | 4 ++-- .../sap_cloud_sdk_connectivity.HttpsAgentConfig.html | 4 ++-- .../v3/interfaces/sap_cloud_sdk_connectivity.JwtPayload.html | 4 ++-- .../sap_cloud_sdk_connectivity.ProxyConfiguration.html | 4 ++-- .../sap_cloud_sdk_connectivity.ProxyConfigurationHeaders.html | 4 ++-- .../api/v3/interfaces/sap_cloud_sdk_connectivity.Service.html | 4 ++-- .../sap_cloud_sdk_connectivity.VerifyJwtOptions.html | 4 ++-- .../interfaces/sap_cloud_sdk_generator.GeneratorOptions.html | 4 ++-- ...sap_cloud_sdk_generator_common.CommonGeneratorOptions.html | 4 ++-- .../sap_cloud_sdk_http_client.CsrfMiddlewareOptions.html | 4 ++-- ...ap_cloud_sdk_http_client.DestinationHttpRequestConfig.html | 4 ++-- .../sap_cloud_sdk_http_client.HttpMiddlewareContext.html | 4 ++-- .../sap_cloud_sdk_http_client.HttpRequestConfigBase.html | 4 ++-- .../sap_cloud_sdk_http_client.HttpRequestOptions.html | 4 ++-- .../v3/interfaces/sap_cloud_sdk_http_client.HttpResponse.html | 4 ++-- .../interfaces/sap_cloud_sdk_http_client.OriginOptions.html | 4 ++-- .../api/v3/interfaces/sap_cloud_sdk_mail_client.Address.html | 4 ++-- .../v3/interfaces/sap_cloud_sdk_mail_client.Attachment.html | 4 ++-- .../interfaces/sap_cloud_sdk_mail_client.AttachmentLike.html | 4 ++-- .../api/v3/interfaces/sap_cloud_sdk_mail_client.Envelope.html | 4 ++-- .../sap_cloud_sdk_mail_client.MailClientOptions.html | 4 ++-- .../v3/interfaces/sap_cloud_sdk_mail_client.MailConfig.html | 4 ++-- .../v3/interfaces/sap_cloud_sdk_mail_client.MailResponse.html | 4 ++-- .../v3/interfaces/sap_cloud_sdk_mail_client.SDKOptions.html | 4 ++-- .../sap_cloud_sdk_mail_client.SmtpTransportOptions.html | 4 ++-- .../interfaces/sap_cloud_sdk_odata_common.BatchReference.html | 4 ++-- .../sap_cloud_sdk_odata_common.ComplexTypeNamespace.html | 4 ++-- .../interfaces/sap_cloud_sdk_odata_common.Constructable.html | 4 ++-- .../interfaces/sap_cloud_sdk_odata_common.DeSerializer.html | 4 ++-- .../interfaces/sap_cloud_sdk_odata_common.DeSerializers.html | 4 ++-- .../v3/interfaces/sap_cloud_sdk_odata_common.EntityApi.html | 4 ++-- .../sap_cloud_sdk_odata_common.EntityDeserializer.html | 4 ++-- .../sap_cloud_sdk_odata_common.EntityIdentifiable.html | 4 ++-- .../sap_cloud_sdk_odata_common.EntitySerializer.html | 4 ++-- .../interfaces/sap_cloud_sdk_odata_common.ErrorResponse.html | 4 ++-- .../interfaces/sap_cloud_sdk_odata_common.FieldOptions.html | 4 ++-- .../sap_cloud_sdk_odata_common.FilterFunctionsType.html | 4 ++-- .../v3/interfaces/sap_cloud_sdk_odata_common.ODataUri.html | 4 ++-- .../sap_cloud_sdk_odata_common.PropertyMetadata.html | 4 ++-- .../interfaces/sap_cloud_sdk_odata_common.ReadResponse.html | 4 ++-- .../sap_cloud_sdk_odata_common.ResponseDataAccessor.html | 4 ++-- static/api/v3/interfaces/sap_cloud_sdk_odata_common.Time.html | 4 ++-- .../sap_cloud_sdk_odata_common.WithBatchReference.html | 4 ++-- .../v3/interfaces/sap_cloud_sdk_odata_common.WithETag.html | 4 ++-- .../sap_cloud_sdk_odata_common.WithGetAllRestrictions.html | 4 ++-- .../v3/interfaces/sap_cloud_sdk_odata_common.WithKeys.html | 4 ++-- .../interfaces/sap_cloud_sdk_odata_common.WithSelection.html | 4 ++-- .../interfaces/sap_cloud_sdk_odata_common.WriteResponse.html | 4 ++-- .../interfaces/sap_cloud_sdk_odata_common.WriteResponses.html | 4 ++-- .../v3/interfaces/sap_cloud_sdk_odata_v2.DeSerializers.html | 4 ++-- .../v3/interfaces/sap_cloud_sdk_odata_v4.DeSerializers.html | 4 ++-- .../sap_cloud_sdk_openapi.OpenApiRequestParameters.html | 4 ++-- ...p_cloud_sdk_openapi_generator.OpenAPIGeneratorOptions.html | 4 ++-- .../sap_cloud_sdk_resilience.MiddlewareContext.html | 4 ++-- .../sap_cloud_sdk_resilience.MiddlewareOptions.html | 4 ++-- .../sap_cloud_sdk_resilience.ResilienceOptions.html | 4 ++-- .../sap_cloud_sdk_test_util.GetTestDestinationOptions.html | 4 ++-- .../api/v3/interfaces/sap_cloud_sdk_util.LoggerOptions.html | 4 ++-- .../v3/interfaces/sap_cloud_sdk_util.MessageContextObj.html | 4 ++-- static/api/v3/modules/sap_cloud_sdk_connectivity.html | 4 ++-- static/api/v3/modules/sap_cloud_sdk_generator.html | 4 ++-- static/api/v3/modules/sap_cloud_sdk_generator_common.html | 4 ++-- static/api/v3/modules/sap_cloud_sdk_http_client.html | 4 ++-- static/api/v3/modules/sap_cloud_sdk_mail_client.html | 4 ++-- static/api/v3/modules/sap_cloud_sdk_odata_common.html | 4 ++-- static/api/v3/modules/sap_cloud_sdk_odata_v2.html | 4 ++-- static/api/v3/modules/sap_cloud_sdk_odata_v4.html | 4 ++-- static/api/v3/modules/sap_cloud_sdk_openapi.html | 4 ++-- static/api/v3/modules/sap_cloud_sdk_openapi_generator.html | 4 ++-- static/api/v3/modules/sap_cloud_sdk_resilience.html | 4 ++-- .../api/v3/modules/sap_cloud_sdk_temporal_de_serializers.html | 4 ++-- static/api/v3/modules/sap_cloud_sdk_test_util.html | 4 ++-- static/api/v3/modules/sap_cloud_sdk_util.html | 4 ++-- .../sap_cloud_sdk_connectivity.AllDestinationOptions.html | 4 ++-- .../types/sap_cloud_sdk_connectivity.AuthenticationType.html | 4 ++-- .../sap_cloud_sdk_connectivity.DestinationCacheInterface.html | 4 ++-- .../types/sap_cloud_sdk_connectivity.DestinationOptions.html | 4 ++-- .../sap_cloud_sdk_connectivity.DestinationOrFetchOptions.html | 4 ++-- .../sap_cloud_sdk_connectivity.DestinationProxyType.html | 4 ++-- ...ap_cloud_sdk_connectivity.DestinationRetrievalOptions.html | 4 ++-- ...p_cloud_sdk_connectivity.DestinationSelectionStrategy.html | 4 ++-- .../types/sap_cloud_sdk_connectivity.DestinationWithName.html | 4 ++-- .../sap_cloud_sdk_connectivity.DestinationWithoutToken.html | 4 ++-- .../v3/types/sap_cloud_sdk_connectivity.HttpDestination.html | 4 ++-- ..._cloud_sdk_connectivity.HttpDestinationOrFetchOptions.html | 4 ++-- .../types/sap_cloud_sdk_connectivity.IsolationStrategy.html | 4 ++-- ...cloud_sdk_connectivity.PartialDestinationFetchOptions.html | 4 ++-- static/api/v3/types/sap_cloud_sdk_connectivity.Protocol.html | 4 ++-- ...sap_cloud_sdk_connectivity.RegisterDestinationOptions.html | 4 ++-- ...loud_sdk_connectivity.ServiceBindingTransformFunction.html | 4 ++-- ...cloud_sdk_connectivity.ServiceBindingTransformOptions.html | 4 ++-- .../types/sap_cloud_sdk_connectivity.ServiceCredentials.html | 4 ++-- .../sap_cloud_sdk_connectivity.XsuaaServiceCredentials.html | 4 ++-- .../types/sap_cloud_sdk_http_client.CustomRequestConfig.html | 4 ++-- .../v3/types/sap_cloud_sdk_http_client.HttpMiddleware.html | 4 ++-- .../sap_cloud_sdk_http_client.HttpMiddlewareOptions.html | 4 ++-- .../v3/types/sap_cloud_sdk_http_client.HttpRequestConfig.html | 4 ++-- ...sap_cloud_sdk_http_client.HttpRequestConfigWithOrigin.html | 4 ++-- static/api/v3/types/sap_cloud_sdk_http_client.Method.html | 4 ++-- .../v3/types/sap_cloud_sdk_http_client.ParameterEncoder.html | 4 ++-- static/api/v3/types/sap_cloud_sdk_mail_client.Headers.html | 4 ++-- .../sap_cloud_sdk_odata_common.BatchSubRequestPathType.html | 4 ++-- .../sap_cloud_sdk_odata_common.ChangesetBuilderTypes.html | 4 ++-- .../types/sap_cloud_sdk_odata_common.CollectionFieldType.html | 4 ++-- ...ap_cloud_sdk_odata_common.ComplexTypeFieldConstructor.html | 4 ++-- .../sap_cloud_sdk_odata_common.ComplexTypePropertyFields.html | 4 ++-- .../types/sap_cloud_sdk_odata_common.ConstructorOrField.html | 4 ++-- .../types/sap_cloud_sdk_odata_common.CustomOrDefaultType.html | 4 ++-- .../sap_cloud_sdk_odata_common.DefaultDeSerializers.html | 4 ++-- .../v3/types/sap_cloud_sdk_odata_common.DeserializedType.html | 4 ++-- .../v3/types/sap_cloud_sdk_odata_common.EdmTypeCommon.html | 4 ++-- ...sap_cloud_sdk_odata_common.EdmTypeDifferentConverters.html | 4 ++-- .../sap_cloud_sdk_odata_common.EdmTypeSameConverters.html | 4 ++-- .../v3/types/sap_cloud_sdk_odata_common.EdmTypeShared.html | 4 ++-- .../types/sap_cloud_sdk_odata_common.EntityBuilderType.html | 4 ++-- .../api/v3/types/sap_cloud_sdk_odata_common.EntityType.html | 4 ++-- .../sap_cloud_sdk_odata_common.EntityTypeFromFieldOf.html | 4 ++-- .../types/sap_cloud_sdk_odata_common.ExclusiveEdmTypeV2.html | 4 ++-- .../types/sap_cloud_sdk_odata_common.ExclusiveEdmTypeV4.html | 4 ++-- .../api/v3/types/sap_cloud_sdk_odata_common.Expandable.html | 4 ++-- .../types/sap_cloud_sdk_odata_common.FieldTypeByEdmType.html | 4 ++-- ...ap_cloud_sdk_odata_common.FilterFunctionParameterType.html | 4 ++-- ...sdk_odata_common.FilterFunctionPrimitiveParameterType.html | 4 ++-- .../types/sap_cloud_sdk_odata_common.FilterFunctionTypes.html | 4 ++-- .../sap_cloud_sdk_odata_common.FilterLambdaOperator.html | 4 ++-- .../v3/types/sap_cloud_sdk_odata_common.FilterOperator.html | 4 ++-- .../sap_cloud_sdk_odata_common.FilterOperatorBoolean.html | 4 ++-- .../sap_cloud_sdk_odata_common.FilterOperatorNumber.html | 4 ++-- .../sap_cloud_sdk_odata_common.FilterOperatorString.html | 4 ++-- .../api/v3/types/sap_cloud_sdk_odata_common.Filterable.html | 4 ++-- .../api/v3/types/sap_cloud_sdk_odata_common.FromJsonType.html | 4 ++-- .../sap_cloud_sdk_odata_common.FunctionImportParameters.html | 4 ++-- .../types/sap_cloud_sdk_odata_common.IsSelectableField.html | 4 ++-- .../v3/types/sap_cloud_sdk_odata_common.NonNullishType.html | 4 ++-- .../types/sap_cloud_sdk_odata_common.NullableFieldType.html | 4 ++-- .../api/v3/types/sap_cloud_sdk_odata_common.NullishTypes.html | 4 ++-- .../v3/types/sap_cloud_sdk_odata_common.ODataVersionOf.html | 4 ++-- .../types/sap_cloud_sdk_odata_common.OperationParameters.html | 4 ++-- static/api/v3/types/sap_cloud_sdk_odata_common.OrderType.html | 4 ++-- static/api/v3/types/sap_cloud_sdk_odata_common.Orderable.html | 4 ++-- ...sap_cloud_sdk_odata_common.OrderableAndOrderableInput.html | 4 ++-- .../v3/types/sap_cloud_sdk_odata_common.OrderableEdmType.html | 4 ++-- .../v3/types/sap_cloud_sdk_odata_common.OrderableInput.html | 4 ++-- .../v3/types/sap_cloud_sdk_odata_common.PureEntityType.html | 4 ++-- .../types/sap_cloud_sdk_odata_common.RequestMethodType.html | 4 ++-- .../api/v3/types/sap_cloud_sdk_odata_common.Selectable.html | 4 ++-- .../v3/types/sap_cloud_sdk_odata_common.SimpleTypeFields.html | 4 ++-- static/api/v3/types/sap_cloud_sdk_odata_v2.BatchResponse.html | 4 ++-- .../v3/types/sap_cloud_sdk_odata_v2.CustomDeSerializers.html | 4 ++-- .../v3/types/sap_cloud_sdk_odata_v2.CustomOrDefaultType.html | 4 ++-- .../v3/types/sap_cloud_sdk_odata_v2.DefaultDeSerializers.html | 4 ++-- .../v3/types/sap_cloud_sdk_odata_v2.FilterFunctionsType.html | 4 ++-- .../types/sap_cloud_sdk_odata_v4.ActionImportParameters.html | 4 ++-- static/api/v3/types/sap_cloud_sdk_odata_v4.BatchResponse.html | 4 ++-- .../v3/types/sap_cloud_sdk_odata_v4.CustomDeSerializers.html | 4 ++-- .../v3/types/sap_cloud_sdk_odata_v4.CustomOrDefaultType.html | 4 ++-- .../v3/types/sap_cloud_sdk_odata_v4.DefaultDeSerializers.html | 4 ++-- .../v3/types/sap_cloud_sdk_odata_v4.FilterFunctionTypes.html | 4 ++-- .../sap_cloud_sdk_openapi_generator.GeneratorOptions.html | 4 ++-- static/api/v3/types/sap_cloud_sdk_resilience.Middleware.html | 4 ++-- .../v3/types/sap_cloud_sdk_resilience.MiddlewareFunction.html | 4 ++-- static/api/v3/types/sap_cloud_sdk_util.LogLevel.html | 4 ++-- static/api/v3/types/sap_cloud_sdk_util.ODataVersion.html | 4 ++-- static/api/v3/types/sap_cloud_sdk_util.Without.html | 4 ++-- static/api/v3/types/sap_cloud_sdk_util.Xor.html | 4 ++-- ...cloud_sdk_connectivity.DestinationSelectionStrategies.html | 4 ++-- .../sap_cloud_sdk_http_client.defaultDisallowedKeys.html | 4 ++-- ...k_odata_common.ActionFunctionImportRequestBuilderBase.html | 4 ++-- .../sap_cloud_sdk_odata_common.FunctionImportParameter.html | 4 ++-- ...oud_sdk_odata_common.ODataFunctionImportRequestConfig.html | 4 ++-- .../sap_cloud_sdk_odata_v2.FunctionImportRequestBuilder.html | 4 ++-- ...p_cloud_sdk_odata_v2.ODataFunctionImportRequestConfig.html | 4 ++-- .../sap_cloud_sdk_odata_v2.defaultDeSerializers-1.html | 4 ++-- ...sap_cloud_sdk_odata_v4.ODataActionImportRequestConfig.html | 4 ++-- ...p_cloud_sdk_odata_v4.ODataFunctionImportRequestConfig.html | 4 ++-- ...ud_sdk_odata_v4.OdataBoundFunctionImportRequestConfig.html | 4 ++-- .../sap_cloud_sdk_odata_v4.defaultDeSerializers-1.html | 4 ++-- ...d_sdk_temporal_de_serializers.temporalDeSerializersV2.html | 4 ++-- ...d_sdk_temporal_de_serializers.temporalDeSerializersV4.html | 4 ++-- .../variables/sap_cloud_sdk_util.cloudSdkExceptionLogger.html | 4 ++-- static/api/v3/variables/sap_cloud_sdk_util.kibana.html | 4 ++-- static/api/v3/variables/sap_cloud_sdk_util.local.html | 4 ++-- static/api/v3/variables/sap_cloud_sdk_util.logFormat.html | 4 ++-- static/api/v3/variables/sap_cloud_sdk_util.unixEOL.html | 4 ++-- static/api/v3/variables/sap_cloud_sdk_util.webEOL.html | 4 ++-- 447 files changed, 887 insertions(+), 887 deletions(-) diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_common.AllFields.html b/static/api/v3/classes/sap_cloud_sdk_odata_common.AllFields.html index f5665ef2c9..aaf2530a10 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_common.AllFields.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_common.AllFields.html @@ -1,8 +1,8 @@ -AllFields | SAP Cloud SDK for JavaScript - v3.22.0

Class AllFields<EntityT>

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

Class AllFields<EntityT>

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

Type Parameters

Constructors

constructor

Properties

_entityConstructor _fieldName selectable

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

-

Constructors

constructor

Properties

_entityConstructor

_entityConstructor: Constructable<EntityT>

_fieldName

_fieldName: string

Readonlyselectable

selectable: true

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

_entityConstructor

_entityConstructor: Constructable<EntityT>

_fieldName

_fieldName: string

Readonlyselectable

selectable: true

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_common.BatchChangeSet.html b/static/api/v3/classes/sap_cloud_sdk_odata_common.BatchChangeSet.html index fa3fd391de..a6b06aff3c 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_common.BatchChangeSet.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_common.BatchChangeSet.html @@ -1,4 +1,4 @@ -BatchChangeSet | SAP Cloud SDK for JavaScript - v3.22.0

Class BatchChangeSet<DeSerializersT>

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

+BatchChangeSet | SAP Cloud SDK for JavaScript - v3.22.1

Class BatchChangeSet<DeSerializersT>

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

Type Parameters

Constructors

constructor

Properties

boundary requests @@ -6,4 +6,4 @@

Type Parameters

Parameters

  • requests: ChangesetBuilderTypes<DeSerializersT>[]

    Requests to combine to one change set.

  • Optionalboundary: string

    Request boundary for separation of sub requests. Defaults to an auto generated value.

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

    -

Returns BatchChangeSet<DeSerializersT>

Properties

Readonlyboundary

boundary: string

Readonlyrequests

requests: ChangesetBuilderTypes<DeSerializersT>[]

Settings

Member Visibility

On This Page

Constructors
Properties
+

Returns BatchChangeSet<DeSerializersT>

Properties

Readonlyboundary

boundary: string

Readonlyrequests

requests: ChangesetBuilderTypes<DeSerializersT>[]

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_common.BooleanFilterFunction.html b/static/api/v3/classes/sap_cloud_sdk_odata_common.BooleanFilterFunction.html index 6c7c3b7f91..4eac9322f1 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_common.BooleanFilterFunction.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_common.BooleanFilterFunction.html @@ -1,4 +1,4 @@ -BooleanFilterFunction | SAP Cloud SDK for JavaScript - v3.22.0

Class BooleanFilterFunction<EntityT>

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

+BooleanFilterFunction | SAP Cloud SDK for JavaScript - v3.22.1

Class BooleanFilterFunction<EntityT>

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

Type Parameters

Hierarchy (view full)

Constructors

constructor

Properties

edmType functionName @@ -15,4 +15,4 @@

Parameters

  • value: boolean

    Value to be used in the filter.

Returns Filter<EntityT, any, boolean>

The resulting filter.

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

-

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_common.CollectionField.html b/static/api/v3/classes/sap_cloud_sdk_odata_common.CollectionField.html index 77ab67f708..a07406e58f 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_common.CollectionField.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_common.CollectionField.html @@ -1,4 +1,4 @@ -CollectionField | SAP Cloud SDK for JavaScript - v3.22.0

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

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

+CollectionField | SAP Cloud SDK for JavaScript - v3.22.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.

    @@ -20,4 +20,4 @@

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

Properties

Readonly_deSerializers

_deSerializers: DeSerializersT

Readonly_entityConstructor

_entityConstructor: Constructable<EntityT>

Readonly_fieldName

_fieldName: string

Readonly_fieldOf

_fieldOf: ConstructorOrField<EntityT>

Readonly_fieldOptions

_fieldOptions: Required<FieldOptions<NullableT, SelectableT>>

Readonly_fieldType

_fieldType: CollectionFieldType<CollectionFieldT>

Methods

fieldPath

  • fieldPath(): string

  • 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.

    -

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_common.CollectionFilterFunction.html b/static/api/v3/classes/sap_cloud_sdk_odata_common.CollectionFilterFunction.html index 889596d737..c7b06961a7 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_common.CollectionFilterFunction.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_common.CollectionFilterFunction.html @@ -1,4 +1,4 @@ -CollectionFilterFunction | SAP Cloud SDK for JavaScript - v3.22.0

Class CollectionFilterFunction<EntityT, FieldT>

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

+CollectionFilterFunction | SAP Cloud SDK for JavaScript - v3.22.1

Class CollectionFilterFunction<EntityT, FieldT>

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

Type Parameters

Hierarchy (view full)

Constructors

constructor

Properties

edmType functionName @@ -16,4 +16,4 @@

Parameters

  • value: FieldT[]

    Value to be used in the filter.

Returns Filter<EntityT, any, FieldT[]>

The resulting filter.

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

-

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_common.ComplexTypeField.html b/static/api/v3/classes/sap_cloud_sdk_odata_common.ComplexTypeField.html index ab4a9359d3..533a51d7c5 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_common.ComplexTypeField.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_common.ComplexTypeField.html @@ -1,4 +1,4 @@ -ComplexTypeField | SAP Cloud SDK for JavaScript - v3.22.0

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.22.1

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. @@ -31,4 +31,4 @@

ReadonlydeSerializers

deSerializers: DeSerializersT

ReadonlyfieldOf

fieldOf: ConstructorOrField<EntityT, ComplexT>

Methods

fieldPath

  • fieldPath(): string

  • 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.

    -

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_common.CountRequestBuilder.html b/static/api/v3/classes/sap_cloud_sdk_odata_common.CountRequestBuilder.html index 0fd337b555..69d3245548 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_common.CountRequestBuilder.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_common.CountRequestBuilder.html @@ -1,4 +1,4 @@ -CountRequestBuilder | SAP Cloud SDK for JavaScript - v3.22.0

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.22.1

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

  • EntityT extends EntityBase

    Type of the entity to be requested

    @@ -55,4 +55,4 @@

    Parameters

    Returns Promise<string>

    Promise resolving to the URL for the request.

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

    -

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_common.CreateRequestBuilderBase.html b/static/api/v3/classes/sap_cloud_sdk_odata_common.CreateRequestBuilderBase.html index 5926df89c4..a64e1b045a 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_common.CreateRequestBuilderBase.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_common.CreateRequestBuilderBase.html @@ -1,4 +1,4 @@ -CreateRequestBuilderBase | SAP Cloud SDK for JavaScript - v3.22.0

Class CreateRequestBuilderBase<EntityT, DeSerializersT>Abstract

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

+CreateRequestBuilderBase | SAP Cloud SDK for JavaScript - v3.22.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

constructor

Properties

_deSerializers @@ -78,4 +78,4 @@

Parameters

Returns Promise<string>

Promise resolving to the URL for the request.

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

-

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_common.CustomField.html b/static/api/v3/classes/sap_cloud_sdk_odata_common.CustomField.html index 4316210dd1..200613c06f 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_common.CustomField.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_common.CustomField.html @@ -1,4 +1,4 @@ -CustomField | SAP Cloud SDK for JavaScript - v3.22.0

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.22.1

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

constructor

Properties

_entityConstructor @@ -22,4 +22,4 @@

Constructors

constructor

Properties

Readonly_entityConstructor

_entityConstructor: Constructable<EntityT>

Readonly_fieldName

_fieldName: string

Readonly_fieldOptions

_fieldOptions: Required<FieldOptions<NullableT, false>>

ProtectedfieldBuilder

fieldBuilder: FieldBuilder<Constructable<EntityT>, DeSerializersT>

Methods

edmBinary

edmBoolean

edmByte

edmDateTimeOffset

edmDecimal

edmDouble

edmGuid

edmInt16

edmInt32

edmInt64

edmSByte

edmSingle

edmString

fieldPath

  • fieldPath(): string

  • 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.

    -

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_common.DeleteRequestBuilderBase.html b/static/api/v3/classes/sap_cloud_sdk_odata_common.DeleteRequestBuilderBase.html index 4111989e7e..d8f07fd50a 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_common.DeleteRequestBuilderBase.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_common.DeleteRequestBuilderBase.html @@ -1,4 +1,4 @@ -DeleteRequestBuilderBase | SAP Cloud SDK for JavaScript - v3.22.0

Class DeleteRequestBuilderBase<EntityT, DeSerializersT>Abstract

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

+DeleteRequestBuilderBase | SAP Cloud SDK for JavaScript - v3.22.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

constructor

Properties

_deSerializers @@ -69,4 +69,4 @@

Parameters

Returns Promise<string>

Promise resolving to the URL for the request.

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

-

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_common.EdmTypeField.html b/static/api/v3/classes/sap_cloud_sdk_odata_common.EdmTypeField.html index 4a1888d5d6..78a3a040ee 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_common.EdmTypeField.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_common.EdmTypeField.html @@ -1,4 +1,4 @@ -EdmTypeField | SAP Cloud SDK for JavaScript - v3.22.0

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.22.1

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. @@ -38,4 +38,4 @@

Parameters

Returns Filter<EntityT, DeSerializersT, NullableFieldType<DeserializedType<DeSerializersT, EdmT>, NullableT>>

The resulting filter.

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

-

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_common.EntityBase.html b/static/api/v3/classes/sap_cloud_sdk_odata_common.EntityBase.html index cbe18b452e..a6872a316f 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_common.EntityBase.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_common.EntityBase.html @@ -1,4 +1,4 @@ -EntityBase | SAP Cloud SDK for JavaScript - v3.22.0

Class EntityBaseAbstract

Super class for all representations of OData entity types.

+EntityBase | SAP Cloud SDK for JavaScript - v3.22.1

Class EntityBaseAbstract

Super class for all representations of OData entity types.

Hierarchy (view full)

Constructors

constructor

Properties

_customFields _entityApi @@ -77,4 +77,4 @@

toJSON

  • toJSON(): {
        [key: string]: any;
    }

  • 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

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
+
  • [key: string]: any

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_common.EntityBuilder.html b/static/api/v3/classes/sap_cloud_sdk_odata_common.EntityBuilder.html index 63029b84f7..2df005a210 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_common.EntityBuilder.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_common.EntityBuilder.html @@ -1,4 +1,4 @@ -EntityBuilder | SAP Cloud SDK for JavaScript - v3.22.0

Class EntityBuilder<EntityT, DeSerializersT>

Contains the methods to build an entity.

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

Class EntityBuilder<EntityT, DeSerializersT>

Contains the methods to build an entity.

Type Parameters

Constructors

constructor

Properties

_entity _entityApi @@ -16,4 +16,4 @@

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.

-

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_common.EnumField.html b/static/api/v3/classes/sap_cloud_sdk_odata_common.EnumField.html index fb8a0757c2..d780310b16 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_common.EnumField.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_common.EnumField.html @@ -1,4 +1,4 @@ -EnumField | SAP Cloud SDK for JavaScript - v3.22.0

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

Represents a property with an enum value.

+EnumField | SAP Cloud SDK for JavaScript - v3.22.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.

    @@ -27,4 +27,4 @@

    Parameters

    • value: `${EnumT}`

      Value to be used in the filter.

    Returns Filter<EntityT, DeSerializersT, string>

    The resulting filter.

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

    -

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_common.Field.html b/static/api/v3/classes/sap_cloud_sdk_odata_common.Field.html index 7c980c62a5..36580d8c68 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_common.Field.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_common.Field.html @@ -1,4 +1,4 @@ -Field | SAP Cloud SDK for JavaScript - v3.22.0

Class Field<EntityT, NullableT, SelectableT>

Abstract representation a property of an OData entity.

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

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.

@@ -18,4 +18,4 @@

Returns Field<EntityT, NullableT, SelectableT>

Properties

Readonly_entityConstructor

_entityConstructor: Constructable<EntityT>

Readonly_fieldName

_fieldName: string

Readonly_fieldOptions

_fieldOptions: Required<FieldOptions<NullableT, SelectableT>>

Methods

fieldPath

  • fieldPath(): string

  • 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.

    -

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
+

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_common.FieldBuilder.html b/static/api/v3/classes/sap_cloud_sdk_odata_common.FieldBuilder.html index f894320db4..6c5197ea50 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_common.FieldBuilder.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_common.FieldBuilder.html @@ -1,4 +1,4 @@ -FieldBuilder | SAP Cloud SDK for JavaScript - v3.22.0

Class FieldBuilder<FieldOfT, DeSerializersT>

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

+FieldBuilder | SAP Cloud SDK for JavaScript - v3.22.1

Class FieldBuilder<FieldOfT, DeSerializersT>

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

constructor @@ -29,4 +29,4 @@
  • isNullable: NullableT

    Whether the field is nullable.

    • Returns EnumField<EntityTypeFromFieldOf<FieldOfT>, DeSerializersT, EnumT, NullableT, IsSelectableField<FieldOfT>>

    A collection field with the given collection type.

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

    -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_common.Filter.html b/static/api/v3/classes/sap_cloud_sdk_odata_common.Filter.html index 074eef030a..dcc7752c53 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_common.Filter.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_common.Filter.html @@ -1,4 +1,4 @@ -Filter | SAP Cloud SDK for JavaScript - v3.22.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. +Filter | SAP Cloud SDK for JavaScript - v3.22.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. 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}.
    @@ -20,4 +20,4 @@

    Returns Filter<EntityT, DeSerializersT, FieldT>

    Properties

    Readonly_deSerializers

    _deSerializers: DeSerializersT

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

    Readonly_entity

    _entity: EntityT

    Entity type of the entity tp be filtered.

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

    -

    OptionaledmType

    edmType?: EdmTypeShared<ODataVersionOf<EntityT>>

    field

    field: string | FilterFunction<EntityT, FieldT>

    operator

    operator: FilterOperator

    value

    value: FieldT

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    +

    OptionaledmType

    edmType?: EdmTypeShared<ODataVersionOf<EntityT>>

    field

    field: string | FilterFunction<EntityT, FieldT>

    operator

    operator: FilterOperator

    value

    value: FieldT

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_common.FilterFunction.html b/static/api/v3/classes/sap_cloud_sdk_odata_common.FilterFunction.html index fd928c16c1..dfc7d91d04 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_common.FilterFunction.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_common.FilterFunction.html @@ -1,4 +1,4 @@ -FilterFunction | SAP Cloud SDK for JavaScript - v3.22.0

    Class FilterFunction<EntityT, ReturnT>Abstract

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

    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

    constructor

    Properties

    edmType @@ -17,4 +17,4 @@

    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.

    -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_common.FilterLambdaExpression.html b/static/api/v3/classes/sap_cloud_sdk_odata_common.FilterLambdaExpression.html index 168b214d9f..d3d0cb55f3 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_common.FilterLambdaExpression.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_common.FilterLambdaExpression.html @@ -1,6 +1,6 @@ -FilterLambdaExpression | SAP Cloud SDK for JavaScript - v3.22.0

    Class FilterLambdaExpression<EntityT, DeSerializersT>

    Class representing a filter expression based on a FilterLambdaOperator.

    +FilterLambdaExpression | SAP Cloud SDK for JavaScript - v3.22.1

    Class FilterLambdaExpression<EntityT, DeSerializersT>

    Class representing a filter expression based on a FilterLambdaOperator.

    Type Parameters

    Constructors

    constructor

    Properties

    filters lambdaOperator

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

    -

    Constructors

    constructor

    Properties

    filters

    filters: FilterList<EntityT, DeSerializersT>

    lambdaOperator

    lambdaOperator: FilterLambdaOperator

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    +

    Constructors

    constructor

    Properties

    filters

    filters: FilterList<EntityT, DeSerializersT>

    lambdaOperator

    lambdaOperator: FilterLambdaOperator

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_common.FilterLink.html b/static/api/v3/classes/sap_cloud_sdk_odata_common.FilterLink.html index f6c93e3685..c942cbb790 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_common.FilterLink.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_common.FilterLink.html @@ -1,4 +1,4 @@ -FilterLink | SAP Cloud SDK for JavaScript - v3.22.0

    Class FilterLink<EntityT, DeSerializersT, LinkedEntityApiT>

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

    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}.
    @@ -18,4 +18,4 @@

    Readonly_entity

    _entity: EntityT

    Entity type of the entity tp be filtered.

    Readonly_linkedEntityType

    _linkedEntityType: EntityType<LinkedEntityApiT>

    Linked entity to be filtered by.

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

    -

    filters

    filters: Filterable<EntityType<LinkedEntityApiT>, DeSerializersT>[]

    link

    link: Link<EntityT, DeSerializersT, LinkedEntityApiT>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    +

    filters

    filters: Filterable<EntityType<LinkedEntityApiT>, DeSerializersT>[]

    link

    link: Link<EntityT, DeSerializersT, LinkedEntityApiT>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_common.FilterList.html b/static/api/v3/classes/sap_cloud_sdk_odata_common.FilterList.html index 2d5e69ec57..f3d2631fc7 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_common.FilterList.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_common.FilterList.html @@ -1,4 +1,4 @@ -FilterList | SAP Cloud SDK for JavaScript - v3.22.0

    Class FilterList<EntityT, DeSerializersT>

    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.

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

    Class FilterList<EntityT, DeSerializersT>

    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

    constructor

    Properties

    _deSerializers _entity @@ -10,4 +10,4 @@

    Returns FilterList<EntityT, DeSerializersT>

    Properties

    _deSerializers

    _deSerializers: DeSerializersT

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

    Readonly_entity

    _entity: EntityT

    Entity type of the entity tp be filtered.

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

    -

    andFilters

    andFilters: Filterable<EntityT, DeSerializersT>[]

    orFilters

    orFilters: Filterable<EntityT, DeSerializersT>[]

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    +

    andFilters

    andFilters: Filterable<EntityT, DeSerializersT>[]

    orFilters

    orFilters: Filterable<EntityT, DeSerializersT>[]

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_common.GetAllRequestBuilderBase.html b/static/api/v3/classes/sap_cloud_sdk_odata_common.GetAllRequestBuilderBase.html index c531941125..ca00d970fb 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_common.GetAllRequestBuilderBase.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_common.GetAllRequestBuilderBase.html @@ -1,4 +1,4 @@ -GetAllRequestBuilderBase | SAP Cloud SDK for JavaScript - v3.22.0

    Class GetAllRequestBuilderBase<EntityT, DeSerializersT>Abstract

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

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

    Class GetAllRequestBuilderBase<EntityT, DeSerializersT>Abstract

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

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _deSerializers @@ -85,4 +85,4 @@

    Parameters

    Returns Promise<string>

    Promise resolving to the URL for the request.

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

    -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_common.GetByKeyRequestBuilderBase.html b/static/api/v3/classes/sap_cloud_sdk_odata_common.GetByKeyRequestBuilderBase.html index 40f587cffe..27a815ffd8 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_common.GetByKeyRequestBuilderBase.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_common.GetByKeyRequestBuilderBase.html @@ -1,4 +1,4 @@ -GetByKeyRequestBuilderBase | SAP Cloud SDK for JavaScript - v3.22.0

    Class GetByKeyRequestBuilderBase<EntityT, DeSerializersT>Abstract

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

    +GetByKeyRequestBuilderBase | SAP Cloud SDK for JavaScript - v3.22.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

    constructor

    Properties

    _deSerializers @@ -77,4 +77,4 @@

    Parameters

    Returns Promise<string>

    Promise resolving to the URL for the request.

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

    -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_common.Link.html b/static/api/v3/classes/sap_cloud_sdk_odata_common.Link.html index 2b0df7165f..8ef6c62ba3 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_common.Link.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_common.Link.html @@ -1,4 +1,4 @@ -Link | SAP Cloud SDK for JavaScript - v3.22.0

    Class Link<EntityT, DeSerializersT, LinkedEntityApiT>

    Represents a navigation property of an OData entity.

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

    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. @@ -35,4 +35,4 @@

    Parameters

    Returns this

    The link itself, to facilitate method chaining.

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

    -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_common.NumberFilterFunction.html b/static/api/v3/classes/sap_cloud_sdk_odata_common.NumberFilterFunction.html index 2413b009a6..b3874c0035 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_common.NumberFilterFunction.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_common.NumberFilterFunction.html @@ -1,4 +1,4 @@ -NumberFilterFunction | SAP Cloud SDK for JavaScript - v3.22.0

    Class NumberFilterFunction<EntityT>

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

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

    Class NumberFilterFunction<EntityT>

    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

    constructor

    Properties

    edmType functionName @@ -32,4 +32,4 @@

    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.

    -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_common.ODataBatchRequestConfig.html b/static/api/v3/classes/sap_cloud_sdk_odata_common.ODataBatchRequestConfig.html index 1766eb5b4e..b3c5369fde 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_common.ODataBatchRequestConfig.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_common.ODataBatchRequestConfig.html @@ -1,4 +1,4 @@ -ODataBatchRequestConfig | SAP Cloud SDK for JavaScript - v3.22.0

    Class ODataBatchRequestConfig

    OData batch request configuration for an entity type.

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

    Class ODataBatchRequestConfig

    OData batch request configuration for an entity type.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    basePath boundary @@ -32,4 +32,4 @@

    Returns void

    addCustomRequestConfiguration

    • addCustomRequestConfiguration(requestConfiguration): 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.

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

        -

      Returns void

    appendPath

    • appendPath(...path): void

    • Parameters

      • Rest...path: string[]

      Returns void

    ProtectedprependDollarToQueryParameters

    • prependDollarToQueryParameters(params): Record<string, any>

    • Parameters

      • params: Record<string, any>

      Returns Record<string, any>

    queryParameters

    • queryParameters(): Record<string, any>
    • Internal

      Returns Record<string, any>

    resourcePath

    • resourcePath(): string
    • Internal

      Returns string

    withSubRequestPathType

    • withSubRequestPathType(subRequestPathType): void

    • Parameters

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns void

    appendPath

    • appendPath(...path): void

    • Parameters

      • Rest...path: string[]

      Returns void

    ProtectedprependDollarToQueryParameters

    • prependDollarToQueryParameters(params): Record<string, any>

    • Parameters

      • params: Record<string, any>

      Returns Record<string, any>

    queryParameters

    • queryParameters(): Record<string, any>
    • Internal

      Returns Record<string, any>

    resourcePath

    • resourcePath(): string
    • Internal

      Returns string

    withSubRequestPathType

    • withSubRequestPathType(subRequestPathType): void

    • Parameters

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_common.ODataCountRequestConfig.html b/static/api/v3/classes/sap_cloud_sdk_odata_common.ODataCountRequestConfig.html index 109f8ff94f..b66b82f5e9 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_common.ODataCountRequestConfig.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_common.ODataCountRequestConfig.html @@ -1,4 +1,4 @@ -ODataCountRequestConfig | SAP Cloud SDK for JavaScript - v3.22.0

    Class ODataCountRequestConfig<EntityT, DeSerializersT>

    OData count request configuration for an entity type.

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

    Class ODataCountRequestConfig<EntityT, DeSerializersT>

    OData count request configuration for an entity type.

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    basePath @@ -30,4 +30,4 @@

    Returns void

    addCustomRequestConfiguration

    • addCustomRequestConfiguration(requestConfiguration): 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.

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

        -

      Returns void

    appendPath

    • appendPath(...path): void

    • Parameters

      • Rest...path: string[]

      Returns void

    ProtectedprependDollarToQueryParameters

    • prependDollarToQueryParameters(params): Record<string, any>

    • Parameters

      • params: Record<string, any>

      Returns Record<string, any>

    queryParameters

    • queryParameters(): Record<string, any>
    • Internal

      Returns Record<string, any>

    resourcePath

    • resourcePath(): string
    • Internal

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns void

    appendPath

    • appendPath(...path): void

    • Parameters

      • Rest...path: string[]

      Returns void

    ProtectedprependDollarToQueryParameters

    • prependDollarToQueryParameters(params): Record<string, any>

    • Parameters

      • params: Record<string, any>

      Returns Record<string, any>

    queryParameters

    • queryParameters(): Record<string, any>
    • Internal

      Returns Record<string, any>

    resourcePath

    • resourcePath(): string
    • Internal

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_common.ODataCreateRequestConfig.html b/static/api/v3/classes/sap_cloud_sdk_odata_common.ODataCreateRequestConfig.html index 0898cef5e8..8e455cb6fa 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_common.ODataCreateRequestConfig.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_common.ODataCreateRequestConfig.html @@ -1,4 +1,4 @@ -ODataCreateRequestConfig | SAP Cloud SDK for JavaScript - v3.22.0

    Class ODataCreateRequestConfig<EntityT, DeSerializersT>

    OData create request configuration for an entity type.

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

    Class ODataCreateRequestConfig<EntityT, DeSerializersT>

    OData create request configuration for an entity type.

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    basePath @@ -36,4 +36,4 @@

    Returns void

    addCustomRequestConfiguration

    • addCustomRequestConfiguration(requestConfiguration): 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.

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

        -

      Returns void

    appendPath

    • appendPath(...path): void

    • Parameters

      • Rest...path: string[]

      Returns void

    ProtectedprependDollarToQueryParameters

    • prependDollarToQueryParameters(params): Record<string, any>

    • Parameters

      • params: Record<string, any>

      Returns Record<string, any>

    queryParameters

    • queryParameters(): Record<string, any>
    • Internal

      Returns Record<string, any>

    resourcePath

    • resourcePath(): string
    • Internal

      Returns string

    ProtectedresourcePathAsChild

    • resourcePathAsChild(): string

    • Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns void

    appendPath

    • appendPath(...path): void

    • Parameters

      • Rest...path: string[]

      Returns void

    ProtectedprependDollarToQueryParameters

    • prependDollarToQueryParameters(params): Record<string, any>

    • Parameters

      • params: Record<string, any>

      Returns Record<string, any>

    queryParameters

    • queryParameters(): Record<string, any>
    • Internal

      Returns Record<string, any>

    resourcePath

    • resourcePath(): string
    • Internal

      Returns string

    ProtectedresourcePathAsChild

    • resourcePathAsChild(): string

    • Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_common.ODataDeleteRequestConfig.html b/static/api/v3/classes/sap_cloud_sdk_odata_common.ODataDeleteRequestConfig.html index 1f640eaef7..64d8170bfd 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_common.ODataDeleteRequestConfig.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_common.ODataDeleteRequestConfig.html @@ -1,4 +1,4 @@ -ODataDeleteRequestConfig | SAP Cloud SDK for JavaScript - v3.22.0

    Class ODataDeleteRequestConfig<EntityT, DeSerializersT>

    OData delete request configuration for an entity type.

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

    Class ODataDeleteRequestConfig<EntityT, DeSerializersT>

    OData delete request configuration for an entity type.

    Type Parameters

    Hierarchy (view full)

    Implements

    Constructors

    constructor

    Properties

    basePath @@ -37,4 +37,4 @@

    Returns void

    addCustomRequestConfiguration

    • addCustomRequestConfiguration(requestConfiguration): 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.

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

        -

      Returns void

    appendPath

    • appendPath(...path): void

    • Parameters

      • Rest...path: string[]

      Returns void

    ProtectedprependDollarToQueryParameters

    • prependDollarToQueryParameters(params): Record<string, any>

    • Parameters

      • params: Record<string, any>

      Returns Record<string, any>

    queryParameters

    • queryParameters(): Record<string, any>
    • Internal

      Returns Record<string, any>

    resourcePath

    • resourcePath(): string
    • Internal

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns void

    appendPath

    • appendPath(...path): void

    • Parameters

      • Rest...path: string[]

      Returns void

    ProtectedprependDollarToQueryParameters

    • prependDollarToQueryParameters(params): Record<string, any>

    • Parameters

      • params: Record<string, any>

      Returns Record<string, any>

    queryParameters

    • queryParameters(): Record<string, any>
    • Internal

      Returns Record<string, any>

    resourcePath

    • resourcePath(): string
    • Internal

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_common.ODataFunctionRequestConfig.html b/static/api/v3/classes/sap_cloud_sdk_odata_common.ODataFunctionRequestConfig.html index 2e53f6f177..d9ffebfbca 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_common.ODataFunctionRequestConfig.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_common.ODataFunctionRequestConfig.html @@ -1,4 +1,4 @@ -ODataFunctionRequestConfig | SAP Cloud SDK for JavaScript - v3.22.0

    Class ODataFunctionRequestConfig<DeSerializersT, ParametersT>Abstract

    Function request configuration for an entity type.

    +ODataFunctionRequestConfig | SAP Cloud SDK for JavaScript - v3.22.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

    constructor @@ -37,4 +37,4 @@

    Returns void

    addCustomRequestConfiguration

    • addCustomRequestConfiguration(requestConfiguration): 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.

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

        -

      Returns void

    appendPath

    • appendPath(...path): void

    • Parameters

      • Rest...path: string[]

      Returns void

    ProtectedprependDollarToQueryParameters

    • prependDollarToQueryParameters(params): Record<string, any>

    • Parameters

      • params: Record<string, any>

      Returns Record<string, any>

    AbstractqueryParameters

    • queryParameters(): Record<string, any>
    • Internal

      Returns Record<string, any>

    AbstractresourcePath

    • resourcePath(): string
    • Internal

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns void

    appendPath

    • appendPath(...path): void

    • Parameters

      • Rest...path: string[]

      Returns void

    ProtectedprependDollarToQueryParameters

    • prependDollarToQueryParameters(params): Record<string, any>

    • Parameters

      • params: Record<string, any>

      Returns Record<string, any>

    AbstractqueryParameters

    • queryParameters(): Record<string, any>
    • Internal

      Returns Record<string, any>

    AbstractresourcePath

    • resourcePath(): string
    • Internal

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_common.ODataGetAllRequestConfig.html b/static/api/v3/classes/sap_cloud_sdk_odata_common.ODataGetAllRequestConfig.html index 6a252e21de..303691c7e2 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_common.ODataGetAllRequestConfig.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_common.ODataGetAllRequestConfig.html @@ -1,4 +1,4 @@ -ODataGetAllRequestConfig | SAP Cloud SDK for JavaScript - v3.22.0

    Class ODataGetAllRequestConfig<EntityT, DeSerializersT>

    OData getAll request configuration for an entity type.

    +ODataGetAllRequestConfig | SAP Cloud SDK for JavaScript - v3.22.1

    Class ODataGetAllRequestConfig<EntityT, DeSerializersT>

    OData getAll request configuration for an entity type.

    Type Parameters

    Hierarchy (view full)

    Implements

    Constructors

    constructor

    Properties

    basePath @@ -42,4 +42,4 @@

    Returns void

    addCustomRequestConfiguration

    • addCustomRequestConfiguration(requestConfiguration): 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.

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

        -

      Returns void

    appendPath

    • appendPath(...path): void

    • Parameters

      • Rest...path: string[]

      Returns void

    ProtectedprependDollarToQueryParameters

    • prependDollarToQueryParameters(params): Record<string, any>

    • Parameters

      • params: Record<string, any>

      Returns Record<string, any>

    queryParameters

    • queryParameters(): Record<string, any>
    • Internal

      Returns Record<string, any>

    resourcePath

    • resourcePath(): string
    • Internal

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns void

    appendPath

    • appendPath(...path): void

    • Parameters

      • Rest...path: string[]

      Returns void

    ProtectedprependDollarToQueryParameters

    • prependDollarToQueryParameters(params): Record<string, any>

    • Parameters

      • params: Record<string, any>

      Returns Record<string, any>

    queryParameters

    • queryParameters(): Record<string, any>
    • Internal

      Returns Record<string, any>

    resourcePath

    • resourcePath(): string
    • Internal

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_common.ODataGetByKeyRequestConfig.html b/static/api/v3/classes/sap_cloud_sdk_odata_common.ODataGetByKeyRequestConfig.html index a587875ab4..4e5c68f0fe 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_common.ODataGetByKeyRequestConfig.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_common.ODataGetByKeyRequestConfig.html @@ -1,4 +1,4 @@ -ODataGetByKeyRequestConfig | SAP Cloud SDK for JavaScript - v3.22.0

    Class ODataGetByKeyRequestConfig<EntityT, DeSerializersT>

    OData getByKey request configuration for an entity type.

    +ODataGetByKeyRequestConfig | SAP Cloud SDK for JavaScript - v3.22.1

    Class ODataGetByKeyRequestConfig<EntityT, DeSerializersT>

    OData getByKey request configuration for an entity type.

    Type Parameters

    Hierarchy (view full)

    Implements

    Constructors

    constructor

    Properties

    basePath @@ -36,4 +36,4 @@

    Returns void

    addCustomRequestConfiguration

    • addCustomRequestConfiguration(requestConfiguration): 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.

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

        -

      Returns void

    appendPath

    • appendPath(...path): void

    • Parameters

      • Rest...path: string[]

      Returns void

    ProtectedprependDollarToQueryParameters

    • prependDollarToQueryParameters(params): Record<string, any>

    • Parameters

      • params: Record<string, any>

      Returns Record<string, any>

    queryParameters

    • queryParameters(): Record<string, any>
    • Internal

      Returns Record<string, any>

    resourcePath

    • resourcePath(): string
    • Internal

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns void

    appendPath

    • appendPath(...path): void

    • Parameters

      • Rest...path: string[]

      Returns void

    ProtectedprependDollarToQueryParameters

    • prependDollarToQueryParameters(params): Record<string, any>

    • Parameters

      • params: Record<string, any>

      Returns Record<string, any>

    queryParameters

    • queryParameters(): Record<string, any>
    • Internal

      Returns Record<string, any>

    resourcePath

    • resourcePath(): string
    • Internal

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_common.ODataRequest.html b/static/api/v3/classes/sap_cloud_sdk_odata_common.ODataRequest.html index c8c4454f3b..437cb1cc3f 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_common.ODataRequest.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_common.ODataRequest.html @@ -1,4 +1,4 @@ -ODataRequest | SAP Cloud SDK for JavaScript - v3.22.0

    Class ODataRequest<RequestConfigT>

    OData request configuration for an entity type.

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

    Class ODataRequest<RequestConfigT>

    OData request configuration for an entity type.

    Type Param: EntityT

    Type of the entity to setup a request for.

    Type Parameters

    Constructors

    constructor

    Properties

    config @@ -49,4 +49,4 @@

    url

    • url(): string

    • 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.

      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_common.ODataRequestConfig.html b/static/api/v3/classes/sap_cloud_sdk_odata_common.ODataRequestConfig.html index cc92d8b1f1..58378c6079 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_common.ODataRequestConfig.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_common.ODataRequestConfig.html @@ -1,4 +1,4 @@ -ODataRequestConfig | SAP Cloud SDK for JavaScript - v3.22.0

    Class ODataRequestConfigAbstract

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

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

    Class ODataRequestConfigAbstract

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

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    basePath defaultBasePath @@ -30,4 +30,4 @@

    Returns void

    addCustomRequestConfiguration

    • addCustomRequestConfiguration(requestConfiguration): 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.

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

        -

      Returns void

    appendPath

    • appendPath(...path): void

    • Parameters

      • Rest...path: string[]

      Returns void

    ProtectedprependDollarToQueryParameters

    • prependDollarToQueryParameters(params): Record<string, any>

    • Parameters

      • params: Record<string, any>

      Returns Record<string, any>

    AbstractqueryParameters

    • queryParameters(): Record<string, any>
    • Internal

      Returns Record<string, any>

    AbstractresourcePath

    • resourcePath(): string
    • Internal

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns void

    appendPath

    • appendPath(...path): void

    • Parameters

      • Rest...path: string[]

      Returns void

    ProtectedprependDollarToQueryParameters

    • prependDollarToQueryParameters(params): Record<string, any>

    • Parameters

      • params: Record<string, any>

      Returns Record<string, any>

    AbstractqueryParameters

    • queryParameters(): Record<string, any>
    • Internal

      Returns Record<string, any>

    AbstractresourcePath

    • resourcePath(): string
    • Internal

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_common.ODataUpdateRequestConfig.html b/static/api/v3/classes/sap_cloud_sdk_odata_common.ODataUpdateRequestConfig.html index a26d020888..77148143ff 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_common.ODataUpdateRequestConfig.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_common.ODataUpdateRequestConfig.html @@ -1,4 +1,4 @@ -ODataUpdateRequestConfig | SAP Cloud SDK for JavaScript - v3.22.0

    Class ODataUpdateRequestConfig<EntityT, DeSerializersT>

    OData update request configuration for an entity type.

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

    Class ODataUpdateRequestConfig<EntityT, DeSerializersT>

    OData update request configuration for an entity type.

    Type Parameters

    Hierarchy (view full)

    Implements

    Constructors

    constructor

    Properties

    basePath @@ -38,4 +38,4 @@

    Returns void

    addCustomRequestConfiguration

    • addCustomRequestConfiguration(requestConfiguration): 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.

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

        -

      Returns void

    appendPath

    • appendPath(...path): void

    • Parameters

      • Rest...path: string[]

      Returns void

    ProtectedprependDollarToQueryParameters

    • prependDollarToQueryParameters(params): Record<string, any>

    • Parameters

      • params: Record<string, any>

      Returns Record<string, any>

    queryParameters

    • queryParameters(): Record<string, any>
    • Internal

      Returns Record<string, any>

    resourcePath

    • resourcePath(): string
    • Internal

      Returns string

    updateWithPut

    • updateWithPut(): void

    • Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns void

    appendPath

    • appendPath(...path): void

    • Parameters

      • Rest...path: string[]

      Returns void

    ProtectedprependDollarToQueryParameters

    • prependDollarToQueryParameters(params): Record<string, any>

    • Parameters

      • params: Record<string, any>

      Returns Record<string, any>

    queryParameters

    • queryParameters(): Record<string, any>
    • Internal

      Returns Record<string, any>

    resourcePath

    • resourcePath(): string
    • Internal

      Returns string

    updateWithPut

    • updateWithPut(): void

    • Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_common.OneToManyLink.html b/static/api/v3/classes/sap_cloud_sdk_odata_common.OneToManyLink.html index fc7e82e322..d877d46f24 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_common.OneToManyLink.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_common.OneToManyLink.html @@ -1,4 +1,4 @@ -OneToManyLink | SAP Cloud SDK for JavaScript - v3.22.0

    Class OneToManyLink<EntityT, DeSerializersT, LinkedEntityApiT>

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

    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

    constructor @@ -46,4 +46,4 @@

    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.

    -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_common.OneToOneLink.html b/static/api/v3/classes/sap_cloud_sdk_odata_common.OneToOneLink.html index 15e80a431e..dd8ecbdf44 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_common.OneToOneLink.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_common.OneToOneLink.html @@ -1,4 +1,4 @@ -OneToOneLink | SAP Cloud SDK for JavaScript - v3.22.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.

    +OneToOneLink | SAP Cloud SDK for JavaScript - v3.22.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.

    Type Param: LinkedEntityT

    Type of the entity to be linked to.

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor @@ -41,4 +41,4 @@

    Parameters

    Returns this

    The link itself, to facilitate method chaining.

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

    -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_common.OperationParameter.html b/static/api/v3/classes/sap_cloud_sdk_odata_common.OperationParameter.html index 8668cdb49f..c5a0281c65 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_common.OperationParameter.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_common.OperationParameter.html @@ -1,4 +1,4 @@ -OperationParameter | SAP Cloud SDK for JavaScript - v3.22.0

    Class OperationParameter<ValueT>

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

    +OperationParameter | SAP Cloud SDK for JavaScript - v3.22.1

    Class OperationParameter<ValueT>

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

    Type Parameters

    • ValueT

      Type of the value.

    Constructors

    constructor

    Properties

    edmType @@ -9,4 +9,4 @@
  • edmType: EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4

    Original EDM type.

  • value: ValueT

    Value to be used as parameter.

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

    -

    • Returns OperationParameter<ValueT>

    Properties

    edmType

    edmType: EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4

    originalName

    originalName: string

    value

    value: ValueT

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    +

    Returns OperationParameter<ValueT>

    Properties

    edmType

    edmType: EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4

    originalName

    originalName: string

    value

    value: ValueT

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_common.OperationRequestBuilderBase.html b/static/api/v3/classes/sap_cloud_sdk_odata_common.OperationRequestBuilderBase.html index 8465a64bc4..788b48ab07 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_common.OperationRequestBuilderBase.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_common.OperationRequestBuilderBase.html @@ -1,4 +1,4 @@ -OperationRequestBuilderBase | SAP Cloud SDK for JavaScript - v3.22.0

    Class OperationRequestBuilderBase<DeSerializersT, ReturnT, RequestConfigT>Abstract

    Create OData request to execute an action or function.

    +OperationRequestBuilderBase | SAP Cloud SDK for JavaScript - v3.22.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.

      @@ -65,4 +65,4 @@

      Parameters

      Returns Promise<string>

      Promise resolving to the URL for the request.

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

      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_common.Order.html b/static/api/v3/classes/sap_cloud_sdk_odata_common.Order.html index b18806ca0e..84e3f6d4bd 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_common.Order.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_common.Order.html @@ -1,4 +1,4 @@ -Order | SAP Cloud SDK for JavaScript - v3.22.0

    Class Order<EntityT>

    OData queries take this to determine the order of results.

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

    Class Order<EntityT>

    OData queries take this to determine the order of results.

    Type Parameters

    Implements

    Constructors

    constructor

    Properties

    _deSerializers _entity @@ -11,4 +11,4 @@

    Returns Order<EntityT>

    Properties

    Readonly_deSerializers

    _deSerializers: any

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

    Readonly_entity

    _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.

    -

    Readonly_entityConstructor

    _entityConstructor: Constructable<EntityT>

    _fieldName

    _fieldName: string

    orderType

    orderType: OrderType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    +

    Readonly_entityConstructor

    _entityConstructor: Constructable<EntityT>

    _fieldName

    _fieldName: string

    orderType

    orderType: OrderType

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_common.OrderLink.html b/static/api/v3/classes/sap_cloud_sdk_odata_common.OrderLink.html index 6fb71d3052..166f32137c 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_common.OrderLink.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_common.OrderLink.html @@ -1,4 +1,4 @@ -OrderLink | SAP Cloud SDK for JavaScript - v3.22.0

    Class OrderLink<EntityT, LinkedEntityApiT>

    Link to represent an order by on a linked entity.

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

    Class OrderLink<EntityT, LinkedEntityApiT>

    Link to represent an order by on a linked entity.

    Type Param: LinkedEntityT

    Type of the entity to link to.

    Type Parameters

    Constructors

    constructor @@ -10,4 +10,4 @@

    Type Parameters

    Parameters

    Returns OrderLink<EntityT, LinkedEntityApiT>

    Properties

    ReadonlyentityType

    entityType: EntityT

    link

    link: Link<EntityT, any, LinkedEntityApiT>

    ReadonlylinkedEntityType

    linkedEntityType: EntityType<LinkedEntityApiT>

    orderBy

    orderBy: Orderable<EntityType<LinkedEntityApiT>, EntityApi<EntityBase, any>>[]

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    +

    Returns OrderLink<EntityT, LinkedEntityApiT>

    Properties

    ReadonlyentityType

    entityType: EntityT

    link

    link: Link<EntityT, any, LinkedEntityApiT>

    ReadonlylinkedEntityType

    linkedEntityType: EntityType<LinkedEntityApiT>

    orderBy

    orderBy: Orderable<EntityType<LinkedEntityApiT>, EntityApi<EntityBase, any>>[]

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_common.OrderableEdmTypeField.html b/static/api/v3/classes/sap_cloud_sdk_odata_common.OrderableEdmTypeField.html index 7e58d258e1..a6f7d1b240 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_common.OrderableEdmTypeField.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_common.OrderableEdmTypeField.html @@ -1,4 +1,4 @@ -OrderableEdmTypeField | SAP Cloud SDK for JavaScript - v3.22.0

    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.

    +OrderableEdmTypeField | SAP Cloud SDK for JavaScript - v3.22.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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_common.RequestBuilder.html b/static/api/v3/classes/sap_cloud_sdk_odata_common.RequestBuilder.html index aed04dd7ce..4ade40bd35 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_common.RequestBuilder.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_common.RequestBuilder.html @@ -1,4 +1,4 @@ -RequestBuilder | SAP Cloud SDK for JavaScript - v3.22.0

    Class RequestBuilder<EntityT, DeSerializersT>Abstract

    Represents a request builder for a given entity API.

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

    Class RequestBuilder<EntityT, DeSerializersT>Abstract

    Represents a request builder for a given entity API.

    Type Parameters

    Implements

    Constructors

    constructor

    Properties

    _deSerializers _entity @@ -6,4 +6,4 @@

    Constructors

    constructor

    Properties

    _deSerializers

    _deSerializers: DeSerializersT

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

    _entity

    _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.

    -

    entityApi

    entityApi: EntityApi<EntityT, DeSerializersT>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    +

    entityApi

    entityApi: EntityApi<EntityT, DeSerializersT>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_common.StringFilterFunction.html b/static/api/v3/classes/sap_cloud_sdk_odata_common.StringFilterFunction.html index bfb57c3d43..9743336fd7 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_common.StringFilterFunction.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_common.StringFilterFunction.html @@ -1,4 +1,4 @@ -StringFilterFunction | SAP Cloud SDK for JavaScript - v3.22.0

    Class StringFilterFunction<EntityT>

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

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

    Class StringFilterFunction<EntityT>

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

    Type Parameters

    Hierarchy

    • OrderableFilterFunction<EntityT, string>
      • StringFilterFunction

    Constructors

    constructor

    Properties

    edmType functionName @@ -31,4 +31,4 @@

    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.

    -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_common.UnaryFilter.html b/static/api/v3/classes/sap_cloud_sdk_odata_common.UnaryFilter.html index e7693c6d9d..c2de823b67 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_common.UnaryFilter.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_common.UnaryFilter.html @@ -1,6 +1,6 @@ -UnaryFilter | SAP Cloud SDK for JavaScript - v3.22.0

    Class UnaryFilter<EntityT, DeSerializersT>

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

    +UnaryFilter | SAP Cloud SDK for JavaScript - v3.22.1

    Class UnaryFilter<EntityT, DeSerializersT>

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

    Type Parameters

    Constructors

    constructor

    Properties

    operator singleOperand

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

    -

    Constructors

    constructor

    Properties

    operator

    operator: "not"

    singleOperand

    singleOperand: Filterable<EntityT, DeSerializersT>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    +

    Constructors

    constructor

    Properties

    operator

    operator: "not"

    singleOperand

    singleOperand: Filterable<EntityT, DeSerializersT>

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_common.UpdateRequestBuilderBase.html b/static/api/v3/classes/sap_cloud_sdk_odata_common.UpdateRequestBuilderBase.html index 46d5cf1768..1685ddb9f3 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_common.UpdateRequestBuilderBase.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_common.UpdateRequestBuilderBase.html @@ -1,4 +1,4 @@ -UpdateRequestBuilderBase | SAP Cloud SDK for JavaScript - v3.22.0

    Class UpdateRequestBuilderBase<EntityT, DeSerializersT>Abstract

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

    +UpdateRequestBuilderBase | SAP Cloud SDK for JavaScript - v3.22.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

    constructor

    Properties

    _deSerializers @@ -90,4 +90,4 @@

    Parameters

    Returns Promise<string>

    Promise resolving to the URL for the request.

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

    -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_v2.CountRequestBuilder.html b/static/api/v3/classes/sap_cloud_sdk_odata_v2.CountRequestBuilder.html index 3e85e948d6..87953bca19 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_v2.CountRequestBuilder.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_v2.CountRequestBuilder.html @@ -1,4 +1,4 @@ -CountRequestBuilder | SAP Cloud SDK for JavaScript - v3.22.0

    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.22.1

    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

    • EntityT extends Entity

      Type of the entity to be requested.

      @@ -56,4 +56,4 @@

      Parameters

      Returns Promise<string>

      Promise resolving to the URL for the request.

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

      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_v2.CreateRequestBuilder.html b/static/api/v3/classes/sap_cloud_sdk_odata_v2.CreateRequestBuilder.html index ba1e20eb88..5f1d69589a 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_v2.CreateRequestBuilder.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_v2.CreateRequestBuilder.html @@ -1,4 +1,4 @@ -CreateRequestBuilder | SAP Cloud SDK for JavaScript - v3.22.0

    Class CreateRequestBuilder<EntityT, DeSerializersT>

    Create OData request to create an entity.

    +CreateRequestBuilder | SAP Cloud SDK for JavaScript - v3.22.1

    Class CreateRequestBuilder<EntityT, DeSerializersT>

    Create OData request to create an entity.

    Type Parameters

    Hierarchy (view full)

    Implements

    Constructors

    constructor

    Properties

    _deSerializers @@ -74,4 +74,4 @@

    Parameters

    Returns Promise<string>

    Promise resolving to the URL for the request.

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

    -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_v2.CustomField.html b/static/api/v3/classes/sap_cloud_sdk_odata_v2.CustomField.html index a9a05fed1a..849697e659 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_v2.CustomField.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_v2.CustomField.html @@ -1,4 +1,4 @@ -CustomField | SAP Cloud SDK for JavaScript - v3.22.0

    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.22.1

    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

    constructor

    Properties

    _entityConstructor @@ -24,4 +24,4 @@

    Constructors

    constructor

    Properties

    Readonly_entityConstructor

    _entityConstructor: Constructable<EntityT>

    Readonly_fieldName

    _fieldName: string

    Readonly_fieldOptions

    _fieldOptions: Required<FieldOptions<NullableT, false>>

    ProtectedfieldBuilder

    fieldBuilder: FieldBuilder<Constructable<EntityT>, DeSerializersT>

    Methods

    edmBinary

    edmBoolean

    edmByte

    edmDateTime

    edmDateTimeOffset

    edmDecimal

    edmDouble

    edmGuid

    edmInt16

    edmInt32

    edmInt64

    edmSByte

    edmSingle

    edmString

    edmTime

    fieldPath

    • fieldPath(): string

    • 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.

      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_v2.DeleteRequestBuilder.html b/static/api/v3/classes/sap_cloud_sdk_odata_v2.DeleteRequestBuilder.html index 9dcb18ee8a..8c85b7691d 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_v2.DeleteRequestBuilder.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_v2.DeleteRequestBuilder.html @@ -1,4 +1,4 @@ -DeleteRequestBuilder | SAP Cloud SDK for JavaScript - v3.22.0

    Class DeleteRequestBuilder<EntityT, DeSerializersT>

    Create OData query to delete an entity.

    +DeleteRequestBuilder | SAP Cloud SDK for JavaScript - v3.22.1

    Class DeleteRequestBuilder<EntityT, DeSerializersT>

    Create OData query to delete an entity.

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _deSerializers @@ -71,4 +71,4 @@

    Parameters

    Returns Promise<string>

    Promise resolving to the URL for the request.

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

    -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_v2.Entity.html b/static/api/v3/classes/sap_cloud_sdk_odata_v2.Entity.html index 142a44e24e..809bb586ea 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_v2.Entity.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_v2.Entity.html @@ -1,4 +1,4 @@ -Entity | SAP Cloud SDK for JavaScript - v3.22.0

    Class Entity

    Super class for all representations of OData v2 entity types.

    +Entity | SAP Cloud SDK for JavaScript - v3.22.1

    Class Entity

    Super class for all representations of OData v2 entity types.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _customFields _entityApi @@ -77,4 +77,4 @@

    toJSON

    • toJSON(): {
          [key: string]: any;
      }

    • 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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +
    • [key: string]: any

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_v2.GetAllRequestBuilder.html b/static/api/v3/classes/sap_cloud_sdk_odata_v2.GetAllRequestBuilder.html index 6e21636b74..f85c829368 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_v2.GetAllRequestBuilder.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_v2.GetAllRequestBuilder.html @@ -1,4 +1,4 @@ -GetAllRequestBuilder | SAP Cloud SDK for JavaScript - v3.22.0

    Class GetAllRequestBuilder<EntityT, DeSerializersT>

    Represents an object that is related to an entity. +GetAllRequestBuilder | SAP Cloud SDK for JavaScript - v3.22.1

    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

    constructor @@ -87,4 +87,4 @@

    Parameters

    Returns Promise<string>

    Promise resolving to the URL for the request.

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

    -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_v2.GetByKeyRequestBuilder.html b/static/api/v3/classes/sap_cloud_sdk_odata_v2.GetByKeyRequestBuilder.html index 2e677326e6..ce6b0565cb 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_v2.GetByKeyRequestBuilder.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_v2.GetByKeyRequestBuilder.html @@ -1,4 +1,4 @@ -GetByKeyRequestBuilder | SAP Cloud SDK for JavaScript - v3.22.0

    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.22.1

    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

    • EntityT extends Entity

      Type of the entity to be requested.

      @@ -76,4 +76,4 @@

      Parameters

      Returns Promise<string>

      Promise resolving to the URL for the request.

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

      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_v2.ODataBatchRequestBuilder.html b/static/api/v3/classes/sap_cloud_sdk_odata_v2.ODataBatchRequestBuilder.html index cf360bbc7d..d457b62c87 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_v2.ODataBatchRequestBuilder.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_v2.ODataBatchRequestBuilder.html @@ -1,4 +1,4 @@ -ODataBatchRequestBuilder | SAP Cloud SDK for JavaScript - v3.22.0

    Class ODataBatchRequestBuilder<DeSerializersT>

    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.22.1

    Class ODataBatchRequestBuilder<DeSerializersT>

    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

    constructor

    Properties

    defaultBasePath @@ -58,4 +58,4 @@

    Parameters

    Returns Promise<string>

    Promise resolving to the URL for the request.

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

    -

    withSubRequestPathType

    • withSubRequestPathType(subRequestPathType): this

    • Parameters

      Returns this

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    withSubRequestPathType

    • withSubRequestPathType(subRequestPathType): this

    • Parameters

      Returns this

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_v2.ODataFunctionRequestConfig.html b/static/api/v3/classes/sap_cloud_sdk_odata_v2.ODataFunctionRequestConfig.html index 15d3796f10..934b00eed2 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_v2.ODataFunctionRequestConfig.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_v2.ODataFunctionRequestConfig.html @@ -1,4 +1,4 @@ -ODataFunctionRequestConfig | SAP Cloud SDK for JavaScript - v3.22.0

    Class ODataFunctionRequestConfig<DeSerializersT, ParametersT>

    Function request configuration for an entity type.

    +ODataFunctionRequestConfig | SAP Cloud SDK for JavaScript - v3.22.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

    constructor @@ -37,4 +37,4 @@

    Returns void

    addCustomRequestConfiguration

    • addCustomRequestConfiguration(requestConfiguration): 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.

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

        -

      Returns void

    appendPath

    • appendPath(...path): void

    • Parameters

      • Rest...path: string[]

      Returns void

    ProtectedprependDollarToQueryParameters

    queryParameters

    resourcePath

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns void

    appendPath

    • appendPath(...path): void

    • Parameters

      • Rest...path: string[]

      Returns void

    ProtectedprependDollarToQueryParameters

    queryParameters

    resourcePath

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_v2.OperationRequestBuilder.html b/static/api/v3/classes/sap_cloud_sdk_odata_v2.OperationRequestBuilder.html index 4fbc96f432..5483442fc8 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_v2.OperationRequestBuilder.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_v2.OperationRequestBuilder.html @@ -1,4 +1,4 @@ -OperationRequestBuilder | SAP Cloud SDK for JavaScript - v3.22.0

    Class OperationRequestBuilder<DeSerializersT, ParametersT, ReturnT>

    Create OData request to execute an operation. +OperationRequestBuilder | SAP Cloud SDK for JavaScript - v3.22.1

    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.

      @@ -68,4 +68,4 @@

      Parameters

      Returns Promise<string>

      Promise resolving to the URL for the request.

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

      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_v2.UpdateRequestBuilder.html b/static/api/v3/classes/sap_cloud_sdk_odata_v2.UpdateRequestBuilder.html index abdef1328a..96bb1e8ae5 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_v2.UpdateRequestBuilder.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_v2.UpdateRequestBuilder.html @@ -1,4 +1,4 @@ -UpdateRequestBuilder | SAP Cloud SDK for JavaScript - v3.22.0

    Class UpdateRequestBuilder<EntityT, DeSerializersT>

    Create OData query to update an entity.

    +UpdateRequestBuilder | SAP Cloud SDK for JavaScript - v3.22.1

    Class UpdateRequestBuilder<EntityT, DeSerializersT>

    Create OData query to update an entity.

    Type Parameters

    Hierarchy (view full)

    Implements

    Constructors

    constructor

    Properties

    _deSerializers @@ -94,4 +94,4 @@

    Parameters

    Returns Promise<string>

    Promise resolving to the URL for the request.

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

    -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_v4.ActionImportParameter.html b/static/api/v3/classes/sap_cloud_sdk_odata_v4.ActionImportParameter.html index 1a056e4b65..d0b7862b44 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_v4.ActionImportParameter.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_v4.ActionImportParameter.html @@ -1,4 +1,4 @@ -ActionImportParameter | SAP Cloud SDK for JavaScript - v3.22.0

    Class ActionImportParameter<ValueT>

    Deprecated

    Since 3.3.0. Use OperationParameter instead.

    +ActionImportParameter | SAP Cloud SDK for JavaScript - v3.22.1

    Class ActionImportParameter<ValueT>

    Deprecated

    Since 3.3.0. Use OperationParameter instead.

    Type Parameters

    • ValueT

    Constructors

    constructor

    Properties

    edmType originalName @@ -8,4 +8,4 @@
  • edmType: EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4

    Original EDM type.

  • value: ValueT

    Value to be used as parameter.

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

    -

    • Returns ActionImportParameter<ValueT>

    Properties

    edmType

    edmType: EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4

    originalName

    originalName: string

    value

    value: ValueT

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    +

    Returns ActionImportParameter<ValueT>

    Properties

    edmType

    edmType: EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4

    originalName

    originalName: string

    value

    value: ValueT

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_v4.ActionImportRequestBuilder.html b/static/api/v3/classes/sap_cloud_sdk_odata_v4.ActionImportRequestBuilder.html index d006e8f099..49f5711d45 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_v4.ActionImportRequestBuilder.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_v4.ActionImportRequestBuilder.html @@ -1,4 +1,4 @@ -ActionImportRequestBuilder | SAP Cloud SDK for JavaScript - v3.22.0

    Class ActionImportRequestBuilder<DeSerializersT, ParametersT, ReturnT>

    Deprecated

    Since 3.3.0. Use OperationRequestBuilder instead.

    +ActionImportRequestBuilder | SAP Cloud SDK for JavaScript - v3.22.1

    Class ActionImportRequestBuilder<DeSerializersT, ParametersT, ReturnT>

    Deprecated

    Since 3.3.0. Use OperationRequestBuilder instead.

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _deSerializers requestConfig @@ -58,4 +58,4 @@

    Parameters

    Returns Promise<string>

    Promise resolving to the URL for the request.

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

    -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_v4.BoundActionImportRequestBuilder.html b/static/api/v3/classes/sap_cloud_sdk_odata_v4.BoundActionImportRequestBuilder.html index 1da1e3783d..88d26e5d90 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_v4.BoundActionImportRequestBuilder.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_v4.BoundActionImportRequestBuilder.html @@ -1,4 +1,4 @@ -BoundActionImportRequestBuilder | SAP Cloud SDK for JavaScript - v3.22.0

    Class BoundActionImportRequestBuilder<EntityT, DeSerializersT, ParametersT, ReturnT>

    Deprecated

    Since 3.3.0. Use OperationRequestBuilder instead.

    +BoundActionImportRequestBuilder | SAP Cloud SDK for JavaScript - v3.22.1

    Class BoundActionImportRequestBuilder<EntityT, DeSerializersT, ParametersT, ReturnT>

    Deprecated

    Since 3.3.0. Use OperationRequestBuilder instead.

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _deSerializers requestConfig @@ -58,4 +58,4 @@

    Parameters

    Returns Promise<string>

    Promise resolving to the URL for the request.

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

    -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_v4.BoundFunctionImportRequestBuilder.html b/static/api/v3/classes/sap_cloud_sdk_odata_v4.BoundFunctionImportRequestBuilder.html index 0c13881222..2cf8c40a20 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_v4.BoundFunctionImportRequestBuilder.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_v4.BoundFunctionImportRequestBuilder.html @@ -1,4 +1,4 @@ -BoundFunctionImportRequestBuilder | SAP Cloud SDK for JavaScript - v3.22.0

    Class BoundFunctionImportRequestBuilder<EntityT, DeSerializersT, ParametersT, ReturnT>

    Deprecated

    Since 3.3.0. Use OperationRequestBuilder instead.

    +BoundFunctionImportRequestBuilder | SAP Cloud SDK for JavaScript - v3.22.1

    Class BoundFunctionImportRequestBuilder<EntityT, DeSerializersT, ParametersT, ReturnT>

    Deprecated

    Since 3.3.0. Use OperationRequestBuilder instead.

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _deSerializers requestConfig @@ -58,4 +58,4 @@

    Parameters

    Returns Promise<string>

    Promise resolving to the URL for the request.

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

    -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_v4.BoundOperationRequestBuilder.html b/static/api/v3/classes/sap_cloud_sdk_odata_v4.BoundOperationRequestBuilder.html index 8822967528..6fa3b6e77a 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_v4.BoundOperationRequestBuilder.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_v4.BoundOperationRequestBuilder.html @@ -1,4 +1,4 @@ -BoundOperationRequestBuilder | SAP Cloud SDK for JavaScript - v3.22.0

    Class BoundOperationRequestBuilder<EntityT, DeSerializersT, ParametersT, ReturnT>

    Create bound OData request to execute an operation.

    +BoundOperationRequestBuilder | SAP Cloud SDK for JavaScript - v3.22.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

    constructor @@ -60,4 +60,4 @@

    Parameters

    Returns Promise<string>

    Promise resolving to the URL for the request.

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

    -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_v4.CountRequestBuilder.html b/static/api/v3/classes/sap_cloud_sdk_odata_v4.CountRequestBuilder.html index 5dbe8586cb..307027268a 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_v4.CountRequestBuilder.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_v4.CountRequestBuilder.html @@ -1,4 +1,4 @@ -CountRequestBuilder | SAP Cloud SDK for JavaScript - v3.22.0

    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.22.1

    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

    • EntityT extends Entity

      Type of the entity to be requested.

      @@ -56,4 +56,4 @@

      Parameters

      Returns Promise<string>

      Promise resolving to the URL for the request.

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

      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_v4.CreateRequestBuilder.html b/static/api/v3/classes/sap_cloud_sdk_odata_v4.CreateRequestBuilder.html index e2725394d3..c912515ba9 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_v4.CreateRequestBuilder.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_v4.CreateRequestBuilder.html @@ -1,4 +1,4 @@ -CreateRequestBuilder | SAP Cloud SDK for JavaScript - v3.22.0

    Class CreateRequestBuilder<EntityT, DeSerializersT>

    Create OData request to create an entity.

    +CreateRequestBuilder | SAP Cloud SDK for JavaScript - v3.22.1

    Class CreateRequestBuilder<EntityT, DeSerializersT>

    Create OData request to create an entity.

    Type Parameters

    Hierarchy (view full)

    Implements

    Constructors

    constructor

    Properties

    _deSerializers @@ -74,4 +74,4 @@

    Parameters

    Returns Promise<string>

    Promise resolving to the URL for the request.

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

    -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_v4.CustomField.html b/static/api/v3/classes/sap_cloud_sdk_odata_v4.CustomField.html index 53f4007485..d0699099a2 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_v4.CustomField.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_v4.CustomField.html @@ -1,4 +1,4 @@ -CustomField | SAP Cloud SDK for JavaScript - v3.22.0

    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.22.1

    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

    constructor

    Properties

    _entityConstructor @@ -25,4 +25,4 @@

    Constructors

    constructor

    Properties

    Readonly_entityConstructor

    _entityConstructor: Constructable<EntityT>

    Readonly_fieldName

    _fieldName: string

    Readonly_fieldOptions

    _fieldOptions: Required<FieldOptions<NullableT, false>>

    ProtectedfieldBuilder

    fieldBuilder: FieldBuilder<Constructable<EntityT>, any>

    Methods

    edmBinary

    edmBoolean

    edmByte

    edmDate

    edmDateTimeOffset

    edmDecimal

    edmDouble

    edmDuration

    edmGuid

    edmInt16

    edmInt32

    edmInt64

    edmSByte

    edmSingle

    edmString

    edmTimeOfDay

    fieldPath

    • fieldPath(): string

    • 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.

      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_v4.DateFilterFunction.html b/static/api/v3/classes/sap_cloud_sdk_odata_v4.DateFilterFunction.html index 77191bbd2a..fc966350db 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_v4.DateFilterFunction.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_v4.DateFilterFunction.html @@ -1,4 +1,4 @@ -DateFilterFunction | SAP Cloud SDK for JavaScript - v3.22.0

    Class DateFilterFunction<EntityT>

    Representation of a filter function, that returns a value of type date. This supports DateTimeOffset values.

    +DateFilterFunction | SAP Cloud SDK for JavaScript - v3.22.1

    Class DateFilterFunction<EntityT>

    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

    constructor

    Properties

    edmType functionName @@ -31,4 +31,4 @@

    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.

    -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_v4.DeleteRequestBuilder.html b/static/api/v3/classes/sap_cloud_sdk_odata_v4.DeleteRequestBuilder.html index f8feb83508..a4883692a3 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_v4.DeleteRequestBuilder.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_v4.DeleteRequestBuilder.html @@ -1,4 +1,4 @@ -DeleteRequestBuilder | SAP Cloud SDK for JavaScript - v3.22.0

    Class DeleteRequestBuilder<EntityT, DeSerializersT>

    Create OData query to delete an entity.

    +DeleteRequestBuilder | SAP Cloud SDK for JavaScript - v3.22.1

    Class DeleteRequestBuilder<EntityT, DeSerializersT>

    Create OData query to delete an entity.

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _deSerializers @@ -71,4 +71,4 @@

    Parameters

    Returns Promise<string>

    Promise resolving to the URL for the request.

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

    -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_v4.Entity.html b/static/api/v3/classes/sap_cloud_sdk_odata_v4.Entity.html index 352e3c518b..34542d6ac8 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_v4.Entity.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_v4.Entity.html @@ -1,4 +1,4 @@ -Entity | SAP Cloud SDK for JavaScript - v3.22.0

    Class Entity

    Super class for all representations of OData v4 entity types.

    +Entity | SAP Cloud SDK for JavaScript - v3.22.1

    Class Entity

    Super class for all representations of OData v4 entity types.

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _customFields _entityApi @@ -77,4 +77,4 @@

    toJSON

    • toJSON(): {
          [key: string]: any;
      }

    • 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

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +
    • [key: string]: any

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_v4.FunctionImportRequestBuilder.html b/static/api/v3/classes/sap_cloud_sdk_odata_v4.FunctionImportRequestBuilder.html index 014e30be06..c8efbe020b 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_v4.FunctionImportRequestBuilder.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_v4.FunctionImportRequestBuilder.html @@ -1,4 +1,4 @@ -FunctionImportRequestBuilder | SAP Cloud SDK for JavaScript - v3.22.0

    Class FunctionImportRequestBuilder<DeSerializersT, ParametersT, ReturnT>

    Deprecated

    Since 3.3.0. Use OperationRequestBuilder instead.

    +FunctionImportRequestBuilder | SAP Cloud SDK for JavaScript - v3.22.1

    Class FunctionImportRequestBuilder<DeSerializersT, ParametersT, ReturnT>

    Deprecated

    Since 3.3.0. Use OperationRequestBuilder instead.

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    _deSerializers requestConfig @@ -58,4 +58,4 @@

    Parameters

    Returns Promise<string>

    Promise resolving to the URL for the request.

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

    -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_v4.GetAllRequestBuilder.html b/static/api/v3/classes/sap_cloud_sdk_odata_v4.GetAllRequestBuilder.html index ecd8958ab1..57f4565b31 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_v4.GetAllRequestBuilder.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_v4.GetAllRequestBuilder.html @@ -1,4 +1,4 @@ -GetAllRequestBuilder | SAP Cloud SDK for JavaScript - v3.22.0

    Class GetAllRequestBuilder<EntityT, DeSerializersT>

    Represents an object that is related to an entity. +GetAllRequestBuilder | SAP Cloud SDK for JavaScript - v3.22.1

    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

    constructor @@ -88,4 +88,4 @@

    Parameters

    Returns Promise<string>

    Promise resolving to the URL for the request.

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

    -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_v4.GetByKeyRequestBuilder.html b/static/api/v3/classes/sap_cloud_sdk_odata_v4.GetByKeyRequestBuilder.html index f23f5ce605..fb98c2bc46 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_v4.GetByKeyRequestBuilder.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_v4.GetByKeyRequestBuilder.html @@ -1,4 +1,4 @@ -GetByKeyRequestBuilder | SAP Cloud SDK for JavaScript - v3.22.0

    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.22.1

    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.

    @@ -78,4 +78,4 @@

    Parameters

    Returns Promise<string>

    Promise resolving to the URL for the request.

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

    -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_v4.ODataActionRequestConfig.html b/static/api/v3/classes/sap_cloud_sdk_odata_v4.ODataActionRequestConfig.html index 2717e34ffa..775211f550 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_v4.ODataActionRequestConfig.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_v4.ODataActionRequestConfig.html @@ -1,4 +1,4 @@ -ODataActionRequestConfig | SAP Cloud SDK for JavaScript - v3.22.0

    Class ODataActionRequestConfig<DeSerializersT, ParametersT>

    Action request configuration for an entity type.

    +ODataActionRequestConfig | SAP Cloud SDK for JavaScript - v3.22.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

    constructor @@ -36,4 +36,4 @@

    Returns void

    addCustomRequestConfiguration

    • addCustomRequestConfiguration(requestConfiguration): 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.

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

        -

      Returns void

    appendPath

    • appendPath(...path): void

    • Parameters

      • Rest...path: string[]

      Returns void

    ProtectedprependDollarToQueryParameters

    • prependDollarToQueryParameters(params): Record<string, any>

    • Parameters

      • params: Record<string, any>

      Returns Record<string, any>

    queryParameters

    • queryParameters(): Record<string, any>
    • Internal

      Returns Record<string, any>

    resourcePath

    • resourcePath(): string
    • Internal

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns void

    appendPath

    • appendPath(...path): void

    • Parameters

      • Rest...path: string[]

      Returns void

    ProtectedprependDollarToQueryParameters

    • prependDollarToQueryParameters(params): Record<string, any>

    • Parameters

      • params: Record<string, any>

      Returns Record<string, any>

    queryParameters

    • queryParameters(): Record<string, any>
    • Internal

      Returns Record<string, any>

    resourcePath

    • resourcePath(): string
    • Internal

      Returns string

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_v4.ODataBatchRequestBuilder.html b/static/api/v3/classes/sap_cloud_sdk_odata_v4.ODataBatchRequestBuilder.html index b6064e4a9b..261f915f95 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_v4.ODataBatchRequestBuilder.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_v4.ODataBatchRequestBuilder.html @@ -1,4 +1,4 @@ -ODataBatchRequestBuilder | SAP Cloud SDK for JavaScript - v3.22.0

    Class ODataBatchRequestBuilder<DeSerializersT>

    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.22.1

    Class ODataBatchRequestBuilder<DeSerializersT>

    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

    constructor

    Properties

    defaultBasePath @@ -58,4 +58,4 @@

    Parameters

    Returns Promise<string>

    Promise resolving to the URL for the request.

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

    -

    withSubRequestPathType

    • withSubRequestPathType(subRequestPathType): this

    • Parameters

      Returns this

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    withSubRequestPathType

    • withSubRequestPathType(subRequestPathType): this

    • Parameters

      Returns this

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_v4.ODataBoundActionImportRequestConfig.html b/static/api/v3/classes/sap_cloud_sdk_odata_v4.ODataBoundActionImportRequestConfig.html index fa60b9f503..f5b51e83d5 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_v4.ODataBoundActionImportRequestConfig.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_v4.ODataBoundActionImportRequestConfig.html @@ -1,4 +1,4 @@ -ODataBoundActionImportRequestConfig | SAP Cloud SDK for JavaScript - v3.22.0

    Class ODataBoundActionImportRequestConfig<EntityT, DeSerializersT, ParametersT>

    Deprecated

    Since 3.3.0. Use ODataBoundActionRequestConfig instead.

    +ODataBoundActionImportRequestConfig | SAP Cloud SDK for JavaScript - v3.22.1

    Class ODataBoundActionImportRequestConfig<EntityT, DeSerializersT, ParametersT>

    Deprecated

    Since 3.3.0. Use ODataBoundActionRequestConfig instead.

    Type Parameters

    Hierarchy (view full)

    Constructors

    constructor

    Properties

    actionName basePath @@ -33,4 +33,4 @@

    Returns void

    addCustomRequestConfiguration

    • addCustomRequestConfiguration(requestConfiguration): 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.

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

        -

      Returns void

    appendPath

    • appendPath(...path): void

    • Parameters

      • Rest...path: string[]

      Returns void

    ProtectedprependDollarToQueryParameters

    queryParameters

    resourcePath

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns void

    appendPath

    • appendPath(...path): void

    • Parameters

      • Rest...path: string[]

      Returns void

    ProtectedprependDollarToQueryParameters

    queryParameters

    resourcePath

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_v4.ODataBoundActionRequestConfig.html b/static/api/v3/classes/sap_cloud_sdk_odata_v4.ODataBoundActionRequestConfig.html index 32ee053ee8..5ab2051278 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_v4.ODataBoundActionRequestConfig.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_v4.ODataBoundActionRequestConfig.html @@ -1,4 +1,4 @@ -ODataBoundActionRequestConfig | SAP Cloud SDK for JavaScript - v3.22.0

    Class ODataBoundActionRequestConfig<EntityT, DeSerializersT, ParametersT>

    Action request configuration for an entity type.

    +ODataBoundActionRequestConfig | SAP Cloud SDK for JavaScript - v3.22.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

    constructor @@ -34,4 +34,4 @@

    Returns void

    addCustomRequestConfiguration

    • addCustomRequestConfiguration(requestConfiguration): 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.

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

        -

      Returns void

    appendPath

    • appendPath(...path): void

    • Parameters

      • Rest...path: string[]

      Returns void

    ProtectedprependDollarToQueryParameters

    queryParameters

    • queryParameters(): Record<string, any>
    • Internal

      Returns Record<string, any>

    resourcePath

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns void

    appendPath

    • appendPath(...path): void

    • Parameters

      • Rest...path: string[]

      Returns void

    ProtectedprependDollarToQueryParameters

    queryParameters

    • queryParameters(): Record<string, any>
    • Internal

      Returns Record<string, any>

    resourcePath

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_v4.ODataBoundFunctionRequestConfig.html b/static/api/v3/classes/sap_cloud_sdk_odata_v4.ODataBoundFunctionRequestConfig.html index 1101e5ce4b..991b2d7714 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_v4.ODataBoundFunctionRequestConfig.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_v4.ODataBoundFunctionRequestConfig.html @@ -1,4 +1,4 @@ -ODataBoundFunctionRequestConfig | SAP Cloud SDK for JavaScript - v3.22.0

    Class ODataBoundFunctionRequestConfig<EntityT, DeSerializersT, ParametersT>

    Function request configuration for an entity type.

    +ODataBoundFunctionRequestConfig | SAP Cloud SDK for JavaScript - v3.22.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

    constructor @@ -34,4 +34,4 @@

    Returns void

    addCustomRequestConfiguration

    • addCustomRequestConfiguration(requestConfiguration): 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.

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

        -

      Returns void

    appendPath

    • appendPath(...path): void

    • Parameters

      • Rest...path: string[]

      Returns void

    ProtectedprependDollarToQueryParameters

    queryParameters

    • queryParameters(): Record<string, any>
    • Internal

      Returns Record<string, any>

    resourcePath

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns void

    appendPath

    • appendPath(...path): void

    • Parameters

      • Rest...path: string[]

      Returns void

    ProtectedprependDollarToQueryParameters

    queryParameters

    • queryParameters(): Record<string, any>
    • Internal

      Returns Record<string, any>

    resourcePath

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_v4.ODataFunctionRequestConfig.html b/static/api/v3/classes/sap_cloud_sdk_odata_v4.ODataFunctionRequestConfig.html index b1e411ce4a..d500690c28 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_v4.ODataFunctionRequestConfig.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_v4.ODataFunctionRequestConfig.html @@ -1,4 +1,4 @@ -ODataFunctionRequestConfig | SAP Cloud SDK for JavaScript - v3.22.0

    Class ODataFunctionRequestConfig<DeSerializersT, ParametersT>

    Function request configuration for an entity type.

    +ODataFunctionRequestConfig | SAP Cloud SDK for JavaScript - v3.22.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

    constructor @@ -37,4 +37,4 @@

    Returns void

    addCustomRequestConfiguration

    • addCustomRequestConfiguration(requestConfiguration): 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.

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

        -

      Returns void

    appendPath

    • appendPath(...path): void

    • Parameters

      • Rest...path: string[]

      Returns void

    ProtectedprependDollarToQueryParameters

    queryParameters

    resourcePath

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Returns void

    appendPath

    • appendPath(...path): void

    • Parameters

      • Rest...path: string[]

      Returns void

    ProtectedprependDollarToQueryParameters

    queryParameters

    resourcePath

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_v4.OperationRequestBuilder.html b/static/api/v3/classes/sap_cloud_sdk_odata_v4.OperationRequestBuilder.html index 390ca4ecd0..0eb00f659a 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_v4.OperationRequestBuilder.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_v4.OperationRequestBuilder.html @@ -1,4 +1,4 @@ -OperationRequestBuilder | SAP Cloud SDK for JavaScript - v3.22.0

    Class OperationRequestBuilder<DeSerializersT, ParametersT, ReturnT>

    Create OData request to execute an operation.

    +OperationRequestBuilder | SAP Cloud SDK for JavaScript - v3.22.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

    constructor @@ -67,4 +67,4 @@

    Parameters

    Returns Promise<string>

    Promise resolving to the URL for the request.

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

    -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_odata_v4.UpdateRequestBuilder.html b/static/api/v3/classes/sap_cloud_sdk_odata_v4.UpdateRequestBuilder.html index 67a14febc0..e1f446240f 100644 --- a/static/api/v3/classes/sap_cloud_sdk_odata_v4.UpdateRequestBuilder.html +++ b/static/api/v3/classes/sap_cloud_sdk_odata_v4.UpdateRequestBuilder.html @@ -1,4 +1,4 @@ -UpdateRequestBuilder | SAP Cloud SDK for JavaScript - v3.22.0

    Class UpdateRequestBuilder<EntityT, DeSerializersT>

    Create OData query to update an entity.

    +UpdateRequestBuilder | SAP Cloud SDK for JavaScript - v3.22.1

    Class UpdateRequestBuilder<EntityT, DeSerializersT>

    Create OData query to update an entity.

    Type Parameters

    Hierarchy (view full)

    Implements

    Constructors

    constructor

    Properties

    _deSerializers @@ -94,4 +94,4 @@

    Parameters

    Returns Promise<string>

    Promise resolving to the URL for the request.

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

    -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_openapi.OpenApiRequestBuilder.html b/static/api/v3/classes/sap_cloud_sdk_openapi.OpenApiRequestBuilder.html index a0d17c3c68..43e98309ae 100644 --- a/static/api/v3/classes/sap_cloud_sdk_openapi.OpenApiRequestBuilder.html +++ b/static/api/v3/classes/sap_cloud_sdk_openapi.OpenApiRequestBuilder.html @@ -1,4 +1,4 @@ -OpenApiRequestBuilder | SAP Cloud SDK for JavaScript - v3.22.0

    Class OpenApiRequestBuilder<ResponseT>

    Request builder for OpenAPI requests.

    +OpenApiRequestBuilder | SAP Cloud SDK for JavaScript - v3.22.1

    Class OpenApiRequestBuilder<ResponseT>

    Request builder for OpenAPI requests.

    Type Parameters

    • ResponseT = any

      Type of the response for the request.

    Constructors

    constructor

    Properties

    method @@ -35,4 +35,4 @@

    skipCsrfTokenFetching

    • skipCsrfTokenFetching(): 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.

      -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_util.ErrorWithCause.html b/static/api/v3/classes/sap_cloud_sdk_util.ErrorWithCause.html index 6d537929fd..bd6a559ce8 100644 --- a/static/api/v3/classes/sap_cloud_sdk_util.ErrorWithCause.html +++ b/static/api/v3/classes/sap_cloud_sdk_util.ErrorWithCause.html @@ -1,4 +1,4 @@ -ErrorWithCause | SAP Cloud SDK for JavaScript - v3.22.0

    Class ErrorWithCause

    Represents an error that was caused by another error.

    +ErrorWithCause | SAP Cloud SDK for JavaScript - v3.22.1

    Class ErrorWithCause

    Represents an error that was caused by another error.

    Hierarchy

    • Error
      • ErrorWithCause

    Constructors

    constructor

    Properties

    cause message @@ -19,4 +19,4 @@

    Returns Error

    The root cause.

    Methods

    StaticcaptureStackTrace

    • captureStackTrace(targetObject, constructorOpt?): void

    • Create .stack property on a target object

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

      -

      Parameters

      • targetObject: object
      • OptionalconstructorOpt: Function

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    +

    Parameters

    • targetObject: object
    • OptionalconstructorOpt: Function

    Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods
    diff --git a/static/api/v3/classes/sap_cloud_sdk_util.UniqueNameGenerator.html b/static/api/v3/classes/sap_cloud_sdk_util.UniqueNameGenerator.html index 292de3c142..fc2c8a1ff3 100644 --- a/static/api/v3/classes/sap_cloud_sdk_util.UniqueNameGenerator.html +++ b/static/api/v3/classes/sap_cloud_sdk_util.UniqueNameGenerator.html @@ -1,4 +1,4 @@ -UniqueNameGenerator | SAP Cloud SDK for JavaScript - v3.22.0

    Class UniqueNameGenerator

    Holds state on already used names and provides new names if there are naming conflicts.

    +UniqueNameGenerator | SAP Cloud SDK for JavaScript - v3.22.1

    Class UniqueNameGenerator

    Holds state on already used names and provides new names if there are naming conflicts.

    Constructors

    constructor

    Methods

    addToUsedNames generateAndSaveUniqueName @@ -47,4 +47,4 @@

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

    -

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    diff --git a/static/api/v3/functions/sap_cloud_sdk_connectivity.alwaysProvider.html b/static/api/v3/functions/sap_cloud_sdk_connectivity.alwaysProvider.html index 58c044fa45..10976ebc3e 100644 --- a/static/api/v3/functions/sap_cloud_sdk_connectivity.alwaysProvider.html +++ b/static/api/v3/functions/sap_cloud_sdk_connectivity.alwaysProvider.html @@ -1,6 +1,6 @@ -alwaysProvider | SAP Cloud SDK for JavaScript - v3.22.0

    Function alwaysProvider

    • alwaysProvider(allDestinations, destinationName): Destination | null

    • Constraints the selection to provider destinations.

      +alwaysProvider | SAP Cloud SDK for JavaScript - v3.22.1

      Function alwaysProvider

      • alwaysProvider(allDestinations, destinationName): Destination | null

      • 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_connectivity.alwaysSubscriber.html b/static/api/v3/functions/sap_cloud_sdk_connectivity.alwaysSubscriber.html index 0e5fde2ddd..c5f11d7bb9 100644 --- a/static/api/v3/functions/sap_cloud_sdk_connectivity.alwaysSubscriber.html +++ b/static/api/v3/functions/sap_cloud_sdk_connectivity.alwaysSubscriber.html @@ -1,6 +1,6 @@ -alwaysSubscriber | SAP Cloud SDK for JavaScript - v3.22.0

    Function alwaysSubscriber

    • alwaysSubscriber(allDestinations, destinationName): Destination | null

    • Constraints the selection to subscriber destinations.

      +alwaysSubscriber | SAP Cloud SDK for JavaScript - v3.22.1

      Function alwaysSubscriber

      • alwaysSubscriber(allDestinations, destinationName): Destination | null

      • 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_connectivity.assertHttpDestination.html b/static/api/v3/functions/sap_cloud_sdk_connectivity.assertHttpDestination.html index fa17690b0f..ec0aa20310 100644 --- a/static/api/v3/functions/sap_cloud_sdk_connectivity.assertHttpDestination.html +++ b/static/api/v3/functions/sap_cloud_sdk_connectivity.assertHttpDestination.html @@ -1,5 +1,5 @@ -assertHttpDestination | SAP Cloud SDK for JavaScript - v3.22.0

    Function assertHttpDestination

    • assertHttpDestination(destination): asserts destination is HttpDestination

    • Assertion that the Destination is a HttpDestination. +assertHttpDestination | SAP Cloud SDK for JavaScript - v3.22.1

      Function assertHttpDestination

      • assertHttpDestination(destination): asserts destination is HttpDestination

      • 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.

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

          -

        Returns asserts destination is HttpDestination

      Settings

      Member Visibility
      +

    Returns asserts destination is HttpDestination

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_connectivity.buildHeadersForDestination.html b/static/api/v3/functions/sap_cloud_sdk_connectivity.buildHeadersForDestination.html index abfcf89603..25dabd9ea5 100644 --- a/static/api/v3/functions/sap_cloud_sdk_connectivity.buildHeadersForDestination.html +++ b/static/api/v3/functions/sap_cloud_sdk_connectivity.buildHeadersForDestination.html @@ -1,5 +1,5 @@ -buildHeadersForDestination | SAP Cloud SDK for JavaScript - v3.22.0

    Function buildHeadersForDestination

    • buildHeadersForDestination(destination): Promise<Record<string, string>>

    • Build a request header object, that contains authentication headers and SAP specific headers like 'sap-client', from a given destination.

      +buildHeadersForDestination | SAP Cloud SDK for JavaScript - v3.22.1

      Function buildHeadersForDestination

      • buildHeadersForDestination(destination): Promise<Record<string, string>>

      • 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_connectivity.decodeJwt.html b/static/api/v3/functions/sap_cloud_sdk_connectivity.decodeJwt.html index 562cc34041..ed62a0aa93 100644 --- a/static/api/v3/functions/sap_cloud_sdk_connectivity.decodeJwt.html +++ b/static/api/v3/functions/sap_cloud_sdk_connectivity.decodeJwt.html @@ -1,5 +1,5 @@ -decodeJwt | SAP Cloud SDK for JavaScript - v3.22.0

    Function decodeJwt

    • decodeJwt(token): JwtPayload

    • Decode JWT.

      +decodeJwt | SAP Cloud SDK for JavaScript - v3.22.1

      Function decodeJwt

      • decodeJwt(token): JwtPayload

      • Decode JWT.

        Parameters

        Returns JwtPayload

        Decoded payload.

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

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_connectivity.destinationForServiceBinding.html b/static/api/v3/functions/sap_cloud_sdk_connectivity.destinationForServiceBinding.html index 164856145c..2934490545 100644 --- a/static/api/v3/functions/sap_cloud_sdk_connectivity.destinationForServiceBinding.html +++ b/static/api/v3/functions/sap_cloud_sdk_connectivity.destinationForServiceBinding.html @@ -1,4 +1,4 @@ -destinationForServiceBinding | SAP Cloud SDK for JavaScript - v3.22.0

    Function destinationForServiceBinding

    • destinationForServiceBinding(serviceInstanceName, options?): Promise<Destination>

    • Tries to build a destination from a service binding with the given name. +destinationForServiceBinding | SAP Cloud SDK for JavaScript - v3.22.1

      Function destinationForServiceBinding

      • destinationForServiceBinding(serviceInstanceName, options?): Promise<Destination>

      • 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

        • serviceInstanceName: string

          The name of the service.

          @@ -6,4 +6,4 @@

        Returns Promise<Destination>

        A destination.

        Deprecated

        Since v3.4.0. Use getDestinationFromServiceBinding instead.

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

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_connectivity.getAgentConfig.html b/static/api/v3/functions/sap_cloud_sdk_connectivity.getAgentConfig.html index 7bc2a292e8..ce5ca4d345 100644 --- a/static/api/v3/functions/sap_cloud_sdk_connectivity.getAgentConfig.html +++ b/static/api/v3/functions/sap_cloud_sdk_connectivity.getAgentConfig.html @@ -1,8 +1,8 @@ -getAgentConfig | SAP Cloud SDK for JavaScript - v3.22.0

    Function getAgentConfig

    • getAgentConfig(destination): HttpAgentConfig | HttpsAgentConfig

    • Returns the http or https-agent config depending on the destination URL. +getAgentConfig | SAP Cloud SDK for JavaScript - v3.22.1

      Function getAgentConfig

      • getAgentConfig(destination): HttpAgentConfig | HttpsAgentConfig

      • 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.

        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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_connectivity.getAgentConfigAsync.html b/static/api/v3/functions/sap_cloud_sdk_connectivity.getAgentConfigAsync.html index f3b0420d72..6e9a5684fc 100644 --- a/static/api/v3/functions/sap_cloud_sdk_connectivity.getAgentConfigAsync.html +++ b/static/api/v3/functions/sap_cloud_sdk_connectivity.getAgentConfigAsync.html @@ -1,8 +1,8 @@ -getAgentConfigAsync | SAP Cloud SDK for JavaScript - v3.22.0

    Function getAgentConfigAsync

    • getAgentConfigAsync(destination): Promise<HttpAgentConfig | HttpsAgentConfig>

    • Will be renamed to getAgentConfig in the next major release. +getAgentConfigAsync | SAP Cloud SDK for JavaScript - v3.22.1

      Function getAgentConfigAsync

      • getAgentConfigAsync(destination): Promise<HttpAgentConfig | HttpsAgentConfig>

      • 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.

        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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_connectivity.getAllDestinationsFromDestinationService.html b/static/api/v3/functions/sap_cloud_sdk_connectivity.getAllDestinationsFromDestinationService.html index 8c5ee83c9e..19c93bddb2 100644 --- a/static/api/v3/functions/sap_cloud_sdk_connectivity.getAllDestinationsFromDestinationService.html +++ b/static/api/v3/functions/sap_cloud_sdk_connectivity.getAllDestinationsFromDestinationService.html @@ -1,6 +1,6 @@ -getAllDestinationsFromDestinationService | SAP Cloud SDK for JavaScript - v3.22.0

    Function getAllDestinationsFromDestinationService

    • getAllDestinationsFromDestinationService(options?): Promise<DestinationWithoutToken[]>

    • Fetches all destinations from the destination service which match the token. +getAllDestinationsFromDestinationService | SAP Cloud SDK for JavaScript - v3.22.1

      Function getAllDestinationsFromDestinationService

      • getAllDestinationsFromDestinationService(options?): Promise<DestinationWithoutToken[]>

      • 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

        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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_connectivity.getClientCredentialsToken.html b/static/api/v3/functions/sap_cloud_sdk_connectivity.getClientCredentialsToken.html index f070811952..ef4ddf6714 100644 --- a/static/api/v3/functions/sap_cloud_sdk_connectivity.getClientCredentialsToken.html +++ b/static/api/v3/functions/sap_cloud_sdk_connectivity.getClientCredentialsToken.html @@ -1,6 +1,6 @@ -getClientCredentialsToken | SAP Cloud SDK for JavaScript - v3.22.0

    Function getClientCredentialsToken

    • getClientCredentialsToken(service, jwt?): Promise<ClientCredentialsResponse>

    • Make a client credentials request against the XSUAA service.

      +getClientCredentialsToken | SAP Cloud SDK for JavaScript - v3.22.1

      Function getClientCredentialsToken

      • getClientCredentialsToken(service, jwt?): Promise<ClientCredentialsResponse>

      • Make a client credentials request against the XSUAA service.

        Parameters

        • service: string | Service

          Service as it is defined in the environment variable.

        • Optionaljwt: string | JwtPayload

          User JWT or object containing the iss property.

        Returns Promise<ClientCredentialsResponse>

        Client credentials token.

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

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_connectivity.getDestination.html b/static/api/v3/functions/sap_cloud_sdk_connectivity.getDestination.html index d65029aad7..33d4478068 100644 --- a/static/api/v3/functions/sap_cloud_sdk_connectivity.getDestination.html +++ b/static/api/v3/functions/sap_cloud_sdk_connectivity.getDestination.html @@ -1,4 +1,4 @@ -getDestination | SAP Cloud SDK for JavaScript - v3.22.0

    Function getDestination

    • getDestination(options): Promise<Destination | null>

    • Builds a destination from one of three sources (in the given order):

      +getDestination | SAP Cloud SDK for JavaScript - v3.22.1

      Function getDestination

      • getDestination(options): Promise<Destination | null>

      • Builds a destination from one of three sources (in the given order):

        • from the environment variable "destinations".
        • from service bindings.
          • @@ -9,4 +9,4 @@

        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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_connectivity.getDestinationFromDestinationService.html b/static/api/v3/functions/sap_cloud_sdk_connectivity.getDestinationFromDestinationService.html index 856d813a64..e78827793e 100644 --- a/static/api/v3/functions/sap_cloud_sdk_connectivity.getDestinationFromDestinationService.html +++ b/static/api/v3/functions/sap_cloud_sdk_connectivity.getDestinationFromDestinationService.html @@ -1,8 +1,8 @@ -getDestinationFromDestinationService | SAP Cloud SDK for JavaScript - v3.22.0

    Function getDestinationFromDestinationService

    • getDestinationFromDestinationService(options): Promise<Destination | null>

    • Retrieves a destination with the given name from the Cloud Foundry destination service. +getDestinationFromDestinationService | SAP Cloud SDK for JavaScript - v3.22.1

      Function getDestinationFromDestinationService

      • getDestinationFromDestinationService(options): Promise<Destination | null>

      • 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

        Returns Promise<Destination | null>

        A promise returning the requested destination on success.

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

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_connectivity.getDestinationFromServiceBinding.html b/static/api/v3/functions/sap_cloud_sdk_connectivity.getDestinationFromServiceBinding.html index a3c855b558..76277ebbe2 100644 --- a/static/api/v3/functions/sap_cloud_sdk_connectivity.getDestinationFromServiceBinding.html +++ b/static/api/v3/functions/sap_cloud_sdk_connectivity.getDestinationFromServiceBinding.html @@ -1,7 +1,7 @@ -getDestinationFromServiceBinding | SAP Cloud SDK for JavaScript - v3.22.0

    Function getDestinationFromServiceBinding

    • getDestinationFromServiceBinding(options): Promise<Destination>

    • Tries to build a destination from a service binding with the given name. +getDestinationFromServiceBinding | SAP Cloud SDK for JavaScript - v3.22.1

      Function getDestinationFromServiceBinding

      • getDestinationFromServiceBinding(options): Promise<Destination>

      • 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

        Returns Promise<Destination>

        A destination.

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

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_connectivity.getServiceBinding.html b/static/api/v3/functions/sap_cloud_sdk_connectivity.getServiceBinding.html index f41ac97706..c806ccfad3 100644 --- a/static/api/v3/functions/sap_cloud_sdk_connectivity.getServiceBinding.html +++ b/static/api/v3/functions/sap_cloud_sdk_connectivity.getServiceBinding.html @@ -1,6 +1,6 @@ -getServiceBinding | SAP Cloud SDK for JavaScript - v3.22.0

    Function getServiceBinding

    • getServiceBinding(service): Service | undefined

    • Returns the first found instance for the given service type. +getServiceBinding | SAP Cloud SDK for JavaScript - v3.22.1

      Function getServiceBinding

      • getServiceBinding(service): Service | undefined

      • Returns the first found instance for the given service type. Internally uses xsenv library to read configurations from VCAP_SERVICES.

        Parameters

        • service: string

          The service type.

        Returns Service | undefined

        The first found service.

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

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_connectivity.getTenantId.html b/static/api/v3/functions/sap_cloud_sdk_connectivity.getTenantId.html index 2af32f3c97..6e59f4c210 100644 --- a/static/api/v3/functions/sap_cloud_sdk_connectivity.getTenantId.html +++ b/static/api/v3/functions/sap_cloud_sdk_connectivity.getTenantId.html @@ -1,5 +1,5 @@ -getTenantId | SAP Cloud SDK for JavaScript - v3.22.0

    Function getTenantId

    • getTenantId(jwt): string | undefined

    • Get the tenant ID of a decoded JWT, based on its zid or if not available app_tid property.

      +getTenantId | SAP Cloud SDK for JavaScript - v3.22.1

      Function getTenantId

      • getTenantId(jwt): string | undefined

      • Get the tenant ID of a decoded JWT, based on its zid or if not available app_tid property.

        Parameters

        • jwt: undefined | string | JwtPayload

          Token to read the tenant ID from.

        Returns string | undefined

        The tenant ID, if available.

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

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_connectivity.getUserToken.html b/static/api/v3/functions/sap_cloud_sdk_connectivity.getUserToken.html index 4054bc4963..1c6f95c588 100644 --- a/static/api/v3/functions/sap_cloud_sdk_connectivity.getUserToken.html +++ b/static/api/v3/functions/sap_cloud_sdk_connectivity.getUserToken.html @@ -1,6 +1,6 @@ -getUserToken | SAP Cloud SDK for JavaScript - v3.22.0

    Function getUserToken

    • getUserToken(service, userJwt): Promise<string>

    • Make a user token request against the XSUAA service.

      +getUserToken | SAP Cloud SDK for JavaScript - v3.22.1

      Function getUserToken

      • getUserToken(service, userJwt): Promise<string>

      • 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_connectivity.isHttpDestination.html b/static/api/v3/functions/sap_cloud_sdk_connectivity.isHttpDestination.html index 80a86b4290..f960be737d 100644 --- a/static/api/v3/functions/sap_cloud_sdk_connectivity.isHttpDestination.html +++ b/static/api/v3/functions/sap_cloud_sdk_connectivity.isHttpDestination.html @@ -1,5 +1,5 @@ -isHttpDestination | SAP Cloud SDK for JavaScript - v3.22.0

    Function isHttpDestination

    • isHttpDestination(destination): destination is HttpDestination

    • Type guard to find if object is a Destination.

      +isHttpDestination | SAP Cloud SDK for JavaScript - v3.22.1

      Function isHttpDestination

      • isHttpDestination(destination): destination is HttpDestination

      • Type guard to find if object is a Destination.

        Parameters

        Returns destination is HttpDestination

        Boolean.

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

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_connectivity.jwtBearerToken.html b/static/api/v3/functions/sap_cloud_sdk_connectivity.jwtBearerToken.html index 7c34ff5cbc..0e7a059eb0 100644 --- a/static/api/v3/functions/sap_cloud_sdk_connectivity.jwtBearerToken.html +++ b/static/api/v3/functions/sap_cloud_sdk_connectivity.jwtBearerToken.html @@ -1,8 +1,8 @@ -jwtBearerToken | SAP Cloud SDK for JavaScript - v3.22.0

    Function jwtBearerToken

    • jwtBearerToken(jwt, service): Promise<string>

    • Returns a JWT bearer token that can be used to call the given service. +jwtBearerToken | SAP Cloud SDK for JavaScript - v3.22.1

      Function jwtBearerToken

      • jwtBearerToken(jwt, service): Promise<string>

      • 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.

        Returns Promise<string>

        A JWT bearer token.

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

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_connectivity.parseDestination.html b/static/api/v3/functions/sap_cloud_sdk_connectivity.parseDestination.html index 56e72a7feb..dce04eab04 100644 --- a/static/api/v3/functions/sap_cloud_sdk_connectivity.parseDestination.html +++ b/static/api/v3/functions/sap_cloud_sdk_connectivity.parseDestination.html @@ -1,7 +1,7 @@ -parseDestination | SAP Cloud SDK for JavaScript - v3.22.0

    Function parseDestination

    • parseDestination(destinationJson): Destination

    • 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.22.1

      Function parseDestination

      • parseDestination(destinationJson): Destination

      • 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

        Returns Destination

        An SDK compatible destination object.

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

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_connectivity.parseProxyEnv.html b/static/api/v3/functions/sap_cloud_sdk_connectivity.parseProxyEnv.html index 21da145120..a9dcdf82fc 100644 --- a/static/api/v3/functions/sap_cloud_sdk_connectivity.parseProxyEnv.html +++ b/static/api/v3/functions/sap_cloud_sdk_connectivity.parseProxyEnv.html @@ -1,7 +1,7 @@ -parseProxyEnv | SAP Cloud SDK for JavaScript - v3.22.0

    Function parseProxyEnv

    • parseProxyEnv(proxyEnvValue): ProxyConfiguration | undefined

    • 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.22.1

      Function parseProxyEnv

      • parseProxyEnv(proxyEnvValue): ProxyConfiguration | undefined

      • 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.

        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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_connectivity.registerDestination.html b/static/api/v3/functions/sap_cloud_sdk_connectivity.registerDestination.html index 312ed31f8e..89daa426a2 100644 --- a/static/api/v3/functions/sap_cloud_sdk_connectivity.registerDestination.html +++ b/static/api/v3/functions/sap_cloud_sdk_connectivity.registerDestination.html @@ -1,7 +1,7 @@ -registerDestination | SAP Cloud SDK for JavaScript - v3.22.0

    Function registerDestination

    • registerDestination(destination, options?): Promise<void>

    • Registers a destination in a cache for later usage.

      +registerDestination | SAP Cloud SDK for JavaScript - v3.22.1

      Function registerDestination

      • registerDestination(destination, options?): Promise<void>

      • 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.

        • Optionaloptions: RegisterDestinationOptions

          Options how to cache the destination.

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

          -

        Returns Promise<void>

      Settings

      Member Visibility
      +

    Returns Promise<void>

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_connectivity.retrieveJwt.html b/static/api/v3/functions/sap_cloud_sdk_connectivity.retrieveJwt.html index 7a13764262..90e6427d52 100644 --- a/static/api/v3/functions/sap_cloud_sdk_connectivity.retrieveJwt.html +++ b/static/api/v3/functions/sap_cloud_sdk_connectivity.retrieveJwt.html @@ -1,5 +1,5 @@ -retrieveJwt | SAP Cloud SDK for JavaScript - v3.22.0

    Function retrieveJwt

    • retrieveJwt(req): string | undefined

    • 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 '.

      +retrieveJwt | SAP Cloud SDK for JavaScript - v3.22.1

      Function retrieveJwt

      • retrieveJwt(req): string | undefined

      • 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_connectivity.sanitizeDestination.html b/static/api/v3/functions/sap_cloud_sdk_connectivity.sanitizeDestination.html index 93f672e767..05b8a0f555 100644 --- a/static/api/v3/functions/sap_cloud_sdk_connectivity.sanitizeDestination.html +++ b/static/api/v3/functions/sap_cloud_sdk_connectivity.sanitizeDestination.html @@ -1,5 +1,5 @@ -sanitizeDestination | SAP Cloud SDK for JavaScript - v3.22.0

    Function sanitizeDestination

    • sanitizeDestination(destination): Destination

    • Takes an existing or a parsed destination and returns an SDK compatible destination object.

      +sanitizeDestination | SAP Cloud SDK for JavaScript - v3.22.1

      Function sanitizeDestination

      • sanitizeDestination(destination): Destination

      • 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_connectivity.serviceToken.html b/static/api/v3/functions/sap_cloud_sdk_connectivity.serviceToken.html index 1af882bda7..e39d674d48 100644 --- a/static/api/v3/functions/sap_cloud_sdk_connectivity.serviceToken.html +++ b/static/api/v3/functions/sap_cloud_sdk_connectivity.serviceToken.html @@ -1,4 +1,4 @@ -serviceToken | SAP Cloud SDK for JavaScript - v3.22.0

    Function serviceToken

    • serviceToken(service, options?): Promise<string>

    • 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.22.1

      Function serviceToken

      • serviceToken(service, options?): Promise<string>

      • 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.

        @@ -7,4 +7,4 @@
      • Optionaloptions: 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.

      Returns Promise<string>

      Access token.

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

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_connectivity.setDestinationCache.html b/static/api/v3/functions/sap_cloud_sdk_connectivity.setDestinationCache.html index 68f8a20e39..698b9e5ee1 100644 --- a/static/api/v3/functions/sap_cloud_sdk_connectivity.setDestinationCache.html +++ b/static/api/v3/functions/sap_cloud_sdk_connectivity.setDestinationCache.html @@ -1,6 +1,6 @@ -setDestinationCache | SAP Cloud SDK for JavaScript - v3.22.0

    Function setDestinationCache

    Returns void

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_connectivity.subscriberFirst.html b/static/api/v3/functions/sap_cloud_sdk_connectivity.subscriberFirst.html index 4ea116d245..d10d44afbc 100644 --- a/static/api/v3/functions/sap_cloud_sdk_connectivity.subscriberFirst.html +++ b/static/api/v3/functions/sap_cloud_sdk_connectivity.subscriberFirst.html @@ -1,6 +1,6 @@ -subscriberFirst | SAP Cloud SDK for JavaScript - v3.22.0

    Function subscriberFirst

    • subscriberFirst(allDestinations, destinationName): Destination | null

    • Prioritizes the selection of subscriber destinations.

      +subscriberFirst | SAP Cloud SDK for JavaScript - v3.22.1

      Function subscriberFirst

      • subscriberFirst(allDestinations, destinationName): Destination | null

      • 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_connectivity.toDestinationNameUrl.html b/static/api/v3/functions/sap_cloud_sdk_connectivity.toDestinationNameUrl.html index b618a882c9..872dc5fecb 100644 --- a/static/api/v3/functions/sap_cloud_sdk_connectivity.toDestinationNameUrl.html +++ b/static/api/v3/functions/sap_cloud_sdk_connectivity.toDestinationNameUrl.html @@ -1,5 +1,5 @@ -toDestinationNameUrl | SAP Cloud SDK for JavaScript - v3.22.0

    Function toDestinationNameUrl

    • toDestinationNameUrl(destination): string

    • Transform destination to string containing destination information.

      +toDestinationNameUrl | SAP Cloud SDK for JavaScript - v3.22.1

      Function toDestinationNameUrl

      • toDestinationNameUrl(destination): string

      • 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_connectivity.transformServiceBindingToDestination.html b/static/api/v3/functions/sap_cloud_sdk_connectivity.transformServiceBindingToDestination.html index 3450455ac3..8b39c45444 100644 --- a/static/api/v3/functions/sap_cloud_sdk_connectivity.transformServiceBindingToDestination.html +++ b/static/api/v3/functions/sap_cloud_sdk_connectivity.transformServiceBindingToDestination.html @@ -1,4 +1,4 @@ -transformServiceBindingToDestination | SAP Cloud SDK for JavaScript - v3.22.0

    Function transformServiceBindingToDestination

    • transformServiceBindingToDestination(serviceBinding, options?): Promise<Destination>

    • Convenience function to create a destination from the provided service binding. +transformServiceBindingToDestination | SAP Cloud SDK for JavaScript - v3.22.1

      Function transformServiceBindingToDestination

      • transformServiceBindingToDestination(serviceBinding, options?): Promise<Destination>

      • Convenience function to create a destination from the provided service binding. If a JWT is provided as part of options, the tenant in the JWT is used for client credentials grant, else the provider tenant is used, wherever applicable. Supported service types are:

          @@ -16,4 +16,4 @@
      • Optionaloptions: ServiceBindingTransformOptions

        Options used for fetching the destination.

      Returns Promise<Destination>

      A promise returning the transformed destination on success.

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

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_connectivity.useOrFetchDestination.html b/static/api/v3/functions/sap_cloud_sdk_connectivity.useOrFetchDestination.html index 70db56bbb1..a841177835 100644 --- a/static/api/v3/functions/sap_cloud_sdk_connectivity.useOrFetchDestination.html +++ b/static/api/v3/functions/sap_cloud_sdk_connectivity.useOrFetchDestination.html @@ -1,4 +1,4 @@ -useOrFetchDestination | SAP Cloud SDK for JavaScript - v3.22.0

    Function useOrFetchDestination

    • useOrFetchDestination(destination): Promise<Destination | null>

    • 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.22.1

      Function useOrFetchDestination

      • useOrFetchDestination(destination): Promise<Destination | null>

      • 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:

          @@ -9,4 +9,4 @@

        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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_generator.generate.html b/static/api/v3/functions/sap_cloud_sdk_generator.generate.html index 64ed1bd3f0..b1b995fca1 100644 --- a/static/api/v3/functions/sap_cloud_sdk_generator.generate.html +++ b/static/api/v3/functions/sap_cloud_sdk_generator.generate.html @@ -1,6 +1,6 @@ -generate | SAP Cloud SDK for JavaScript - v3.22.0

    Function generate

    • generate(options): Promise<void>

    • Main entry point for the OData client generation. +generate | SAP Cloud SDK for JavaScript - v3.22.1

      Function generate

      • generate(options): Promise<void>

      • Main entry point for the OData client generation. Generates models and API files.

        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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_http_client.buildHttpRequest.html b/static/api/v3/functions/sap_cloud_sdk_http_client.buildHttpRequest.html index 5214f52eff..328c20fe1b 100644 --- a/static/api/v3/functions/sap_cloud_sdk_http_client.buildHttpRequest.html +++ b/static/api/v3/functions/sap_cloud_sdk_http_client.buildHttpRequest.html @@ -1,6 +1,6 @@ -buildHttpRequest | SAP Cloud SDK for JavaScript - v3.22.0

    Function buildHttpRequest

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_http_client.csrf.html b/static/api/v3/functions/sap_cloud_sdk_http_client.csrf.html index fa0ac9ba53..e308a3117a 100644 --- a/static/api/v3/functions/sap_cloud_sdk_http_client.csrf.html +++ b/static/api/v3/functions/sap_cloud_sdk_http_client.csrf.html @@ -1,6 +1,6 @@ -csrf | SAP Cloud SDK for JavaScript - v3.22.0

    Function csrf

    • csrf(options?): HttpMiddleware

    • Middleware for fetching a CSRF token. This middleware is added to all request per default. +csrf | SAP Cloud SDK for JavaScript - v3.22.1

      Function csrf

      • csrf(options?): HttpMiddleware

      • Middleware for fetching a CSRF token. This middleware is added to all request per default. Use the fetchCsrfToken option to disable it.

        Parameters

        Returns HttpMiddleware

        The middleware for fetching CSRF tokens.

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

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_http_client.encodeAllParameters.html b/static/api/v3/functions/sap_cloud_sdk_http_client.encodeAllParameters.html index e3a6c00943..619654e495 100644 --- a/static/api/v3/functions/sap_cloud_sdk_http_client.encodeAllParameters.html +++ b/static/api/v3/functions/sap_cloud_sdk_http_client.encodeAllParameters.html @@ -1,5 +1,5 @@ -encodeAllParameters | SAP Cloud SDK for JavaScript - v3.22.0

    Function encodeAllParameters

    Encoder for encoding all query parameters (key and value) using encodeURIComponent.

    +encodeAllParameters | SAP Cloud SDK for JavaScript - v3.22.1

    Function encodeAllParameters

    Encoder for encoding all query parameters (key and value) using encodeURIComponent.

    • encodeAllParameters(parameter): Record<string, any>

    • Parameters

      • parameter: Record<string, any>

        Parameter to be encoded using encodeURIComponent.

      Returns Record<string, any>

      Encoded parameter object.

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

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_http_client.executeHttpRequest.html b/static/api/v3/functions/sap_cloud_sdk_http_client.executeHttpRequest.html index d81ebb5e33..cf957ace2d 100644 --- a/static/api/v3/functions/sap_cloud_sdk_http_client.executeHttpRequest.html +++ b/static/api/v3/functions/sap_cloud_sdk_http_client.executeHttpRequest.html @@ -1,7 +1,7 @@ -executeHttpRequest | SAP Cloud SDK for JavaScript - v3.22.0

    Function executeHttpRequest

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_http_client.executeHttpRequestWithOrigin.html b/static/api/v3/functions/sap_cloud_sdk_http_client.executeHttpRequestWithOrigin.html index 54dd49c41f..b3337e6597 100644 --- a/static/api/v3/functions/sap_cloud_sdk_http_client.executeHttpRequestWithOrigin.html +++ b/static/api/v3/functions/sap_cloud_sdk_http_client.executeHttpRequestWithOrigin.html @@ -1,4 +1,4 @@ -executeHttpRequestWithOrigin | SAP Cloud SDK for JavaScript - v3.22.0

    Function executeHttpRequestWithOrigin

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_mail_client.sendMail.html b/static/api/v3/functions/sap_cloud_sdk_mail_client.sendMail.html index d27429f2bc..7090e8a777 100644 --- a/static/api/v3/functions/sap_cloud_sdk_mail_client.sendMail.html +++ b/static/api/v3/functions/sap_cloud_sdk_mail_client.sendMail.html @@ -1,4 +1,4 @@ -sendMail | SAP Cloud SDK for JavaScript - v3.22.0

    Function sendMail

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_odata_common.and.html b/static/api/v3/functions/sap_cloud_sdk_odata_common.and.html index 40f5d2fb98..698b20d66a 100644 --- a/static/api/v3/functions/sap_cloud_sdk_odata_common.and.html +++ b/static/api/v3/functions/sap_cloud_sdk_odata_common.and.html @@ -1,4 +1,4 @@ -and | SAP Cloud SDK for JavaScript - v3.22.0

    Function and

    Settings

    Member Visibility
    +
  • and<EntityT, DeSerializersT>(...expressions): FilterList<EntityT, DeSerializersT>

  • Type Parameters

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

    Parameters

    Returns FilterList<EntityT, DeSerializersT>

    • Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_odata_common.asc.html b/static/api/v3/functions/sap_cloud_sdk_odata_common.asc.html index b796be4701..63eaa91d7b 100644 --- a/static/api/v3/functions/sap_cloud_sdk_odata_common.asc.html +++ b/static/api/v3/functions/sap_cloud_sdk_odata_common.asc.html @@ -1,6 +1,6 @@ -asc | SAP Cloud SDK for JavaScript - v3.22.0

    Function asc

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_odata_common.desc.html b/static/api/v3/functions/sap_cloud_sdk_odata_common.desc.html index 3a03d73cf6..f02915f5fb 100644 --- a/static/api/v3/functions/sap_cloud_sdk_odata_common.desc.html +++ b/static/api/v3/functions/sap_cloud_sdk_odata_common.desc.html @@ -1,6 +1,6 @@ -desc | SAP Cloud SDK for JavaScript - v3.22.0

    Function desc

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_odata_common.entityBuilder-1.html b/static/api/v3/functions/sap_cloud_sdk_odata_common.entityBuilder-1.html index 3d646d9d6b..b312ff898a 100644 --- a/static/api/v3/functions/sap_cloud_sdk_odata_common.entityBuilder-1.html +++ b/static/api/v3/functions/sap_cloud_sdk_odata_common.entityBuilder-1.html @@ -1,5 +1,5 @@ -entityBuilder | SAP Cloud SDK for JavaScript - v3.22.0

    Function entityBuilder

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_odata_common.entityDeserializer-1.html b/static/api/v3/functions/sap_cloud_sdk_odata_common.entityDeserializer-1.html index 75a57990f4..2121f06042 100644 --- a/static/api/v3/functions/sap_cloud_sdk_odata_common.entityDeserializer-1.html +++ b/static/api/v3/functions/sap_cloud_sdk_odata_common.entityDeserializer-1.html @@ -1,8 +1,8 @@ -entityDeserializer | SAP Cloud SDK for JavaScript - v3.22.0

    Function entityDeserializer

    • entityDeserializer<T>(deSerializers, extractODataETag, extractDataFromOneToManyLink): EntityDeserializer

    • Constructs an entityDeserializer given the OData v2 or v4 specific methods. +entityDeserializer | SAP Cloud SDK for JavaScript - v3.22.1

      Function entityDeserializer

      • entityDeserializer<T>(deSerializers, extractODataETag, extractDataFromOneToManyLink): EntityDeserializer

      • 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: Record<string, any>) => undefined | string)

          Extractor for the ETag.

            • (json): undefined | string

            • Parameters

              • json: Record<string, any>

              Returns undefined | string

        • extractDataFromOneToManyLink: ((data: any) => 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_odata_common.entitySerializer-1.html b/static/api/v3/functions/sap_cloud_sdk_odata_common.entitySerializer-1.html index 64b7026473..5a0ca8f231 100644 --- a/static/api/v3/functions/sap_cloud_sdk_odata_common.entitySerializer-1.html +++ b/static/api/v3/functions/sap_cloud_sdk_odata_common.entitySerializer-1.html @@ -1,6 +1,6 @@ -entitySerializer | SAP Cloud SDK for JavaScript - v3.22.0

    Function entitySerializer

    • entitySerializer(deSerializers): EntitySerializer

    • Constructs an entitySerializer given the OData v2 or v4 specific tsToEdm method. +entitySerializer | SAP Cloud SDK for JavaScript - v3.22.1

      Function entitySerializer

      • entitySerializer(deSerializers): EntitySerializer

      • 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.

        Returns EntitySerializer

        A entity serializer as defined by EntitySerializer.

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

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_odata_common.filterFunction-1.html b/static/api/v3/functions/sap_cloud_sdk_odata_common.filterFunction-1.html index d5151a9923..87723fbde5 100644 --- a/static/api/v3/functions/sap_cloud_sdk_odata_common.filterFunction-1.html +++ b/static/api/v3/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.22.0

    Function filterFunction

    Settings

    Member Visibility
    +filterFunction | SAP Cloud SDK for JavaScript - v3.22.1

    Function filterFunction

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_odata_common.isOrderableEdmType.html b/static/api/v3/functions/sap_cloud_sdk_odata_common.isOrderableEdmType.html index f2071f83ae..922bd1e6dc 100644 --- a/static/api/v3/functions/sap_cloud_sdk_odata_common.isOrderableEdmType.html +++ b/static/api/v3/functions/sap_cloud_sdk_odata_common.isOrderableEdmType.html @@ -1,5 +1,5 @@ -isOrderableEdmType | SAP Cloud SDK for JavaScript - v3.22.0

    Function isOrderableEdmType

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_odata_common.not.html b/static/api/v3/functions/sap_cloud_sdk_odata_common.not.html index 2336edd31a..287a4e7691 100644 --- a/static/api/v3/functions/sap_cloud_sdk_odata_common.not.html +++ b/static/api/v3/functions/sap_cloud_sdk_odata_common.not.html @@ -1,5 +1,5 @@ -not | SAP Cloud SDK for JavaScript - v3.22.0

    Function not

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_odata_common.or.html b/static/api/v3/functions/sap_cloud_sdk_odata_common.or.html index 4c8b099a69..ecb2a41c89 100644 --- a/static/api/v3/functions/sap_cloud_sdk_odata_common.or.html +++ b/static/api/v3/functions/sap_cloud_sdk_odata_common.or.html @@ -1,4 +1,4 @@ -or | SAP Cloud SDK for JavaScript - v3.22.0

    Function or

    Settings

    Member Visibility
    +
  • or<EntityT, DeSerializersT>(...expressions): FilterList<EntityT, DeSerializersT>

  • Type Parameters

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

    Parameters

    Returns FilterList<EntityT, DeSerializersT>

    • Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_odata_common.throwErrorWhenReturnTypeIsUnionType.html b/static/api/v3/functions/sap_cloud_sdk_odata_common.throwErrorWhenReturnTypeIsUnionType.html index 5250fd1e03..7ac7f8732e 100644 --- a/static/api/v3/functions/sap_cloud_sdk_odata_common.throwErrorWhenReturnTypeIsUnionType.html +++ b/static/api/v3/functions/sap_cloud_sdk_odata_common.throwErrorWhenReturnTypeIsUnionType.html @@ -1,5 +1,5 @@ -throwErrorWhenReturnTypeIsUnionType | SAP Cloud SDK for JavaScript - v3.22.0

    Function throwErrorWhenReturnTypeIsUnionType

    • throwErrorWhenReturnTypeIsUnionType(data, functionActionName): never

    • Throws an error.

      +throwErrorWhenReturnTypeIsUnionType | SAP Cloud SDK for JavaScript - v3.22.1

      Function throwErrorWhenReturnTypeIsUnionType

      • throwErrorWhenReturnTypeIsUnionType(data, functionActionName): never

      • Throws an error.

        Parameters

        • data: any

          Data.

        • functionActionName: string

          FunctionActionName.

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

          -

        Returns never

      Settings

      Member Visibility
      +

    Returns never

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_odata_v2.edmToTs.html b/static/api/v3/functions/sap_cloud_sdk_odata_v2.edmToTs.html index 923ab2d25b..1fac2d26a2 100644 --- a/static/api/v3/functions/sap_cloud_sdk_odata_v2.edmToTs.html +++ b/static/api/v3/functions/sap_cloud_sdk_odata_v2.edmToTs.html @@ -1,7 +1,7 @@ -edmToTs | SAP Cloud SDK for JavaScript - v3.22.0

    Function edmToTs

    • edmToTs(value, edmType, deSerializers): any

    • Convert a value from EDM format to TypeScript. This function is typically used when deserializing an OData response.

      +edmToTs | SAP Cloud SDK for JavaScript - v3.22.1

      Function edmToTs

      • edmToTs(value, edmType, deSerializers): any

      • 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_odata_v2.entityDeserializer.html b/static/api/v3/functions/sap_cloud_sdk_odata_v2.entityDeserializer.html index 13ac75f4c0..09db47161d 100644 --- a/static/api/v3/functions/sap_cloud_sdk_odata_v2.entityDeserializer.html +++ b/static/api/v3/functions/sap_cloud_sdk_odata_v2.entityDeserializer.html @@ -1,6 +1,6 @@ -entityDeserializer | SAP Cloud SDK for JavaScript - v3.22.0

    Function entityDeserializer

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_odata_v2.filterFunctions.html b/static/api/v3/functions/sap_cloud_sdk_odata_v2.filterFunctions.html index 4a6a93e84e..b7f7eea0fc 100644 --- a/static/api/v3/functions/sap_cloud_sdk_odata_v2.filterFunctions.html +++ b/static/api/v3/functions/sap_cloud_sdk_odata_v2.filterFunctions.html @@ -1,5 +1,5 @@ -filterFunctions | SAP Cloud SDK for JavaScript - v3.22.0

    Function filterFunctions

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_odata_v2.length.html b/static/api/v3/functions/sap_cloud_sdk_odata_v2.length.html index ba1b401158..965ab72051 100644 --- a/static/api/v3/functions/sap_cloud_sdk_odata_v2.length.html +++ b/static/api/v3/functions/sap_cloud_sdk_odata_v2.length.html @@ -1,6 +1,6 @@ -length | SAP Cloud SDK for JavaScript - v3.22.0

    Function length

    Export length filter function for backwards compatibility.

    +length | SAP Cloud SDK for JavaScript - v3.22.1

    Function length

    Export length filter function for backwards compatibility.

    • length<EntityT>(str): NumberFilterFunction<EntityT>
    • Internal

      Build a filter function to get the length of a string. Evaluates to int.

      Type Parameters

      Parameters

      • str: string | Field<EntityT, boolean, boolean> | StringFilterFunction<EntityT>

        The string to compute the length for. This can either be a string, a reference to a field or another filter function.

      Returns NumberFilterFunction<EntityT>

      The newly created filter function

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

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_odata_v2.mergeDefaultDeSerializersWith.html b/static/api/v3/functions/sap_cloud_sdk_odata_v2.mergeDefaultDeSerializersWith.html index 78e7db7332..261d1c520f 100644 --- a/static/api/v3/functions/sap_cloud_sdk_odata_v2.mergeDefaultDeSerializersWith.html +++ b/static/api/v3/functions/sap_cloud_sdk_odata_v2.mergeDefaultDeSerializersWith.html @@ -1,6 +1,6 @@ -mergeDefaultDeSerializersWith | SAP Cloud SDK for JavaScript - v3.22.0

    Function mergeDefaultDeSerializersWith

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_odata_v2.replace.html b/static/api/v3/functions/sap_cloud_sdk_odata_v2.replace.html index d5e58400eb..5a797e7515 100644 --- a/static/api/v3/functions/sap_cloud_sdk_odata_v2.replace.html +++ b/static/api/v3/functions/sap_cloud_sdk_odata_v2.replace.html @@ -1,7 +1,7 @@ -replace | SAP Cloud SDK for JavaScript - v3.22.0

    Function replace

    • replace<EntityT>(str, searchStr, replaceStr): StringFilterFunction<EntityT>

    • Build a filter function to replace the occurrence of a search string with another string. Evaluates to string.

      +replace | SAP Cloud SDK for JavaScript - v3.22.1

      Function replace

      • replace<EntityT>(str, searchStr, replaceStr): StringFilterFunction<EntityT>

      • Build a filter function to replace the occurrence of a search string with another string. Evaluates to string.

        Type Parameters

        Parameters

        • str: string | Field<EntityT, boolean, boolean> | StringFilterFunction<EntityT>

          The string to get the index from. This can either be a string, a reference to a field or another filter function.

        • searchStr: string | Field<EntityT, boolean, boolean> | StringFilterFunction<EntityT>

          The substring to get the index for. This can either be a string, a reference to a field or another filter function.

        • replaceStr: string | Field<EntityT, boolean, boolean> | StringFilterFunction<EntityT>

          The substring to get the index for. This can either be a string, a reference to a field or another filter function.

        Returns StringFilterFunction<EntityT>

        The newly created filter function.

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

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_odata_v2.substring.html b/static/api/v3/functions/sap_cloud_sdk_odata_v2.substring.html index f05318e80c..9461b4c84a 100644 --- a/static/api/v3/functions/sap_cloud_sdk_odata_v2.substring.html +++ b/static/api/v3/functions/sap_cloud_sdk_odata_v2.substring.html @@ -1,8 +1,8 @@ -substring | SAP Cloud SDK for JavaScript - v3.22.0

    Function substring

    Export substring filter function for backwards compatibility.

    +substring | SAP Cloud SDK for JavaScript - v3.22.1

    Function substring

    Export substring filter function for backwards compatibility.

    • substring<EntityT>(str, pos, len?): StringFilterFunction<EntityT>
    • Internal

      Build a filter function to get a substring starting from a designated position. Evaluates to string.

      Type Parameters

      Parameters

      • str: string | Field<EntityT, boolean, boolean> | StringFilterFunction<EntityT>

        The string to get a substring from. This can either be a string, a reference to a field or another filter function.

      • pos: number | Field<EntityT, boolean, boolean> | NumberFilterFunction<EntityT>

        The starting position of the substring. This can be either a number, a reference to a field or another filter function.

      • Optionallen: number | Field<EntityT, boolean, boolean> | NumberFilterFunction<EntityT>

        The length of the substring. This can be either a number, a reference to a field or another filter function.

      Returns StringFilterFunction<EntityT>

      The newly created filter function

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

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_odata_v2.substringOf.html b/static/api/v3/functions/sap_cloud_sdk_odata_v2.substringOf.html index 67db153365..5aab3a1164 100644 --- a/static/api/v3/functions/sap_cloud_sdk_odata_v2.substringOf.html +++ b/static/api/v3/functions/sap_cloud_sdk_odata_v2.substringOf.html @@ -1,6 +1,6 @@ -substringOf | SAP Cloud SDK for JavaScript - v3.22.0

    Function substringOf

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_odata_v2.transformReturnValueForComplexType.html b/static/api/v3/functions/sap_cloud_sdk_odata_v2.transformReturnValueForComplexType.html index e89d75c638..1126eda29e 100644 --- a/static/api/v3/functions/sap_cloud_sdk_odata_v2.transformReturnValueForComplexType.html +++ b/static/api/v3/functions/sap_cloud_sdk_odata_v2.transformReturnValueForComplexType.html @@ -1,6 +1,6 @@ -transformReturnValueForComplexType | SAP Cloud SDK for JavaScript - v3.22.0

    Function transformReturnValueForComplexType

    • transformReturnValueForComplexType<ReturnT>(data, builderFn): ReturnT

    • Transform the payload of the OData response to a complex type by using given deserialization function.

      +transformReturnValueForComplexType | SAP Cloud SDK for JavaScript - v3.22.1

      Function transformReturnValueForComplexType

      • transformReturnValueForComplexType<ReturnT>(data, builderFn): ReturnT

      • 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: any) => 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_odata_v2.transformReturnValueForComplexTypeList.html b/static/api/v3/functions/sap_cloud_sdk_odata_v2.transformReturnValueForComplexTypeList.html index a2557160a9..b566c89124 100644 --- a/static/api/v3/functions/sap_cloud_sdk_odata_v2.transformReturnValueForComplexTypeList.html +++ b/static/api/v3/functions/sap_cloud_sdk_odata_v2.transformReturnValueForComplexTypeList.html @@ -1,6 +1,6 @@ -transformReturnValueForComplexTypeList | SAP Cloud SDK for JavaScript - v3.22.0

    Function transformReturnValueForComplexTypeList

    • transformReturnValueForComplexTypeList<ReturnT>(data, builderFn): ReturnT[]

    • Transform the payload of the OData response to complex type array by using given deserialization function.

      +transformReturnValueForComplexTypeList | SAP Cloud SDK for JavaScript - v3.22.1

      Function transformReturnValueForComplexTypeList

      • transformReturnValueForComplexTypeList<ReturnT>(data, builderFn): ReturnT[]

      • 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: any) => 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_odata_v2.transformReturnValueForEdmType.html b/static/api/v3/functions/sap_cloud_sdk_odata_v2.transformReturnValueForEdmType.html index 4deaec2c43..7e2efdfc4f 100644 --- a/static/api/v3/functions/sap_cloud_sdk_odata_v2.transformReturnValueForEdmType.html +++ b/static/api/v3/functions/sap_cloud_sdk_odata_v2.transformReturnValueForEdmType.html @@ -1,6 +1,6 @@ -transformReturnValueForEdmType | SAP Cloud SDK for JavaScript - v3.22.0

    Function transformReturnValueForEdmType

    • transformReturnValueForEdmType<ReturnT>(data, builderFn): ReturnT

    • Transform the payload of the OData response to edm type by using given deserialization function.

      +transformReturnValueForEdmType | SAP Cloud SDK for JavaScript - v3.22.1

      Function transformReturnValueForEdmType

      • transformReturnValueForEdmType<ReturnT>(data, builderFn): ReturnT

      • 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: any) => 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_odata_v2.transformReturnValueForEdmTypeList.html b/static/api/v3/functions/sap_cloud_sdk_odata_v2.transformReturnValueForEdmTypeList.html index 44c4ed1ed9..a69e145e90 100644 --- a/static/api/v3/functions/sap_cloud_sdk_odata_v2.transformReturnValueForEdmTypeList.html +++ b/static/api/v3/functions/sap_cloud_sdk_odata_v2.transformReturnValueForEdmTypeList.html @@ -1,6 +1,6 @@ -transformReturnValueForEdmTypeList | SAP Cloud SDK for JavaScript - v3.22.0

    Function transformReturnValueForEdmTypeList

    • transformReturnValueForEdmTypeList<ReturnT>(data, builderFn): ReturnT[]

    • Transform the payload of the OData response to edm type array by using given deserialization function.

      +transformReturnValueForEdmTypeList | SAP Cloud SDK for JavaScript - v3.22.1

      Function transformReturnValueForEdmTypeList

      • transformReturnValueForEdmTypeList<ReturnT>(data, builderFn): ReturnT[]

      • 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: any) => 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_odata_v2.transformReturnValueForEntity.html b/static/api/v3/functions/sap_cloud_sdk_odata_v2.transformReturnValueForEntity.html index fa1c46f946..883c6a75e9 100644 --- a/static/api/v3/functions/sap_cloud_sdk_odata_v2.transformReturnValueForEntity.html +++ b/static/api/v3/functions/sap_cloud_sdk_odata_v2.transformReturnValueForEntity.html @@ -1,6 +1,6 @@ -transformReturnValueForEntity | SAP Cloud SDK for JavaScript - v3.22.0

    Function transformReturnValueForEntity

    • transformReturnValueForEntity<ReturnT, DeSerializersT>(data, entityApi): ReturnT

    • Transform the payload of an OData response to an entity by using the given (de-)serializers.

      +transformReturnValueForEntity | SAP Cloud SDK for JavaScript - v3.22.1

      Function transformReturnValueForEntity

      • transformReturnValueForEntity<ReturnT, DeSerializersT>(data, entityApi): ReturnT

      • 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_odata_v2.transformReturnValueForEntityList.html b/static/api/v3/functions/sap_cloud_sdk_odata_v2.transformReturnValueForEntityList.html index 142aae5f53..67b08d03a1 100644 --- a/static/api/v3/functions/sap_cloud_sdk_odata_v2.transformReturnValueForEntityList.html +++ b/static/api/v3/functions/sap_cloud_sdk_odata_v2.transformReturnValueForEntityList.html @@ -1,6 +1,6 @@ -transformReturnValueForEntityList | SAP Cloud SDK for JavaScript - v3.22.0

    Function transformReturnValueForEntityList

    • transformReturnValueForEntityList<ReturnT, DeSerializersT>(data, entityApi): ReturnT[]

    • Transform the payload of the OData response to array of entities by using given (de-)serializers.

      +transformReturnValueForEntityList | SAP Cloud SDK for JavaScript - v3.22.1

      Function transformReturnValueForEntityList

      • transformReturnValueForEntityList<ReturnT, DeSerializersT>(data, entityApi): ReturnT[]

      • 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_odata_v2.transformReturnValueForUndefined.html b/static/api/v3/functions/sap_cloud_sdk_odata_v2.transformReturnValueForUndefined.html index be9e728f03..1c1dbd8c10 100644 --- a/static/api/v3/functions/sap_cloud_sdk_odata_v2.transformReturnValueForUndefined.html +++ b/static/api/v3/functions/sap_cloud_sdk_odata_v2.transformReturnValueForUndefined.html @@ -1,7 +1,7 @@ -transformReturnValueForUndefined | SAP Cloud SDK for JavaScript - v3.22.0

    Function transformReturnValueForUndefined

    • transformReturnValueForUndefined<ReturnT>(data, builderFn): ReturnT

    • Transform the payload of the OData response to undefined. +transformReturnValueForUndefined | SAP Cloud SDK for JavaScript - v3.22.1

      Function transformReturnValueForUndefined

      • transformReturnValueForUndefined<ReturnT>(data, builderFn): ReturnT

      • 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: any) => 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_odata_v4.all.html b/static/api/v3/functions/sap_cloud_sdk_odata_v4.all.html index ddcd7b056e..174d5a4065 100644 --- a/static/api/v3/functions/sap_cloud_sdk_odata_v4.all.html +++ b/static/api/v3/functions/sap_cloud_sdk_odata_v4.all.html @@ -1,5 +1,5 @@ -all | SAP Cloud SDK for JavaScript - v3.22.0

    Function all

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_odata_v4.any.html b/static/api/v3/functions/sap_cloud_sdk_odata_v4.any.html index db76d79c90..0fbd761534 100644 --- a/static/api/v3/functions/sap_cloud_sdk_odata_v4.any.html +++ b/static/api/v3/functions/sap_cloud_sdk_odata_v4.any.html @@ -1,5 +1,5 @@ -any | SAP Cloud SDK for JavaScript - v3.22.0

    Function any

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_odata_v4.contains.html b/static/api/v3/functions/sap_cloud_sdk_odata_v4.contains.html index 995186f27b..85be327ba5 100644 --- a/static/api/v3/functions/sap_cloud_sdk_odata_v4.contains.html +++ b/static/api/v3/functions/sap_cloud_sdk_odata_v4.contains.html @@ -1,6 +1,6 @@ -contains | SAP Cloud SDK for JavaScript - v3.22.0

    Function contains

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_odata_v4.edmToTs.html b/static/api/v3/functions/sap_cloud_sdk_odata_v4.edmToTs.html index bddaaa006d..b625381ab2 100644 --- a/static/api/v3/functions/sap_cloud_sdk_odata_v4.edmToTs.html +++ b/static/api/v3/functions/sap_cloud_sdk_odata_v4.edmToTs.html @@ -1,7 +1,7 @@ -edmToTs | SAP Cloud SDK for JavaScript - v3.22.0

    Function edmToTs

    • edmToTs(value, edmType, deSerializers): any

    • Convert a value with edm format to one with typescript format. This function is typically used when deserializing an OData response.

      +edmToTs | SAP Cloud SDK for JavaScript - v3.22.1

      Function edmToTs

      • edmToTs(value, edmType, deSerializers): any

      • 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_odata_v4.entityDeserializer.html b/static/api/v3/functions/sap_cloud_sdk_odata_v4.entityDeserializer.html index b78a135eb4..8700c7d386 100644 --- a/static/api/v3/functions/sap_cloud_sdk_odata_v4.entityDeserializer.html +++ b/static/api/v3/functions/sap_cloud_sdk_odata_v4.entityDeserializer.html @@ -1,6 +1,6 @@ -entityDeserializer | SAP Cloud SDK for JavaScript - v3.22.0

    Function entityDeserializer

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_odata_v4.filterFunction.html b/static/api/v3/functions/sap_cloud_sdk_odata_v4.filterFunction.html index 8e3b5b7c27..81610e5aef 100644 --- a/static/api/v3/functions/sap_cloud_sdk_odata_v4.filterFunction.html +++ b/static/api/v3/functions/sap_cloud_sdk_odata_v4.filterFunction.html @@ -1,2 +1,2 @@

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

    -filterFunction | SAP Cloud SDK for JavaScript - v3.22.0

    Function filterFunction

    Settings

    Member Visibility
    +filterFunction | SAP Cloud SDK for JavaScript - v3.22.1

    Function filterFunction

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_odata_v4.filterFunctions.html b/static/api/v3/functions/sap_cloud_sdk_odata_v4.filterFunctions.html index c0ba5be636..be7b4840ef 100644 --- a/static/api/v3/functions/sap_cloud_sdk_odata_v4.filterFunctions.html +++ b/static/api/v3/functions/sap_cloud_sdk_odata_v4.filterFunctions.html @@ -1,5 +1,5 @@ -filterFunctions | SAP Cloud SDK for JavaScript - v3.22.0

    Function filterFunctions

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_odata_v4.fractionalSeconds.html b/static/api/v3/functions/sap_cloud_sdk_odata_v4.fractionalSeconds.html index 51f8dd560c..bea976403a 100644 --- a/static/api/v3/functions/sap_cloud_sdk_odata_v4.fractionalSeconds.html +++ b/static/api/v3/functions/sap_cloud_sdk_odata_v4.fractionalSeconds.html @@ -1,5 +1,5 @@ -fractionalSeconds | SAP Cloud SDK for JavaScript - v3.22.0

    Function fractionalSeconds

    • fractionalSeconds<EntityT>(date): NumberFilterFunction<EntityT>

    • Build a filter function to get the fractional seconds of a date. Evaluates to decimal.

      +fractionalSeconds | SAP Cloud SDK for JavaScript - v3.22.1

      Function fractionalSeconds

      • fractionalSeconds<EntityT>(date): NumberFilterFunction<EntityT>

      • Build a filter function to get the fractional seconds of a date. Evaluates to decimal.

        Type Parameters

        Parameters

        • date: Moment | Field<EntityT, boolean, boolean>

          The date to get the fractional seconds for. This can either be a date (Moment) or a reference to a field.

        Returns NumberFilterFunction<EntityT>

        The newly created filter function.

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

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_odata_v4.hasSubsequence.html b/static/api/v3/functions/sap_cloud_sdk_odata_v4.hasSubsequence.html index 036bd3781a..7a614bf0cf 100644 --- a/static/api/v3/functions/sap_cloud_sdk_odata_v4.hasSubsequence.html +++ b/static/api/v3/functions/sap_cloud_sdk_odata_v4.hasSubsequence.html @@ -1,6 +1,6 @@ -hasSubsequence | SAP Cloud SDK for JavaScript - v3.22.0

    Function hasSubsequence

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_odata_v4.hasSubset.html b/static/api/v3/functions/sap_cloud_sdk_odata_v4.hasSubset.html index fce1e3d0fb..d91d620eff 100644 --- a/static/api/v3/functions/sap_cloud_sdk_odata_v4.hasSubset.html +++ b/static/api/v3/functions/sap_cloud_sdk_odata_v4.hasSubset.html @@ -1,6 +1,6 @@ -hasSubset | SAP Cloud SDK for JavaScript - v3.22.0

    Function hasSubset

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_odata_v4.matchesPattern.html b/static/api/v3/functions/sap_cloud_sdk_odata_v4.matchesPattern.html index ed8dbc3ad2..32f434e4ce 100644 --- a/static/api/v3/functions/sap_cloud_sdk_odata_v4.matchesPattern.html +++ b/static/api/v3/functions/sap_cloud_sdk_odata_v4.matchesPattern.html @@ -1,6 +1,6 @@ -matchesPattern | SAP Cloud SDK for JavaScript - v3.22.0

    Function matchesPattern

    • matchesPattern<EntityT>(str, regex): BooleanFilterFunction<EntityT>

    • Build a filter function to test whether a string matches a pattern. Evaluates to boolean.

      +matchesPattern | SAP Cloud SDK for JavaScript - v3.22.1

      Function matchesPattern

      • matchesPattern<EntityT>(str, regex): BooleanFilterFunction<EntityT>

      • Build a filter function to test whether a string matches a pattern. Evaluates to boolean.

        Type Parameters

        Parameters

        • str: string | Field<EntityT, boolean, boolean> | StringFilterFunction<EntityT>

          The string to get the index from. This can either be a string, a reference to a field or another filter function.

        • regex: string

          The pattern to test against. This should be a regular expression as a string.

        Returns BooleanFilterFunction<EntityT>

        The newly created filter function.

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

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_odata_v4.maxDateTime.html b/static/api/v3/functions/sap_cloud_sdk_odata_v4.maxDateTime.html index d2aa7e4a4f..2416df81ca 100644 --- a/static/api/v3/functions/sap_cloud_sdk_odata_v4.maxDateTime.html +++ b/static/api/v3/functions/sap_cloud_sdk_odata_v4.maxDateTime.html @@ -1,4 +1,4 @@ -maxDateTime | SAP Cloud SDK for JavaScript - v3.22.0

    Function maxDateTime

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_odata_v4.mergeDefaultDeSerializersWith.html b/static/api/v3/functions/sap_cloud_sdk_odata_v4.mergeDefaultDeSerializersWith.html index 105b522249..a9de9403f8 100644 --- a/static/api/v3/functions/sap_cloud_sdk_odata_v4.mergeDefaultDeSerializersWith.html +++ b/static/api/v3/functions/sap_cloud_sdk_odata_v4.mergeDefaultDeSerializersWith.html @@ -1,6 +1,6 @@ -mergeDefaultDeSerializersWith | SAP Cloud SDK for JavaScript - v3.22.0

    Function mergeDefaultDeSerializersWith

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_odata_v4.minDateTime.html b/static/api/v3/functions/sap_cloud_sdk_odata_v4.minDateTime.html index f89be2b272..93ee1a7e03 100644 --- a/static/api/v3/functions/sap_cloud_sdk_odata_v4.minDateTime.html +++ b/static/api/v3/functions/sap_cloud_sdk_odata_v4.minDateTime.html @@ -1,4 +1,4 @@ -minDateTime | SAP Cloud SDK for JavaScript - v3.22.0

    Function minDateTime

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_odata_v4.now.html b/static/api/v3/functions/sap_cloud_sdk_odata_v4.now.html index 5be1e48df1..61658af141 100644 --- a/static/api/v3/functions/sap_cloud_sdk_odata_v4.now.html +++ b/static/api/v3/functions/sap_cloud_sdk_odata_v4.now.html @@ -1,4 +1,4 @@ -now | SAP Cloud SDK for JavaScript - v3.22.0

    Function now

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_odata_v4.totalOffsetMinutes.html b/static/api/v3/functions/sap_cloud_sdk_odata_v4.totalOffsetMinutes.html index 0eaa374dc7..f2694f1963 100644 --- a/static/api/v3/functions/sap_cloud_sdk_odata_v4.totalOffsetMinutes.html +++ b/static/api/v3/functions/sap_cloud_sdk_odata_v4.totalOffsetMinutes.html @@ -1,5 +1,5 @@ -totalOffsetMinutes | SAP Cloud SDK for JavaScript - v3.22.0

    Function totalOffsetMinutes

    • totalOffsetMinutes<EntityT>(date): NumberFilterFunction<EntityT>

    • Build a filter function to get the signed number of minutes in the time zone offset. Evaluates to int.

      +totalOffsetMinutes | SAP Cloud SDK for JavaScript - v3.22.1

      Function totalOffsetMinutes

      • totalOffsetMinutes<EntityT>(date): NumberFilterFunction<EntityT>

      • Build a filter function to get the signed number of minutes in the time zone offset. Evaluates to int.

        Type Parameters

        Parameters

        • date: Moment | Field<EntityT, boolean, boolean>

          The date to get the offset minutes for. This can either be a date (Moment) or a reference to a field.

        Returns NumberFilterFunction<EntityT>

        The newly created filter function.

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

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_odata_v4.transformReturnValueForComplexType.html b/static/api/v3/functions/sap_cloud_sdk_odata_v4.transformReturnValueForComplexType.html index 0da4595ed6..51c0fdf8a7 100644 --- a/static/api/v3/functions/sap_cloud_sdk_odata_v4.transformReturnValueForComplexType.html +++ b/static/api/v3/functions/sap_cloud_sdk_odata_v4.transformReturnValueForComplexType.html @@ -1,6 +1,6 @@ -transformReturnValueForComplexType | SAP Cloud SDK for JavaScript - v3.22.0

    Function transformReturnValueForComplexType

    • transformReturnValueForComplexType<ReturnT>(data, builderFn): ReturnT

    • Transform the payload of the OData response to a complex type by using given deserialization function.

      +transformReturnValueForComplexType | SAP Cloud SDK for JavaScript - v3.22.1

      Function transformReturnValueForComplexType

      • transformReturnValueForComplexType<ReturnT>(data, builderFn): ReturnT

      • 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: any) => 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_odata_v4.transformReturnValueForComplexTypeList.html b/static/api/v3/functions/sap_cloud_sdk_odata_v4.transformReturnValueForComplexTypeList.html index 4b5b5e3e80..3460246b45 100644 --- a/static/api/v3/functions/sap_cloud_sdk_odata_v4.transformReturnValueForComplexTypeList.html +++ b/static/api/v3/functions/sap_cloud_sdk_odata_v4.transformReturnValueForComplexTypeList.html @@ -1,6 +1,6 @@ -transformReturnValueForComplexTypeList | SAP Cloud SDK for JavaScript - v3.22.0

    Function transformReturnValueForComplexTypeList

    • transformReturnValueForComplexTypeList<ReturnT>(data, builderFn): ReturnT[]

    • Transform the payload of the OData response to complex type array by using given deserialization function.

      +transformReturnValueForComplexTypeList | SAP Cloud SDK for JavaScript - v3.22.1

      Function transformReturnValueForComplexTypeList

      • transformReturnValueForComplexTypeList<ReturnT>(data, builderFn): ReturnT[]

      • 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: any) => 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_odata_v4.transformReturnValueForEdmType.html b/static/api/v3/functions/sap_cloud_sdk_odata_v4.transformReturnValueForEdmType.html index d2add0a9ef..bb3cf0a096 100644 --- a/static/api/v3/functions/sap_cloud_sdk_odata_v4.transformReturnValueForEdmType.html +++ b/static/api/v3/functions/sap_cloud_sdk_odata_v4.transformReturnValueForEdmType.html @@ -1,6 +1,6 @@ -transformReturnValueForEdmType | SAP Cloud SDK for JavaScript - v3.22.0

    Function transformReturnValueForEdmType

    • transformReturnValueForEdmType<ReturnT>(data, builderFn): ReturnT

    • Transform the payload of the OData response to edm type by using given deserialization function.

      +transformReturnValueForEdmType | SAP Cloud SDK for JavaScript - v3.22.1

      Function transformReturnValueForEdmType

      • transformReturnValueForEdmType<ReturnT>(data, builderFn): ReturnT

      • 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: any) => 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_odata_v4.transformReturnValueForEdmTypeList.html b/static/api/v3/functions/sap_cloud_sdk_odata_v4.transformReturnValueForEdmTypeList.html index 7cdfa38713..161c1235bd 100644 --- a/static/api/v3/functions/sap_cloud_sdk_odata_v4.transformReturnValueForEdmTypeList.html +++ b/static/api/v3/functions/sap_cloud_sdk_odata_v4.transformReturnValueForEdmTypeList.html @@ -1,6 +1,6 @@ -transformReturnValueForEdmTypeList | SAP Cloud SDK for JavaScript - v3.22.0

    Function transformReturnValueForEdmTypeList

    • transformReturnValueForEdmTypeList<ReturnT>(data, builderFn): ReturnT[]

    • Transform the payload of the OData response to edm type array by using given deserialization function.

      +transformReturnValueForEdmTypeList | SAP Cloud SDK for JavaScript - v3.22.1

      Function transformReturnValueForEdmTypeList

      • transformReturnValueForEdmTypeList<ReturnT>(data, builderFn): ReturnT[]

      • 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: any) => 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_odata_v4.transformReturnValueForEntity.html b/static/api/v3/functions/sap_cloud_sdk_odata_v4.transformReturnValueForEntity.html index 757810c986..4756e6ed28 100644 --- a/static/api/v3/functions/sap_cloud_sdk_odata_v4.transformReturnValueForEntity.html +++ b/static/api/v3/functions/sap_cloud_sdk_odata_v4.transformReturnValueForEntity.html @@ -1,6 +1,6 @@ -transformReturnValueForEntity | SAP Cloud SDK for JavaScript - v3.22.0

    Function transformReturnValueForEntity

    • transformReturnValueForEntity<ReturnT, DeSerializersT>(data, entityApi): ReturnT

    • Transform the payload of an OData response to an entity by using the given (de-)serializers.

      +transformReturnValueForEntity | SAP Cloud SDK for JavaScript - v3.22.1

      Function transformReturnValueForEntity

      • transformReturnValueForEntity<ReturnT, DeSerializersT>(data, entityApi): ReturnT

      • 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_odata_v4.transformReturnValueForEntityList.html b/static/api/v3/functions/sap_cloud_sdk_odata_v4.transformReturnValueForEntityList.html index ed6504026d..3ee8515269 100644 --- a/static/api/v3/functions/sap_cloud_sdk_odata_v4.transformReturnValueForEntityList.html +++ b/static/api/v3/functions/sap_cloud_sdk_odata_v4.transformReturnValueForEntityList.html @@ -1,6 +1,6 @@ -transformReturnValueForEntityList | SAP Cloud SDK for JavaScript - v3.22.0

    Function transformReturnValueForEntityList

    • transformReturnValueForEntityList<ReturnT, DeSerializersT>(data, entityApi): ReturnT[]

    • Transform the payload of the OData response to array of entities by using given (de-)serializers.

      +transformReturnValueForEntityList | SAP Cloud SDK for JavaScript - v3.22.1

      Function transformReturnValueForEntityList

      • transformReturnValueForEntityList<ReturnT, DeSerializersT>(data, entityApi): ReturnT[]

      • 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_odata_v4.transformReturnValueForUndefined.html b/static/api/v3/functions/sap_cloud_sdk_odata_v4.transformReturnValueForUndefined.html index 423b499bef..2ae1d9a60a 100644 --- a/static/api/v3/functions/sap_cloud_sdk_odata_v4.transformReturnValueForUndefined.html +++ b/static/api/v3/functions/sap_cloud_sdk_odata_v4.transformReturnValueForUndefined.html @@ -1,7 +1,7 @@ -transformReturnValueForUndefined | SAP Cloud SDK for JavaScript - v3.22.0

    Function transformReturnValueForUndefined

    • transformReturnValueForUndefined<ReturnT>(data, builderFn): ReturnT

    • Transform the payload of the OData response to undefined. +transformReturnValueForUndefined | SAP Cloud SDK for JavaScript - v3.22.1

      Function transformReturnValueForUndefined

      • transformReturnValueForUndefined<ReturnT>(data, builderFn): ReturnT

      • 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: any) => 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_openapi_generator.generate.html b/static/api/v3/functions/sap_cloud_sdk_openapi_generator.generate.html index 8529ac1aed..cc5c2526ae 100644 --- a/static/api/v3/functions/sap_cloud_sdk_openapi_generator.generate.html +++ b/static/api/v3/functions/sap_cloud_sdk_openapi_generator.generate.html @@ -1,6 +1,6 @@ -generate | SAP Cloud SDK for JavaScript - v3.22.0

    Function generate

    • generate(options): Promise<void>

    • Main entry point for the OpenAPI client generation. +generate | SAP Cloud SDK for JavaScript - v3.22.1

      Function generate

      • generate(options): Promise<void>

      • Main entry point for the OpenAPI client generation. Generates models and API files.

        Parameters

        Returns Promise<void>

        A promise to void.

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

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_resilience.circuitBreaker.html b/static/api/v3/functions/sap_cloud_sdk_resilience.circuitBreaker.html index aac52471aa..b70239ffdb 100644 --- a/static/api/v3/functions/sap_cloud_sdk_resilience.circuitBreaker.html +++ b/static/api/v3/functions/sap_cloud_sdk_resilience.circuitBreaker.html @@ -1,4 +1,4 @@ -circuitBreaker | SAP Cloud SDK for JavaScript - v3.22.0

    Function circuitBreaker

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_resilience.circuitBreakerHttp.html b/static/api/v3/functions/sap_cloud_sdk_resilience.circuitBreakerHttp.html index b8071962d0..142e80d87c 100644 --- a/static/api/v3/functions/sap_cloud_sdk_resilience.circuitBreakerHttp.html +++ b/static/api/v3/functions/sap_cloud_sdk_resilience.circuitBreakerHttp.html @@ -1,7 +1,7 @@ -circuitBreakerHttp | SAP Cloud SDK for JavaScript - v3.22.0

    Function circuitBreakerHttp

    Deprecated

    Since v3.0.1. Use {@link circuitBreaker} instead. +circuitBreakerHttp | SAP Cloud SDK for JavaScript - v3.22.1

    Function circuitBreakerHttp

    Deprecated

    Since v3.0.1. Use {@link circuitBreaker} instead. Helper method to build a circuit breaker middleware.

    Returns

    The middleware adding a circuit breaker to the function.

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_resilience.resilience.html b/static/api/v3/functions/sap_cloud_sdk_resilience.resilience.html index 7c13467122..b0ac49d46d 100644 --- a/static/api/v3/functions/sap_cloud_sdk_resilience.resilience.html +++ b/static/api/v3/functions/sap_cloud_sdk_resilience.resilience.html @@ -1,7 +1,7 @@ -resilience | SAP Cloud SDK for JavaScript - v3.22.0

    Function resilience

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_resilience.retry.html b/static/api/v3/functions/sap_cloud_sdk_resilience.retry.html index 34d8e07055..98c20d1f8b 100644 --- a/static/api/v3/functions/sap_cloud_sdk_resilience.retry.html +++ b/static/api/v3/functions/sap_cloud_sdk_resilience.retry.html @@ -1,5 +1,5 @@ -retry | SAP Cloud SDK for JavaScript - v3.22.0

    Function retry

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_resilience.timeout.html b/static/api/v3/functions/sap_cloud_sdk_resilience.timeout.html index 1dff0b89c5..b01ea4e281 100644 --- a/static/api/v3/functions/sap_cloud_sdk_resilience.timeout.html +++ b/static/api/v3/functions/sap_cloud_sdk_resilience.timeout.html @@ -1,5 +1,5 @@ -timeout | SAP Cloud SDK for JavaScript - v3.22.0

    Function timeout

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_test_util.getTestDestinationByAlias.html b/static/api/v3/functions/sap_cloud_sdk_test_util.getTestDestinationByAlias.html index 7bb72e83fa..ff4371965c 100644 --- a/static/api/v3/functions/sap_cloud_sdk_test_util.getTestDestinationByAlias.html +++ b/static/api/v3/functions/sap_cloud_sdk_test_util.getTestDestinationByAlias.html @@ -1,4 +1,4 @@ -getTestDestinationByAlias | SAP Cloud SDK for JavaScript - v3.22.0

    Function getTestDestinationByAlias

    • getTestDestinationByAlias(alias, options?): Destination

    • Loads a destination matching the provided alias stored in systems.json and credentials.json. +getTestDestinationByAlias | SAP Cloud SDK for JavaScript - v3.22.1

      Function getTestDestinationByAlias

      • getTestDestinationByAlias(alias, options?): Destination

      • 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.

        @@ -9,4 +9,4 @@
      • Optionaloptions: 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.

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_test_util.getTestDestinations.html b/static/api/v3/functions/sap_cloud_sdk_test_util.getTestDestinations.html index 0d16a9684e..833092d86a 100644 --- a/static/api/v3/functions/sap_cloud_sdk_test_util.getTestDestinations.html +++ b/static/api/v3/functions/sap_cloud_sdk_test_util.getTestDestinations.html @@ -1,4 +1,4 @@ -getTestDestinations | SAP Cloud SDK for JavaScript - v3.22.0

    Function getTestDestinations

    • getTestDestinations(options?): Destination[]

    • Loads all destinations stored in systems.json and credentials.json files.

      +getTestDestinations | SAP Cloud SDK for JavaScript - v3.22.1

      Function getTestDestinations

      • getTestDestinations(options?): Destination[]

      • 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.

        @@ -7,4 +7,4 @@

        Parameters

        Returns Destination[]

        An array of destinations.

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

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_test_util.mockAllTestDestinations.html b/static/api/v3/functions/sap_cloud_sdk_test_util.mockAllTestDestinations.html index 472807acad..f22cc98c17 100644 --- a/static/api/v3/functions/sap_cloud_sdk_test_util.mockAllTestDestinations.html +++ b/static/api/v3/functions/sap_cloud_sdk_test_util.mockAllTestDestinations.html @@ -1,5 +1,5 @@ -mockAllTestDestinations | SAP Cloud SDK for JavaScript - v3.22.0

    Function mockAllTestDestinations

    • mockAllTestDestinations(options?): void

    • Add all destinations from the systems.json and credentials.json files to the destinations environment variable.

      +mockAllTestDestinations | SAP Cloud SDK for JavaScript - v3.22.1

      Function mockAllTestDestinations

      • mockAllTestDestinations(options?): void

      • 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

        • Optionaloptions: GetTestDestinationOptions

          References to the systems.json and credentials.json files.

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

          -

        Returns void

      Settings

      Member Visibility
      +

    Returns void

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_test_util.mockTestDestination.html b/static/api/v3/functions/sap_cloud_sdk_test_util.mockTestDestination.html index 9d24f03cfb..8d352af6fa 100644 --- a/static/api/v3/functions/sap_cloud_sdk_test_util.mockTestDestination.html +++ b/static/api/v3/functions/sap_cloud_sdk_test_util.mockTestDestination.html @@ -1,6 +1,6 @@ -mockTestDestination | SAP Cloud SDK for JavaScript - v3.22.0

    Function mockTestDestination

    • mockTestDestination(name, options?): void

    • 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.22.1

      Function mockTestDestination

      • mockTestDestination(name, options?): void

      • 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.

        • Optionaloptions: GetTestDestinationOptions

          References to the systems.json and credentials.json files.

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

          -

        Returns void

      Settings

      Member Visibility
      +

    Returns void

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_test_util.setTestDestination.html b/static/api/v3/functions/sap_cloud_sdk_test_util.setTestDestination.html index 3f15d94350..fc8cd507d4 100644 --- a/static/api/v3/functions/sap_cloud_sdk_test_util.setTestDestination.html +++ b/static/api/v3/functions/sap_cloud_sdk_test_util.setTestDestination.html @@ -1,5 +1,5 @@ -setTestDestination | SAP Cloud SDK for JavaScript - v3.22.0

    Function setTestDestination

    • setTestDestination(destination): void

    • Set a given destination in the destinations environment variable.

      +setTestDestination | SAP Cloud SDK for JavaScript - v3.22.1

      Function setTestDestination

      • setTestDestination(destination): void

      • 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.

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

          -

        Returns void

      Settings

      Member Visibility
      +

    Returns void

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_test_util.unmockAllTestDestinations.html b/static/api/v3/functions/sap_cloud_sdk_test_util.unmockAllTestDestinations.html index 193785d549..e1162d776a 100644 --- a/static/api/v3/functions/sap_cloud_sdk_test_util.unmockAllTestDestinations.html +++ b/static/api/v3/functions/sap_cloud_sdk_test_util.unmockAllTestDestinations.html @@ -1,4 +1,4 @@ -unmockAllTestDestinations | SAP Cloud SDK for JavaScript - v3.22.0

    Function unmockAllTestDestinations

    • unmockAllTestDestinations(): void

    • 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.22.1

      Function unmockAllTestDestinations

      • unmockAllTestDestinations(): void

      • 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

      Settings

      Member Visibility
      +

      Returns void

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_test_util.unmockTestDestination.html b/static/api/v3/functions/sap_cloud_sdk_test_util.unmockTestDestination.html index 33760d9325..cd01a5a464 100644 --- a/static/api/v3/functions/sap_cloud_sdk_test_util.unmockTestDestination.html +++ b/static/api/v3/functions/sap_cloud_sdk_test_util.unmockTestDestination.html @@ -1,5 +1,5 @@ -unmockTestDestination | SAP Cloud SDK for JavaScript - v3.22.0

    Function unmockTestDestination

    • unmockTestDestination(name): void

    • 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.22.1

      Function unmockTestDestination

      • unmockTestDestination(name): void

      • 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.

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

          -

        Returns void

      Settings

      Member Visibility
      +

    Returns void

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.assoc.html b/static/api/v3/functions/sap_cloud_sdk_util.assoc.html index 63437f27df..d8c18a0566 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.assoc.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.assoc.html @@ -1,4 +1,4 @@ -assoc | SAP Cloud SDK for JavaScript - v3.22.0

    Function assoc

    Adds a key value pair to the given objects and returns a shallow copy. +assoc | SAP Cloud SDK for JavaScript - v3.22.1

    Function assoc

    Adds a key value pair to the given objects and returns a shallow copy. If the key is already present it will be overwritten.

    Deprecated

    Since v3.12.1. Will not be replaced.

    • assoc<T>(key, value, obj): T & {
          [key: string]: any;
      }

    • Type Parameters

      • T

      Parameters

      • key: string

        Key to be added.

        @@ -6,4 +6,4 @@
      • obj: T

        Object the key value pair is added to.

      Returns T & {
          [key: string]: any;
      }

      The object with the key value pair added.

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

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.camelCase.html b/static/api/v3/functions/sap_cloud_sdk_util.camelCase.html index 296c7cce3f..14d7c4d0eb 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.camelCase.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.camelCase.html @@ -1,5 +1,5 @@ -camelCase | SAP Cloud SDK for JavaScript - v3.22.0

    Function camelCase

    • camelCase(str): string

    • Convert a string to camelCase. This format used e.g. for properties on entity class instances.

      +camelCase | SAP Cloud SDK for JavaScript - v3.22.1

      Function camelCase

      • camelCase(str): string

      • 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.caps.html b/static/api/v3/functions/sap_cloud_sdk_util.caps.html index 02c926ad92..1b722019b9 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.caps.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.caps.html @@ -1,5 +1,5 @@ -caps | SAP Cloud SDK for JavaScript - v3.22.0

    Function caps

    • caps(oDataVersion): "V2" | "V4"

    • Returns the OData version in capital letters so V2 or V4.

      +caps | SAP Cloud SDK for JavaScript - v3.22.1

      Function caps

      • caps(oDataVersion): "V2" | "V4"

      • 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.checkUrlExists.html b/static/api/v3/functions/sap_cloud_sdk_util.checkUrlExists.html index 99c9247501..abd398ef9d 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.checkUrlExists.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.checkUrlExists.html @@ -1,5 +1,5 @@ -checkUrlExists | SAP Cloud SDK for JavaScript - v3.22.0

    Function checkUrlExists

    • checkUrlExists(url): Promise<number>

    • Checks whether a URL is existing via a head request.

      +checkUrlExists | SAP Cloud SDK for JavaScript - v3.22.1

      Function checkUrlExists

      • checkUrlExists(url): Promise<number>

      • 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.codeBlock.html b/static/api/v3/functions/sap_cloud_sdk_util.codeBlock.html index e2a5ed11c2..e1a72db332 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.codeBlock.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.codeBlock.html @@ -1,4 +1,4 @@ -codeBlock | SAP Cloud SDK for JavaScript - v3.22.0

    Function codeBlock

    • codeBlock(strings, ...args): string
    • Experimental

      This API is experimental and might change in newer versions. Use with caution. +codeBlock | SAP Cloud SDK for JavaScript - v3.22.1

      Function codeBlock

      • codeBlock(strings, ...args): string
      • 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;`
@@ -8,4 +8,4 @@
      • 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.

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.createLogger.html b/static/api/v3/functions/sap_cloud_sdk_util.createLogger.html index d49ede0970..f4b9ba1eb5 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.createLogger.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.createLogger.html @@ -1,4 +1,4 @@ -createLogger | SAP Cloud SDK for JavaScript - v3.22.0

    Function createLogger

    • createLogger(messageContext?): Logger

    • Create a logger for the given message context, if available.

      +createLogger | SAP Cloud SDK for JavaScript - v3.22.1

      Function createLogger

      • createLogger(messageContext?): Logger

      • 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. @@ -15,4 +15,4 @@

        Parameters

        • OptionalmessageContext: 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.disableExceptionLogger.html b/static/api/v3/functions/sap_cloud_sdk_util.disableExceptionLogger.html index 58487534a0..d2738cd4b7 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.disableExceptionLogger.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.disableExceptionLogger.html @@ -1,3 +1,3 @@ -disableExceptionLogger | SAP Cloud SDK for JavaScript - v3.22.0

    Function disableExceptionLogger

    • disableExceptionLogger(): void

    • Disable logging of exceptions. Enabled by default.

      +disableExceptionLogger | SAP Cloud SDK for JavaScript - v3.22.1

      Function disableExceptionLogger

      • disableExceptionLogger(): void

      • Disable logging of exceptions. Enabled by default.

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

        -

        Returns void

      Settings

      Member Visibility
      +

      Returns void

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.documentationBlock.html b/static/api/v3/functions/sap_cloud_sdk_util.documentationBlock.html index c6253ecb3b..953c8689b6 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.documentationBlock.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.documentationBlock.html @@ -1,4 +1,4 @@ -documentationBlock | SAP Cloud SDK for JavaScript - v3.22.0

    Function documentationBlock

    • documentationBlock(strings, ...args): string
    • Experimental

      This API is experimental and might change in newer versions. Use with caution. +documentationBlock | SAP Cloud SDK for JavaScript - v3.22.1

      Function documentationBlock

      • documentationBlock(strings, ...args): string
      • 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. @@ -10,4 +10,4 @@

      • 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.

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.enableExceptionLogger.html b/static/api/v3/functions/sap_cloud_sdk_util.enableExceptionLogger.html index 2bea9aaa8a..2f80e93e17 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.enableExceptionLogger.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.enableExceptionLogger.html @@ -1,3 +1,3 @@ -enableExceptionLogger | SAP Cloud SDK for JavaScript - v3.22.0

    Function enableExceptionLogger

    • enableExceptionLogger(): void

    • Enable logging of exceptions. Enabled by default.

      +enableExceptionLogger | SAP Cloud SDK for JavaScript - v3.22.1

      Function enableExceptionLogger

      • enableExceptionLogger(): void

      • Enable logging of exceptions. Enabled by default.

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

        -

        Returns void

      Settings

      Member Visibility
      +

      Returns void

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.encodeBase64.html b/static/api/v3/functions/sap_cloud_sdk_util.encodeBase64.html index 32e1a85b52..1f518d1e03 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.encodeBase64.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.encodeBase64.html @@ -1,5 +1,5 @@ -encodeBase64 | SAP Cloud SDK for JavaScript - v3.22.0

    Function encodeBase64

    • encodeBase64(str): string

    • Encode a string to a base64 encoded string.

      +encodeBase64 | SAP Cloud SDK for JavaScript - v3.22.1

      Function encodeBase64

      • encodeBase64(str): string

      • 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.equal.html b/static/api/v3/functions/sap_cloud_sdk_util.equal.html index da321b1cb6..70d6531ddd 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.equal.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.equal.html @@ -1,4 +1,4 @@ -equal | SAP Cloud SDK for JavaScript - v3.22.0

    Function equal

    • equal<T>(item1, item2): boolean

    • Checks whether the two items contain the same content. +equal | SAP Cloud SDK for JavaScript - v3.22.1

      Function equal

      • equal<T>(item1, item2): boolean

      • 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.

        @@ -6,4 +6,4 @@
      • 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.

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.equalArrays.html b/static/api/v3/functions/sap_cloud_sdk_util.equalArrays.html index 02e73258ec..6557987881 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.equalArrays.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.equalArrays.html @@ -1,6 +1,6 @@ -equalArrays | SAP Cloud SDK for JavaScript - v3.22.0

    Function equalArrays

    • equalArrays<T>(arr1, arr2): boolean

    • Checks whether the elements of two arrays are the same with the same order.

      +equalArrays | SAP Cloud SDK for JavaScript - v3.22.1

      Function equalArrays

      • equalArrays<T>(arr1, arr2): boolean

      • Checks whether the elements of two arrays are the same with the same order.

        Type Parameters

        • T

        Parameters

        • arr1: T[]

          The first array.

        • arr2: T[]

          The second array.

        Returns boolean

        A boolean, indicating both arrays have the same contents.

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

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.equalObjects.html b/static/api/v3/functions/sap_cloud_sdk_util.equalObjects.html index cd2230f9d4..694cb942ec 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.equalObjects.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.equalObjects.html @@ -1,6 +1,6 @@ -equalObjects | SAP Cloud SDK for JavaScript - v3.22.0

    Function equalObjects

    • equalObjects(obj1, obj2): boolean

    • Checks whether the keys and values of two objects are equal.

      +equalObjects | SAP Cloud SDK for JavaScript - v3.22.1

      Function equalObjects

      • equalObjects(obj1, obj2): boolean

      • 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.exclude.html b/static/api/v3/functions/sap_cloud_sdk_util.exclude.html index a2edb4b75c..36919f6e01 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.exclude.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.exclude.html @@ -1,7 +1,7 @@ -exclude | SAP Cloud SDK for JavaScript - v3.22.0

    Function exclude

    Create a shallow copy of the given object, that does not contain the given keys. +exclude | SAP Cloud SDK for JavaScript - v3.22.1

    Function exclude

    Create a shallow copy of the given object, that does not contain the given keys. Non existing keys in the source object are ignored.

    • exclude<T>(keys, obj): Partial<T>

    • 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.

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.filterDuplicates.html b/static/api/v3/functions/sap_cloud_sdk_util.filterDuplicates.html index 87c02bfd95..c7f07e7df1 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.filterDuplicates.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.filterDuplicates.html @@ -1,6 +1,6 @@ -filterDuplicates | SAP Cloud SDK for JavaScript - v3.22.0

    Function filterDuplicates

    • filterDuplicates<T>(arr, comparator?): T[]

    • Filter an array by removing duplicates and keeping the left most occurrence. By default this compares by identity.

      +filterDuplicates | SAP Cloud SDK for JavaScript - v3.22.1

      Function filterDuplicates

      • filterDuplicates<T>(arr, comparator?): T[]

      • 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.

        • Optionalcomparator: ((left: T, right: T) => 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.filterDuplicatesRight.html b/static/api/v3/functions/sap_cloud_sdk_util.filterDuplicatesRight.html index 4e1945848a..30f60d6419 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.filterDuplicatesRight.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.filterDuplicatesRight.html @@ -1,6 +1,6 @@ -filterDuplicatesRight | SAP Cloud SDK for JavaScript - v3.22.0

    Function filterDuplicatesRight

    • filterDuplicatesRight<T>(arr, comparator?): T[]

    • Filter an array by removing duplicates and keeping the right most occurrence. By default this compares by identity.

      +filterDuplicatesRight | SAP Cloud SDK for JavaScript - v3.22.1

      Function filterDuplicatesRight

      • filterDuplicatesRight<T>(arr, comparator?): T[]

      • 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.

        • Optionalcomparator: ((left: T, right: T) => 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.findProjectRoot.html b/static/api/v3/functions/sap_cloud_sdk_util.findProjectRoot.html index f36022766c..fcd69ec05a 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.findProjectRoot.html +++ b/static/api/v3/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.22.0

    Function findProjectRoot

    • findProjectRoot(path, lastPath?): string
    • Internal

      Parameters

      • path: string
      • OptionallastPath: string

      Returns string

    Settings

    Member Visibility
    +findProjectRoot | SAP Cloud SDK for JavaScript - v3.22.1

    Function findProjectRoot

    • findProjectRoot(path, lastPath?): string
    • Internal

      Parameters

      • path: string
      • OptionallastPath: string

      Returns string

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.finishAll.html b/static/api/v3/functions/sap_cloud_sdk_util.finishAll.html index 455adbdd1a..983af75dc6 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.finishAll.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.finishAll.html @@ -1,7 +1,7 @@ -finishAll | SAP Cloud SDK for JavaScript - v3.22.0

    Function finishAll

    • finishAll(promises, errorMessage?): Promise<void>

    • Await all promises and resolve if non of them failed. +finishAll | SAP Cloud SDK for JavaScript - v3.22.1

      Function finishAll

      • finishAll(promises, errorMessage?): Promise<void>

      • 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.

        • OptionalerrorMessage: 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>

      Settings

      Member Visibility
      +

    Returns Promise<void>

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.first.html b/static/api/v3/functions/sap_cloud_sdk_util.first.html index dcadffb082..2a84cfdd03 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.first.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.first.html @@ -1,5 +1,5 @@ -first | SAP Cloud SDK for JavaScript - v3.22.0

    Function first

    • first<T>(arr): T | undefined

    • Get the first item from an array. Returns undefined, if the array is empty.

      +first | SAP Cloud SDK for JavaScript - v3.22.1

      Function first

      • first<T>(arr): T | undefined

      • Get the first item from an array. Returns undefined, if the array is empty.

        Type Parameters

        • T

        Parameters

        • arr: T[]

          Array to get the first item of.

        Returns T | undefined

        Fist item of the array or undefined, if the array was empty.

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

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.flat.html b/static/api/v3/functions/sap_cloud_sdk_util.flat.html index e945946242..520caf0379 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.flat.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.flat.html @@ -1,5 +1,5 @@ -flat | SAP Cloud SDK for JavaScript - v3.22.0

    Function flat

    • flat<T>(arr): T[]

    • Flatten a two dimensional array into a one dimensional array.

      +flat | SAP Cloud SDK for JavaScript - v3.22.1

      Function flat

      • flat<T>(arr): T[]

      • Flatten a two dimensional array into a one dimensional array.

        Type Parameters

        • T

        Parameters

        • arr: T[][]

          The array to be flattened.

        Returns T[]

        A one dimensional array.

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

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.flatten.html b/static/api/v3/functions/sap_cloud_sdk_util.flatten.html index 439d9907ee..3323cff6eb 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.flatten.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.flatten.html @@ -1,6 +1,6 @@ -flatten | SAP Cloud SDK for JavaScript - v3.22.0

    Function flatten

    Flattens a array: [1,[2,[3,4]],5] will become [1,2,3,4,5]. +flatten | SAP Cloud SDK for JavaScript - v3.22.1

    Function flatten

    Flattens a array: [1,[2,[3,4]],5] will become [1,2,3,4,5]. Non primitive values are copied by reference.

    • flatten(input): any[]

    • Parameters

      • input: any[]

        Array to be flattened.

      Returns any[]

      The flattened array.

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

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.formatJson.html b/static/api/v3/functions/sap_cloud_sdk_util.formatJson.html index 8eb8c3d476..2c3b4faa9d 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.formatJson.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.formatJson.html @@ -1,5 +1,5 @@ -formatJson | SAP Cloud SDK for JavaScript - v3.22.0

    Function formatJson

    • formatJson(json): string

    • Convert a JSON object to a string using formatting in line with the prettier with indentation and new line at the end.

      +formatJson | SAP Cloud SDK for JavaScript - v3.22.1

      Function formatJson

      • formatJson(json): string

      • 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.getGlobalLogFormat.html b/static/api/v3/functions/sap_cloud_sdk_util.getGlobalLogFormat.html index 2d38d5746e..bdcbae9b37 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.getGlobalLogFormat.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.getGlobalLogFormat.html @@ -1,4 +1,4 @@ -getGlobalLogFormat | SAP Cloud SDK for JavaScript - v3.22.0

    Function getGlobalLogFormat

    • getGlobalLogFormat(): Format | undefined

    • Get the global log format of the container.

      +getGlobalLogFormat | SAP Cloud SDK for JavaScript - v3.22.1

      Function getGlobalLogFormat

      • getGlobalLogFormat(): Format | undefined

      • 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.getGlobalLogLevel.html b/static/api/v3/functions/sap_cloud_sdk_util.getGlobalLogLevel.html index 5456118e57..71f352d81c 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.getGlobalLogLevel.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.getGlobalLogLevel.html @@ -1,4 +1,4 @@ -getGlobalLogLevel | SAP Cloud SDK for JavaScript - v3.22.0

    Function getGlobalLogLevel

    • getGlobalLogLevel(): string | undefined

    • Get the global log level of the container.

      +getGlobalLogLevel | SAP Cloud SDK for JavaScript - v3.22.1

      Function getGlobalLogLevel

      • getGlobalLogLevel(): string | undefined

      • 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.getLogger.html b/static/api/v3/functions/sap_cloud_sdk_util.getLogger.html index 708c06ecc4..7c8f608a7b 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.getLogger.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.getLogger.html @@ -1,5 +1,5 @@ -getLogger | SAP Cloud SDK for JavaScript - v3.22.0

    Function getLogger

    • getLogger(messageContext?): Logger | undefined

    • Get logger for a given message context, if available.

      +getLogger | SAP Cloud SDK for JavaScript - v3.22.1

      Function getLogger

      • getLogger(messageContext?): Logger | undefined

      • Get logger for a given message context, if available.

        Parameters

        • OptionalmessageContext: 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.getMessageOrStack.html b/static/api/v3/functions/sap_cloud_sdk_util.getMessageOrStack.html index 99153aa72a..a658d4cb03 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.getMessageOrStack.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.getMessageOrStack.html @@ -1,5 +1,5 @@ -getMessageOrStack | SAP Cloud SDK for JavaScript - v3.22.0

    Function getMessageOrStack

    • getMessageOrStack(info): string
    • Internal

      Gets the stack of the given error if available, otherwise the message.

      +getMessageOrStack | SAP Cloud SDK for JavaScript - v3.22.1

      Function getMessageOrStack

      • getMessageOrStack(info): string
      • 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.identity.html b/static/api/v3/functions/sap_cloud_sdk_util.identity.html index 4bf079466b..0f063ffcc7 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.identity.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.identity.html @@ -1,5 +1,5 @@ -identity | SAP Cloud SDK for JavaScript - v3.22.0

    Function identity

    • identity<T>(value): T

    • Identity function.

      +identity | SAP Cloud SDK for JavaScript - v3.22.1

      Function identity

      • identity<T>(value): T

      • 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.isErrorWithCause.html b/static/api/v3/functions/sap_cloud_sdk_util.isErrorWithCause.html index f5d44fb866..2717715aba 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.isErrorWithCause.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.isErrorWithCause.html @@ -1,5 +1,5 @@ -isErrorWithCause | SAP Cloud SDK for JavaScript - v3.22.0

    Function isErrorWithCause

    • isErrorWithCause(err): err is ErrorWithCause

    • Type guard to check whether an error is of type ErrorWithCause.

      +isErrorWithCause | SAP Cloud SDK for JavaScript - v3.22.1

      Function isErrorWithCause

      • isErrorWithCause(err): err is ErrorWithCause

      • Type guard to check whether an error is of type ErrorWithCause.

        Parameters

        • err: Error

          An error.

        Returns err is ErrorWithCause

        Whether the given error is of type ErrorWithCause.

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

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.isNullish.html b/static/api/v3/functions/sap_cloud_sdk_util.isNullish.html index 4dc41587a7..3ebbd56016 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.isNullish.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.isNullish.html @@ -1,5 +1,5 @@ -isNullish | SAP Cloud SDK for JavaScript - v3.22.0

    Function isNullish

    • isNullish(val): val is undefined | null

    • Checks whether a value is either null or undefined.

      +isNullish | SAP Cloud SDK for JavaScript - v3.22.1

      Function isNullish

      • isNullish(val): val is undefined | null

      • 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.kebabCase.html b/static/api/v3/functions/sap_cloud_sdk_util.kebabCase.html index cd91b2919e..615bf60019 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.kebabCase.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.kebabCase.html @@ -1,5 +1,5 @@ -kebabCase | SAP Cloud SDK for JavaScript - v3.22.0

    Function kebabCase

    • kebabCase(str): string

    • Convert a string to kebab case. This format is used e.g. for file names.

      +kebabCase | SAP Cloud SDK for JavaScript - v3.22.1

      Function kebabCase

      • kebabCase(str): string

      • 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.last.html b/static/api/v3/functions/sap_cloud_sdk_util.last.html index 9dc7f46909..2e2d9ead37 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.last.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.last.html @@ -1,5 +1,5 @@ -last | SAP Cloud SDK for JavaScript - v3.22.0

    Function last

    • last<T>(arr): T | undefined

    • Get the last item from an array. Returns undefined, if the array is empty.

      +last | SAP Cloud SDK for JavaScript - v3.22.1

      Function last

      • last<T>(arr): T | undefined

      • Get the last item from an array. Returns undefined, if the array is empty.

        Type Parameters

        • T

        Parameters

        • arr: T[]

          Array to get the last item of.

        Returns T | undefined

        Last item of the array or undefined, if the array was empty.

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

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.mergeIgnoreCase.html b/static/api/v3/functions/sap_cloud_sdk_util.mergeIgnoreCase.html index 602259b452..aac41c7c4b 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.mergeIgnoreCase.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.mergeIgnoreCase.html @@ -1,8 +1,8 @@ -mergeIgnoreCase | SAP Cloud SDK for JavaScript - v3.22.0

    Function mergeIgnoreCase

    • mergeIgnoreCase<LeftT, RightT>(left?, right?): Record<string, any>

    • 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.

      +mergeIgnoreCase | SAP Cloud SDK for JavaScript - v3.22.1

      Function mergeIgnoreCase

      • mergeIgnoreCase<LeftT, RightT>(left?, right?): Record<string, any>

      • 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

        • Optionalleft: LeftT

          Object to merge.

        • Optionalright: 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.mergeLeftIgnoreCase.html b/static/api/v3/functions/sap_cloud_sdk_util.mergeLeftIgnoreCase.html index c832560bde..5f4549a2ac 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.mergeLeftIgnoreCase.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.mergeLeftIgnoreCase.html @@ -1,8 +1,8 @@ -mergeLeftIgnoreCase | SAP Cloud SDK for JavaScript - v3.22.0

    Function mergeLeftIgnoreCase

    • mergeLeftIgnoreCase<LeftT, RightT>(left?, right?): Record<string, any>

    • 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.

      +mergeLeftIgnoreCase | SAP Cloud SDK for JavaScript - v3.22.1

      Function mergeLeftIgnoreCase

      • mergeLeftIgnoreCase<LeftT, RightT>(left?, right?): Record<string, any>

      • 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

        • Optionalleft: LeftT

          Object to merge into. They keys of this object will be present in the returned object.

        • Optionalright: 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.muteLoggers.html b/static/api/v3/functions/sap_cloud_sdk_util.muteLoggers.html index bbf6247b52..c79d36e23e 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.muteLoggers.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.muteLoggers.html @@ -1,3 +1,3 @@ -muteLoggers | SAP Cloud SDK for JavaScript - v3.22.0

    Function muteLoggers

    • muteLoggers(): void

    • 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.22.1

      Function muteLoggers

      • muteLoggers(): void

      • 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

      Settings

      Member Visibility
      +

      Returns void

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.partition.html b/static/api/v3/functions/sap_cloud_sdk_util.partition.html index e466ce7cef..762c8acba4 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.partition.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.partition.html @@ -1,6 +1,6 @@ -partition | SAP Cloud SDK for JavaScript - v3.22.0

    Function partition

    • partition<T>(arr, condition): [T[], T[]]

    • Split an array into two based on a condition.

      +partition | SAP Cloud SDK for JavaScript - v3.22.1

      Function partition

      • partition<T>(arr, condition): [T[], T[]]

      • Split an array into two based on a condition.

        Type Parameters

        • T

        Parameters

        • arr: T[]

          Array to partition.

        • condition: ((item: T) => 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.pascalCase.html b/static/api/v3/functions/sap_cloud_sdk_util.pascalCase.html index 2a706d98a9..ff9f5702aa 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.pascalCase.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.pascalCase.html @@ -1,5 +1,5 @@ -pascalCase | SAP Cloud SDK for JavaScript - v3.22.0

    Function pascalCase

    • pascalCase(str): string

    • Convert a string to pascal case. This format is used e.g. for types.

      +pascalCase | SAP Cloud SDK for JavaScript - v3.22.1

      Function pascalCase

      • pascalCase(str): string

      • 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.pick.html b/static/api/v3/functions/sap_cloud_sdk_util.pick.html index 57b18ff21c..52e801506f 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.pick.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.pick.html @@ -1,7 +1,7 @@ -pick | SAP Cloud SDK for JavaScript - v3.22.0

    Function pick

    Create a shallow copy of the given object, that contains the given keys. +pick | SAP Cloud SDK for JavaScript - v3.22.1

    Function pick

    Create a shallow copy of the given object, that contains the given keys. Non existing keys in the source object are ignored.

    • pick<T>(keys, obj): Partial<T>

    • 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.

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.pickIgnoreCase.html b/static/api/v3/functions/sap_cloud_sdk_util.pickIgnoreCase.html index 4feb63c365..cf387ac617 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.pickIgnoreCase.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.pickIgnoreCase.html @@ -1,4 +1,4 @@ -pickIgnoreCase | SAP Cloud SDK for JavaScript - v3.22.0

    Function pickIgnoreCase

    • pickIgnoreCase<T>(obj?, ...keys): Partial<Pick<T, typeof keys[number]>>

    • Create a shallow copy of the given object, that contains the given keys, independent of casing. +pickIgnoreCase | SAP Cloud SDK for JavaScript - v3.22.1

      Function pickIgnoreCase

      • pickIgnoreCase<T>(obj?, ...keys): Partial<Pick<T, typeof keys[number]>>

      • 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

        • Optionalobj: T

          Object to pick the given key from.

        • Rest...keys: string[]

          Keys of the pair to be picked.

          @@ -6,4 +6,4 @@
        • 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.pickNonNullish.html b/static/api/v3/functions/sap_cloud_sdk_util.pickNonNullish.html index 26a59aded4..4d4156cb96 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.pickNonNullish.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.pickNonNullish.html @@ -1,7 +1,7 @@ -pickNonNullish | SAP Cloud SDK for JavaScript - v3.22.0

    Function pickNonNullish

    • pickNonNullish<T>(obj?): Partial<T>

    • Create a shallow copy of the given object, that contains all entries with non-nullish values.

      +pickNonNullish | SAP Cloud SDK for JavaScript - v3.22.1

      Function pickNonNullish

      • pickNonNullish<T>(obj?): Partial<T>

      • Create a shallow copy of the given object, that contains all entries with non-nullish values.

        Type Parameters

        • T extends Record<string, any>

        Parameters

        • Optionalobj: 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.pickValueIgnoreCase.html b/static/api/v3/functions/sap_cloud_sdk_util.pickValueIgnoreCase.html index 2ebcda265c..0d1f4c6d7c 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.pickValueIgnoreCase.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.pickValueIgnoreCase.html @@ -1,6 +1,6 @@ -pickValueIgnoreCase | SAP Cloud SDK for JavaScript - v3.22.0

    Function pickValueIgnoreCase

    • pickValueIgnoreCase<T>(obj, key): any | undefined

    • Returns the value of an object based on the given key, independent of casing.

      +pickValueIgnoreCase | SAP Cloud SDK for JavaScript - v3.22.1

      Function pickValueIgnoreCase

      • pickValueIgnoreCase<T>(obj, key): any | undefined

      • 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.propertyExists.html b/static/api/v3/functions/sap_cloud_sdk_util.propertyExists.html index 3f3a18f120..9b9b8e8f2b 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.propertyExists.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.propertyExists.html @@ -1,6 +1,6 @@ -propertyExists | SAP Cloud SDK for JavaScript - v3.22.0

    Function propertyExists

    • propertyExists(obj, ...properties): boolean

    • Checks if a chain of properties exists on the given object.

      +propertyExists | SAP Cloud SDK for JavaScript - v3.22.1

      Function propertyExists

      • propertyExists(obj, ...properties): boolean

      • 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.readJSON.html b/static/api/v3/functions/sap_cloud_sdk_util.readJSON.html index d01ac54b8a..0d5aa8a47c 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.readJSON.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.readJSON.html @@ -1,5 +1,5 @@ -readJSON | SAP Cloud SDK for JavaScript - v3.22.0

    Function readJSON

    • readJSON(path): {
          [key: string]: any;
      }

    • Read a JSON file from the file system.

      +readJSON | SAP Cloud SDK for JavaScript - v3.22.1

      Function readJSON

      • readJSON(path): {
            [key: string]: any;
        }

      • Read a JSON file from the file system.

        Parameters

        • path: PathLike

          The path to the JSON file.

        Returns {
            [key: string]: any;
        }

        An object parsed from the JSON file.

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

        -
        • [key: string]: any

      Settings

      Member Visibility
      +
      • [key: string]: any

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.removeFileExtension.html b/static/api/v3/functions/sap_cloud_sdk_util.removeFileExtension.html index 62d4cd03c7..facf2751cd 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.removeFileExtension.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.removeFileExtension.html @@ -1,5 +1,5 @@ -removeFileExtension | SAP Cloud SDK for JavaScript - v3.22.0

    Function removeFileExtension

    • removeFileExtension(fileName): string

    • Remove file extension from a string, e.g. remove 'test.jpg' would return 'test'.

      +removeFileExtension | SAP Cloud SDK for JavaScript - v3.22.1

      Function removeFileExtension

      • removeFileExtension(fileName): string

      • 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.removeLeadingSlashes.html b/static/api/v3/functions/sap_cloud_sdk_util.removeLeadingSlashes.html index 0d34995323..cead9286cf 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.removeLeadingSlashes.html +++ b/static/api/v3/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.22.0

    Function removeLeadingSlashes

    • removeLeadingSlashes(path): string
    • Internal

      Parameters

      • path: string

      Returns string

    Settings

    Member Visibility
    +removeLeadingSlashes | SAP Cloud SDK for JavaScript - v3.22.1

    Function removeLeadingSlashes

    • removeLeadingSlashes(path): string
    • Internal

      Parameters

      • path: string

      Returns string

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.removeSlashes.html b/static/api/v3/functions/sap_cloud_sdk_util.removeSlashes.html index ffbc4a0f40..cbb130159f 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.removeSlashes.html +++ b/static/api/v3/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.22.0

    Function removeSlashes

    • removeSlashes(path): string
    • Internal

      Parameters

      • path: string

      Returns string

    Settings

    Member Visibility
    +removeSlashes | SAP Cloud SDK for JavaScript - v3.22.1

    Function removeSlashes

    • removeSlashes(path): string
    • Internal

      Parameters

      • path: string

      Returns string

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.removeTrailingSlashes.html b/static/api/v3/functions/sap_cloud_sdk_util.removeTrailingSlashes.html index ed0082e768..2d3cb2a62e 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.removeTrailingSlashes.html +++ b/static/api/v3/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.22.0

    Function removeTrailingSlashes

    • removeTrailingSlashes(path): string
    • Internal

      Parameters

      • path: string

      Returns string

    Settings

    Member Visibility
    +removeTrailingSlashes | SAP Cloud SDK for JavaScript - v3.22.1

    Function removeTrailingSlashes

    • removeTrailingSlashes(path): string
    • Internal

      Parameters

      • path: string

      Returns string

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.renameKeys.html b/static/api/v3/functions/sap_cloud_sdk_util.renameKeys.html index ebcb19a858..5662db94c4 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.renameKeys.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.renameKeys.html @@ -1,8 +1,8 @@ -renameKeys | SAP Cloud SDK for JavaScript - v3.22.0

    Function renameKeys

    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.22.1

    Function renameKeys

    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".

    • renameKeys(keyMapping, obj): Record<string, any>

    • 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.

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.resetCustomLogFormats.html b/static/api/v3/functions/sap_cloud_sdk_util.resetCustomLogFormats.html index 44bd7a3750..ec010373d0 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.resetCustomLogFormats.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.resetCustomLogFormats.html @@ -1,3 +1,3 @@ -resetCustomLogFormats | SAP Cloud SDK for JavaScript - v3.22.0

    Function resetCustomLogFormats

    • resetCustomLogFormats(): void

    • Reset all the custom log formats for loggers and message context.

      +resetCustomLogFormats | SAP Cloud SDK for JavaScript - v3.22.1

      Function resetCustomLogFormats

      • resetCustomLogFormats(): void

      • 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

      Settings

      Member Visibility
      +

      Returns void

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.resetCustomLogLevels.html b/static/api/v3/functions/sap_cloud_sdk_util.resetCustomLogLevels.html index f177db6dca..9cd126114b 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.resetCustomLogLevels.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.resetCustomLogLevels.html @@ -1,3 +1,3 @@ -resetCustomLogLevels | SAP Cloud SDK for JavaScript - v3.22.0

    Function resetCustomLogLevels

    • resetCustomLogLevels(): void

    • Reset all the custom log levels for loggers and message context.

      +resetCustomLogLevels | SAP Cloud SDK for JavaScript - v3.22.1

      Function resetCustomLogLevels

      • resetCustomLogLevels(): void

      • 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

      Settings

      Member Visibility
      +

      Returns void

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.sanitizeRecord.html b/static/api/v3/functions/sap_cloud_sdk_util.sanitizeRecord.html index a37bcc053b..ba5928cde6 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.sanitizeRecord.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.sanitizeRecord.html @@ -1,8 +1,8 @@ -sanitizeRecord | SAP Cloud SDK for JavaScript - v3.22.0

    Function sanitizeRecord

    • sanitizeRecord<T>(input, replacementString?, sensitiveKeys?): Record<string, T>

    • Potentially sensitive keys will be matched case-insensitive and as substrings. +sanitizeRecord | SAP Cloud SDK for JavaScript - v3.22.1

      Function sanitizeRecord

      • sanitizeRecord<T>(input, replacementString?, sensitiveKeys?): Record<string, T>

      • 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.

        • OptionalreplacementString: string

          The placeholder string.

        • OptionalsensitiveKeys: 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.setGlobalLogFormat.html b/static/api/v3/functions/sap_cloud_sdk_util.setGlobalLogFormat.html index bfaa454fb1..8850b27f16 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.setGlobalLogFormat.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.setGlobalLogFormat.html @@ -1,5 +1,5 @@ -setGlobalLogFormat | SAP Cloud SDK for JavaScript - v3.22.0

    Function setGlobalLogFormat

    • setGlobalLogFormat(format): void

    • Change the global log format of the container which will set default format for all active loggers. +setGlobalLogFormat | SAP Cloud SDK for JavaScript - v3.22.1

      Function setGlobalLogFormat

      • setGlobalLogFormat(format): void

      • 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.

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

          -

        Returns void

      Settings

      Member Visibility
      +

    Returns void

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.setGlobalLogLevel.html b/static/api/v3/functions/sap_cloud_sdk_util.setGlobalLogLevel.html index 5e8767b760..1da86302a0 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.setGlobalLogLevel.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.setGlobalLogLevel.html @@ -1,5 +1,5 @@ -setGlobalLogLevel | SAP Cloud SDK for JavaScript - v3.22.0

    Function setGlobalLogLevel

    • setGlobalLogLevel(level): void

    • Change the global log level of the container which will set default level for all active loggers. +setGlobalLogLevel | SAP Cloud SDK for JavaScript - v3.22.1

      Function setGlobalLogLevel

      • setGlobalLogLevel(level): void

      • 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.

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

          -

        Returns void

      Settings

      Member Visibility
      +

    Returns void

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.setGlobalTransports.html b/static/api/v3/functions/sap_cloud_sdk_util.setGlobalTransports.html index c7ca53a2dd..387642c20f 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.setGlobalTransports.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.setGlobalTransports.html @@ -1,5 +1,5 @@ -setGlobalTransports | SAP Cloud SDK for JavaScript - v3.22.0

    Function setGlobalTransports

    • setGlobalTransports(customTransports): void

    • Change the global transport of the container which will set default transport for all active loggers. +setGlobalTransports | SAP Cloud SDK for JavaScript - v3.22.1

      Function setGlobalTransports

      • setGlobalTransports(customTransports): void

      • 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.

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

          -

        Returns void

      Settings

      Member Visibility
      +

    Returns void

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.setLogFormat.html b/static/api/v3/functions/sap_cloud_sdk_util.setLogFormat.html index 3912eed17a..5deb007159 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.setLogFormat.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.setLogFormat.html @@ -1,6 +1,6 @@ -setLogFormat | SAP Cloud SDK for JavaScript - v3.22.0

    Function setLogFormat

    • setLogFormat(format, messageContextOrLogger?): void

    • Change the log format of a logger based on its message context. +setLogFormat | SAP Cloud SDK for JavaScript - v3.22.1

      Function setLogFormat

      • setLogFormat(format, messageContextOrLogger?): void

      • 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.

        • OptionalmessageContextOrLogger: 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

      Settings

      Member Visibility
      +

    Returns void

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.setLogLevel.html b/static/api/v3/functions/sap_cloud_sdk_util.setLogLevel.html index 97e8a77479..0226e93922 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.setLogLevel.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.setLogLevel.html @@ -1,6 +1,6 @@ -setLogLevel | SAP Cloud SDK for JavaScript - v3.22.0

    Function setLogLevel

    • setLogLevel(level, messageContextOrLogger?): void

    • Change the log level of a logger based on its message context. +setLogLevel | SAP Cloud SDK for JavaScript - v3.22.1

      Function setLogLevel

      • setLogLevel(level, messageContextOrLogger?): void

      • 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.

        • OptionalmessageContextOrLogger: 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

      Settings

      Member Visibility
      +

    Returns void

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.splitInChunks.html b/static/api/v3/functions/sap_cloud_sdk_util.splitInChunks.html index 4eff1f736f..6ea5d79c2b 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.splitInChunks.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.splitInChunks.html @@ -1,6 +1,6 @@ -splitInChunks | SAP Cloud SDK for JavaScript - v3.22.0

    Function splitInChunks

    • splitInChunks<T>(arr, chunkSize): T[][]

    • Split the given array in chunks.

      +splitInChunks | SAP Cloud SDK for JavaScript - v3.22.1

      Function splitInChunks

      • splitInChunks<T>(arr, chunkSize): T[][]

      • Split the given array in chunks.

        Type Parameters

        • T

        Parameters

        • arr: T[]

          Array to be split into chunks.

        • chunkSize: number

          Size of the chunks.

        Returns T[][]

        Two dimensional array with arrays of length chunkSize. The last subarray could be shorter.

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

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.titleFormat.html b/static/api/v3/functions/sap_cloud_sdk_util.titleFormat.html index 25dfea89ec..285a2084e9 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.titleFormat.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.titleFormat.html @@ -1,5 +1,5 @@ -titleFormat | SAP Cloud SDK for JavaScript - v3.22.0

    Function titleFormat

    • titleFormat(str): string

    • Convert a string to a human readable format, e.g. it transforms to_BusinessPartner to To Business Partner.

      +titleFormat | SAP Cloud SDK for JavaScript - v3.22.1

      Function titleFormat

      • titleFormat(str): string

      • 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.toSanitizedObject.html b/static/api/v3/functions/sap_cloud_sdk_util.toSanitizedObject.html index 773a45a928..680919bbd0 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.toSanitizedObject.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.toSanitizedObject.html @@ -1,8 +1,8 @@ -toSanitizedObject | SAP Cloud SDK for JavaScript - v3.22.0

    Function toSanitizedObject

    • toSanitizedObject(key, value): Record<string, any>

    • Create an object based on the given key and value if neither key nor value are nullish.

      +toSanitizedObject | SAP Cloud SDK for JavaScript - v3.22.1

      Function toSanitizedObject

      • toSanitizedObject(key, value): Record<string, any>

      • 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.transformVariadicArgumentToArray.html b/static/api/v3/functions/sap_cloud_sdk_util.transformVariadicArgumentToArray.html index 5b73964017..2afbcdbcf0 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.transformVariadicArgumentToArray.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.transformVariadicArgumentToArray.html @@ -1,4 +1,4 @@ -transformVariadicArgumentToArray | SAP Cloud SDK for JavaScript - v3.22.0

    Function transformVariadicArgumentToArray

    • transformVariadicArgumentToArray<T>(firstOrArray, rest): T[]

    • We want to provide methods which accept a variable single number of elements and arrays. +transformVariadicArgumentToArray | SAP Cloud SDK for JavaScript - v3.22.1

      Function transformVariadicArgumentToArray

      • transformVariadicArgumentToArray<T>(firstOrArray, rest): T[]

      • 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
        }
        @@ -8,4 +8,4 @@
      • 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.

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.trim.html b/static/api/v3/functions/sap_cloud_sdk_util.trim.html index c837c39bb2..ea79748ae8 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.trim.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.trim.html @@ -1,5 +1,5 @@ -trim | SAP Cloud SDK for JavaScript - v3.22.0

    Function trim

    • trim(string): string

    • Remove whitespace from the left and right side of a string.

      +trim | SAP Cloud SDK for JavaScript - v3.22.1

      Function trim

      • trim(string): string

      • 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.trimLeft.html b/static/api/v3/functions/sap_cloud_sdk_util.trimLeft.html index a33d79d195..5a6cb3bf71 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.trimLeft.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.trimLeft.html @@ -1,5 +1,5 @@ -trimLeft | SAP Cloud SDK for JavaScript - v3.22.0

    Function trimLeft

    • trimLeft(string): string

    • Remove whitespace from the left side of a string.

      +trimLeft | SAP Cloud SDK for JavaScript - v3.22.1

      Function trimLeft

      • trimLeft(string): string

      • 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.trimRight.html b/static/api/v3/functions/sap_cloud_sdk_util.trimRight.html index a3a03386d3..38c139fb3e 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.trimRight.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.trimRight.html @@ -1,5 +1,5 @@ -trimRight | SAP Cloud SDK for JavaScript - v3.22.0

    Function trimRight

    • trimRight(string): string

    • Remove whitespace from the right side of a string.

      +trimRight | SAP Cloud SDK for JavaScript - v3.22.1

      Function trimRight

      • trimRight(string): string

      • 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.unique.html b/static/api/v3/functions/sap_cloud_sdk_util.unique.html index d8a5e38740..7204fbba4d 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.unique.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.unique.html @@ -1,5 +1,5 @@ -unique | SAP Cloud SDK for JavaScript - v3.22.0

    Function unique

    • unique<T>(arr): T[]

    • Remove all duplicates from an array.

      +unique | SAP Cloud SDK for JavaScript - v3.22.1

      Function unique

      • unique<T>(arr): T[]

      • Remove all duplicates from an array.

        Type Parameters

        • T

        Parameters

        • arr: T[]

          Array that might contain duplicates.

        Returns T[]

        Array of unique items.

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

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.unmuteLoggers.html b/static/api/v3/functions/sap_cloud_sdk_util.unmuteLoggers.html index 1aabd6d2bd..83ce26a0f6 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.unmuteLoggers.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.unmuteLoggers.html @@ -1,3 +1,3 @@ -unmuteLoggers | SAP Cloud SDK for JavaScript - v3.22.0

    Function unmuteLoggers

    • unmuteLoggers(): void

    • 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.22.1

      Function unmuteLoggers

      • unmuteLoggers(): void

      • 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

      Settings

      Member Visibility
      +

      Returns void

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.upperCaseSnakeCase.html b/static/api/v3/functions/sap_cloud_sdk_util.upperCaseSnakeCase.html index 069ae75ad4..7c73fe6522 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.upperCaseSnakeCase.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.upperCaseSnakeCase.html @@ -1,5 +1,5 @@ -upperCaseSnakeCase | SAP Cloud SDK for JavaScript - v3.22.0

    Function upperCaseSnakeCase

    • upperCaseSnakeCase(str): string

    • Convert a string to the uppercase snake case. This format is used e.g. for static properties on entity classes.

      +upperCaseSnakeCase | SAP Cloud SDK for JavaScript - v3.22.1

      Function upperCaseSnakeCase

      • upperCaseSnakeCase(str): string

      • 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.

        -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/functions/sap_cloud_sdk_util.zip.html b/static/api/v3/functions/sap_cloud_sdk_util.zip.html index c29a0fd211..5fa2ad8797 100644 --- a/static/api/v3/functions/sap_cloud_sdk_util.zip.html +++ b/static/api/v3/functions/sap_cloud_sdk_util.zip.html @@ -1,4 +1,4 @@ -zip | SAP Cloud SDK for JavaScript - v3.22.0

    Function zip

    • zip<T>(left, right): T[]

    • Merge two arrays by alternately adding inserting values from both arrays, starting from the left.

      +zip | SAP Cloud SDK for JavaScript - v3.22.1

      Function zip

      • zip<T>(left, right): T[]

      • 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.

        @@ -6,4 +6,4 @@

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

        -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/hierarchy.html b/static/api/v3/hierarchy.html index ef15632cf1..8c46398071 100644 --- a/static/api/v3/hierarchy.html +++ b/static/api/v3/hierarchy.html @@ -1,2 +1,2 @@

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

    -SAP Cloud SDK for JavaScript - v3.22.0

    SAP Cloud SDK for JavaScript - v3.22.0

    Class Hierarchy

    Settings

    Member Visibility
    +SAP Cloud SDK for JavaScript - v3.22.1

    SAP Cloud SDK for JavaScript - v3.22.1

    Class Hierarchy

    Settings

    Member Visibility
    diff --git a/static/api/v3/index.html b/static/api/v3/index.html index e8f9f39c24..9797cde62c 100644 --- a/static/api/v3/index.html +++ b/static/api/v3/index.html @@ -1,4 +1,4 @@ -SAP Cloud SDK for JavaScript - v3.22.0

    SAP Cloud SDK for JavaScript - v3.22.0

    Version: 3.22.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.

    +SAP Cloud SDK for JavaScript - v3.22.1

    SAP Cloud SDK for JavaScript - v3.22.1

    Version: 3.22.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.

    Links

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

    -

    Settings

    Member Visibility

    On This Page

    Version: 3.22.0Links
    +

    Settings

    Member Visibility

    On This Page

    Version: 3.22.1Links
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_connectivity.AllDestinations.html b/static/api/v3/interfaces/sap_cloud_sdk_connectivity.AllDestinations.html index 230ed9b4d3..b84ba20bf4 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_connectivity.AllDestinations.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_connectivity.AllDestinations.html @@ -1,8 +1,8 @@ -AllDestinations | SAP Cloud SDK for JavaScript - v3.22.0

    Interface AllDestinations

    Collection of all destinations from the provider and subscriber account. +AllDestinations | SAP Cloud SDK for JavaScript - v3.22.1

    Interface AllDestinations

    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

    provider subscriber

    Properties

    provider

    provider: DestinationsByType

    Collection of all destinations from the provider account.

    subscriber

    subscriber: DestinationsByType

    Collection of all destinations from the subscriber account.

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

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_connectivity.BasicProxyConfiguration.html b/static/api/v3/interfaces/sap_cloud_sdk_connectivity.BasicProxyConfiguration.html index c96cc70857..824797640f 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_connectivity.BasicProxyConfiguration.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_connectivity.BasicProxyConfiguration.html @@ -1,4 +1,4 @@ -BasicProxyConfiguration | SAP Cloud SDK for JavaScript - v3.22.0

    Interface BasicProxyConfiguration

    Standard proxy configuration without additional headers nor authorization info.

    +BasicProxyConfiguration | SAP Cloud SDK for JavaScript - v3.22.1

    Interface BasicProxyConfiguration

    Standard proxy configuration without additional headers nor authorization info.

    interface BasicProxyConfiguration {
        host: string;
        port: number;
        protocol: Protocol;
    }

    Hierarchy (view full)

    Properties

    host port protocol @@ -6,4 +6,4 @@

    port

    port: number

    The port of the proxy.

    protocol

    protocol: Protocol

    The protocol used by the proxy.

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

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_connectivity.CacheEntry.html b/static/api/v3/interfaces/sap_cloud_sdk_connectivity.CacheEntry.html index e88e21df58..2d28e4e19f 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_connectivity.CacheEntry.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_connectivity.CacheEntry.html @@ -1,7 +1,7 @@ -CacheEntry | SAP Cloud SDK for JavaScript - v3.22.0

    Interface CacheEntry<T>

    Representation of a cached object.

    +CacheEntry | SAP Cloud SDK for JavaScript - v3.22.1

    Interface CacheEntry<T>

    Representation of a cached object.

    interface CacheEntry<T> {
        entry: T;
        expires?: number;
    }

    Type Parameters

    • T

    Properties

    entry expires?

    Properties

    entry

    entry: T

    The cache entry.

    Optionalexpires

    expires?: number

    The expiration time of the cache entry in milliseconds.

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

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_connectivity.CachingOptions.html b/static/api/v3/interfaces/sap_cloud_sdk_connectivity.CachingOptions.html index 6c2fee5ae1..b0616715ec 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_connectivity.CachingOptions.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_connectivity.CachingOptions.html @@ -1,5 +1,5 @@ -CachingOptions | SAP Cloud SDK for JavaScript - v3.22.0

    Interface CachingOptions

    Options to enable caching when fetching destinations.

    +CachingOptions | SAP Cloud SDK for JavaScript - v3.22.1

    Interface CachingOptions

    Options to enable caching when fetching destinations.

    interface CachingOptions {
        useCache?: boolean;
    }

    Properties

    useCache?

    Properties

    OptionaluseCache

    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.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_connectivity.ClientCredentialsResponse.html b/static/api/v3/interfaces/sap_cloud_sdk_connectivity.ClientCredentialsResponse.html index 108ae964e0..7c9e00071e 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_connectivity.ClientCredentialsResponse.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_connectivity.ClientCredentialsResponse.html @@ -1,4 +1,4 @@ -ClientCredentialsResponse | SAP Cloud SDK for JavaScript - v3.22.0

    Interface ClientCredentialsResponse

    Represents the response to a client credentials request.

    +ClientCredentialsResponse | SAP Cloud SDK for JavaScript - v3.22.1

    Interface ClientCredentialsResponse

    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 expires_in jti @@ -10,4 +10,4 @@

    scope

    scope: string

    Scopes associated with the token.

    token_type

    token_type: string

    Type of the token, e.g., Bearer.

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

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_connectivity.Destination.html b/static/api/v3/interfaces/sap_cloud_sdk_connectivity.Destination.html index b9c16fe6b1..46182ee7b8 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_connectivity.Destination.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_connectivity.Destination.html @@ -1,4 +1,4 @@ -Destination | SAP Cloud SDK for JavaScript - v3.22.0

    Interface Destination

    A resolved destination containing information needed to execute requests, such as the system URL.

    +Destination | SAP Cloud SDK for JavaScript - v3.22.1

    Interface Destination

    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 {
        authentication?: AuthenticationType;
        authTokens?: null | DestinationAuthToken[];
        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

    authentication? @@ -71,4 +71,4 @@ The path for requests against this destination will be appended to the path defined in the URL as a new path segment.

    Optionalusername

    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.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_connectivity.DestinationAccessorOptions.html b/static/api/v3/interfaces/sap_cloud_sdk_connectivity.DestinationAccessorOptions.html index 251074d420..1563f5a7a3 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_connectivity.DestinationAccessorOptions.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_connectivity.DestinationAccessorOptions.html @@ -1,4 +1,4 @@ -DestinationAccessorOptions | SAP Cloud SDK for JavaScript - v3.22.0

    Interface DestinationAccessorOptions

    Options to configure the behavior of the destination accessor.

    +DestinationAccessorOptions | SAP Cloud SDK for JavaScript - v3.22.1

    Interface DestinationAccessorOptions

    Options to configure the behavior of the destination accessor.

    See

    DestinationFetchOptions

    interface DestinationAccessorOptions {
        iasToXsuaaTokenExchange?: boolean;
        iss?: string;
        jwt?: string;
        refreshToken?: string;
        selectionStrategy?: DestinationSelectionStrategy;
    }

    Properties

    iasToXsuaaTokenExchange? iss? @@ -24,4 +24,4 @@

    See

    https://datatracker.ietf.org/doc/html/rfc6749#section-6.

    OptionalselectionStrategy

    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.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_connectivity.DestinationAuthToken.html b/static/api/v3/interfaces/sap_cloud_sdk_connectivity.DestinationAuthToken.html index a752886636..792cddbb37 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_connectivity.DestinationAuthToken.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_connectivity.DestinationAuthToken.html @@ -1,4 +1,4 @@ -DestinationAuthToken | SAP Cloud SDK for JavaScript - v3.22.0

    Interface DestinationAuthToken

    Represents authentication token returned from destination service.

    +DestinationAuthToken | SAP Cloud SDK for JavaScript - v3.22.1

    Interface DestinationAuthToken

    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 expiresIn? http_header @@ -10,4 +10,4 @@

    type

    type: string

    Type of the token, e.g., Bearer.

    value

    value: string

    Value of the token.

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

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_connectivity.DestinationCertificate.html b/static/api/v3/interfaces/sap_cloud_sdk_connectivity.DestinationCertificate.html index e93ed4db10..40070c1173 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_connectivity.DestinationCertificate.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_connectivity.DestinationCertificate.html @@ -1,4 +1,4 @@ -DestinationCertificate | SAP Cloud SDK for JavaScript - v3.22.0

    Interface DestinationCertificate

    Represents a certificate attached to a destination.

    +DestinationCertificate | SAP Cloud SDK for JavaScript - v3.22.1

    Interface DestinationCertificate

    Represents a certificate attached to a destination.

    interface DestinationCertificate {
        content: string;
        name: string;
        type: string;
    }

    Properties

    content name type @@ -6,4 +6,4 @@

    name

    name: string

    Name of the certificate file.

    type

    type: string

    Type of the certificate.

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

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_connectivity.DestinationConfiguration.html b/static/api/v3/interfaces/sap_cloud_sdk_connectivity.DestinationConfiguration.html index 318663fb1f..63a843440f 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_connectivity.DestinationConfiguration.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_connectivity.DestinationConfiguration.html @@ -1,4 +1,4 @@ -DestinationConfiguration | SAP Cloud SDK for JavaScript - v3.22.0

    Interface DestinationConfiguration

    Configuration of a destination as it is available through the destination service.

    +DestinationConfiguration | SAP Cloud SDK for JavaScript - v3.22.1

    Interface DestinationConfiguration

    Configuration of a destination as it is available through the destination service.

    interface DestinationConfiguration {
        Authentication?: AuthenticationType;
        clientId?: string;
        clientSecret?: string;
        Name?: string;
        Password?: string;
        ProxyType?: string;
        sap-client?: string;
        SystemUser?: string;
        tokenServicePass?: string;
        tokenServiceURL?: string;
        tokenServiceURLType?: "Common" | "Dedicated;";
        tokenServiceUsername?: string;
        TrustAll?: string;
        Type?:
            | "HTTP"
            | "LDAP"
            | "MAIL"
            | "RFC";
        URL?: string;
        User?: string;
        [key: string]: any;
    }

    Indexable

    • [key: string]: any

    Properties

    Authentication? clientId? clientSecret? @@ -36,4 +36,4 @@

    OptionalURL

    URL?: string

    URL of the destination.

    OptionalUser

    User?: string

    Username in case of basic authentication destinations.

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

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_connectivity.DestinationFetchOptions.html b/static/api/v3/interfaces/sap_cloud_sdk_connectivity.DestinationFetchOptions.html index a3a3471900..d23ac96872 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_connectivity.DestinationFetchOptions.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_connectivity.DestinationFetchOptions.html @@ -1,4 +1,4 @@ -DestinationFetchOptions | SAP Cloud SDK for JavaScript - v3.22.0

    Interface DestinationFetchOptions

    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.22.1

    Interface DestinationFetchOptions

    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:

      @@ -44,4 +44,4 @@

    OptionalselectionStrategy

    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.

    OptionaluseCache

    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.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_connectivity.DestinationForServiceBindingOptions.html b/static/api/v3/interfaces/sap_cloud_sdk_connectivity.DestinationForServiceBindingOptions.html index 2674e7f99e..96041d994e 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_connectivity.DestinationForServiceBindingOptions.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_connectivity.DestinationForServiceBindingOptions.html @@ -1,5 +1,5 @@ -DestinationForServiceBindingOptions | SAP Cloud SDK for JavaScript - v3.22.0

    Interface DestinationForServiceBindingOptions

    Options to customize the behavior of getDestinationFromServiceBinding.

    +DestinationForServiceBindingOptions | SAP Cloud SDK for JavaScript - v3.22.1

    Interface DestinationForServiceBindingOptions

    Options to customize the behavior of getDestinationFromServiceBinding.

    interface DestinationForServiceBindingOptions {
        serviceBindingTransformFn?: ServiceBindingTransformFunction;
    }

    Properties

    serviceBindingTransformFn?

    Properties

    OptionalserviceBindingTransformFn

    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.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_connectivity.DestinationJson.html b/static/api/v3/interfaces/sap_cloud_sdk_connectivity.DestinationJson.html index 29bf05ea5b..b5241ef4de 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_connectivity.DestinationJson.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_connectivity.DestinationJson.html @@ -1,4 +1,4 @@ -DestinationJson | SAP Cloud SDK for JavaScript - v3.22.0

    Interface DestinationJson

    Destination configuration alongside auth tokens and certificates.

    +DestinationJson | SAP Cloud SDK for JavaScript - v3.22.1

    Interface DestinationJson

    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? certificates? destinationConfiguration @@ -6,4 +6,4 @@

    Optionalcertificates

    certificates?: Record<string, string>[]

    Certificates for authentication as they are available through the destination service.

    destinationConfiguration

    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.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_connectivity.DestinationsByType.html b/static/api/v3/interfaces/sap_cloud_sdk_connectivity.DestinationsByType.html index 6ca5910e75..2c6f030a88 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_connectivity.DestinationsByType.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_connectivity.DestinationsByType.html @@ -1,8 +1,8 @@ -DestinationsByType | SAP Cloud SDK for JavaScript - v3.22.0

    Interface DestinationsByType

    Collection of all destinations from an account. +DestinationsByType | SAP Cloud SDK for JavaScript - v3.22.1

    Interface DestinationsByType

    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

    instance subaccount

    Properties

    instance

    instance: Destination[]

    Collection of destinations from the destination service instance.

    subaccount

    subaccount: Destination[]

    Collection of destinations from the subaccount.

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

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_connectivity.HttpAgentConfig.html b/static/api/v3/interfaces/sap_cloud_sdk_connectivity.HttpAgentConfig.html index ec3009d153..c8c5a7ce24 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_connectivity.HttpAgentConfig.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_connectivity.HttpAgentConfig.html @@ -1,5 +1,5 @@ -HttpAgentConfig | SAP Cloud SDK for JavaScript - v3.22.0

    Interface HttpAgentConfig

    Interface for the http-agent within the Axios request config.

    +HttpAgentConfig | SAP Cloud SDK for JavaScript - v3.22.1

    Interface HttpAgentConfig

    Interface for the http-agent within the Axios request config.

    interface HttpAgentConfig {
        httpAgent: Agent;
    }

    Properties

    httpAgent

    Properties

    httpAgent

    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.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_connectivity.HttpsAgentConfig.html b/static/api/v3/interfaces/sap_cloud_sdk_connectivity.HttpsAgentConfig.html index fa61fa286a..764ff812cf 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_connectivity.HttpsAgentConfig.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_connectivity.HttpsAgentConfig.html @@ -1,5 +1,5 @@ -HttpsAgentConfig | SAP Cloud SDK for JavaScript - v3.22.0

    Interface HttpsAgentConfig

    Interface for the https-agent within the Axios request config.

    +HttpsAgentConfig | SAP Cloud SDK for JavaScript - v3.22.1

    Interface HttpsAgentConfig

    Interface for the https-agent within the Axios request config.

    interface HttpsAgentConfig {
        httpsAgent: Agent;
    }

    Properties

    httpsAgent

    Properties

    httpsAgent

    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.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_connectivity.JwtPayload.html b/static/api/v3/interfaces/sap_cloud_sdk_connectivity.JwtPayload.html index be977b9714..a834870a3d 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_connectivity.JwtPayload.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_connectivity.JwtPayload.html @@ -1,4 +1,4 @@ -JwtPayload | SAP Cloud SDK for JavaScript - v3.22.0

    Interface JwtPayload

    This is copied from @types/jsonwebtoken.

    +JwtPayload | SAP Cloud SDK for JavaScript - v3.22.1

    Interface JwtPayload

    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

    aud? exp? iat? @@ -14,4 +14,4 @@

    Optionalnbf

    nbf?: number

    Standard claims https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.

    Optionalsub

    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.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_connectivity.ProxyConfiguration.html b/static/api/v3/interfaces/sap_cloud_sdk_connectivity.ProxyConfiguration.html index a7ae4808a5..c1e931d25d 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_connectivity.ProxyConfiguration.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_connectivity.ProxyConfiguration.html @@ -1,4 +1,4 @@ -ProxyConfiguration | SAP Cloud SDK for JavaScript - v3.22.0

    Interface ProxyConfiguration

    Proxy settings for connecting to an on-premise destination via connectivity proxy or web proxies. +ProxyConfiguration | SAP Cloud SDK for JavaScript - v3.22.1

    Interface ProxyConfiguration

    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.
      • @@ -19,4 +19,4 @@

    protocol

    protocol: Protocol

    The protocol used by the proxy.

    Optionalproxy-authorization

    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.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_connectivity.ProxyConfigurationHeaders.html b/static/api/v3/interfaces/sap_cloud_sdk_connectivity.ProxyConfigurationHeaders.html index 4772928c41..9aa1ba8825 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_connectivity.ProxyConfigurationHeaders.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_connectivity.ProxyConfigurationHeaders.html @@ -1,7 +1,7 @@ -ProxyConfigurationHeaders | SAP Cloud SDK for JavaScript - v3.22.0

    Interface ProxyConfigurationHeaders

    Represents the request headers when using a proxy like the connectivity proxy to reach On-Premise systems.

    +ProxyConfigurationHeaders | SAP Cloud SDK for JavaScript - v3.22.1

    Interface ProxyConfigurationHeaders

    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 SAP-Connectivity-Authentication?

    Properties

    Proxy-Authorization

    Proxy-Authorization: string

    Proxy-Authorization header sent to the proxy.

    OptionalSAP-Connectivity-Authentication

    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.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_connectivity.Service.html b/static/api/v3/interfaces/sap_cloud_sdk_connectivity.Service.html index 963eaadc8e..d3220c70cd 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_connectivity.Service.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_connectivity.Service.html @@ -1,4 +1,4 @@ -Service | SAP Cloud SDK for JavaScript - v3.22.0

    Interface Service

    Unspecific representation of a service as read from VCAP_SERVICES (for Cloud Foundry) or mounted secrets (for K8S).

    +Service | SAP Cloud SDK for JavaScript - v3.22.1

    Interface Service

    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

    credentials label name @@ -8,4 +8,4 @@

    name

    name: string

    The name of the service.

    tags

    tags: string[]

    The tags of the service.

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

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_connectivity.VerifyJwtOptions.html b/static/api/v3/interfaces/sap_cloud_sdk_connectivity.VerifyJwtOptions.html index deff115e85..46876b8b73 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_connectivity.VerifyJwtOptions.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_connectivity.VerifyJwtOptions.html @@ -1,5 +1,5 @@ -VerifyJwtOptions | SAP Cloud SDK for JavaScript - v3.22.0

    Interface VerifyJwtOptions

    Options to control certain aspects of JWT verification behavior.

    +VerifyJwtOptions | SAP Cloud SDK for JavaScript - v3.22.1

    Interface VerifyJwtOptions

    Options to control certain aspects of JWT verification behavior.

    interface VerifyJwtOptions {
        cacheVerificationKeys?: boolean;
    }

    Properties

    cacheVerificationKeys?

    Properties

    OptionalcacheVerificationKeys

    cacheVerificationKeys?: boolean

    The verification keys are cached if set to true.

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

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_generator.GeneratorOptions.html b/static/api/v3/interfaces/sap_cloud_sdk_generator.GeneratorOptions.html index 397f06052b..a2e9f12b1d 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_generator.GeneratorOptions.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_generator.GeneratorOptions.html @@ -1,4 +1,4 @@ -GeneratorOptions | SAP Cloud SDK for JavaScript - v3.22.0

    Interface GeneratorOptions

    Options to configure OData client generation when using the generator programmatically.

    +GeneratorOptions | SAP Cloud SDK for JavaScript - v3.22.1

    Interface GeneratorOptions

    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? include? input @@ -43,4 +43,4 @@

    Optionalverbose

    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.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_generator_common.CommonGeneratorOptions.html b/static/api/v3/interfaces/sap_cloud_sdk_generator_common.CommonGeneratorOptions.html index c9771f672b..435f77f159 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_generator_common.CommonGeneratorOptions.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_generator_common.CommonGeneratorOptions.html @@ -1,4 +1,4 @@ -CommonGeneratorOptions | SAP Cloud SDK for JavaScript - v3.22.0

    Interface CommonGeneratorOptions

    Generator options shared by the OData and OpenApi generator.

    +CommonGeneratorOptions | SAP Cloud SDK for JavaScript - v3.22.1

    Interface CommonGeneratorOptions

    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? include? input @@ -39,4 +39,4 @@

    Optionalverbose

    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.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_http_client.CsrfMiddlewareOptions.html b/static/api/v3/interfaces/sap_cloud_sdk_http_client.CsrfMiddlewareOptions.html index ca25ad6e0c..f94db4316b 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_http_client.CsrfMiddlewareOptions.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_http_client.CsrfMiddlewareOptions.html @@ -1,4 +1,4 @@ -CsrfMiddlewareOptions | SAP Cloud SDK for JavaScript - v3.22.0

    Interface CsrfMiddlewareOptions

    Options for middleware to fetch CSRF tokens.

    +CsrfMiddlewareOptions | SAP Cloud SDK for JavaScript - v3.22.1

    Interface CsrfMiddlewareOptions

    Options for middleware to fetch CSRF tokens.

    interface CsrfMiddlewareOptions {
        method?: Method;
        middleware?: HttpMiddleware[];
        url?: string;
    }

    Properties

    method? middleware? url? @@ -6,4 +6,4 @@

    Optionalmiddleware

    middleware?: HttpMiddleware[]

    Middlewares added to the token retrieval request.

    Optionalurl

    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.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_http_client.DestinationHttpRequestConfig.html b/static/api/v3/interfaces/sap_cloud_sdk_http_client.DestinationHttpRequestConfig.html index cfd7587acb..eee1d0a50a 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_http_client.DestinationHttpRequestConfig.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_http_client.DestinationHttpRequestConfig.html @@ -1,4 +1,4 @@ -DestinationHttpRequestConfig | SAP Cloud SDK for JavaScript - v3.22.0

    Interface DestinationHttpRequestConfig

    Represents the request configuration, that was inferred from a destination.

    +DestinationHttpRequestConfig | SAP Cloud SDK for JavaScript - v3.22.1

    Interface DestinationHttpRequestConfig

    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 headers httpAgent? @@ -12,4 +12,4 @@

    Optionalparams

    params?: Record<string, string>

    URL parameters to be sent with the request.

    Optionalproxy

    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.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_http_client.HttpMiddlewareContext.html b/static/api/v3/interfaces/sap_cloud_sdk_http_client.HttpMiddlewareContext.html index c3624bb7f6..b5cbe42d8e 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_http_client.HttpMiddlewareContext.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_http_client.HttpMiddlewareContext.html @@ -1,4 +1,4 @@ -HttpMiddlewareContext | SAP Cloud SDK for JavaScript - v3.22.0

    Interface HttpMiddlewareContext

    Context for HttpRequests of the middleware.

    +HttpMiddlewareContext | SAP Cloud SDK for JavaScript - v3.22.1

    Interface HttpMiddlewareContext

    Context for HttpRequests of the middleware.

    interface HttpMiddlewareContext {
        destinationName?: string;
        jwt?: string;
        tenantId: undefined | string;
        uri: string;
    }

    Hierarchy (view full)

    Properties

    destinationName? jwt? tenantId @@ -8,4 +8,4 @@

    ReadonlytenantId

    tenantId: undefined | string

    Tenant identifier.

    Readonlyuri

    uri: string

    URI of the function passed to the middleware.

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

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_http_client.HttpRequestConfigBase.html b/static/api/v3/interfaces/sap_cloud_sdk_http_client.HttpRequestConfigBase.html index 5585fbc504..f1a8ee26e0 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_http_client.HttpRequestConfigBase.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_http_client.HttpRequestConfigBase.html @@ -1,4 +1,4 @@ -HttpRequestConfigBase | SAP Cloud SDK for JavaScript - v3.22.0

    Interface HttpRequestConfigBase

    Represents an HTTP request config. This is the basis for actual request configurations and request configurations with origins.

    +HttpRequestConfigBase | SAP Cloud SDK for JavaScript - v3.22.1

    Interface HttpRequestConfigBase

    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? httpAgent? httpsAgent? @@ -21,4 +21,4 @@

    Optionalurl

    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.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_http_client.HttpRequestOptions.html b/static/api/v3/interfaces/sap_cloud_sdk_http_client.HttpRequestOptions.html index 3964071e3d..c2c53e7db8 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_http_client.HttpRequestOptions.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_http_client.HttpRequestOptions.html @@ -1,8 +1,8 @@ -HttpRequestOptions | SAP Cloud SDK for JavaScript - v3.22.0

    Interface HttpRequestOptions

    Options to configure the behavior when sending HTTP requests. +HttpRequestOptions | SAP Cloud SDK for JavaScript - v3.22.1

    Interface HttpRequestOptions

    Options to configure the behavior when sending HTTP requests. For example, whether the CSRF token is fetched automatically.

    interface HttpRequestOptions {
        fetchCsrfToken?: boolean;
    }

    Properties

    fetchCsrfToken?

    Properties

    OptionalfetchCsrfToken

    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.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_http_client.HttpResponse.html b/static/api/v3/interfaces/sap_cloud_sdk_http_client.HttpResponse.html index 5c0b804b0c..f5d8644d21 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_http_client.HttpResponse.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_http_client.HttpResponse.html @@ -1,8 +1,8 @@ -HttpResponse | SAP Cloud SDK for JavaScript - v3.22.0

    Interface HttpResponse

    Represents an HTTP response, that contains response code, headers, payload and the original request. +HttpResponse | SAP Cloud SDK for JavaScript - v3.22.1

    Interface HttpResponse

    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

    data headers request status

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

    -

    Properties

    data

    data: any

    headers

    headers: any

    request

    request: any

    status

    status: number

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Properties

    data

    data: any

    headers

    headers: any

    request

    request: any

    status

    status: number

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_http_client.OriginOptions.html b/static/api/v3/interfaces/sap_cloud_sdk_http_client.OriginOptions.html index e6d8b1ebc0..a5e73a4997 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_http_client.OriginOptions.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_http_client.OriginOptions.html @@ -1,8 +1,8 @@ -OriginOptions | SAP Cloud SDK for JavaScript - v3.22.0

    Interface OriginOptions

    This interface is used for defining e.g., headers and query parameters with origin information. +OriginOptions | SAP Cloud SDK for JavaScript - v3.22.1

    Interface OriginOptions

    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

    custom? requestConfig?

    Properties

    Optionalcustom

    custom?: Record<string, any>

    Header or parameters properties set explicitly, which take precedence over requestConfig.

    OptionalrequestConfig

    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.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_mail_client.Address.html b/static/api/v3/interfaces/sap_cloud_sdk_mail_client.Address.html index 3dfc39ff41..8eb6188cbe 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_mail_client.Address.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_mail_client.Address.html @@ -1,8 +1,8 @@ -Address | SAP Cloud SDK for JavaScript - v3.22.0

    Interface Address

    Represents an e-mail address. +Address | SAP Cloud SDK for JavaScript - v3.22.1

    Interface Address

    Represents an e-mail address. This interface is compatible with Mail.Address of nodemailer.

    interface Address {
        address: string;
        name: string;
    }

    Properties

    address name

    Properties

    address

    address: string

    E-mail address of the recipient, e.g. sender@server.com.

    name

    name: string

    Name of the recipient.

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

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_mail_client.Attachment.html b/static/api/v3/interfaces/sap_cloud_sdk_mail_client.Attachment.html index 53ea54d0b8..77f122b2a0 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_mail_client.Attachment.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_mail_client.Attachment.html @@ -1,4 +1,4 @@ -Attachment | SAP Cloud SDK for JavaScript - v3.22.0

    Interface Attachment

    Represents an attachment. +Attachment | SAP Cloud SDK for JavaScript - v3.22.1

    Interface Attachment

    Represents an attachment. This interface is compatible with Attachment of nodemailer.

    interface Attachment {
        cid?: string;
        content?: string | Buffer | Readable;
        contentDisposition?: "attachment" | "inline";
        contentTransferEncoding?:
            | false
            | "7bit"
            | "base64"
            | "quoted-printable";
        contentType?: string;
        encoding?: string;
        filename?: string | false;
        headers?: Headers;
        path?: string | Url;
        raw?:
            | string
            | Buffer
            | Readable
            | AttachmentLike;
    }

    Hierarchy (view full)

    Properties

    cid? content? @@ -21,4 +21,4 @@

    Optionalpath

    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).

    Optionalraw

    raw?:
        | string
        | Buffer
        | Readable
        | 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.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_mail_client.AttachmentLike.html b/static/api/v3/interfaces/sap_cloud_sdk_mail_client.AttachmentLike.html index e6ccb9763f..13a6c618a7 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_mail_client.AttachmentLike.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_mail_client.AttachmentLike.html @@ -1,8 +1,8 @@ -AttachmentLike | SAP Cloud SDK for JavaScript - v3.22.0

    Interface AttachmentLike

    Represents the structure of an attachment. +AttachmentLike | SAP Cloud SDK for JavaScript - v3.22.1

    Interface AttachmentLike

    Represents the structure of an attachment. This interface is compatible with AttachmentLike of nodemailer.

    interface AttachmentLike {
        content?: string | Buffer | Readable;
        path?: string | Url;
    }

    Hierarchy (view full)

    Properties

    content? path?

    Properties

    Optionalcontent

    content?: string | Buffer | Readable

    Contents of the attachment stored in a string, buffer or stream.

    Optionalpath

    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.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_mail_client.Envelope.html b/static/api/v3/interfaces/sap_cloud_sdk_mail_client.Envelope.html index 5f57f6a035..0044b18d30 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_mail_client.Envelope.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_mail_client.Envelope.html @@ -1,8 +1,8 @@ -Envelope | SAP Cloud SDK for JavaScript - v3.22.0

    Interface Envelope

    Represents an envelope that contains the e-mail addresses of the sender and the recipients. +Envelope | SAP Cloud SDK for JavaScript - v3.22.1

    Interface Envelope

    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

    from: string | false

    E-mail address of the sender or false if it should not be shown.

    to

    to: string[]

    Array of e-mail addresses of recipients.

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

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_mail_client.MailClientOptions.html b/static/api/v3/interfaces/sap_cloud_sdk_mail_client.MailClientOptions.html index 4d748851a6..54035af0a3 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_mail_client.MailClientOptions.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_mail_client.MailClientOptions.html @@ -1,4 +1,4 @@ -MailClientOptions | SAP Cloud SDK for JavaScript - v3.22.0

    Interface MailClientOptions

    Represents options of the mail client.

    +MailClientOptions | SAP Cloud SDK for JavaScript - v3.22.1

    Interface MailClientOptions

    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? connectionTimeout? debug? @@ -31,4 +31,4 @@

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

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_mail_client.MailConfig.html b/static/api/v3/interfaces/sap_cloud_sdk_mail_client.MailConfig.html index 6aee45b1e9..9dbbf4be11 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_mail_client.MailConfig.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_mail_client.MailConfig.html @@ -1,4 +1,4 @@ -MailConfig | SAP Cloud SDK for JavaScript - v3.22.0

    Interface MailConfig

    Represents configurations for sending an e-mail. +MailConfig | SAP Cloud SDK for JavaScript - v3.22.1

    Interface MailConfig

    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
            | Buffer
            | Readable
            | AttachmentLike;
        priority?: "high" | "normal" | "low";
        replyTo?: string | Address | (string | Address)[];
        sender?: string | Address;
        subject?: string;
        text?:
            | string
            | Buffer
            | Readable
            | AttachmentLike;
        to?: string | Address | (string | Address)[];
    }

    Properties

    attachments? bcc? @@ -29,4 +29,4 @@

    Optionaltext

    text?:
        | string
        | Buffer
        | Readable
        | AttachmentLike

    Plaintext version of the message.

    Optionalto

    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.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_mail_client.MailResponse.html b/static/api/v3/interfaces/sap_cloud_sdk_mail_client.MailResponse.html index 351432e1b9..d48f5bc1f5 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_mail_client.MailResponse.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_mail_client.MailResponse.html @@ -1,4 +1,4 @@ -MailResponse | SAP Cloud SDK for JavaScript - v3.22.0

    Interface MailResponse

    Represents the response from the mail server. +MailResponse | SAP Cloud SDK for JavaScript - v3.22.1

    Interface MailResponse

    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? envelope? @@ -11,4 +11,4 @@

    Optionalrejected

    rejected?: (string | Address)[]

    Array of e-mail addresses that rejected the requests.

    Optionalresponse

    response?: string

    Other response message from the mail server.

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

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_mail_client.SDKOptions.html b/static/api/v3/interfaces/sap_cloud_sdk_mail_client.SDKOptions.html index e351341d0b..a0b481ff1f 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_mail_client.SDKOptions.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_mail_client.SDKOptions.html @@ -1,5 +1,5 @@ -SDKOptions | SAP Cloud SDK for JavaScript - v3.22.0

    Interface SDKOptions

    Represents options for sending mails provided by the SDK. For example whether the mails are sent in parallel.

    +SDKOptions | SAP Cloud SDK for JavaScript - v3.22.1

    Interface SDKOptions

    Represents options for sending mails provided by the SDK. For example whether the mails are sent in parallel.

    interface SDKOptions {
        parallel?: boolean;
    }

    Properties

    parallel?

    Properties

    Optionalparallel

    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.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_mail_client.SmtpTransportOptions.html b/static/api/v3/interfaces/sap_cloud_sdk_mail_client.SmtpTransportOptions.html index 9f4802b464..c347a07360 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_mail_client.SmtpTransportOptions.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_mail_client.SmtpTransportOptions.html @@ -1,4 +1,4 @@ -SmtpTransportOptions | SAP Cloud SDK for JavaScript - v3.22.0

    Interface SmtpTransportOptions

    Represents options for setting up the SMTP connection. +SmtpTransportOptions | SAP Cloud SDK for JavaScript - v3.22.1

    Interface SmtpTransportOptions

    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? connectionTimeout? @@ -30,4 +30,4 @@

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

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_odata_common.BatchReference.html b/static/api/v3/interfaces/sap_cloud_sdk_odata_common.BatchReference.html index d0236bba96..f6bed7e1f7 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_odata_common.BatchReference.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_odata_common.BatchReference.html @@ -1,5 +1,5 @@ -BatchReference | SAP Cloud SDK for JavaScript - v3.22.0

    Interface BatchReference

    Interface implemented by OData requests needing identifier to reference an entity for a batch request like create, delete, getByKey, update or bound actions/functions.

    +BatchReference | SAP Cloud SDK for JavaScript - v3.22.1

    Interface BatchReference

    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

    id: string

    Batch reference identifier.

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

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_odata_common.ComplexTypeNamespace.html b/static/api/v3/interfaces/sap_cloud_sdk_odata_common.ComplexTypeNamespace.html index 14b6d9a1aa..7f0c377dc1 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_odata_common.ComplexTypeNamespace.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_odata_common.ComplexTypeNamespace.html @@ -1,5 +1,5 @@ -ComplexTypeNamespace | SAP Cloud SDK for JavaScript - v3.22.0

    Interface ComplexTypeNamespace<ComplexT>

    Interface to represent meta information on the _propertyMetadata property of a complex type.

    +ComplexTypeNamespace | SAP Cloud SDK for JavaScript - v3.22.1

    Interface ComplexTypeNamespace<ComplexT>

    Interface to represent meta information on the _propertyMetadata property of a complex type.

    interface ComplexTypeNamespace<ComplexT> {
        _propertyMetadata: PropertyMetadata<ComplexT>[];
    }

    Type Parameters

    • ComplexT

    Properties

    _propertyMetadata

    Properties

    _propertyMetadata

    _propertyMetadata: PropertyMetadata<ComplexT>[]

    Metadata like Edm.Type of the complex type properties.

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

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_odata_common.Constructable.html b/static/api/v3/interfaces/sap_cloud_sdk_odata_common.Constructable.html index b0e222c4a4..d9f7c319ad 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_odata_common.Constructable.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_odata_common.Constructable.html @@ -1,4 +1,4 @@ -Constructable | SAP Cloud SDK for JavaScript - v3.22.0

    Interface Constructable<EntityT>

    Represents the static API of an entity.

    +Constructable | SAP Cloud SDK for JavaScript - v3.22.1

    Interface Constructable<EntityT>

    Represents the static API of an entity.

    interface Constructable<EntityT> {
        new Constructablenew (...args: any[]): EntityT;
        _defaultBasePath: string;
        _entityName: string;
        _keys: string[];
    }

    Type Parameters

    Constructors

    constructor

    Properties

    _defaultBasePath _entityName @@ -7,4 +7,4 @@

    _entityName

    _entityName: string

    Name of the entity.

    _keys

    _keys: string[]

    Names of the key properties of the entity.

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

    -

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    +

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_odata_common.DeSerializer.html b/static/api/v3/interfaces/sap_cloud_sdk_odata_common.DeSerializer.html index 04de9b6ecc..516bebaab2 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_odata_common.DeSerializer.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_odata_common.DeSerializer.html @@ -1,4 +1,4 @@ -DeSerializer | SAP Cloud SDK for JavaScript - v3.22.0

    Interface DeSerializer<DeserializedT>

    Represents a set of functions for serialization, deserialization and optionally serialization for URIs. +DeSerializer | SAP Cloud SDK for JavaScript - v3.22.1

    Interface DeSerializer<DeserializedT>

    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: any) => DeserializedT);
        serialize: ((value: DeserializedT) => any);
        serializeToUri?: ((value: DeserializedT, serialize: ((value: DeserializedT) => any)) => string);
    }

    Type Parameters

    • DeserializedT

      The return type of deserialize and input of serialize and serializeToUri.

    Properties

    deserialize @@ -16,4 +16,4 @@
  • serialize: ((value: DeserializedT) => any)

    A reference to the serialize function which is usually used to serialize the payload.

    • Returns string

    Serialized value for URIs.

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

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_odata_common.DeSerializers.html b/static/api/v3/interfaces/sap_cloud_sdk_odata_common.DeSerializers.html index 56b069f4fe..f9f234b2a4 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_odata_common.DeSerializers.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_odata_common.DeSerializers.html @@ -1,4 +1,4 @@ -DeSerializers | SAP Cloud SDK for JavaScript - v3.22.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.

    +DeSerializers | SAP Cloud SDK for JavaScript - v3.22.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.

    interface DeSerializers<BinaryT, BooleanT, ByteT, DecimalT, DoubleT, FloatT, Int16T, Int32T, Int64T, GuidT, SByteT, SingleT, StringT, AnyT> {
        Edm.Any: DeSerializer<AnyT>;
        Edm.Binary: DeSerializer<BinaryT>;
        Edm.Boolean: DeSerializer<BooleanT>;
        Edm.Byte: DeSerializer<ByteT>;
        Edm.Decimal: DeSerializer<DecimalT>;
        Edm.Double: DeSerializer<DoubleT>;
        Edm.Float: DeSerializer<FloatT>;
        Edm.Guid: DeSerializer<GuidT>;
        Edm.Int16: DeSerializer<Int16T>;
        Edm.Int32: DeSerializer<Int32T>;
        Edm.Int64: DeSerializer<Int64T>;
        Edm.SByte: DeSerializer<SByteT>;
        Edm.Single: DeSerializer<SingleT>;
        Edm.String: DeSerializer<StringT>;
    }

    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 Edm.Binary Edm.Boolean @@ -28,4 +28,4 @@

    Edm.Single

    Edm.Single: DeSerializer<SingleT>

    DeSerializer for Edm.Single to the generic type SingleT.

    Edm.String

    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.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_odata_common.EntityApi.html b/static/api/v3/interfaces/sap_cloud_sdk_odata_common.EntityApi.html index a6ff026062..268f2cf63d 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_odata_common.EntityApi.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_odata_common.EntityApi.html @@ -1,4 +1,4 @@ -EntityApi | SAP Cloud SDK for JavaScript - v3.22.0

    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.22.1

    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.

    interface EntityApi<EntityT, DeSerializersT> {
        deSerializers: DeSerializersT;
        entityConstructor: Constructable<EntityT>;
        schema: Record<string, any>;
        customField<NullableT>(fieldName: string): CustomField<EntityT, DeSerializersT, NullableT>;
        entityBuilder(): EntityBuilderType<EntityT, DeSerializersT>;
        requestBuilder(): RequestBuilder<EntityT, DeSerializersT>;
    }

    Type Parameters

    entityConstructor

    entityConstructor: Constructable<EntityT>

    Constructor function for the entity.

    schema

    schema: Record<string, any>

    Schema of the entity api.

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

    -

    Methods

    customField

    entityBuilder

    requestBuilder

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    +

    Methods

    customField

    entityBuilder

    requestBuilder

    Settings

    Member Visibility

    On This Page

    Properties
    Methods
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_odata_common.EntityDeserializer.html b/static/api/v3/interfaces/sap_cloud_sdk_odata_common.EntityDeserializer.html index a479c28ac7..a936037b16 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_odata_common.EntityDeserializer.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_odata_common.EntityDeserializer.html @@ -1,7 +1,7 @@ -EntityDeserializer | SAP Cloud SDK for JavaScript - v3.22.0

    Interface EntityDeserializer

    Interface representing the return type of the builder function entityDeserializer.

    +EntityDeserializer | SAP Cloud SDK for JavaScript - v3.22.1

    Interface EntityDeserializer

    Interface representing the return type of the builder function entityDeserializer.

    interface EntityDeserializer {
        deserializeComplexType: ((json: Record<string, any>, complexType: ComplexTypeNamespace<any>) => any);
        deserializeEntity: (<EntityT>(json: any, entityApi: EntityApi<EntityT, any>, requestHeader?: any) => EntityT);
    }

    Properties

    deserializeComplexType deserializeEntity

    Properties

    deserializeComplexType

    deserializeComplexType: ((json: Record<string, any>, complexType: ComplexTypeNamespace<any>) => any)

    Method to deserialize the full entity from JSON to the complex type property.

    deserializeEntity

    deserializeEntity: (<EntityT>(json: any, entityApi: EntityApi<EntityT, any>, requestHeader?: any) => 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.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_odata_common.EntityIdentifiable.html b/static/api/v3/interfaces/sap_cloud_sdk_odata_common.EntityIdentifiable.html index 05c369545c..746f3cfb6c 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_odata_common.EntityIdentifiable.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_odata_common.EntityIdentifiable.html @@ -1,4 +1,4 @@ -EntityIdentifiable | SAP Cloud SDK for JavaScript - v3.22.0

    Interface EntityIdentifiable<T, DeSerializersT>

    Represents an object that is related to an entity. +EntityIdentifiable | SAP Cloud SDK for JavaScript - v3.22.1

    Interface EntityIdentifiable<T, 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.

    interface EntityIdentifiable<T, DeSerializersT> {
        _deSerializers: DeSerializersT;
        _entity: T;
    }

    Type Parameters

    Implemented by

    Properties

    _deSerializers @@ -6,4 +6,4 @@

    Properties

    Readonly_deSerializers

    _deSerializers: DeSerializersT

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

    Readonly_entity

    _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.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_odata_common.EntitySerializer.html b/static/api/v3/interfaces/sap_cloud_sdk_odata_common.EntitySerializer.html index af2879cb6c..59bfc8396b 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_odata_common.EntitySerializer.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_odata_common.EntitySerializer.html @@ -1,4 +1,4 @@ -EntitySerializer | SAP Cloud SDK for JavaScript - v3.22.0

    Interface EntitySerializer

    Interface representing the return type of the builder function entitySerializer.

    +EntitySerializer | SAP Cloud SDK for JavaScript - v3.22.1

    Interface EntitySerializer

    Interface representing the return type of the builder function entitySerializer.

    interface EntitySerializer {
        serializeComplexType: (<ComplexTypeNamespaceT>(fieldValue: any, complexTypeNameSpace: ComplexTypeNamespaceT) => any);
        serializeEntity: (<EntityT>(entity: EntityT, entityApi: EntityApi<EntityT, any>, diff?: boolean) => Record<string, any>);
        serializeEntityNonCustomFields: (<EntityT>(entity: EntityT, entityApi: EntityApi<EntityT, any>) => Record<string, any>);
    }

    Properties

    serializeComplexType serializeEntity serializeEntityNonCustomFields @@ -6,4 +6,4 @@

    serializeEntity

    serializeEntity: (<EntityT>(entity: EntityT, entityApi: EntityApi<EntityT, any>, diff?: boolean) => Record<string, any>)

    Converts an instance of an entity class into a JSON payload to be sent to an OData service.

    serializeEntityNonCustomFields

    serializeEntityNonCustomFields: (<EntityT>(entity: EntityT, entityApi: EntityApi<EntityT, any>) => Record<string, any>)

    Like EntitySerializer#serializeEntity ignoring custom fields.

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

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_odata_common.ErrorResponse.html b/static/api/v3/interfaces/sap_cloud_sdk_odata_common.ErrorResponse.html index 907141f501..933077d845 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_odata_common.ErrorResponse.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_odata_common.ErrorResponse.html @@ -1,4 +1,4 @@ -ErrorResponse | SAP Cloud SDK for JavaScript - v3.22.0

    Interface ErrorResponse

    Represents an erroneous response to a retrieve or change set request within a batch request.

    +ErrorResponse | SAP Cloud SDK for JavaScript - v3.22.1

    Interface ErrorResponse

    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 httpCode isError @@ -10,4 +10,4 @@

    httpCode

    httpCode: number

    HTTP response status code.

    isError

    isError: (() => this is ErrorResponse)

    isReadResponse

    isReadResponse: (() => this is ReadResponse<any>)

    isSuccess

    isSuccess: (() => this is ReadResponse<any> | WriteResponses<any>)

    isWriteResponses

    isWriteResponses: (() => this is WriteResponses<any>)

    responseType

    responseType: "ErrorResponse"

    Tag for identifying the type of a batch response.

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

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_odata_common.FieldOptions.html b/static/api/v3/interfaces/sap_cloud_sdk_odata_common.FieldOptions.html index 14b30a733e..e4ad7c1598 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_odata_common.FieldOptions.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_odata_common.FieldOptions.html @@ -1,7 +1,7 @@ -FieldOptions | SAP Cloud SDK for JavaScript - v3.22.0

    Interface FieldOptions<NullableT, SelectableT>

    Optional settings for fields.

    +FieldOptions | SAP Cloud SDK for JavaScript - v3.22.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? isSelectable?

    Properties

    OptionalisNullable

    isNullable?: NullableT

    Whether the value of the field can be null.

    OptionalisSelectable

    isSelectable?: SelectableT

    Whether the field can be reference in a .select statement.

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

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_odata_common.FilterFunctionsType.html b/static/api/v3/interfaces/sap_cloud_sdk_odata_common.FilterFunctionsType.html index a3bdafc55a..e44089e4a4 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_odata_common.FilterFunctionsType.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_odata_common.FilterFunctionsType.html @@ -1,4 +1,4 @@ -FilterFunctionsType | SAP Cloud SDK for JavaScript - v3.22.0

    Interface FilterFunctionsType

    Interface containing all filter functions like startsWith, toUpper or floor.

    +FilterFunctionsType | SAP Cloud SDK for JavaScript - v3.22.1

    Interface FilterFunctionsType

    Interface containing all filter functions like startsWith, toUpper or floor.

    interface FilterFunctionsType {
        ceiling: (<EntityT>(num: number | Field<EntityT, boolean, boolean> | NumberFilterFunction<EntityT>, returnType?: "double" | "decimal") => NumberFilterFunction<EntityT>);
        concat: (<EntityT>(str1: string | Field<EntityT, boolean, boolean> | StringFilterFunction<EntityT>, str2: string | Field<EntityT, boolean, boolean> | StringFilterFunction<EntityT>) => StringFilterFunction<EntityT>);
        day: (<EntityT>(date: Moment | Field<EntityT, boolean, boolean>) => NumberFilterFunction<EntityT>);
        endsWith: (<EntityT>(str: string | Field<EntityT, boolean, boolean> | StringFilterFunction<EntityT>, suffix: string | Field<EntityT, boolean, boolean> | StringFilterFunction<EntityT>) => BooleanFilterFunction<EntityT>);
        floor: (<EntityT>(num: number | Field<EntityT, boolean, boolean> | NumberFilterFunction<EntityT>, returnType?: "double" | "decimal") => NumberFilterFunction<EntityT>);
        hour: (<EntityT>(date: Moment | Field<EntityT, boolean, boolean>) => NumberFilterFunction<EntityT>);
        indexOf: (<EntityT>(str: string | Field<EntityT, boolean, boolean> | StringFilterFunction<EntityT>, substr: string | Field<EntityT, boolean, boolean> | StringFilterFunction<EntityT>) => NumberFilterFunction<EntityT>);
        isOf: {
            <EntityT>(type: string): BooleanFilterFunction<EntityT>;
            <EntityT>(expression: Field<EntityT, boolean, boolean>, type: string): BooleanFilterFunction<EntityT>;
        };
        length: (<EntityT>(str: string | Field<EntityT, boolean, boolean> | StringFilterFunction<EntityT>) => NumberFilterFunction<EntityT>);
        minute: (<EntityT>(date: Moment | Field<EntityT, boolean, boolean>) => NumberFilterFunction<EntityT>);
        month: (<EntityT>(date: Moment | Field<EntityT, boolean, boolean>) => NumberFilterFunction<EntityT>);
        round: (<EntityT>(num: number | Field<EntityT, boolean, boolean> | NumberFilterFunction<EntityT>, returnType?: "double" | "decimal") => NumberFilterFunction<EntityT>);
        second: (<EntityT>(date: Moment | Field<EntityT, boolean, boolean>) => NumberFilterFunction<EntityT>);
        startsWith: (<EntityT>(str: string | Field<EntityT, boolean, boolean> | StringFilterFunction<EntityT>, prefix: string | Field<EntityT, boolean, boolean> | StringFilterFunction<EntityT>) => BooleanFilterFunction<EntityT>);
        substring: (<EntityT>(str: string | Field<EntityT, boolean, boolean> | StringFilterFunction<EntityT>, pos: number | Field<EntityT, boolean, boolean> | NumberFilterFunction<EntityT>, len?: number | Field<EntityT, boolean, boolean> | NumberFilterFunction<EntityT>) => StringFilterFunction<EntityT>);
        toLower: (<EntityT>(str: string | Field<EntityT, boolean, boolean> | StringFilterFunction<EntityT>) => StringFilterFunction<EntityT>);
        toUpper: (<EntityT>(str: string | Field<EntityT, boolean, boolean> | StringFilterFunction<EntityT>) => StringFilterFunction<EntityT>);
        trim: (<EntityT>(str: string | Field<EntityT, boolean, boolean> | StringFilterFunction<EntityT>) => StringFilterFunction<EntityT>);
        year: (<EntityT>(date: Moment | Field<EntityT, boolean, boolean>) => NumberFilterFunction<EntityT>);
    }

    Properties

    ceiling concat day @@ -108,4 +108,4 @@

    Type Parameters

    Parameters

    • date: Moment | Field<EntityT, boolean, boolean>

      The date to get the year for. This can either be a date (Moment) or a reference to a field.

    Returns NumberFilterFunction<EntityT>

    The newly created filter function

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

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_odata_common.ODataUri.html b/static/api/v3/interfaces/sap_cloud_sdk_odata_common.ODataUri.html index ffe2e7e364..c85eb12712 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_odata_common.ODataUri.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_odata_common.ODataUri.html @@ -1,4 +1,4 @@ -ODataUri | SAP Cloud SDK for JavaScript - v3.22.0

    Interface ODataUri<DeSerializersT>

    Union of necessary methods for the OData URI conversion. +ODataUri | SAP Cloud SDK for JavaScript - v3.22.1

    Interface ODataUri<DeSerializersT>

    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: any, edmType: EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4): string;
        getEntityKeys<EntityT>(entity: EntityT, entityApi: EntityApi<EntityT, DeSerializersT>): Record<string, any>;
        getExpand<EntityT>(selects: Selectable<EntityT, DeSerializersT>[], expands: Expandable<EntityT, DeSerializersT>[], entityApi: EntityApi<EntityT, DeSerializersT>): Partial<{
            expand: string;
        }>;
        getFilter<EntityT>(filter: Filterable<EntityT, DeSerializersT>, entityApi: EntityApi<EntityT, DeSerializersT>): Partial<{
            filter: string;
        }>;
        getOrderBy<EntityT>(orderBy: Orderable<EntityT>[]): Partial<{
            orderby: string;
        }>;
        getResourcePathForKeys<EntityT>(keys: Record<string, any>, _entityApi: EntityApi<EntityT, DeSerializersT>): string;
        getSelect<EntityT>(selects: Selectable<EntityT, DeSerializersT>[]): Partial<{
            select: string;
        }>;
    }

    Type Parameters

    Methods

    convertToUriFormat getEntityKeys @@ -8,4 +8,4 @@ getResourcePathForKeys getSelect

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

    -

    Methods

    convertToUriFormat

    getEntityKeys

    • getEntityKeys<EntityT>(entity, entityApi): Record<string, any>

    • Type Parameters

      Parameters

      Returns Record<string, any>

    getExpand

    getFilter

    getOrderBy

    • getOrderBy<EntityT>(orderBy): Partial<{
          orderby: string;
      }>

    • Type Parameters

      Parameters

      Returns Partial<{
          orderby: string;
      }>

    getResourcePathForKeys

    • getResourcePathForKeys<EntityT>(keys, _entityApi): string

    • Type Parameters

      Parameters

      Returns string

    getSelect

    • getSelect<EntityT>(selects): Partial<{
          select: string;
      }>

    • Type Parameters

      Parameters

      Returns Partial<{
          select: string;
      }>

    Settings

    Member Visibility

    On This Page

    Methods
    +

    Methods

    convertToUriFormat

    getEntityKeys

    • getEntityKeys<EntityT>(entity, entityApi): Record<string, any>

    • Type Parameters

      Parameters

      Returns Record<string, any>

    getExpand

    getFilter

    getOrderBy

    • getOrderBy<EntityT>(orderBy): Partial<{
          orderby: string;
      }>

    • Type Parameters

      Parameters

      Returns Partial<{
          orderby: string;
      }>

    getResourcePathForKeys

    • getResourcePathForKeys<EntityT>(keys, _entityApi): string

    • Type Parameters

      Parameters

      Returns string

    getSelect

    • getSelect<EntityT>(selects): Partial<{
          select: string;
      }>

    • Type Parameters

      Parameters

      Returns Partial<{
          select: string;
      }>

    Settings

    Member Visibility

    On This Page

    Methods
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_odata_common.PropertyMetadata.html b/static/api/v3/interfaces/sap_cloud_sdk_odata_common.PropertyMetadata.html index 015fcdf3b1..7ada7f956d 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_odata_common.PropertyMetadata.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_odata_common.PropertyMetadata.html @@ -1,4 +1,4 @@ -PropertyMetadata | SAP Cloud SDK for JavaScript - v3.22.0

    Interface PropertyMetadata<ComplexT>

    Interface to represent meta information on a property of a complex type.

    +PropertyMetadata | SAP Cloud SDK for JavaScript - v3.22.1

    Interface PropertyMetadata<ComplexT>

    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? name originalName @@ -8,4 +8,4 @@

    originalName

    originalName: string

    Original name of the complex type property.

    type

    type:
        | EdmTypeCommon
        | ExclusiveEdmTypeV2
        | ExclusiveEdmTypeV4
        | ComplexTypeNamespace<any>

    Type of the complex type property.

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

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_odata_common.ReadResponse.html b/static/api/v3/interfaces/sap_cloud_sdk_odata_common.ReadResponse.html index 372b7c46b2..b4fc58bfd0 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_odata_common.ReadResponse.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_odata_common.ReadResponse.html @@ -1,4 +1,4 @@ -ReadResponse | SAP Cloud SDK for JavaScript - v3.22.0

    Interface ReadResponse<DeSerializersT>

    Represents a response to a retrieve request within a batch request.

    +ReadResponse | SAP Cloud SDK for JavaScript - v3.22.1

    Interface ReadResponse<DeSerializersT>

    Represents a response to a retrieve request within a batch request.

    interface ReadResponse<DeSerializersT> {
        as: (<EntityT>(entityApi: EntityApi<EntityT, DeSerializersT>) => 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 body @@ -16,4 +16,4 @@

    isError

    isError: (() => this is ErrorResponse)

    isReadResponse

    isReadResponse: (() => this is ReadResponse<DeSerializersT>)

    isSuccess

    isSuccess: (() => this is ReadResponse<DeSerializersT> | WriteResponses<DeSerializersT>)

    isWriteResponses

    isWriteResponses: (() => this is WriteResponses<DeSerializersT>)

    responseType

    responseType: "ReadResponse"

    Tag for identifying the type of a batch response.

    type

    type: EntityApi<EntityBase, DeSerializersT>

    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.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_odata_common.ResponseDataAccessor.html b/static/api/v3/interfaces/sap_cloud_sdk_odata_common.ResponseDataAccessor.html index 166b19d4c5..c091d611fa 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_odata_common.ResponseDataAccessor.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_odata_common.ResponseDataAccessor.html @@ -1,4 +1,4 @@ -ResponseDataAccessor | SAP Cloud SDK for JavaScript - v3.22.0

    Interface ResponseDataAccessor

    Interface containing the functions to extract the data from the response object. +ResponseDataAccessor | SAP Cloud SDK for JavaScript - v3.22.1

    Interface ResponseDataAccessor

    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) => any[]);
        getLinkedCollectionResult: ((data: any) => any[]);
        getSingleResult: ((data: any) => Record<string, any>);
        isCollectionResult: ((data: any) => boolean);
    }

    Properties

    getCollectionResult getLinkedCollectionResult @@ -12,4 +12,4 @@ The data is extracted by default from data.d.results.

    isCollectionResult

    isCollectionResult: ((data: any) => boolean)

    Checks if the response is an array-like object.

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

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_odata_common.Time.html b/static/api/v3/interfaces/sap_cloud_sdk_odata_common.Time.html index 7fa58460f2..963cad70df 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_odata_common.Time.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_odata_common.Time.html @@ -1,4 +1,4 @@ -Time | SAP Cloud SDK for JavaScript - v3.22.0

    Interface Time

    Interface to represent Time or Duration.

    +Time | SAP Cloud SDK for JavaScript - v3.22.1

    Interface Time

    Interface to represent Time or Duration.

    interface Time {
        hours: number;
        minutes: number;
        seconds: number;
    }

    Properties

    hours minutes seconds @@ -6,4 +6,4 @@

    minutes

    minutes: number

    The number of minutes.

    seconds

    seconds: number

    The number of seconds.

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

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_odata_common.WithBatchReference.html b/static/api/v3/interfaces/sap_cloud_sdk_odata_common.WithBatchReference.html index fa84a37489..e338ec4115 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_odata_common.WithBatchReference.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_odata_common.WithBatchReference.html @@ -1,7 +1,7 @@ -WithBatchReference | SAP Cloud SDK for JavaScript - v3.22.0

    Interface WithBatchReference

    Interface implemented by OData requests defining the getter and setter for the batch reference.

    +WithBatchReference | SAP Cloud SDK for JavaScript - v3.22.1

    Interface WithBatchReference

    Interface implemented by OData requests defining the getter and setter for the batch reference.

    interface WithBatchReference {
        getBatchReference: (() => BatchReference);
        setBatchId: ((id: string) => void);
    }

    Implemented by

    Properties

    getBatchReference setBatchId

    Properties

    getBatchReference

    getBatchReference: (() => BatchReference)

    Getter for the batch reference.

    setBatchId

    setBatchId: ((id: string) => void)

    Setter for the batch reference.

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

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_odata_common.WithETag.html b/static/api/v3/interfaces/sap_cloud_sdk_odata_common.WithETag.html index 25484d35c1..490f401425 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_odata_common.WithETag.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_odata_common.WithETag.html @@ -1,7 +1,7 @@ -WithETag | SAP Cloud SDK for JavaScript - v3.22.0

    Interface WithETag

    Interface implemented by OData requests needing ETagsto avoid conflicts in the persisted data like update or delete.

    +WithETag | SAP Cloud SDK for JavaScript - v3.22.1

    Interface WithETag

    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 versionIdentifierIgnored

    Properties

    eTag

    eTag: string

    Version identifier.

    versionIdentifierIgnored

    versionIdentifierIgnored: boolean

    Ignore the version identifier if set to true.

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

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_odata_common.WithGetAllRestrictions.html b/static/api/v3/interfaces/sap_cloud_sdk_odata_common.WithGetAllRestrictions.html index d02dfacd34..7f494b97ad 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_odata_common.WithGetAllRestrictions.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_odata_common.WithGetAllRestrictions.html @@ -1,4 +1,4 @@ -WithGetAllRestrictions | SAP Cloud SDK for JavaScript - v3.22.0

    Interface WithGetAllRestrictions<EntityT, DeSerializersT>

    Interface representing options on a getAll request like top or orderBy.

    +WithGetAllRestrictions | SAP Cloud SDK for JavaScript - v3.22.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

    filter orderBy selects @@ -10,4 +10,4 @@

    skip

    skip: number

    Skip a number of results in the requested set.

    top

    top: number

    Limit the number of results to the given number.

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

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_odata_common.WithKeys.html b/static/api/v3/interfaces/sap_cloud_sdk_odata_common.WithKeys.html index e7c4892623..b202655209 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_odata_common.WithKeys.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_odata_common.WithKeys.html @@ -1,5 +1,5 @@ -WithKeys | SAP Cloud SDK for JavaScript - v3.22.0

    Interface WithKeys

    Interface implemented by OData requests needing keys to identify an entity like getByKey, delete or update.

    +WithKeys | SAP Cloud SDK for JavaScript - v3.22.1

    Interface WithKeys

    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

    keys

    Properties

    keys

    keys: Record<string, any>

    Map containing the key name and value.

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

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_odata_common.WithSelection.html b/static/api/v3/interfaces/sap_cloud_sdk_odata_common.WithSelection.html index 42b22c1351..b2b4594288 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_odata_common.WithSelection.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_odata_common.WithSelection.html @@ -1,5 +1,5 @@ -WithSelection | SAP Cloud SDK for JavaScript - v3.22.0

    Interface WithSelection<EntityT, DeSerializersT>

    Interface implemented by OData requests returning data like getAll or getByKey.

    +WithSelection | SAP Cloud SDK for JavaScript - v3.22.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

    selects

    Properties

    selects

    selects: Selectable<EntityT, DeSerializersT>[]

    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.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_odata_common.WriteResponse.html b/static/api/v3/interfaces/sap_cloud_sdk_odata_common.WriteResponse.html index 9a7b881b32..736e29a9f7 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_odata_common.WriteResponse.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_odata_common.WriteResponse.html @@ -1,4 +1,4 @@ -WriteResponse | SAP Cloud SDK for JavaScript - v3.22.0

    Interface WriteResponse<DeSerializersT>

    Represents a single subresponse to a changeset request within a batch request.

    +WriteResponse | SAP Cloud SDK for JavaScript - v3.22.1

    Interface WriteResponse<DeSerializersT>

    Represents a single subresponse to a changeset request within a batch request.

    interface WriteResponse<DeSerializersT> {
        as?: (<EntityT>(entityApi: EntityApi<EntityT, DeSerializersT>) => 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? body? @@ -12,4 +12,4 @@

    responseType

    responseType: "WriteResponse"

    Tag for identifying the type of a batch response.

    Optionaltype

    type?: EntityApi<EntityBase, DeSerializersT>

    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.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_odata_common.WriteResponses.html b/static/api/v3/interfaces/sap_cloud_sdk_odata_common.WriteResponses.html index 3f79fea131..d170ac0dbb 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_odata_common.WriteResponses.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_odata_common.WriteResponses.html @@ -1,4 +1,4 @@ -WriteResponses | SAP Cloud SDK for JavaScript - v3.22.0

    Interface WriteResponses<DeSerializersT>

    Represents the list of responses for a change set in a batch request.

    +WriteResponses | SAP Cloud SDK for JavaScript - v3.22.1

    Interface WriteResponses<DeSerializersT>

    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 isReadResponse @@ -7,4 +7,4 @@ responses

    Properties

    isError

    isError: (() => this is ErrorResponse)

    isReadResponse

    isReadResponse: (() => this is ReadResponse<DeSerializersT>)

    isSuccess

    isSuccess: (() => this is WriteResponses<DeSerializersT> | ReadResponse<DeSerializersT>)

    isWriteResponses

    isWriteResponses: (() => this is WriteResponses<DeSerializersT>)

    responses

    responses: WriteResponse<DeSerializersT>[]

    List of responses for a change set in a batch request.

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

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_odata_v2.DeSerializers.html b/static/api/v3/interfaces/sap_cloud_sdk_odata_v2.DeSerializers.html index 5dec280615..f7be3be305 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_odata_v2.DeSerializers.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_odata_v2.DeSerializers.html @@ -1,4 +1,4 @@ -DeSerializers | SAP Cloud SDK for JavaScript - v3.22.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.

    +DeSerializers | SAP Cloud SDK for JavaScript - v3.22.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.

    interface DeSerializers<BinaryT, BooleanT, ByteT, DecimalT, DoubleT, FloatT, Int16T, Int32T, Int64T, GuidT, SByteT, SingleT, StringT, AnyT, DateTimeT, DateTimeOffsetT, TimeT> {
        Edm.Any: DeSerializer<AnyT>;
        Edm.Binary: DeSerializer<BinaryT>;
        Edm.Boolean: DeSerializer<BooleanT>;
        Edm.Byte: DeSerializer<ByteT>;
        Edm.DateTime: DeSerializer<DateTimeT>;
        Edm.DateTimeOffset: DeSerializer<DateTimeOffsetT>;
        Edm.Decimal: DeSerializer<DecimalT>;
        Edm.Double: DeSerializer<DoubleT>;
        Edm.Float: DeSerializer<FloatT>;
        Edm.Guid: DeSerializer<GuidT>;
        Edm.Int16: DeSerializer<Int16T>;
        Edm.Int32: DeSerializer<Int32T>;
        Edm.Int64: DeSerializer<Int64T>;
        Edm.SByte: DeSerializer<SByteT>;
        Edm.Single: DeSerializer<SingleT>;
        Edm.String: DeSerializer<StringT>;
        Edm.Time: DeSerializer<TimeT>;
    }

    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 Edm.Binary Edm.Boolean @@ -34,4 +34,4 @@

    Edm.String

    Edm.String: DeSerializer<StringT>

    DeSerializer for Edm.String to the generic type StringT.

    Edm.Time

    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.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_odata_v4.DeSerializers.html b/static/api/v3/interfaces/sap_cloud_sdk_odata_v4.DeSerializers.html index ad8232fa85..95bf043b02 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_odata_v4.DeSerializers.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_odata_v4.DeSerializers.html @@ -1,4 +1,4 @@ -DeSerializers | SAP Cloud SDK for JavaScript - v3.22.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.

    +DeSerializers | SAP Cloud SDK for JavaScript - v3.22.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.

    interface DeSerializers<BinaryT, BooleanT, ByteT, DecimalT, DoubleT, FloatT, Int16T, Int32T, Int64T, GuidT, SByteT, SingleT, StringT, AnyT, DateT, DateTimeOffsetT, DurationT, TimeOfDayT, EnumT> {
        Edm.Any: DeSerializer<AnyT>;
        Edm.Binary: DeSerializer<BinaryT>;
        Edm.Boolean: DeSerializer<BooleanT>;
        Edm.Byte: DeSerializer<ByteT>;
        Edm.Date: DeSerializer<DateT>;
        Edm.DateTimeOffset: DeSerializer<DateTimeOffsetT>;
        Edm.Decimal: DeSerializer<DecimalT>;
        Edm.Double: DeSerializer<DoubleT>;
        Edm.Duration: DeSerializer<DurationT>;
        Edm.Enum: DeSerializer<EnumT>;
        Edm.Float: DeSerializer<FloatT>;
        Edm.Guid: DeSerializer<GuidT>;
        Edm.Int16: DeSerializer<Int16T>;
        Edm.Int32: DeSerializer<Int32T>;
        Edm.Int64: DeSerializer<Int64T>;
        Edm.SByte: DeSerializer<SByteT>;
        Edm.Single: DeSerializer<SingleT>;
        Edm.String: DeSerializer<StringT>;
        Edm.TimeOfDay: DeSerializer<TimeOfDayT>;
    }

    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 Edm.Binary Edm.Boolean @@ -38,4 +38,4 @@

    Edm.String

    Edm.String: DeSerializer<StringT>

    DeSerializer for Edm.String to the generic type StringT.

    Edm.TimeOfDay

    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.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_openapi.OpenApiRequestParameters.html b/static/api/v3/interfaces/sap_cloud_sdk_openapi.OpenApiRequestParameters.html index ced7f291aa..fee95b9952 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_openapi.OpenApiRequestParameters.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_openapi.OpenApiRequestParameters.html @@ -1,4 +1,4 @@ -OpenApiRequestParameters | SAP Cloud SDK for JavaScript - v3.22.0

    Interface OpenApiRequestParameters

    Type of the request parameters to be passed to OpenApiRequestBuilder.

    +OpenApiRequestParameters | SAP Cloud SDK for JavaScript - v3.22.1

    Interface OpenApiRequestParameters

    Type of the request parameters to be passed to OpenApiRequestBuilder.

    interface OpenApiRequestParameters {
        body?: any;
        headerParameters?: Record<string, any>;
        pathParameters?: Record<string, any>;
        queryParameters?: Record<string, any>;
    }

    Properties

    body? headerParameters? pathParameters? @@ -8,4 +8,4 @@

    OptionalpathParameters

    pathParameters?: Record<string, any>

    Collection of path parameters.

    OptionalqueryParameters

    queryParameters?: Record<string, any>

    Collection of query parameters.

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

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_openapi_generator.OpenAPIGeneratorOptions.html b/static/api/v3/interfaces/sap_cloud_sdk_openapi_generator.OpenAPIGeneratorOptions.html index 6b9da419e2..4a4256ffaf 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_openapi_generator.OpenAPIGeneratorOptions.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_openapi_generator.OpenAPIGeneratorOptions.html @@ -1,7 +1,7 @@ -OpenAPIGeneratorOptions | SAP Cloud SDK for JavaScript - v3.22.0

    Interface OpenAPIGeneratorOptions

    Options to configure OpenAPI client generation when using the generator programmatically.

    +OpenAPIGeneratorOptions | SAP Cloud SDK for JavaScript - v3.22.1

    Interface OpenAPIGeneratorOptions

    Options to configure OpenAPI client generation when using the generator programmatically.

    interface OpenAPIGeneratorOptions {
        generateESM?: boolean;
        schemaPrefix?: string;
    }

    Properties

    generateESM? schemaPrefix?

    Properties

    OptionalgenerateESM

    generateESM?: boolean

    Whether to generate ECMAScript modules instead of CommonJS modules.

    Optional ExperimentalschemaPrefix

    schemaPrefix?: string

    Prefix all schema names with a value.

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

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_resilience.MiddlewareContext.html b/static/api/v3/interfaces/sap_cloud_sdk_resilience.MiddlewareContext.html index 8d71995a68..2a7de3a687 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_resilience.MiddlewareContext.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_resilience.MiddlewareContext.html @@ -1,7 +1,7 @@ -MiddlewareContext | SAP Cloud SDK for JavaScript - v3.22.0

    Interface MiddlewareContext<ArgumentT>

    Minimal Context of the middleware.

    +MiddlewareContext | SAP Cloud SDK for JavaScript - v3.22.1

    Interface MiddlewareContext<ArgumentT>

    Minimal Context of the middleware.

    interface MiddlewareContext<ArgumentT> {
        tenantId: undefined | string;
        uri: string;
    }

    Type Parameters

    • ArgumentT

    Hierarchy (view full)

    Properties

    tenantId uri

    Properties

    ReadonlytenantId

    tenantId: undefined | string

    Tenant identifier.

    Readonlyuri

    uri: string

    URI of the function passed to the middleware.

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

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_resilience.MiddlewareOptions.html b/static/api/v3/interfaces/sap_cloud_sdk_resilience.MiddlewareOptions.html index fd4df2415d..834d045e53 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_resilience.MiddlewareOptions.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_resilience.MiddlewareOptions.html @@ -1,7 +1,7 @@ -MiddlewareOptions | SAP Cloud SDK for JavaScript - v3.22.0

    Interface MiddlewareOptions<ArgumentT, ReturnT, ContextT>

    Input parameter of a middleware.

    +MiddlewareOptions | SAP Cloud SDK for JavaScript - v3.22.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

    context fn

    Properties

    context

    context: ContextT

    Context of the execution e.g. the request context or URL.

    Readonlyfn

    fn: MiddlewareFunction<ArgumentT, ReturnT>

    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.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_resilience.ResilienceOptions.html b/static/api/v3/interfaces/sap_cloud_sdk_resilience.ResilienceOptions.html index bb4e881b18..2e89f4c9b5 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_resilience.ResilienceOptions.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_resilience.ResilienceOptions.html @@ -1,4 +1,4 @@ -ResilienceOptions | SAP Cloud SDK for JavaScript - v3.22.0

    Interface ResilienceOptions

    Interface for Resilience Options.

    +ResilienceOptions | SAP Cloud SDK for JavaScript - v3.22.1

    Interface ResilienceOptions

    Interface for Resilience Options.

    interface ResilienceOptions {
        circuitBreaker?: boolean;
        retry?: number | boolean;
        timeout?: number | boolean;
    }

    Properties

    circuitBreaker? retry? timeout? @@ -11,4 +11,4 @@ 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.

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_test_util.GetTestDestinationOptions.html b/static/api/v3/interfaces/sap_cloud_sdk_test_util.GetTestDestinationOptions.html index 8185b3493f..8b2adac17b 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_test_util.GetTestDestinationOptions.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_test_util.GetTestDestinationOptions.html @@ -1,7 +1,7 @@ -GetTestDestinationOptions | SAP Cloud SDK for JavaScript - v3.22.0

    Interface GetTestDestinationOptions

    An interface to define systems.json and credentials.json for loading destinations.

    +GetTestDestinationOptions | SAP Cloud SDK for JavaScript - v3.22.1

    Interface GetTestDestinationOptions

    An interface to define systems.json and credentials.json for loading destinations.

    interface GetTestDestinationOptions {
        credentialsFilePath?: string;
        systemsFilePath?: string;
    }

    Properties

    credentialsFilePath? systemsFilePath?

    Properties

    OptionalcredentialsFilePath

    credentialsFilePath?: string

    The path of the credentials.json file.

    OptionalsystemsFilePath

    systemsFilePath?: string

    The path of the systems.json file.

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

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_util.LoggerOptions.html b/static/api/v3/interfaces/sap_cloud_sdk_util.LoggerOptions.html index 8fd8b27528..82631038ad 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_util.LoggerOptions.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_util.LoggerOptions.html @@ -1,5 +1,5 @@ -LoggerOptions | SAP Cloud SDK for JavaScript - v3.22.0

    Interface LoggerOptions

    Configurable logger options.

    +LoggerOptions | SAP Cloud SDK for JavaScript - v3.22.1

    Interface LoggerOptions

    Configurable logger options.

    interface LoggerOptions {
        level?: LogLevel;
    }

    Properties

    level?

    Properties

    Optionallevel

    level?: LogLevel

    The log level of the logger.

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

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/interfaces/sap_cloud_sdk_util.MessageContextObj.html b/static/api/v3/interfaces/sap_cloud_sdk_util.MessageContextObj.html index c36450017f..6e00469ee1 100644 --- a/static/api/v3/interfaces/sap_cloud_sdk_util.MessageContextObj.html +++ b/static/api/v3/interfaces/sap_cloud_sdk_util.MessageContextObj.html @@ -1,5 +1,5 @@ -MessageContextObj | SAP Cloud SDK for JavaScript - v3.22.0

    Interface MessageContextObj

    Log message context for a logger with additional custom data.

    +MessageContextObj | SAP Cloud SDK for JavaScript - v3.22.1

    Interface MessageContextObj

    Log message context for a logger with additional custom data.

    interface MessageContextObj {
        messageContext?: string;
        [key: string]: any;
    }

    Indexable

    • [key: string]: any

    Properties

    messageContext?

    Properties

    OptionalmessageContext

    messageContext?: string

    Name of the message context.

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

    -

    Settings

    Member Visibility

    On This Page

    Properties
    +

    Settings

    Member Visibility

    On This Page

    Properties
    diff --git a/static/api/v3/modules/sap_cloud_sdk_connectivity.html b/static/api/v3/modules/sap_cloud_sdk_connectivity.html index 06cd3f05f6..c8dbe6b2d9 100644 --- a/static/api/v3/modules/sap_cloud_sdk_connectivity.html +++ b/static/api/v3/modules/sap_cloud_sdk_connectivity.html @@ -1,4 +1,4 @@ -@sap-cloud-sdk/connectivity | SAP Cloud SDK for JavaScript - v3.22.0

    Module @sap-cloud-sdk/connectivity

    [[include:connectivity/README.md]]

    +@sap-cloud-sdk/connectivity | SAP Cloud SDK for JavaScript - v3.22.1

    Module @sap-cloud-sdk/connectivity

    [[include:connectivity/README.md]]

    Index

    Interfaces

    AllDestinations BasicProxyConfiguration CacheEntry @@ -71,4 +71,4 @@ transformServiceBindingToDestination useOrFetchDestination

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/modules/sap_cloud_sdk_generator.html b/static/api/v3/modules/sap_cloud_sdk_generator.html index a471f15720..11b8db4af3 100644 --- a/static/api/v3/modules/sap_cloud_sdk_generator.html +++ b/static/api/v3/modules/sap_cloud_sdk_generator.html @@ -1,5 +1,5 @@ -@sap-cloud-sdk/generator | SAP Cloud SDK for JavaScript - v3.22.0

    Module @sap-cloud-sdk/generator

    [[include:generator/README.md]]

    +@sap-cloud-sdk/generator | SAP Cloud SDK for JavaScript - v3.22.1

    Module @sap-cloud-sdk/generator

    [[include:generator/README.md]]

    Index

    Interfaces

    GeneratorOptions

    Functions

    generate

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/modules/sap_cloud_sdk_generator_common.html b/static/api/v3/modules/sap_cloud_sdk_generator_common.html index f5ac6d88e3..931fc59eff 100644 --- a/static/api/v3/modules/sap_cloud_sdk_generator_common.html +++ b/static/api/v3/modules/sap_cloud_sdk_generator_common.html @@ -1,4 +1,4 @@ -@sap-cloud-sdk/generator-common | SAP Cloud SDK for JavaScript - v3.22.0

    Module @sap-cloud-sdk/generator-common

    [[include:generator-common/README.md]]

    +@sap-cloud-sdk/generator-common | SAP Cloud SDK for JavaScript - v3.22.1

    Module @sap-cloud-sdk/generator-common

    [[include:generator-common/README.md]]

    Index

    Interfaces

    CommonGeneratorOptions

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/modules/sap_cloud_sdk_http_client.html b/static/api/v3/modules/sap_cloud_sdk_http_client.html index 220dff1615..2792c938ef 100644 --- a/static/api/v3/modules/sap_cloud_sdk_http_client.html +++ b/static/api/v3/modules/sap_cloud_sdk_http_client.html @@ -1,4 +1,4 @@ -@sap-cloud-sdk/http-client | SAP Cloud SDK for JavaScript - v3.22.0

    Module @sap-cloud-sdk/http-client

    [[include:http-client/README.md]]

    +@sap-cloud-sdk/http-client | SAP Cloud SDK for JavaScript - v3.22.1

    Module @sap-cloud-sdk/http-client

    [[include:http-client/README.md]]

    Index

    Interfaces

    CsrfMiddlewareOptions DestinationHttpRequestConfig HttpMiddlewareContext @@ -20,4 +20,4 @@ executeHttpRequest executeHttpRequestWithOrigin

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/modules/sap_cloud_sdk_mail_client.html b/static/api/v3/modules/sap_cloud_sdk_mail_client.html index ff2a787d77..4eabe91ad6 100644 --- a/static/api/v3/modules/sap_cloud_sdk_mail_client.html +++ b/static/api/v3/modules/sap_cloud_sdk_mail_client.html @@ -1,4 +1,4 @@ -@sap-cloud-sdk/mail-client | SAP Cloud SDK for JavaScript - v3.22.0

    Module @sap-cloud-sdk/mail-client

    [[include:mail-client/README.md]]

    +@sap-cloud-sdk/mail-client | SAP Cloud SDK for JavaScript - v3.22.1

    Module @sap-cloud-sdk/mail-client

    [[include:mail-client/README.md]]

    Index

    Interfaces

    Address Attachment AttachmentLike @@ -11,4 +11,4 @@

    Type Aliases

    Headers

    Functions

    sendMail

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/modules/sap_cloud_sdk_odata_common.html b/static/api/v3/modules/sap_cloud_sdk_odata_common.html index 4bc954d34c..dbf1e9a82b 100644 --- a/static/api/v3/modules/sap_cloud_sdk_odata_common.html +++ b/static/api/v3/modules/sap_cloud_sdk_odata_common.html @@ -1,4 +1,4 @@ -@sap-cloud-sdk/odata-common | SAP Cloud SDK for JavaScript - v3.22.0

    Module @sap-cloud-sdk/odata-common

    [[include:odata-common/README.md]]

    +@sap-cloud-sdk/odata-common | SAP Cloud SDK for JavaScript - v3.22.1

    Module @sap-cloud-sdk/odata-common

    [[include:odata-common/README.md]]

    References

    transformVariadicArgumentToArray

    Classes

    AllFields BatchChangeSet @@ -131,4 +131,4 @@ or throwErrorWhenReturnTypeIsUnionType

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

    -

    References

    transformVariadicArgumentToArray

    Re-exports transformVariadicArgumentToArray

    Settings

    Member Visibility

    On This Page

    References
    +

    References

    transformVariadicArgumentToArray

    Re-exports transformVariadicArgumentToArray

    Settings

    Member Visibility

    On This Page

    References
    diff --git a/static/api/v3/modules/sap_cloud_sdk_odata_v2.html b/static/api/v3/modules/sap_cloud_sdk_odata_v2.html index b1b8712c71..833156678a 100644 --- a/static/api/v3/modules/sap_cloud_sdk_odata_v2.html +++ b/static/api/v3/modules/sap_cloud_sdk_odata_v2.html @@ -1,4 +1,4 @@ -@sap-cloud-sdk/odata-v2 | SAP Cloud SDK for JavaScript - v3.22.0

    Module @sap-cloud-sdk/odata-v2

    [[include:odata-v2/README.md]]

    +@sap-cloud-sdk/odata-v2 | SAP Cloud SDK for JavaScript - v3.22.1

    Module @sap-cloud-sdk/odata-v2

    [[include:odata-v2/README.md]]

    References

    AllFields and asc @@ -71,4 +71,4 @@ transformReturnValueForEntityList transformReturnValueForUndefined

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

    -

    References

    AllFields

    Re-exports AllFields

    and

    Re-exports and

    asc

    Re-exports asc

    BatchChangeSet

    Re-exports BatchChangeSet

    ComplexTypeField

    Re-exports ComplexTypeField

    Constructable

    Re-exports Constructable

    ConstructorOrField

    Re-exports ConstructorOrField

    CustomOrDefaultTypeCommon

    Renames and re-exports CustomOrDefaultType

    desc

    Re-exports desc

    DeserializedType

    Re-exports DeserializedType

    DeSerializer

    Re-exports DeSerializer

    DeSerializersCommon

    Renames and re-exports DeSerializers

    EdmTypeField

    Re-exports EdmTypeField

    EntityApi

    Re-exports EntityApi

    EntityBase

    Re-exports EntityBase

    entityBuilder

    Re-exports entityBuilder

    EntityBuilder

    Re-exports EntityBuilder

    EntityBuilderType

    Re-exports EntityBuilderType

    ErrorResponse

    Re-exports ErrorResponse

    FieldBuilder

    Re-exports FieldBuilder

    FieldOptions

    Re-exports FieldOptions

    Link

    Re-exports Link

    not

    Re-exports not

    OneToManyLink

    Re-exports OneToManyLink

    OneToOneLink

    Re-exports OneToOneLink

    OperationParameter

    Re-exports OperationParameter

    or

    Re-exports or

    OrderableEdmTypeField

    Re-exports OrderableEdmTypeField

    PropertyMetadata

    Re-exports PropertyMetadata

    ReadResponseCommon

    Renames and re-exports ReadResponse

    RequestBuilder

    Re-exports RequestBuilder

    throwErrorWhenReturnTypeIsUnionType

    Re-exports throwErrorWhenReturnTypeIsUnionType

    Time

    Re-exports Time

    transformVariadicArgumentToArray

    Re-exports transformVariadicArgumentToArray

    WriteResponseCommon

    Renames and re-exports WriteResponse

    WriteResponsesCommon

    Renames and re-exports WriteResponses

    Settings

    Member Visibility

    On This Page

    References
    +

    References

    AllFields

    Re-exports AllFields

    and

    Re-exports and

    asc

    Re-exports asc

    BatchChangeSet

    Re-exports BatchChangeSet

    ComplexTypeField

    Re-exports ComplexTypeField

    Constructable

    Re-exports Constructable

    ConstructorOrField

    Re-exports ConstructorOrField

    CustomOrDefaultTypeCommon

    Renames and re-exports CustomOrDefaultType

    desc

    Re-exports desc

    DeserializedType

    Re-exports DeserializedType

    DeSerializer

    Re-exports DeSerializer

    DeSerializersCommon

    Renames and re-exports DeSerializers

    EdmTypeField

    Re-exports EdmTypeField

    EntityApi

    Re-exports EntityApi

    EntityBase

    Re-exports EntityBase

    entityBuilder

    Re-exports entityBuilder

    EntityBuilder

    Re-exports EntityBuilder

    EntityBuilderType

    Re-exports EntityBuilderType

    ErrorResponse

    Re-exports ErrorResponse

    FieldBuilder

    Re-exports FieldBuilder

    FieldOptions

    Re-exports FieldOptions

    Link

    Re-exports Link

    not

    Re-exports not

    OneToManyLink

    Re-exports OneToManyLink

    OneToOneLink

    Re-exports OneToOneLink

    OperationParameter

    Re-exports OperationParameter

    or

    Re-exports or

    OrderableEdmTypeField

    Re-exports OrderableEdmTypeField

    PropertyMetadata

    Re-exports PropertyMetadata

    ReadResponseCommon

    Renames and re-exports ReadResponse

    RequestBuilder

    Re-exports RequestBuilder

    throwErrorWhenReturnTypeIsUnionType

    Re-exports throwErrorWhenReturnTypeIsUnionType

    Time

    Re-exports Time

    transformVariadicArgumentToArray

    Re-exports transformVariadicArgumentToArray

    WriteResponseCommon

    Renames and re-exports WriteResponse

    WriteResponsesCommon

    Renames and re-exports WriteResponses

    Settings

    Member Visibility

    On This Page

    References
    diff --git a/static/api/v3/modules/sap_cloud_sdk_odata_v4.html b/static/api/v3/modules/sap_cloud_sdk_odata_v4.html index 981ba6473e..48a189f852 100644 --- a/static/api/v3/modules/sap_cloud_sdk_odata_v4.html +++ b/static/api/v3/modules/sap_cloud_sdk_odata_v4.html @@ -1,4 +1,4 @@ -@sap-cloud-sdk/odata-v4 | SAP Cloud SDK for JavaScript - v3.22.0

    Module @sap-cloud-sdk/odata-v4

    [[include:odata-v4/README.md]]

    +@sap-cloud-sdk/odata-v4 | SAP Cloud SDK for JavaScript - v3.22.1

    Module @sap-cloud-sdk/odata-v4

    [[include:odata-v4/README.md]]

    References

    AllFields and asc @@ -90,4 +90,4 @@ transformReturnValueForEntityList transformReturnValueForUndefined

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

    -

    References

    AllFields

    Re-exports AllFields

    and

    Re-exports and

    asc

    Re-exports asc

    BatchChangeSet

    Re-exports BatchChangeSet

    CollectionField

    Re-exports CollectionField

    ComplexTypeField

    Re-exports ComplexTypeField

    Constructable

    Re-exports Constructable

    ConstructorOrField

    Re-exports ConstructorOrField

    CustomOrDefaultTypeCommon

    Renames and re-exports CustomOrDefaultType

    desc

    Re-exports desc

    DeserializedType

    Re-exports DeserializedType

    DeSerializer

    Re-exports DeSerializer

    DeSerializersCommon

    Renames and re-exports DeSerializers

    EdmTypeField

    Re-exports EdmTypeField

    EntityApi

    Re-exports EntityApi

    EntityBase

    Re-exports EntityBase

    entityBuilder

    Re-exports entityBuilder

    EntityBuilder

    Re-exports EntityBuilder

    EntityBuilderType

    Re-exports EntityBuilderType

    EnumField

    Re-exports EnumField

    FieldBuilder

    Re-exports FieldBuilder

    FieldOptions

    Re-exports FieldOptions

    Link

    Re-exports Link

    not

    Re-exports not

    OneToManyLink

    Re-exports OneToManyLink

    OneToOneLink

    Re-exports OneToOneLink

    OperationParameter

    Re-exports OperationParameter

    or

    Re-exports or

    OrderableEdmTypeField

    Re-exports OrderableEdmTypeField

    PropertyMetadata

    Re-exports PropertyMetadata

    RequestBuilder

    Re-exports RequestBuilder

    throwErrorWhenReturnTypeIsUnionType

    Re-exports throwErrorWhenReturnTypeIsUnionType

    Time

    Re-exports Time

    transformVariadicArgumentToArray

    Re-exports transformVariadicArgumentToArray

    Settings

    Member Visibility

    On This Page

    References
    +

    References

    AllFields

    Re-exports AllFields

    and

    Re-exports and

    asc

    Re-exports asc

    BatchChangeSet

    Re-exports BatchChangeSet

    CollectionField

    Re-exports CollectionField

    ComplexTypeField

    Re-exports ComplexTypeField

    Constructable

    Re-exports Constructable

    ConstructorOrField

    Re-exports ConstructorOrField

    CustomOrDefaultTypeCommon

    Renames and re-exports CustomOrDefaultType

    desc

    Re-exports desc

    DeserializedType

    Re-exports DeserializedType

    DeSerializer

    Re-exports DeSerializer

    DeSerializersCommon

    Renames and re-exports DeSerializers

    EdmTypeField

    Re-exports EdmTypeField

    EntityApi

    Re-exports EntityApi

    EntityBase

    Re-exports EntityBase

    entityBuilder

    Re-exports entityBuilder

    EntityBuilder

    Re-exports EntityBuilder

    EntityBuilderType

    Re-exports EntityBuilderType

    EnumField

    Re-exports EnumField

    FieldBuilder

    Re-exports FieldBuilder

    FieldOptions

    Re-exports FieldOptions

    Link

    Re-exports Link

    not

    Re-exports not

    OneToManyLink

    Re-exports OneToManyLink

    OneToOneLink

    Re-exports OneToOneLink

    OperationParameter

    Re-exports OperationParameter

    or

    Re-exports or

    OrderableEdmTypeField

    Re-exports OrderableEdmTypeField

    PropertyMetadata

    Re-exports PropertyMetadata

    RequestBuilder

    Re-exports RequestBuilder

    throwErrorWhenReturnTypeIsUnionType

    Re-exports throwErrorWhenReturnTypeIsUnionType

    Time

    Re-exports Time

    transformVariadicArgumentToArray

    Re-exports transformVariadicArgumentToArray

    Settings

    Member Visibility

    On This Page

    References
    diff --git a/static/api/v3/modules/sap_cloud_sdk_openapi.html b/static/api/v3/modules/sap_cloud_sdk_openapi.html index e84b84fa85..cbf38f3442 100644 --- a/static/api/v3/modules/sap_cloud_sdk_openapi.html +++ b/static/api/v3/modules/sap_cloud_sdk_openapi.html @@ -1,5 +1,5 @@ -@sap-cloud-sdk/openapi | SAP Cloud SDK for JavaScript - v3.22.0

    Module @sap-cloud-sdk/openapi

    [[include:openapi/README.md]]

    +@sap-cloud-sdk/openapi | SAP Cloud SDK for JavaScript - v3.22.1

    Module @sap-cloud-sdk/openapi

    [[include:openapi/README.md]]

    Index

    Classes

    OpenApiRequestBuilder

    Interfaces

    OpenApiRequestParameters

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/modules/sap_cloud_sdk_openapi_generator.html b/static/api/v3/modules/sap_cloud_sdk_openapi_generator.html index d0969518ca..7798a4be6e 100644 --- a/static/api/v3/modules/sap_cloud_sdk_openapi_generator.html +++ b/static/api/v3/modules/sap_cloud_sdk_openapi_generator.html @@ -1,6 +1,6 @@ -@sap-cloud-sdk/openapi-generator | SAP Cloud SDK for JavaScript - v3.22.0

    Module @sap-cloud-sdk/openapi-generator

    [[include:openapi-generator/README.md]]

    +@sap-cloud-sdk/openapi-generator | SAP Cloud SDK for JavaScript - v3.22.1

    Module @sap-cloud-sdk/openapi-generator

    [[include:openapi-generator/README.md]]

    Index

    Interfaces

    OpenAPIGeneratorOptions

    Type Aliases

    GeneratorOptions

    Functions

    generate

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/modules/sap_cloud_sdk_resilience.html b/static/api/v3/modules/sap_cloud_sdk_resilience.html index 9f8f3e2150..a64a41223d 100644 --- a/static/api/v3/modules/sap_cloud_sdk_resilience.html +++ b/static/api/v3/modules/sap_cloud_sdk_resilience.html @@ -1,4 +1,4 @@ -@sap-cloud-sdk/resilience | SAP Cloud SDK for JavaScript - v3.22.0

    Module @sap-cloud-sdk/resilience

    [[include:resilience/README.md]]

    +@sap-cloud-sdk/resilience | SAP Cloud SDK for JavaScript - v3.22.1

    Module @sap-cloud-sdk/resilience

    [[include:resilience/README.md]]

    Index

    Interfaces

    MiddlewareContext MiddlewareOptions ResilienceOptions @@ -10,4 +10,4 @@ retry timeout

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/modules/sap_cloud_sdk_temporal_de_serializers.html b/static/api/v3/modules/sap_cloud_sdk_temporal_de_serializers.html index a4e8fd7011..7abfaaec97 100644 --- a/static/api/v3/modules/sap_cloud_sdk_temporal_de_serializers.html +++ b/static/api/v3/modules/sap_cloud_sdk_temporal_de_serializers.html @@ -1,5 +1,5 @@ -@sap-cloud-sdk/temporal-de-serializers | SAP Cloud SDK for JavaScript - v3.22.0

    Module @sap-cloud-sdk/temporal-de-serializers

    [[include:temporal-de-serializers/README.md]]

    +@sap-cloud-sdk/temporal-de-serializers | SAP Cloud SDK for JavaScript - v3.22.1

    Module @sap-cloud-sdk/temporal-de-serializers

    [[include:temporal-de-serializers/README.md]]

    Index

    Variables

    temporalDeSerializersV2 temporalDeSerializersV4

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/modules/sap_cloud_sdk_test_util.html b/static/api/v3/modules/sap_cloud_sdk_test_util.html index cdadaa9179..12d26eeb19 100644 --- a/static/api/v3/modules/sap_cloud_sdk_test_util.html +++ b/static/api/v3/modules/sap_cloud_sdk_test_util.html @@ -1,4 +1,4 @@ -@sap-cloud-sdk/test-util | SAP Cloud SDK for JavaScript - v3.22.0

    Module @sap-cloud-sdk/test-util

    [[include:test-util/README.md]]

    +@sap-cloud-sdk/test-util | SAP Cloud SDK for JavaScript - v3.22.1

    Module @sap-cloud-sdk/test-util

    [[include:test-util/README.md]]

    Index

    Interfaces

    GetTestDestinationOptions

    Functions

    getTestDestinationByAlias getTestDestinations @@ -8,4 +8,4 @@ unmockAllTestDestinations unmockTestDestination

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/modules/sap_cloud_sdk_util.html b/static/api/v3/modules/sap_cloud_sdk_util.html index af4235d05a..cc5f044e5c 100644 --- a/static/api/v3/modules/sap_cloud_sdk_util.html +++ b/static/api/v3/modules/sap_cloud_sdk_util.html @@ -1,4 +1,4 @@ -@sap-cloud-sdk/util | SAP Cloud SDK for JavaScript - v3.22.0

    Module @sap-cloud-sdk/util

    [[include:util/README.md]]

    +@sap-cloud-sdk/util | SAP Cloud SDK for JavaScript - v3.22.1

    Module @sap-cloud-sdk/util

    [[include:util/README.md]]

    Index

    Classes

    ErrorWithCause UniqueNameGenerator

    Interfaces

    LoggerOptions @@ -80,4 +80,4 @@ upperCaseSnakeCase zip

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_connectivity.AllDestinationOptions.html b/static/api/v3/types/sap_cloud_sdk_connectivity.AllDestinationOptions.html index 89005bae2a..4f58e947dd 100644 --- a/static/api/v3/types/sap_cloud_sdk_connectivity.AllDestinationOptions.html +++ b/static/api/v3/types/sap_cloud_sdk_connectivity.AllDestinationOptions.html @@ -1,3 +1,3 @@ -AllDestinationOptions | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias AllDestinationOptions

    AllDestinationOptions: Omit<DestinationOptions, "selectionStrategy" | "isolationStrategy">

    Options used to fetch all destinations.

    +AllDestinationOptions | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias AllDestinationOptions

    AllDestinationOptions: Omit<DestinationOptions, "selectionStrategy" | "isolationStrategy">

    Options used to fetch all destinations.

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_connectivity.AuthenticationType.html b/static/api/v3/types/sap_cloud_sdk_connectivity.AuthenticationType.html index 386fddbff8..bbcb698a67 100644 --- a/static/api/v3/types/sap_cloud_sdk_connectivity.AuthenticationType.html +++ b/static/api/v3/types/sap_cloud_sdk_connectivity.AuthenticationType.html @@ -1,3 +1,3 @@ -AuthenticationType | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias AuthenticationType

    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.22.1

    Type Alias AuthenticationType

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_connectivity.DestinationCacheInterface.html b/static/api/v3/types/sap_cloud_sdk_connectivity.DestinationCacheInterface.html index af13f02621..10b4f0d5b6 100644 --- a/static/api/v3/types/sap_cloud_sdk_connectivity.DestinationCacheInterface.html +++ b/static/api/v3/types/sap_cloud_sdk_connectivity.DestinationCacheInterface.html @@ -1,4 +1,4 @@ -DestinationCacheInterface | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias DestinationCacheInterface

    DestinationCacheInterface: AsyncCacheInterface<Destination>

    Type to implement custom destination caching. +DestinationCacheInterface | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias DestinationCacheInterface

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_connectivity.DestinationOptions.html b/static/api/v3/types/sap_cloud_sdk_connectivity.DestinationOptions.html index 15a9d3aedd..8e704eb85b 100644 --- a/static/api/v3/types/sap_cloud_sdk_connectivity.DestinationOptions.html +++ b/static/api/v3/types/sap_cloud_sdk_connectivity.DestinationOptions.html @@ -1,3 +1,3 @@ -DestinationOptions | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias DestinationOptions

    DestinationOptions: DestinationAccessorOptions & DestinationRetrievalOptions & VerifyJwtOptions

    Options used when fetching destinations. Encompasses DestinationAccessorOptions, DestinationRetrievalOptions and VerifyJwtOptions.

    +DestinationOptions | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias DestinationOptions

    DestinationOptions: DestinationAccessorOptions & DestinationRetrievalOptions & VerifyJwtOptions

    Options used when fetching destinations. Encompasses DestinationAccessorOptions, DestinationRetrievalOptions and VerifyJwtOptions.

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_connectivity.DestinationOrFetchOptions.html b/static/api/v3/types/sap_cloud_sdk_connectivity.DestinationOrFetchOptions.html index 88b48921bd..cda0487130 100644 --- a/static/api/v3/types/sap_cloud_sdk_connectivity.DestinationOrFetchOptions.html +++ b/static/api/v3/types/sap_cloud_sdk_connectivity.DestinationOrFetchOptions.html @@ -1,3 +1,3 @@ -DestinationOrFetchOptions | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias DestinationOrFetchOptions

    DestinationOrFetchOptions: Xor<Destination, DestinationFetchOptions & DestinationForServiceBindingOptions>

    Type that is either a HttpDestination or (XOR) & DestinationForServiceBindingOptions.

    +DestinationOrFetchOptions | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias DestinationOrFetchOptions

    DestinationOrFetchOptions: Xor<Destination, DestinationFetchOptions & DestinationForServiceBindingOptions>

    Type that is either a HttpDestination or (XOR) & DestinationForServiceBindingOptions.

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_connectivity.DestinationProxyType.html b/static/api/v3/types/sap_cloud_sdk_connectivity.DestinationProxyType.html index 1fe8b5facc..fd7f06e5d9 100644 --- a/static/api/v3/types/sap_cloud_sdk_connectivity.DestinationProxyType.html +++ b/static/api/v3/types/sap_cloud_sdk_connectivity.DestinationProxyType.html @@ -1,3 +1,3 @@ -DestinationProxyType | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias DestinationProxyType

    DestinationProxyType:
        | "OnPremise"
        | "Internet"
        | "PrivateLink"
        | null

    Represents the proxy type on a destination.

    +DestinationProxyType | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias DestinationProxyType

    DestinationProxyType:
        | "OnPremise"
        | "Internet"
        | "PrivateLink"
        | null

    Represents the proxy type on a destination.

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_connectivity.DestinationRetrievalOptions.html b/static/api/v3/types/sap_cloud_sdk_connectivity.DestinationRetrievalOptions.html index f6aaf164f4..be1f874412 100644 --- a/static/api/v3/types/sap_cloud_sdk_connectivity.DestinationRetrievalOptions.html +++ b/static/api/v3/types/sap_cloud_sdk_connectivity.DestinationRetrievalOptions.html @@ -1,8 +1,8 @@ -DestinationRetrievalOptions | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias DestinationRetrievalOptions

    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.22.1

    Type Alias DestinationRetrievalOptions

    DestinationRetrievalOptions: CachingOptions & {
        isolationStrategy?: IsolationStrategy;
        retry?: boolean;
    }

    Options to use while fetching destinations. Encompasses both CachingOptions and isolation strategy.

    Type declaration

    • OptionalisolationStrategy?: IsolationStrategy

      The isolation strategy used for caching destinations. For the available options, see IsolationStrategy. By default, 'tenant-user' is set.

    • Optionalretry?: 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.

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_connectivity.DestinationSelectionStrategy.html b/static/api/v3/types/sap_cloud_sdk_connectivity.DestinationSelectionStrategy.html index ba8b514f46..ec5074eab3 100644 --- a/static/api/v3/types/sap_cloud_sdk_connectivity.DestinationSelectionStrategy.html +++ b/static/api/v3/types/sap_cloud_sdk_connectivity.DestinationSelectionStrategy.html @@ -1,4 +1,4 @@ -DestinationSelectionStrategy | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias DestinationSelectionStrategy

    DestinationSelectionStrategy: ((allDestinations: AllDestinations, destinationName: string) => Destination | null)

    Function to implement the selection strategy of the retrieved destination. +DestinationSelectionStrategy | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias DestinationSelectionStrategy

    DestinationSelectionStrategy: ((allDestinations: AllDestinations, destinationName: string) => 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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_connectivity.DestinationWithName.html b/static/api/v3/types/sap_cloud_sdk_connectivity.DestinationWithName.html index d69796e1ee..1da492f5b2 100644 --- a/static/api/v3/types/sap_cloud_sdk_connectivity.DestinationWithName.html +++ b/static/api/v3/types/sap_cloud_sdk_connectivity.DestinationWithName.html @@ -1,3 +1,3 @@ -DestinationWithName | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias DestinationWithName

    DestinationWithName: Destination & {
        name: string;
    }

    Represents a destination with a name property.

    +DestinationWithName | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias DestinationWithName

    DestinationWithName: Destination & {
        name: string;
    }

    Represents a destination with a name property.

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_connectivity.DestinationWithoutToken.html b/static/api/v3/types/sap_cloud_sdk_connectivity.DestinationWithoutToken.html index 3a55251814..d4514d7772 100644 --- a/static/api/v3/types/sap_cloud_sdk_connectivity.DestinationWithoutToken.html +++ b/static/api/v3/types/sap_cloud_sdk_connectivity.DestinationWithoutToken.html @@ -1,3 +1,3 @@ -DestinationWithoutToken | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias DestinationWithoutToken

    DestinationWithoutToken: Omit<Destination, "authTokens">

    A Destination which does not contain | authTokens.

    +DestinationWithoutToken | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias DestinationWithoutToken

    DestinationWithoutToken: Omit<Destination, "authTokens">

    A Destination which does not contain | authTokens.

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_connectivity.HttpDestination.html b/static/api/v3/types/sap_cloud_sdk_connectivity.HttpDestination.html index 00231b6e20..e089da28c0 100644 --- a/static/api/v3/types/sap_cloud_sdk_connectivity.HttpDestination.html +++ b/static/api/v3/types/sap_cloud_sdk_connectivity.HttpDestination.html @@ -1,3 +1,3 @@ -HttpDestination | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias HttpDestination

    HttpDestination: Destination & {
        url: string;
    }

    Destination for HTTP request where the URL is mandatory.

    +HttpDestination | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias HttpDestination

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_connectivity.HttpDestinationOrFetchOptions.html b/static/api/v3/types/sap_cloud_sdk_connectivity.HttpDestinationOrFetchOptions.html index 8460797da4..5c44f8bc2a 100644 --- a/static/api/v3/types/sap_cloud_sdk_connectivity.HttpDestinationOrFetchOptions.html +++ b/static/api/v3/types/sap_cloud_sdk_connectivity.HttpDestinationOrFetchOptions.html @@ -1,3 +1,3 @@ -HttpDestinationOrFetchOptions | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias HttpDestinationOrFetchOptions

    HttpDestinationOrFetchOptions: Xor<HttpDestination, DestinationFetchOptions & DestinationForServiceBindingOptions>

    Type that is either a HttpDestination or (XOR) & DestinationForServiceBindingOptions.

    +HttpDestinationOrFetchOptions | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias HttpDestinationOrFetchOptions

    HttpDestinationOrFetchOptions: Xor<HttpDestination, DestinationFetchOptions & DestinationForServiceBindingOptions>

    Type that is either a HttpDestination or (XOR) & DestinationForServiceBindingOptions.

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_connectivity.IsolationStrategy.html b/static/api/v3/types/sap_cloud_sdk_connectivity.IsolationStrategy.html index 346c6a1fa7..e6728bbdb5 100644 --- a/static/api/v3/types/sap_cloud_sdk_connectivity.IsolationStrategy.html +++ b/static/api/v3/types/sap_cloud_sdk_connectivity.IsolationStrategy.html @@ -1,4 +1,4 @@ -IsolationStrategy | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias IsolationStrategy

    IsolationStrategy: "tenant" | "tenant-user"

    Represents the isolation strategy in the destination cache. +IsolationStrategy | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias IsolationStrategy

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_connectivity.PartialDestinationFetchOptions.html b/static/api/v3/types/sap_cloud_sdk_connectivity.PartialDestinationFetchOptions.html index ff063c1218..f1427f37e1 100644 --- a/static/api/v3/types/sap_cloud_sdk_connectivity.PartialDestinationFetchOptions.html +++ b/static/api/v3/types/sap_cloud_sdk_connectivity.PartialDestinationFetchOptions.html @@ -1,7 +1,7 @@ -PartialDestinationFetchOptions | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias PartialDestinationFetchOptions

    PartialDestinationFetchOptions: {
        jwt?: JwtPayload;
    } & CachingOptions

    Type declaration

    • Optionaljwt?: JwtPayload

      The JWT used to fetch destinations. +PartialDestinationFetchOptions | SAP Cloud SDK for JavaScript - v3.22.1

      Type Alias PartialDestinationFetchOptions

      PartialDestinationFetchOptions: {
          jwt?: JwtPayload;
      } & CachingOptions

      Type declaration

      • Optionaljwt?: 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.

      -

      Settings

      Member Visibility
      +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_connectivity.Protocol.html b/static/api/v3/types/sap_cloud_sdk_connectivity.Protocol.html index b7796ea010..60e8178b94 100644 --- a/static/api/v3/types/sap_cloud_sdk_connectivity.Protocol.html +++ b/static/api/v3/types/sap_cloud_sdk_connectivity.Protocol.html @@ -1,3 +1,3 @@ -Protocol | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias Protocol

    Protocol: "http" | "https" | "socks"

    Supported web protocols for requests made by the SAP Cloud SDK.

    +Protocol | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias Protocol

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_connectivity.RegisterDestinationOptions.html b/static/api/v3/types/sap_cloud_sdk_connectivity.RegisterDestinationOptions.html index f8cf08fa81..41500c6977 100644 --- a/static/api/v3/types/sap_cloud_sdk_connectivity.RegisterDestinationOptions.html +++ b/static/api/v3/types/sap_cloud_sdk_connectivity.RegisterDestinationOptions.html @@ -1,3 +1,3 @@ -RegisterDestinationOptions | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias RegisterDestinationOptions

    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.22.1

    Type Alias RegisterDestinationOptions

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_connectivity.ServiceBindingTransformFunction.html b/static/api/v3/types/sap_cloud_sdk_connectivity.ServiceBindingTransformFunction.html index 5e81085634..866a879529 100644 --- a/static/api/v3/types/sap_cloud_sdk_connectivity.ServiceBindingTransformFunction.html +++ b/static/api/v3/types/sap_cloud_sdk_connectivity.ServiceBindingTransformFunction.html @@ -1,3 +1,3 @@ -ServiceBindingTransformFunction | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias ServiceBindingTransformFunction

    ServiceBindingTransformFunction: ((service: Service, options?: ServiceBindingTransformOptions) => Promise<Destination>)

    Type of the function to transform the service binding.

    +ServiceBindingTransformFunction | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias ServiceBindingTransformFunction

    ServiceBindingTransformFunction: ((service: Service, options?: ServiceBindingTransformOptions) => Promise<Destination>)

    Type of the function to transform the service binding.

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_connectivity.ServiceBindingTransformOptions.html b/static/api/v3/types/sap_cloud_sdk_connectivity.ServiceBindingTransformOptions.html index 79cf1ee6a8..6471d17e9d 100644 --- a/static/api/v3/types/sap_cloud_sdk_connectivity.ServiceBindingTransformOptions.html +++ b/static/api/v3/types/sap_cloud_sdk_connectivity.ServiceBindingTransformOptions.html @@ -1,4 +1,4 @@ -ServiceBindingTransformOptions | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias ServiceBindingTransformOptions

    ServiceBindingTransformOptions: {
        jwt?: JwtPayload;
    } & CachingOptions

    Represents options passed to the service binding transform function.

    +ServiceBindingTransformOptions | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias ServiceBindingTransformOptions

    ServiceBindingTransformOptions: {
        jwt?: JwtPayload;
    } & CachingOptions

    Represents options passed to the service binding transform function.

    Type declaration

    • Optionaljwt?: JwtPayload

      The JWT payload used to fetch destinations.

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

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_connectivity.ServiceCredentials.html b/static/api/v3/types/sap_cloud_sdk_connectivity.ServiceCredentials.html index b205bcc397..dabf1a3d46 100644 --- a/static/api/v3/types/sap_cloud_sdk_connectivity.ServiceCredentials.html +++ b/static/api/v3/types/sap_cloud_sdk_connectivity.ServiceCredentials.html @@ -1,3 +1,3 @@ -ServiceCredentials | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias ServiceCredentials

    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.22.1

    Type Alias ServiceCredentials

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_connectivity.XsuaaServiceCredentials.html b/static/api/v3/types/sap_cloud_sdk_connectivity.XsuaaServiceCredentials.html index b048be4091..7a51288c83 100644 --- a/static/api/v3/types/sap_cloud_sdk_connectivity.XsuaaServiceCredentials.html +++ b/static/api/v3/types/sap_cloud_sdk_connectivity.XsuaaServiceCredentials.html @@ -1,3 +1,3 @@ -XsuaaServiceCredentials | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias XsuaaServiceCredentials

    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.22.1

    Type Alias XsuaaServiceCredentials

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_http_client.CustomRequestConfig.html b/static/api/v3/types/sap_cloud_sdk_http_client.CustomRequestConfig.html index c59647f59b..899b98ffc4 100644 --- a/static/api/v3/types/sap_cloud_sdk_http_client.CustomRequestConfig.html +++ b/static/api/v3/types/sap_cloud_sdk_http_client.CustomRequestConfig.html @@ -1,3 +1,3 @@ -CustomRequestConfig | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias CustomRequestConfig

    CustomRequestConfig: Pick<HttpRequestConfig,
        | "middleware"
        | "maxContentLength"
        | "proxy"
        | "httpAgent"
        | "httpsAgent"
        | "parameterEncoder"> & Record<string, any>

    The type for parameter in Custom Request Configuration.

    +CustomRequestConfig | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias CustomRequestConfig

    CustomRequestConfig: Pick<HttpRequestConfig,
        | "middleware"
        | "maxContentLength"
        | "proxy"
        | "httpAgent"
        | "httpsAgent"
        | "parameterEncoder"> & Record<string, any>

    The type for parameter in Custom Request Configuration.

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_http_client.HttpMiddleware.html b/static/api/v3/types/sap_cloud_sdk_http_client.HttpMiddleware.html index d35c95b45e..7951275a62 100644 --- a/static/api/v3/types/sap_cloud_sdk_http_client.HttpMiddleware.html +++ b/static/api/v3/types/sap_cloud_sdk_http_client.HttpMiddleware.html @@ -1,3 +1,3 @@ -HttpMiddleware | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias HttpMiddleware

    HttpMiddleware: Middleware<HttpRequestConfig, HttpResponse, HttpMiddlewareContext>

    Middleware for http requests.

    +HttpMiddleware | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias HttpMiddleware

    HttpMiddleware: Middleware<HttpRequestConfig, HttpResponse, HttpMiddlewareContext>

    Middleware for http requests.

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_http_client.HttpMiddlewareOptions.html b/static/api/v3/types/sap_cloud_sdk_http_client.HttpMiddlewareOptions.html index 7a12d7570f..72c7699477 100644 --- a/static/api/v3/types/sap_cloud_sdk_http_client.HttpMiddlewareOptions.html +++ b/static/api/v3/types/sap_cloud_sdk_http_client.HttpMiddlewareOptions.html @@ -1,3 +1,3 @@ -HttpMiddlewareOptions | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias HttpMiddlewareOptions

    HttpMiddlewareOptions: MiddlewareOptions<HttpRequestConfig, HttpResponse, HttpMiddlewareContext>

    Options for http middleware.

    +HttpMiddlewareOptions | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias HttpMiddlewareOptions

    HttpMiddlewareOptions: MiddlewareOptions<HttpRequestConfig, HttpResponse, HttpMiddlewareContext>

    Options for http middleware.

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_http_client.HttpRequestConfig.html b/static/api/v3/types/sap_cloud_sdk_http_client.HttpRequestConfig.html index 0cc8481445..5e4b8aab26 100644 --- a/static/api/v3/types/sap_cloud_sdk_http_client.HttpRequestConfig.html +++ b/static/api/v3/types/sap_cloud_sdk_http_client.HttpRequestConfig.html @@ -1,3 +1,3 @@ -HttpRequestConfig | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias HttpRequestConfig

    HttpRequestConfig: HttpRequestConfigBase & {
        headers?: Record<string, any>;
        params?: Record<string, any>;
    }

    This interface is compatible with RawAxiosRequestConfig.

    +HttpRequestConfig | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias HttpRequestConfig

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_http_client.HttpRequestConfigWithOrigin.html b/static/api/v3/types/sap_cloud_sdk_http_client.HttpRequestConfigWithOrigin.html index f2466fe5a2..23b131bff6 100644 --- a/static/api/v3/types/sap_cloud_sdk_http_client.HttpRequestConfigWithOrigin.html +++ b/static/api/v3/types/sap_cloud_sdk_http_client.HttpRequestConfigWithOrigin.html @@ -1,4 +1,4 @@ -HttpRequestConfigWithOrigin | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias HttpRequestConfigWithOrigin

    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.22.1

    Type Alias HttpRequestConfigWithOrigin

    HttpRequestConfigWithOrigin: HttpRequestConfigBase & {
        headers?: OriginOptions;
        params?: OriginOptions;
    }

    This interface is similar to HttpRequestConfig. In addition, the headers and params can be defined with "origin" information.

    See

    OriginOptions

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_http_client.Method.html b/static/api/v3/types/sap_cloud_sdk_http_client.Method.html index d8bb6a499a..76f7312f28 100644 --- a/static/api/v3/types/sap_cloud_sdk_http_client.Method.html +++ b/static/api/v3/types/sap_cloud_sdk_http_client.Method.html @@ -1,3 +1,3 @@ -Method | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias Method

    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.22.1

    Type Alias Method

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_http_client.ParameterEncoder.html b/static/api/v3/types/sap_cloud_sdk_http_client.ParameterEncoder.html index 7a8801cb1b..f007660547 100644 --- a/static/api/v3/types/sap_cloud_sdk_http_client.ParameterEncoder.html +++ b/static/api/v3/types/sap_cloud_sdk_http_client.ParameterEncoder.html @@ -1,3 +1,3 @@ -ParameterEncoder | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias ParameterEncoder

    ParameterEncoder: ((parameter: Record<string, any>) => Record<string, any>)

    Type of the parameter encoder.

    +ParameterEncoder | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias ParameterEncoder

    ParameterEncoder: ((parameter: Record<string, any>) => Record<string, any>)

    Type of the parameter encoder.

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_mail_client.Headers.html b/static/api/v3/types/sap_cloud_sdk_mail_client.Headers.html index 120b63b5c2..75846293a7 100644 --- a/static/api/v3/types/sap_cloud_sdk_mail_client.Headers.html +++ b/static/api/v3/types/sap_cloud_sdk_mail_client.Headers.html @@ -1,5 +1,5 @@ -Headers | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias Headers

    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.22.1

    Type Alias Headers

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_common.BatchSubRequestPathType.html b/static/api/v3/types/sap_cloud_sdk_odata_common.BatchSubRequestPathType.html index 5f6c19f3e4..a74f0a5e66 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_common.BatchSubRequestPathType.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_common.BatchSubRequestPathType.html @@ -1,3 +1,3 @@ -BatchSubRequestPathType | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias BatchSubRequestPathType

    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.22.1

    Type Alias BatchSubRequestPathType

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_common.ChangesetBuilderTypes.html b/static/api/v3/types/sap_cloud_sdk_odata_common.ChangesetBuilderTypes.html index 81f874696e..efd1452e86 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_common.ChangesetBuilderTypes.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_common.ChangesetBuilderTypes.html @@ -1,4 +1,4 @@ -ChangesetBuilderTypes | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias ChangesetBuilderTypes<DeSerializersT>

    ChangesetBuilderTypes<DeSerializersT>:
        | CreateRequestBuilderBase<EntityBase, DeSerializersT>
        | UpdateRequestBuilderBase<EntityBase, DeSerializersT>
        | DeleteRequestBuilderBase<EntityBase, DeSerializersT>
        | Omit<OperationRequestBuilderBase<any, any, any>, "execute">

    Some function imports contain not serializable entities and the execute() method is removed from them. +ChangesetBuilderTypes | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias ChangesetBuilderTypes<DeSerializersT>

    ChangesetBuilderTypes<DeSerializersT>:
        | CreateRequestBuilderBase<EntityBase, DeSerializersT>
        | UpdateRequestBuilderBase<EntityBase, DeSerializersT>
        | DeleteRequestBuilderBase<EntityBase, DeSerializersT>
        | Omit<OperationRequestBuilderBase<any, any, any>, "execute">

    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

    Settings

    Member Visibility
    +

    Type Parameters

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_common.CollectionFieldType.html b/static/api/v3/types/sap_cloud_sdk_odata_common.CollectionFieldType.html index d61ee84836..e7d7399faa 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_common.CollectionFieldType.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_common.CollectionFieldType.html @@ -1,5 +1,5 @@ -CollectionFieldType | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias CollectionFieldType<CollectionFieldT>

    CollectionFieldType<CollectionFieldT>: CollectionFieldT | ComplexTypeNamespace<CollectionFieldT>

    Convenience type to reflect the type of the instances of a collection field. +CollectionFieldType | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias CollectionFieldType<CollectionFieldT>

    CollectionFieldType<CollectionFieldT>: CollectionFieldT | ComplexTypeNamespace<CollectionFieldT>

    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.

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

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_common.ComplexTypeFieldConstructor.html b/static/api/v3/types/sap_cloud_sdk_odata_common.ComplexTypeFieldConstructor.html index b3bd6ccdae..a7c7d41573 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_common.ComplexTypeFieldConstructor.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_common.ComplexTypeFieldConstructor.html @@ -1,3 +1,3 @@ -ComplexTypeFieldConstructor | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias ComplexTypeFieldConstructor<ComplexTypeFieldT, EntityT, DeSerializersT, ComplexT, NullableT, SelectableT>

    ComplexTypeFieldConstructor<ComplexTypeFieldT, EntityT, DeSerializersT, ComplexT, NullableT, SelectableT>: (new (fieldName: string, fieldOf: ConstructorOrField<EntityT>, deSerializers: DeSerializersT, fieldOptions?: FieldOptions<NullableT, SelectableT>) => ComplexTypeFieldT)

    Constructor function creating a ComplexTypeField.

    +ComplexTypeFieldConstructor | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias ComplexTypeFieldConstructor<ComplexTypeFieldT, EntityT, DeSerializersT, ComplexT, NullableT, SelectableT>

    ComplexTypeFieldConstructor<ComplexTypeFieldT, EntityT, DeSerializersT, ComplexT, NullableT, SelectableT>: (new (fieldName: string, fieldOf: ConstructorOrField<EntityT>, deSerializers: DeSerializersT, fieldOptions?: FieldOptions<NullableT, SelectableT>) => ComplexTypeFieldT)

    Constructor function creating a ComplexTypeField.

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

    -

    Type Parameters

    Settings

    Member Visibility
    +

    Type Parameters

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_common.ComplexTypePropertyFields.html b/static/api/v3/types/sap_cloud_sdk_odata_common.ComplexTypePropertyFields.html index 084477d815..30415f0e3c 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_common.ComplexTypePropertyFields.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_common.ComplexTypePropertyFields.html @@ -1,4 +1,4 @@ -ComplexTypePropertyFields | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias ComplexTypePropertyFields<EntityT>

    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.22.1

    Type Alias ComplexTypePropertyFields<EntityT>

    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

    Settings

    Member Visibility
    +

    Type Parameters

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_common.ConstructorOrField.html b/static/api/v3/types/sap_cloud_sdk_odata_common.ConstructorOrField.html index d025147d03..0a576fb5ea 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_common.ConstructorOrField.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_common.ConstructorOrField.html @@ -1,3 +1,3 @@ -ConstructorOrField | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias ConstructorOrField<EntityT, ComplexT>

    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.22.1

    Type Alias ConstructorOrField<EntityT, ComplexT>

    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

    Settings

    Member Visibility
    +

    Type Parameters

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_common.CustomOrDefaultType.html b/static/api/v3/types/sap_cloud_sdk_odata_common.CustomOrDefaultType.html index 1d4de82cd3..5e01093dfd 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_common.CustomOrDefaultType.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_common.CustomOrDefaultType.html @@ -1,7 +1,7 @@ -CustomOrDefaultType | SAP Cloud SDK for JavaScript - v3.22.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. +CustomOrDefaultType | SAP Cloud SDK for JavaScript - v3.22.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. 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.

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

      -
    • DefaultDeSerializersT extends DefaultDeSerializers

    Settings

    Member Visibility
    +
  • DefaultDeSerializersT extends DefaultDeSerializers

    • Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_common.DefaultDeSerializers.html b/static/api/v3/types/sap_cloud_sdk_odata_common.DefaultDeSerializers.html index 37492eee2b..fc756b3422 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_common.DefaultDeSerializers.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_common.DefaultDeSerializers.html @@ -1,3 +1,3 @@ -DefaultDeSerializers | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias DefaultDeSerializers

    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.22.1

    Type Alias DefaultDeSerializers

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_common.DeserializedType.html b/static/api/v3/types/sap_cloud_sdk_odata_common.DeserializedType.html index e3fb4e5867..4da462d5cf 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_common.DeserializedType.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_common.DeserializedType.html @@ -1,5 +1,5 @@ -DeserializedType | SAP Cloud SDK for JavaScript - v3.22.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.

    +DeserializedType | SAP Cloud SDK for JavaScript - v3.22.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.

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

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_common.EdmTypeCommon.html b/static/api/v3/types/sap_cloud_sdk_odata_common.EdmTypeCommon.html index 3c59f496c4..1ce9582020 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_common.EdmTypeCommon.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_common.EdmTypeCommon.html @@ -1,3 +1,3 @@ -EdmTypeCommon | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias EdmTypeCommon

    EdmTypeCommon: EdmTypeSameConverters | EdmTypeDifferentConverters

    Includes all EDM types which are shared between OData version 2 and 4.

    +EdmTypeCommon | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias EdmTypeCommon

    EdmTypeCommon: EdmTypeSameConverters | EdmTypeDifferentConverters

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_common.EdmTypeDifferentConverters.html b/static/api/v3/types/sap_cloud_sdk_odata_common.EdmTypeDifferentConverters.html index 64a2262f65..89ddc36df8 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_common.EdmTypeDifferentConverters.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_common.EdmTypeDifferentConverters.html @@ -1,3 +1,3 @@ -EdmTypeDifferentConverters | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias EdmTypeDifferentConverters

    EdmTypeDifferentConverters: "Edm.DateTimeOffset"

    Includes all EDM types that have different converters for OData version 2 and 4.

    +EdmTypeDifferentConverters | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias EdmTypeDifferentConverters

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_common.EdmTypeSameConverters.html b/static/api/v3/types/sap_cloud_sdk_odata_common.EdmTypeSameConverters.html index 7ff99435ee..ccbcc9b5c7 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_common.EdmTypeSameConverters.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_common.EdmTypeSameConverters.html @@ -1,3 +1,3 @@ -EdmTypeSameConverters | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias EdmTypeSameConverters

    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.22.1

    Type Alias EdmTypeSameConverters

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_common.EdmTypeShared.html b/static/api/v3/types/sap_cloud_sdk_odata_common.EdmTypeShared.html index 7343859ddc..d734673a11 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_common.EdmTypeShared.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_common.EdmTypeShared.html @@ -1,4 +1,4 @@ -EdmTypeShared | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias EdmTypeShared<VersionT>

    EdmTypeShared<VersionT>: VersionT extends any
        ? EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4
        : EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4

    Represents all valid EDM types for one OData version (either v2 or v4). +EdmTypeShared | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias EdmTypeShared<VersionT>

    EdmTypeShared<VersionT>: VersionT extends any
        ? EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4
        : EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4

    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

    Settings

    Member Visibility
    +

    Type Parameters

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_common.EntityBuilderType.html b/static/api/v3/types/sap_cloud_sdk_odata_common.EntityBuilderType.html index 81022efb5a..ce6da0ca92 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_common.EntityBuilderType.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_common.EntityBuilderType.html @@ -1,3 +1,3 @@ -EntityBuilderType | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias EntityBuilderType<EntityT, DeSerializersT>

    EntityBuilderType<EntityT, DeSerializersT>: {
        [property in keyof Required<Omit<EntityT, keyof EntityBase>>]: ((value: EntityT[property]) => EntityBuilderType<EntityT, DeSerializersT>)
    } & EntityBuilder<EntityT, DeSerializersT>

    Entity builder type with check for EntityT.

    +EntityBuilderType | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias EntityBuilderType<EntityT, DeSerializersT>

    EntityBuilderType<EntityT, DeSerializersT>: {
        [property in keyof Required<Omit<EntityT, keyof EntityBase>>]: ((value: EntityT[property]) => 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

    Settings

    Member Visibility
    +

    Type Parameters

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_common.EntityType.html b/static/api/v3/types/sap_cloud_sdk_odata_common.EntityType.html index b7708cb09c..4df4be7460 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_common.EntityType.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_common.EntityType.html @@ -1,3 +1,3 @@ -EntityType | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias EntityType<forExtraction>

    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.22.1

    Type Alias EntityType<forExtraction>

    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

    Settings

    Member Visibility
    +

    Type Parameters

    • forExtraction

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_common.EntityTypeFromFieldOf.html b/static/api/v3/types/sap_cloud_sdk_odata_common.EntityTypeFromFieldOf.html index 0f66e2dd93..0326d3cb3a 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_common.EntityTypeFromFieldOf.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_common.EntityTypeFromFieldOf.html @@ -1,3 +1,3 @@ -EntityTypeFromFieldOf | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias EntityTypeFromFieldOf<FieldOfT>

    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.22.1

    Type Alias EntityTypeFromFieldOf<FieldOfT>

    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

    Settings

    Member Visibility
    +

    Type Parameters

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_common.ExclusiveEdmTypeV2.html b/static/api/v3/types/sap_cloud_sdk_odata_common.ExclusiveEdmTypeV2.html index 445ce7f30a..f729fe1adf 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_common.ExclusiveEdmTypeV2.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_common.ExclusiveEdmTypeV2.html @@ -1,3 +1,3 @@ -ExclusiveEdmTypeV2 | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias ExclusiveEdmTypeV2

    ExclusiveEdmTypeV2: "Edm.DateTime" | "Edm.Time"

    Exclusive EDM types for OData v2.

    +ExclusiveEdmTypeV2 | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias ExclusiveEdmTypeV2

    ExclusiveEdmTypeV2: "Edm.DateTime" | "Edm.Time"

    Exclusive EDM types for OData v2.

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_common.ExclusiveEdmTypeV4.html b/static/api/v3/types/sap_cloud_sdk_odata_common.ExclusiveEdmTypeV4.html index 527dd39a3f..658a433832 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_common.ExclusiveEdmTypeV4.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_common.ExclusiveEdmTypeV4.html @@ -1,3 +1,3 @@ -ExclusiveEdmTypeV4 | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias ExclusiveEdmTypeV4

    ExclusiveEdmTypeV4:
        | "Edm.Date"
        | "Edm.Duration"
        | "Edm.TimeOfDay"
        | "Edm.Enum"

    Exclusive EDM types for OData v4.

    +ExclusiveEdmTypeV4 | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias ExclusiveEdmTypeV4

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_common.Expandable.html b/static/api/v3/types/sap_cloud_sdk_odata_common.Expandable.html index 61e06a7f85..c81e146567 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_common.Expandable.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_common.Expandable.html @@ -1,4 +1,4 @@ -Expandable | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias Expandable<EntityT, DeSerializersT, LinkedEntityApiT>

    Expandable<EntityT, DeSerializersT, LinkedEntityApiT>: ODataVersionOf<EntityT> extends "v2"
        ? never
        : OneToManyLink<EntityT, DeSerializersT, LinkedEntityApiT> | OneToOneLink<EntityT, DeSerializersT, LinkedEntityApiT> | AllFields<EntityT>

    Represents everything that can be used in an .expand statement. Only relevant for OData v4 requests.

    +Expandable | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias Expandable<EntityT, DeSerializersT, LinkedEntityApiT>

    Expandable<EntityT, DeSerializersT, LinkedEntityApiT>: ODataVersionOf<EntityT> extends "v2"
        ? never
        : OneToManyLink<EntityT, DeSerializersT, LinkedEntityApiT> | OneToOneLink<EntityT, DeSerializersT, LinkedEntityApiT> | AllFields<EntityT>

    Represents everything that can be used in an .expand statement. Only relevant for OData v4 requests.

    Type Parameters

    Settings

    Member Visibility
    +
  • DeSerializersT extends DeSerializers
  • LinkedEntityApiT extends EntityApi<EntityBase, DeSerializersT> = EntityApi<EntityBase, DeSerializersT>

    • Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_common.FieldTypeByEdmType.html b/static/api/v3/types/sap_cloud_sdk_odata_common.FieldTypeByEdmType.html index b4bf77068e..9a21301ebe 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_common.FieldTypeByEdmType.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_common.FieldTypeByEdmType.html @@ -1,5 +1,5 @@ -FieldTypeByEdmType | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias FieldTypeByEdmType<T, EdmT, NullableT>

    FieldTypeByEdmType<T, EdmT, NullableT>: NullableFieldType<DeserializedType<T, EdmT>, NullableT>

    Convenience type that maps the given EDM type to a field type. It also considers whether the field is nullable.

    +FieldTypeByEdmType | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias FieldTypeByEdmType<T, EdmT, NullableT>

    FieldTypeByEdmType<T, EdmT, NullableT>: NullableFieldType<DeserializedType<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

    • T extends DeSerializers
    • EdmT extends EdmTypeShared<"any">

      EDM type of the field. Deprecated: 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.

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_common.FilterFunctionParameterType.html b/static/api/v3/types/sap_cloud_sdk_odata_common.FilterFunctionParameterType.html index d73527a898..c000dacf4f 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_common.FilterFunctionParameterType.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_common.FilterFunctionParameterType.html @@ -1,3 +1,3 @@ -FilterFunctionParameterType | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias FilterFunctionParameterType<EntityT>

    FilterFunctionParameterType<EntityT>:
        | FilterFunctionPrimitiveParameterType
        | Field<EntityT, boolean, boolean>
        | FilterFunction<EntityT, any>
        | FilterFunctionPrimitiveParameterType[]

    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.22.1

    Type Alias FilterFunctionParameterType<EntityT>

    FilterFunctionParameterType<EntityT>:
        | FilterFunctionPrimitiveParameterType
        | Field<EntityT, boolean, boolean>
        | FilterFunction<EntityT, any>
        | FilterFunctionPrimitiveParameterType[]

    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

    Settings

    Member Visibility
    +

    Type Parameters

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_common.FilterFunctionPrimitiveParameterType.html b/static/api/v3/types/sap_cloud_sdk_odata_common.FilterFunctionPrimitiveParameterType.html index ecc642b291..2de35d36c1 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_common.FilterFunctionPrimitiveParameterType.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_common.FilterFunctionPrimitiveParameterType.html @@ -1,3 +1,3 @@ -FilterFunctionPrimitiveParameterType | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias FilterFunctionPrimitiveParameterType

    FilterFunctionPrimitiveParameterType: number | string | moment.Moment

    Primitive type of a parameter of a filter function.

    +FilterFunctionPrimitiveParameterType | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias FilterFunctionPrimitiveParameterType

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_common.FilterFunctionTypes.html b/static/api/v3/types/sap_cloud_sdk_odata_common.FilterFunctionTypes.html index c6ef84f192..99adc4747d 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_common.FilterFunctionTypes.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_common.FilterFunctionTypes.html @@ -1,3 +1,3 @@ -FilterFunctionTypes | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias FilterFunctionTypes

    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.22.1

    Type Alias FilterFunctionTypes

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_common.FilterLambdaOperator.html b/static/api/v3/types/sap_cloud_sdk_odata_common.FilterLambdaOperator.html index aa902b8906..0c4f8bfee5 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_common.FilterLambdaOperator.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_common.FilterLambdaOperator.html @@ -1,4 +1,4 @@ -FilterLambdaOperator | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias FilterLambdaOperator

    FilterLambdaOperator: "any" | "all"

    Possible operators used to filter one to many relations in OData v4. +FilterLambdaOperator | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias FilterLambdaOperator

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_common.FilterOperator.html b/static/api/v3/types/sap_cloud_sdk_odata_common.FilterOperator.html index 3f1750e79a..ac137a8c03 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_common.FilterOperator.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_common.FilterOperator.html @@ -1,3 +1,3 @@ -FilterOperator | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias FilterOperator

    FilterOperator: FilterOperatorString | FilterOperatorBoolean | FilterOperatorNumber

    Union type of the filter operators for string, boolean and number types.

    +FilterOperator | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias FilterOperator

    FilterOperator: FilterOperatorString | FilterOperatorBoolean | FilterOperatorNumber

    Union type of the filter operators for string, boolean and number types.

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_common.FilterOperatorBoolean.html b/static/api/v3/types/sap_cloud_sdk_odata_common.FilterOperatorBoolean.html index 33934d2d91..5ae2052b66 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_common.FilterOperatorBoolean.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_common.FilterOperatorBoolean.html @@ -1,4 +1,4 @@ -FilterOperatorBoolean | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias FilterOperatorBoolean

    FilterOperatorBoolean: "eq" | "ne"

    Union type representing all filter operations for boolean properties. +FilterOperatorBoolean | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias FilterOperatorBoolean

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_common.FilterOperatorNumber.html b/static/api/v3/types/sap_cloud_sdk_odata_common.FilterOperatorNumber.html index f9d2c81278..915281274a 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_common.FilterOperatorNumber.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_common.FilterOperatorNumber.html @@ -1,3 +1,3 @@ -FilterOperatorNumber | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias FilterOperatorNumber

    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.22.1

    Type Alias FilterOperatorNumber

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_common.FilterOperatorString.html b/static/api/v3/types/sap_cloud_sdk_odata_common.FilterOperatorString.html index 6830fddb7f..8168cc921f 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_common.FilterOperatorString.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_common.FilterOperatorString.html @@ -1,3 +1,3 @@ -FilterOperatorString | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias FilterOperatorString

    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.22.1

    Type Alias FilterOperatorString

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_common.Filterable.html b/static/api/v3/types/sap_cloud_sdk_odata_common.Filterable.html index aa6d40a360..56ceea3b82 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_common.Filterable.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_common.Filterable.html @@ -1,4 +1,4 @@ -Filterable | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias Filterable<EntityT, DeSerializersT, LinkedEntityApiT>

    Filterable<EntityT, DeSerializersT, LinkedEntityApiT>:
        | Filter<EntityT, DeSerializersT, any>
        | FilterLink<EntityT, DeSerializersT, LinkedEntityApiT>
        | FilterList<EntityT, DeSerializersT>
        | FilterLambdaExpression<EntityT, DeSerializersT>
        | UnaryFilter<EntityT, DeSerializersT>
        | BooleanFilterFunction<EntityT>
        | OneToManyLink<EntityT, DeSerializersT, LinkedEntityApiT>

    A union of all types that can be used for filtering.

    +Filterable | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias Filterable<EntityT, DeSerializersT, LinkedEntityApiT>

    Filterable<EntityT, DeSerializersT, LinkedEntityApiT>:
        | Filter<EntityT, DeSerializersT, any>
        | FilterLink<EntityT, DeSerializersT, LinkedEntityApiT>
        | FilterList<EntityT, DeSerializersT>
        | FilterLambdaExpression<EntityT, DeSerializersT>
        | UnaryFilter<EntityT, DeSerializersT>
        | BooleanFilterFunction<EntityT>
        | OneToManyLink<EntityT, DeSerializersT, LinkedEntityApiT>

    A union of all types that can be used for filtering.

    Type Parameters

    Settings

    Member Visibility
    +
  • DeSerializersT extends DeSerializers
  • LinkedEntityApiT extends EntityApi<EntityBase, DeSerializersT> = EntityApi<EntityBase, any>

    • Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_common.FromJsonType.html b/static/api/v3/types/sap_cloud_sdk_odata_common.FromJsonType.html index c0f6aeac27..d20e62b80d 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_common.FromJsonType.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_common.FromJsonType.html @@ -1,6 +1,6 @@ -FromJsonType | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias FromJsonType<JsonT>

    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.22.1

    Type Alias FromJsonType<JsonT>

    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.

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

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_common.FunctionImportParameters.html b/static/api/v3/types/sap_cloud_sdk_odata_common.FunctionImportParameters.html index 872d6be1e2..5c0d663899 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_common.FunctionImportParameters.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_common.FunctionImportParameters.html @@ -1,3 +1,3 @@ -FunctionImportParameters | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias FunctionImportParameters<ParametersT>

    FunctionImportParameters<ParametersT>: OperationParameters<ParametersT>

    Type Parameters

    • ParametersT

    Deprecated

    Since 3.3.0. Use OperationParameters instead.

    +FunctionImportParameters | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias FunctionImportParameters<ParametersT>

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_common.IsSelectableField.html b/static/api/v3/types/sap_cloud_sdk_odata_common.IsSelectableField.html index d072018e76..d431f38ed1 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_common.IsSelectableField.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_common.IsSelectableField.html @@ -1,4 +1,4 @@ -IsSelectableField | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias IsSelectableField<FieldOfT>

    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.

    +IsSelectableField | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias IsSelectableField<FieldOfT>

    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.

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_common.NonNullishType.html b/static/api/v3/types/sap_cloud_sdk_odata_common.NonNullishType.html index a7685b144b..5e09704293 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_common.NonNullishType.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_common.NonNullishType.html @@ -1,3 +1,3 @@ -NonNullishType | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias NonNullishType<T>

    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.22.1

    Type Alias NonNullishType<T>

    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

    Settings

    Member Visibility
    +

    Type Parameters

    • T

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_common.NullableFieldType.html b/static/api/v3/types/sap_cloud_sdk_odata_common.NullableFieldType.html index 1de666d685..a6473dcee9 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_common.NullableFieldType.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_common.NullableFieldType.html @@ -1,5 +1,5 @@ -NullableFieldType | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias NullableFieldType<FieldT, NullableT>

    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.

    +NullableFieldType | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias NullableFieldType<FieldT, NullableT>

    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.

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_common.NullishTypes.html b/static/api/v3/types/sap_cloud_sdk_odata_common.NullishTypes.html index a7926202c6..aab2f96d90 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_common.NullishTypes.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_common.NullishTypes.html @@ -1,3 +1,3 @@ -NullishTypes | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias NullishTypes

    NullishTypes: null | undefined

    Union type of null and undefined.

    +NullishTypes | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias NullishTypes

    NullishTypes: null | undefined

    Union type of null and undefined.

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_common.ODataVersionOf.html b/static/api/v3/types/sap_cloud_sdk_odata_common.ODataVersionOf.html index 66913ed94a..218c06381b 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_common.ODataVersionOf.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_common.ODataVersionOf.html @@ -1,3 +1,3 @@ -ODataVersionOf | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias ODataVersionOf<T>

    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.22.1

    Type Alias ODataVersionOf<T>

    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

    Settings

    Member Visibility
    +

    Type Parameters

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_common.OperationParameters.html b/static/api/v3/types/sap_cloud_sdk_odata_common.OperationParameters.html index 69828c480d..4d631c805b 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_common.OperationParameters.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_common.OperationParameters.html @@ -1,4 +1,4 @@ -OperationParameters | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias OperationParameters<ParametersT>

    OperationParameters<ParametersT>: {
        [K in keyof ParametersT]: OperationParameter<ParametersT[K]>
    }

    Internal representation of all parameters of an operation as a map.

    +OperationParameters | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias OperationParameters<ParametersT>

    OperationParameters<ParametersT>: {
        [K in keyof ParametersT]: OperationParameter<ParametersT[K]>
    }

    Internal representation of all parameters of an operation as a map.

    Type Parameters

    • ParametersT

      External representation of all parameters

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

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_common.OrderType.html b/static/api/v3/types/sap_cloud_sdk_odata_common.OrderType.html index 428d70aac1..35d8c34e76 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_common.OrderType.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_common.OrderType.html @@ -1,3 +1,3 @@ -OrderType | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias OrderType

    OrderType: "asc" | "desc"

    Is either ascending or descending.

    +OrderType | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias OrderType

    OrderType: "asc" | "desc"

    Is either ascending or descending.

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_common.Orderable.html b/static/api/v3/types/sap_cloud_sdk_odata_common.Orderable.html index 7fcf6c95ff..a3ec6f0df2 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_common.Orderable.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_common.Orderable.html @@ -1,4 +1,4 @@ -Orderable | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias Orderable<EntityT, LinkedEntityApiT>

    Orderable<EntityT, LinkedEntityApiT>: Order<EntityT> | OrderLink<EntityT, LinkedEntityApiT>

    A union of all types that can be used for ordering.

    +Orderable | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias Orderable<EntityT, LinkedEntityApiT>

    Orderable<EntityT, LinkedEntityApiT>: Order<EntityT> | OrderLink<EntityT, LinkedEntityApiT>

    A union of all types that can be used for ordering.

    Type Parameters

    Settings

    Member Visibility
    +
  • LinkedEntityApiT extends EntityApi<EntityBase> = EntityApi<EntityBase>

    • Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_common.OrderableAndOrderableInput.html b/static/api/v3/types/sap_cloud_sdk_odata_common.OrderableAndOrderableInput.html index b1774e5f4f..550998594f 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_common.OrderableAndOrderableInput.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_common.OrderableAndOrderableInput.html @@ -1,4 +1,4 @@ -OrderableAndOrderableInput | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias OrderableAndOrderableInput<EntityT, DeSerializersT, LinkedEntityApiT, LinkedEntityApiTOptional>

    OrderableAndOrderableInput<EntityT, DeSerializersT, LinkedEntityApiT, LinkedEntityApiTOptional>: Orderable<EntityT, LinkedEntityApiTOptional> | OrderableInput<EntityT, DeSerializersT, LinkedEntityApiT>

    A union of Orderable and OrderableInput.

    +OrderableAndOrderableInput | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias OrderableAndOrderableInput<EntityT, DeSerializersT, LinkedEntityApiT, LinkedEntityApiTOptional>

    OrderableAndOrderableInput<EntityT, DeSerializersT, LinkedEntityApiT, LinkedEntityApiTOptional>: Orderable<EntityT, LinkedEntityApiTOptional> | OrderableInput<EntityT, DeSerializersT, LinkedEntityApiT>

    A union of Orderable and OrderableInput.

    Type Parameters

    Settings

    Member Visibility
    +
  • DeSerializersT extends DeSerializers
  • LinkedEntityApiT extends EntityApi<EntityBase, DeSerializersT>
  • LinkedEntityApiTOptional extends EntityApi<EntityBase> = EntityApi<EntityBase>

    • Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_common.OrderableEdmType.html b/static/api/v3/types/sap_cloud_sdk_odata_common.OrderableEdmType.html index e90b72c817..44edf5a8fc 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_common.OrderableEdmType.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_common.OrderableEdmType.html @@ -1,3 +1,3 @@ -OrderableEdmType | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias OrderableEdmType

    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.22.1

    Type Alias OrderableEdmType

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_common.OrderableInput.html b/static/api/v3/types/sap_cloud_sdk_odata_common.OrderableInput.html index 305e2508cd..c515fad56d 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_common.OrderableInput.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_common.OrderableInput.html @@ -1,4 +1,4 @@ -OrderableInput | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias OrderableInput<EntityT, DeSerializersT, LinkedEntityApiT>

    OrderableInput<EntityT, DeSerializersT, LinkedEntityApiT>: SimpleTypeFields<EntityT> | Link<EntityT, DeSerializersT, LinkedEntityApiT> | ComplexTypePropertyFields<EntityT>

    A union of all types that can be used as input for ordering.

    +OrderableInput | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias OrderableInput<EntityT, DeSerializersT, LinkedEntityApiT>

    OrderableInput<EntityT, DeSerializersT, LinkedEntityApiT>: SimpleTypeFields<EntityT> | Link<EntityT, DeSerializersT, LinkedEntityApiT> | ComplexTypePropertyFields<EntityT>

    A union of all types that can be used as input for ordering.

    Type Parameters

    Settings

    Member Visibility
    +
  • DeSerializersT extends DeSerializers
  • LinkedEntityApiT extends EntityApi<EntityBase, DeSerializersT>

    • Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_common.PureEntityType.html b/static/api/v3/types/sap_cloud_sdk_odata_common.PureEntityType.html index e31d2cb856..0ad221f341 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_common.PureEntityType.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_common.PureEntityType.html @@ -1,3 +1,3 @@ -PureEntityType | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias PureEntityType<T>

    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.22.1

    Type Alias PureEntityType<T>

    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

    Settings

    Member Visibility
    +

    Type Parameters

    • T

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_common.RequestMethodType.html b/static/api/v3/types/sap_cloud_sdk_odata_common.RequestMethodType.html index 3261ab41fb..5b330685c9 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_common.RequestMethodType.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_common.RequestMethodType.html @@ -1,3 +1,3 @@ -RequestMethodType | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias RequestMethodType

    RequestMethodType:
        | "get"
        | "post"
        | "patch"
        | "delete"
        | "put"

    Set of possible request methods.

    +RequestMethodType | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias RequestMethodType

    RequestMethodType:
        | "get"
        | "post"
        | "patch"
        | "delete"
        | "put"

    Set of possible request methods.

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_common.Selectable.html b/static/api/v3/types/sap_cloud_sdk_odata_common.Selectable.html index 1da20f3924..909789f26e 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_common.Selectable.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_common.Selectable.html @@ -1,3 +1,3 @@ -Selectable | SAP Cloud SDK for JavaScript - v3.22.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.

    +Selectable | SAP Cloud SDK for JavaScript - v3.22.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.

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

    -

    Type Parameters

    Settings

    Member Visibility
    +

    Type Parameters

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_common.SimpleTypeFields.html b/static/api/v3/types/sap_cloud_sdk_odata_common.SimpleTypeFields.html index 4bef059e18..3ddf916369 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_common.SimpleTypeFields.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_common.SimpleTypeFields.html @@ -1,3 +1,3 @@ -SimpleTypeFields | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias SimpleTypeFields<EntityT>

    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.22.1

    Type Alias SimpleTypeFields<EntityT>

    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

    Settings

    Member Visibility
    +

    Type Parameters

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_v2.BatchResponse.html b/static/api/v3/types/sap_cloud_sdk_odata_v2.BatchResponse.html index 6fcc28ee88..f31001d297 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_v2.BatchResponse.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_v2.BatchResponse.html @@ -1,3 +1,3 @@ -BatchResponse | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias BatchResponse<DeSerializersT>

    BatchResponse<DeSerializersT>: ReadResponse<DeSerializersT> | WriteResponses<DeSerializersT> | ErrorResponse

    Union of the possible batch responses: ReadResponseCommon, WriteResponsesCommon and @sap-cloud-sdk/odata-common!ErrorResponse.

    +BatchResponse | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias BatchResponse<DeSerializersT>

    BatchResponse<DeSerializersT>: ReadResponse<DeSerializersT> | WriteResponses<DeSerializersT> | ErrorResponse

    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

    Settings

    Member Visibility
    +

    Type Parameters

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_v2.CustomDeSerializers.html b/static/api/v3/types/sap_cloud_sdk_odata_v2.CustomDeSerializers.html index c8c7b67554..47e58c57e8 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_v2.CustomDeSerializers.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_v2.CustomDeSerializers.html @@ -1,3 +1,3 @@ -CustomDeSerializers | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias CustomDeSerializers<T>

    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.22.1

    Type Alias CustomDeSerializers<T>

    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

    Settings

    Member Visibility
    +

    Type Parameters

    • T

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_v2.CustomOrDefaultType.html b/static/api/v3/types/sap_cloud_sdk_odata_v2.CustomOrDefaultType.html index 73805cef96..a9c32c3849 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_v2.CustomOrDefaultType.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_v2.CustomOrDefaultType.html @@ -1,7 +1,7 @@ -CustomOrDefaultType | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias CustomOrDefaultType<CustomDeSerializerT, EdmT>

    CustomOrDefaultType<CustomDeSerializerT, EdmT>: CustomOrDefaultType<CustomDeSerializerT, EdmT, DefaultDeSerializers>

    Infers the deserialized type for an EDM type, based on custom (de-)serializers. +CustomOrDefaultType | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias CustomOrDefaultType<CustomDeSerializerT, EdmT>

    CustomOrDefaultType<CustomDeSerializerT, EdmT>: CustomOrDefaultType<CustomDeSerializerT, EdmT, DefaultDeSerializers>

    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.

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

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_v2.DefaultDeSerializers.html b/static/api/v3/types/sap_cloud_sdk_odata_v2.DefaultDeSerializers.html index ac2e4ae3f3..4952f9d383 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_v2.DefaultDeSerializers.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_v2.DefaultDeSerializers.html @@ -1,3 +1,3 @@ -DefaultDeSerializers | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias DefaultDeSerializers

    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.22.1

    Type Alias DefaultDeSerializers

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_v2.FilterFunctionsType.html b/static/api/v3/types/sap_cloud_sdk_odata_v2.FilterFunctionsType.html index 546a3fe813..88155b454c 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_v2.FilterFunctionsType.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_v2.FilterFunctionsType.html @@ -1,3 +1,3 @@ -FilterFunctionsType | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias FilterFunctionsType

    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.22.1

    Type Alias FilterFunctionsType

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_v4.ActionImportParameters.html b/static/api/v3/types/sap_cloud_sdk_odata_v4.ActionImportParameters.html index dd790b809b..e4e9856238 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_v4.ActionImportParameters.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_v4.ActionImportParameters.html @@ -1,3 +1,3 @@ -ActionImportParameters | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias ActionImportParameters<ParametersT>

    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.22.1

    Type Alias ActionImportParameters<ParametersT>

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_v4.BatchResponse.html b/static/api/v3/types/sap_cloud_sdk_odata_v4.BatchResponse.html index df11029a76..637f647b55 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_v4.BatchResponse.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_v4.BatchResponse.html @@ -1,3 +1,3 @@ -BatchResponse | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias BatchResponse<DeSerializersT>

    BatchResponse<DeSerializersT>: ReadResponse<DeSerializersT> | WriteResponses<DeSerializersT> | ErrorResponse

    Union of the possible batch responses: ReadResponseCommon, WriteResponsesCommon and @sap-cloud-sdk/odata-common!ErrorResponse.

    +BatchResponse | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias BatchResponse<DeSerializersT>

    BatchResponse<DeSerializersT>: ReadResponse<DeSerializersT> | WriteResponses<DeSerializersT> | ErrorResponse

    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

    Settings

    Member Visibility
    +

    Type Parameters

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_v4.CustomDeSerializers.html b/static/api/v3/types/sap_cloud_sdk_odata_v4.CustomDeSerializers.html index 56717d1547..4083298e9f 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_v4.CustomDeSerializers.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_v4.CustomDeSerializers.html @@ -1,3 +1,3 @@ -CustomDeSerializers | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias CustomDeSerializers<T>

    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.22.1

    Type Alias CustomDeSerializers<T>

    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

    Settings

    Member Visibility
    +

    Type Parameters

    • T

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_v4.CustomOrDefaultType.html b/static/api/v3/types/sap_cloud_sdk_odata_v4.CustomOrDefaultType.html index fc48fb6969..88f0666e1c 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_v4.CustomOrDefaultType.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_v4.CustomOrDefaultType.html @@ -1,7 +1,7 @@ -CustomOrDefaultType | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias CustomOrDefaultType<CustomDeSerializerT, EdmT>

    CustomOrDefaultType<CustomDeSerializerT, EdmT>: CustomOrDefaultType<CustomDeSerializerT, EdmT, DefaultDeSerializers>

    Infers the deserialized type for an EDM type, based on custom (de-)serializers. +CustomOrDefaultType | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias CustomOrDefaultType<CustomDeSerializerT, EdmT>

    CustomOrDefaultType<CustomDeSerializerT, EdmT>: CustomOrDefaultType<CustomDeSerializerT, EdmT, DefaultDeSerializers>

    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.

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

      -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_v4.DefaultDeSerializers.html b/static/api/v3/types/sap_cloud_sdk_odata_v4.DefaultDeSerializers.html index e4e4691b36..fba39bdaa7 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_v4.DefaultDeSerializers.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_v4.DefaultDeSerializers.html @@ -1,3 +1,3 @@ -DefaultDeSerializers | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias DefaultDeSerializers

    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.22.1

    Type Alias DefaultDeSerializers

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_odata_v4.FilterFunctionTypes.html b/static/api/v3/types/sap_cloud_sdk_odata_v4.FilterFunctionTypes.html index 813427f106..122763bc5f 100644 --- a/static/api/v3/types/sap_cloud_sdk_odata_v4.FilterFunctionTypes.html +++ b/static/api/v3/types/sap_cloud_sdk_odata_v4.FilterFunctionTypes.html @@ -1,3 +1,3 @@ -FilterFunctionTypes | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias FilterFunctionTypes

    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.22.1

    Type Alias FilterFunctionTypes

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_openapi_generator.GeneratorOptions.html b/static/api/v3/types/sap_cloud_sdk_openapi_generator.GeneratorOptions.html index f0f8f3b806..89645d394f 100644 --- a/static/api/v3/types/sap_cloud_sdk_openapi_generator.GeneratorOptions.html +++ b/static/api/v3/types/sap_cloud_sdk_openapi_generator.GeneratorOptions.html @@ -1,3 +1,3 @@ -GeneratorOptions | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias GeneratorOptions

    GeneratorOptions: CommonGeneratorOptions & OpenAPIGeneratorOptions

    Options to configure OData client generation when using the generator programmatically.

    +GeneratorOptions | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias GeneratorOptions

    GeneratorOptions: CommonGeneratorOptions & OpenAPIGeneratorOptions

    Options to configure OData client generation when using the generator programmatically.

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_resilience.Middleware.html b/static/api/v3/types/sap_cloud_sdk_resilience.Middleware.html index d23636fd98..91c6828049 100644 --- a/static/api/v3/types/sap_cloud_sdk_resilience.Middleware.html +++ b/static/api/v3/types/sap_cloud_sdk_resilience.Middleware.html @@ -1,5 +1,5 @@ -Middleware | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias Middleware<ArgumentT, ReturnT, ContextT>

    Middleware<ArgumentT, ReturnT, ContextT>: ((options: MiddlewareOptions<ArgumentT, ReturnT, ContextT>) => MiddlewareFunction<ArgumentT, ReturnT>)

    Middleware type - This function takes some initial function and returns a function. +Middleware | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias Middleware<ArgumentT, ReturnT, ContextT>

    Middleware<ArgumentT, ReturnT, ContextT>: ((options: MiddlewareOptions<ArgumentT, ReturnT, ContextT>) => MiddlewareFunction<ArgumentT, ReturnT>)

    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

    Settings

    Member Visibility
    +

    Type Parameters

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_resilience.MiddlewareFunction.html b/static/api/v3/types/sap_cloud_sdk_resilience.MiddlewareFunction.html index 2ae254de17..f8f0e41479 100644 --- a/static/api/v3/types/sap_cloud_sdk_resilience.MiddlewareFunction.html +++ b/static/api/v3/types/sap_cloud_sdk_resilience.MiddlewareFunction.html @@ -1,3 +1,3 @@ -MiddlewareFunction | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias MiddlewareFunction<ArgumentT, ReturnT>

    MiddlewareFunction<ArgumentT, ReturnT>: ((arg: ArgumentT) => Promise<ReturnT>)

    Function around which the middlewares are added.

    +MiddlewareFunction | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias MiddlewareFunction<ArgumentT, ReturnT>

    MiddlewareFunction<ArgumentT, ReturnT>: ((arg: ArgumentT) => 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

    Settings

    Member Visibility
    +

    Type Parameters

    • ArgumentT
    • ReturnT

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_util.LogLevel.html b/static/api/v3/types/sap_cloud_sdk_util.LogLevel.html index 5e1f33954f..faf628b733 100644 --- a/static/api/v3/types/sap_cloud_sdk_util.LogLevel.html +++ b/static/api/v3/types/sap_cloud_sdk_util.LogLevel.html @@ -1,3 +1,3 @@ -LogLevel | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias LogLevel

    LogLevel:
        | "error"
        | "warn"
        | "info"
        | "verbose"
        | "debug"
        | "silly"

    Npm log levels used for the SAP Cloud SDK logger.

    +LogLevel | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias LogLevel

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_util.ODataVersion.html b/static/api/v3/types/sap_cloud_sdk_util.ODataVersion.html index 2d88d60572..8e6a3fd4a2 100644 --- a/static/api/v3/types/sap_cloud_sdk_util.ODataVersion.html +++ b/static/api/v3/types/sap_cloud_sdk_util.ODataVersion.html @@ -1,3 +1,3 @@ -ODataVersion | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias ODataVersion

    ODataVersion: "v2" | "v4"

    Denotes the OData version.

    +ODataVersion | SAP Cloud SDK for JavaScript - v3.22.1

    Type Alias ODataVersion

    ODataVersion: "v2" | "v4"

    Denotes the OData version.

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_util.Without.html b/static/api/v3/types/sap_cloud_sdk_util.Without.html index b72fa23428..b4a178bb4f 100644 --- a/static/api/v3/types/sap_cloud_sdk_util.Without.html +++ b/static/api/v3/types/sap_cloud_sdk_util.Without.html @@ -1,4 +1,4 @@ -Without | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias Without<T>

    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.22.1

    Type Alias Without<T>

    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

    Settings

    Member Visibility
    +

    Type Parameters

    • T

    Settings

    Member Visibility
    diff --git a/static/api/v3/types/sap_cloud_sdk_util.Xor.html b/static/api/v3/types/sap_cloud_sdk_util.Xor.html index d4deacffd6..8c4eaa1874 100644 --- a/static/api/v3/types/sap_cloud_sdk_util.Xor.html +++ b/static/api/v3/types/sap_cloud_sdk_util.Xor.html @@ -1,4 +1,4 @@ -Xor | SAP Cloud SDK for JavaScript - v3.22.0

    Type Alias Xor<T, U>

    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.22.1

    Type Alias Xor<T, U>

    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

    Settings

    Member Visibility
    +

    Type Parameters

    • T
    • U

    Settings

    Member Visibility
    diff --git a/static/api/v3/variables/sap_cloud_sdk_connectivity.DestinationSelectionStrategies.html b/static/api/v3/variables/sap_cloud_sdk_connectivity.DestinationSelectionStrategies.html index bc12c322c1..373b0c36a3 100644 --- a/static/api/v3/variables/sap_cloud_sdk_connectivity.DestinationSelectionStrategies.html +++ b/static/api/v3/variables/sap_cloud_sdk_connectivity.DestinationSelectionStrategies.html @@ -1,3 +1,3 @@ -DestinationSelectionStrategies | SAP Cloud SDK for JavaScript - v3.22.0

    Variable DestinationSelectionStrategiesConst

    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.22.1

    Variable DestinationSelectionStrategiesConst

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/variables/sap_cloud_sdk_http_client.defaultDisallowedKeys.html b/static/api/v3/variables/sap_cloud_sdk_http_client.defaultDisallowedKeys.html index b899c0e73a..9dba9d22dd 100644 --- a/static/api/v3/variables/sap_cloud_sdk_http_client.defaultDisallowedKeys.html +++ b/static/api/v3/variables/sap_cloud_sdk_http_client.defaultDisallowedKeys.html @@ -1,3 +1,3 @@ -defaultDisallowedKeys | SAP Cloud SDK for JavaScript - v3.22.0

    Variable defaultDisallowedKeysConst

    defaultDisallowedKeys: string[]

    A list of request config keys that are not allowed to be customized by default.

    +defaultDisallowedKeys | SAP Cloud SDK for JavaScript - v3.22.1

    Variable defaultDisallowedKeysConst

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/variables/sap_cloud_sdk_odata_common.ActionFunctionImportRequestBuilderBase.html b/static/api/v3/variables/sap_cloud_sdk_odata_common.ActionFunctionImportRequestBuilderBase.html index a11087d888..7d38311297 100644 --- a/static/api/v3/variables/sap_cloud_sdk_odata_common.ActionFunctionImportRequestBuilderBase.html +++ b/static/api/v3/variables/sap_cloud_sdk_odata_common.ActionFunctionImportRequestBuilderBase.html @@ -1,3 +1,3 @@ -ActionFunctionImportRequestBuilderBase | SAP Cloud SDK for JavaScript - v3.22.0

    Variable ActionFunctionImportRequestBuilderBaseConst

    ActionFunctionImportRequestBuilderBase: typeof OperationRequestBuilderBase

    Deprecated

    Since 3.3.0. Use OperationRequestBuilderBase instead.

    +ActionFunctionImportRequestBuilderBase | SAP Cloud SDK for JavaScript - v3.22.1

    Variable ActionFunctionImportRequestBuilderBaseConst

    ActionFunctionImportRequestBuilderBase: typeof OperationRequestBuilderBase

    Deprecated

    Since 3.3.0. Use OperationRequestBuilderBase instead.

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/variables/sap_cloud_sdk_odata_common.FunctionImportParameter.html b/static/api/v3/variables/sap_cloud_sdk_odata_common.FunctionImportParameter.html index 2807085510..89adc1ea16 100644 --- a/static/api/v3/variables/sap_cloud_sdk_odata_common.FunctionImportParameter.html +++ b/static/api/v3/variables/sap_cloud_sdk_odata_common.FunctionImportParameter.html @@ -1,3 +1,3 @@ -FunctionImportParameter | SAP Cloud SDK for JavaScript - v3.22.0

    Variable FunctionImportParameterConst

    FunctionImportParameter: typeof OperationParameter

    Deprecated

    Since 3.3.0. Use OperationParameter instead.

    +FunctionImportParameter | SAP Cloud SDK for JavaScript - v3.22.1

    Variable FunctionImportParameterConst

    FunctionImportParameter: typeof OperationParameter

    Deprecated

    Since 3.3.0. Use OperationParameter instead.

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/variables/sap_cloud_sdk_odata_common.ODataFunctionImportRequestConfig.html b/static/api/v3/variables/sap_cloud_sdk_odata_common.ODataFunctionImportRequestConfig.html index 620d52ee8c..9f8f45f181 100644 --- a/static/api/v3/variables/sap_cloud_sdk_odata_common.ODataFunctionImportRequestConfig.html +++ b/static/api/v3/variables/sap_cloud_sdk_odata_common.ODataFunctionImportRequestConfig.html @@ -1,3 +1,3 @@ -ODataFunctionImportRequestConfig | SAP Cloud SDK for JavaScript - v3.22.0

    Variable ODataFunctionImportRequestConfigConst

    ODataFunctionImportRequestConfig: typeof ODataFunctionRequestConfig

    Deprecated

    Since 3.3.0. Use ODataFunctionRequestConfig instead.

    +ODataFunctionImportRequestConfig | SAP Cloud SDK for JavaScript - v3.22.1

    Variable ODataFunctionImportRequestConfigConst

    ODataFunctionImportRequestConfig: typeof ODataFunctionRequestConfig

    Deprecated

    Since 3.3.0. Use ODataFunctionRequestConfig instead.

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/variables/sap_cloud_sdk_odata_v2.FunctionImportRequestBuilder.html b/static/api/v3/variables/sap_cloud_sdk_odata_v2.FunctionImportRequestBuilder.html index ad22bc0d25..3ef7379878 100644 --- a/static/api/v3/variables/sap_cloud_sdk_odata_v2.FunctionImportRequestBuilder.html +++ b/static/api/v3/variables/sap_cloud_sdk_odata_v2.FunctionImportRequestBuilder.html @@ -1,3 +1,3 @@ -FunctionImportRequestBuilder | SAP Cloud SDK for JavaScript - v3.22.0

    Variable FunctionImportRequestBuilderConst

    FunctionImportRequestBuilder: typeof OperationRequestBuilder

    Deprecated

    Since 3.3.0. Use OperationRequestBuilder instead.

    +FunctionImportRequestBuilder | SAP Cloud SDK for JavaScript - v3.22.1

    Variable FunctionImportRequestBuilderConst

    FunctionImportRequestBuilder: typeof OperationRequestBuilder

    Deprecated

    Since 3.3.0. Use OperationRequestBuilder instead.

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/variables/sap_cloud_sdk_odata_v2.ODataFunctionImportRequestConfig.html b/static/api/v3/variables/sap_cloud_sdk_odata_v2.ODataFunctionImportRequestConfig.html index ca4966d0d5..66dcb466e5 100644 --- a/static/api/v3/variables/sap_cloud_sdk_odata_v2.ODataFunctionImportRequestConfig.html +++ b/static/api/v3/variables/sap_cloud_sdk_odata_v2.ODataFunctionImportRequestConfig.html @@ -1,3 +1,3 @@ -ODataFunctionImportRequestConfig | SAP Cloud SDK for JavaScript - v3.22.0

    Variable ODataFunctionImportRequestConfigConst

    ODataFunctionImportRequestConfig: typeof ODataFunctionRequestConfig

    Deprecated

    Since 3.3.0. Use ODataFunctionRequestConfig instead.

    +ODataFunctionImportRequestConfig | SAP Cloud SDK for JavaScript - v3.22.1

    Variable ODataFunctionImportRequestConfigConst

    ODataFunctionImportRequestConfig: typeof ODataFunctionRequestConfig

    Deprecated

    Since 3.3.0. Use ODataFunctionRequestConfig instead.

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/variables/sap_cloud_sdk_odata_v2.defaultDeSerializers-1.html b/static/api/v3/variables/sap_cloud_sdk_odata_v2.defaultDeSerializers-1.html index e563fee331..785db7fc2c 100644 --- a/static/api/v3/variables/sap_cloud_sdk_odata_v2.defaultDeSerializers-1.html +++ b/static/api/v3/variables/sap_cloud_sdk_odata_v2.defaultDeSerializers-1.html @@ -1,3 +1,3 @@ -defaultDeSerializers | SAP Cloud SDK for JavaScript - v3.22.0

    Variable defaultDeSerializersConst

    defaultDeSerializers: DefaultDeSerializers

    The default (de-)serializers.

    +defaultDeSerializers | SAP Cloud SDK for JavaScript - v3.22.1

    Variable defaultDeSerializersConst

    defaultDeSerializers: DefaultDeSerializers

    The default (de-)serializers.

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/variables/sap_cloud_sdk_odata_v4.ODataActionImportRequestConfig.html b/static/api/v3/variables/sap_cloud_sdk_odata_v4.ODataActionImportRequestConfig.html index cedbe28581..d96a63256f 100644 --- a/static/api/v3/variables/sap_cloud_sdk_odata_v4.ODataActionImportRequestConfig.html +++ b/static/api/v3/variables/sap_cloud_sdk_odata_v4.ODataActionImportRequestConfig.html @@ -1,3 +1,3 @@ -ODataActionImportRequestConfig | SAP Cloud SDK for JavaScript - v3.22.0

    Variable ODataActionImportRequestConfigConst

    ODataActionImportRequestConfig: typeof ODataActionRequestConfig

    Deprecated

    Since 3.3.0. Use ODataActionRequestConfig instead.

    +ODataActionImportRequestConfig | SAP Cloud SDK for JavaScript - v3.22.1

    Variable ODataActionImportRequestConfigConst

    ODataActionImportRequestConfig: typeof ODataActionRequestConfig

    Deprecated

    Since 3.3.0. Use ODataActionRequestConfig instead.

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/variables/sap_cloud_sdk_odata_v4.ODataFunctionImportRequestConfig.html b/static/api/v3/variables/sap_cloud_sdk_odata_v4.ODataFunctionImportRequestConfig.html index 6525903552..ad000c068c 100644 --- a/static/api/v3/variables/sap_cloud_sdk_odata_v4.ODataFunctionImportRequestConfig.html +++ b/static/api/v3/variables/sap_cloud_sdk_odata_v4.ODataFunctionImportRequestConfig.html @@ -1,3 +1,3 @@ -ODataFunctionImportRequestConfig | SAP Cloud SDK for JavaScript - v3.22.0

    Variable ODataFunctionImportRequestConfigConst

    ODataFunctionImportRequestConfig: typeof ODataFunctionRequestConfig

    Deprecated

    Since 3.3.0. Use ODataFunctionRequestConfig instead.

    +ODataFunctionImportRequestConfig | SAP Cloud SDK for JavaScript - v3.22.1

    Variable ODataFunctionImportRequestConfigConst

    ODataFunctionImportRequestConfig: typeof ODataFunctionRequestConfig

    Deprecated

    Since 3.3.0. Use ODataFunctionRequestConfig instead.

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/variables/sap_cloud_sdk_odata_v4.OdataBoundFunctionImportRequestConfig.html b/static/api/v3/variables/sap_cloud_sdk_odata_v4.OdataBoundFunctionImportRequestConfig.html index 741cfd456b..d164a6c984 100644 --- a/static/api/v3/variables/sap_cloud_sdk_odata_v4.OdataBoundFunctionImportRequestConfig.html +++ b/static/api/v3/variables/sap_cloud_sdk_odata_v4.OdataBoundFunctionImportRequestConfig.html @@ -1,3 +1,3 @@ -OdataBoundFunctionImportRequestConfig | SAP Cloud SDK for JavaScript - v3.22.0

    Variable OdataBoundFunctionImportRequestConfigConst

    OdataBoundFunctionImportRequestConfig: typeof ODataBoundFunctionRequestConfig

    Deprecated

    Since 3.3.0. Use ODataBoundFunctionRequestConfig instead.

    +OdataBoundFunctionImportRequestConfig | SAP Cloud SDK for JavaScript - v3.22.1

    Variable OdataBoundFunctionImportRequestConfigConst

    OdataBoundFunctionImportRequestConfig: typeof ODataBoundFunctionRequestConfig

    Deprecated

    Since 3.3.0. Use ODataBoundFunctionRequestConfig instead.

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/variables/sap_cloud_sdk_odata_v4.defaultDeSerializers-1.html b/static/api/v3/variables/sap_cloud_sdk_odata_v4.defaultDeSerializers-1.html index 4891cec633..a099561cd7 100644 --- a/static/api/v3/variables/sap_cloud_sdk_odata_v4.defaultDeSerializers-1.html +++ b/static/api/v3/variables/sap_cloud_sdk_odata_v4.defaultDeSerializers-1.html @@ -1,3 +1,3 @@ -defaultDeSerializers | SAP Cloud SDK for JavaScript - v3.22.0

    Variable defaultDeSerializersConst

    defaultDeSerializers: DefaultDeSerializers

    The default (de-)serializers.

    +defaultDeSerializers | SAP Cloud SDK for JavaScript - v3.22.1

    Variable defaultDeSerializersConst

    defaultDeSerializers: DefaultDeSerializers

    The default (de-)serializers.

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/variables/sap_cloud_sdk_temporal_de_serializers.temporalDeSerializersV2.html b/static/api/v3/variables/sap_cloud_sdk_temporal_de_serializers.temporalDeSerializersV2.html index e2816b13bd..bf6189dff9 100644 --- a/static/api/v3/variables/sap_cloud_sdk_temporal_de_serializers.temporalDeSerializersV2.html +++ b/static/api/v3/variables/sap_cloud_sdk_temporal_de_serializers.temporalDeSerializersV2.html @@ -1,3 +1,3 @@ -temporalDeSerializersV2 | SAP Cloud SDK for JavaScript - v3.22.0

    Variable temporalDeSerializersV2Const

    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.22.1

    Variable temporalDeSerializersV2Const

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/variables/sap_cloud_sdk_temporal_de_serializers.temporalDeSerializersV4.html b/static/api/v3/variables/sap_cloud_sdk_temporal_de_serializers.temporalDeSerializersV4.html index 059ff48f96..83e5e8ba23 100644 --- a/static/api/v3/variables/sap_cloud_sdk_temporal_de_serializers.temporalDeSerializersV4.html +++ b/static/api/v3/variables/sap_cloud_sdk_temporal_de_serializers.temporalDeSerializersV4.html @@ -1,3 +1,3 @@ -temporalDeSerializersV4 | SAP Cloud SDK for JavaScript - v3.22.0

    Variable temporalDeSerializersV4Const

    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.22.1

    Variable temporalDeSerializersV4Const

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/variables/sap_cloud_sdk_util.cloudSdkExceptionLogger.html b/static/api/v3/variables/sap_cloud_sdk_util.cloudSdkExceptionLogger.html index c92fe3c61d..63338f9d65 100644 --- a/static/api/v3/variables/sap_cloud_sdk_util.cloudSdkExceptionLogger.html +++ b/static/api/v3/variables/sap_cloud_sdk_util.cloudSdkExceptionLogger.html @@ -1,3 +1,3 @@ -cloudSdkExceptionLogger | SAP Cloud SDK for JavaScript - v3.22.0

    Variable cloudSdkExceptionLoggerConst

    cloudSdkExceptionLogger: Logger

    Default logger for the SAP Cloud SDK for unhandled exceptions.

    +cloudSdkExceptionLogger | SAP Cloud SDK for JavaScript - v3.22.1

    Variable cloudSdkExceptionLoggerConst

    cloudSdkExceptionLogger: Logger

    Default logger for the SAP Cloud SDK for unhandled exceptions.

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/variables/sap_cloud_sdk_util.kibana.html b/static/api/v3/variables/sap_cloud_sdk_util.kibana.html index 392510e03b..d3265947de 100644 --- a/static/api/v3/variables/sap_cloud_sdk_util.kibana.html +++ b/static/api/v3/variables/sap_cloud_sdk_util.kibana.html @@ -1,3 +1,3 @@ -kibana | SAP Cloud SDK for JavaScript - v3.22.0

    Variable kibanaConst

    kibana: Format

    Format for logging in Kibana.

    +kibana | SAP Cloud SDK for JavaScript - v3.22.1

    Variable kibanaConst

    kibana: Format

    Format for logging in Kibana.

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/variables/sap_cloud_sdk_util.local.html b/static/api/v3/variables/sap_cloud_sdk_util.local.html index 4c5a167be9..ffd88ef4cd 100644 --- a/static/api/v3/variables/sap_cloud_sdk_util.local.html +++ b/static/api/v3/variables/sap_cloud_sdk_util.local.html @@ -1,3 +1,3 @@ -local | SAP Cloud SDK for JavaScript - v3.22.0

    Variable localConst

    local: Format

    Format for local logging.

    +local | SAP Cloud SDK for JavaScript - v3.22.1

    Variable localConst

    local: Format

    Format for local logging.

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/variables/sap_cloud_sdk_util.logFormat.html b/static/api/v3/variables/sap_cloud_sdk_util.logFormat.html index 654c564002..471d2c8052 100644 --- a/static/api/v3/variables/sap_cloud_sdk_util.logFormat.html +++ b/static/api/v3/variables/sap_cloud_sdk_util.logFormat.html @@ -1,3 +1,3 @@ -logFormat | SAP Cloud SDK for JavaScript - v3.22.0

    Variable logFormatConst

    logFormat: {
        kibana: Format;
        local: Format;
    }

    Log formats provided by the util package.

    +logFormat | SAP Cloud SDK for JavaScript - v3.22.1

    Variable logFormatConst

    logFormat: {
        kibana: Format;
        local: Format;
    }

    Log formats provided by the util package.

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

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/variables/sap_cloud_sdk_util.unixEOL.html b/static/api/v3/variables/sap_cloud_sdk_util.unixEOL.html index 8a7d7e4929..8cb167ce05 100644 --- a/static/api/v3/variables/sap_cloud_sdk_util.unixEOL.html +++ b/static/api/v3/variables/sap_cloud_sdk_util.unixEOL.html @@ -1,5 +1,5 @@ -unixEOL | SAP Cloud SDK for JavaScript - v3.22.0

    Variable unixEOLConst

    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.22.1

    Variable unixEOLConst

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/static/api/v3/variables/sap_cloud_sdk_util.webEOL.html b/static/api/v3/variables/sap_cloud_sdk_util.webEOL.html index e0ea7f0178..a3754a6088 100644 --- a/static/api/v3/variables/sap_cloud_sdk_util.webEOL.html +++ b/static/api/v3/variables/sap_cloud_sdk_util.webEOL.html @@ -1,3 +1,3 @@ -webEOL | SAP Cloud SDK for JavaScript - v3.22.0

    Variable webEOLConst

    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.22.1

    Variable webEOLConst

    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.

    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility