+
+
+
+
+ Class ActionFunctionImportRequestBuilder<ParametersT, ReturnT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.actionimportrequestbuilder.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.actionimportrequestbuilder.html
new file mode 100644
index 0000000000..3187eb9f18
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.actionimportrequestbuilder.html
@@ -0,0 +1,748 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ request
+
+
+
+
+
+ Readonly response
+
+
+
+
+
+
+
+ add
+
+
+
+ add
+
+
+
+
+
+
+
+
+
+ relative
+
+
+
+ set
+
+
+
+
+
+
+ with
+
+
+
+ with
+
+
+
+ with
+
+
+
+
+ Type parameters
+-
+
-
+
ParametersT
+++++Type of the function import parameters
+
+ -
+
ReturnT
+++++Type of the function import return value
+
+
Hierarchy
+-
+
-
+ MethodRequestBuilder<ODataFunctionImportRequestConfig<ParametersT> | ODataActionImportRequestConfig<ParametersT>>
+
-
+
-
+ ActionFunctionImportRequestBuilder
+
-
+
- + FunctionImportRequestBuilder + +
- + FunctionImportRequestBuilderV4 + +
- + ActionImportRequestBuilder + +
+
+ -
+ ActionFunctionImportRequestBuilder
+
Index
+Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Base class for function and actions imports
+Type parameters
+-
+
-
+
ParametersT
+
+ -
+
ReturnT
+
+
Parameters
+-
+
-
+
responseTransformer: (data: any) => ReturnT
+++Transformation function for the response
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
data: any
+
+
Returns ReturnT
+
+ -
+
+ -
+
+ -
+
-
+
requestConfig: ODataFunctionImportRequestConfig<ParametersT> | ODataActionImportRequestConfig<ParametersT>
+++Request config for a action or funciton import
+
+
Returns ActionFunctionImportRequestBuilder<ParametersT, ReturnT>
+
+ -
+
Properties
+requestConfig
+
+
+ Readonly responseTransformer
+
+
+
+
+ Type declaration
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
data: any
+
+
Returns ReturnT
+
+ -
+
+ -
+
Methods
+addCustomHeaders
+ -
+
+
-
+
-
+
+ ++++
Add custom headers to the request. Existing headers will be overwritten.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs denoting additional custom headers.
+
+
Returns ActionFunctionImportRequestBuilder<ParametersT, ReturnT>
+The request builder itself, to facilitate method chaining.
+
+ -
+
addCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++
Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs denoting additional custom query parameters to be set in the request
+
+
Returns ActionFunctionImportRequestBuilder<ParametersT, ReturnT>
+The request builder itself, to facilitate method chaining
+
+ -
+
build
+-
+
+
+
-
+
-
+
+
Returns ODataRequest<ODataFunctionImportRequestConfig<ParametersT> | ODataActionImportRequestConfig<ParametersT>>
+
+ -
+
+
Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+
+ -
+
Optional options: (DestinationCachingOptions & ResilienceOptions) | (CachingOptions & ResilienceOptions)
+
+
Returns Promise<ODataRequest<ODataFunctionImportRequestConfig<ParametersT> | ODataActionImportRequestConfig<ParametersT>>>
+
+ -
+
execute
+-
+
+
-
+
-
+
+ ++++
Execute request
+Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++Destination to execute the request against
+
+ -
+
Optional options: (DestinationAccessorOptions & DestinationCachingOptions & ResilienceOptions & VerifyJwtOptions) | (DestinationAccessorOptions & CachingOptions & ResilienceOptions & VerifyJwtOptions)
+++Options to employ when fetching destinations
+
+
Returns Promise<ReturnT>
+A promise resolving to the requested return type
+
+ -
+
relativeUrl
+ -
+
+
-
+
-
+
+ ++++
Create the relative url based on configuration of the given builder.
+Returns string
+The relative url for the request
+
+
setCustomServicePath
+ -
+
+
-
+
-
+
+ ++++
Replace the default service path with the given custom path. + In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/
+' and can be overwritten here. Parameters
+-
+
-
+
servicePath: string
+++Path to override the default with
+
+
Returns ActionFunctionImportRequestBuilder<ParametersT, ReturnT>
+The request builder itself, to facilitate method chaining
+
+ -
+
url
+-
+
+
-
+
-
+
+ ++++
Create the url based on configuration of the given builder.
+Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++Destination to execute the request against
+
+ -
+
Optional options: (DestinationCachingOptions & ResilienceOptions) | (CachingOptions & ResilienceOptions)
+++Options to employ when fetching destinations.
+
+
Returns Promise<string>
+Promise resolving to the url for the request
+
+ -
+
withCustomHeaders
+ -
+
+
-
+
-
+
+ ++++ +
Add custom headers to the request.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs denoting additional custom headers
+
+
Returns ActionFunctionImportRequestBuilder<ParametersT, ReturnT>
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++ +
Add custom query parameters to the request.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs denoting additional custom query parameters to be set in the request
+
+
Returns ActionFunctionImportRequestBuilder<ParametersT, ReturnT>
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomServicePath
+ -
+
+
-
+
-
+
+ ++++ +
Replace the default service path with the given custom path. + In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/
+' and can be overwritten here. Parameters
+-
+
-
+
servicePath: string
+++Path to override the default with
+
+
Returns ActionFunctionImportRequestBuilder<ParametersT, ReturnT>
+The request builder itself, to facilitate method chaining
+
+ -
+
+
+
+
+
+ Class ActionImportRequestBuilder<ParametersT, ReturnT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.allfields.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.allfields.html
new file mode 100644
index 0000000000..d7551a6bcb
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.allfields.html
@@ -0,0 +1,263 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ request
+
+
+
+
+
+ Readonly response
+
+
+
+
+
+
+
+ add
+
+
+
+ add
+
+
+
+
+
+
+
+
+
+ relative
+
+
+
+ set
+
+
+
+
+
+
+ with
+
+
+
+ with
+
+
+
+ with
+
+
+
+
+
+
+
+
+ Create an OData request to execute an action import.
+Type parameters
+-
+
-
+
ParametersT
+++++Type of the action import parameters
+
+ -
+
ReturnT
+++++Type of the action import return value
+
+
Hierarchy
+-
+
-
+ ActionFunctionImportRequestBuilder<ParametersT, ReturnT>
+
-
+
- + ActionImportRequestBuilder + +
+
Index
+Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of ActionImportRequestBuilder.
+Type parameters
+-
+
-
+
ParametersT
+
+ -
+
ReturnT
+
+
Parameters
+-
+
-
+
defaultServicePath: string
+++Default path for the service the action belongs to
+
+ -
+
actionImportName: string
+++The name of the action import.
+
+ -
+
responseTransformer: (data: any) => ReturnT
+++Transformation function for the response
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
data: any
+
+
Returns ReturnT
+
+ -
+
+ -
+
+ -
+
-
+
parameters: FunctionImportParameters<ParametersT>
+++Parameters to be set in the action
+
+
Returns ActionImportRequestBuilder<ParametersT, ReturnT>
+
+ -
+
Properties
+requestConfig
+
+
+ Readonly responseTransformer
+
+
+
+
+ Type declaration
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
data: any
+
+
Returns ReturnT
+
+ -
+
+ -
+
Methods
+addCustomHeaders
+ -
+
+
-
+
-
+
+ ++++
Add custom headers to the request. Existing headers will be overwritten.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs denoting additional custom headers.
+
+
Returns ActionImportRequestBuilder<ParametersT, ReturnT>
+The request builder itself, to facilitate method chaining.
+
+ -
+
addCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++
Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs denoting additional custom query parameters to be set in the request
+
+
Returns ActionImportRequestBuilder<ParametersT, ReturnT>
+The request builder itself, to facilitate method chaining
+
+ -
+
build
+-
+
+
+
-
+
-
+
+
Returns ODataRequest<ODataFunctionImportRequestConfig<ParametersT> | ODataActionImportRequestConfig<ParametersT>>
+
+ -
+
+
Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+
+ -
+
Optional options: (DestinationCachingOptions & ResilienceOptions) | (CachingOptions & ResilienceOptions)
+
+
Returns Promise<ODataRequest<ODataFunctionImportRequestConfig<ParametersT> | ODataActionImportRequestConfig<ParametersT>>>
+
+ -
+
execute
+-
+
+
-
+
-
+
+ ++++
Execute request
+Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++Destination to execute the request against
+
+ -
+
Optional options: (DestinationAccessorOptions & DestinationCachingOptions & ResilienceOptions & VerifyJwtOptions) | (DestinationAccessorOptions & CachingOptions & ResilienceOptions & VerifyJwtOptions)
+++Options to employ when fetching destinations
+
+
Returns Promise<ReturnT>
+A promise resolving to the requested return type
+
+ -
+
relativeUrl
+ -
+
+
-
+
-
+
+ ++++
Create the relative url based on configuration of the given builder.
+Returns string
+The relative url for the request
+
+
setCustomServicePath
+ -
+
+
-
+
-
+
+ ++++
Replace the default service path with the given custom path. + In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/
+' and can be overwritten here. Parameters
+-
+
-
+
servicePath: string
+++Path to override the default with
+
+
Returns ActionImportRequestBuilder<ParametersT, ReturnT>
+The request builder itself, to facilitate method chaining
+
+ -
+
url
+-
+
+
-
+
-
+
+ ++++
Create the url based on configuration of the given builder.
+Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++Destination to execute the request against
+
+ -
+
Optional options: (DestinationCachingOptions & ResilienceOptions) | (CachingOptions & ResilienceOptions)
+++Options to employ when fetching destinations.
+
+
Returns Promise<string>
+Promise resolving to the url for the request
+
+ -
+
withCustomHeaders
+ -
+
+
-
+
-
+
+ ++++ +
Add custom headers to the request.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs denoting additional custom headers
+
+
Returns ActionImportRequestBuilder<ParametersT, ReturnT>
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++ +
Add custom query parameters to the request.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs denoting additional custom query parameters to be set in the request
+
+
Returns ActionImportRequestBuilder<ParametersT, ReturnT>
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomServicePath
+ -
+
+
-
+
-
+
+ ++++ +
Replace the default service path with the given custom path. + In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/
+' and can be overwritten here. Parameters
+-
+
-
+
servicePath: string
+++Path to override the default with
+
+
Returns ActionImportRequestBuilder<ParametersT, ReturnT>
+The request builder itself, to facilitate method chaining
+
+ -
+
+
+
+
+
+ Class AllFields<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.anyfield.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.anyfield.html
new file mode 100644
index 0000000000..81b35dfa83
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.anyfield.html
@@ -0,0 +1,440 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ _entity
+
+
+
+
+
+ _field
+
+
+
+
+
+
+
+
+
+ Type parameters
+-
+
-
+
EntityT: EntityBase
+
+
Hierarchy
+-
+
- + AllFields + +
Index
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- _entity
Constructor
+ - _field
Name
+ - selectable +
Constructors
+constructor
+-
+
+
-
+
-
+
+
Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
_fieldName: string
+
+ -
+
_entityConstructor: Constructable<EntityT, unknown>
+
+
Returns AllFields<EntityT>
+
+ -
+
Properties
+_entityConstructor
+
+
+ _fieldName
+
+
+ Readonly selectable
+ + +
+
+
+
+
+ Class AnyField<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.batchchangeset.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.batchchangeset.html
new file mode 100644
index 0000000000..2dc01710a3
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.batchchangeset.html
@@ -0,0 +1,274 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ Readonly _field
+
+
+
+
+
+ Readonly edm
+
+
+
+
+
+
+
+
+
+
+
+
+
+ field
+
+
+
+ not
+
+
+
+
+
+
+
+
+ Represents a selectable property with with an unknown or currently unsupported edm type like Edm.Geography.
+Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity the field belongs to
+
+
Hierarchy
+-
+
-
+ AnyFieldBase<EntityT>
+
-
+
- + AnyField + +
+
Implements
+ +Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- _entity +
- _entity
Constructor
+ - _field
Name
+ - edm
Type
+ - selectable +
Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of EdmTypeField.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
fieldName: string
+++Actual name of the field used in the OData request
+
+ -
+
entityConstructor: Constructable<EntityT, unknown>
+++Constructor type of the entity the field belongs to
+
+ -
+
edmType: EdmTypeShared<VersionT>
+++Type of the field according to the metadata description
+
+
Returns AnyField<EntityT>
+
+ -
+
Properties
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ Readonly _fieldName
+
+
+ Readonly edmType
+
+
+ Readonly selectable
+ + +Methods
+equals
+-
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'eq', i.e.
+==.Parameters
+-
+
-
+
value: any
+++Value to be used in the filter
+
+
Returns Filter<EntityT, any>
+The resulting filter
+
+ -
+
fieldPath
+ -
+
+
-
+
-
+
+ ++++
Path to the field to be used in filter and order by queries. In most cases this will just be the _fieldName itself. However, for complex types for instance, the path is prefixed with the name of the complextype.
+Returns string
+Path to the field to be used in filter and order by queries.
+
+
notEquals
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'ne', i.e.
+!=.Parameters
+-
+
-
+
value: any
+++Value to be used in the filter
+
+
Returns Filter<EntityT, any>
+The resulting filter
+
+ -
+
+
+
+
+
+ Class BatchChangeSet<RequestT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.batchrequestbuilder.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.batchrequestbuilder.html
new file mode 100644
index 0000000000..35e8eb01ad
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.batchrequestbuilder.html
@@ -0,0 +1,695 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Representation of a batch change set, which holds a collection of write operations.
+Type parameters
+-
+
-
+
RequestT: MethodRequestBuilder = any
+
+
Hierarchy
+-
+
- + BatchChangeSet + +
Implemented by
+ +Index
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Create an instance of BatchChangeSet.
+Type parameters
+-
+
-
+
RequestT: MethodRequestBuilder<any, RequestT> = any
+
+
Parameters
+-
+
-
+
requests: RequestT[]
+++Requests to combine to one change set.
+
+ -
+
Optional boundary: string
+++Request boundary for separation of subrequests. Defaults to an autogenerated value.
+
+
Returns BatchChangeSet<RequestT>
+
+ -
+
Properties
+Readonly boundary
+ + +Readonly requests
+ + +
+
+
+
+
+ Class BatchRequestBuilder
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.batchresponsedeserializer.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.batchresponsedeserializer.html
new file mode 100644
index 0000000000..d311b80cbb
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.batchresponsedeserializer.html
@@ -0,0 +1,268 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly default
+
+
+
+
+
+ Readonly entity
+
+
+
+
+
+ request
+
+
+
+
+
+
+
+
+
+
+ add
+
+
+
+ add
+
+
+
+
+
+
+ relative
+
+
+
+ set
+
+
+
+
+
+
+ with
+
+
+
+ with
+
+
+
+ with
+
+
+
+ with
+
+
+
+
+
+
+
+
+ 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 excuted in order, while the order within a change set can vary.
+Hierarchy
+-
+
-
+ MethodRequestBuilder<ODataBatchRequestConfig>
+
-
+
-
+ BatchRequestBuilder
+
-
+
- + ODataBatchRequestBuilder + +
- + ODataBatchRequestBuilderV4 + +
+
+ -
+ BatchRequestBuilder
+
Index
+Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of ODataBatchRequestBuilder.
+Parameters
+-
+
-
+
defaultServicePath: string
+++Service path
+
+ -
+
requests: (BatchChangeSet<any> | MethodRequestBuilder<any>)[]
+++An array of retrieve requests or change sets
+
+ -
+
entityToConstructorMap: Record<string, Constructable<EntityBase, unknown>>
+++A map that holds the entity type to constructor mapping
+
+
Returns BatchRequestBuilder
+
+ -
+
Properties
+Readonly defaultServicePath
+
+
+ Readonly entityToConstructorMap
+
+
+ requestConfig
+
+
+ Readonly requests
+ + +Methods
+addCustomHeaders
+ -
+
+
-
+
-
+
+ ++++
Add custom headers to the request. Existing headers will be overwritten.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs denoting additional custom headers.
+
+
Returns BatchRequestBuilder
+The request builder itself, to facilitate method chaining.
+
+ -
+
addCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++
Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs denoting additional custom query parameters to be set in the request
+
+
Returns BatchRequestBuilder
+The request builder itself, to facilitate method chaining
+
+ -
+
build
+-
+
+
+
-
+
-
+
+
Returns ODataRequest<ODataBatchRequestConfig>
+
+ -
+
+
Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+
+ -
+
Optional options: (DestinationCachingOptions & ResilienceOptions) | (CachingOptions & ResilienceOptions)
+
+
Returns Promise<ODataRequest<ODataBatchRequestConfig>>
+
+ -
+
relativeUrl
+ -
+
+
-
+
-
+
+ ++++
Create the relative url based on configuration of the given builder.
+Returns string
+The relative url for the request
+
+
setCustomServicePath
+ -
+
+
-
+
-
+
+ ++++
Replace the default service path with the given custom path. + In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/
+' and can be overwritten here. Parameters
+-
+
-
+
servicePath: string
+++Path to override the default with
+
+
Returns BatchRequestBuilder
+The request builder itself, to facilitate method chaining
+
+ -
+
url
+-
+
+
-
+
-
+
+ ++++
Create the url based on configuration of the given builder.
+Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++Destination to execute the request against
+
+ -
+
Optional options: (DestinationCachingOptions & ResilienceOptions) | (CachingOptions & ResilienceOptions)
+++Options to employ when fetching destinations.
+
+
Returns Promise<string>
+Promise resolving to the url for the request
+
+ -
+
withCustomHeaders
+ -
+
+
-
+
-
+
+ ++++ +
Add custom headers to the request.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs denoting additional custom headers
+
+
Returns BatchRequestBuilder
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++ +
Add custom query parameters to the request.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs denoting additional custom query parameters to be set in the request
+
+
Returns BatchRequestBuilder
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomServicePath
+ -
+
+
-
+
-
+
+ ++++ +
Replace the default service path with the given custom path. + In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/
+' and can be overwritten here. Parameters
+-
+
-
+
servicePath: string
+++Path to override the default with
+
+
Returns BatchRequestBuilder
+The request builder itself, to facilitate method chaining
+
+ -
+
withSubRequestPathType
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
subRequestPathType: BatchSubRequestPathType
+
+
Returns BatchRequestBuilder
+
+ -
+
+
+
+
+
+ Class BatchResponseDeserializer
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.bignumberfield.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.bignumberfield.html
new file mode 100644
index 0000000000..96c0237fec
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.bignumberfield.html
@@ -0,0 +1,584 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ deserialize
+
+
+
+
+
+
+
+
+ Represents the state needed to deserialize a parsed batch response using OData version specific deserialization data access.
+Hierarchy
+-
+
- + BatchResponseDeserializer + +
Index
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of BatchResponseTransformer.
+Parameters
+-
+
-
+
entityToConstructorMap: Record<string, Constructable<EntityBase, unknown>>
+++A map that holds the entity type to constructor mapping.
+
+ -
+
responseDataAccessor: ResponseDataAccessor
+++Response data access module.
+
+ -
+
deserializer: EntityDeserializer<any>
+++Entity deserializer.
+
+
Returns BatchResponseDeserializer
+
+ -
+
Methods
+deserializeBatchResponse
+ -
+
+
-
+
-
+
+ ++++
Deserialize the parsed batch response.
+Parameters
+-
+
-
+
parsedBatchResponse: (ResponseData | ResponseData[])[]
+++Two dimensional list of parsed batch sub responses.
+
+
Returns BatchResponse[]
+An array of parsed sub responses of the batch response.
+
+ -
+
+
+
+
+
+ Class BigNumberField<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.binaryfield.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.binaryfield.html
new file mode 100644
index 0000000000..18dfbcf337
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.binaryfield.html
@@ -0,0 +1,451 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ Readonly _field
+
+
+
+
+
+ Readonly edm
+
+
+
+
+
+
+
+
+
+
+
+
+
+ field
+
+
+
+ greater
+
+
+
+ greater
+
+
+
+ less
+
+
+
+ less
+
+
+
+ not
+
+
+
+
+
+
+
+
+ Represents a selectable property with a big number value.
+Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity the field belongs to
+
+
Hierarchy
+-
+
-
+ BigNumberFieldBase<EntityT>
+
-
+
- + BigNumberField + +
+
Implements
+ +Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- _entity +
- _entity
Constructor
+ - _field
Name
+ - edm
Type
+ - selectable +
Methods
+-
+
- equals +
- field
Path
+ - greater
OrEqual
+ - greater
Than
+ - less
OrEqual
+ - less
Than
+ - not
Equals
+
Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of EdmTypeField.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
fieldName: string
+++Actual name of the field used in the OData request
+
+ -
+
entityConstructor: Constructable<EntityT, unknown>
+++Constructor type of the entity the field belongs to
+
+ -
+
edmType: EdmTypeShared<VersionT>
+++Type of the field according to the metadata description
+
+
Returns BigNumberField<EntityT>
+
+ -
+
Properties
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ Readonly _fieldName
+
+
+ Readonly edmType
+
+
+ Readonly selectable
+ + +Methods
+equals
+-
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'eq', i.e.
+==.Parameters
+-
+
-
+
value: BigNumber
+++Value to be used in the filter
+
+
Returns Filter<EntityT, BigNumber>
+The resulting filter
+
+ -
+
fieldPath
+ -
+
+
-
+
-
+
+ ++++
Path to the field to be used in filter and order by queries. In most cases this will just be the _fieldName itself. However, for complex types for instance, the path is prefixed with the name of the complextype.
+Returns string
+Path to the field to be used in filter and order by queries.
+
+
greaterOrEqual
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'ge', i.e.
+>=.Parameters
+-
+
-
+
value: BigNumber
+++Value to be used in the filter
+
+
Returns Filter<EntityT, BigNumber>
+The resulting filter
+
+ -
+
greaterThan
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'gt', i.e.
+>.Parameters
+-
+
-
+
value: BigNumber
+++Value to be used in the filter
+
+
Returns Filter<EntityT, BigNumber>
+The resulting filter
+
+ -
+
lessOrEqual
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'le', i.e.
+<=.Parameters
+-
+
-
+
value: BigNumber
+++Value to be used in the filter
+
+
Returns Filter<EntityT, BigNumber>
+The resulting filter
+
+ -
+
lessThan
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'lt', i.e.
+<.Parameters
+-
+
-
+
value: BigNumber
+++Value to be used in the filter
+
+
Returns Filter<EntityT, BigNumber>
+The resulting filter
+
+ -
+
notEquals
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'ne', i.e.
+!=.Parameters
+-
+
-
+
value: BigNumber
+++Value to be used in the filter
+
+
Returns Filter<EntityT, BigNumber>
+The resulting filter
+
+ -
+
+
+
+
+
+ Class BinaryField<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.binaryfieldbase.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.binaryfieldbase.html
new file mode 100644
index 0000000000..42d0d1ba13
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.binaryfieldbase.html
@@ -0,0 +1,437 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ Readonly _field
+
+
+
+
+
+ Readonly edm
+
+
+
+
+
+
+
+
+
+
+
+
+
+ field
+
+
+
+ not
+
+
+
+
+
+
+
+
+ Represents a selectable property with a binary value.
+Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity the field belongs to
+
+
Hierarchy
+-
+
-
+ BinaryFieldBase<EntityT>
+
-
+
- + BinaryField + +
+
Implements
+ +Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- _entity +
- _entity
Constructor
+ - _field
Name
+ - edm
Type
+ - selectable +
Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of EdmTypeField.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
fieldName: string
+++Actual name of the field used in the OData request
+
+ -
+
entityConstructor: Constructable<EntityT, unknown>
+++Constructor type of the entity the field belongs to
+
+ -
+
edmType: EdmTypeShared<VersionT>
+++Type of the field according to the metadata description
+
+
Returns BinaryField<EntityT>
+
+ -
+
Properties
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ Readonly _fieldName
+
+
+ Readonly edmType
+
+
+ Readonly selectable
+ + +Methods
+equals
+-
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'eq', i.e.
+==.Parameters
+-
+
-
+
value: string
+++Value to be used in the filter
+
+
Returns Filter<EntityT, string>
+The resulting filter
+
+ -
+
fieldPath
+ -
+
+
-
+
-
+
+ ++++
Path to the field to be used in filter and order by queries. In most cases this will just be the _fieldName itself. However, for complex types for instance, the path is prefixed with the name of the complextype.
+Returns string
+Path to the field to be used in filter and order by queries.
+
+
notEquals
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'ne', i.e.
+!=.Parameters
+-
+
-
+
value: string
+++Value to be used in the filter
+
+
Returns Filter<EntityT, string>
+The resulting filter
+
+ -
+
+
+
+
+
+ Class BinaryFieldBase<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.booleanfield.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.booleanfield.html
new file mode 100644
index 0000000000..26910339c2
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.booleanfield.html
@@ -0,0 +1,451 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ Readonly _field
+
+
+
+
+
+ Readonly edm
+
+
+
+
+
+
+
+
+
+
+ field
+
+
+
+ not
+
+
+
+
+
+
+
+
+ Represents a property with a binary value.
+Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity the field belongs to
+
+
Hierarchy
+-
+
-
+ EdmTypeField<EntityT, string>
+
-
+
-
+ BinaryFieldBase
+
-
+
- + BinaryField + +
- + ComplexTypeBinaryPropertyField + +
+
+ -
+ BinaryFieldBase
+
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- _entity +
- _entity
Constructor
+ - _field
Name
+ - edm
Type
+
Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of EdmTypeField.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
fieldName: string
+++Actual name of the field used in the OData request
+
+ -
+
entityConstructor: Constructable<EntityT, unknown>
+++Constructor type of the entity the field belongs to
+
+ -
+
edmType: EdmTypeShared<VersionT>
+++Type of the field according to the metadata description
+
+
Returns BinaryFieldBase<EntityT>
+
+ -
+
Properties
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ Readonly _fieldName
+
+
+ Readonly edmType
+
+
+ Methods
+equals
+-
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'eq', i.e.
+==.Parameters
+-
+
-
+
value: string
+++Value to be used in the filter
+
+
Returns Filter<EntityT, string>
+The resulting filter
+
+ -
+
fieldPath
+ -
+
+
-
+
-
+
+ ++++
Path to the field to be used in filter and order by queries. In most cases this will just be the _fieldName itself. However, for complex types for instance, the path is prefixed with the name of the complextype.
+Returns string
+Path to the field to be used in filter and order by queries.
+
+
notEquals
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'ne', i.e.
+!=.Parameters
+-
+
-
+
value: string
+++Value to be used in the filter
+
+
Returns Filter<EntityT, string>
+The resulting filter
+
+ -
+
+
+
+
+
+ Class BooleanField<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.booleanfieldbase.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.booleanfieldbase.html
new file mode 100644
index 0000000000..f9cdfb756a
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.booleanfieldbase.html
@@ -0,0 +1,437 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ Readonly _field
+
+
+
+
+
+ Readonly edm
+
+
+
+
+
+
+
+
+
+
+
+
+
+ field
+
+
+
+ not
+
+
+
+
+
+
+
+
+ Represents a selectable property with a boolean value.
+Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity the field belongs to
+
+
Hierarchy
+-
+
-
+ BooleanFieldBase<EntityT>
+
-
+
- + BooleanField + +
+
Implements
+ +Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- _entity +
- _entity
Constructor
+ - _field
Name
+ - edm
Type
+ - selectable +
Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of EdmTypeField.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
fieldName: string
+++Actual name of the field used in the OData request
+
+ -
+
entityConstructor: Constructable<EntityT, unknown>
+++Constructor type of the entity the field belongs to
+
+ -
+
edmType: EdmTypeShared<VersionT>
+++Type of the field according to the metadata description
+
+
Returns BooleanField<EntityT>
+
+ -
+
Properties
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ Readonly _fieldName
+
+
+ Readonly edmType
+
+
+ Readonly selectable
+ + +Methods
+equals
+-
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'eq', i.e.
+==.Parameters
+-
+
-
+
value: boolean
+++Value to be used in the filter
+
+
Returns Filter<EntityT, boolean>
+The resulting filter
+
+ -
+
fieldPath
+ -
+
+
-
+
-
+
+ ++++
Path to the field to be used in filter and order by queries. In most cases this will just be the _fieldName itself. However, for complex types for instance, the path is prefixed with the name of the complextype.
+Returns string
+Path to the field to be used in filter and order by queries.
+
+
notEquals
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'ne', i.e.
+!=.Parameters
+-
+
-
+
value: boolean
+++Value to be used in the filter
+
+
Returns Filter<EntityT, boolean>
+The resulting filter
+
+ -
+
+
+
+
+
+ Class BooleanFieldBase<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.booleanfilterfunction.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.booleanfilterfunction.html
new file mode 100644
index 0000000000..81cb6c9075
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.booleanfilterfunction.html
@@ -0,0 +1,415 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ Readonly _field
+
+
+
+
+
+ Readonly edm
+
+
+
+
+
+
+
+
+
+
+ field
+
+
+
+ not
+
+
+
+
+
+
+
+
+ Represents a property with a boolean value.
+Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity the field belongs to
+
+
Hierarchy
+-
+
-
+ EdmTypeField<EntityT, boolean>
+
-
+
-
+ BooleanFieldBase
+
-
+
- + BooleanField + +
- + ComplexTypeBooleanPropertyField + +
+
+ -
+ BooleanFieldBase
+
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- _entity +
- _entity
Constructor
+ - _field
Name
+ - edm
Type
+
Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of EdmTypeField.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
fieldName: string
+++Actual name of the field used in the OData request
+
+ -
+
entityConstructor: Constructable<EntityT, unknown>
+++Constructor type of the entity the field belongs to
+
+ -
+
edmType: EdmTypeShared<VersionT>
+++Type of the field according to the metadata description
+
+
Returns BooleanFieldBase<EntityT>
+
+ -
+
Properties
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ Readonly _fieldName
+
+
+ Readonly edmType
+
+
+ Methods
+equals
+-
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'eq', i.e.
+==.Parameters
+-
+
-
+
value: boolean
+++Value to be used in the filter
+
+
Returns Filter<EntityT, boolean>
+The resulting filter
+
+ -
+
fieldPath
+ -
+
+
-
+
-
+
+ ++++
Path to the field to be used in filter and order by queries. In most cases this will just be the _fieldName itself. However, for complex types for instance, the path is prefixed with the name of the complextype.
+Returns string
+Path to the field to be used in filter and order by queries.
+
+
notEquals
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'ne', i.e.
+!=.Parameters
+-
+
-
+
value: boolean
+++Value to be used in the filter
+
+
Returns Filter<EntityT, boolean>
+The resulting filter
+
+ -
+
+
+
+
+
+ Class BooleanFilterFunction<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.cache.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.cache.html
new file mode 100644
index 0000000000..bb76c55381
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.cache.html
@@ -0,0 +1,381 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly edm
+
+
+
+
+
+ Readonly function
+
+
+
+
+
+
+
+
+
+
+
+
+
+ not
+
+
+
+ to
+
+
+
+
+
+
+
+
+ Representation of a filter function, that returns a value of type boolean.
+Type parameters
+-
+
-
+
EntityT: EntityBase
+
+
Hierarchy
+-
+
-
+ FilterFunction<EntityT, boolean>
+
-
+
- + BooleanFilterFunction + +
+
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- edm
Type
+ - function
Name
+ - parameters +
Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of BooleanFilterFunction.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
functionName: string
+++Name of the function that returns a boolean value
+
+ -
+
parameters: FilterFunctionParameterType<EntityT>[]
+++Representation of the parameters passed to the filter function
+
+
Returns BooleanFilterFunction<EntityT>
+
+ -
+
Properties
+Readonly edmType
+
+
+ Readonly functionName
+
+
+ Readonly parameters
+ + +Methods
+equals
+-
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this filter function and the given value using the operator 'eq', i.e.
+==.Parameters
+-
+
-
+
value: boolean
+++Value to be used in the filter
+
+
Returns Filter<EntityT, boolean>
+The resulting filter
+
+ -
+
notEquals
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this filter function and the given value using the operator 'ne', i.e.
+!=.Parameters
+-
+
-
+
value: boolean
+++Value to be used in the filter
+
+
Returns Filter<EntityT, boolean>
+The resulting filter
+
+ -
+
toString
+ -
+
+
-
+
-
+
+ + ++
Parameters
+-
+
-
+
Optional parentFieldNames: string[]
+++Names of parents in case the function is part of a filter on a navigation property
+
+
Returns string
+The filter function as string
+
+ -
+
+
+
+
+
+ Class Cache<T>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.collectionfield.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.collectionfield.html
new file mode 100644
index 0000000000..01d4e8f8fb
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.collectionfield.html
@@ -0,0 +1,387 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ has
+
+
+
+
+
+
+
+
+
+
+
+ Representation of a cache to transiently store objects locally for faster access.
+Type parameters
+-
+
-
+
T
+++++Type of the cache entries.
+
+
Hierarchy
+-
+
- + Cache + +
Implements
+-
+
- CacheInterface<T> +
Index
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+
Type parameters
+-
+
-
+
T
+
+
Parameters
+-
+
-
+
Optional validityTime: MomentInputObject
+
+
Returns Cache<T>
+
+ -
+
Methods
+clear
+-
+
+
-
+
-
+
+ ++++
Clear all cached items.
+Returns void
+
+
get
+-
+
+
-
+
-
+
+ ++++
Getter of cached entries.
+Parameters
+-
+
-
+
key: string
+++The key of the entry to retrieve
+
+
Returns undefined | T
+The corresponding entry to the provided key if it is still valid, returns undefined otherwise
+
+ -
+
hasKey
+ -
+
+
-
+
-
+
+ ++++
Specifies whether an entry with a given key is defined in cache.
+Parameters
+-
+
-
+
key: string
+++The entry's key
+
+
Returns boolean
+boolean A boolean value that indicates whether the entry exists in cache
+
+ -
+
set
+-
+
+
-
+
-
+
+ ++++
Setter of entries in cache.
+Parameters
+-
+
-
+
key: string
+++The entry's key
+
+ -
+
entry: T
+++The entry to cache
+
+ -
+
Optional expirationTime: number
+++The time expressed in UTC in which the given entry expires
+
+
Returns void
+
+ -
+
+
+
+
+
+ Class CollectionField<EntityT, FieldT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.complextypeanypropertyfield.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.complextypeanypropertyfield.html
new file mode 100644
index 0000000000..d31b9e39b5
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.complextypeanypropertyfield.html
@@ -0,0 +1,444 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ Readonly _field
+
+
+
+
+
+ Readonly _field
+
+
+
+
+
+
+
+
+
+
+ field
+
+
+
+
+
+
+
+
+ Represents a static field of an entity or complex type.
+Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity the field belongs to
+
+ -
+
FieldT: EdmTypeShared<"any"> | Record<string, any> = any
+++++Type of the entries of the collection in the field
+
+
Hierarchy
+-
+
-
+ Field<EntityT>
+
-
+
- + CollectionField + +
+
Implements
+ +Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- _entity +
- _entity
Constructor
+ - _field
Name
+ - _field
Type
+ - selectable +
Methods
+-
+
- field
Path
+
Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of CollectionField.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+ -
+
FieldT: Record<string, any> | "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" | "Edm.DateTimeOffset" | "Edm.DateTime" | "Edm.Time" | "Edm.Date" | "Edm.Duration" | "Edm.TimeOfDay" | "Edm.Enum" = any
+
+
Parameters
+-
+
-
+
fieldName: string
+++Actual name of the field used in the OData request.
+
+ -
+
fieldOf: ConstructorOrField<EntityT, any>
+++The constructor of the entity or the complex type field this field belongs to.
+
+ -
+
_fieldType: FieldT | ComplexTypeNamespace<FieldT>
+++Type of the field according to the metadata description.
+
+
Returns CollectionField<EntityT, FieldT>
+
+ -
+
Properties
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ Readonly _fieldName
+
+
+ Readonly _fieldType
+
+
+ Readonly selectable
+ + +Methods
+fieldPath
+ -
+
+
-
+
-
+
+ ++++
Path to the field to be used in filter and order by queries. In most cases this will just be the _fieldName itself. However, for complex types for instance, the path is prefixed with the name of the complextype.
+Returns string
+Path to the field to be used in filter and order by queries.
+
+
+
+
+
+
+ Class ComplexTypeAnyPropertyField<EntityT, ComplexT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.complextypebignumberpropertyfield.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.complextypebignumberpropertyfield.html
new file mode 100644
index 0000000000..debaca12d8
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.complextypebignumberpropertyfield.html
@@ -0,0 +1,641 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ Readonly _field
+
+
+
+
+
+ Readonly edm
+
+
+
+
+
+ Readonly field
+
+
+
+
+
+
+
+
+
+
+ field
+
+
+
+ not
+
+
+
+
+
+
+
+
+ Represents a complex type property with with an unknown or currently unsupported edm type like Edm.Geography.
+Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity the field belongs to
+
+ -
+
ComplexT = any
+
+
Hierarchy
+-
+
-
+ AnyFieldBase<EntityT>
+
-
+
- + ComplexTypeAnyPropertyField + +
+
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- _entity +
- _entity
Constructor
+ - _field
Name
+ - edm
Type
+ - field
Of
+
Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of ComplexTypeAnyPropertyField.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+ -
+
ComplexT = any
+
+
Parameters
+-
+
-
+
fieldName: string
+++Actual name of the field used in the OData request
+
+ -
+
fieldOf: ConstructorOrField<EntityT, ComplexT>
+++The constructor of the entity or the complex type this field belongs to
+
+ -
+
edmType: EdmTypeShared<VersionT>
+++Type of the field according to the metadata description
+
+
Returns ComplexTypeAnyPropertyField<EntityT, ComplexT>
+
+ -
+
Properties
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ Readonly _fieldName
+
+
+ Readonly edmType
+
+
+ Readonly fieldOf
+
+
+
+
+
+
+ The constructor of the entity or the complex type this field belongs to
+Methods
+equals
+-
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'eq', i.e.
+==.Parameters
+-
+
-
+
value: any
+++Value to be used in the filter
+
+
Returns Filter<EntityT, any>
+The resulting filter
+
+ -
+
fieldPath
+ -
+
+
-
+
-
+
+ ++++
Path to the field to be used in filter and order by queries. Combines the parent complex type name with the field name.
+Returns string
+Path to the field to be used in filter and order by queries.
+
+
notEquals
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'ne', i.e.
+!=.Parameters
+-
+
-
+
value: any
+++Value to be used in the filter
+
+
Returns Filter<EntityT, any>
+The resulting filter
+
+ -
+
+
+
+
+
+ Class ComplexTypeBigNumberPropertyField<EntityT, ComplexT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.complextypebinarypropertyfield.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.complextypebinarypropertyfield.html
new file mode 100644
index 0000000000..69d9839e45
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.complextypebinarypropertyfield.html
@@ -0,0 +1,509 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ Readonly _field
+
+
+
+
+
+ Readonly edm
+
+
+
+
+
+ Readonly field
+
+
+
+
+
+
+
+
+
+
+ field
+
+
+
+ greater
+
+
+
+ greater
+
+
+
+ less
+
+
+
+ less
+
+
+
+ not
+
+
+
+
+
+
+
+
+ Represents a complex type property with a big number value.
+Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity the field belongs to
+
+ -
+
ComplexT = any
+
+
Hierarchy
+-
+
-
+ BigNumberFieldBase<EntityT>
+
-
+
- + ComplexTypeBigNumberPropertyField + +
+
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- _entity +
- _entity
Constructor
+ - _field
Name
+ - edm
Type
+ - field
Of
+
Methods
+-
+
- equals +
- field
Path
+ - greater
OrEqual
+ - greater
Than
+ - less
OrEqual
+ - less
Than
+ - not
Equals
+
Constructors
+constructor
+-
+
+
+
-
+
-
+
+ ++++
Creates an instance of ComplexTypeBigNumberPropertyField.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+ -
+
ComplexT = any
+
+
Parameters
+-
+
-
+
fieldName: string
+++Actual name of the field used in the OData request
+
+ -
+
fieldOf: ConstructorOrField<EntityT, ComplexT>
+++The constructor of the entity or the complex type this field belongs to
+
+ -
+
edmType: EdmTypeShared<VersionT>
+++Type of the field according to the metadata description
+
+
Returns ComplexTypeBigNumberPropertyField<EntityT, ComplexT>
+
+ -
+
-
+
+ + ++
Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+ -
+
ComplexT = any
+
+
Parameters
+-
+
-
+
fieldName: string
+++Actual name of the field used in the OData request
+
+ -
+
entityConstructor: Constructable<EntityT, unknown>
+++Constructor type of the entity the field belongs to
+
+ -
+
parentTypeName: string
+++Name of the parent complex type
+
+ -
+
edmType: EdmTypeShared<VersionT>
+++Type of the field according to the metadata description
+
+
Returns ComplexTypeBigNumberPropertyField<EntityT, ComplexT>
+
+ -
+
Properties
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ Readonly _fieldName
+
+
+ Readonly edmType
+
+
+ Readonly fieldOf
+
+
+
+
+
+
+ The constructor of the entity or the complex type this field belongs to
+Methods
+equals
+-
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'eq', i.e.
+==.Parameters
+-
+
-
+
value: BigNumber
+++Value to be used in the filter
+
+
Returns Filter<EntityT, BigNumber>
+The resulting filter
+
+ -
+
fieldPath
+ -
+
+
-
+
-
+
+ ++++
Path to the field to be used in filter and order by queries. Combines the parent complex type name with the field name.
+Returns string
+Path to the field to be used in filter and order by queries.
+
+
greaterOrEqual
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'ge', i.e.
+>=.Parameters
+-
+
-
+
value: BigNumber
+++Value to be used in the filter
+
+
Returns Filter<EntityT, BigNumber>
+The resulting filter
+
+ -
+
greaterThan
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'gt', i.e.
+>.Parameters
+-
+
-
+
value: BigNumber
+++Value to be used in the filter
+
+
Returns Filter<EntityT, BigNumber>
+The resulting filter
+
+ -
+
lessOrEqual
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'le', i.e.
+<=.Parameters
+-
+
-
+
value: BigNumber
+++Value to be used in the filter
+
+
Returns Filter<EntityT, BigNumber>
+The resulting filter
+
+ -
+
lessThan
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'lt', i.e.
+<.Parameters
+-
+
-
+
value: BigNumber
+++Value to be used in the filter
+
+
Returns Filter<EntityT, BigNumber>
+The resulting filter
+
+ -
+
notEquals
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'ne', i.e.
+!=.Parameters
+-
+
-
+
value: BigNumber
+++Value to be used in the filter
+
+
Returns Filter<EntityT, BigNumber>
+The resulting filter
+
+ -
+
+
+
+
+
+ Class ComplexTypeBinaryPropertyField<EntityT, ComplexT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.complextypebooleanpropertyfield.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.complextypebooleanpropertyfield.html
new file mode 100644
index 0000000000..ba74f4c933
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.complextypebooleanpropertyfield.html
@@ -0,0 +1,509 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ Readonly _field
+
+
+
+
+
+ Readonly edm
+
+
+
+
+
+ Readonly field
+
+
+
+
+
+
+
+
+
+
+ field
+
+
+
+ not
+
+
+
+
+
+
+
+
+ Represents a complex type property with a binary value.
+Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity the field belongs to
+
+ -
+
ComplexT = any
+
+
Hierarchy
+-
+
-
+ BinaryFieldBase<EntityT>
+
-
+
- + ComplexTypeBinaryPropertyField + +
+
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- _entity +
- _entity
Constructor
+ - _field
Name
+ - edm
Type
+ - field
Of
+
Methods
+ +Constructors
+constructor
+-
+
+
+
-
+
-
+
+ ++++
Creates an instance of ComplexTypeBinaryPropertyField.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+ -
+
ComplexT = any
+
+
Parameters
+-
+
-
+
fieldName: string
+++Actual name of the field used in the OData request
+
+ -
+
fieldOf: ConstructorOrField<EntityT, ComplexT>
+++The constructor of the entity or the complex type this field belongs to
+
+ -
+
edmType: EdmTypeShared<VersionT>
+++Type of the field according to the metadata description
+
+
Returns ComplexTypeBinaryPropertyField<EntityT, ComplexT>
+
+ -
+
-
+
+ + ++
Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+ -
+
ComplexT = any
+
+
Parameters
+-
+
-
+
fieldName: string
+++Actual name of the field used in the OData request
+
+ -
+
entityConstructor: Constructable<EntityT, unknown>
+++Constructor type of the entity the field belongs to
+
+ -
+
parentTypeName: string
+++Name of the parent complex type
+
+ -
+
edmType: EdmTypeShared<VersionT>
+++Type of the field according to the metadata description
+
+
Returns ComplexTypeBinaryPropertyField<EntityT, ComplexT>
+
+ -
+
Properties
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ Readonly _fieldName
+
+
+ Readonly edmType
+
+
+ Readonly fieldOf
+
+
+
+
+
+
+ The constructor of the entity or the complex type this field belongs to
+Methods
+equals
+-
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'eq', i.e.
+==.Parameters
+-
+
-
+
value: string
+++Value to be used in the filter
+
+
Returns Filter<EntityT, string>
+The resulting filter
+
+ -
+
fieldPath
+ -
+
+
-
+
-
+
+ ++++
Path to the field to be used in filter and order by queries. Combines the parent complex type name with the field name.
+Returns string
+Path to the field to be used in filter and order by queries.
+
+
notEquals
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'ne', i.e.
+!=.Parameters
+-
+
-
+
value: string
+++Value to be used in the filter
+
+
Returns Filter<EntityT, string>
+The resulting filter
+
+ -
+
+
+
+
+
+ Class ComplexTypeBooleanPropertyField<EntityT, ComplexT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.complextypedatepropertyfield.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.complextypedatepropertyfield.html
new file mode 100644
index 0000000000..5c18eeb776
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.complextypedatepropertyfield.html
@@ -0,0 +1,657 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ Readonly _field
+
+
+
+
+
+ Readonly edm
+
+
+
+
+
+ Readonly field
+
+
+
+
+
+
+
+
+
+
+ field
+
+
+
+ not
+
+
+
+
+
+
+
+
+ Represents a complex type property with a boolean value.
+Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity the field belongs to
+
+ -
+
ComplexT = any
+
+
Hierarchy
+-
+
-
+ BooleanFieldBase<EntityT>
+
-
+
- + ComplexTypeBooleanPropertyField + +
+
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- _entity +
- _entity
Constructor
+ - _field
Name
+ - edm
Type
+ - field
Of
+
Methods
+ +Constructors
+constructor
+-
+
+
+
-
+
-
+
+ ++++
Creates an instance of ComplexTypeBooleanPropertyField.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+ -
+
ComplexT = any
+
+
Parameters
+-
+
-
+
fieldName: string
+++Actual name of the field used in the OData request
+
+ -
+
fieldOf: ConstructorOrField<EntityT, ComplexT>
+++The constructor of the entity or the complex type this field belongs to
+
+ -
+
edmType: EdmTypeShared<VersionT>
+++Type of the field according to the metadata description
+
+
Returns ComplexTypeBooleanPropertyField<EntityT, ComplexT>
+
+ -
+
-
+
+ + ++
Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+ -
+
ComplexT = any
+
+
Parameters
+-
+
-
+
fieldName: string
+++Actual name of the field used in the OData request
+
+ -
+
entityConstructor: Constructable<EntityT, unknown>
+++Constructor type of the entity the field belongs to
+
+ -
+
parentTypeName: string
+++Name of the parent complex type
+
+ -
+
edmType: EdmTypeShared<VersionT>
+++Type of the field according to the metadata description
+
+
Returns ComplexTypeBooleanPropertyField<EntityT, ComplexT>
+
+ -
+
Properties
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ Readonly _fieldName
+
+
+ Readonly edmType
+
+
+ Readonly fieldOf
+
+
+
+
+
+
+ The constructor of the entity or the complex type this field belongs to
+Methods
+equals
+-
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'eq', i.e.
+==.Parameters
+-
+
-
+
value: boolean
+++Value to be used in the filter
+
+
Returns Filter<EntityT, boolean>
+The resulting filter
+
+ -
+
fieldPath
+ -
+
+
-
+
-
+
+ ++++
Path to the field to be used in filter and order by queries. Combines the parent complex type name with the field name.
+Returns string
+Path to the field to be used in filter and order by queries.
+
+
notEquals
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'ne', i.e.
+!=.Parameters
+-
+
-
+
value: boolean
+++Value to be used in the filter
+
+
Returns Filter<EntityT, boolean>
+The resulting filter
+
+ -
+
+
+
+
+
+ Class ComplexTypeDatePropertyField<EntityT, ComplexT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.complextypedurationpropertyfield.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.complextypedurationpropertyfield.html
new file mode 100644
index 0000000000..299eb731ee
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.complextypedurationpropertyfield.html
@@ -0,0 +1,657 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ Readonly _field
+
+
+
+
+
+ Readonly edm
+
+
+
+
+
+ Readonly field
+
+
+
+
+
+
+
+
+
+
+ field
+
+
+
+ greater
+
+
+
+ greater
+
+
+
+ less
+
+
+
+ less
+
+
+
+ not
+
+
+
+
+
+
+
+
+ Represents a complex type property with a date value.
+Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity the field belongs to
+
+ -
+
ComplexT = any
+
+
Hierarchy
+-
+
-
+ DateFieldBase<EntityT>
+
-
+
- + ComplexTypeDatePropertyField + +
+
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- _entity +
- _entity
Constructor
+ - _field
Name
+ - edm
Type
+ - field
Of
+
Methods
+-
+
- equals +
- field
Path
+ - greater
OrEqual
+ - greater
Than
+ - less
OrEqual
+ - less
Than
+ - not
Equals
+
Constructors
+constructor
+-
+
+
+
-
+
-
+
+ ++++
Creates an instance of ComplexTypeDatePropertyField.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+ -
+
ComplexT = any
+
+
Parameters
+-
+
-
+
fieldName: string
+++Actual name of the field used in the OData request
+
+ -
+
fieldOf: ConstructorOrField<EntityT, ComplexT>
+++The constructor of the entity or the complex type this field belongs to
+
+ -
+
edmType: EdmTypeShared<VersionT>
+++Type of the field according to the metadata description
+
+
Returns ComplexTypeDatePropertyField<EntityT, ComplexT>
+
+ -
+
-
+
+ + ++
Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+ -
+
ComplexT = any
+
+
Parameters
+-
+
-
+
fieldName: string
+++Actual name of the field used in the OData request
+
+ -
+
entityConstructor: Constructable<EntityT, unknown>
+++Constructor type of the entity the field belongs to
+
+ -
+
parentTypeName: string
+++Name of the parent complex type
+
+ -
+
edmType: EdmTypeShared<VersionT>
+++Type of the field according to the metadata description
+
+
Returns ComplexTypeDatePropertyField<EntityT, ComplexT>
+
+ -
+
Properties
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ Readonly _fieldName
+
+
+ Readonly edmType
+
+
+ Readonly fieldOf
+
+
+
+
+
+
+ The constructor of the entity or the complex type this field belongs to
+Methods
+equals
+-
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'eq', i.e.
+==.Parameters
+-
+
-
+
value: Moment
+++Value to be used in the filter
+
+
Returns Filter<EntityT, Moment>
+The resulting filter
+
+ -
+
fieldPath
+ -
+
+
-
+
-
+
+ ++++
Path to the field to be used in filter and order by queries. Combines the parent complex type name with the field name.
+Returns string
+Path to the field to be used in filter and order by queries.
+
+
greaterOrEqual
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'ge', i.e.
+>=.Parameters
+-
+
-
+
value: Moment
+++Value to be used in the filter
+
+
Returns Filter<EntityT, Moment>
+The resulting filter
+
+ -
+
greaterThan
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'gt', i.e.
+>.Parameters
+-
+
-
+
value: Moment
+++Value to be used in the filter
+
+
Returns Filter<EntityT, Moment>
+The resulting filter
+
+ -
+
lessOrEqual
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'le', i.e.
+<=.Parameters
+-
+
-
+
value: Moment
+++Value to be used in the filter
+
+
Returns Filter<EntityT, Moment>
+The resulting filter
+
+ -
+
lessThan
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'lt', i.e.
+<.Parameters
+-
+
-
+
value: Moment
+++Value to be used in the filter
+
+
Returns Filter<EntityT, Moment>
+The resulting filter
+
+ -
+
notEquals
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'ne', i.e.
+!=.Parameters
+-
+
-
+
value: Moment
+++Value to be used in the filter
+
+
Returns Filter<EntityT, Moment>
+The resulting filter
+
+ -
+
+
+
+
+
+ Class ComplexTypeDurationPropertyField<EntityT, ComplexT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.complextypeenumpropertyfield.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.complextypeenumpropertyfield.html
new file mode 100644
index 0000000000..2aad86ee2c
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.complextypeenumpropertyfield.html
@@ -0,0 +1,438 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ Readonly _field
+
+
+
+
+
+ Readonly edm
+
+
+
+
+
+ Readonly field
+
+
+
+
+
+
+
+
+
+
+ field
+
+
+
+ greater
+
+
+
+ greater
+
+
+
+ less
+
+
+
+ less
+
+
+
+ not
+
+
+
+
+
+
+
+
+ Represents a complex type property with a duration value.
+Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity the field belongs to
+
+ -
+
ComplexT = any
+
+
Hierarchy
+-
+
-
+ DurtionFieldBase<EntityT>
+
-
+
- + ComplexTypeDurationPropertyField + +
+
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- _entity +
- _entity
Constructor
+ - _field
Name
+ - edm
Type
+ - field
Of
+
Methods
+-
+
- equals +
- field
Path
+ - greater
OrEqual
+ - greater
Than
+ - less
OrEqual
+ - less
Than
+ - not
Equals
+
Constructors
+constructor
+-
+
+
+
-
+
-
+
+ ++++
Creates an instance of ComplexTypeDurationPropertyField.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+ -
+
ComplexT = any
+
+
Parameters
+-
+
-
+
fieldName: string
+++Actual name of the field used in the OData request
+
+ -
+
fieldOf: ConstructorOrField<EntityT, ComplexT>
+++The constructor of the entity or the complex type this field belongs to
+
+ -
+
edmType: EdmTypeShared<VersionT>
+++Type of the field according to the metadata description
+
+
Returns ComplexTypeDurationPropertyField<EntityT, ComplexT>
+
+ -
+
-
+
+ + ++
Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+ -
+
ComplexT = any
+
+
Parameters
+-
+
-
+
fieldName: string
+++Actual name of the field used in the OData request
+
+ -
+
entityConstructor: Constructable<EntityT, unknown>
+++Constructor type of the entity the field belongs to
+
+ -
+
parentTypeName: string
+++Name of the parent complex type
+
+ -
+
edmType: EdmTypeShared<VersionT>
+++Type of the field according to the metadata description
+
+
Returns ComplexTypeDurationPropertyField<EntityT, ComplexT>
+
+ -
+
Properties
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ Readonly _fieldName
+
+
+ Readonly edmType
+
+
+ Readonly fieldOf
+
+
+
+
+
+
+ The constructor of the entity or the complex type this field belongs to
+Methods
+equals
+-
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'eq', i.e.
+==.Parameters
+-
+
-
+
value: Duration
+++Value to be used in the filter
+
+
Returns Filter<EntityT, Duration>
+The resulting filter
+
+ -
+
fieldPath
+ -
+
+
-
+
-
+
+ ++++
Path to the field to be used in filter and order by queries. Combines the parent complex type name with the field name.
+Returns string
+Path to the field to be used in filter and order by queries.
+
+
greaterOrEqual
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'ge', i.e.
+>=.Parameters
+-
+
-
+
value: Duration
+++Value to be used in the filter
+
+
Returns Filter<EntityT, Duration>
+The resulting filter
+
+ -
+
greaterThan
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'gt', i.e.
+>.Parameters
+-
+
-
+
value: Duration
+++Value to be used in the filter
+
+
Returns Filter<EntityT, Duration>
+The resulting filter
+
+ -
+
lessOrEqual
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'le', i.e.
+<=.Parameters
+-
+
-
+
value: Duration
+++Value to be used in the filter
+
+
Returns Filter<EntityT, Duration>
+The resulting filter
+
+ -
+
lessThan
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'lt', i.e.
+<.Parameters
+-
+
-
+
value: Duration
+++Value to be used in the filter
+
+
Returns Filter<EntityT, Duration>
+The resulting filter
+
+ -
+
notEquals
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'ne', i.e.
+!=.Parameters
+-
+
-
+
value: Duration
+++Value to be used in the filter
+
+
Returns Filter<EntityT, Duration>
+The resulting filter
+
+ -
+
+
+
+
+
+ Class ComplexTypeEnumPropertyField<EntityT, ComplexT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.complextypefield.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.complextypefield.html
new file mode 100644
index 0000000000..51755fdf9f
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.complextypefield.html
@@ -0,0 +1,434 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ Readonly _field
+
+
+
+
+
+ Readonly edm
+
+
+
+
+
+ Readonly field
+
+
+
+
+
+
+
+
+
+
+ field
+
+
+
+ not
+
+
+
+
+
+
+
+
+ Represents a complex type property with a enum value.
+Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity the field belongs to
+
+ -
+
ComplexT = any
+
+
Hierarchy
+-
+
-
+ EnumFieldBase<EntityT>
+
-
+
- + ComplexTypeEnumPropertyField + +
+
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- _entity +
- _entity
Constructor
+ - _field
Name
+ - edm
Type
+ - field
Of
+
Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of ComplexTypeEnumPropertyField.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+ -
+
ComplexT = any
+
+
Parameters
+-
+
-
+
fieldName: string
+++Actual name of the field used in the OData request
+
+ -
+
fieldOf: ConstructorOrField<EntityT, ComplexT>
+++The constructor of the entity or the complex type this field belongs to
+
+
Returns ComplexTypeEnumPropertyField<EntityT, ComplexT>
+
+ -
+
Properties
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ Readonly _fieldName
+
+
+ Readonly edmType
+
+
+ Readonly fieldOf
+
+
+
+
+
+
+ The constructor of the entity or the complex type this field belongs to
+Methods
+equals
+-
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'eq', i.e.
+==.Parameters
+-
+
-
+
value: string
+++Value to be used in the filter
+
+
Returns Filter<EntityT, string>
+The resulting filter
+
+ -
+
fieldPath
+ -
+
+
-
+
-
+
+ ++++
Path to the field to be used in filter and order by queries. Combines the parent complex type name with the field name.
+Returns string
+Path to the field to be used in filter and order by queries.
+
+
notEquals
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'ne', i.e.
+!=.Parameters
+-
+
-
+
value: string
+++Value to be used in the filter
+
+
Returns Filter<EntityT, string>
+The resulting filter
+
+ -
+
+
+
+
+
+ Class ComplexTypeField<EntityT, ComplexT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.complextypenumberpropertyfield.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.complextypenumberpropertyfield.html
new file mode 100644
index 0000000000..6b6b5e6629
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.complextypenumberpropertyfield.html
@@ -0,0 +1,657 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _complex
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ Readonly _field
+
+
+
+
+
+ Readonly field
+
+
+
+
+
+
+
+ field
+
+
+
+
+
+
+
+
+ Represents a complex type property of an entity.
+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.
+ For example, when constructing a query on the TimeSheetEntry entity, an instance of ComplexTypeField<TimeSheetEntry>
+ can be supplied as argument to the select function, e.g. TimeSheetEntry.TIME_SHEET_DATA_FIELDS.
+ Moreover, classes implementing this abstract class will provide property fields, that can be used for filtering and ordering.
See also: Selectable
+Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity the field belongs to
+
+ -
+
ComplexT = any
+
+
Hierarchy
+-
+
-
+ Field<EntityT>
+
-
+
- + ComplexTypeField + +
+
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- _complex
Type
+ - _entity +
- _entity
Constructor
+ - _field
Name
+ - field
Of
+
Methods
+-
+
- field
Path
+
Constructors
+constructor
+-
+
+
+
-
+
-
+
+ ++++
Creates an instance of ComplexTypeField.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+ -
+
ComplexT = any
+
+
Parameters
+-
+
-
+
fieldName: string
+++Actual name of the field as used in the OData request.
+
+ -
+
fieldOf: ConstructorOrField<EntityT, ComplexT>
+++Either the parent entity constructor of the parent complex type this field belongs to.
+
+ -
+
Optional complexType: ComplexTypeNamespace<ComplexT>
+++The complex type of the complex type property represented by this.
+
+
Returns ComplexTypeField<EntityT, ComplexT>
+
+ -
+
-
+
+ + ++
Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+ -
+
ComplexT = any
+
+
Parameters
+-
+
-
+
fieldName: string
+++Actual name of the field as used in the OData request.
+
+ -
+
entityConstructor: Constructable<EntityT, unknown>
+++Constructor type of the entity the field belongs to.
+
+ -
+
complexTypeName: string
+++Name of the type of the field according to the metadata description.
+
+
Returns ComplexTypeField<EntityT, ComplexT>
+
+ -
+
Properties
+Readonly _complexType
+
+
+
+
+
+
+ The complex type of the complex type property represented by this.
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ Readonly _fieldName
+
+
+ Readonly fieldOf
+
+
+ Methods
+fieldPath
+ -
+
+
-
+
-
+
+ ++++
Gets the path to the complex type property represented by this.
+Returns string
+The path to the complex type property.
+
+
+
+
+
+
+ Class ComplexTypeNumberPropertyField<EntityT, ComplexT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.complextypestringpropertyfield.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.complextypestringpropertyfield.html
new file mode 100644
index 0000000000..c9d8337ff4
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.complextypestringpropertyfield.html
@@ -0,0 +1,497 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ Readonly _field
+
+
+
+
+
+ Readonly edm
+
+
+
+
+
+ Readonly field
+
+
+
+
+
+
+
+
+
+
+ field
+
+
+
+ greater
+
+
+
+ greater
+
+
+
+ less
+
+
+
+ less
+
+
+
+ not
+
+
+
+
+
+
+
+
+ Represents a complex type property with a number value.
+Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity the field belongs to
+
+ -
+
ComplexT = any
+
+
Hierarchy
+-
+
-
+ NumberFieldBase<EntityT>
+
-
+
- + ComplexTypeNumberPropertyField + +
+
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- _entity +
- _entity
Constructor
+ - _field
Name
+ - edm
Type
+ - field
Of
+
Methods
+-
+
- equals +
- field
Path
+ - greater
OrEqual
+ - greater
Than
+ - less
OrEqual
+ - less
Than
+ - not
Equals
+
Constructors
+constructor
+-
+
+
+
-
+
-
+
+ ++++
Creates an instance of ComplexTypeNumberPropertyField.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+ -
+
ComplexT = any
+
+
Parameters
+-
+
-
+
fieldName: string
+++Actual name of the field used in the OData request
+
+ -
+
fieldOf: ConstructorOrField<EntityT, ComplexT>
+++The constructor of the entity or the complex type this field belongs to
+
+ -
+
edmType: EdmTypeShared<VersionT>
+++Type of the field according to the metadata description
+
+
Returns ComplexTypeNumberPropertyField<EntityT, ComplexT>
+
+ -
+
-
+
+ + ++
Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+ -
+
ComplexT = any
+
+
Parameters
+-
+
-
+
fieldName: string
+++Actual name of the field used in the OData request
+
+ -
+
entityConstructor: Constructable<EntityT, unknown>
+++Constructor type of the entity the field belongs to
+
+ -
+
parentTypeName: string
+++Name of the parent complex type
+
+ -
+
edmType: EdmTypeShared<VersionT>
+++Type of the field according to the metadata description
+
+
Returns ComplexTypeNumberPropertyField<EntityT, ComplexT>
+
+ -
+
Properties
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ Readonly _fieldName
+
+
+ Readonly edmType
+
+
+ Readonly fieldOf
+
+
+
+
+
+
+ The constructor of the entity or the complex type this field belongs to
+Methods
+equals
+-
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'eq', i.e.
+==.Parameters
+-
+
-
+
value: number
+++Value to be used in the filter
+
+
Returns Filter<EntityT, number>
+The resulting filter
+
+ -
+
fieldPath
+ -
+
+
-
+
-
+
+ ++++
Path to the field to be used in filter and order by queries. Combines the parent complex type name with the field name.
+Returns string
+Path to the field to be used in filter and order by queries.
+
+
greaterOrEqual
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'ge', i.e.
+>=.Parameters
+-
+
-
+
value: number
+++Value to be used in the filter
+
+
Returns Filter<EntityT, number>
+The resulting filter
+
+ -
+
greaterThan
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'gt', i.e.
+>.Parameters
+-
+
-
+
value: number
+++Value to be used in the filter
+
+
Returns Filter<EntityT, number>
+The resulting filter
+
+ -
+
lessOrEqual
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'le', i.e.
+<=.Parameters
+-
+
-
+
value: number
+++Value to be used in the filter
+
+
Returns Filter<EntityT, number>
+The resulting filter
+
+ -
+
lessThan
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'lt', i.e.
+<.Parameters
+-
+
-
+
value: number
+++Value to be used in the filter
+
+
Returns Filter<EntityT, number>
+The resulting filter
+
+ -
+
notEquals
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'ne', i.e.
+!=.Parameters
+-
+
-
+
value: number
+++Value to be used in the filter
+
+
Returns Filter<EntityT, number>
+The resulting filter
+
+ -
+
+
+
+
+
+ Class ComplexTypeStringPropertyField<EntityT, ComplexT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.complextypetimepropertyfield.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.complextypetimepropertyfield.html
new file mode 100644
index 0000000000..7f85448165
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.complextypetimepropertyfield.html
@@ -0,0 +1,657 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ Readonly _field
+
+
+
+
+
+ Readonly edm
+
+
+
+
+
+ Readonly field
+
+
+
+
+
+
+
+
+
+
+ field
+
+
+
+ not
+
+
+
+
+
+
+
+
+ Represents a complex type property with a string value.
+Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity the field belongs to
+
+ -
+
ComplexT = any
+
+
Hierarchy
+-
+
-
+ StringFieldBase<EntityT>
+
-
+
- + ComplexTypeStringPropertyField + +
+
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- _entity +
- _entity
Constructor
+ - _field
Name
+ - edm
Type
+ - field
Of
+
Methods
+ +Constructors
+constructor
+-
+
+
+
-
+
-
+
+ ++++
Creates an instance of ComplexTypeStringPropertyField.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+ -
+
ComplexT = any
+
+
Parameters
+-
+
-
+
fieldName: string
+++Actual name of the field used in the OData request
+
+ -
+
fieldOf: ConstructorOrField<EntityT, ComplexT>
+++The constructor of the entity or the complex type this field belongs to
+
+ -
+
edmType: EdmTypeShared<VersionT>
+++Type of the field according to the metadata description
+
+
Returns ComplexTypeStringPropertyField<EntityT, ComplexT>
+
+ -
+
-
+
+ + ++
Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+ -
+
ComplexT = any
+
+
Parameters
+-
+
-
+
fieldName: string
+++Actual name of the field used in the OData request
+
+ -
+
entityConstructor: Constructable<EntityT, unknown>
+++Constructor type of the entity the field belongs to
+
+ -
+
parentTypeName: string
+++Name of the parent complex type
+
+ -
+
edmType: EdmTypeShared<VersionT>
+++Type of the field according to the metadata description
+
+
Returns ComplexTypeStringPropertyField<EntityT, ComplexT>
+
+ -
+
Properties
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ Readonly _fieldName
+
+
+ Readonly edmType
+
+
+ Readonly fieldOf
+
+
+
+
+
+
+ The constructor of the entity or the complex type this field belongs to
+Methods
+equals
+-
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'eq', i.e.
+==.Parameters
+-
+
-
+
value: string
+++Value to be used in the filter
+
+
Returns Filter<EntityT, string>
+The resulting filter
+
+ -
+
fieldPath
+ -
+
+
-
+
-
+
+ ++++
Path to the field to be used in filter and order by queries. Combines the parent complex type name with the field name.
+Returns string
+Path to the field to be used in filter and order by queries.
+
+
notEquals
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'ne', i.e.
+!=.Parameters
+-
+
-
+
value: string
+++Value to be used in the filter
+
+
Returns Filter<EntityT, string>
+The resulting filter
+
+ -
+
+
+
+
+
+ Class ComplexTypeTimePropertyField<EntityT, ComplexT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.countrequestbuilder.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.countrequestbuilder.html
new file mode 100644
index 0000000000..7c7392ba50
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.countrequestbuilder.html
@@ -0,0 +1,678 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ Readonly _field
+
+
+
+
+
+ Readonly edm
+
+
+
+
+
+ Readonly field
+
+
+
+
+
+
+
+
+
+
+ field
+
+
+
+ greater
+
+
+
+ greater
+
+
+
+ less
+
+
+
+ less
+
+
+
+ not
+
+
+
+
+
+
+
+
+ Represents a complex type property with a time value.
+Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity the field belongs to
+
+ -
+
ComplexT = any
+
+
Hierarchy
+-
+
-
+ TimeFieldBase<EntityT>
+
-
+
- + ComplexTypeTimePropertyField + +
+
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- _entity +
- _entity
Constructor
+ - _field
Name
+ - edm
Type
+ - field
Of
+
Methods
+-
+
- equals +
- field
Path
+ - greater
OrEqual
+ - greater
Than
+ - less
OrEqual
+ - less
Than
+ - not
Equals
+
Constructors
+constructor
+-
+
+
+
-
+
-
+
+ ++++
Creates an instance of ComplexTypeTimePropertyField.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+ -
+
ComplexT = any
+
+
Parameters
+-
+
-
+
fieldName: string
+++Actual name of the field used in the OData request
+
+ -
+
fieldOf: ConstructorOrField<EntityT, ComplexT>
+++The constructor of the entity or the complex type this field belongs to
+
+ -
+
edmType: EdmTypeShared<VersionT>
+++Type of the field according to the metadata description
+
+
Returns ComplexTypeTimePropertyField<EntityT, ComplexT>
+
+ -
+
-
+
+ + ++
Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+ -
+
ComplexT = any
+
+
Parameters
+-
+
-
+
fieldName: string
+++Actual name of the field used in the OData request
+
+ -
+
entityConstructor: Constructable<EntityT, unknown>
+++Constructor type of the entity the field belongs to
+
+ -
+
parentTypeName: string
+++Name of the parent complex type
+
+ -
+
edmType: EdmTypeShared<VersionT>
+++Type of the field according to the metadata description
+
+
Returns ComplexTypeTimePropertyField<EntityT, ComplexT>
+
+ -
+
Properties
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ Readonly _fieldName
+
+
+ Readonly edmType
+
+
+ Readonly fieldOf
+
+
+
+
+
+
+ The constructor of the entity or the complex type this field belongs to
+Methods
+equals
+-
+
+
fieldPath
+ -
+
+
-
+
-
+
+ ++++
Path to the field to be used in filter and order by queries. Combines the parent complex type name with the field name.
+Returns string
+Path to the field to be used in filter and order by queries.
+
+
greaterOrEqual
+ -
+
+
greaterThan
+ -
+
+
lessOrEqual
+ -
+
+
lessThan
+ -
+
+
notEquals
+ -
+
+
+
+
+
+
+ Class CountRequestBuilder<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.createrequestbuilder.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.createrequestbuilder.html
new file mode 100644
index 0000000000..ae63059f97
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.createrequestbuilder.html
@@ -0,0 +1,875 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly get
+
+
+
+
+
+ request
+
+
+
+
+
+
+
+ add
+
+
+
+ add
+
+
+
+
+
+
+
+
+
+ relative
+
+
+
+ set
+
+
+
+
+
+
+ with
+
+
+
+ with
+
+
+
+ with
+
+
+
+
+
+
+
+
+ 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: EntityBase
+++++Type of the entity to be requested
+
+
Hierarchy
+-
+
-
+ MethodRequestBuilder<ODataCountRequestConfig<EntityT>>
+
-
+
- + CountRequestBuilder + +
+
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- get
All Request
+ - request
Config
+
Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of CountRequestBuilder.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
getAllRequest: GetAllRequestBuilderBase<EntityT>
+
+
Returns CountRequestBuilder<EntityT>
+
+ -
+
Properties
+Readonly getAllRequest
+
+
+ requestConfig
+
+
+ Methods
+addCustomHeaders
+ -
+
+
-
+
-
+
+ ++++
Add custom headers to the request. Existing headers will be overwritten.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs denoting additional custom headers.
+
+
Returns CountRequestBuilder<EntityT>
+The request builder itself, to facilitate method chaining.
+
+ -
+
addCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++
Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs denoting additional custom query parameters to be set in the request
+
+
Returns CountRequestBuilder<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
build
+-
+
+
+
-
+
-
+
+
Returns ODataRequest<ODataCountRequestConfig<EntityT>>
+
+ -
+
+
Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+
+ -
+
Optional options: (DestinationCachingOptions & ResilienceOptions) | (CachingOptions & ResilienceOptions)
+
+
Returns Promise<ODataRequest<ODataCountRequestConfig<EntityT>>>
+
+ -
+
execute
+-
+
+
-
+
-
+
+ ++++
Execute request.
+Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++Destination to execute the request against
+
+ -
+
Optional options: (DestinationAccessorOptions & DestinationCachingOptions & ResilienceOptions & VerifyJwtOptions) | (DestinationAccessorOptions & CachingOptions & ResilienceOptions & VerifyJwtOptions)
+++Options to employ when fetching destinations
+
+
Returns Promise<number>
+A promise resolving to the number of entities
+
+ -
+
relativeUrl
+ -
+
+
-
+
-
+
+ ++++
Create the relative url based on configuration of the given builder.
+Returns string
+The relative url for the request
+
+
setCustomServicePath
+ -
+
+
-
+
-
+
+ ++++
Replace the default service path with the given custom path. + In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/
+' and can be overwritten here. Parameters
+-
+
-
+
servicePath: string
+++Path to override the default with
+
+
Returns CountRequestBuilder<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
url
+-
+
+
-
+
-
+
+ ++++
Create the url based on configuration of the given builder.
+Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++Destination to execute the request against
+
+ -
+
Optional options: (DestinationCachingOptions & ResilienceOptions) | (CachingOptions & ResilienceOptions)
+++Options to employ when fetching destinations.
+
+
Returns Promise<string>
+Promise resolving to the url for the request
+
+ -
+
withCustomHeaders
+ -
+
+
-
+
-
+
+ ++++ +
Add custom headers to the request.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs denoting additional custom headers
+
+
Returns CountRequestBuilder<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++ +
Add custom query parameters to the request.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs denoting additional custom query parameters to be set in the request
+
+
Returns CountRequestBuilder<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomServicePath
+ -
+
+
-
+
-
+
+ ++++ +
Replace the default service path with the given custom path. + In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/
+' and can be overwritten here. Parameters
+-
+
-
+
servicePath: string
+++Path to override the default with
+
+
Returns CountRequestBuilder<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
+
+
+
+
+ Class CreateRequestBuilder<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.createrequestbuilderbase.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.createrequestbuilderbase.html
new file mode 100644
index 0000000000..27c2d90e3e
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.createrequestbuilderbase.html
@@ -0,0 +1,887 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+
+
+
+ Readonly odata
+
+
+
+
+
+ request
+
+
+
+
+
+ Readonly response
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ add
+
+
+
+ add
+
+
+
+ as
+
+
+
+
+
+
+
+
+
+
+
+
+ relative
+
+
+
+ set
+
+
+
+
+
+
+ with
+
+
+
+ with
+
+
+
+ with
+
+
+
+
+
+
+
+
+ Create OData request to create an entity.
+Type parameters
+-
+
-
+
EntityT: Entity
+++++Type of the entity to be created
+
+
Hierarchy
+-
+
-
+ CreateRequestBuilderBase<EntityT>
+
-
+
- + CreateRequestBuilder + +
+
Implements
+-
+
- EntityIdentifiable<EntityT> +
Index
+
+
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- _entity +
- _entity
Constructor
+ - deserializer +
- odata
Uri
+ - request
Config
+ - response
Data Accessor
+ - serializer +
Accessors
+-
+
- entity +
Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of CreateRequestBuilder.
+Type parameters
+-
+
-
+
EntityT: Entity<EntityT>
+
+
Parameters
+-
+
-
+
_entityConstructor: Constructable<EntityT, unknown>
+++Constructor type of the entity to be created
+
+ -
+
_entity: EntityT
+++Entity to be created
+
+
Returns CreateRequestBuilder<EntityT>
+
+ -
+
Properties
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ Readonly deserializer
+ + +Readonly odataUri
+
+
+ requestConfig
+
+
+ Readonly responseDataAccessor
+
+
+ Readonly serializer
+ + +Accessors
+entity
+-
+
+
-
+
-
+
+
Returns EntityT
+
+
Methods
+addCustomHeaders
+ -
+
+
-
+
-
+
+ ++++
Add custom headers to the request. Existing headers will be overwritten.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs denoting additional custom headers.
+
+
Returns CreateRequestBuilder<EntityT>
+The request builder itself, to facilitate method chaining.
+
+ -
+
addCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++
Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs denoting additional custom query parameters to be set in the request
+
+
Returns CreateRequestBuilder<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
asChildOf
+ -
+
+
-
+
-
+
+ ++++
Specifies the parent of the entity to create.
+Type parameters
+-
+
-
+
ParentEntityT: EntityBase<ParentEntityT>
+
+
Parameters
+-
+
-
+
parentEntity: ParentEntityT
+++Parent of the entity to create
+
+ -
+
linkField: Link<ParentEntityT, EntityT>
+++Static representation of the navigation property that navigates from the parent entity to the child entity
+
+
Returns CreateRequestBuilder<EntityT>
+The entity itself, to facilitate method chaining
+
+ -
+
build
+-
+
+
+
-
+
-
+
+
Returns ODataRequest<ODataCreateRequestConfig<EntityT>>
+
+ -
+
+
Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+
+ -
+
Optional options: (DestinationCachingOptions & ResilienceOptions) | (CachingOptions & ResilienceOptions)
+
+
Returns Promise<ODataRequest<ODataCreateRequestConfig<EntityT>>>
+
+ -
+
execute
+-
+
+
-
+
-
+
+ ++++
Execute query.
+Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++Destination to execute the request against
+
+ -
+
Optional options: (DestinationAccessorOptions & DestinationCachingOptions & ResilienceOptions & VerifyJwtOptions) | (DestinationAccessorOptions & CachingOptions & ResilienceOptions & VerifyJwtOptions)
+++Options to employ when fetching destinations
+
+
Returns Promise<EntityT>
+A promise resolving to the created entity
+
+ -
+
prepare
+-
+
+
-
+
-
+
+ + ++
Returns CreateRequestBuilder<EntityT>
+the builder itself
+
+
relativeUrl
+ -
+
+
-
+
-
+
+ ++++
Create the relative url based on configuration of the given builder.
+Returns string
+The relative url for the request
+
+
setCustomServicePath
+ -
+
+
-
+
-
+
+ ++++
Replace the default service path with the given custom path. + In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/
+' and can be overwritten here. Parameters
+-
+
-
+
servicePath: string
+++Path to override the default with
+
+
Returns CreateRequestBuilder<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
url
+-
+
+
-
+
-
+
+ ++++
Create the url based on configuration of the given builder.
+Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++Destination to execute the request against
+
+ -
+
Optional options: (DestinationCachingOptions & ResilienceOptions) | (CachingOptions & ResilienceOptions)
+++Options to employ when fetching destinations.
+
+
Returns Promise<string>
+Promise resolving to the url for the request
+
+ -
+
withCustomHeaders
+ -
+
+
-
+
-
+
+ ++++ +
Add custom headers to the request.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs denoting additional custom headers
+
+
Returns CreateRequestBuilder<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++ +
Add custom query parameters to the request.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs denoting additional custom query parameters to be set in the request
+
+
Returns CreateRequestBuilder<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomServicePath
+ -
+
+
-
+
-
+
+ ++++ +
Replace the default service path with the given custom path. + In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/
+' and can be overwritten here. Parameters
+-
+
-
+
servicePath: string
+++Path to override the default with
+
+
Returns CreateRequestBuilder<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
+
+
+
+
+ Class CreateRequestBuilderBase<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.createrequestbuilderv4.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.createrequestbuilderv4.html
new file mode 100644
index 0000000000..102be80f28
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.createrequestbuilderv4.html
@@ -0,0 +1,875 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+
+
+
+ Readonly odata
+
+
+
+
+
+ request
+
+
+
+
+
+ Readonly response
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ add
+
+
+
+ add
+
+
+
+ as
+
+
+
+
+
+
+
+
+
+
+
+
+ relative
+
+
+
+ set
+
+
+
+
+
+
+ with
+
+
+
+ with
+
+
+
+ with
+
+
+
+
+
+
+
+
+ Abstract create request class holding the parts shared in OData v2 and v4.
+Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity to be created
+
+
Hierarchy
+-
+
-
+ MethodRequestBuilder<ODataCreateRequestConfig<EntityT>>
+
-
+
-
+ CreateRequestBuilderBase
+
-
+
- + CreateRequestBuilder + +
- + CreateRequestBuilderV4 + +
+
+ -
+ CreateRequestBuilderBase
+
Implements
+-
+
- EntityIdentifiable<EntityT> +
Index
+
+
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- _entity +
- _entity
Constructor
+ - deserializer +
- odata
Uri
+ - request
Config
+ - response
Data Accessor
+ - serializer +
Accessors
+-
+
- entity +
Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of CreateRequestBuilder.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
_entityConstructor: Constructable<EntityT, unknown>
+++Constructor type of the entity to be created
+
+ -
+
_entity: EntityT
+++Entity to be created
+
+ -
+
odataUri: ODataUri
+
+ -
+
serializer: EntitySerializer<any, any>
+
+ -
+
deserializer: EntityDeserializer<any>
+
+ -
+
responseDataAccessor: ResponseDataAccessor
+
+
Returns CreateRequestBuilderBase<EntityT>
+
+ -
+
Properties
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ Readonly deserializer
+ + +Readonly odataUri
+
+
+ requestConfig
+
+
+ Readonly responseDataAccessor
+
+
+ Readonly serializer
+ + +Accessors
+entity
+-
+
+
-
+
-
+
+
Returns EntityT
+
+
Methods
+addCustomHeaders
+ -
+
+
-
+
-
+
+ ++++
Add custom headers to the request. Existing headers will be overwritten.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs denoting additional custom headers.
+
+
Returns CreateRequestBuilderBase<EntityT>
+The request builder itself, to facilitate method chaining.
+
+ -
+
addCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++
Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs denoting additional custom query parameters to be set in the request
+
+
Returns CreateRequestBuilderBase<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
asChildOf
+ -
+
+
-
+
-
+
+ ++++
Specifies the parent of the entity to create.
+Type parameters
+-
+
-
+
ParentEntityT: EntityBase<ParentEntityT>
+
+
Parameters
+-
+
-
+
parentEntity: ParentEntityT
+++Parent of the entity to create
+
+ -
+
linkField: Link<ParentEntityT, EntityT>
+++Static representation of the navigation property that navigates from the parent entity to the child entity
+
+
Returns CreateRequestBuilderBase<EntityT>
+The entity itself, to facilitate method chaining
+
+ -
+
build
+-
+
+
+
-
+
-
+
+
Returns ODataRequest<ODataCreateRequestConfig<EntityT>>
+
+ -
+
+
Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+
+ -
+
Optional options: (DestinationCachingOptions & ResilienceOptions) | (CachingOptions & ResilienceOptions)
+
+
Returns Promise<ODataRequest<ODataCreateRequestConfig<EntityT>>>
+
+ -
+
execute
+-
+
+
-
+
-
+
+ ++++
Execute query.
+Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++Destination to execute the request against
+
+ -
+
Optional options: (DestinationAccessorOptions & DestinationCachingOptions & ResilienceOptions & VerifyJwtOptions) | (DestinationAccessorOptions & CachingOptions & ResilienceOptions & VerifyJwtOptions)
+++Options to employ when fetching destinations
+
+
Returns Promise<EntityT>
+A promise resolving to the created entity
+
+ -
+
prepare
+-
+
+
-
+
-
+
+ + ++
Returns CreateRequestBuilderBase<EntityT>
+the builder itself
+
+
relativeUrl
+ -
+
+
-
+
-
+
+ ++++
Create the relative url based on configuration of the given builder.
+Returns string
+The relative url for the request
+
+
setCustomServicePath
+ -
+
+
-
+
-
+
+ ++++
Replace the default service path with the given custom path. + In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/
+' and can be overwritten here. Parameters
+-
+
-
+
servicePath: string
+++Path to override the default with
+
+
Returns CreateRequestBuilderBase<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
url
+-
+
+
-
+
-
+
+ ++++
Create the url based on configuration of the given builder.
+Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++Destination to execute the request against
+
+ -
+
Optional options: (DestinationCachingOptions & ResilienceOptions) | (CachingOptions & ResilienceOptions)
+++Options to employ when fetching destinations.
+
+
Returns Promise<string>
+Promise resolving to the url for the request
+
+ -
+
withCustomHeaders
+ -
+
+
-
+
-
+
+ ++++ +
Add custom headers to the request.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs denoting additional custom headers
+
+
Returns CreateRequestBuilderBase<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++ +
Add custom query parameters to the request.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs denoting additional custom query parameters to be set in the request
+
+
Returns CreateRequestBuilderBase<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomServicePath
+ -
+
+
-
+
-
+
+ ++++ +
Replace the default service path with the given custom path. + In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/
+' and can be overwritten here. Parameters
+-
+
-
+
servicePath: string
+++Path to override the default with
+
+
Returns CreateRequestBuilderBase<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
+
+
+
+
+ Class CreateRequestBuilderV4<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.customfield.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.customfield.html
new file mode 100644
index 0000000000..76108b0a77
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.customfield.html
@@ -0,0 +1,619 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+
+
+
+ Readonly odata
+
+
+
+
+
+ request
+
+
+
+
+
+ Readonly response
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ add
+
+
+
+ add
+
+
+
+ as
+
+
+
+
+
+
+
+
+
+
+
+
+ relative
+
+
+
+ set
+
+
+
+
+
+
+ with
+
+
+
+ with
+
+
+
+ with
+
+
+
+
+
+
+
+
+ Create OData request to create an entity.
+Type parameters
+-
+
-
+
EntityT: EntityV4
+++++Type of the entity to be created
+
+
Hierarchy
+-
+
-
+ CreateRequestBuilderBase<EntityT>
+
-
+
- + CreateRequestBuilderV4 + +
+
Implements
+-
+
- EntityIdentifiable<EntityT> +
Index
+
+
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- _entity +
- _entity
Constructor
+ - deserializer +
- odata
Uri
+ - request
Config
+ - response
Data Accessor
+ - serializer +
Accessors
+-
+
- entity +
Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of CreateRequestBuilder.
+Type parameters
+-
+
-
+
EntityT: EntityV4<EntityT>
+
+
Parameters
+-
+
-
+
_entityConstructor: Constructable<EntityT, unknown>
+++Constructor type of the entity to be created
+
+ -
+
_entity: EntityT
+++Entity to be created
+
+
Returns CreateRequestBuilderV4<EntityT>
+
+ -
+
Properties
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ Readonly deserializer
+ + +Readonly odataUri
+
+
+ requestConfig
+
+
+ Readonly responseDataAccessor
+
+
+ Readonly serializer
+ + +Accessors
+entity
+-
+
+
-
+
-
+
+
Returns EntityT
+
+
Methods
+addCustomHeaders
+ -
+
+
-
+
-
+
+ ++++
Add custom headers to the request. Existing headers will be overwritten.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs denoting additional custom headers.
+
+
Returns CreateRequestBuilderV4<EntityT>
+The request builder itself, to facilitate method chaining.
+
+ -
+
addCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++
Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs denoting additional custom query parameters to be set in the request
+
+
Returns CreateRequestBuilderV4<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
asChildOf
+ -
+
+
-
+
-
+
+ ++++
Specifies the parent of the entity to create.
+Type parameters
+-
+
-
+
ParentEntityT: EntityBase<ParentEntityT>
+
+
Parameters
+-
+
-
+
parentEntity: ParentEntityT
+++Parent of the entity to create
+
+ -
+
linkField: Link<ParentEntityT, EntityT>
+++Static representation of the navigation property that navigates from the parent entity to the child entity
+
+
Returns CreateRequestBuilderV4<EntityT>
+The entity itself, to facilitate method chaining
+
+ -
+
build
+-
+
+
+
-
+
-
+
+
Returns ODataRequest<ODataCreateRequestConfig<EntityT>>
+
+ -
+
+
Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+
+ -
+
Optional options: (DestinationCachingOptions & ResilienceOptions) | (CachingOptions & ResilienceOptions)
+
+
Returns Promise<ODataRequest<ODataCreateRequestConfig<EntityT>>>
+
+ -
+
execute
+-
+
+
-
+
-
+
+ ++++
Execute query.
+Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++Destination to execute the request against
+
+ -
+
Optional options: (DestinationAccessorOptions & DestinationCachingOptions & ResilienceOptions & VerifyJwtOptions) | (DestinationAccessorOptions & CachingOptions & ResilienceOptions & VerifyJwtOptions)
+++Options to employ when fetching destinations
+
+
Returns Promise<EntityT>
+A promise resolving to the created entity
+
+ -
+
prepare
+-
+
+
-
+
-
+
+ + ++
Returns CreateRequestBuilderV4<EntityT>
+the builder itself
+
+
relativeUrl
+ -
+
+
-
+
-
+
+ ++++
Create the relative url based on configuration of the given builder.
+Returns string
+The relative url for the request
+
+
setCustomServicePath
+ -
+
+
-
+
-
+
+ ++++
Replace the default service path with the given custom path. + In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/
+' and can be overwritten here. Parameters
+-
+
-
+
servicePath: string
+++Path to override the default with
+
+
Returns CreateRequestBuilderV4<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
url
+-
+
+
-
+
-
+
+ ++++
Create the url based on configuration of the given builder.
+Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++Destination to execute the request against
+
+ -
+
Optional options: (DestinationCachingOptions & ResilienceOptions) | (CachingOptions & ResilienceOptions)
+++Options to employ when fetching destinations.
+
+
Returns Promise<string>
+Promise resolving to the url for the request
+
+ -
+
withCustomHeaders
+ -
+
+
-
+
-
+
+ ++++ +
Add custom headers to the request.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs denoting additional custom headers
+
+
Returns CreateRequestBuilderV4<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++ +
Add custom query parameters to the request.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs denoting additional custom query parameters to be set in the request
+
+
Returns CreateRequestBuilderV4<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomServicePath
+ -
+
+
-
+
-
+
+ ++++ +
Replace the default service path with the given custom path. + In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/
+' and can be overwritten here. Parameters
+-
+
-
+
servicePath: string
+++Path to override the default with
+
+
Returns CreateRequestBuilderV4<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
+
+
+
+
+ Class CustomField<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.customfieldv4.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.customfieldv4.html
new file mode 100644
index 0000000000..eedc101cb3
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.customfieldv4.html
@@ -0,0 +1,640 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ Readonly _field
+
+
+
+
+
+
+
+ edm
+
+
+
+ edm
+
+
+
+ edm
+
+
+
+ edm
+
+
+
+ edm
+
+
+
+ edm
+
+
+
+ edm
+
+
+
+ edm
+
+
+
+ edm
+
+
+
+ edm
+
+
+
+ edm
+
+
+
+
+
+
+ edm
+
+
+
+ edm
+
+
+
+ edm
+
+
+
+ field
+
+
+
+
+ Type parameters
+-
+
-
+
EntityT: Entity
+
+
Hierarchy
+-
+
-
+ CustomFieldBase<EntityT>
+
-
+
- + CustomField + +
+
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- _entity +
- _entity
Constructor
+ - _field
Name
+
Methods
+-
+
- edm
Binary
+ - edm
Boolean
+ - edm
Byte
+ - edm
Date Time
+ - edm
Date Time Offset
+ - edm
Decimal
+ - edm
Double
+ - edm
Guid
+ - edm
Int16
+ - edm
Int32
+ - edm
Int64
+ - edmSByte +
- edm
Single
+ - edm
String
+ - edm
Time
+ - field
Path
+
Constructors
+constructor
+-
+
+
-
+
-
+
+
Type parameters
+-
+
-
+
EntityT: Entity<EntityT>
+
+
Parameters
+-
+
-
+
_fieldName: string
+
+ -
+
_entityConstructor: Constructable<EntityT, unknown>
+
+
Returns CustomField<EntityT>
+
+ -
+
Properties
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ Readonly _fieldName
+
+
+ Methods
+edmBinary
+ -
+
+
-
+
-
+
+
Returns StringField<EntityT>
+
+
edmBoolean
+ -
+
+
-
+
-
+
+
Returns BooleanField<EntityT>
+
+
edmByte
+ -
+
+
-
+
-
+
+
Returns NumberField<EntityT>
+
+
edmDateTime
+ -
+
+
-
+
-
+
+
Returns DateField<EntityT>
+
+
edmDateTimeOffset
+ -
+
+
-
+
-
+
+
Returns DateField<EntityT>
+
+
edmDecimal
+ -
+
+
-
+
-
+
+
Returns BigNumberField<EntityT>
+
+
edmDouble
+ -
+
+
-
+
-
+
+
Returns NumberField<EntityT>
+
+
edmGuid
+ -
+
+
-
+
-
+
+
Returns StringField<EntityT>
+
+
edmInt16
+ -
+
+
-
+
-
+
+
Returns NumberField<EntityT>
+
+
edmInt32
+ -
+
+
-
+
-
+
+
Returns NumberField<EntityT>
+
+
edmInt64
+ -
+
+
-
+
-
+
+
Returns BigNumberField<EntityT>
+
+
edmSByte
+-
+
+
-
+
-
+
+
Returns NumberField<EntityT>
+
+
edmSingle
+ -
+
+
-
+
-
+
+
Returns NumberField<EntityT>
+
+
edmString
+ -
+
+
-
+
-
+
+
Returns StringField<EntityT>
+
+
edmTime
+ -
+
+
-
+
-
+
+
Returns TimeField<EntityT>
+
+
fieldPath
+ -
+
+
-
+
-
+
+ ++++
Path to the field to be used in filter and order by queries. In most cases this will just be the _fieldName itself. However, for complex types for instance, the path is prefixed with the name of the complextype.
+Returns string
+Path to the field to be used in filter and order by queries.
+
+
+
+
+
+
+ Class CustomFieldV4<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.datefield.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.datefield.html
new file mode 100644
index 0000000000..386f176031
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.datefield.html
@@ -0,0 +1,599 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ Readonly _field
+
+
+
+
+
+
+
+ edm
+
+
+
+ edm
+
+
+
+ edm
+
+
+
+ edm
+
+
+
+ edm
+
+
+
+ edm
+
+
+
+ edm
+
+
+
+ edm
+
+
+
+ edm
+
+
+
+ edm
+
+
+
+ edm
+
+
+
+ edm
+
+
+
+
+
+
+ edm
+
+
+
+ edm
+
+
+
+ edm
+
+
+
+ field
+
+
+
+
+ Type parameters
+-
+
-
+
EntityT: EntityV4
+
+
Hierarchy
+-
+
-
+ CustomFieldBase<EntityT>
+
-
+
- + CustomFieldV4 + +
+
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- _entity +
- _entity
Constructor
+ - _field
Name
+
Methods
+-
+
- edm
Binary
+ - edm
Boolean
+ - edm
Byte
+ - edm
Date
+ - edm
Date Time Offset
+ - edm
Decimal
+ - edm
Double
+ - edm
Duration
+ - edm
Guid
+ - edm
Int16
+ - edm
Int32
+ - edm
Int64
+ - edmSByte +
- edm
Single
+ - edm
String
+ - edm
Time OfDay
+ - field
Path
+
Constructors
+constructor
+-
+
+
-
+
-
+
+
Type parameters
+-
+
-
+
EntityT: EntityV4<EntityT>
+
+
Parameters
+-
+
-
+
_fieldName: string
+
+ -
+
_entityConstructor: Constructable<EntityT, unknown>
+
+
Returns CustomFieldV4<EntityT>
+
+ -
+
Properties
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ Readonly _fieldName
+
+
+ Methods
+edmBinary
+ -
+
+
-
+
-
+
+
Returns StringField<EntityT>
+
+
edmBoolean
+ -
+
+
-
+
-
+
+
Returns BooleanField<EntityT>
+
+
edmByte
+ -
+
+
-
+
-
+
+
Returns NumberField<EntityT>
+
+
edmDate
+ -
+
+
-
+
-
+
+
Returns DateField<EntityT>
+
+
edmDateTimeOffset
+ -
+
+
-
+
-
+
+
Returns DateField<EntityT>
+
+
edmDecimal
+ -
+
+
-
+
-
+
+
Returns BigNumberField<EntityT>
+
+
edmDouble
+ -
+
+
-
+
-
+
+
Returns NumberField<EntityT>
+
+
edmDuration
+ -
+
+
-
+
-
+
+
Returns DurationField<EntityT>
+
+
edmGuid
+ -
+
+
-
+
-
+
+
Returns StringField<EntityT>
+
+
edmInt16
+ -
+
+
-
+
-
+
+
Returns NumberField<EntityT>
+
+
edmInt32
+ -
+
+
-
+
-
+
+
Returns NumberField<EntityT>
+
+
edmInt64
+ -
+
+
-
+
-
+
+
Returns BigNumberField<EntityT>
+
+
edmSByte
+-
+
+
-
+
-
+
+
Returns NumberField<EntityT>
+
+
edmSingle
+ -
+
+
-
+
-
+
+
Returns NumberField<EntityT>
+
+
edmString
+ -
+
+
-
+
-
+
+
Returns StringField<EntityT>
+
+
edmTimeOfDay
+ -
+
+
-
+
-
+
+
Returns TimeField<EntityT>
+
+
fieldPath
+ -
+
+
-
+
-
+
+ ++++
Path to the field to be used in filter and order by queries. In most cases this will just be the _fieldName itself. However, for complex types for instance, the path is prefixed with the name of the complextype.
+Returns string
+Path to the field to be used in filter and order by queries.
+
+
+
+
+
+
+ Class DateField<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.datefieldbase.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.datefieldbase.html
new file mode 100644
index 0000000000..782f07679a
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.datefieldbase.html
@@ -0,0 +1,582 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ Readonly _field
+
+
+
+
+
+ Readonly edm
+
+
+
+
+
+
+
+
+
+
+
+
+
+ field
+
+
+
+ greater
+
+
+
+ greater
+
+
+
+ less
+
+
+
+ less
+
+
+
+ not
+
+
+
+
+
+
+
+
+ Represents a selectable property with a date value.
+Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity the field belongs to
+
+
Hierarchy
+-
+
-
+ DateFieldBase<EntityT>
+
-
+
- + DateField + +
+
Implements
+ +Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- _entity +
- _entity
Constructor
+ - _field
Name
+ - edm
Type
+ - selectable +
Methods
+-
+
- equals +
- field
Path
+ - greater
OrEqual
+ - greater
Than
+ - less
OrEqual
+ - less
Than
+ - not
Equals
+
Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of EdmTypeField.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
fieldName: string
+++Actual name of the field used in the OData request
+
+ -
+
entityConstructor: Constructable<EntityT, unknown>
+++Constructor type of the entity the field belongs to
+
+ -
+
edmType: EdmTypeShared<VersionT>
+++Type of the field according to the metadata description
+
+
Returns DateField<EntityT>
+
+ -
+
Properties
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ Readonly _fieldName
+
+
+ Readonly edmType
+
+
+ Readonly selectable
+ + +Methods
+equals
+-
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'eq', i.e.
+==.Parameters
+-
+
-
+
value: Moment
+++Value to be used in the filter
+
+
Returns Filter<EntityT, Moment>
+The resulting filter
+
+ -
+
fieldPath
+ -
+
+
-
+
-
+
+ ++++
Path to the field to be used in filter and order by queries. In most cases this will just be the _fieldName itself. However, for complex types for instance, the path is prefixed with the name of the complextype.
+Returns string
+Path to the field to be used in filter and order by queries.
+
+
greaterOrEqual
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'ge', i.e.
+>=.Parameters
+-
+
-
+
value: Moment
+++Value to be used in the filter
+
+
Returns Filter<EntityT, Moment>
+The resulting filter
+
+ -
+
greaterThan
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'gt', i.e.
+>.Parameters
+-
+
-
+
value: Moment
+++Value to be used in the filter
+
+
Returns Filter<EntityT, Moment>
+The resulting filter
+
+ -
+
lessOrEqual
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'le', i.e.
+<=.Parameters
+-
+
-
+
value: Moment
+++Value to be used in the filter
+
+
Returns Filter<EntityT, Moment>
+The resulting filter
+
+ -
+
lessThan
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'lt', i.e.
+<.Parameters
+-
+
-
+
value: Moment
+++Value to be used in the filter
+
+
Returns Filter<EntityT, Moment>
+The resulting filter
+
+ -
+
notEquals
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'ne', i.e.
+!=.Parameters
+-
+
-
+
value: Moment
+++Value to be used in the filter
+
+
Returns Filter<EntityT, Moment>
+The resulting filter
+
+ -
+
+
+
+
+
+ Class DateFieldBase<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.deleterequestbuilder.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.deleterequestbuilder.html
new file mode 100644
index 0000000000..74b37b4f38
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.deleterequestbuilder.html
@@ -0,0 +1,766 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ Readonly _field
+
+
+
+
+
+ Readonly edm
+
+
+
+
+
+
+
+
+
+
+ field
+
+
+
+ greater
+
+
+
+ greater
+
+
+
+ less
+
+
+
+ less
+
+
+
+ not
+
+
+
+
+
+
+
+
+ Represents a property with a date value.
+Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity the field belongs to
+
+
Hierarchy
+-
+
-
+ EdmTypeField<EntityT, moment.Moment>
+
-
+
-
+ DateFieldBase
+
-
+
- + DateField + +
- + ComplexTypeDatePropertyField + +
+
+ -
+ DateFieldBase
+
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- _entity +
- _entity
Constructor
+ - _field
Name
+ - edm
Type
+
Methods
+-
+
- equals +
- field
Path
+ - greater
OrEqual
+ - greater
Than
+ - less
OrEqual
+ - less
Than
+ - not
Equals
+
Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of EdmTypeField.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
fieldName: string
+++Actual name of the field used in the OData request
+
+ -
+
entityConstructor: Constructable<EntityT, unknown>
+++Constructor type of the entity the field belongs to
+
+ -
+
edmType: EdmTypeShared<VersionT>
+++Type of the field according to the metadata description
+
+
Returns DateFieldBase<EntityT>
+
+ -
+
Properties
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ Readonly _fieldName
+
+
+ Readonly edmType
+
+
+ Methods
+equals
+-
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'eq', i.e.
+==.Parameters
+-
+
-
+
value: Moment
+++Value to be used in the filter
+
+
Returns Filter<EntityT, Moment>
+The resulting filter
+
+ -
+
fieldPath
+ -
+
+
-
+
-
+
+ ++++
Path to the field to be used in filter and order by queries. In most cases this will just be the _fieldName itself. However, for complex types for instance, the path is prefixed with the name of the complextype.
+Returns string
+Path to the field to be used in filter and order by queries.
+
+
greaterOrEqual
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'ge', i.e.
+>=.Parameters
+-
+
-
+
value: Moment
+++Value to be used in the filter
+
+
Returns Filter<EntityT, Moment>
+The resulting filter
+
+ -
+
greaterThan
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'gt', i.e.
+>.Parameters
+-
+
-
+
value: Moment
+++Value to be used in the filter
+
+
Returns Filter<EntityT, Moment>
+The resulting filter
+
+ -
+
lessOrEqual
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'le', i.e.
+<=.Parameters
+-
+
-
+
value: Moment
+++Value to be used in the filter
+
+
Returns Filter<EntityT, Moment>
+The resulting filter
+
+ -
+
lessThan
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'lt', i.e.
+<.Parameters
+-
+
-
+
value: Moment
+++Value to be used in the filter
+
+
Returns Filter<EntityT, Moment>
+The resulting filter
+
+ -
+
notEquals
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'ne', i.e.
+!=.Parameters
+-
+
-
+
value: Moment
+++Value to be used in the filter
+
+
Returns Filter<EntityT, Moment>
+The resulting filter
+
+ -
+
+
+
+
+
+ Class DeleteRequestBuilder<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.deleterequestbuilderbase.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.deleterequestbuilderbase.html
new file mode 100644
index 0000000000..2099b058e2
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.deleterequestbuilderbase.html
@@ -0,0 +1,773 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ request
+
+
+
+
+
+
+
+ add
+
+
+
+ add
+
+
+
+
+
+
+
+
+
+ ignore
+
+
+
+ relative
+
+
+
+ set
+
+
+
+ set
+
+
+
+
+
+
+ with
+
+
+
+ with
+
+
+
+ with
+
+
+
+
+
+
+
+
+ Create OData query to delete an entity.
+Type parameters
+-
+
-
+
EntityT: Entity
+++++Type of the entity to be deleted
+
+
Hierarchy
+-
+
-
+ DeleteRequestBuilderBase<EntityT>
+
-
+
- + DeleteRequestBuilder + +
+
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- _entity +
- _entity
Constructor
+ - request
Config
+
Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of DeleteRequestBuilder. If the entity is passed, version identifier will also be added.
+Type parameters
+-
+
-
+
EntityT: Entity<EntityT>
+
+
Parameters
+-
+
-
+
entityConstructor: Constructable<EntityT, unknown>
+++Constructor type of the entity to be deleted
+
+ -
+
keysOrEntity: Entity | Record<string, FieldType>
+++Entity or Key-value pairs of key properties for the given entity
+
+
Returns DeleteRequestBuilder<EntityT>
+
+ -
+
Properties
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ requestConfig
+
+
+ Methods
+addCustomHeaders
+ -
+
+
-
+
-
+
+ ++++
Add custom headers to the request. Existing headers will be overwritten.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs denoting additional custom headers.
+
+
Returns DeleteRequestBuilder<EntityT>
+The request builder itself, to facilitate method chaining.
+
+ -
+
addCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++
Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs denoting additional custom query parameters to be set in the request
+
+
Returns DeleteRequestBuilder<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
build
+-
+
+
+
-
+
-
+
+
Returns ODataRequest<ODataDeleteRequestConfig<EntityT>>
+
+ -
+
+
Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+
+ -
+
Optional options: (DestinationCachingOptions & ResilienceOptions) | (CachingOptions & ResilienceOptions)
+
+
Returns Promise<ODataRequest<ODataDeleteRequestConfig<EntityT>>>
+
+ -
+
execute
+-
+
+
-
+
-
+
+ ++++
Execute query.
+Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++Destination to execute the request against
+
+ -
+
Optional options: (DestinationAccessorOptions & DestinationCachingOptions & ResilienceOptions & VerifyJwtOptions) | (DestinationAccessorOptions & CachingOptions & ResilienceOptions & VerifyJwtOptions)
+++Options to employ when fetching destinations
+
+
Returns Promise<void>
+A promise resolving once the entity was deleted
+
+ -
+
ignoreVersionIdentifier
+ -
+
+
-
+
-
+
+ ++++
Instructs the request to force an overwrite of the entity by sending an 'If-Match: *' header instead of sending the ETag version identifier.
+Returns DeleteRequestBuilder<EntityT>
+this The request itself to ease chaining while executing the request
+
+
relativeUrl
+ -
+
+
-
+
-
+
+ ++++
Create the relative url based on configuration of the given builder.
+Returns string
+The relative url for the request
+
+
setCustomServicePath
+ -
+
+
-
+
-
+
+ ++++
Replace the default service path with the given custom path. + In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/
+' and can be overwritten here. Parameters
+-
+
-
+
servicePath: string
+++Path to override the default with
+
+
Returns DeleteRequestBuilder<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
setVersionIdentifier
+ -
+
+
-
+
-
+
+ ++++
Add an eTag version identifier in the delete request header.
+Parameters
+-
+
-
+
eTag: string
+++The version identifier of the entity
+
+
Returns DeleteRequestBuilder<EntityT>
+The builder itself, to facilitate method chaining
+
+ -
+
url
+-
+
+
-
+
-
+
+ ++++
Create the url based on configuration of the given builder.
+Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++Destination to execute the request against
+
+ -
+
Optional options: (DestinationCachingOptions & ResilienceOptions) | (CachingOptions & ResilienceOptions)
+++Options to employ when fetching destinations.
+
+
Returns Promise<string>
+Promise resolving to the url for the request
+
+ -
+
withCustomHeaders
+ -
+
+
-
+
-
+
+ ++++ +
Add custom headers to the request.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs denoting additional custom headers
+
+
Returns DeleteRequestBuilder<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++ +
Add custom query parameters to the request.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs denoting additional custom query parameters to be set in the request
+
+
Returns DeleteRequestBuilder<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomServicePath
+ -
+
+
-
+
-
+
+ ++++ +
Replace the default service path with the given custom path. + In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/
+' and can be overwritten here. Parameters
+-
+
-
+
servicePath: string
+++Path to override the default with
+
+
Returns DeleteRequestBuilder<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
+
+
+
+
+ Class DeleteRequestBuilderBase<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.deleterequestbuilderv4.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.deleterequestbuilderv4.html
new file mode 100644
index 0000000000..53bb4ea2cb
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.deleterequestbuilderv4.html
@@ -0,0 +1,773 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ request
+
+
+
+
+
+
+
+ add
+
+
+
+ add
+
+
+
+
+
+
+
+
+
+ ignore
+
+
+
+ relative
+
+
+
+ set
+
+
+
+ Abstract set
+
+
+
+
+
+
+ with
+
+
+
+ with
+
+
+
+ with
+
+
+
+
+
+
+
+
+ Abstract class to delete an entity holding the shared parts between OData v2 and v4
+Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity to be deleted
+
+
Hierarchy
+-
+
-
+ MethodRequestBuilder<ODataDeleteRequestConfig<EntityT>>
+
-
+
-
+ DeleteRequestBuilderBase
+
-
+
- + DeleteRequestBuilder + +
- + DeleteRequestBuilderV4 + +
+
+ -
+ DeleteRequestBuilderBase
+
Implements
+-
+
- EntityIdentifiable<EntityT> +
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- _entity +
- _entity
Constructor
+ - request
Config
+
Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of DeleteRequestBuilder. If the entity is passed, version identifier will also be added.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
entityConstructor: Constructable<EntityT, unknown>
+++Constructor type of the entity to be deleted
+
+ -
+
oDataUri: ODataUri
+++ODataUri conversion interface at runtime either v2 or v4
+
+ -
+
keysOrEntity: EntityBase | Record<string, FieldType>
+++Entity or Key-value pairs of key properties for the given entity
+
+
Returns DeleteRequestBuilderBase<EntityT>
+
+ -
+
Properties
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ requestConfig
+
+
+ Methods
+addCustomHeaders
+ -
+
+
-
+
-
+
+ ++++
Add custom headers to the request. Existing headers will be overwritten.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs denoting additional custom headers.
+
+
Returns DeleteRequestBuilderBase<EntityT>
+The request builder itself, to facilitate method chaining.
+
+ -
+
addCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++
Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs denoting additional custom query parameters to be set in the request
+
+
Returns DeleteRequestBuilderBase<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
build
+-
+
+
+
-
+
-
+
+
Returns ODataRequest<ODataDeleteRequestConfig<EntityT>>
+
+ -
+
+
Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+
+ -
+
Optional options: (DestinationCachingOptions & ResilienceOptions) | (CachingOptions & ResilienceOptions)
+
+
Returns Promise<ODataRequest<ODataDeleteRequestConfig<EntityT>>>
+
+ -
+
execute
+-
+
+
-
+
-
+
+ ++++
Execute query.
+Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++Destination to execute the request against
+
+ -
+
Optional options: (DestinationAccessorOptions & DestinationCachingOptions & ResilienceOptions & VerifyJwtOptions) | (DestinationAccessorOptions & CachingOptions & ResilienceOptions & VerifyJwtOptions)
+++Options to employ when fetching destinations
+
+
Returns Promise<void>
+A promise resolving once the entity was deleted
+
+ -
+
ignoreVersionIdentifier
+ -
+
+
-
+
-
+
+ ++++
Instructs the request to force an overwrite of the entity by sending an 'If-Match: *' header instead of sending the ETag version identifier.
+Returns DeleteRequestBuilderBase<EntityT>
+this The request itself to ease chaining while executing the request
+
+
relativeUrl
+ -
+
+
-
+
-
+
+ ++++
Create the relative url based on configuration of the given builder.
+Returns string
+The relative url for the request
+
+
setCustomServicePath
+ -
+
+
-
+
-
+
+ ++++
Replace the default service path with the given custom path. + In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/
+' and can be overwritten here. Parameters
+-
+
-
+
servicePath: string
+++Path to override the default with
+
+
Returns DeleteRequestBuilderBase<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
Abstract setVersionIdentifier
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
eTag: string
+
+
Returns DeleteRequestBuilderBase<EntityT>
+
+ -
+
url
+-
+
+
-
+
-
+
+ ++++
Create the url based on configuration of the given builder.
+Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++Destination to execute the request against
+
+ -
+
Optional options: (DestinationCachingOptions & ResilienceOptions) | (CachingOptions & ResilienceOptions)
+++Options to employ when fetching destinations.
+
+
Returns Promise<string>
+Promise resolving to the url for the request
+
+ -
+
withCustomHeaders
+ -
+
+
-
+
-
+
+ ++++ +
Add custom headers to the request.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs denoting additional custom headers
+
+
Returns DeleteRequestBuilderBase<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++ +
Add custom query parameters to the request.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs denoting additional custom query parameters to be set in the request
+
+
Returns DeleteRequestBuilderBase<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomServicePath
+ -
+
+
-
+
-
+
+ ++++ +
Replace the default service path with the given custom path. + In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/
+' and can be overwritten here. Parameters
+-
+
-
+
servicePath: string
+++Path to override the default with
+
+
Returns DeleteRequestBuilderBase<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
+
+
+
+
+ Class DeleteRequestBuilderV4<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.durationfield.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.durationfield.html
new file mode 100644
index 0000000000..8773d506aa
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.durationfield.html
@@ -0,0 +1,592 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ request
+
+
+
+
+
+
+
+ add
+
+
+
+ add
+
+
+
+
+
+
+
+
+
+ ignore
+
+
+
+ relative
+
+
+
+ set
+
+
+
+ set
+
+
+
+
+
+
+ with
+
+
+
+ with
+
+
+
+ with
+
+
+
+
+
+
+
+
+ Create OData query to delete an entity.
+Type parameters
+-
+
-
+
EntityT: EntityV4
+++++Type of the entity to be deleted
+
+
Hierarchy
+-
+
-
+ DeleteRequestBuilderBase<EntityT>
+
-
+
- + DeleteRequestBuilderV4 + +
+
Implements
+-
+
- EntityIdentifiable<EntityT> +
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- _entity +
- _entity
Constructor
+ - request
Config
+
Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of DeleteRequestBuilder. If the entity is passed, version identifier will also be added.
+Type parameters
+-
+
-
+
EntityT: EntityV4<EntityT>
+
+
Parameters
+-
+
-
+
entityConstructor: Constructable<EntityT, unknown>
+++Constructor type of the entity to be deleted
+
+ -
+
keysOrEntity: Record<string, FieldType> | EntityV4
+++Entity or Key-value pairs of key properties for the given entity
+
+
Returns DeleteRequestBuilderV4<EntityT>
+
+ -
+
Properties
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ requestConfig
+
+
+ Methods
+addCustomHeaders
+ -
+
+
-
+
-
+
+ ++++
Add custom headers to the request. Existing headers will be overwritten.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs denoting additional custom headers.
+
+
Returns DeleteRequestBuilderV4<EntityT>
+The request builder itself, to facilitate method chaining.
+
+ -
+
addCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++
Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs denoting additional custom query parameters to be set in the request
+
+
Returns DeleteRequestBuilderV4<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
build
+-
+
+
+
-
+
-
+
+
Returns ODataRequest<ODataDeleteRequestConfig<EntityT>>
+
+ -
+
+
Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+
+ -
+
Optional options: (DestinationCachingOptions & ResilienceOptions) | (CachingOptions & ResilienceOptions)
+
+
Returns Promise<ODataRequest<ODataDeleteRequestConfig<EntityT>>>
+
+ -
+
execute
+-
+
+
-
+
-
+
+ ++++
Execute query.
+Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++Destination to execute the request against
+
+ -
+
Optional options: (DestinationAccessorOptions & DestinationCachingOptions & ResilienceOptions & VerifyJwtOptions) | (DestinationAccessorOptions & CachingOptions & ResilienceOptions & VerifyJwtOptions)
+++Options to employ when fetching destinations
+
+
Returns Promise<void>
+A promise resolving once the entity was deleted
+
+ -
+
ignoreVersionIdentifier
+ -
+
+
-
+
-
+
+ ++++
Instructs the request to force an overwrite of the entity by sending an 'If-Match: *' header instead of sending the ETag version identifier.
+Returns DeleteRequestBuilderV4<EntityT>
+this The request itself to ease chaining while executing the request
+
+
relativeUrl
+ -
+
+
-
+
-
+
+ ++++
Create the relative url based on configuration of the given builder.
+Returns string
+The relative url for the request
+
+
setCustomServicePath
+ -
+
+
-
+
-
+
+ ++++
Replace the default service path with the given custom path. + In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/
+' and can be overwritten here. Parameters
+-
+
-
+
servicePath: string
+++Path to override the default with
+
+
Returns DeleteRequestBuilderV4<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
setVersionIdentifier
+ -
+
+
-
+
-
+
+ ++++
Add ETag version identifier in the delete request header.
+Parameters
+-
+
-
+
etag: string
+++The version identifier of the entity
+
+
Returns DeleteRequestBuilderV4<EntityT>
+The builder itself, to facilitate method chaining
+
+ -
+
url
+-
+
+
-
+
-
+
+ ++++
Create the url based on configuration of the given builder.
+Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++Destination to execute the request against
+
+ -
+
Optional options: (DestinationCachingOptions & ResilienceOptions) | (CachingOptions & ResilienceOptions)
+++Options to employ when fetching destinations.
+
+
Returns Promise<string>
+Promise resolving to the url for the request
+
+ -
+
withCustomHeaders
+ -
+
+
-
+
-
+
+ ++++ +
Add custom headers to the request.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs denoting additional custom headers
+
+
Returns DeleteRequestBuilderV4<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++ +
Add custom query parameters to the request.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs denoting additional custom query parameters to be set in the request
+
+
Returns DeleteRequestBuilderV4<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomServicePath
+ -
+
+
-
+
-
+
+ ++++ +
Replace the default service path with the given custom path. + In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/
+' and can be overwritten here. Parameters
+-
+
-
+
servicePath: string
+++Path to override the default with
+
+
Returns DeleteRequestBuilderV4<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
+
+
+
+
+ Class DurationField<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.durtionfieldbase.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.durtionfieldbase.html
new file mode 100644
index 0000000000..be8d100f19
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.durtionfieldbase.html
@@ -0,0 +1,582 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ Readonly _field
+
+
+
+
+
+ Readonly edm
+
+
+
+
+
+
+
+
+
+
+
+
+
+ field
+
+
+
+ greater
+
+
+
+ greater
+
+
+
+ less
+
+
+
+ less
+
+
+
+ not
+
+
+
+
+
+
+
+
+ Represents a selectable property with a duration value.
+Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity the field belongs to
+
+
Hierarchy
+-
+
-
+ DurtionFieldBase<EntityT>
+
-
+
- + DurationField + +
+
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- _entity +
- _entity
Constructor
+ - _field
Name
+ - edm
Type
+ - selectable +
Methods
+-
+
- equals +
- field
Path
+ - greater
OrEqual
+ - greater
Than
+ - less
OrEqual
+ - less
Than
+ - not
Equals
+
Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of EdmTypeField.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
fieldName: string
+++Actual name of the field used in the OData request
+
+ -
+
entityConstructor: Constructable<EntityT, unknown>
+++Constructor type of the entity the field belongs to
+
+ -
+
edmType: EdmTypeShared<VersionT>
+++Type of the field according to the metadata description
+
+
Returns DurationField<EntityT>
+
+ -
+
Properties
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ Readonly _fieldName
+
+
+ Readonly edmType
+
+
+ Readonly selectable
+ + +Methods
+equals
+-
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'eq', i.e.
+==.Parameters
+-
+
-
+
value: Duration
+++Value to be used in the filter
+
+
Returns Filter<EntityT, Duration>
+The resulting filter
+
+ -
+
fieldPath
+ -
+
+
-
+
-
+
+ ++++
Path to the field to be used in filter and order by queries. In most cases this will just be the _fieldName itself. However, for complex types for instance, the path is prefixed with the name of the complextype.
+Returns string
+Path to the field to be used in filter and order by queries.
+
+
greaterOrEqual
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'ge', i.e.
+>=.Parameters
+-
+
-
+
value: Duration
+++Value to be used in the filter
+
+
Returns Filter<EntityT, Duration>
+The resulting filter
+
+ -
+
greaterThan
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'gt', i.e.
+>.Parameters
+-
+
-
+
value: Duration
+++Value to be used in the filter
+
+
Returns Filter<EntityT, Duration>
+The resulting filter
+
+ -
+
lessOrEqual
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'le', i.e.
+<=.Parameters
+-
+
-
+
value: Duration
+++Value to be used in the filter
+
+
Returns Filter<EntityT, Duration>
+The resulting filter
+
+ -
+
lessThan
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'lt', i.e.
+<.Parameters
+-
+
-
+
value: Duration
+++Value to be used in the filter
+
+
Returns Filter<EntityT, Duration>
+The resulting filter
+
+ -
+
notEquals
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'ne', i.e.
+!=.Parameters
+-
+
-
+
value: Duration
+++Value to be used in the filter
+
+
Returns Filter<EntityT, Duration>
+The resulting filter
+
+ -
+
+
+
+
+
+ Class DurtionFieldBase<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.edmtypefield.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.edmtypefield.html
new file mode 100644
index 0000000000..e71941b3c4
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.edmtypefield.html
@@ -0,0 +1,465 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ Readonly _field
+
+
+
+
+
+ Readonly edm
+
+
+
+
+
+
+
+
+
+
+ field
+
+
+
+ greater
+
+
+
+ greater
+
+
+
+ less
+
+
+
+ less
+
+
+
+ not
+
+
+
+
+
+
+
+
+ Represents a property with a duration value.
+Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity the field belongs to
+
+
Hierarchy
+-
+
-
+ EdmTypeField<EntityT, moment.Duration>
+
-
+
-
+ DurtionFieldBase
+
-
+
- + DurationField + +
- + ComplexTypeDurationPropertyField + +
+
+ -
+ DurtionFieldBase
+
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- _entity +
- _entity
Constructor
+ - _field
Name
+ - edm
Type
+
Methods
+-
+
- equals +
- field
Path
+ - greater
OrEqual
+ - greater
Than
+ - less
OrEqual
+ - less
Than
+ - not
Equals
+
Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of EdmTypeField.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
fieldName: string
+++Actual name of the field used in the OData request
+
+ -
+
entityConstructor: Constructable<EntityT, unknown>
+++Constructor type of the entity the field belongs to
+
+ -
+
edmType: EdmTypeShared<VersionT>
+++Type of the field according to the metadata description
+
+
Returns DurtionFieldBase<EntityT>
+
+ -
+
Properties
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ Readonly _fieldName
+
+
+ Readonly edmType
+
+
+ Methods
+equals
+-
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'eq', i.e.
+==.Parameters
+-
+
-
+
value: Duration
+++Value to be used in the filter
+
+
Returns Filter<EntityT, Duration>
+The resulting filter
+
+ -
+
fieldPath
+ -
+
+
-
+
-
+
+ ++++
Path to the field to be used in filter and order by queries. In most cases this will just be the _fieldName itself. However, for complex types for instance, the path is prefixed with the name of the complextype.
+Returns string
+Path to the field to be used in filter and order by queries.
+
+
greaterOrEqual
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'ge', i.e.
+>=.Parameters
+-
+
-
+
value: Duration
+++Value to be used in the filter
+
+
Returns Filter<EntityT, Duration>
+The resulting filter
+
+ -
+
greaterThan
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'gt', i.e.
+>.Parameters
+-
+
-
+
value: Duration
+++Value to be used in the filter
+
+
Returns Filter<EntityT, Duration>
+The resulting filter
+
+ -
+
lessOrEqual
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'le', i.e.
+<=.Parameters
+-
+
-
+
value: Duration
+++Value to be used in the filter
+
+
Returns Filter<EntityT, Duration>
+The resulting filter
+
+ -
+
lessThan
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'lt', i.e.
+<.Parameters
+-
+
-
+
value: Duration
+++Value to be used in the filter
+
+
Returns Filter<EntityT, Duration>
+The resulting filter
+
+ -
+
notEquals
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'ne', i.e.
+!=.Parameters
+-
+
-
+
value: Duration
+++Value to be used in the filter
+
+
Returns Filter<EntityT, Duration>
+The resulting filter
+
+ -
+
+
+
+
+
+ Class EdmTypeField<EntityT, FieldT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.entity.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.entity.html
new file mode 100644
index 0000000000..8cd16f3d0d
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.entity.html
@@ -0,0 +1,1039 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ Readonly _field
+
+
+
+
+
+ Readonly edm
+
+
+
+
+
+
+
+
+
+
+ field
+
+
+
+ not
+
+
+
+
+
+
+
+
+ Represents a property of an OData entity with an Edm type.
+EdmTypeFields are used as static properties of entities and are generated from the metadata, i.e. for each property of
+ an OData entity, that has an Edm type, there exists one static instance of EdmTypeField (or rather one of its subclasses) in the corresponding generated class file.
+ EdmTypeFields are used to represent the domain of more or less primitive values that can be used in select, filter and order by functions.
+ For example, when constructing a query on the BusinessPartner entity, an instance of EdmTypeField<BusinessPartner, string>
+ can be supplied as argument to the select function, e.g. BusinessPartner.FIRST_NAME.
See also: Selectable
+Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity the field belongs to
+
+ -
+
FieldT: FieldType
+++++Type of the field
+
+
Hierarchy
+-
+
-
+ Field<EntityT>
+
-
+
-
+ EdmTypeField
+
-
+
- + BinaryFieldBase + +
- + BooleanFieldBase + +
- + DateFieldBase + +
- + DurtionFieldBase + +
- + NumberFieldBase + +
- + TimeFieldBase + +
+
+ -
+ EdmTypeField
+
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- _entity +
- _entity
Constructor
+ - _field
Name
+ - edm
Type
+
Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of EdmTypeField.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+ -
+
FieldT: FieldType
+
+
Parameters
+-
+
-
+
fieldName: string
+++Actual name of the field used in the OData request
+
+ -
+
entityConstructor: Constructable<EntityT, unknown>
+++Constructor type of the entity the field belongs to
+
+ -
+
edmType: EdmTypeShared<VersionT>
+++Type of the field according to the metadata description
+
+
Returns EdmTypeField<EntityT, FieldT>
+
+ -
+
Properties
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ Readonly _fieldName
+
+
+ Readonly edmType
+
+
+ Methods
+equals
+-
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'eq', i.e.
+==.Parameters
+-
+
-
+
value: FieldT
+++Value to be used in the filter
+
+
Returns Filter<EntityT, FieldT>
+The resulting filter
+
+ -
+
fieldPath
+ -
+
+
-
+
-
+
+ ++++
Path to the field to be used in filter and order by queries. In most cases this will just be the _fieldName itself. However, for complex types for instance, the path is prefixed with the name of the complextype.
+Returns string
+Path to the field to be used in filter and order by queries.
+
+
notEquals
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'ne', i.e.
+!=.Parameters
+-
+
-
+
value: FieldT
+++Value to be used in the filter
+
+
Returns Filter<EntityT, FieldT>
+The resulting filter
+
+ -
+
+
+
+
+
+ Class Entity
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.entitybase.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.entitybase.html
new file mode 100644
index 0000000000..22a01a1a0b
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.entitybase.html
@@ -0,0 +1,986 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Protected _custom
+
+
+
+
+
+ Readonly _o
+
+
+
+
+
+ Protected _version
+
+
+
+
+
+ Protected remote
+
+
+
+
+
+ Static _default
+
+
+
+
+
+ Static _entity
+
+
+
+
+
+ Static _service
+
+
+
+
+
+
+
+ version
+
+
+
+
+
+ Protected as
+
+
+
+ Protected get
+
+
+
+ Protected get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ has
+
+
+
+ initialize
+
+
+
+ Protected is
+
+
+
+ Protected is
+
+
+
+ set
+
+
+
+ set
+
+
+
+ set
+
+
+
+ set
+
+
+
+ Protected Static custom
+
+
+
+ Protected Static entity
+
+
+
+
+
+
+
+
+ Super class for all representations of OData v2 entity types.
+Hierarchy
+-
+
-
+ EntityBase
+
-
+
- + Entity + +
+
Index
+
+
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+ +Accessors
+ +Methods
+-
+
- as
Object
+ - get
Current Map Keys
+ - get
Current State For Key
+ - get
Custom Field
+ - get
Custom Fields
+ - get
Updated Custom Fields
+ - get
Updated Properties
+ - get
Updated Property Names
+ - has
Custom Field
+ - initialize
Custom Fields
+ - is
Conflicting Custom Field
+ - is
Visited Entity
+ - set
Custom Field
+ - set
Custom Fields
+ - set
OrInitialize Remote State
+ - set
Version Identifier
+ - custom
Field Selector
+ - entity
Builder
+
Constructors
+constructor
+-
+
+
-
+
-
+
+
Returns Entity
+
+
Properties
+Protected _customFields
+
+
+
+
+
+
+ A mapper representing custom fields in an entity. + Custom fields are represented by their field names and the corresponding values. + A custom field can be added or updated using setCustomField method.
+Readonly _oDataVersion
+
+
+ Protected _versionIdentifier
+
+
+
+
+
+
+ The current ETag version of the entity in the remote system. + The ETag identified the version of the in the remote system. It will be automatically set in the "if-match" header of update requests and can be set as a custom header for delete requests. + When no ETag is provided by the remote system the value of this variable defaults to "*".
+Protected remoteState
+
+
+
+
+
+
+ The remote state of the entity. + Remote state refers to the last known state of the entity on the remote system from which it has been retrieved or to which it has been posted. + It is stored as map, where the keys are stored in the format of the original OData properties.
+
+
+ Type declaration
+-
+
-
+
[keys: string]: any
+
+
Static _defaultServicePath
+
+
+ Static _entityName
+
+
+ Static _serviceName
+
+
+ Accessors
+versionIdentifier
+ -
+
+
-
+
-
+
+ ++++
ETag version identifier accessor.
+Returns string
+The ETag version identifier of the retrieved entity, returns undefined if not retrieved
+
+
Methods
+Protected asObject
+ -
+
+
-
+
-
+
+ ++++
Creates an object containing all defined properties, navigation properties and custom fields in the entity.
+Parameters
+-
+
-
+
Optional visitedEntities: EntityBase[]
+++List of entities to check in case of circular dependencies.
+
+
Returns Record<string, any>
+Entity as an object with all defined entity fields
+
+ -
+
Protected getCurrentMapKeys
+ -
+
+
-
+
-
+
+ + ++
Parameters
+-
+
-
+
Optional visitedEntities: EntityBase[]
+++List of entities to check in case of circular dependencies.
+
+
Returns Entity
+Entity with all defined entity fields
+
+ -
+
Protected getCurrentStateForKey
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
key: string
+
+ -
+
Optional visitedEntities: EntityBase[]
+
+
Returns any
+
+ -
+
getCustomField
+ -
+
+
-
+
-
+
+ ++++
Custom field value getter.
+Parameters
+-
+
-
+
fieldName: string
+++The name of the custom field
+
+
Returns any
+The value of the corresponding custom field
+
+ -
+
getCustomFields
+ -
+
+
-
+
-
+
+ ++++
Returns a map that contains all entity custom fields.
+Returns Record<string, any>
+A map of all defined custom fields in the entity
+
+
getUpdatedCustomFields
+ -
+
+
-
+
-
+
+ ++++
Returns all updated custom field properties compared to the last known remote state.
+Returns Record<string, any>
+An object containing all updated custom properties, with their new values.
+
+
getUpdatedProperties
+ -
+
+
-
+
-
+
+ ++++
Returns all changed properties compared to the last known remote state. + The returned properties do not include custom fields. + Use getUpdatedCustomFields, if you need custom fields.
+Returns Record<string, any>
+Entity with all properties that changed
+
+
getUpdatedPropertyNames
+ -
+
+
-
+
-
+
+ ++++
Returns all changed property names compared to the last known remote state. + The returned properties names do not include custom fields. + Use getUpdatedCustomFields, if you need custom fields.
+Returns string[]
+Entity with all properties that changed
+
+
hasCustomField
+ -
+
+
-
+
-
+
+ ++++
Validates whether a custom field exists in the entity.
+Parameters
+-
+
-
+
fieldName: string
+++The name of the custom field to update
+
+
Returns boolean
+A boolean value, that indicates whether a custom field is defined in entity
+
+ -
+
initializeCustomFields
+ -
+
+
-
+
-
+
+ + ++
Parameters
+-
+
-
+
customFields: Record<string, any>
+++Extracted custom fields from a retrieved entity
+
+
Returns Entity
+The entity itself, to facilitate method chaining
+
+ -
+
Protected isConflictingCustomField
+ -
+
+
-
+
-
+
+ ++++
Validates whether a field name does not conflict with an original field name and thus can be defined as custom fields.
+Parameters
+-
+
-
+
customFieldName: string
+++Field name to check
+
+
Returns boolean
+Boolean value that describes whether a field name can be defined as custom field
+
+ -
+
Protected isVisitedEntity
+ -
+
+
-
+
-
+
+
Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
entity: EntityT
+
+ -
+
Optional visitedEntities: EntityBase[]
+
+
Returns boolean
+
+ -
+
setCustomField
+ -
+
+
-
+
-
+
+ ++++
Sets a new custom field in the entity or updates it. + Throws an error, if the provided custom field name is already defined by an original field in entity.
+Parameters
+-
+
-
+
fieldName: string
+++The name of the custom field to update
+
+ -
+
value: any
+++The value of the field
+
+
Returns Entity
+The entity itself, to facilitate method chaining
+
+ -
+
setCustomFields
+ -
+
+
-
+
-
+
+ ++++
Sets custom fields on an entity.
+Parameters
+-
+
-
+
customFields: Record<string, any>
+++Custom fields to set on the entity.
+
+
Returns Entity
+The entity itself, to facilitate method chaining
+
+ -
+
setOrInitializeRemoteState
+ -
+
+
-
+
-
+
+ ++++ +
Initializes or sets the remoteState of the entity. + This function is called on all read, create and update requests. + This function should be called after initializeCustomFields, if custom fields are defined.
+Parameters
+-
+
-
+
Optional state: Record<string, any>
+++State to be set as remote state.
+
+
Returns Entity
+The entity itself, to facilitate method chaining
+
+ -
+
setVersionIdentifier
+ -
+
+
-
+
-
+
+ ++++
Set the ETag version identifier of the retrieved entity.
+Parameters
+-
+
-
+
etag: undefined | string
+++The returned ETag version of the entity
+
+
Returns Entity
+The entity itself, to facilitate method chaining
+
+ -
+
Protected Static customFieldSelector
+ -
+
+
-
+
-
+
+
Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
fieldName: string
+
+ -
+
entityConstructor: Constructable<EntityT, unknown>
+
+
Returns CustomField<EntityT>
+
+ -
+
Protected Static entityBuilder
+ -
+
+
-
+
-
+
+
Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+ -
+
EntityTypeT
+
+
Parameters
+-
+
-
+
entityConstructor: Constructable<EntityT, EntityTypeT>
+
+
Returns EntityBuilderType<EntityT, EntityTypeT>
+
+ -
+
+
+
+
+
+ Class EntityBase
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.entityv4.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.entityv4.html
new file mode 100644
index 0000000000..0dbb3376dc
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.entityv4.html
@@ -0,0 +1,1039 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Protected _custom
+
+
+
+
+
+ Readonly Abstract _o
+
+
+
+
+
+ Protected _version
+
+
+
+
+
+ Protected remote
+
+
+
+
+
+ Static _default
+
+
+
+
+
+ Static _entity
+
+
+
+
+
+ Static _service
+
+
+
+
+
+
+
+ version
+
+
+
+
+
+ Protected as
+
+
+
+ Protected get
+
+
+
+ Protected get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ has
+
+
+
+ initialize
+
+
+
+ Protected is
+
+
+
+ Protected is
+
+
+
+ set
+
+
+
+ set
+
+
+
+ set
+
+
+
+ set
+
+
+
+ Protected Static entity
+
+
+
+
+
+
+
+
+ Super class for all representations of OData entity types.
+Hierarchy
+ +Index
+
+
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+ +Accessors
+ +Methods
+-
+
- as
Object
+ - get
Current Map Keys
+ - get
Current State For Key
+ - get
Custom Field
+ - get
Custom Fields
+ - get
Updated Custom Fields
+ - get
Updated Properties
+ - get
Updated Property Names
+ - has
Custom Field
+ - initialize
Custom Fields
+ - is
Conflicting Custom Field
+ - is
Visited Entity
+ - set
Custom Field
+ - set
Custom Fields
+ - set
OrInitialize Remote State
+ - set
Version Identifier
+ - entity
Builder
+
Constructors
+constructor
+-
+
+
-
+
-
+
+
Returns EntityBase
+
+
Properties
+Protected _customFields
+
+
+
+
+
+
+ A mapper representing custom fields in an entity. + Custom fields are represented by their field names and the corresponding values. + A custom field can be added or updated using setCustomField method.
+Readonly Abstract _oDataVersion
+
+
+ Protected _versionIdentifier
+
+
+
+
+
+
+ The current ETag version of the entity in the remote system. + The ETag identified the version of the in the remote system. It will be automatically set in the "if-match" header of update requests and can be set as a custom header for delete requests. + When no ETag is provided by the remote system the value of this variable defaults to "*".
+Protected remoteState
+
+
+
+
+
+
+ The remote state of the entity. + Remote state refers to the last known state of the entity on the remote system from which it has been retrieved or to which it has been posted. + It is stored as map, where the keys are stored in the format of the original OData properties.
+
+
+ Type declaration
+-
+
-
+
[keys: string]: any
+
+
Static _defaultServicePath
+
+
+ Static _entityName
+
+
+ Static _serviceName
+
+
+ Accessors
+versionIdentifier
+ -
+
+
-
+
-
+
+ ++++
ETag version identifier accessor.
+Returns string
+The ETag version identifier of the retrieved entity, returns undefined if not retrieved
+
+
Methods
+Protected asObject
+ -
+
+
-
+
-
+
+ ++++
Creates an object containing all defined properties, navigation properties and custom fields in the entity.
+Parameters
+-
+
-
+
Optional visitedEntities: EntityBase[]
+++List of entities to check in case of circular dependencies.
+
+
Returns Record<string, any>
+Entity as an object with all defined entity fields
+
+ -
+
Protected getCurrentMapKeys
+ -
+
+
-
+
-
+
+ + ++
Parameters
+-
+
-
+
Optional visitedEntities: EntityBase[]
+++List of entities to check in case of circular dependencies.
+
+
Returns EntityBase
+Entity with all defined entity fields
+
+ -
+
Protected getCurrentStateForKey
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
key: string
+
+ -
+
Optional visitedEntities: EntityBase[]
+
+
Returns any
+
+ -
+
getCustomField
+ -
+
+
-
+
-
+
+ ++++
Custom field value getter.
+Parameters
+-
+
-
+
fieldName: string
+++The name of the custom field
+
+
Returns any
+The value of the corresponding custom field
+
+ -
+
getCustomFields
+ -
+
+
-
+
-
+
+ ++++
Returns a map that contains all entity custom fields.
+Returns Record<string, any>
+A map of all defined custom fields in the entity
+
+
getUpdatedCustomFields
+ -
+
+
-
+
-
+
+ ++++
Returns all updated custom field properties compared to the last known remote state.
+Returns Record<string, any>
+An object containing all updated custom properties, with their new values.
+
+
getUpdatedProperties
+ -
+
+
-
+
-
+
+ ++++
Returns all changed properties compared to the last known remote state. + The returned properties do not include custom fields. + Use getUpdatedCustomFields, if you need custom fields.
+Returns Record<string, any>
+Entity with all properties that changed
+
+
getUpdatedPropertyNames
+ -
+
+
-
+
-
+
+ ++++
Returns all changed property names compared to the last known remote state. + The returned properties names do not include custom fields. + Use getUpdatedCustomFields, if you need custom fields.
+Returns string[]
+Entity with all properties that changed
+
+
hasCustomField
+ -
+
+
-
+
-
+
+ ++++
Validates whether a custom field exists in the entity.
+Parameters
+-
+
-
+
fieldName: string
+++The name of the custom field to update
+
+
Returns boolean
+A boolean value, that indicates whether a custom field is defined in entity
+
+ -
+
initializeCustomFields
+ -
+
+
-
+
-
+
+ + ++
Parameters
+-
+
-
+
customFields: Record<string, any>
+++Extracted custom fields from a retrieved entity
+
+
Returns EntityBase
+The entity itself, to facilitate method chaining
+
+ -
+
Protected isConflictingCustomField
+ -
+
+
-
+
-
+
+ ++++
Validates whether a field name does not conflict with an original field name and thus can be defined as custom fields.
+Parameters
+-
+
-
+
customFieldName: string
+++Field name to check
+
+
Returns boolean
+Boolean value that describes whether a field name can be defined as custom field
+
+ -
+
Protected isVisitedEntity
+ -
+
+
-
+
-
+
+
Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
entity: EntityT
+
+ -
+
Optional visitedEntities: EntityBase[]
+
+
Returns boolean
+
+ -
+
setCustomField
+ -
+
+
-
+
-
+
+ ++++
Sets a new custom field in the entity or updates it. + Throws an error, if the provided custom field name is already defined by an original field in entity.
+Parameters
+-
+
-
+
fieldName: string
+++The name of the custom field to update
+
+ -
+
value: any
+++The value of the field
+
+
Returns EntityBase
+The entity itself, to facilitate method chaining
+
+ -
+
setCustomFields
+ -
+
+
-
+
-
+
+ ++++
Sets custom fields on an entity.
+Parameters
+-
+
-
+
customFields: Record<string, any>
+++Custom fields to set on the entity.
+
+
Returns EntityBase
+The entity itself, to facilitate method chaining
+
+ -
+
setOrInitializeRemoteState
+ -
+
+
-
+
-
+
+ ++++ +
Initializes or sets the remoteState of the entity. + This function is called on all read, create and update requests. + This function should be called after initializeCustomFields, if custom fields are defined.
+Parameters
+-
+
-
+
Optional state: Record<string, any>
+++State to be set as remote state.
+
+
Returns EntityBase
+The entity itself, to facilitate method chaining
+
+ -
+
setVersionIdentifier
+ -
+
+
-
+
-
+
+ ++++
Set the ETag version identifier of the retrieved entity.
+Parameters
+-
+
-
+
etag: undefined | string
+++The returned ETag version of the entity
+
+
Returns EntityBase
+The entity itself, to facilitate method chaining
+
+ -
+
Protected Static entityBuilder
+ -
+
+
-
+
-
+
+
Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+ -
+
EntityTypeT
+
+
Parameters
+-
+
-
+
entityConstructor: Constructable<EntityT, EntityTypeT>
+
+
Returns EntityBuilderType<EntityT, EntityTypeT>
+
+ -
+
+
+
+
+
+ Class EntityV4
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.enumfield.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.enumfield.html
new file mode 100644
index 0000000000..73dc88a083
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.enumfield.html
@@ -0,0 +1,423 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Protected _custom
+
+
+
+
+
+ Readonly _o
+
+
+
+
+
+ Protected _version
+
+
+
+
+
+ Protected remote
+
+
+
+
+
+ Static _default
+
+
+
+
+
+ Static _entity
+
+
+
+
+
+ Static _service
+
+
+
+
+
+
+
+ version
+
+
+
+
+
+ Protected as
+
+
+
+ Protected get
+
+
+
+ Protected get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ has
+
+
+
+ initialize
+
+
+
+ Protected is
+
+
+
+ Protected is
+
+
+
+ set
+
+
+
+ set
+
+
+
+ set
+
+
+
+ set
+
+
+
+ Protected Static custom
+
+
+
+ Protected Static entity
+
+
+
+
+
+
+
+
+ Super class for all representations of OData v4 entity types.
+Hierarchy
+-
+
-
+ EntityBase
+
-
+
- + EntityV4 + +
+
Index
+
+
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+ +Accessors
+ +Methods
+-
+
- as
Object
+ - get
Current Map Keys
+ - get
Current State For Key
+ - get
Custom Field
+ - get
Custom Fields
+ - get
Updated Custom Fields
+ - get
Updated Properties
+ - get
Updated Property Names
+ - has
Custom Field
+ - initialize
Custom Fields
+ - is
Conflicting Custom Field
+ - is
Visited Entity
+ - set
Custom Field
+ - set
Custom Fields
+ - set
OrInitialize Remote State
+ - set
Version Identifier
+ - custom
Field Selector
+ - entity
Builder
+
Constructors
+constructor
+-
+
+
-
+
-
+
+
Returns EntityV4
+
+
Properties
+Protected _customFields
+
+
+
+
+
+
+ A mapper representing custom fields in an entity. + Custom fields are represented by their field names and the corresponding values. + A custom field can be added or updated using setCustomField method.
+Readonly _oDataVersion
+
+
+ Protected _versionIdentifier
+
+
+
+
+
+
+ The current ETag version of the entity in the remote system. + The ETag identified the version of the in the remote system. It will be automatically set in the "if-match" header of update requests and can be set as a custom header for delete requests. + When no ETag is provided by the remote system the value of this variable defaults to "*".
+Protected remoteState
+
+
+
+
+
+
+ The remote state of the entity. + Remote state refers to the last known state of the entity on the remote system from which it has been retrieved or to which it has been posted. + It is stored as map, where the keys are stored in the format of the original OData properties.
+
+
+ Type declaration
+-
+
-
+
[keys: string]: any
+
+
Static _defaultServicePath
+
+
+ Static _entityName
+
+
+ Static _serviceName
+
+
+ Accessors
+versionIdentifier
+ -
+
+
-
+
-
+
+ ++++
ETag version identifier accessor.
+Returns string
+The ETag version identifier of the retrieved entity, returns undefined if not retrieved
+
+
Methods
+Protected asObject
+ -
+
+
-
+
-
+
+ ++++
Creates an object containing all defined properties, navigation properties and custom fields in the entity.
+Parameters
+-
+
-
+
Optional visitedEntities: EntityBase[]
+++List of entities to check in case of circular dependencies.
+
+
Returns Record<string, any>
+Entity as an object with all defined entity fields
+
+ -
+
Protected getCurrentMapKeys
+ -
+
+
-
+
-
+
+ + ++
Parameters
+-
+
-
+
Optional visitedEntities: EntityBase[]
+++List of entities to check in case of circular dependencies.
+
+
Returns EntityV4
+Entity with all defined entity fields
+
+ -
+
Protected getCurrentStateForKey
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
key: string
+
+ -
+
Optional visitedEntities: EntityBase[]
+
+
Returns any
+
+ -
+
getCustomField
+ -
+
+
-
+
-
+
+ ++++
Custom field value getter.
+Parameters
+-
+
-
+
fieldName: string
+++The name of the custom field
+
+
Returns any
+The value of the corresponding custom field
+
+ -
+
getCustomFields
+ -
+
+
-
+
-
+
+ ++++
Returns a map that contains all entity custom fields.
+Returns Record<string, any>
+A map of all defined custom fields in the entity
+
+
getUpdatedCustomFields
+ -
+
+
-
+
-
+
+ ++++
Returns all updated custom field properties compared to the last known remote state.
+Returns Record<string, any>
+An object containing all updated custom properties, with their new values.
+
+
getUpdatedProperties
+ -
+
+
-
+
-
+
+ ++++
Returns all changed properties compared to the last known remote state. + The returned properties do not include custom fields. + Use getUpdatedCustomFields, if you need custom fields.
+Returns Record<string, any>
+Entity with all properties that changed
+
+
getUpdatedPropertyNames
+ -
+
+
-
+
-
+
+ ++++
Returns all changed property names compared to the last known remote state. + The returned properties names do not include custom fields. + Use getUpdatedCustomFields, if you need custom fields.
+Returns string[]
+Entity with all properties that changed
+
+
hasCustomField
+ -
+
+
-
+
-
+
+ ++++
Validates whether a custom field exists in the entity.
+Parameters
+-
+
-
+
fieldName: string
+++The name of the custom field to update
+
+
Returns boolean
+A boolean value, that indicates whether a custom field is defined in entity
+
+ -
+
initializeCustomFields
+ -
+
+
-
+
-
+
+ + ++
Parameters
+-
+
-
+
customFields: Record<string, any>
+++Extracted custom fields from a retrieved entity
+
+
Returns EntityV4
+The entity itself, to facilitate method chaining
+
+ -
+
Protected isConflictingCustomField
+ -
+
+
-
+
-
+
+ ++++
Validates whether a field name does not conflict with an original field name and thus can be defined as custom fields.
+Parameters
+-
+
-
+
customFieldName: string
+++Field name to check
+
+
Returns boolean
+Boolean value that describes whether a field name can be defined as custom field
+
+ -
+
Protected isVisitedEntity
+ -
+
+
-
+
-
+
+
Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
entity: EntityT
+
+ -
+
Optional visitedEntities: EntityBase[]
+
+
Returns boolean
+
+ -
+
setCustomField
+ -
+
+
-
+
-
+
+ ++++
Sets a new custom field in the entity or updates it. + Throws an error, if the provided custom field name is already defined by an original field in entity.
+Parameters
+-
+
-
+
fieldName: string
+++The name of the custom field to update
+
+ -
+
value: any
+++The value of the field
+
+
Returns EntityV4
+The entity itself, to facilitate method chaining
+
+ -
+
setCustomFields
+ -
+
+
-
+
-
+
+ ++++
Sets custom fields on an entity.
+Parameters
+-
+
-
+
customFields: Record<string, any>
+++Custom fields to set on the entity.
+
+
Returns EntityV4
+The entity itself, to facilitate method chaining
+
+ -
+
setOrInitializeRemoteState
+ -
+
+
-
+
-
+
+ ++++ +
Initializes or sets the remoteState of the entity. + This function is called on all read, create and update requests. + This function should be called after initializeCustomFields, if custom fields are defined.
+Parameters
+-
+
-
+
Optional state: Record<string, any>
+++State to be set as remote state.
+
+
Returns EntityV4
+The entity itself, to facilitate method chaining
+
+ -
+
setVersionIdentifier
+ -
+
+
-
+
-
+
+ ++++
Set the ETag version identifier of the retrieved entity.
+Parameters
+-
+
-
+
etag: undefined | string
+++The returned ETag version of the entity
+
+
Returns EntityV4
+The entity itself, to facilitate method chaining
+
+ -
+
Protected Static customFieldSelector
+ -
+
+
-
+
-
+
+
Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
fieldName: string
+
+ -
+
entityConstructor: Constructable<EntityT, unknown>
+
+
Returns CustomFieldV4<EntityT>
+
+ -
+
Protected Static entityBuilder
+ -
+
+
-
+
-
+
+
Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+ -
+
EntityTypeT
+
+
Parameters
+-
+
-
+
entityConstructor: Constructable<EntityT, EntityTypeT>
+
+
Returns EntityBuilderType<EntityT, EntityTypeT>
+
+ -
+
+
+
+
+
+ Class EnumField<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.field.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.field.html
new file mode 100644
index 0000000000..f6771a9552
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.field.html
@@ -0,0 +1,343 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ Readonly _field
+
+
+
+
+
+ Readonly edm
+
+
+
+
+
+
+
+
+
+
+
+
+
+ field
+
+
+
+ not
+
+
+
+
+
+
+
+
+ Represents a selectable property with a enum value.
+Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity the field belongs to
+
+
Hierarchy
+-
+
-
+ EnumFieldBase<EntityT>
+
-
+
- + EnumField + +
+
Implements
+ +Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- _entity +
- _entity
Constructor
+ - _field
Name
+ - edm
Type
+ - selectable +
Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+
Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
fieldName: string
+
+ -
+
fieldOf: Constructable<EntityT, unknown>
+
+
Returns EnumField<EntityT>
+
+ -
+
Properties
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ Readonly _fieldName
+
+
+ Readonly edmType
+
+
+ Readonly selectable
+ + +Methods
+equals
+-
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'eq', i.e.
+==.Parameters
+-
+
-
+
value: string
+++Value to be used in the filter
+
+
Returns Filter<EntityT, string>
+The resulting filter
+
+ -
+
fieldPath
+ -
+
+
-
+
-
+
+ ++++
Path to the field to be used in filter and order by queries. In most cases this will just be the _fieldName itself. However, for complex types for instance, the path is prefixed with the name of the complextype.
+Returns string
+Path to the field to be used in filter and order by queries.
+
+
notEquals
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'ne', i.e.
+!=.Parameters
+-
+
-
+
value: string
+++Value to be used in the filter
+
+
Returns Filter<EntityT, string>
+The resulting filter
+
+ -
+
+
+
+
+
+ Class Field<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.filter.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.filter.html
new file mode 100644
index 0000000000..d55943de91
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.filter.html
@@ -0,0 +1,391 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ Readonly _field
+
+
+
+
+
+
+
+ field
+
+
+
+
+
+
+
+
+ Abstract representation a property of an OData entity.
+Fields are used as static properties of entities or properties of ComplexTypeFields and are generated from the metadata, i.e. for each property of
+ an OData entity, there exists one static instance of Field (or rather one of its subclasses) in the corresponding generated class file.
+ Fields are used to represent the domain of values that can be used in select, filter and order by functions.
See also: Selectable, EdmTypeField, ComplexTypeField
+Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity the field belongs to
+
+
Hierarchy
+-
+
-
+ Field
+
-
+
- + CollectionField + +
- + ComplexTypeField + +
- + EdmTypeField + +
+
Implements
+-
+
- EntityIdentifiable<EntityT> +
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- _entity +
- _entity
Constructor
+ - _field
Name
+
Methods
+-
+
- field
Path
+
Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of Field.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
_fieldName: string
+++Actual name of the field used in the OData request
+
+ -
+
_entityConstructor: Constructable<EntityT, unknown>
+++Constructor type of the entity the field belongs to
+
+
Returns Field<EntityT>
+
+ -
+
Properties
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ Readonly _fieldName
+
+
+ Methods
+fieldPath
+ -
+
+
-
+
-
+
+ ++++
Path to the field to be used in filter and order by queries. In most cases this will just be the _fieldName itself. However, for complex types for instance, the path is prefixed with the name of the complextype.
+Returns string
+Path to the field to be used in filter and order by queries.
+
+
+
+
+
+
+ Class Filter<EntityT, FieldT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.filterfunction.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.filterfunction.html
new file mode 100644
index 0000000000..5ae181f28e
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.filterfunction.html
@@ -0,0 +1,425 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ _field
+
+
+
+
+
+ Optional edm
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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: Filterable
+Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity to be filtered on
+
+ -
+
FieldT: FieldType | FieldType[]
+++++Type of the field to be filtered by, see also: FieldType
+
+
Hierarchy
+-
+
- + Filter + +
Implements
+-
+
- EntityIdentifiable<EntityT> +
Index
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- _entity +
- _entity
Constructor
+ - _field
Name
+ - edm
Type
+ - field +
- operator +
- value +
Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of Filter.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+ -
+
FieldT: undefined | null | string | number | boolean | Moment | Time | Duration | BigNumber | FieldType[]
+
+
Parameters
+-
+
-
+
field: string | FilterFunction<EntityT, FieldT>
+++Name of the field of the entity to be filtered on or a filter function
+
+ -
+
operator: FilterOperatorNumber
+++Function to be used for matching
+
+ -
+
value: FieldT
+++Value to be used by the operator
+
+ -
+
Optional edmType: "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" | "Edm.DateTimeOffset" | "Edm.DateTime" | "Edm.Time" | "Edm.Date" | "Edm.Duration" | "Edm.TimeOfDay" | "Edm.Enum"
+++EdmType of the field to filter on, needed for custom fields
+
+
Returns Filter<EntityT, FieldT>
+
+ -
+
Properties
+Readonly _entity
+ + +
+
+
+
+ Entity type of the entity tp be filtered.
+Readonly _entityConstructor
+
+
+
+
+
+
+ Constructor type of the entity to be filtered.
+_fieldName
+
+
+
+
+
+ Optional edmType
+
+
+ field
+ + +operator
+ + +value
+ + +
+
+
+
+
+ Class FilterFunction<EntityT, ReturnT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.filterlambdaexpression.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.filterlambdaexpression.html
new file mode 100644
index 0000000000..c8338a88f6
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.filterlambdaexpression.html
@@ -0,0 +1,262 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly edm
+
+
+
+
+
+ Readonly function
+
+
+
+
+
+
+
+
+
+
+
+
+
+ not
+
+
+
+ to
+
+
+
+
+
+
+
+
+ Data structure to represent OData filter functions.
+ Use the factory function filterFunction to create instances of FilterFunction.
Type parameters
+-
+
-
+
EntityT: EntityBase
+
+ -
+
ReturnT: FieldType | FieldType[]
+
+
Hierarchy
+-
+
-
+ FilterFunction
+
-
+
- + BooleanFilterFunction + +
- + StringFilterFunction + +
- + OrderableFilterFunction + +
+
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- edm
Type
+ - function
Name
+ - parameters +
Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of FilterFunction.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+ -
+
ReturnT: undefined | null | string | number | boolean | Moment | Time | Duration | BigNumber | FieldType[]
+
+
Parameters
+-
+
-
+
functionName: string
+++Name of the function.
+
+ -
+
parameters: FilterFunctionParameterType<EntityT>[]
+++Representation of the parameters passed to the filter function.
+
+ -
+
edmType: EdmTypeShared<VersionT>
+++EdmType of the return type of the filter function.
+
+
Returns FilterFunction<EntityT, ReturnT>
+
+ -
+
Properties
+Readonly edmType
+
+
+ Readonly functionName
+
+
+ Readonly parameters
+ + +Methods
+equals
+-
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this filter function and the given value using the operator 'eq', i.e.
+==.Parameters
+-
+
-
+
value: ReturnT
+++Value to be used in the filter
+
+
Returns Filter<EntityT, ReturnT>
+The resulting filter
+
+ -
+
notEquals
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this filter function and the given value using the operator 'ne', i.e.
+!=.Parameters
+-
+
-
+
value: ReturnT
+++Value to be used in the filter
+
+
Returns Filter<EntityT, ReturnT>
+The resulting filter
+
+ -
+
toString
+ -
+
+
-
+
-
+
+ + ++
Parameters
+-
+
-
+
Optional parentFieldNames: string[]
+++Names of parents in case the function is part of a filter on a navigation property
+
+
Returns string
+The filter function as string
+
+ -
+
+
+
+
+
+ Class FilterLambdaExpression<EntityT, FieldT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.filterlink.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.filterlink.html
new file mode 100644
index 0000000000..7940b58c08
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.filterlink.html
@@ -0,0 +1,351 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ lambda
+
+
+
+
+
+
+
+
+
+
+ hidden
+Type parameters
+-
+
-
+
EntityT: EntityBase
+
+ -
+
FieldT: FieldType
+
+
Hierarchy
+-
+
- + FilterLambdaExpression + +
Index
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- filters +
- lambda
Operator
+
Constructors
+constructor
+-
+
+
-
+
-
+
+
Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+ -
+
FieldT: FieldType
+
+
Parameters
+-
+
-
+
filters: FilterList<EntityT>
+
+ -
+
lambdaOperator: FilterLambdaOperator
+
+
Returns FilterLambdaExpression<EntityT, FieldT>
+
+ -
+
Properties
+filters
+ + +lambdaOperator
+
+
+
+
+
+
+
+ Class FilterLink<EntityT, LinkedEntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.filterlist.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.filterlist.html
new file mode 100644
index 0000000000..a48a544005
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.filterlist.html
@@ -0,0 +1,357 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ Readonly _linked
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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 OneToManyLink.
+Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity to be filtered
+
+ -
+
LinkedEntityT: EntityBase = any
+++++Type of the linked entity which is used in the filter
+
+
Hierarchy
+-
+
- + FilterLink + +
Implements
+-
+
- EntityIdentifiable<EntityT> +
Index
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- _entity +
- _entity
Constructor
+ - _linked
Entity Type
+ - filters +
- link +
Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of FilterLink.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+ -
+
LinkedEntityT: EntityBase<LinkedEntityT> = any
+
+
Parameters
+-
+
-
+
link: Link<EntityT, LinkedEntityT>
+++Linked entity to be used in the filter
+
+ -
+
filters: Filterable<LinkedEntityT>[]
+++List of filterables for the linked entity
+
+
Returns FilterLink<EntityT, LinkedEntityT>
+
+ -
+
Properties
+Readonly _entity
+ + +
+
+
+
+ Entity type of the entity tp be filtered.
+Readonly _entityConstructor
+
+
+
+
+
+
+ Constructor type of the entity to be filtered.
+Readonly _linkedEntityType
+
+
+
+
+
+
+ Linked entity to be filtered by.
+filters
+ + +link
+ + +
+
+
+
+
+ Class FilterList<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.functionimportparameter.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.functionimportparameter.html
new file mode 100644
index 0000000000..ff28b46af3
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.functionimportparameter.html
@@ -0,0 +1,292 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ and
+
+
+
+
+
+ or
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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
+-
+
-
+
EntityT: EntityBase
+++++-
+
+
Hierarchy
+-
+
- + FilterList + +
Implements
+-
+
- EntityIdentifiable<EntityT> +
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- _entity +
- _entity
Constructor
+ - and
Filters
+ - or
Filters
+
Methods
+-
+
- flatten +
Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of FilterList.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
Optional andFilters: Filterable<EntityT>[]
+++Filters to be combined by logical conjunction (
+and)
+ -
+
Optional orFilters: Filterable<EntityT>[]
+++Filters to be combined by logical disjunction (
+or)
+
Returns FilterList<EntityT>
+
+ -
+
Properties
+Readonly _entity
+ + +
+
+
+
+ Entity type of the entity tp be filtered.
+Readonly _entityConstructor
+
+
+
+
+
+
+ Constructor type of the entity to be filtered.
+andFilters
+
+
+ orFilters
+
+
+ Methods
+flatten
+-
+
+
-
+
-
+
+ ++++ +
Flattens
+andFiltersandorFiltersas far as possible while staying logically equivalent.Returns FilterList<EntityT>
+Flattened filter list
+
+
+
+
+
+
+ Class FunctionImportParameter<ValueT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.functionimportrequestbuilder.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.functionimportrequestbuilder.html
new file mode 100644
index 0000000000..597f988d2e
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.functionimportrequestbuilder.html
@@ -0,0 +1,754 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ edm
+
+
+
+
+
+ original
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Internal representation of function import parameters. It adds metadata to the value.
+Type parameters
+-
+
-
+
ValueT
+++++Type of the value
+
+
Hierarchy
+-
+
- + FunctionImportParameter + +
Index
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- edm
Type
+ - original
Name
+ - value +
Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of FunctionImportParameter.
+Type parameters
+-
+
-
+
ValueT
+
+
Parameters
+-
+
-
+
originalName: string
+++The original name of the parameter in the OData service
+
+ -
+
edmType: EdmTypeShared<VersionT>
+++Original edm Type
+
+ -
+
value: ValueT
+++Value to be used as parameter
+
+
Returns FunctionImportParameter<ValueT>
+
+ -
+
Properties
+edmType
+
+
+ originalName
+
+
+ value
+ + +
+
+
+
+
+ Class FunctionImportRequestBuilder<ParametersT, ReturnT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.functionimportrequestbuilderv4.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.functionimportrequestbuilderv4.html
new file mode 100644
index 0000000000..6494daf5fc
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.functionimportrequestbuilderv4.html
@@ -0,0 +1,748 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ request
+
+
+
+
+
+ Readonly response
+
+
+
+
+
+
+
+ add
+
+
+
+ add
+
+
+
+
+
+
+
+
+
+ relative
+
+
+
+ set
+
+
+
+
+
+
+ with
+
+
+
+ with
+
+
+
+ with
+
+
+
+
+
+
+
+
+ Create OData request to execute a function import.
+Type parameters
+-
+
-
+
ParametersT
+++++Type of the function import parameters
+
+ -
+
ReturnT
+++++Type of the function import return value
+
+
Hierarchy
+-
+
-
+ ActionFunctionImportRequestBuilder<ParametersT, ReturnT>
+
-
+
- + FunctionImportRequestBuilder + +
+
Index
+Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of FunctionImportRequestBuilder.
+Type parameters
+-
+
-
+
ParametersT
+
+ -
+
ReturnT
+
+
Parameters
+-
+
-
+
method: RequestMethodType
+++HTTP method to be used for the request
+
+ -
+
defaultServicePath: string
+++Default path for the service the function belongs to
+
+ -
+
functionImportName: string
+++The name of the function import.
+
+ -
+
responseTransformer: (data: any) => ReturnT
+++Transformation function for the response
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
data: any
+
+
Returns ReturnT
+
+ -
+
+ -
+
+ -
+
-
+
parameters: FunctionImportParameters<ParametersT>
+++Parameters to be set in the function
+
+
Returns FunctionImportRequestBuilder<ParametersT, ReturnT>
+
+ -
+
Properties
+requestConfig
+
+
+ Readonly responseTransformer
+
+
+
+
+ Type declaration
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
data: any
+
+
Returns ReturnT
+
+ -
+
+ -
+
Methods
+addCustomHeaders
+ -
+
+
-
+
-
+
+ ++++
Add custom headers to the request. Existing headers will be overwritten.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs denoting additional custom headers.
+
+
Returns FunctionImportRequestBuilder<ParametersT, ReturnT>
+The request builder itself, to facilitate method chaining.
+
+ -
+
addCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++
Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs denoting additional custom query parameters to be set in the request
+
+
Returns FunctionImportRequestBuilder<ParametersT, ReturnT>
+The request builder itself, to facilitate method chaining
+
+ -
+
build
+-
+
+
+
-
+
-
+
+
Returns ODataRequest<ODataFunctionImportRequestConfig<ParametersT> | ODataActionImportRequestConfig<ParametersT>>
+
+ -
+
+
Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+
+ -
+
Optional options: (DestinationCachingOptions & ResilienceOptions) | (CachingOptions & ResilienceOptions)
+
+
Returns Promise<ODataRequest<ODataFunctionImportRequestConfig<ParametersT> | ODataActionImportRequestConfig<ParametersT>>>
+
+ -
+
execute
+-
+
+
-
+
-
+
+ ++++
Execute request
+Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++Destination to execute the request against
+
+ -
+
Optional options: (DestinationAccessorOptions & DestinationCachingOptions & ResilienceOptions & VerifyJwtOptions) | (DestinationAccessorOptions & CachingOptions & ResilienceOptions & VerifyJwtOptions)
+++Options to employ when fetching destinations
+
+
Returns Promise<ReturnT>
+A promise resolving to the requested return type
+
+ -
+
relativeUrl
+ -
+
+
-
+
-
+
+ ++++
Create the relative url based on configuration of the given builder.
+Returns string
+The relative url for the request
+
+
setCustomServicePath
+ -
+
+
-
+
-
+
+ ++++
Replace the default service path with the given custom path. + In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/
+' and can be overwritten here. Parameters
+-
+
-
+
servicePath: string
+++Path to override the default with
+
+
Returns FunctionImportRequestBuilder<ParametersT, ReturnT>
+The request builder itself, to facilitate method chaining
+
+ -
+
url
+-
+
+
-
+
-
+
+ ++++
Create the url based on configuration of the given builder.
+Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++Destination to execute the request against
+
+ -
+
Optional options: (DestinationCachingOptions & ResilienceOptions) | (CachingOptions & ResilienceOptions)
+++Options to employ when fetching destinations.
+
+
Returns Promise<string>
+Promise resolving to the url for the request
+
+ -
+
withCustomHeaders
+ -
+
+
-
+
-
+
+ ++++ +
Add custom headers to the request.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs denoting additional custom headers
+
+
Returns FunctionImportRequestBuilder<ParametersT, ReturnT>
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++ +
Add custom query parameters to the request.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs denoting additional custom query parameters to be set in the request
+
+
Returns FunctionImportRequestBuilder<ParametersT, ReturnT>
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomServicePath
+ -
+
+
-
+
-
+
+ ++++ +
Replace the default service path with the given custom path. + In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/
+' and can be overwritten here. Parameters
+-
+
-
+
servicePath: string
+++Path to override the default with
+
+
Returns FunctionImportRequestBuilder<ParametersT, ReturnT>
+The request builder itself, to facilitate method chaining
+
+ -
+
+
+
+
+
+ Class FunctionImportRequestBuilderV4<ParametersT, ReturnT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.getallrequestbuilder.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.getallrequestbuilder.html
new file mode 100644
index 0000000000..526913613c
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.getallrequestbuilder.html
@@ -0,0 +1,978 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ request
+
+
+
+
+
+ Readonly response
+
+
+
+
+
+
+
+ add
+
+
+
+ add
+
+
+
+
+
+
+
+
+
+ relative
+
+
+
+ set
+
+
+
+
+
+
+ with
+
+
+
+ with
+
+
+
+ with
+
+
+
+
+
+
+
+
+ Create OData request to execute a function import.
+Type parameters
+-
+
-
+
ParametersT
+++++Type of the function import parameters
+
+ -
+
ReturnT
+++++Type of the function import return value
+
+
Hierarchy
+-
+
-
+ ActionFunctionImportRequestBuilder<ParametersT, ReturnT>
+
-
+
- + FunctionImportRequestBuilderV4 + +
+
Index
+Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of FunctionImportRequestBuilder.
+Type parameters
+-
+
-
+
ParametersT
+
+ -
+
ReturnT
+
+
Parameters
+-
+
-
+
defaultServicePath: string
+++Default path for the service the function belongs to
+
+ -
+
functionImportName: string
+++The name of the function import.
+
+ -
+
responseTransformer: (data: any) => ReturnT
+++Transformation function for the response
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
data: any
+
+
Returns ReturnT
+
+ -
+
+ -
+
+ -
+
-
+
parameters: FunctionImportParameters<ParametersT>
+++Parameters to be set in the function
+
+
Returns FunctionImportRequestBuilderV4<ParametersT, ReturnT>
+
+ -
+
Properties
+requestConfig
+
+
+ Readonly responseTransformer
+
+
+
+
+ Type declaration
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
data: any
+
+
Returns ReturnT
+
+ -
+
+ -
+
Methods
+addCustomHeaders
+ -
+
+
-
+
-
+
+ ++++
Add custom headers to the request. Existing headers will be overwritten.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs denoting additional custom headers.
+
+
Returns FunctionImportRequestBuilderV4<ParametersT, ReturnT>
+The request builder itself, to facilitate method chaining.
+
+ -
+
addCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++
Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs denoting additional custom query parameters to be set in the request
+
+
Returns FunctionImportRequestBuilderV4<ParametersT, ReturnT>
+The request builder itself, to facilitate method chaining
+
+ -
+
build
+-
+
+
+
-
+
-
+
+
Returns ODataRequest<ODataFunctionImportRequestConfig<ParametersT> | ODataActionImportRequestConfig<ParametersT>>
+
+ -
+
+
Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+
+ -
+
Optional options: (DestinationCachingOptions & ResilienceOptions) | (CachingOptions & ResilienceOptions)
+
+
Returns Promise<ODataRequest<ODataFunctionImportRequestConfig<ParametersT> | ODataActionImportRequestConfig<ParametersT>>>
+
+ -
+
execute
+-
+
+
-
+
-
+
+ ++++
Execute request
+Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++Destination to execute the request against
+
+ -
+
Optional options: (DestinationAccessorOptions & DestinationCachingOptions & ResilienceOptions & VerifyJwtOptions) | (DestinationAccessorOptions & CachingOptions & ResilienceOptions & VerifyJwtOptions)
+++Options to employ when fetching destinations
+
+
Returns Promise<ReturnT>
+A promise resolving to the requested return type
+
+ -
+
relativeUrl
+ -
+
+
-
+
-
+
+ ++++
Create the relative url based on configuration of the given builder.
+Returns string
+The relative url for the request
+
+
setCustomServicePath
+ -
+
+
-
+
-
+
+ ++++
Replace the default service path with the given custom path. + In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/
+' and can be overwritten here. Parameters
+-
+
-
+
servicePath: string
+++Path to override the default with
+
+
Returns FunctionImportRequestBuilderV4<ParametersT, ReturnT>
+The request builder itself, to facilitate method chaining
+
+ -
+
url
+-
+
+
-
+
-
+
+ ++++
Create the url based on configuration of the given builder.
+Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++Destination to execute the request against
+
+ -
+
Optional options: (DestinationCachingOptions & ResilienceOptions) | (CachingOptions & ResilienceOptions)
+++Options to employ when fetching destinations.
+
+
Returns Promise<string>
+Promise resolving to the url for the request
+
+ -
+
withCustomHeaders
+ -
+
+
-
+
-
+
+ ++++ +
Add custom headers to the request.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs denoting additional custom headers
+
+
Returns FunctionImportRequestBuilderV4<ParametersT, ReturnT>
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++ +
Add custom query parameters to the request.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs denoting additional custom query parameters to be set in the request
+
+
Returns FunctionImportRequestBuilderV4<ParametersT, ReturnT>
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomServicePath
+ -
+
+
-
+
-
+
+ ++++ +
Replace the default service path with the given custom path. + In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/
+' and can be overwritten here. Parameters
+-
+
-
+
servicePath: string
+++Path to override the default with
+
+
Returns FunctionImportRequestBuilderV4<ParametersT, ReturnT>
+The request builder itself, to facilitate method chaining
+
+ -
+
+
+
+
+
+ Class GetAllRequestBuilder<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.getallrequestbuilderbase.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.getallrequestbuilderbase.html
new file mode 100644
index 0000000000..175a939376
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.getallrequestbuilderbase.html
@@ -0,0 +1,926 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ Readonly data
+
+
+
+
+
+ Readonly entity
+
+
+
+
+
+ request
+
+
+
+
+
+
+
+ add
+
+
+
+ add
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ order
+
+
+
+ relative
+
+
+
+
+
+
+ set
+
+
+
+
+
+
+
+
+
+
+
+
+ with
+
+
+
+ with
+
+
+
+ with
+
+
+
+
+ Type parameters
+-
+
-
+
EntityT: Entity
+
+
Hierarchy
+-
+
-
+ GetAllRequestBuilderBase<EntityT>
+
-
+
- + GetAllRequestBuilder + +
+
Implements
+-
+
- EntityIdentifiable<EntityT> +
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+ +Methods
+-
+
- add
Custom Headers
+ - add
Custom Query Parameters
+ - build +
- count +
- execute +
- filter +
- order
By
+ - relative
Url
+ - select +
- set
Custom Service Path
+ - skip +
- top +
- url +
- with
Custom Headers
+ - with
Custom Query Parameters
+ - with
Custom Service Path
+
Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of GetAllRequestBuilder.
+Type parameters
+-
+
-
+
EntityT: Entity<EntityT>
+
+
Parameters
+-
+
-
+
entityConstructor: Constructable<EntityT, unknown>
+++Constructor of the entity to create the request for
+
+
Returns GetAllRequestBuilder<EntityT>
+
+ -
+
Properties
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ Readonly dataAccessor
+
+
+ Readonly entityDeserializer
+
+
+ requestConfig
+
+
+ Methods
+addCustomHeaders
+ -
+
+
-
+
-
+
+ ++++
Add custom headers to the request. Existing headers will be overwritten.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs denoting additional custom headers.
+
+
Returns GetAllRequestBuilder<EntityT>
+The request builder itself, to facilitate method chaining.
+
+ -
+
addCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++
Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs denoting additional custom query parameters to be set in the request
+
+
Returns GetAllRequestBuilder<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
build
+-
+
+
+
-
+
-
+
+
Returns ODataRequest<ODataGetAllRequestConfig<EntityT>>
+
+ -
+
+
Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+
+ -
+
Optional options: (DestinationCachingOptions & ResilienceOptions) | (CachingOptions & ResilienceOptions)
+
+
Returns Promise<ODataRequest<ODataGetAllRequestConfig<EntityT>>>
+
+ -
+
count
+-
+
+
-
+
-
+
+ ++++
Count the number of entities.
+Returns CountRequestBuilder<EntityT>
+A count request builder for execution
+
+
execute
+-
+
+
-
+
-
+
+ ++++
Execute request.
+Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++Destination to execute the request against
+
+ -
+
Optional options: (DestinationAccessorOptions & DestinationCachingOptions & ResilienceOptions & VerifyJwtOptions) | (DestinationAccessorOptions & CachingOptions & ResilienceOptions & VerifyJwtOptions)
+++Options to employ when fetching destinations
+
+
Returns Promise<EntityT[]>
+A promise resolving to the requested entities
+
+ -
+
filter
+-
+
+
+
-
+
-
+
+ ++++
Add filter statements to the request.
+Parameters
+-
+
-
+
expressions: Filterable<EntityT>[]
+++Filter expressions to restrict the response
+
+
Returns GetAllRequestBuilder<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
-
+
+
Parameters
+-
+
-
+
Rest ...expressions: Filterable<EntityT>[]
+
+
Returns GetAllRequestBuilder<EntityT>
+
+ -
+
orderBy
+ -
+
+
+
-
+
-
+
+ ++++
Add order-by statements to the request.
+Parameters
+-
+
-
+
orderBy: Orderable<EntityT>[]
+++OrderBy statements to order the response by
+
+
Returns GetAllRequestBuilder<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
-
+
+
Parameters
+-
+
-
+
Rest ...orderBy: Orderable<EntityT>[]
+
+
Returns GetAllRequestBuilder<EntityT>
+
+ -
+
relativeUrl
+ -
+
+
-
+
-
+
+ ++++
Create the relative url based on configuration of the given builder.
+Returns string
+The relative url for the request
+
+
select
+-
+
+
+
-
+
-
+
+ ++++
Restrict the response to the given selection of properties in the request.
+Parameters
+-
+
-
+
Rest ...selects: Selectable<EntityT>[]
+++Fields to select in the request
+
+
Returns GetAllRequestBuilder<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
-
+
+
Parameters
+-
+
-
+
selects: Selectable<EntityT>[]
+
+
Returns GetAllRequestBuilder<EntityT>
+
+ -
+
setCustomServicePath
+ -
+
+
-
+
-
+
+ ++++
Replace the default service path with the given custom path. + In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/
+' and can be overwritten here. Parameters
+-
+
-
+
servicePath: string
+++Path to override the default with
+
+
Returns GetAllRequestBuilder<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
skip
+-
+
+
-
+
-
+
+ ++++
Skip number of entities.
+Parameters
+-
+
-
+
skip: number
+++Number of matching entities to skip. Useful for paging
+
+
Returns GetAllRequestBuilder<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
top
+-
+
+
-
+
-
+
+ ++++
Limit number of returned entities.
+Parameters
+-
+
-
+
top: number
+++Maximum number of entities to return in the response. Can be less, if less entities match the request
+
+
Returns GetAllRequestBuilder<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
url
+-
+
+
-
+
-
+
+ ++++
Create the url based on configuration of the given builder.
+Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++Destination to execute the request against
+
+ -
+
Optional options: (DestinationCachingOptions & ResilienceOptions) | (CachingOptions & ResilienceOptions)
+++Options to employ when fetching destinations.
+
+
Returns Promise<string>
+Promise resolving to the url for the request
+
+ -
+
withCustomHeaders
+ -
+
+
-
+
-
+
+ ++++ +
Add custom headers to the request.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs denoting additional custom headers
+
+
Returns GetAllRequestBuilder<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++ +
Add custom query parameters to the request.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs denoting additional custom query parameters to be set in the request
+
+
Returns GetAllRequestBuilder<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomServicePath
+ -
+
+
-
+
-
+
+ ++++ +
Replace the default service path with the given custom path. + In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/
+' and can be overwritten here. Parameters
+-
+
-
+
servicePath: string
+++Path to override the default with
+
+
Returns GetAllRequestBuilder<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
+
+
+
+
+ Class GetAllRequestBuilderBase<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.getallrequestbuilderv4.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.getallrequestbuilderv4.html
new file mode 100644
index 0000000000..d2daaf6e53
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.getallrequestbuilderv4.html
@@ -0,0 +1,1006 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ Readonly data
+
+
+
+
+
+ Readonly entity
+
+
+
+
+
+ request
+
+
+
+
+
+
+
+ add
+
+
+
+ add
+
+
+
+
+
+
+
+
+
+
+
+
+ order
+
+
+
+ relative
+
+
+
+
+
+
+ set
+
+
+
+
+
+
+
+
+
+
+
+
+ with
+
+
+
+ with
+
+
+
+ with
+
+
+
+
+
+
+
+
+ Base class for the get all request builders GetAllRequestBuilderV2 and GetAllRequestBuilderV4
+Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity to be requested
+
+
Hierarchy
+-
+
-
+ GetRequestBuilder<EntityT, ODataGetAllRequestConfig<EntityT>>
+
-
+
-
+ GetAllRequestBuilderBase
+
-
+
- + GetAllRequestBuilder + +
- + GetAllRequestBuilderV4 + +
+
+ -
+ GetAllRequestBuilderBase
+
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+ +Methods
+-
+
- add
Custom Headers
+ - add
Custom Query Parameters
+ - build +
- count +
- execute +
- order
By
+ - relative
Url
+ - select +
- set
Custom Service Path
+ - skip +
- top +
- url +
- with
Custom Headers
+ - with
Custom Query Parameters
+ - with
Custom Service Path
+
Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of GetAllRequestBuilder.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
entityConstructor: Constructable<EntityT, unknown>
+++Constructor of the entity to create the request for
+
+ -
+
getAllRequestConfig: ODataGetAllRequestConfig<EntityT>
+++Request config of the get all request.
+
+ -
+
entityDeserializer: EntityDeserializer<any>
+
+ -
+
dataAccessor: ResponseDataAccessor
+
+
Returns GetAllRequestBuilderBase<EntityT>
+
+ -
+
Properties
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ Readonly dataAccessor
+
+
+ Readonly entityDeserializer
+
+
+ requestConfig
+
+
+ Methods
+addCustomHeaders
+ -
+
+
-
+
-
+
+ ++++
Add custom headers to the request. Existing headers will be overwritten.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs denoting additional custom headers.
+
+
Returns GetAllRequestBuilderBase<EntityT>
+The request builder itself, to facilitate method chaining.
+
+ -
+
addCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++
Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs denoting additional custom query parameters to be set in the request
+
+
Returns GetAllRequestBuilderBase<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
build
+-
+
+
+
-
+
-
+
+
Returns ODataRequest<ODataGetAllRequestConfig<EntityT>>
+
+ -
+
+
Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+
+ -
+
Optional options: (DestinationCachingOptions & ResilienceOptions) | (CachingOptions & ResilienceOptions)
+
+
Returns Promise<ODataRequest<ODataGetAllRequestConfig<EntityT>>>
+
+ -
+
count
+-
+
+
-
+
-
+
+ ++++
Count the number of entities.
+Returns CountRequestBuilder<EntityT>
+A count request builder for execution
+
+
execute
+-
+
+
-
+
-
+
+ ++++
Execute request.
+Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++Destination to execute the request against
+
+ -
+
Optional options: (DestinationAccessorOptions & DestinationCachingOptions & ResilienceOptions & VerifyJwtOptions) | (DestinationAccessorOptions & CachingOptions & ResilienceOptions & VerifyJwtOptions)
+++Options to employ when fetching destinations
+
+
Returns Promise<EntityT[]>
+A promise resolving to the requested entities
+
+ -
+
orderBy
+ -
+
+
+
-
+
-
+
+ ++++
Add order-by statements to the request.
+Parameters
+-
+
-
+
orderBy: Orderable<EntityT>[]
+++OrderBy statements to order the response by
+
+
Returns GetAllRequestBuilderBase<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
-
+
+
Parameters
+-
+
-
+
Rest ...orderBy: Orderable<EntityT>[]
+
+
Returns GetAllRequestBuilderBase<EntityT>
+
+ -
+
relativeUrl
+ -
+
+
-
+
-
+
+ ++++
Create the relative url based on configuration of the given builder.
+Returns string
+The relative url for the request
+
+
select
+-
+
+
+
-
+
-
+
+ ++++
Restrict the response to the given selection of properties in the request.
+Parameters
+-
+
-
+
Rest ...selects: Selectable<EntityT>[]
+++Fields to select in the request
+
+
Returns GetAllRequestBuilderBase<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
-
+
+
Parameters
+-
+
-
+
selects: Selectable<EntityT>[]
+
+
Returns GetAllRequestBuilderBase<EntityT>
+
+ -
+
setCustomServicePath
+ -
+
+
-
+
-
+
+ ++++
Replace the default service path with the given custom path. + In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/
+' and can be overwritten here. Parameters
+-
+
-
+
servicePath: string
+++Path to override the default with
+
+
Returns GetAllRequestBuilderBase<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
skip
+-
+
+
-
+
-
+
+ ++++
Skip number of entities.
+Parameters
+-
+
-
+
skip: number
+++Number of matching entities to skip. Useful for paging
+
+
Returns GetAllRequestBuilderBase<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
top
+-
+
+
-
+
-
+
+ ++++
Limit number of returned entities.
+Parameters
+-
+
-
+
top: number
+++Maximum number of entities to return in the response. Can be less, if less entities match the request
+
+
Returns GetAllRequestBuilderBase<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
url
+-
+
+
-
+
-
+
+ ++++
Create the url based on configuration of the given builder.
+Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++Destination to execute the request against
+
+ -
+
Optional options: (DestinationCachingOptions & ResilienceOptions) | (CachingOptions & ResilienceOptions)
+++Options to employ when fetching destinations.
+
+
Returns Promise<string>
+Promise resolving to the url for the request
+
+ -
+
withCustomHeaders
+ -
+
+
-
+
-
+
+ ++++ +
Add custom headers to the request.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs denoting additional custom headers
+
+
Returns GetAllRequestBuilderBase<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++ +
Add custom query parameters to the request.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs denoting additional custom query parameters to be set in the request
+
+
Returns GetAllRequestBuilderBase<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomServicePath
+ -
+
+
-
+
-
+
+ ++++ +
Replace the default service path with the given custom path. + In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/
+' and can be overwritten here. Parameters
+-
+
-
+
servicePath: string
+++Path to override the default with
+
+
Returns GetAllRequestBuilderBase<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
+
+
+
+
+ Class GetAllRequestBuilderV4<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.getbykeyrequestbuilder.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.getbykeyrequestbuilder.html
new file mode 100644
index 0000000000..d57bec8879
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.getbykeyrequestbuilder.html
@@ -0,0 +1,792 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ Readonly data
+
+
+
+
+
+ Readonly entity
+
+
+
+
+
+ request
+
+
+
+
+
+
+
+ add
+
+
+
+ add
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ order
+
+
+
+ relative
+
+
+
+
+
+
+ set
+
+
+
+
+
+
+
+
+
+
+
+
+ with
+
+
+
+ with
+
+
+
+ with
+
+
+
+
+ Type parameters
+-
+
-
+
EntityT: EntityV4
+
+
Hierarchy
+-
+
-
+ GetAllRequestBuilderBase<EntityT>
+
-
+
- + GetAllRequestBuilderV4 + +
+
Implements
+-
+
- EntityIdentifiable<EntityT> +
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+ +Methods
+-
+
- add
Custom Headers
+ - add
Custom Query Parameters
+ - build +
- count +
- execute +
- expand +
- filter +
- order
By
+ - relative
Url
+ - select +
- set
Custom Service Path
+ - skip +
- top +
- url +
- with
Custom Headers
+ - with
Custom Query Parameters
+ - with
Custom Service Path
+
Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of GetAllRequestBuilder.
+Type parameters
+-
+
-
+
EntityT: EntityV4<EntityT>
+
+
Parameters
+-
+
-
+
entityConstructor: Constructable<EntityT, unknown>
+++Constructor of the entity to create the request for
+
+
Returns GetAllRequestBuilderV4<EntityT>
+
+ -
+
Properties
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ Readonly dataAccessor
+
+
+ Readonly entityDeserializer
+
+
+ requestConfig
+
+
+ Methods
+addCustomHeaders
+ -
+
+
-
+
-
+
+ ++++
Add custom headers to the request. Existing headers will be overwritten.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs denoting additional custom headers.
+
+
Returns GetAllRequestBuilderV4<EntityT>
+The request builder itself, to facilitate method chaining.
+
+ -
+
addCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++
Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs denoting additional custom query parameters to be set in the request
+
+
Returns GetAllRequestBuilderV4<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
build
+-
+
+
+
-
+
-
+
+
Returns ODataRequest<ODataGetAllRequestConfig<EntityT>>
+
+ -
+
+
Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+
+ -
+
Optional options: (DestinationCachingOptions & ResilienceOptions) | (CachingOptions & ResilienceOptions)
+
+
Returns Promise<ODataRequest<ODataGetAllRequestConfig<EntityT>>>
+
+ -
+
count
+-
+
+
-
+
-
+
+ ++++
Count the number of entities.
+Returns CountRequestBuilder<EntityT>
+A count request builder for execution
+
+
execute
+-
+
+
-
+
-
+
+ ++++
Execute request.
+Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++Destination to execute the request against
+
+ -
+
Optional options: (DestinationAccessorOptions & DestinationCachingOptions & ResilienceOptions & VerifyJwtOptions) | (DestinationAccessorOptions & CachingOptions & ResilienceOptions & VerifyJwtOptions)
+++Options to employ when fetching destinations
+
+
Returns Promise<EntityT[]>
+A promise resolving to the requested entities
+
+ -
+
expand
+-
+
+
+
-
+
-
+
+
Parameters
+-
+
-
+
expands: Expandable<EntityT>[]
+
+
Returns GetAllRequestBuilderV4<EntityT>
+
+ -
+
-
+
+
Parameters
+-
+
-
+
Rest ...expands: Expandable<EntityT>[]
+
+
Returns GetAllRequestBuilderV4<EntityT>
+
+ -
+
filter
+-
+
+
-
+
-
+
+ ++++
Add filter statements to the request.
+Parameters
+-
+
-
+
Rest ...expressions: (Filter<EntityT, undefined | null | string | number | boolean | Moment | Time | Duration | BigNumber | FieldType[]> | FilterLink<EntityT, any> | FilterList<EntityT> | FilterLambdaExpression<EntityT, FieldType> | OneToManyLink<EntityT, any>)[]
+++Filter expressions to restrict the response
+
+
Returns GetAllRequestBuilderV4<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
orderBy
+ -
+
+
+
-
+
-
+
+ ++++
Add order-by statements to the request.
+Parameters
+-
+
-
+
orderBy: Orderable<EntityT>[]
+++OrderBy statements to order the response by
+
+
Returns GetAllRequestBuilderV4<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
-
+
+
Parameters
+-
+
-
+
Rest ...orderBy: Orderable<EntityT>[]
+
+
Returns GetAllRequestBuilderV4<EntityT>
+
+ -
+
relativeUrl
+ -
+
+
-
+
-
+
+ ++++
Create the relative url based on configuration of the given builder.
+Returns string
+The relative url for the request
+
+
select
+-
+
+
+
-
+
-
+
+ ++++
Restrict the response to the given selection of properties in the request.
+Parameters
+-
+
-
+
Rest ...selects: Selectable<EntityT>[]
+++Fields to select in the request
+
+
Returns GetAllRequestBuilderV4<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
-
+
+
Parameters
+-
+
-
+
selects: Selectable<EntityT>[]
+
+
Returns GetAllRequestBuilderV4<EntityT>
+
+ -
+
setCustomServicePath
+ -
+
+
-
+
-
+
+ ++++
Replace the default service path with the given custom path. + In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/
+' and can be overwritten here. Parameters
+-
+
-
+
servicePath: string
+++Path to override the default with
+
+
Returns GetAllRequestBuilderV4<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
skip
+-
+
+
-
+
-
+
+ ++++
Skip number of entities.
+Parameters
+-
+
-
+
skip: number
+++Number of matching entities to skip. Useful for paging
+
+
Returns GetAllRequestBuilderV4<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
top
+-
+
+
-
+
-
+
+ ++++
Limit number of returned entities.
+Parameters
+-
+
-
+
top: number
+++Maximum number of entities to return in the response. Can be less, if less entities match the request
+
+
Returns GetAllRequestBuilderV4<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
url
+-
+
+
-
+
-
+
+ ++++
Create the url based on configuration of the given builder.
+Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++Destination to execute the request against
+
+ -
+
Optional options: (DestinationCachingOptions & ResilienceOptions) | (CachingOptions & ResilienceOptions)
+++Options to employ when fetching destinations.
+
+
Returns Promise<string>
+Promise resolving to the url for the request
+
+ -
+
withCustomHeaders
+ -
+
+
-
+
-
+
+ ++++ +
Add custom headers to the request.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs denoting additional custom headers
+
+
Returns GetAllRequestBuilderV4<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++ +
Add custom query parameters to the request.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs denoting additional custom query parameters to be set in the request
+
+
Returns GetAllRequestBuilderV4<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomServicePath
+ -
+
+
-
+
-
+
+ ++++ +
Replace the default service path with the given custom path. + In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/
+' and can be overwritten here. Parameters
+-
+
-
+
servicePath: string
+++Path to override the default with
+
+
Returns GetAllRequestBuilderV4<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
+
+
+
+
+ Class GetByKeyRequestBuilder<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.getbykeyrequestbuilderbase.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.getbykeyrequestbuilderbase.html
new file mode 100644
index 0000000000..f79af9ffe4
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.getbykeyrequestbuilderbase.html
@@ -0,0 +1,785 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ Readonly data
+
+
+
+
+
+ Readonly entity
+
+
+
+
+
+ request
+
+
+
+
+
+
+
+ add
+
+
+
+ add
+
+
+
+
+
+
+
+
+
+ relative
+
+
+
+
+
+
+ set
+
+
+
+
+
+
+ with
+
+
+
+ with
+
+
+
+ with
+
+
+
+
+
+
+
+
+ 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: Entity
+++++Type of the entity to be requested
+
+
Hierarchy
+-
+
-
+ GetByKeyRequestBuilderBase<EntityT>
+
-
+
- + GetByKeyRequestBuilder + +
+
Implements
+-
+
- EntityIdentifiable<EntityT> +
Index
+Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of GetByKeyRequestBuilder.
+Type parameters
+-
+
-
+
EntityT: Entity<EntityT>
+
+
Parameters
+-
+
-
+
_entityConstructor: Constructable<EntityT, unknown>
+++Constructor of the entity to create the request for
+
+ -
+
keys: Record<string, FieldType>
+++Key-value pairs where the key is the name of a key property of the given entity and the value is the respective value
+
+
Returns GetByKeyRequestBuilder<EntityT>
+
+ -
+
Properties
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ Readonly dataAccessor
+
+
+ Readonly entityDeserializer
+
+
+ requestConfig
+
+
+ Methods
+addCustomHeaders
+ -
+
+
-
+
-
+
+ ++++
Add custom headers to the request. Existing headers will be overwritten.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs denoting additional custom headers.
+
+
Returns GetByKeyRequestBuilder<EntityT>
+The request builder itself, to facilitate method chaining.
+
+ -
+
addCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++
Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs denoting additional custom query parameters to be set in the request
+
+
Returns GetByKeyRequestBuilder<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
build
+-
+
+
+
-
+
-
+
+
Returns ODataRequest<ODataGetByKeyRequestConfig<EntityT>>
+
+ -
+
+
Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+
+ -
+
Optional options: (DestinationCachingOptions & ResilienceOptions) | (CachingOptions & ResilienceOptions)
+
+
Returns Promise<ODataRequest<ODataGetByKeyRequestConfig<EntityT>>>
+
+ -
+
execute
+-
+
+
-
+
-
+
+ ++++
Execute request.
+Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++Destination to execute the request against
+
+ -
+
Optional options: (DestinationAccessorOptions & DestinationCachingOptions & ResilienceOptions & VerifyJwtOptions) | (DestinationAccessorOptions & CachingOptions & ResilienceOptions & VerifyJwtOptions)
+++Options to employ when fetching destinations
+
+
Returns Promise<EntityT>
+A promise resolving to the requested entity
+
+ -
+
relativeUrl
+ -
+
+
-
+
-
+
+ ++++
Create the relative url based on configuration of the given builder.
+Returns string
+The relative url for the request
+
+
select
+-
+
+
+
-
+
-
+
+ ++++
Restrict the response to the given selection of properties in the request.
+Parameters
+-
+
-
+
Rest ...selects: Selectable<EntityT>[]
+++Fields to select in the request
+
+
Returns GetByKeyRequestBuilder<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
-
+
+
Parameters
+-
+
-
+
selects: Selectable<EntityT>[]
+
+
Returns GetByKeyRequestBuilder<EntityT>
+
+ -
+
setCustomServicePath
+ -
+
+
-
+
-
+
+ ++++
Replace the default service path with the given custom path. + In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/
+' and can be overwritten here. Parameters
+-
+
-
+
servicePath: string
+++Path to override the default with
+
+
Returns GetByKeyRequestBuilder<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
url
+-
+
+
-
+
-
+
+ ++++
Create the url based on configuration of the given builder.
+Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++Destination to execute the request against
+
+ -
+
Optional options: (DestinationCachingOptions & ResilienceOptions) | (CachingOptions & ResilienceOptions)
+++Options to employ when fetching destinations.
+
+
Returns Promise<string>
+Promise resolving to the url for the request
+
+ -
+
withCustomHeaders
+ -
+
+
-
+
-
+
+ ++++ +
Add custom headers to the request.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs denoting additional custom headers
+
+
Returns GetByKeyRequestBuilder<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++ +
Add custom query parameters to the request.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs denoting additional custom query parameters to be set in the request
+
+
Returns GetByKeyRequestBuilder<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomServicePath
+ -
+
+
-
+
-
+
+ ++++ +
Replace the default service path with the given custom path. + In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/
+' and can be overwritten here. Parameters
+-
+
-
+
servicePath: string
+++Path to override the default with
+
+
Returns GetByKeyRequestBuilder<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
+
+
+
+
+ Class GetByKeyRequestBuilderBase<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.getbykeyrequestbuilderv4.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.getbykeyrequestbuilderv4.html
new file mode 100644
index 0000000000..48d883e1ed
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.getbykeyrequestbuilderv4.html
@@ -0,0 +1,836 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ Readonly data
+
+
+
+
+
+ Readonly entity
+
+
+
+
+
+ request
+
+
+
+
+
+
+
+ add
+
+
+
+ add
+
+
+
+
+
+
+
+
+
+ relative
+
+
+
+
+
+
+ set
+
+
+
+
+
+
+ with
+
+
+
+ with
+
+
+
+ with
+
+
+
+
+
+
+
+
+ Abstract class to create a get by key request containing the shared functionality for OData v2 and v4.
+Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity to be requested
+
+
Hierarchy
+-
+
-
+ GetRequestBuilder<EntityT, ODataGetByKeyRequestConfig<EntityT>>
+
-
+
-
+ GetByKeyRequestBuilderBase
+
-
+
- + GetByKeyRequestBuilder + +
- + GetByKeyRequestBuilderV4 + +
+
+ -
+ GetByKeyRequestBuilderBase
+
Index
+Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of GetByKeyRequestBuilder.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
entityConstructor: Constructable<EntityT, unknown>
+++Constructor of the entity to create the request for
+
+ -
+
keys: Record<string, FieldType>
+++Key-value pairs where the key is the name of a key property of the given entity and the value is the respective value
+
+ -
+
oDataUri: ODataUri
+++Uri conversion methods
+
+ -
+
entityDeserializer: EntityDeserializer<any>
+++Entity deserializer
+
+ -
+
dataAccessor: ResponseDataAccessor
+
+
Returns GetByKeyRequestBuilderBase<EntityT>
+
+ -
+
Properties
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ Readonly dataAccessor
+
+
+ Readonly entityDeserializer
+
+
+ requestConfig
+
+
+ Methods
+addCustomHeaders
+ -
+
+
-
+
-
+
+ ++++
Add custom headers to the request. Existing headers will be overwritten.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs denoting additional custom headers.
+
+
Returns GetByKeyRequestBuilderBase<EntityT>
+The request builder itself, to facilitate method chaining.
+
+ -
+
addCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++
Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs denoting additional custom query parameters to be set in the request
+
+
Returns GetByKeyRequestBuilderBase<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
build
+-
+
+
+
-
+
-
+
+
Returns ODataRequest<ODataGetByKeyRequestConfig<EntityT>>
+
+ -
+
+
Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+
+ -
+
Optional options: (DestinationCachingOptions & ResilienceOptions) | (CachingOptions & ResilienceOptions)
+
+
Returns Promise<ODataRequest<ODataGetByKeyRequestConfig<EntityT>>>
+
+ -
+
execute
+-
+
+
-
+
-
+
+ ++++
Execute request.
+Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++Destination to execute the request against
+
+ -
+
Optional options: (DestinationAccessorOptions & DestinationCachingOptions & ResilienceOptions & VerifyJwtOptions) | (DestinationAccessorOptions & CachingOptions & ResilienceOptions & VerifyJwtOptions)
+++Options to employ when fetching destinations
+
+
Returns Promise<EntityT>
+A promise resolving to the requested entity
+
+ -
+
relativeUrl
+ -
+
+
-
+
-
+
+ ++++
Create the relative url based on configuration of the given builder.
+Returns string
+The relative url for the request
+
+
select
+-
+
+
+
-
+
-
+
+ ++++
Restrict the response to the given selection of properties in the request.
+Parameters
+-
+
-
+
Rest ...selects: Selectable<EntityT>[]
+++Fields to select in the request
+
+
Returns GetByKeyRequestBuilderBase<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
-
+
+
Parameters
+-
+
-
+
selects: Selectable<EntityT>[]
+
+
Returns GetByKeyRequestBuilderBase<EntityT>
+
+ -
+
setCustomServicePath
+ -
+
+
-
+
-
+
+ ++++
Replace the default service path with the given custom path. + In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/
+' and can be overwritten here. Parameters
+-
+
-
+
servicePath: string
+++Path to override the default with
+
+
Returns GetByKeyRequestBuilderBase<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
url
+-
+
+
-
+
-
+
+ ++++
Create the url based on configuration of the given builder.
+Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++Destination to execute the request against
+
+ -
+
Optional options: (DestinationCachingOptions & ResilienceOptions) | (CachingOptions & ResilienceOptions)
+++Options to employ when fetching destinations.
+
+
Returns Promise<string>
+Promise resolving to the url for the request
+
+ -
+
withCustomHeaders
+ -
+
+
-
+
-
+
+ ++++ +
Add custom headers to the request.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs denoting additional custom headers
+
+
Returns GetByKeyRequestBuilderBase<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++ +
Add custom query parameters to the request.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs denoting additional custom query parameters to be set in the request
+
+
Returns GetByKeyRequestBuilderBase<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomServicePath
+ -
+
+
-
+
-
+
+ ++++ +
Replace the default service path with the given custom path. + In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/
+' and can be overwritten here. Parameters
+-
+
-
+
servicePath: string
+++Path to override the default with
+
+
Returns GetByKeyRequestBuilderBase<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
+
+
+
+
+ Class GetByKeyRequestBuilderV4<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.link.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.link.html
new file mode 100644
index 0000000000..88f0c8c8d7
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.link.html
@@ -0,0 +1,572 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ Readonly data
+
+
+
+
+
+ Readonly entity
+
+
+
+
+
+ request
+
+
+
+
+
+
+
+ add
+
+
+
+ add
+
+
+
+
+
+
+
+
+
+
+
+
+ relative
+
+
+
+
+
+
+ set
+
+
+
+
+
+
+ with
+
+
+
+ with
+
+
+
+ with
+
+
+
+
+
+
+
+
+ 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 expanded explicitly by GetAllRequestBuilderV4.expand. + where no selection is equal to selecting all fields.
+Type parameters
+-
+
-
+
EntityT: EntityV4
+++++Type of the entity to be requested
+
+
Hierarchy
+-
+
-
+ GetByKeyRequestBuilderBase<EntityT>
+
-
+
- + GetByKeyRequestBuilderV4 + +
+
Implements
+-
+
- EntityIdentifiable<EntityT> +
Index
+Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of GetByKeyRequestBuilder.
+Type parameters
+-
+
-
+
EntityT: EntityV4<EntityT>
+
+
Parameters
+-
+
-
+
_entityConstructor: Constructable<EntityT, unknown>
+++Constructor of the entity to create the request for
+
+ -
+
keys: Record<string, FieldType>
+++Key-value pairs where the key is the name of a key property of the given entity and the value is the respective value
+
+
Returns GetByKeyRequestBuilderV4<EntityT>
+
+ -
+
Properties
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ Readonly dataAccessor
+
+
+ Readonly entityDeserializer
+
+
+ requestConfig
+
+
+ Methods
+addCustomHeaders
+ -
+
+
-
+
-
+
+ ++++
Add custom headers to the request. Existing headers will be overwritten.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs denoting additional custom headers.
+
+
Returns GetByKeyRequestBuilderV4<EntityT>
+The request builder itself, to facilitate method chaining.
+
+ -
+
addCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++
Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs denoting additional custom query parameters to be set in the request
+
+
Returns GetByKeyRequestBuilderV4<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
build
+-
+
+
+
-
+
-
+
+
Returns ODataRequest<ODataGetByKeyRequestConfig<EntityT>>
+
+ -
+
+
Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+
+ -
+
Optional options: (DestinationCachingOptions & ResilienceOptions) | (CachingOptions & ResilienceOptions)
+
+
Returns Promise<ODataRequest<ODataGetByKeyRequestConfig<EntityT>>>
+
+ -
+
execute
+-
+
+
-
+
-
+
+ ++++
Execute request.
+Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++Destination to execute the request against
+
+ -
+
Optional options: (DestinationAccessorOptions & DestinationCachingOptions & ResilienceOptions & VerifyJwtOptions) | (DestinationAccessorOptions & CachingOptions & ResilienceOptions & VerifyJwtOptions)
+++Options to employ when fetching destinations
+
+
Returns Promise<EntityT>
+A promise resolving to the requested entity
+
+ -
+
expand
+-
+
+
+
-
+
-
+
+
Parameters
+-
+
-
+
expands: Expandable<EntityT>[]
+
+
Returns GetByKeyRequestBuilderV4<EntityT>
+
+ -
+
-
+
+
Parameters
+-
+
-
+
Rest ...expands: Expandable<EntityT>[]
+
+
Returns GetByKeyRequestBuilderV4<EntityT>
+
+ -
+
relativeUrl
+ -
+
+
-
+
-
+
+ ++++
Create the relative url based on configuration of the given builder.
+Returns string
+The relative url for the request
+
+
select
+-
+
+
+
-
+
-
+
+ ++++
Restrict the response to the given selection of properties in the request.
+Parameters
+-
+
-
+
Rest ...selects: Selectable<EntityT>[]
+++Fields to select in the request
+
+
Returns GetByKeyRequestBuilderV4<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
-
+
+
Parameters
+-
+
-
+
selects: Selectable<EntityT>[]
+
+
Returns GetByKeyRequestBuilderV4<EntityT>
+
+ -
+
setCustomServicePath
+ -
+
+
-
+
-
+
+ ++++
Replace the default service path with the given custom path. + In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/
+' and can be overwritten here. Parameters
+-
+
-
+
servicePath: string
+++Path to override the default with
+
+
Returns GetByKeyRequestBuilderV4<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
url
+-
+
+
-
+
-
+
+ ++++
Create the url based on configuration of the given builder.
+Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++Destination to execute the request against
+
+ -
+
Optional options: (DestinationCachingOptions & ResilienceOptions) | (CachingOptions & ResilienceOptions)
+++Options to employ when fetching destinations.
+
+
Returns Promise<string>
+Promise resolving to the url for the request
+
+ -
+
withCustomHeaders
+ -
+
+
-
+
-
+
+ ++++ +
Add custom headers to the request.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs denoting additional custom headers
+
+
Returns GetByKeyRequestBuilderV4<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++ +
Add custom query parameters to the request.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs denoting additional custom query parameters to be set in the request
+
+
Returns GetByKeyRequestBuilderV4<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomServicePath
+ -
+
+
-
+
-
+
+ ++++ +
Replace the default service path with the given custom path. + In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/
+' and can be overwritten here. Parameters
+-
+
-
+
servicePath: string
+++Path to override the default with
+
+
Returns GetByKeyRequestBuilderV4<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
+
+
+
+
+ Class Link<EntityT, LinkedEntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.methodrequestbuilder.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.methodrequestbuilder.html
new file mode 100644
index 0000000000..495849a7f4
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.methodrequestbuilder.html
@@ -0,0 +1,622 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+
+
+
+ Readonly _field
+
+
+
+
+
+ Readonly _linked
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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.
+ For example, when constructing a query on the BusinessPartner entity, an instance of Link<BusinessPartner, Customer>
+ can be passed as argument to the select function, e.g. BusinessPartner.TO_CUSTOMER.
NOTE: Due to historical development the Link and its extensions are used in the following way: + OData v2 entity: 1:N -> Link, 1:0..1 -> OneToOneLink + OData v4 entity: 1:N -> OneToManyLink, 1:0..1 -> OneToOneLink
+See also: Selectable
+Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity to be linked from
+
+ -
+
LinkedEntityT: EntityBase = any
+++++Type of the entity to be linked to
+
+
Hierarchy
+-
+
-
+ Link
+
-
+
- + OneToOneLink + +
- + OneToManyLink + +
+
Implements
+-
+
- EntityIdentifiable<EntityT> +
Index
+
+
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- _entity +
- _entity
Constructor
+ - _expand +
- _field
Name
+ - _linked
Entity
+ - _selects +
Accessors
+-
+
- selects +
Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of Link.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+ -
+
LinkedEntityT: EntityBase<LinkedEntityT> = any
+
+
Parameters
+-
+
-
+
_fieldName: string
+++Name of the linking field to be used in the OData request.
+
+ -
+
_entityConstructor: Constructable<EntityT, unknown>
+++Constructor type of the entity the field belongs to
+
+ -
+
_linkedEntity: Constructable<LinkedEntityT, unknown>
+++Constructor type of the linked entity
+
+
Returns Link<EntityT, LinkedEntityT>
+
+ -
+
Properties
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ _expand
+ + +Readonly _fieldName
+
+
+ Readonly _linkedEntity
+
+
+ _selects
+ + +
+
+
+
+ List of selectables on the linked entity.
+Accessors
+selects
+-
+
+
-
+
-
+
+ + ++
Returns Selectable<LinkedEntityT>[]
+
+
Methods
+clone
+-
+
+
-
+
-
+
+ ++++ +
Create a new link based on a given link.
+Returns Link<EntityT, LinkedEntityT>
+Newly created link
+
+
expand
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
Rest ...expands: Expandable<LinkedEntityT>[]
+
+
Returns Link<EntityT, LinkedEntityT>
+
+ -
+
select
+-
+
+
-
+
-
+
+ ++++
Creates a selection on a linked entity. Has the same behavior as GetAllRequestBuilderV2.select and GetByKeyRequestBuilderV4.select but for linked entities.
+See also, Selectable
+Parameters
+-
+
-
+
Rest ...selects: Selectable<LinkedEntityT>[]
+++Selection of fields or links on a linked entity
+
+
Returns Link<EntityT, LinkedEntityT>
+The link itself, to facilitate method chaining
+
+ -
+
Static clone
+-
+
+
-
+
-
+
+ + ++
Type parameters
+-
+
-
+
EntityT1: EntityBase<EntityT1>
+
+ -
+
LinkedEntityT1: EntityBase<LinkedEntityT1>
+
+
Parameters
+-
+
-
+
link: Link<EntityT1, LinkedEntityT1>
+++Link to be cloned
+
+
Returns Link<EntityT1, LinkedEntityT1>
+Newly created link
+
+ -
+
+
+
+
+
+ Class MethodRequestBuilder<RequestConfigT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.numberfield.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.numberfield.html
new file mode 100644
index 0000000000..f075597ef9
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.numberfield.html
@@ -0,0 +1,599 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ request
+
+
+
+
+
+
+
+ add
+
+
+
+ add
+
+
+
+
+
+
+ relative
+
+
+
+ set
+
+
+
+
+
+
+ with
+
+
+
+ with
+
+
+
+ with
+
+
+
+
+
+
+
+
+
+ Base class for all request builders.
+Type parameters
+-
+
-
+
RequestConfigT: ODataRequestConfig = any
+
+
Hierarchy
+-
+
-
+ MethodRequestBuilder
+
-
+
- + BatchRequestBuilder + +
- + CountRequestBuilder + +
- + ActionFunctionImportRequestBuilder + +
- + CreateRequestBuilderBase + +
- + DeleteRequestBuilderBase + +
- + UpdateRequestBuilderBase + +
+
Index
+Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of MethodRequestBuilder.
+Type parameters
+-
+
-
+
RequestConfigT: ODataRequestConfig<RequestConfigT> = any
+
+
Parameters
+-
+
-
+
requestConfig: RequestConfigT
+++Request configuration to initialize with
+
+
Returns MethodRequestBuilder<RequestConfigT>
+
+ -
+
Properties
+requestConfig
+
+
+ Methods
+addCustomHeaders
+ -
+
+
-
+
-
+
+ ++++
Add custom headers to the request. Existing headers will be overwritten.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs denoting additional custom headers.
+
+
Returns MethodRequestBuilder<RequestConfigT>
+The request builder itself, to facilitate method chaining.
+
+ -
+
addCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++
Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs denoting additional custom query parameters to be set in the request
+
+
Returns MethodRequestBuilder<RequestConfigT>
+The request builder itself, to facilitate method chaining
+
+ -
+
build
+-
+
+
+
-
+
-
+
+
Returns ODataRequest<RequestConfigT>
+
+ -
+
+
Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+
+ -
+
Optional options: (DestinationCachingOptions & ResilienceOptions) | (CachingOptions & ResilienceOptions)
+
+
Returns Promise<ODataRequest<RequestConfigT>>
+
+ -
+
relativeUrl
+ -
+
+
-
+
-
+
+ ++++
Create the relative url based on configuration of the given builder.
+Returns string
+The relative url for the request
+
+
setCustomServicePath
+ -
+
+
-
+
-
+
+ ++++
Replace the default service path with the given custom path. + In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/
+' and can be overwritten here. Parameters
+-
+
-
+
servicePath: string
+++Path to override the default with
+
+
Returns MethodRequestBuilder<RequestConfigT>
+The request builder itself, to facilitate method chaining
+
+ -
+
url
+-
+
+
-
+
-
+
+ ++++
Create the url based on configuration of the given builder.
+Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++Destination to execute the request against
+
+ -
+
Optional options: (DestinationCachingOptions & ResilienceOptions) | (CachingOptions & ResilienceOptions)
+++Options to employ when fetching destinations.
+
+
Returns Promise<string>
+Promise resolving to the url for the request
+
+ -
+
withCustomHeaders
+ -
+
+
-
+
-
+
+ ++++ +
Add custom headers to the request.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs denoting additional custom headers
+
+
Returns MethodRequestBuilder<RequestConfigT>
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++ +
Add custom query parameters to the request.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs denoting additional custom query parameters to be set in the request
+
+
Returns MethodRequestBuilder<RequestConfigT>
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomServicePath
+ -
+
+
-
+
-
+
+ ++++ +
Replace the default service path with the given custom path. + In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/
+' and can be overwritten here. Parameters
+-
+
-
+
servicePath: string
+++Path to override the default with
+
+
Returns MethodRequestBuilder<RequestConfigT>
+The request builder itself, to facilitate method chaining
+
+ -
+
+
+
+
+
+ Class NumberField<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.numberfieldbase.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.numberfieldbase.html
new file mode 100644
index 0000000000..eb4a1ae909
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.numberfieldbase.html
@@ -0,0 +1,582 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ Readonly _field
+
+
+
+
+
+ Readonly edm
+
+
+
+
+
+
+
+
+
+
+
+
+
+ field
+
+
+
+ greater
+
+
+
+ greater
+
+
+
+ less
+
+
+
+ less
+
+
+
+ not
+
+
+
+
+
+
+
+
+ Represents a selectable property with a number value.
+Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity the field belongs to
+
+
Hierarchy
+-
+
-
+ NumberFieldBase<EntityT>
+
-
+
- + NumberField + +
+
Implements
+ +Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- _entity +
- _entity
Constructor
+ - _field
Name
+ - edm
Type
+ - selectable +
Methods
+-
+
- equals +
- field
Path
+ - greater
OrEqual
+ - greater
Than
+ - less
OrEqual
+ - less
Than
+ - not
Equals
+
Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of EdmTypeField.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
fieldName: string
+++Actual name of the field used in the OData request
+
+ -
+
entityConstructor: Constructable<EntityT, unknown>
+++Constructor type of the entity the field belongs to
+
+ -
+
edmType: EdmTypeShared<VersionT>
+++Type of the field according to the metadata description
+
+
Returns NumberField<EntityT>
+
+ -
+
Properties
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ Readonly _fieldName
+
+
+ Readonly edmType
+
+
+ Readonly selectable
+ + +Methods
+equals
+-
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'eq', i.e.
+==.Parameters
+-
+
-
+
value: number
+++Value to be used in the filter
+
+
Returns Filter<EntityT, number>
+The resulting filter
+
+ -
+
fieldPath
+ -
+
+
-
+
-
+
+ ++++
Path to the field to be used in filter and order by queries. In most cases this will just be the _fieldName itself. However, for complex types for instance, the path is prefixed with the name of the complextype.
+Returns string
+Path to the field to be used in filter and order by queries.
+
+
greaterOrEqual
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'ge', i.e.
+>=.Parameters
+-
+
-
+
value: number
+++Value to be used in the filter
+
+
Returns Filter<EntityT, number>
+The resulting filter
+
+ -
+
greaterThan
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'gt', i.e.
+>.Parameters
+-
+
-
+
value: number
+++Value to be used in the filter
+
+
Returns Filter<EntityT, number>
+The resulting filter
+
+ -
+
lessOrEqual
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'le', i.e.
+<=.Parameters
+-
+
-
+
value: number
+++Value to be used in the filter
+
+
Returns Filter<EntityT, number>
+The resulting filter
+
+ -
+
lessThan
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'lt', i.e.
+<.Parameters
+-
+
-
+
value: number
+++Value to be used in the filter
+
+
Returns Filter<EntityT, number>
+The resulting filter
+
+ -
+
notEquals
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'ne', i.e.
+!=.Parameters
+-
+
-
+
value: number
+++Value to be used in the filter
+
+
Returns Filter<EntityT, number>
+The resulting filter
+
+ -
+
+
+
+
+
+ Class NumberFieldBase<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.numberfilterfunction.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.numberfilterfunction.html
new file mode 100644
index 0000000000..e54475e817
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.numberfilterfunction.html
@@ -0,0 +1,569 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ Readonly _field
+
+
+
+
+
+ Readonly edm
+
+
+
+
+
+
+
+
+
+
+ field
+
+
+
+ greater
+
+
+
+ greater
+
+
+
+ less
+
+
+
+ less
+
+
+
+ not
+
+
+
+
+
+
+
+
+ Represents a property with a number value.
+Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity the field belongs to
+
+
Hierarchy
+-
+
-
+ EdmTypeField<EntityT, number>
+
-
+
-
+ NumberFieldBase
+
-
+
- + NumberField + +
- + ComplexTypeNumberPropertyField + +
+
+ -
+ NumberFieldBase
+
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- _entity +
- _entity
Constructor
+ - _field
Name
+ - edm
Type
+
Methods
+-
+
- equals +
- field
Path
+ - greater
OrEqual
+ - greater
Than
+ - less
OrEqual
+ - less
Than
+ - not
Equals
+
Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of EdmTypeField.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
fieldName: string
+++Actual name of the field used in the OData request
+
+ -
+
entityConstructor: Constructable<EntityT, unknown>
+++Constructor type of the entity the field belongs to
+
+ -
+
edmType: EdmTypeShared<VersionT>
+++Type of the field according to the metadata description
+
+
Returns NumberFieldBase<EntityT>
+
+ -
+
Properties
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ Readonly _fieldName
+
+
+ Readonly edmType
+
+
+ Methods
+equals
+-
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'eq', i.e.
+==.Parameters
+-
+
-
+
value: number
+++Value to be used in the filter
+
+
Returns Filter<EntityT, number>
+The resulting filter
+
+ -
+
fieldPath
+ -
+
+
-
+
-
+
+ ++++
Path to the field to be used in filter and order by queries. In most cases this will just be the _fieldName itself. However, for complex types for instance, the path is prefixed with the name of the complextype.
+Returns string
+Path to the field to be used in filter and order by queries.
+
+
greaterOrEqual
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'ge', i.e.
+>=.Parameters
+-
+
-
+
value: number
+++Value to be used in the filter
+
+
Returns Filter<EntityT, number>
+The resulting filter
+
+ -
+
greaterThan
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'gt', i.e.
+>.Parameters
+-
+
-
+
value: number
+++Value to be used in the filter
+
+
Returns Filter<EntityT, number>
+The resulting filter
+
+ -
+
lessOrEqual
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'le', i.e.
+<=.Parameters
+-
+
-
+
value: number
+++Value to be used in the filter
+
+
Returns Filter<EntityT, number>
+The resulting filter
+
+ -
+
lessThan
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'lt', i.e.
+<.Parameters
+-
+
-
+
value: number
+++Value to be used in the filter
+
+
Returns Filter<EntityT, number>
+The resulting filter
+
+ -
+
notEquals
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'ne', i.e.
+!=.Parameters
+-
+
-
+
value: number
+++Value to be used in the filter
+
+
Returns Filter<EntityT, number>
+The resulting filter
+
+ -
+
+
+
+
+
+ Class NumberFilterFunction<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.odataactionimportrequestconfig.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.odataactionimportrequestconfig.html
new file mode 100644
index 0000000000..bc4fd71e40
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.odataactionimportrequestconfig.html
@@ -0,0 +1,587 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly edm
+
+
+
+
+
+ Readonly function
+
+
+
+
+
+
+
+
+
+
+
+
+
+ greater
+
+
+
+ greater
+
+
+
+ less
+
+
+
+ less
+
+
+
+ not
+
+
+
+ to
+
+
+
+
+
+
+
+
+ Representation of a filter function, that returns a value of type number. This supports int, double and decimal values.
+Type parameters
+-
+
-
+
EntityT: EntityBase
+
+
Hierarchy
+-
+
-
+ OrderableFilterFunction<EntityT, number>
+
-
+
- + NumberFilterFunction + +
+
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- edm
Type
+ - function
Name
+ - parameters +
Methods
+-
+
- equals +
- greater
OrEqual
+ - greater
Than
+ - less
OrEqual
+ - less
Than
+ - not
Equals
+ - to
String
+
Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of NumberFilterFunction.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
functionName: string
+++Name of the function that returns a numeric value
+
+ -
+
parameters: FilterFunctionParameterType<EntityT>[]
+++Representation of the parameters passed to the filter function
+
+ -
+
edmType: "Edm.Decimal" | "Edm.Double" | "Edm.Int32"
+++Type of the returned numeric value. This influences the formatting of the returned value.
+
+
Returns NumberFilterFunction<EntityT>
+
+ -
+
Properties
+Readonly edmType
+
+
+ Readonly functionName
+
+
+ Readonly parameters
+ + +Methods
+equals
+-
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this filter function and the given value using the operator 'eq', i.e.
+==.Parameters
+-
+
-
+
value: number
+++Value to be used in the filter
+
+
Returns Filter<EntityT, number>
+The resulting filter
+
+ -
+
greaterOrEqual
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this filter function and the given value using the operator 'ge', i.e.
+>=.Parameters
+-
+
-
+
value: number
+++Value to be used in the filter
+
+
Returns Filter<EntityT, number>
+The resulting filter
+
+ -
+
greaterThan
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this filter function and the given value using the operator 'gt', i.e.
+>.Parameters
+-
+
-
+
value: number
+++Value to be used in the filter
+
+
Returns Filter<EntityT, number>
+The resulting filter
+
+ -
+
lessOrEqual
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this filter function and the given value using the operator 'le', i.e.
+<=.Parameters
+-
+
-
+
value: number
+++Value to be used in the filter
+
+
Returns Filter<EntityT, number>
+The resulting filter
+
+ -
+
lessThan
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this filter function and the given value using the operator 'lt', i.e.
+<.Parameters
+-
+
-
+
value: number
+++Value to be used in the filter
+
+
Returns Filter<EntityT, number>
+The resulting filter
+
+ -
+
notEquals
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this filter function and the given value using the operator 'ne', i.e.
+!=.Parameters
+-
+
-
+
value: number
+++Value to be used in the filter
+
+
Returns Filter<EntityT, number>
+The resulting filter
+
+ -
+
toString
+ -
+
+
-
+
-
+
+ + ++
Parameters
+-
+
-
+
Optional parentFieldNames: string[]
+++Names of parents in case the function is part of a filter on a navigation property
+
+
Returns string
+The filter function as string
+
+ -
+
+
+
+
+
+ Class ODataActionImportRequestConfig<ParametersT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatabatchchangeset.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatabatchchangeset.html
new file mode 100644
index 0000000000..2722690d24
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatabatchchangeset.html
@@ -0,0 +1,312 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly action
+
+
+
+
+
+ custom
+
+
+
+
+
+ Readonly default
+
+
+
+
+
+ Readonly default
+
+
+
+
+
+
+
+
+
+
+
+
+
+ content
+
+
+
+ custom
+
+
+
+ custom
+
+
+
+
+
+ add
+
+
+
+ add
+
+
+
+ Protected prepend
+
+
+
+ query
+
+
+
+ resource
+
+
+
+
+ Type parameters
+-
+
-
+
ParametersT
+
+
Hierarchy
+-
+
-
+ ODataRequestConfig
+
-
+
- + ODataActionImportRequestConfig + +
+
Index
+Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of ODataActionImportRequestConfig.
+Type parameters
+-
+
-
+
ParametersT
+
+
Parameters
+-
+
-
+
defaultServicePath: string
+++Default path of the service
+
+ -
+
actionImportName: string
+++The name of the action import.
+
+ -
+
parameters: FunctionImportParameters<ParametersT>
+++Parameters of the action imports
+
+
Returns ODataActionImportRequestConfig<ParametersT>
+
+ -
+
Properties
+Readonly actionImportName
+
+
+ customServicePath
+
+
+ Readonly defaultHeaders
+
+
+ Readonly defaultServicePath
+
+
+ method
+ + +payload
+ + +Accessors
+contentType
+ -
+
+
-
+
-
+
+ + ++
Returns any
+
+
customHeaders
+ -
+
+
+
-
+
-
+
+
Returns Record<string, string>
+
+ -
+
+
Parameters
+-
+
-
+
headers: Record<string, string>
+
+
Returns any
+
+ -
+
customQueryParameters
+ -
+
+
+
-
+
-
+
+
Returns Record<string, string>
+
+ -
+
+
Parameters
+-
+
-
+
queryParameters: Record<string, string>
+
+
Returns any
+
+ -
+
Methods
+addCustomHeaders
+ -
+
+
-
+
-
+
+ ++++
Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs where the key is the name of a header property and the value is the respective value
+
+
Returns void
+
+ -
+
addCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++
Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs where the key is the name of a query parameter and the value is the respective value
+
+
Returns void
+
+ -
+
Protected prependDollarToQueryParameters
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
params: Record<string, any>
+
+
Returns Record<string, any>
+
+ -
+
queryParameters
+ -
+
+
-
+
-
+
+
Returns Record<string, any>
+
+
resourcePath
+ -
+
+
-
+
-
+
+
Returns string
+
+
+
+
+
+
+ Class ODataBatchChangeSet<RequestT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatabatchchangesetv4.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatabatchchangesetv4.html
new file mode 100644
index 0000000000..a5bf0eda53
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatabatchchangesetv4.html
@@ -0,0 +1,312 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ change
+
+
+
+
+
+
+
+ Type parameters
+-
+
-
+
RequestT: CreateRequestBuilder<Entity> | UpdateRequestBuilder<Entity> | DeleteRequestBuilder<Entity>
+
+
Hierarchy
+-
+
- + ODataBatchChangeSet + +
Implements
+-
+
- BatchChangeSet<RequestT> +
Index
+Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Create an instance of ODataBatchChangeSet.
+Type parameters
+-
+
-
+
RequestT: CreateRequestBuilder<Entity> | UpdateRequestBuilder<Entity> | DeleteRequestBuilder<Entity>
+
+
Parameters
+-
+
-
+
requests: RequestT[]
+++Requests to combine to one change set.
+
+ -
+
Optional boundary: string
+++Boundary used in the multipart request.
+
+
Returns ODataBatchChangeSet<RequestT>
+
+ -
+
Properties
+Readonly boundary
+ + +Readonly requests
+ + +Accessors
+changeSetId
+ -
+
+
-
+
-
+
+ + ++
Returns string
+
+
+
+
+
+
+ Class ODataBatchChangeSetV4<RequestT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatabatchconfig.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatabatchconfig.html
new file mode 100644
index 0000000000..d64be821e5
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatabatchconfig.html
@@ -0,0 +1,675 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ change
+
+
+
+
+
+
+
+ Type parameters
+-
+
-
+
RequestT: CreateRequestBuilderV4<EntityV4> | UpdateRequestBuilderV4<EntityV4> | DeleteRequestBuilderV4<EntityV4>
+
+
Hierarchy
+-
+
- + ODataBatchChangeSetV4 + +
Implements
+-
+
- BatchChangeSet<RequestT> +
Index
+Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Create an instance of ODataBatchChangeSet.
+Type parameters
+-
+
-
+
RequestT: CreateRequestBuilderV4<EntityV4> | UpdateRequestBuilderV4<EntityV4> | DeleteRequestBuilderV4<EntityV4>
+
+
Parameters
+-
+
-
+
requests: RequestT[]
+++Requests to combine to one change set.
+
+ -
+
Optional boundary: string
+++Boundary used in the multipart request.
+
+
Returns ODataBatchChangeSetV4<RequestT>
+
+ -
+
Properties
+Readonly boundary
+ + +Readonly requests
+ + +Accessors
+changeSetId
+ -
+
+
-
+
-
+
+ + ++
Returns string
+
+
+
+
+
+
+ Class ODataBatchConfig
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatabatchrequestbuilder.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatabatchrequestbuilder.html
new file mode 100644
index 0000000000..b7b7837841
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatabatchrequestbuilder.html
@@ -0,0 +1,732 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ custom
+
+
+
+
+
+ Readonly default
+
+
+
+
+
+ Readonly default
+
+
+
+
+
+
+
+
+
+
+
+ sub
+
+
+
+
+
+ Readonly Static content_
+
+
+
+
+
+
+
+ batch
+
+
+
+ content
+
+
+
+ custom
+
+
+
+ custom
+
+
+
+
+
+ add
+
+
+
+ add
+
+
+
+ Protected prepend
+
+
+
+ query
+
+
+
+ resource
+
+
+
+ with
+
+
+
+
+ Hierarchy
+-
+
-
+ ODataBatchRequestConfig
+
-
+
- + ODataBatchConfig + +
+
Index
+
+
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+ +Accessors
+-
+
- batch
Id
+ - content
Type
+ - custom
Headers
+ - custom
Query Parameters
+
Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+ + ++
Parameters
+-
+
-
+
defaultServicePath: string
+++The default OData service path
+
+ -
+
batchId: string
+++The batch id for building the header and the payload.
+
+
Returns ODataBatchConfig
+
+ -
+
Properties
+Readonly boundary
+ + +customServicePath
+
+
+ Readonly defaultHeaders
+
+
+ Readonly defaultServicePath
+
+
+ method
+ + +payload
+ + +subRequestPathType
+
+
+ Readonly Static content_type_prefix
+
+
+
+
+
+ Accessors
+batchId
+ -
+
+
-
+
-
+
+ + ++
Returns string
+
+
contentType
+ -
+
+
-
+
-
+
+ + ++
Returns any
+
+
customHeaders
+ -
+
+
+
-
+
-
+
+
Returns Record<string, string>
+
+ -
+
+
Parameters
+-
+
-
+
headers: Record<string, string>
+
+
Returns any
+
+ -
+
customQueryParameters
+ -
+
+
+
-
+
-
+
+
Returns Record<string, string>
+
+ -
+
+
Parameters
+-
+
-
+
queryParameters: Record<string, string>
+
+
Returns any
+
+ -
+
Methods
+addCustomHeaders
+ -
+
+
-
+
-
+
+ ++++
Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs where the key is the name of a header property and the value is the respective value
+
+
Returns void
+
+ -
+
addCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++
Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs where the key is the name of a query parameter and the value is the respective value
+
+
Returns void
+
+ -
+
Protected prependDollarToQueryParameters
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
params: Record<string, any>
+
+
Returns Record<string, any>
+
+ -
+
queryParameters
+ -
+
+
-
+
-
+
+
Returns Record<string, any>
+
+
resourcePath
+ -
+
+
-
+
-
+
+
Returns string
+
+
withSubRequestPathType
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
subRequestPathType: BatchSubRequestPathType
+
+
Returns void
+
+ -
+
+
+
+
+
+ Class ODataBatchRequestBuilder
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatabatchrequestbuilderv4.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatabatchrequestbuilderv4.html
new file mode 100644
index 0000000000..1c1460bf47
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatabatchrequestbuilderv4.html
@@ -0,0 +1,732 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly default
+
+
+
+
+
+ Readonly entity
+
+
+
+
+
+ request
+
+
+
+
+
+
+
+
+
+
+ add
+
+
+
+ add
+
+
+
+
+
+
+
+
+
+ relative
+
+
+
+ set
+
+
+
+
+
+
+ with
+
+
+
+ with
+
+
+
+ with
+
+
+
+ with
+
+
+
+
+
+
+
+
+ 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 excuted in order, while the order within a change set can vary.
+Hierarchy
+-
+
-
+ BatchRequestBuilder
+
-
+
- + ODataBatchRequestBuilder + +
+
Index
+Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of ODataBatchRequestBuilder.
+Parameters
+-
+
-
+
defaultServicePath: string
+++Service path
+
+ -
+
requests: (BatchChangeSet<any> | MethodRequestBuilder<any>)[]
+++An array of retrieve requests or change sets
+
+ -
+
entityToConstructorMap: Record<string, Constructable<EntityBase, unknown>>
+++A map that holds the entity type to constructor mapping
+
+
Returns ODataBatchRequestBuilder
+
+ -
+
Properties
+Readonly defaultServicePath
+
+
+ Readonly entityToConstructorMap
+
+
+ requestConfig
+
+
+ Readonly requests
+ + +Methods
+addCustomHeaders
+ -
+
+
-
+
-
+
+ ++++
Add custom headers to the request. Existing headers will be overwritten.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs denoting additional custom headers.
+
+
Returns ODataBatchRequestBuilder
+The request builder itself, to facilitate method chaining.
+
+ -
+
addCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++
Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs denoting additional custom query parameters to be set in the request
+
+
Returns ODataBatchRequestBuilder
+The request builder itself, to facilitate method chaining
+
+ -
+
build
+-
+
+
+
-
+
-
+
+
Returns ODataRequest<ODataBatchRequestConfig>
+
+ -
+
+
Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+
+ -
+
Optional options: (DestinationCachingOptions & ResilienceOptions) | (CachingOptions & ResilienceOptions)
+
+
Returns Promise<ODataRequest<ODataBatchRequestConfig>>
+
+ -
+
execute
+-
+
+
-
+
-
+
+ ++++
Execute the given request and return the according promise. Please notice: The sub-requests may fail even the main request is successful.
+Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++Targeted destination on which the request is performed.
+
+ -
+
Optional options: (DestinationAccessorOptions & DestinationCachingOptions & ResilienceOptions & VerifyJwtOptions) | (DestinationAccessorOptions & CachingOptions & ResilienceOptions & VerifyJwtOptions)
+++Options to employ when fetching destinations.
+
+
Returns Promise<BatchResponse[]>
+Promise resolving to the requested data.
+
+ -
+
relativeUrl
+ -
+
+
-
+
-
+
+ ++++
Create the relative url based on configuration of the given builder.
+Returns string
+The relative url for the request
+
+
setCustomServicePath
+ -
+
+
-
+
-
+
+ ++++
Replace the default service path with the given custom path. + In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/
+' and can be overwritten here. Parameters
+-
+
-
+
servicePath: string
+++Path to override the default with
+
+
Returns ODataBatchRequestBuilder
+The request builder itself, to facilitate method chaining
+
+ -
+
url
+-
+
+
-
+
-
+
+ ++++
Create the url based on configuration of the given builder.
+Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++Destination to execute the request against
+
+ -
+
Optional options: (DestinationCachingOptions & ResilienceOptions) | (CachingOptions & ResilienceOptions)
+++Options to employ when fetching destinations.
+
+
Returns Promise<string>
+Promise resolving to the url for the request
+
+ -
+
withCustomHeaders
+ -
+
+
-
+
-
+
+ ++++ +
Add custom headers to the request.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs denoting additional custom headers
+
+
Returns ODataBatchRequestBuilder
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++ +
Add custom query parameters to the request.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs denoting additional custom query parameters to be set in the request
+
+
Returns ODataBatchRequestBuilder
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomServicePath
+ -
+
+
-
+
-
+
+ ++++ +
Replace the default service path with the given custom path. + In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/
+' and can be overwritten here. Parameters
+-
+
-
+
servicePath: string
+++Path to override the default with
+
+
Returns ODataBatchRequestBuilder
+The request builder itself, to facilitate method chaining
+
+ -
+
withSubRequestPathType
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
subRequestPathType: BatchSubRequestPathType
+
+
Returns ODataBatchRequestBuilder
+
+ -
+
+
+
+
+
+ Class ODataBatchRequestBuilderV4
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatabatchrequestconfig.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatabatchrequestconfig.html
new file mode 100644
index 0000000000..7f63645f6f
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatabatchrequestconfig.html
@@ -0,0 +1,666 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly default
+
+
+
+
+
+ Readonly entity
+
+
+
+
+
+ request
+
+
+
+
+
+
+
+
+
+
+ add
+
+
+
+ add
+
+
+
+
+
+
+
+
+
+ relative
+
+
+
+ set
+
+
+
+
+
+
+ with
+
+
+
+ with
+
+
+
+ with
+
+
+
+ with
+
+
+
+
+
+
+
+
+ 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 excuted in order, while the order within a change set can vary.
+Hierarchy
+-
+
-
+ BatchRequestBuilder
+
-
+
- + ODataBatchRequestBuilderV4 + +
+
Index
+Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of ODataBatchRequestBuilder.
+Parameters
+-
+
-
+
defaultServicePath: string
+++Service path
+
+ -
+
requests: (BatchChangeSet<any> | MethodRequestBuilder<any>)[]
+++An array of retrieve requests or change sets
+
+ -
+
entityToConstructorMap: Record<string, Constructable<EntityBase, unknown>>
+++A map that holds the entity type to constructor mapping
+
+
Returns ODataBatchRequestBuilderV4
+
+ -
+
Properties
+Readonly defaultServicePath
+
+
+ Readonly entityToConstructorMap
+
+
+ requestConfig
+
+
+ Readonly requests
+ + +Methods
+addCustomHeaders
+ -
+
+
-
+
-
+
+ ++++
Add custom headers to the request. Existing headers will be overwritten.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs denoting additional custom headers.
+
+
Returns ODataBatchRequestBuilderV4
+The request builder itself, to facilitate method chaining.
+
+ -
+
addCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++
Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs denoting additional custom query parameters to be set in the request
+
+
Returns ODataBatchRequestBuilderV4
+The request builder itself, to facilitate method chaining
+
+ -
+
build
+-
+
+
+
-
+
-
+
+
Returns ODataRequest<ODataBatchRequestConfig>
+
+ -
+
+
Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+
+ -
+
Optional options: (DestinationCachingOptions & ResilienceOptions) | (CachingOptions & ResilienceOptions)
+
+
Returns Promise<ODataRequest<ODataBatchRequestConfig>>
+
+ -
+
execute
+-
+
+
-
+
-
+
+ ++++
Execute the given request and return the according promise. Please notice: The sub-requests may fail even the main request is successful.
+Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++Targeted destination on which the request is performed.
+
+ -
+
Optional options: (DestinationAccessorOptions & DestinationCachingOptions & ResilienceOptions & VerifyJwtOptions) | (DestinationAccessorOptions & CachingOptions & ResilienceOptions & VerifyJwtOptions)
+++Options to employ when fetching destinations.
+
+
Returns Promise<BatchResponse[]>
+Promise resolving to the requested data.
+
+ -
+
relativeUrl
+ -
+
+
-
+
-
+
+ ++++
Create the relative url based on configuration of the given builder.
+Returns string
+The relative url for the request
+
+
setCustomServicePath
+ -
+
+
-
+
-
+
+ ++++
Replace the default service path with the given custom path. + In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/
+' and can be overwritten here. Parameters
+-
+
-
+
servicePath: string
+++Path to override the default with
+
+
Returns ODataBatchRequestBuilderV4
+The request builder itself, to facilitate method chaining
+
+ -
+
url
+-
+
+
-
+
-
+
+ ++++
Create the url based on configuration of the given builder.
+Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++Destination to execute the request against
+
+ -
+
Optional options: (DestinationCachingOptions & ResilienceOptions) | (CachingOptions & ResilienceOptions)
+++Options to employ when fetching destinations.
+
+
Returns Promise<string>
+Promise resolving to the url for the request
+
+ -
+
withCustomHeaders
+ -
+
+
-
+
-
+
+ ++++ +
Add custom headers to the request.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs denoting additional custom headers
+
+
Returns ODataBatchRequestBuilderV4
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++ +
Add custom query parameters to the request.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs denoting additional custom query parameters to be set in the request
+
+
Returns ODataBatchRequestBuilderV4
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomServicePath
+ -
+
+
-
+
-
+
+ ++++ +
Replace the default service path with the given custom path. + In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/
+' and can be overwritten here. Parameters
+-
+
-
+
servicePath: string
+++Path to override the default with
+
+
Returns ODataBatchRequestBuilderV4
+The request builder itself, to facilitate method chaining
+
+ -
+
withSubRequestPathType
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
subRequestPathType: BatchSubRequestPathType
+
+
Returns ODataBatchRequestBuilderV4
+
+ -
+
+
+
+
+
+ Class ODataBatchRequestConfig
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatacreaterequestconfig.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatacreaterequestconfig.html
new file mode 100644
index 0000000000..0509ecca1a
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatacreaterequestconfig.html
@@ -0,0 +1,654 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ custom
+
+
+
+
+
+ Readonly default
+
+
+
+
+
+ Readonly default
+
+
+
+
+
+
+
+
+
+
+
+ sub
+
+
+
+
+
+ Readonly Static content_
+
+
+
+
+
+
+
+ batch
+
+
+
+ content
+
+
+
+ custom
+
+
+
+ custom
+
+
+
+
+
+ add
+
+
+
+ add
+
+
+
+ Protected prepend
+
+
+
+ query
+
+
+
+ resource
+
+
+
+ with
+
+
+
+
+ Hierarchy
+-
+
-
+ ODataRequestConfig
+
-
+
-
+ ODataBatchRequestConfig
+
-
+
- + ODataBatchConfig + +
+
+ -
+ ODataBatchRequestConfig
+
Index
+
+
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+ +Accessors
+-
+
- batch
Id
+ - content
Type
+ - custom
Headers
+ - custom
Query Parameters
+
Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of ODataBatchRequestConfig.
+Parameters
+-
+
-
+
defaultServicePath: string
+++The default OData service path
+
+ -
+
Optional boundary: string
+++Request boundary for separation of subrequests. Defaults to an autogenerated value.
+
+
Returns ODataBatchRequestConfig
+
+ -
+
Properties
+Readonly boundary
+ + +customServicePath
+
+
+ Readonly defaultHeaders
+
+
+ Readonly defaultServicePath
+
+
+ method
+ + +payload
+ + +subRequestPathType
+
+
+ Readonly Static content_type_prefix
+
+
+
+
+
+ Accessors
+batchId
+ -
+
+
-
+
-
+
+ + ++
Returns string
+
+
contentType
+ -
+
+
-
+
-
+
+ + ++
Returns any
+
+
customHeaders
+ -
+
+
+
-
+
-
+
+
Returns Record<string, string>
+
+ -
+
+
Parameters
+-
+
-
+
headers: Record<string, string>
+
+
Returns any
+
+ -
+
customQueryParameters
+ -
+
+
+
-
+
-
+
+
Returns Record<string, string>
+
+ -
+
+
Parameters
+-
+
-
+
queryParameters: Record<string, string>
+
+
Returns any
+
+ -
+
Methods
+addCustomHeaders
+ -
+
+
-
+
-
+
+ ++++
Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs where the key is the name of a header property and the value is the respective value
+
+
Returns void
+
+ -
+
addCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++
Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs where the key is the name of a query parameter and the value is the respective value
+
+
Returns void
+
+ -
+
Protected prependDollarToQueryParameters
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
params: Record<string, any>
+
+
Returns Record<string, any>
+
+ -
+
queryParameters
+ -
+
+
-
+
-
+
+
Returns Record<string, any>
+
+
resourcePath
+ -
+
+
-
+
-
+
+
Returns string
+
+
withSubRequestPathType
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
subRequestPathType: BatchSubRequestPathType
+
+
Returns void
+
+ -
+
+
+
+
+
+ Class ODataCreateRequestConfig<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatacreaterequestconfiglegacy.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatacreaterequestconfiglegacy.html
new file mode 100644
index 0000000000..3665fbcd71
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatacreaterequestconfiglegacy.html
@@ -0,0 +1,663 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ child
+
+
+
+
+
+ custom
+
+
+
+
+
+ Readonly default
+
+
+
+
+
+ Readonly default
+
+
+
+
+
+
+
+
+ parent
+
+
+
+
+
+
+
+
+
+
+ content
+
+
+
+ custom
+
+
+
+ custom
+
+
+
+
+
+ add
+
+
+
+ add
+
+
+
+ Protected prepend
+
+
+
+ query
+
+
+
+ resource
+
+
+
+ Protected resource
+
+
+
+
+
+
+
+
+ OData create request configuration for an entity type.
+Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity to setup a request for
+
+
Hierarchy
+-
+
-
+ ODataRequestConfig
+
-
+
-
+ ODataCreateRequestConfig
+
-
+
- + ODataCreateRequestConfigLegacy + +
+
+ -
+ ODataCreateRequestConfig
+
Index
+
+
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- _entity
Constructor
+ - child
Field
+ - custom
Service Path
+ - default
Headers
+ - default
Service Path
+ - method +
- parent
Keys
+ - payload +
Accessors
+ +Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of ODataRequest.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
_entityConstructor: Constructable<EntityT, unknown>
+++Constructor type of the entity to create a configuration for
+
+ -
+
oDataUri: ODataUri
+
+
Returns ODataCreateRequestConfig<EntityT>
+
+ -
+
Properties
+Readonly _entityConstructor
+
+
+ childField
+
+
+
+
+
+
+ Field that links the parent entity class to the child entity class.
+customServicePath
+
+
+ Readonly defaultHeaders
+
+
+ Readonly defaultServicePath
+
+
+ method
+ + +parentKeys
+
+
+
+
+
+
+ Keys of the parent of the entity to create. Defined only when attempting to create child entities.
+payload
+ + +Accessors
+contentType
+ -
+
+
-
+
-
+
+ + ++
Returns any
+
+
customHeaders
+ -
+
+
+
-
+
-
+
+
Returns Record<string, string>
+
+ -
+
+
Parameters
+-
+
-
+
headers: Record<string, string>
+
+
Returns any
+
+ -
+
customQueryParameters
+ -
+
+
+
-
+
-
+
+
Returns Record<string, string>
+
+ -
+
+
Parameters
+-
+
-
+
queryParameters: Record<string, string>
+
+
Returns any
+
+ -
+
Methods
+addCustomHeaders
+ -
+
+
-
+
-
+
+ ++++
Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs where the key is the name of a header property and the value is the respective value
+
+
Returns void
+
+ -
+
addCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++
Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs where the key is the name of a query parameter and the value is the respective value
+
+
Returns void
+
+ -
+
Protected prependDollarToQueryParameters
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
params: Record<string, any>
+
+
Returns Record<string, any>
+
+ -
+
queryParameters
+ -
+
+
-
+
-
+
+
Returns Record<string, any>
+
+
resourcePath
+ -
+
+
-
+
-
+
+
Returns string
+
+
Protected resourcePathAsChild
+ -
+
+
-
+
-
+
+
Returns string
+
+
+
+
+
+
+ Class ODataCreateRequestConfigLegacy<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatadeleterequestconfig.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatadeleterequestconfig.html
new file mode 100644
index 0000000000..3480ebe7a3
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatadeleterequestconfig.html
@@ -0,0 +1,644 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ child
+
+
+
+
+
+ custom
+
+
+
+
+
+ Readonly default
+
+
+
+
+
+ Readonly default
+
+
+
+
+
+
+
+
+ parent
+
+
+
+
+
+
+
+
+
+
+ content
+
+
+
+ custom
+
+
+
+ custom
+
+
+
+
+
+ add
+
+
+
+ add
+
+
+
+ Protected prepend
+
+
+
+ query
+
+
+
+ resource
+
+
+
+ Protected resource
+
+
+
+
+
+
+
+ Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity to setup a request for
+
+
Hierarchy
+-
+
-
+ ODataCreateRequestConfig<EntityT>
+
-
+
- + ODataCreateRequestConfigLegacy + +
+
Index
+
+
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- _entity
Constructor
+ - child
Field
+ - custom
Service Path
+ - default
Headers
+ - default
Service Path
+ - method +
- parent
Keys
+ - payload +
Accessors
+ +Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of ODataRequest.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
_entityConstructor: Constructable<EntityT, unknown>
+++Constructor type of the entity to create a configuration for
+
+
Returns ODataCreateRequestConfigLegacy<EntityT>
+
+ -
+
Properties
+Readonly _entityConstructor
+
+
+ childField
+
+
+
+
+
+
+ Field that links the parent entity class to the child entity class.
+customServicePath
+
+
+ Readonly defaultHeaders
+
+
+ Readonly defaultServicePath
+
+
+ method
+ + +parentKeys
+
+
+
+
+
+
+ Keys of the parent of the entity to create. Defined only when attempting to create child entities.
+payload
+ + +Accessors
+contentType
+ -
+
+
-
+
-
+
+ + ++
Returns any
+
+
customHeaders
+ -
+
+
+
-
+
-
+
+
Returns Record<string, string>
+
+ -
+
+
Parameters
+-
+
-
+
headers: Record<string, string>
+
+
Returns any
+
+ -
+
customQueryParameters
+ -
+
+
+
-
+
-
+
+
Returns Record<string, string>
+
+ -
+
+
Parameters
+-
+
-
+
queryParameters: Record<string, string>
+
+
Returns any
+
+ -
+
Methods
+addCustomHeaders
+ -
+
+
-
+
-
+
+ ++++
Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs where the key is the name of a header property and the value is the respective value
+
+
Returns void
+
+ -
+
addCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++
Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs where the key is the name of a query parameter and the value is the respective value
+
+
Returns void
+
+ -
+
Protected prependDollarToQueryParameters
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
params: Record<string, any>
+
+
Returns Record<string, any>
+
+ -
+
queryParameters
+ -
+
+
-
+
-
+
+
Returns Record<string, any>
+
+
resourcePath
+ -
+
+
-
+
-
+
+
Returns string
+
+
Protected resourcePathAsChild
+ -
+
+
-
+
-
+
+
Returns string
+
+
+
+
+
+
+ Class ODataDeleteRequestConfig<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatadeleterequestconfiglegacy.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatadeleterequestconfiglegacy.html
new file mode 100644
index 0000000000..5cbdf7b83d
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatadeleterequestconfiglegacy.html
@@ -0,0 +1,646 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ custom
+
+
+
+
+
+ Readonly default
+
+
+
+
+
+ Readonly default
+
+
+
+
+
+ e
+
+
+
+
+
+ Readonly entity
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ version
+
+
+
+
+
+
+
+ content
+
+
+
+ custom
+
+
+
+ custom
+
+
+
+
+
+ add
+
+
+
+ add
+
+
+
+ Protected prepend
+
+
+
+ query
+
+
+
+ resource
+
+
+
+
+
+
+
+
+ OData delete request configuration for an entity type.
+Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity to setup a request for
+
+
Hierarchy
+-
+
-
+ ODataRequestConfig
+
-
+
-
+ ODataDeleteRequestConfig
+
-
+
- + ODataDeleteRequestConfigLegacy + +
+
+ -
+ ODataDeleteRequestConfig
+
Implements
+-
+
- WithKeys +
- WithETag +
Index
+
+
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- custom
Service Path
+ - default
Headers
+ - default
Service Path
+ - e
Tag
+ - entity
Constructor
+ - keys +
- method +
- payload +
- version
Identifier Ignored
+
Accessors
+ +Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of ODataDeleteRequestConfig.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
entityConstructor: Constructable<EntityT, unknown>
+++Constructor type of the entity to create a configuration for
+
+ -
+
oDataUri: ODataUri
+
+
Returns ODataDeleteRequestConfig<EntityT>
+
+ -
+
Properties
+customServicePath
+
+
+ Readonly defaultHeaders
+
+
+ Readonly defaultServicePath
+
+
+ eTag
+
+
+ Readonly entityConstructor
+
+
+ keys
+ + +method
+ + +payload
+ + +versionIdentifierIgnored
+
+
+ Accessors
+contentType
+ -
+
+
-
+
-
+
+ + ++
Returns any
+
+
customHeaders
+ -
+
+
+
-
+
-
+
+
Returns Record<string, string>
+
+ -
+
+
Parameters
+-
+
-
+
headers: Record<string, string>
+
+
Returns any
+
+ -
+
customQueryParameters
+ -
+
+
+
-
+
-
+
+
Returns Record<string, string>
+
+ -
+
+
Parameters
+-
+
-
+
queryParameters: Record<string, string>
+
+
Returns any
+
+ -
+
Methods
+addCustomHeaders
+ -
+
+
-
+
-
+
+ ++++
Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs where the key is the name of a header property and the value is the respective value
+
+
Returns void
+
+ -
+
addCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++
Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs where the key is the name of a query parameter and the value is the respective value
+
+
Returns void
+
+ -
+
Protected prependDollarToQueryParameters
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
params: Record<string, any>
+
+
Returns Record<string, any>
+
+ -
+
queryParameters
+ -
+
+
-
+
-
+
+
Returns Record<string, any>
+
+
resourcePath
+ -
+
+
-
+
-
+
+
Returns string
+
+
+
+
+
+
+ Class ODataDeleteRequestConfigLegacy<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatafunctionimportrequestconfig.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatafunctionimportrequestconfig.html
new file mode 100644
index 0000000000..4faec31fa7
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatafunctionimportrequestconfig.html
@@ -0,0 +1,633 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ custom
+
+
+
+
+
+ Readonly default
+
+
+
+
+
+ Readonly default
+
+
+
+
+
+ e
+
+
+
+
+
+ Readonly entity
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ version
+
+
+
+
+
+
+
+ content
+
+
+
+ custom
+
+
+
+ custom
+
+
+
+
+
+ add
+
+
+
+ add
+
+
+
+ Protected prepend
+
+
+
+ query
+
+
+
+ resource
+
+
+
+
+
+
+
+ Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity to setup a request for
+
+
Hierarchy
+-
+
-
+ ODataDeleteRequestConfig<EntityT>
+
-
+
- + ODataDeleteRequestConfigLegacy + +
+
Index
+
+
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- custom
Service Path
+ - default
Headers
+ - default
Service Path
+ - e
Tag
+ - entity
Constructor
+ - keys +
- method +
- payload +
- version
Identifier Ignored
+
Accessors
+ +Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of ODataRequest.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
_entityConstructor: Constructable<EntityT, unknown>
+++Constructor type of the entity to create a configuration for
+
+
Returns ODataDeleteRequestConfigLegacy<EntityT>
+
+ -
+
Properties
+customServicePath
+
+
+ Readonly defaultHeaders
+
+
+ Readonly defaultServicePath
+
+
+ eTag
+
+
+ Readonly entityConstructor
+
+
+ keys
+ + +method
+ + +payload
+ + +versionIdentifierIgnored
+
+
+ Accessors
+contentType
+ -
+
+
-
+
-
+
+ + ++
Returns any
+
+
customHeaders
+ -
+
+
+
-
+
-
+
+
Returns Record<string, string>
+
+ -
+
+
Parameters
+-
+
-
+
headers: Record<string, string>
+
+
Returns any
+
+ -
+
customQueryParameters
+ -
+
+
+
-
+
-
+
+
Returns Record<string, string>
+
+ -
+
+
Parameters
+-
+
-
+
queryParameters: Record<string, string>
+
+
Returns any
+
+ -
+
Methods
+addCustomHeaders
+ -
+
+
-
+
-
+
+ ++++
Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs where the key is the name of a header property and the value is the respective value
+
+
Returns void
+
+ -
+
addCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++
Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs where the key is the name of a query parameter and the value is the respective value
+
+
Returns void
+
+ -
+
Protected prependDollarToQueryParameters
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
params: Record<string, any>
+
+
Returns Record<string, any>
+
+ -
+
queryParameters
+ -
+
+
-
+
-
+
+
Returns Record<string, any>
+
+
resourcePath
+ -
+
+
-
+
-
+
+
Returns string
+
+
+
+
+
+
+ Class ODataFunctionImportRequestConfig<ParametersT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatafunctionimportrequestconfiglegacy.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatafunctionimportrequestconfiglegacy.html
new file mode 100644
index 0000000000..73a41122de
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatafunctionimportrequestconfiglegacy.html
@@ -0,0 +1,649 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ custom
+
+
+
+
+
+ Readonly default
+
+
+
+
+
+ Readonly default
+
+
+
+
+
+ Readonly function
+
+
+
+
+
+
+
+
+ Protected o
+
+
+
+
+
+
+
+
+
+
+
+
+
+ content
+
+
+
+ custom
+
+
+
+ custom
+
+
+
+
+
+ add
+
+
+
+ add
+
+
+
+ Protected prepend
+
+
+
+ query
+
+
+
+ resource
+
+
+
+
+ Type parameters
+-
+
-
+
ParametersT
+
+
Hierarchy
+-
+
-
+ ODataFunctionImportRequestConfigBase<ParametersT>
+
-
+
- + ODataFunctionImportRequestConfig + + +
+
Index
+
+
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- custom
Service Path
+ - default
Headers
+ - default
Service Path
+ - function
Import Name
+ - method +
- o
Data Uri
+ - parameters +
- payload +
Accessors
+ +Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of ODataFunctionImportRequestConfig.
+Type parameters
+-
+
-
+
ParametersT
+
+
Parameters
+-
+
-
+
method: RequestMethodType
+++HTTP method for the request
+
+ -
+
defaultServicePath: string
+++Default path of the service
+
+ -
+
functionImportName: string
+++The name of the function import.
+
+ -
+
parameters: FunctionImportParameters<ParametersT>
+++Object containing the parameters with a value and additional meta information
+
+ -
+
oDataUri: ODataUri
+++ODataUri conversion interface at runtime either v2 or v4
+
+
Returns ODataFunctionImportRequestConfig<ParametersT>
+
+ -
+
Properties
+customServicePath
+
+
+ Readonly defaultHeaders
+
+
+ Readonly defaultServicePath
+
+
+ Readonly functionImportName
+
+
+ method
+ + +Protected oDataUri
+
+
+ parameters
+ + +payload
+ + +Accessors
+contentType
+ -
+
+
-
+
-
+
+ + ++
Returns any
+
+
customHeaders
+ -
+
+
+
-
+
-
+
+
Returns Record<string, string>
+
+ -
+
+
Parameters
+-
+
-
+
headers: Record<string, string>
+
+
Returns any
+
+ -
+
customQueryParameters
+ -
+
+
+
-
+
-
+
+
Returns Record<string, string>
+
+ -
+
+
Parameters
+-
+
-
+
queryParameters: Record<string, string>
+
+
Returns any
+
+ -
+
Methods
+addCustomHeaders
+ -
+
+
-
+
-
+
+ ++++
Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs where the key is the name of a header property and the value is the respective value
+
+
Returns void
+
+ -
+
addCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++
Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs where the key is the name of a query parameter and the value is the respective value
+
+
Returns void
+
+ -
+
Protected prependDollarToQueryParameters
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
params: Record<string, any>
+
+
Returns Record<string, any>
+
+ -
+
queryParameters
+ -
+
+
-
+
-
+
+
Returns Record<string, any>
+
+
resourcePath
+ -
+
+
-
+
-
+
+
Returns string
+
+
+
+
+
+
+ Class ODataFunctionImportRequestConfigLegacy<ParametersT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatafunctionimportrequestconfigv4.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatafunctionimportrequestconfigv4.html
new file mode 100644
index 0000000000..f25581f724
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatafunctionimportrequestconfigv4.html
@@ -0,0 +1,628 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ custom
+
+
+
+
+
+ Readonly default
+
+
+
+
+
+ Readonly default
+
+
+
+
+
+ Readonly function
+
+
+
+
+
+
+
+
+ Protected o
+
+
+
+
+
+
+
+
+
+
+
+
+
+ content
+
+
+
+ custom
+
+
+
+ custom
+
+
+
+
+
+ add
+
+
+
+ add
+
+
+
+ Protected prepend
+
+
+
+ query
+
+
+
+ resource
+
+
+
+
+
+
+
+ Type parameters
+-
+
-
+
ParametersT
+++++Type of the original parameters object
+
+
Hierarchy
+-
+
-
+ ODataFunctionImportRequestConfig<ParametersT>
+
-
+
- + ODataFunctionImportRequestConfigLegacy + +
+
Index
+
+
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- custom
Service Path
+ - default
Headers
+ - default
Service Path
+ - function
Import Name
+ - method +
- o
Data Uri
+ - parameters +
- payload +
Accessors
+ +Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of ODataFunctionImportRequestConfig.
+Type parameters
+-
+
-
+
ParametersT
+
+
Parameters
+-
+
-
+
method: RequestMethodType
+++HTTP method for the request
+
+ -
+
defaultServicePath: string
+++Default path of the service
+
+ -
+
functionImportName: string
+++The name of the function import.
+
+ -
+
parameters: FunctionImportParameters<ParametersT>
+++Object containing the parameters with a value and additional meta information
+
+
Returns ODataFunctionImportRequestConfigLegacy<ParametersT>
+
+ -
+
Properties
+customServicePath
+
+
+ Readonly defaultHeaders
+
+
+ Readonly defaultServicePath
+
+
+ Readonly functionImportName
+
+
+ method
+ + +Protected oDataUri
+
+
+ parameters
+ + +payload
+ + +Accessors
+contentType
+ -
+
+
-
+
-
+
+ + ++
Returns any
+
+
customHeaders
+ -
+
+
+
-
+
-
+
+
Returns Record<string, string>
+
+ -
+
+
Parameters
+-
+
-
+
headers: Record<string, string>
+
+
Returns any
+
+ -
+
customQueryParameters
+ -
+
+
+
-
+
-
+
+
Returns Record<string, string>
+
+ -
+
+
Parameters
+-
+
-
+
queryParameters: Record<string, string>
+
+
Returns any
+
+ -
+
Methods
+addCustomHeaders
+ -
+
+
-
+
-
+
+ ++++
Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs where the key is the name of a header property and the value is the respective value
+
+
Returns void
+
+ -
+
addCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++
Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs where the key is the name of a query parameter and the value is the respective value
+
+
Returns void
+
+ -
+
Protected prependDollarToQueryParameters
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
params: Record<string, any>
+
+
Returns Record<string, any>
+
+ -
+
queryParameters
+ -
+
+
-
+
-
+
+
Returns Record<string, any>
+
+
resourcePath
+ -
+
+
-
+
-
+
+
Returns string
+
+
+
+
+
+
+ Class ODataFunctionImportRequestConfigV4<ParametersT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatagetallrequestconfig.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatagetallrequestconfig.html
new file mode 100644
index 0000000000..a7b772f503
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatagetallrequestconfig.html
@@ -0,0 +1,685 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ custom
+
+
+
+
+
+ Readonly default
+
+
+
+
+
+ Readonly default
+
+
+
+
+
+ Readonly function
+
+
+
+
+
+
+
+
+ Protected o
+
+
+
+
+
+
+
+
+
+
+
+
+
+ content
+
+
+
+ custom
+
+
+
+ custom
+
+
+
+
+
+ add
+
+
+
+ add
+
+
+
+ Protected prepend
+
+
+
+ query
+
+
+
+ resource
+
+
+
+
+ Type parameters
+-
+
-
+
ParametersT
+
+
Hierarchy
+-
+
-
+ ODataFunctionImportRequestConfigBase<ParametersT>
+
-
+
- + ODataFunctionImportRequestConfigV4 + +
+
Index
+
+
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- custom
Service Path
+ - default
Headers
+ - default
Service Path
+ - function
Import Name
+ - method +
- o
Data Uri
+ - parameters +
- payload +
Accessors
+ +Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of ODataFunctionImportRequestConfig.
+Type parameters
+-
+
-
+
ParametersT
+
+
Parameters
+-
+
-
+
method: RequestMethodType
+++HTTP method for the request
+
+ -
+
defaultServicePath: string
+++Default path of the service
+
+ -
+
functionImportName: string
+++The name of the function import.
+
+ -
+
parameters: FunctionImportParameters<ParametersT>
+++Object containing the parameters with a value and additional meta information
+
+ -
+
oDataUri: ODataUri
+++ODataUri conversion interface at runtime either v2 or v4
+
+
Returns ODataFunctionImportRequestConfigV4<ParametersT>
+
+ -
+
Properties
+customServicePath
+
+
+ Readonly defaultHeaders
+
+
+ Readonly defaultServicePath
+
+
+ Readonly functionImportName
+
+
+ method
+ + +Protected oDataUri
+
+
+ parameters
+ + +payload
+ + +Accessors
+contentType
+ -
+
+
-
+
-
+
+ + ++
Returns any
+
+
customHeaders
+ -
+
+
+
-
+
-
+
+
Returns Record<string, string>
+
+ -
+
+
Parameters
+-
+
-
+
headers: Record<string, string>
+
+
Returns any
+
+ -
+
customQueryParameters
+ -
+
+
+
-
+
-
+
+
Returns Record<string, string>
+
+ -
+
+
Parameters
+-
+
-
+
queryParameters: Record<string, string>
+
+
Returns any
+
+ -
+
Methods
+addCustomHeaders
+ -
+
+
-
+
-
+
+ ++++
Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs where the key is the name of a header property and the value is the respective value
+
+
Returns void
+
+ -
+
addCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++
Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs where the key is the name of a query parameter and the value is the respective value
+
+
Returns void
+
+ -
+
Protected prependDollarToQueryParameters
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
params: Record<string, any>
+
+
Returns Record<string, any>
+
+ -
+
queryParameters
+ -
+
+
-
+
-
+
+
Returns Record<string, any>
+
+
resourcePath
+ -
+
+
-
+
-
+
+
Returns string
+
+
+
+
+
+
+ Class ODataGetAllRequestConfig<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatagetallrequestconfiglegacy.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatagetallrequestconfiglegacy.html
new file mode 100644
index 0000000000..27a973cd28
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatagetallrequestconfiglegacy.html
@@ -0,0 +1,691 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ custom
+
+
+
+
+
+ Readonly default
+
+
+
+
+
+ Readonly default
+
+
+
+
+
+ Readonly entity
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ order
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ content
+
+
+
+ custom
+
+
+
+ custom
+
+
+
+
+
+ add
+
+
+
+ add
+
+
+
+ Protected prepend
+
+
+
+ query
+
+
+
+ resource
+
+
+
+
+
+
+
+
+ OData getAll request configuration for an entity type.
+Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity to setup a request for
+
+
Hierarchy
+-
+
-
+ ODataRequestConfig
+
-
+
-
+ ODataGetAllRequestConfig
+
-
+
- + ODataGetAllRequestConfigLegacy + +
+
+ -
+ ODataGetAllRequestConfig
+
Implements
+-
+
- WithGetAllRestrictions<EntityT> +
Index
+
+
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- custom
Service Path
+ - default
Headers
+ - default
Service Path
+ - entity
Constructor
+ - expands +
- filter +
- method +
- order
By
+ - payload +
- selects +
- skip +
- top +
Accessors
+ +Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of ODataGetAllRequestConfig.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
entityConstructor: Constructable<EntityT, unknown>
+++Constructor type of the entity to create a configuration for
+
+ -
+
oDataUri: ODataUri
+
+
Returns ODataGetAllRequestConfig<EntityT>
+
+ -
+
Properties
+customServicePath
+
+
+ Readonly defaultHeaders
+
+
+ Readonly defaultServicePath
+
+
+ Readonly entityConstructor
+
+
+ expands
+ + +filter
+ + +method
+ + +orderBy
+
+
+ payload
+ + +selects
+ + +skip
+ + +top
+ + +Accessors
+contentType
+ -
+
+
-
+
-
+
+ + ++
Returns any
+
+
customHeaders
+ -
+
+
+
-
+
-
+
+
Returns Record<string, string>
+
+ -
+
+
Parameters
+-
+
-
+
headers: Record<string, string>
+
+
Returns any
+
+ -
+
customQueryParameters
+ -
+
+
+
-
+
-
+
+
Returns Record<string, string>
+
+ -
+
+
Parameters
+-
+
-
+
queryParameters: Record<string, string>
+
+
Returns any
+
+ -
+
Methods
+addCustomHeaders
+ -
+
+
-
+
-
+
+ ++++
Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs where the key is the name of a header property and the value is the respective value
+
+
Returns void
+
+ -
+
addCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++
Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs where the key is the name of a query parameter and the value is the respective value
+
+
Returns void
+
+ -
+
Protected prependDollarToQueryParameters
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
params: Record<string, any>
+
+
Returns Record<string, any>
+
+ -
+
queryParameters
+ -
+
+
-
+
-
+
+
Returns Record<string, any>
+
+
resourcePath
+ -
+
+
-
+
-
+
+
Returns string
+
+
+
+
+
+
+ Class ODataGetAllRequestConfigLegacy<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatagetbykeyrequestconfig.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatagetbykeyrequestconfig.html
new file mode 100644
index 0000000000..20a1b77309
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatagetbykeyrequestconfig.html
@@ -0,0 +1,644 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ custom
+
+
+
+
+
+ Readonly default
+
+
+
+
+
+ Readonly default
+
+
+
+
+
+ Readonly entity
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ order
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ content
+
+
+
+ custom
+
+
+
+ custom
+
+
+
+
+
+ add
+
+
+
+ add
+
+
+
+ Protected prepend
+
+
+
+ query
+
+
+
+ resource
+
+
+
+
+
+
+
+ Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity to setup a request for
+
+
Hierarchy
+-
+
-
+ ODataGetAllRequestConfig<EntityT>
+
-
+
- + ODataGetAllRequestConfigLegacy + +
+
Index
+
+
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- custom
Service Path
+ - default
Headers
+ - default
Service Path
+ - entity
Constructor
+ - expands +
- filter +
- method +
- order
By
+ - payload +
- selects +
- skip +
- top +
Accessors
+ +Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of ODataGetAllRequestConfig.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
_entityConstructor: Constructable<EntityT, unknown>
+++Constructor type of the entity to create a configuration for
+
+
Returns ODataGetAllRequestConfigLegacy<EntityT>
+
+ -
+
Properties
+customServicePath
+
+
+ Readonly defaultHeaders
+
+
+ Readonly defaultServicePath
+
+
+ Readonly entityConstructor
+
+
+ expands
+ + +filter
+ + +method
+ + +orderBy
+
+
+ payload
+ + +selects
+ + +skip
+ + +top
+ + +Accessors
+contentType
+ -
+
+
-
+
-
+
+ + ++
Returns any
+
+
customHeaders
+ -
+
+
+
-
+
-
+
+
Returns Record<string, string>
+
+ -
+
+
Parameters
+-
+
-
+
headers: Record<string, string>
+
+
Returns any
+
+ -
+
customQueryParameters
+ -
+
+
+
-
+
-
+
+
Returns Record<string, string>
+
+ -
+
+
Parameters
+-
+
-
+
queryParameters: Record<string, string>
+
+
Returns any
+
+ -
+
Methods
+addCustomHeaders
+ -
+
+
-
+
-
+
+ ++++
Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs where the key is the name of a header property and the value is the respective value
+
+
Returns void
+
+ -
+
addCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++
Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs where the key is the name of a query parameter and the value is the respective value
+
+
Returns void
+
+ -
+
Protected prependDollarToQueryParameters
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
params: Record<string, any>
+
+
Returns Record<string, any>
+
+ -
+
queryParameters
+ -
+
+
-
+
-
+
+
Returns Record<string, any>
+
+
resourcePath
+ -
+
+
-
+
-
+
+
Returns string
+
+
+
+
+
+
+ Class ODataGetByKeyRequestConfig<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatagetbykeyrequestconfiglegacy.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatagetbykeyrequestconfiglegacy.html
new file mode 100644
index 0000000000..28d005d16e
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatagetbykeyrequestconfiglegacy.html
@@ -0,0 +1,646 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ custom
+
+
+
+
+
+ Readonly default
+
+
+
+
+
+ Readonly default
+
+
+
+
+
+ Readonly entity
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ content
+
+
+
+ custom
+
+
+
+ custom
+
+
+
+
+
+ add
+
+
+
+ add
+
+
+
+ Protected prepend
+
+
+
+ query
+
+
+
+ resource
+
+
+
+
+
+
+
+
+ OData getByKey request configuration for an entity type.
+Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity to setup a request for
+
+
Hierarchy
+-
+
-
+ ODataRequestConfig
+
-
+
-
+ ODataGetByKeyRequestConfig
+
-
+
- + ODataGetByKeyRequestConfigLegacy + +
+
+ -
+ ODataGetByKeyRequestConfig
+
Implements
+-
+
- WithKeys +
- WithSelection<EntityT> +
Index
+
+
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- custom
Service Path
+ - default
Headers
+ - default
Service Path
+ - entity
Constructor
+ - expands +
- keys +
- method +
- payload +
- selects +
Accessors
+ +Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of ODataGetByKeyRequestConfig.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
entityConstructor: Constructable<EntityT, unknown>
+++Constructor type of the entity to create a configuration for
+
+ -
+
oDataUri: ODataUri
+
+
Returns ODataGetByKeyRequestConfig<EntityT>
+
+ -
+
Properties
+customServicePath
+
+
+ Readonly defaultHeaders
+
+
+ Readonly defaultServicePath
+
+
+ Readonly entityConstructor
+
+
+ expands
+ + +keys
+ + +method
+ + +payload
+ + +selects
+ + +Accessors
+contentType
+ -
+
+
-
+
-
+
+ + ++
Returns any
+
+
customHeaders
+ -
+
+
+
-
+
-
+
+
Returns Record<string, string>
+
+ -
+
+
Parameters
+-
+
-
+
headers: Record<string, string>
+
+
Returns any
+
+ -
+
customQueryParameters
+ -
+
+
+
-
+
-
+
+
Returns Record<string, string>
+
+ -
+
+
Parameters
+-
+
-
+
queryParameters: Record<string, string>
+
+
Returns any
+
+ -
+
Methods
+addCustomHeaders
+ -
+
+
-
+
-
+
+ ++++
Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs where the key is the name of a header property and the value is the respective value
+
+
Returns void
+
+ -
+
addCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++
Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs where the key is the name of a query parameter and the value is the respective value
+
+
Returns void
+
+ -
+
Protected prependDollarToQueryParameters
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
params: Record<string, any>
+
+
Returns Record<string, any>
+
+ -
+
queryParameters
+ -
+
+
-
+
-
+
+
Returns Record<string, any>
+
+
resourcePath
+ -
+
+
-
+
-
+
+
Returns string
+
+
+
+
+
+
+ Class ODataGetByKeyRequestConfigLegacy<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatarequest.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatarequest.html
new file mode 100644
index 0000000000..440d30598e
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.odatarequest.html
@@ -0,0 +1,691 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ custom
+
+
+
+
+
+ Readonly default
+
+
+
+
+
+ Readonly default
+
+
+
+
+
+ Readonly entity
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ content
+
+
+
+ custom
+
+
+
+ custom
+
+
+
+
+
+ add
+
+
+
+ add
+
+
+
+ Protected prepend
+
+
+
+ query
+
+
+
+ resource
+
+
+
+
+
+
+
+ Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity to setup a request for
+
+
Hierarchy
+-
+
-
+ ODataGetByKeyRequestConfig<EntityT>
+
-
+
- + ODataGetByKeyRequestConfigLegacy + +
+
Index
+
+
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- custom
Service Path
+ - default
Headers
+ - default
Service Path
+ - entity
Constructor
+ - expands +
- keys +
- method +
- payload +
- selects +
Accessors
+ +Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of ODataGetByKeyRequestConfig.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
_entityConstructor: Constructable<EntityT, unknown>
+++Constructor type of the entity to create a configuration for
+
+
Returns ODataGetByKeyRequestConfigLegacy<EntityT>
+
+ -
+
Properties
+customServicePath
+
+
+ Readonly defaultHeaders
+
+
+ Readonly defaultServicePath
+
+
+ Readonly entityConstructor
+
+
+ expands
+ + +keys
+ + +method
+ + +payload
+ + +selects
+ + +Accessors
+contentType
+ -
+
+
-
+
-
+
+ + ++
Returns any
+
+
customHeaders
+ -
+
+
+
-
+
-
+
+
Returns Record<string, string>
+
+ -
+
+
Parameters
+-
+
-
+
headers: Record<string, string>
+
+
Returns any
+
+ -
+
customQueryParameters
+ -
+
+
+
-
+
-
+
+
Returns Record<string, string>
+
+ -
+
+
Parameters
+-
+
-
+
queryParameters: Record<string, string>
+
+
Returns any
+
+ -
+
Methods
+addCustomHeaders
+ -
+
+
-
+
-
+
+ ++++
Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs where the key is the name of a header property and the value is the respective value
+
+
Returns void
+
+ -
+
addCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++
Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs where the key is the name of a query parameter and the value is the respective value
+
+
Returns void
+
+ -
+
Protected prependDollarToQueryParameters
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
params: Record<string, any>
+
+
Returns Record<string, any>
+
+ -
+
queryParameters
+ -
+
+
-
+
-
+
+
Returns Record<string, any>
+
+
resourcePath
+ -
+
+
-
+
-
+
+
Returns string
+
+
+
+
+
+
+ Class ODataRequest<RequestConfigT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.odataupdaterequestconfig.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.odataupdaterequestconfig.html
new file mode 100644
index 0000000000..f828a30ceb
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.odataupdaterequestconfig.html
@@ -0,0 +1,665 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ custom
+
+
+
+ default
+
+
+
+ e
+
+
+
+
+
+
+
+
+
+ needs
+
+
+
+
+
+
+ relative
+
+
+
+ relative
+
+
+
+ relative
+
+
+
+ resource
+
+
+
+ service
+
+
+
+
+
+
+
+
+
+
+
+
+ OData request configuration for an entity type.
+Type parameters
+-
+
-
+
RequestConfigT: ODataRequestConfig
+
+
Hierarchy
+-
+
- + ODataRequest + +
Index
+
+
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- config +
Accessors
+-
+
- destination +
Methods
+-
+
- custom
Headers
+ - default
Headers
+ - e
Tag Headers
+ - execute +
- headers +
- needs
Authentication
+ - query +
- relative
Resource Url
+ - relative
Service Url
+ - relative
Url
+ - resource
Url
+ - service
Url
+ - url +
Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++ +
Creates an instance of ODataRequest.
+Type parameters
+-
+
-
+
RequestConfigT: ODataRequestConfig<RequestConfigT>
+
+
Parameters
+-
+
-
+
config: RequestConfigT
+++Configuration of the request
+
+ -
+
Optional _destination: Destination
+++Destination to setup the request against
+
+
Returns ODataRequest<RequestConfigT>
+
+ -
+
Properties
+config
+ + +Accessors
+destination
+-
+
+
+
-
+
-
+
+
Returns undefined | Destination
+
+ -
+
+
Parameters
+-
+
-
+
dest: undefined | Destination
+
+
Returns any
+
+ -
+
Methods
+customHeaders
+ -
+
+
-
+
-
+
+ ++++
Get all custom headers.
+Returns Record<string, any>
+Key-value pairs where the key is the name of a header property and the value is the respective value
+
+
defaultHeaders
+ -
+
+
-
+
-
+
+ ++++
Get all default headers. If custom headers are set, those take precedence.
+Returns Record<string, any>
+Key-value pairs where the key is the name of a header property and the value is the respective value
+
+
eTagHeaders
+ -
+
+
-
+
-
+
+ ++++
Get the eTag related headers, e. g.
+if-match.Returns Record<string, any>
+Key-value pairs where the key is the name of a header property and the value is the respective value
+
+
execute
+-
+
+
-
+
-
+
+ ++++
Execute the given request and return the according promise.
+Returns Promise<HttpResponse>
+Promise resolving to the requested data
+
+
headers
+-
+
+
-
+
-
+
+ ++++
Create object containing all headers, including custom headers for the given request.
+Returns Promise<Record<string, any>>
+Key-value pairs where the key is the name of a header property and the value is the respective value
+
+
needsAuthentication
+ -
+
+
-
+
-
+
+ ++++ +
Specifies whether the destination needs a specific authentication or not.
+Returns boolean
+A boolean value that specifies whether the destination needs authentication or not
+
+
query
+-
+
+
-
+
-
+
+ ++++
Get query parameters as string. Leads with
+?if there are parameters to return.Returns string
+Query parameter string
+
+
relativeResourceUrl
+ -
+
+
-
+
-
+
+ ++++
Returns the relative URL to a specific OData resource.
+Parameters
+-
+
-
+
Optional includeServicePath: boolean
+++Whether or not to include the service path in the URL.
+
+
Returns string
+The relative URL of the resource.
+
+ -
+
relativeServiceUrl
+ -
+
+
-
+
-
+
+ ++++
Returns the service URL relative to the url of the destination for a given OData request.
+Returns string
+The relative URL of the service the given entity belongs to.
+
+
relativeUrl
+ -
+
+
-
+
-
+
+ ++++
Constructs a URL relative to the destination.
+Parameters
+-
+
-
+
Optional includeServicePath: boolean
+++Whether or not to include the service path in the URL.
+
+
Returns string
+The relative URL for the request.
+
+ -
+
resourceUrl
+ -
+
+
-
+
-
+
+ ++++
Returns the URL to a specific OData .resource, i.e. the entity collection.
+Returns string
+The URL of the resource
+
+
serviceUrl
+ -
+
+
-
+
-
+
+ ++++
Returns the service URL for a given OData request.
+Returns string
+The URL of the service the given entity belongs to
+
+
url
+-
+
+
-
+
-
+
+ ++++
Constructs an absolute URL for the given request.
+Returns string
+The absolute URL for the request
+
+
+
+
+
+
+ Class ODataUpdateRequestConfig<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.odataupdaterequestconfiglegacy.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.odataupdaterequestconfiglegacy.html
new file mode 100644
index 0000000000..375f09d865
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.odataupdaterequestconfiglegacy.html
@@ -0,0 +1,668 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ custom
+
+
+
+
+
+ Readonly default
+
+
+
+
+
+ Readonly default
+
+
+
+
+
+ e
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ version
+
+
+
+
+
+
+
+ content
+
+
+
+ custom
+
+
+
+ custom
+
+
+
+
+
+ add
+
+
+
+ add
+
+
+
+ Protected prepend
+
+
+
+ query
+
+
+
+ resource
+
+
+
+ update
+
+
+
+
+
+
+
+
+ OData update request configuration for an entity type.
+Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity to setup a request for
+
+
Hierarchy
+-
+
-
+ ODataRequestConfig
+
-
+
-
+ ODataUpdateRequestConfig
+
-
+
- + ODataUpdateRequestConfigLegacy + +
+
+ -
+ ODataUpdateRequestConfig
+
Implements
+-
+
- WithKeys +
- WithETag +
Index
+
+
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- _entity
Constructor
+ - custom
Service Path
+ - default
Headers
+ - default
Service Path
+ - e
Tag
+ - keys +
- method +
- payload +
- version
Identifier Ignored
+
Accessors
+ +Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of ODataUpdateRequestConfig.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
_entityConstructor: Constructable<EntityT, unknown>
+++Constructor type of the entity to create a configuration for
+
+ -
+
oDataUri: ODataUri
+
+
Returns ODataUpdateRequestConfig<EntityT>
+
+ -
+
Properties
+Readonly _entityConstructor
+
+
+ customServicePath
+
+
+ Readonly defaultHeaders
+
+
+ Readonly defaultServicePath
+
+
+ eTag
+
+
+ keys
+ + +method
+ + +payload
+ + +versionIdentifierIgnored
+
+
+ Accessors
+contentType
+ -
+
+
-
+
-
+
+ + ++
Returns any
+
+
customHeaders
+ -
+
+
+
-
+
-
+
+
Returns Record<string, string>
+
+ -
+
+
Parameters
+-
+
-
+
headers: Record<string, string>
+
+
Returns any
+
+ -
+
customQueryParameters
+ -
+
+
+
-
+
-
+
+
Returns Record<string, string>
+
+ -
+
+
Parameters
+-
+
-
+
queryParameters: Record<string, string>
+
+
Returns any
+
+ -
+
Methods
+addCustomHeaders
+ -
+
+
-
+
-
+
+ ++++
Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs where the key is the name of a header property and the value is the respective value
+
+
Returns void
+
+ -
+
addCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++
Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs where the key is the name of a query parameter and the value is the respective value
+
+
Returns void
+
+ -
+
Protected prependDollarToQueryParameters
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
params: Record<string, any>
+
+
Returns Record<string, any>
+
+ -
+
queryParameters
+ -
+
+
-
+
-
+
+
Returns Record<string, any>
+
+
resourcePath
+ -
+
+
-
+
-
+
+
Returns string
+
+
updateWithPut
+ -
+
+
-
+
-
+
+
Returns void
+
+
+
+
+
+
+ Class ODataUpdateRequestConfigLegacy<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.onetomanylink.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.onetomanylink.html
new file mode 100644
index 0000000000..2ec432dcf4
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.onetomanylink.html
@@ -0,0 +1,744 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ custom
+
+
+
+
+
+ Readonly default
+
+
+
+
+
+ Readonly default
+
+
+
+
+
+ e
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ version
+
+
+
+
+
+
+
+ content
+
+
+
+ custom
+
+
+
+ custom
+
+
+
+
+
+ add
+
+
+
+ add
+
+
+
+ Protected prepend
+
+
+
+ query
+
+
+
+ resource
+
+
+
+ update
+
+
+
+
+
+
+
+ Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity to setup a request for
+
+
Hierarchy
+-
+
-
+ ODataUpdateRequestConfig<EntityT>
+
-
+
- + ODataUpdateRequestConfigLegacy + +
+
Index
+
+
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- _entity
Constructor
+ - custom
Service Path
+ - default
Headers
+ - default
Service Path
+ - e
Tag
+ - keys +
- method +
- payload +
- version
Identifier Ignored
+
Accessors
+ +Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of ODataUpdateRequestConfig.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
_entityConstructor: Constructable<EntityT, unknown>
+++Constructor type of the entity to create a configuration for
+
+
Returns ODataUpdateRequestConfigLegacy<EntityT>
+
+ -
+
Properties
+Readonly _entityConstructor
+
+
+ customServicePath
+
+
+ Readonly defaultHeaders
+
+
+ Readonly defaultServicePath
+
+
+ eTag
+
+
+ keys
+ + +method
+ + +payload
+ + +versionIdentifierIgnored
+
+
+ Accessors
+contentType
+ -
+
+
-
+
-
+
+ + ++
Returns any
+
+
customHeaders
+ -
+
+
+
-
+
-
+
+
Returns Record<string, string>
+
+ -
+
+
Parameters
+-
+
-
+
headers: Record<string, string>
+
+
Returns any
+
+ -
+
customQueryParameters
+ -
+
+
+
-
+
-
+
+
Returns Record<string, string>
+
+ -
+
+
Parameters
+-
+
-
+
queryParameters: Record<string, string>
+
+
Returns any
+
+ -
+
Methods
+addCustomHeaders
+ -
+
+
-
+
-
+
+ ++++
Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs where the key is the name of a header property and the value is the respective value
+
+
Returns void
+
+ -
+
addCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++
Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs where the key is the name of a query parameter and the value is the respective value
+
+
Returns void
+
+ -
+
Protected prependDollarToQueryParameters
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
params: Record<string, any>
+
+
Returns Record<string, any>
+
+ -
+
queryParameters
+ -
+
+
-
+
-
+
+
Returns Record<string, any>
+
+
resourcePath
+ -
+
+
-
+
-
+
+
Returns string
+
+
updateWithPut
+ -
+
+
-
+
-
+
+
Returns void
+
+
+
+
+
+
+ Class OneToManyLink<EntityT, LinkedEntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.onetoonelink.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.onetoonelink.html
new file mode 100644
index 0000000000..875a5552cf
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.onetoonelink.html
@@ -0,0 +1,670 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+
+
+
+ Readonly _field
+
+
+
+
+
+
+
+
+ Readonly _linked
+
+
+
+
+
+ _order
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ order
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Type parameters
+-
+
-
+
EntityT: EntityBase
+
+ -
+
LinkedEntityT: EntityBase
+
+
Hierarchy
+-
+
-
+ Link<EntityT, LinkedEntityT>
+
-
+
- + OneToManyLink + +
+
Index
+
+
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- _entity +
- _entity
Constructor
+ - _expand +
- _field
Name
+ - _filters +
- _linked
Entity
+ - _order
By
+ - _selects +
- _skip +
- _top +
Accessors
+-
+
- selects +
Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of Link.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+ -
+
LinkedEntityT: EntityBase<LinkedEntityT>
+
+
Parameters
+-
+
-
+
_fieldName: string
+++Name of the linking field to be used in the OData request.
+
+ -
+
_entityConstructor: Constructable<EntityT, unknown>
+++Constructor type of the entity the field belongs to
+
+ -
+
_linkedEntity: Constructable<LinkedEntityT, unknown>
+++Constructor type of the linked entity
+
+
Returns OneToManyLink<EntityT, LinkedEntityT>
+
+ -
+
Properties
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ _expand
+ + +Readonly _fieldName
+
+
+ _filters
+ + +Readonly _linkedEntity
+
+
+ _orderBy
+
+
+ _selects
+ + +
+
+
+
+ List of selectables on the linked entity.
+_skip
+ + +_top
+ + +Accessors
+selects
+-
+
+
-
+
-
+
+ + ++
Returns Selectable<LinkedEntityT>[]
+
+
Methods
+clone
+-
+
+
-
+
-
+
+
Returns OneToManyLink<EntityT, LinkedEntityT>
+
+
expand
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
Rest ...expands: Expandable<LinkedEntityT>[]
+
+
Returns OneToManyLink<EntityT, LinkedEntityT>
+
+ -
+
filter
+-
+
+
-
+
-
+
+ ++++
Create filter statements to be applied to the OData request based on the linked entity values.
+Parameters
+-
+
-
+
Rest ...expressions: (Filter<LinkedEntityT, undefined | null | string | number | boolean | Moment | Time | Duration | BigNumber | FieldType[]> | FilterLink<LinkedEntityT, any> | FilterList<LinkedEntityT> | FilterLambdaExpression<LinkedEntityT, FieldType> | OneToManyLink<LinkedEntityT, any>)[]
+
+
Returns OneToManyLink<EntityT, LinkedEntityT>
+Newly created Filterlink
+
+ -
+
orderBy
+ -
+
+
-
+
-
+
+ ++++
Add order-by statements to the request.
+Parameters
+-
+
-
+
Rest ...orderBy: Orderable<LinkedEntityT>[]
+++OrderBy statements to order the response by
+
+
Returns OneToManyLink<EntityT, LinkedEntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
select
+-
+
+
-
+
-
+
+ ++++
Creates a selection on a linked entity. Has the same behavior as GetAllRequestBuilderV2.select and GetByKeyRequestBuilderV4.select but for linked entities.
+See also, Selectable
+Parameters
+-
+
-
+
Rest ...selects: Selectable<LinkedEntityT>[]
+++Selection of fields or links on a linked entity
+
+
Returns OneToManyLink<EntityT, LinkedEntityT>
+The link itself, to facilitate method chaining
+
+ -
+
skip
+-
+
+
-
+
-
+
+ ++++
Skip number of entities.
+Parameters
+-
+
-
+
skip: number
+++Number of matching entities to skip. Useful for paging
+
+
Returns OneToManyLink<EntityT, LinkedEntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
top
+-
+
+
-
+
-
+
+ ++++
Limit number of returned entities.
+Parameters
+-
+
-
+
top: number
+++Maximum number of entities to return in the response. Can be less, if less entities match the request
+
+
Returns OneToManyLink<EntityT, LinkedEntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
Static clone
+-
+
+
-
+
-
+
+ + ++
Type parameters
+-
+
-
+
EntityT1: EntityBase<EntityT1>
+
+ -
+
LinkedEntityT1: EntityBase<LinkedEntityT1>
+
+
Parameters
+-
+
-
+
link: Link<EntityT1, LinkedEntityT1>
+++Link to be cloned
+
+
Returns Link<EntityT1, LinkedEntityT1>
+Newly created link
+
+ -
+
+
+
+
+
+ Class OneToOneLink<EntityT, LinkedEntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.openapirequestbuilder.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.openapirequestbuilder.html
new file mode 100644
index 0000000000..308c2e1fab
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.openapirequestbuilder.html
@@ -0,0 +1,396 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+
+
+
+ Readonly _field
+
+
+
+
+
+ Readonly _linked
+
+
+
+
+
+
+
+
+
+
+
+ order
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ order
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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 parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity to be linked from
+
+ -
+
LinkedEntityT: EntityBase
+++++Type of the entity to be linked to
+
+
Hierarchy
+-
+
-
+ Link<EntityT, LinkedEntityT>
+
-
+
- + OneToOneLink + +
+
Index
+
+
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- _entity +
- _entity
Constructor
+ - _expand +
- _field
Name
+ - _linked
Entity
+ - _selects +
- filters +
- order
Bys
+
Accessors
+-
+
- selects +
Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of Link.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+ -
+
LinkedEntityT: EntityBase<LinkedEntityT>
+
+
Parameters
+-
+
-
+
_fieldName: string
+++Name of the linking field to be used in the OData request.
+
+ -
+
_entityConstructor: Constructable<EntityT, unknown>
+++Constructor type of the entity the field belongs to
+
+ -
+
_linkedEntity: Constructable<LinkedEntityT, unknown>
+++Constructor type of the linked entity
+
+
Returns OneToOneLink<EntityT, LinkedEntityT>
+
+ -
+
Properties
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ _expand
+ + +Readonly _fieldName
+
+
+ Readonly _linkedEntity
+
+
+ _selects
+ + +
+
+
+
+ List of selectables on the linked entity.
+filters
+ + +
+
+
+
+ Filterables to apply to the given entity based on the linked entity.
+orderBys
+
+
+
+
+
+
+ List of criteria of the linked entity to order the given entity by with descending priority.
+Accessors
+selects
+-
+
+
-
+
-
+
+ + ++
Returns Selectable<LinkedEntityT>[]
+
+
Methods
+clone
+-
+
+
-
+
-
+
+
Returns OneToOneLink<EntityT, LinkedEntityT>
+
+
expand
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
Rest ...expands: Expandable<LinkedEntityT>[]
+
+
Returns OneToOneLink<EntityT, LinkedEntityT>
+
+ -
+
filter
+-
+
+
-
+
-
+
+ ++++
Create filter statements to be applied to the OData request based on the linked entity values.
+Parameters
+-
+
-
+
Rest ...filters: Filterable<LinkedEntityT>[]
+++Filters based on the linked entity
+
+
Returns FilterLink<EntityT, LinkedEntityT>
+Newly created Filterlink
+
+ -
+
orderBy
+ -
+
+
-
+
-
+
+ ++++
Create order statements for the OData request based on the linked entity. The given statements have descending priority.
+Example:
+
+Entity.requestBuilder() + .getAll() + .orderBy(Entity.TO_LINKED_ENTITY.orderBy(asc(LinkedEntity.PROPERTY1), desc(LinkedEntity.PROPERTY2))); +Parameters
+-
+
-
+
Rest ...orderBy: Orderable<LinkedEntityT>[]
+++Criteria to order by
+
+
Returns OrderLink<EntityT, LinkedEntityT>
+Newly created order link
+
+ -
+
select
+-
+
+
-
+
-
+
+ ++++
Creates a selection on a linked entity. Has the same behavior as GetAllRequestBuilderV2.select and GetByKeyRequestBuilderV4.select but for linked entities.
+See also, Selectable
+Parameters
+-
+
-
+
Rest ...selects: Selectable<LinkedEntityT>[]
+++Selection of fields or links on a linked entity
+
+
Returns OneToOneLink<EntityT, LinkedEntityT>
+The link itself, to facilitate method chaining
+
+ -
+
Static clone
+-
+
+
-
+
-
+
+ + ++
Type parameters
+-
+
-
+
EntityT1: EntityBase<EntityT1>
+
+ -
+
LinkedEntityT1: EntityBase<LinkedEntityT1>
+
+
Parameters
+-
+
-
+
link: OneToOneLink<EntityT1, LinkedEntityT1>
+++Link to be cloned
+
+
Returns OneToOneLink<EntityT1, LinkedEntityT1>
+Newly created link
+
+ -
+
+
+
+
+
+ Class OpenApiRequestBuilder<ApiT, FnT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.order.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.order.html
new file mode 100644
index 0000000000..c0811f0225
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.order.html
@@ -0,0 +1,306 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ add
+
+
+
+
+
+
+ execute
+
+
+
+
+
+
+
+ Type parameters
+-
+
-
+
ApiT
+++++Interface of the generated api. All properties of the interface will be treated as functions.
+
+ -
+
FnT: keyof ApiT
+++++Literal string type of the function name, must be a key of
+ApiTand represent a function.
+
Hierarchy
+-
+
- + OpenApiRequestBuilder + +
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- fn +
Methods
+-
+
- add
Custom Headers
+ - execute +
- execute
Raw
+
Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Create an instance of
+RestRequestBuilder.Type parameters
+-
+
-
+
ApiT
+
+ -
+
FnT: string | number | symbol
+
+
Parameters
+-
+
-
+
apiConstructor: ConstructorType<ApiT>
+++Constructor of the underlying OpenApi api definition.
+
+ -
+
fn: FnT
+++Name of the function represented in thie request builder.
+
+ -
+
Rest ...args: ParametersType<ApiT, FnT>
+++Arguments to pass to the api function.
+
+
Returns OpenApiRequestBuilder<ApiT, FnT>
+
+ -
+
Properties
+fn
+ + +Methods
+addCustomHeaders
+ -
+
+
-
+
-
+
+ ++++
Add custom headers to the request. If a header field with the given name already exists it is overwritten.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs denoting additional custom headers
+
+
Returns OpenApiRequestBuilder<ApiT, FnT>
+The request builder itself, to facilitate method chaining
+
+ -
+
execute
+-
+
+
-
+
-
+
+ ++++
Execute request and get the response data. Use this to conveniently access the data of a service without technical information about the response.
+Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++Destination to execute the request against.
+
+
Returns Promise<UnwrapAxiosResponse<FunctionReturnType<ApiT, FnT>>>
+A promise resolving to the requested return type.
+
+ -
+
executeRaw
+ -
+
+
-
+
-
+
+ ++++
Execute request and get a raw AxiosResponse, including all information about the HTTP response. + This especially comes in handy, when you need to access the headers or status code of the response.
+Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++Destination to execute the request against.
+
+
Returns Promise<FunctionReturnType<ApiT, FnT>>
+A promise resolving to an AxiosResponse.
+
+ -
+
+
+
+
+
+ Class Order<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.orderablefilterfunction.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.orderablefilterfunction.html
new file mode 100644
index 0000000000..b88ef96514
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.orderablefilterfunction.html
@@ -0,0 +1,577 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ _field
+
+
+
+
+
+ order
+
+
+
+
+
+
+
+
+
+
+ OData queries take this to determine the order of results.
+Type parameters
+-
+
-
+
EntityT: EntityBase
+++++-
+
+
Hierarchy
+-
+
- + Order + +
Implements
+-
+
- EntityIdentifiable<EntityT> +
Index
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- _entity +
- _entity
Constructor
+ - _field
Name
+ - order
Type
+
Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of Order.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
_fieldName: string
+++Field to order by
+
+ -
+
Optional orderType: "asc" | "desc"
+++Type of ordering, can be 'asc' for ascending or 'desc' for descending
+
+
Returns Order<EntityT>
+
+ -
+
Properties
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ _fieldName
+
+
+ orderType
+
+
+
+
+
+
+
+ Class OrderableFilterFunction<EntityT, ReturnT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.orderlink.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.orderlink.html
new file mode 100644
index 0000000000..76fa91dd73
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.orderlink.html
@@ -0,0 +1,311 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly edm
+
+
+
+
+
+ Readonly function
+
+
+
+
+
+
+
+
+
+
+
+
+
+ greater
+
+
+
+ greater
+
+
+
+ less
+
+
+
+ less
+
+
+
+ not
+
+
+
+ to
+
+
+
+
+
+
+
+
+ Representation of a filter function, that returns a value of an orderable type. This supports int, double and decimal values.
+Type parameters
+-
+
-
+
EntityT: EntityBase
+
+ -
+
ReturnT: FieldType
+
+
Hierarchy
+-
+
-
+ FilterFunction<EntityT, ReturnT>
+
-
+
-
+ OrderableFilterFunction
+
-
+
- + NumberFilterFunction + +
+
+ -
+ OrderableFilterFunction
+
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- edm
Type
+ - function
Name
+ - parameters +
Methods
+-
+
- equals +
- greater
OrEqual
+ - greater
Than
+ - less
OrEqual
+ - less
Than
+ - not
Equals
+ - to
String
+
Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of OrderableFilterFunction.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+ -
+
ReturnT: FieldType
+
+
Parameters
+-
+
-
+
functionName: string
+++Name of the function that returns a numeric value
+
+ -
+
parameters: FilterFunctionParameterType<EntityT>[]
+++Representation of the parameters passed to the filter function
+
+ -
+
edmType: EdmTypeShared<VersionT>
+++Type of the returned numeric value. This influences the formatting of the returned value.
+
+
Returns OrderableFilterFunction<EntityT, ReturnT>
+
+ -
+
Properties
+Readonly edmType
+
+
+ Readonly functionName
+
+
+ Readonly parameters
+ + +Methods
+equals
+-
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this filter function and the given value using the operator 'eq', i.e.
+==.Parameters
+-
+
-
+
value: ReturnT
+++Value to be used in the filter
+
+
Returns Filter<EntityT, ReturnT>
+The resulting filter
+
+ -
+
greaterOrEqual
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this filter function and the given value using the operator 'ge', i.e.
+>=.Parameters
+-
+
-
+
value: ReturnT
+++Value to be used in the filter
+
+
Returns Filter<EntityT, ReturnT>
+The resulting filter
+
+ -
+
greaterThan
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this filter function and the given value using the operator 'gt', i.e.
+>.Parameters
+-
+
-
+
value: ReturnT
+++Value to be used in the filter
+
+
Returns Filter<EntityT, ReturnT>
+The resulting filter
+
+ -
+
lessOrEqual
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this filter function and the given value using the operator 'le', i.e.
+<=.Parameters
+-
+
-
+
value: ReturnT
+++Value to be used in the filter
+
+
Returns Filter<EntityT, ReturnT>
+The resulting filter
+
+ -
+
lessThan
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this filter function and the given value using the operator 'lt', i.e.
+<.Parameters
+-
+
-
+
value: ReturnT
+++Value to be used in the filter
+
+
Returns Filter<EntityT, ReturnT>
+The resulting filter
+
+ -
+
notEquals
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this filter function and the given value using the operator 'ne', i.e.
+!=.Parameters
+-
+
-
+
value: ReturnT
+++Value to be used in the filter
+
+
Returns Filter<EntityT, ReturnT>
+The resulting filter
+
+ -
+
toString
+ -
+
+
-
+
-
+
+ + ++
Parameters
+-
+
-
+
Optional parentFieldNames: string[]
+++Names of parents in case the function is part of a filter on a navigation property
+
+
Returns string
+The filter function as string
+
+ -
+
+
+
+
+
+ Class OrderLink<EntityT, LinkedEntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.stringfield.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.stringfield.html
new file mode 100644
index 0000000000..ee913d9936
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.stringfield.html
@@ -0,0 +1,440 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly entity
+
+
+
+
+
+
+
+
+ Readonly linked
+
+
+
+
+
+ order
+
+
+
+
+
+
+
+
+
+
+ Link to represent an order by on a linked entity.
+Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity to link from
+
+ -
+
LinkedEntityT: EntityBase
+++++Type of the entity to link to
+
+
Hierarchy
+-
+
- + OrderLink + +
Index
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- entity
Type
+ - link +
- linked
Entity Type
+ - order
By
+
Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of OrderLink.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+ -
+
LinkedEntityT: EntityBase<LinkedEntityT>
+
+
Parameters
+-
+
-
+
link: Link<EntityT, LinkedEntityT>
+++Link to the entity to order by
+
+ -
+
orderBy: Orderable<LinkedEntityT>[]
+++A list of orderables based on the linked entity
+
+
Returns OrderLink<EntityT, LinkedEntityT>
+
+ -
+
Properties
+Readonly entityType
+
+
+ link
+ + +Readonly linkedEntityType
+
+
+ orderBy
+
+
+
+
+
+
+
+ Class StringField<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.stringfilterfunction.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.stringfilterfunction.html
new file mode 100644
index 0000000000..697500d89a
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.stringfilterfunction.html
@@ -0,0 +1,415 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ Readonly _field
+
+
+
+
+
+ Readonly edm
+
+
+
+
+
+
+
+
+
+
+
+
+
+ field
+
+
+
+ not
+
+
+
+
+
+
+
+
+ Represents a selectable property with a string value.
+Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity the field belongs to
+
+
Hierarchy
+-
+
-
+ StringFieldBase<EntityT>
+
-
+
- + StringField + +
+
Implements
+ +Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- _entity +
- _entity
Constructor
+ - _field
Name
+ - edm
Type
+ - selectable +
Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of EdmTypeField.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
fieldName: string
+++Actual name of the field used in the OData request
+
+ -
+
entityConstructor: Constructable<EntityT, unknown>
+++Constructor type of the entity the field belongs to
+
+ -
+
edmType: EdmTypeShared<VersionT>
+++Type of the field according to the metadata description
+
+
Returns StringField<EntityT>
+
+ -
+
Properties
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ Readonly _fieldName
+
+
+ Readonly edmType
+
+
+ Readonly selectable
+ + +Methods
+equals
+-
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'eq', i.e.
+==.Parameters
+-
+
-
+
value: string
+++Value to be used in the filter
+
+
Returns Filter<EntityT, string>
+The resulting filter
+
+ -
+
fieldPath
+ -
+
+
-
+
-
+
+ ++++
Path to the field to be used in filter and order by queries. In most cases this will just be the _fieldName itself. However, for complex types for instance, the path is prefixed with the name of the complextype.
+Returns string
+Path to the field to be used in filter and order by queries.
+
+
notEquals
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this field and the given value using the operator 'ne', i.e.
+!=.Parameters
+-
+
-
+
value: string
+++Value to be used in the filter
+
+
Returns Filter<EntityT, string>
+The resulting filter
+
+ -
+
+
+
+
+
+ Class StringFilterFunction<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.timefield.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.timefield.html
new file mode 100644
index 0000000000..b510b95ae9
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.timefield.html
@@ -0,0 +1,592 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly edm
+
+
+
+
+
+ Readonly function
+
+
+
+
+
+
+
+
+
+
+
+
+
+ not
+
+
+
+ to
+
+
+
+
+
+
+
+
+ Representation of a filter function, that returns a value of type string.
+Type parameters
+-
+
-
+
EntityT: EntityBase
+
+
Hierarchy
+-
+
-
+ FilterFunction<EntityT, string>
+
-
+
- + StringFilterFunction + +
+
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- edm
Type
+ - function
Name
+ - parameters +
Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of StringFilterFunction.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
functionName: string
+++Name of the function that returns a string value
+
+ -
+
parameters: FilterFunctionParameterType<EntityT>[]
+++Representation of the parameters passed to the filter function
+
+
Returns StringFilterFunction<EntityT>
+
+ -
+
Properties
+Readonly edmType
+
+
+ Readonly functionName
+
+
+ Readonly parameters
+ + +Methods
+equals
+-
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this filter function and the given value using the operator 'eq', i.e.
+==.Parameters
+-
+
-
+
value: string
+++Value to be used in the filter
+
+
Returns Filter<EntityT, string>
+The resulting filter
+
+ -
+
notEquals
+ -
+
+
-
+
-
+
+ ++++
Creates an instance of Filter for this filter function and the given value using the operator 'ne', i.e.
+!=.Parameters
+-
+
-
+
value: string
+++Value to be used in the filter
+
+
Returns Filter<EntityT, string>
+The resulting filter
+
+ -
+
toString
+ -
+
+
-
+
-
+
+ + ++
Parameters
+-
+
-
+
Optional parentFieldNames: string[]
+++Names of parents in case the function is part of a filter on a navigation property
+
+
Returns string
+The filter function as string
+
+ -
+
+
+
+
+
+ Class TimeField<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.timefieldbase.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.timefieldbase.html
new file mode 100644
index 0000000000..59bad31b52
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.timefieldbase.html
@@ -0,0 +1,582 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ Readonly _field
+
+
+
+
+
+ Readonly edm
+
+
+
+
+
+
+
+
+
+
+
+
+
+ field
+
+
+
+ greater
+
+
+
+ greater
+
+
+
+ less
+
+
+
+ less
+
+
+
+ not
+
+
+
+
+
+
+
+
+ Represents a selectable property with a time value.
+Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity the field belongs to
+
+
Hierarchy
+-
+
-
+ TimeFieldBase<EntityT>
+
-
+
- + TimeField + +
+
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- _entity +
- _entity
Constructor
+ - _field
Name
+ - edm
Type
+ - selectable +
Methods
+-
+
- equals +
- field
Path
+ - greater
OrEqual
+ - greater
Than
+ - less
OrEqual
+ - less
Than
+ - not
Equals
+
Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of EdmTypeField.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
fieldName: string
+++Actual name of the field used in the OData request
+
+ -
+
entityConstructor: Constructable<EntityT, unknown>
+++Constructor type of the entity the field belongs to
+
+ -
+
edmType: EdmTypeShared<VersionT>
+++Type of the field according to the metadata description
+
+
Returns TimeField<EntityT>
+
+ -
+
Properties
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ Readonly _fieldName
+
+
+ Readonly edmType
+
+
+ Readonly selectable
+ + +Methods
+equals
+-
+
+
fieldPath
+ -
+
+
-
+
-
+
+ ++++
Path to the field to be used in filter and order by queries. In most cases this will just be the _fieldName itself. However, for complex types for instance, the path is prefixed with the name of the complextype.
+Returns string
+Path to the field to be used in filter and order by queries.
+
+
greaterOrEqual
+ -
+
+
greaterThan
+ -
+
+
lessOrEqual
+ -
+
+
lessThan
+ -
+
+
notEquals
+ -
+
+
+
+
+
+
+ Class TimeFieldBase<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.updaterequestbuilder.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.updaterequestbuilder.html
new file mode 100644
index 0000000000..07be58fffa
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.updaterequestbuilder.html
@@ -0,0 +1,1313 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ Readonly _field
+
+
+
+
+
+ Readonly edm
+
+
+
+
+
+
+
+
+
+
+ field
+
+
+
+ greater
+
+
+
+ greater
+
+
+
+ less
+
+
+
+ less
+
+
+
+ not
+
+
+
+
+
+
+
+
+ Represents a property with a time value.
+Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity the field belongs to
+
+
Hierarchy
+-
+
-
+ EdmTypeField<EntityT, Time>
+
-
+
-
+ TimeFieldBase
+
-
+
- + TimeField + +
- + ComplexTypeTimePropertyField + +
+
+ -
+ TimeFieldBase
+
Index
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- _entity +
- _entity
Constructor
+ - _field
Name
+ - edm
Type
+
Methods
+-
+
- equals +
- field
Path
+ - greater
OrEqual
+ - greater
Than
+ - less
OrEqual
+ - less
Than
+ - not
Equals
+
Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of EdmTypeField.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
fieldName: string
+++Actual name of the field used in the OData request
+
+ -
+
entityConstructor: Constructable<EntityT, unknown>
+++Constructor type of the entity the field belongs to
+
+ -
+
edmType: EdmTypeShared<VersionT>
+++Type of the field according to the metadata description
+
+
Returns TimeFieldBase<EntityT>
+
+ -
+
Properties
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ Readonly _fieldName
+
+
+ Readonly edmType
+
+
+ Methods
+equals
+-
+
+
fieldPath
+ -
+
+
-
+
-
+
+ ++++
Path to the field to be used in filter and order by queries. In most cases this will just be the _fieldName itself. However, for complex types for instance, the path is prefixed with the name of the complextype.
+Returns string
+Path to the field to be used in filter and order by queries.
+
+
greaterOrEqual
+ -
+
+
greaterThan
+ -
+
+
lessOrEqual
+ -
+
+
lessThan
+ -
+
+
notEquals
+ -
+
+
+
+
+
+
+ Class UpdateRequestBuilder<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.updaterequestbuilderbase.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.updaterequestbuilderbase.html
new file mode 100644
index 0000000000..0bf09fc8ed
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.updaterequestbuilderbase.html
@@ -0,0 +1,1320 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ Readonly entity
+
+
+
+
+
+ Readonly extractOData
+
+
+
+
+
+ Readonly o
+
+
+
+
+
+ Readonly payload
+
+
+
+
+
+ request
+
+
+
+
+
+
+
+
+
+
+
+
+ add
+
+
+
+ add
+
+
+
+
+
+
+
+
+
+ Protected execute
+
+
+
+ Protected get
+
+
+
+ ignore
+
+
+
+ ignored
+
+
+
+ Protected is
+
+
+
+
+
+
+ relative
+
+
+
+ replace
+
+
+
+ required
+
+
+
+ set
+
+
+
+ set
+
+
+
+ set
+
+
+
+ set
+
+
+
+
+
+
+ with
+
+
+
+ with
+
+
+
+ with
+
+
+
+ with
+
+
+
+
+
+
+
+
+ Create OData query to update an entity.
+Type parameters
+-
+
-
+
EntityT: Entity
+++++Type of the entity to be updated
+
+
Hierarchy
+-
+
-
+ UpdateRequestBuilderBase<EntityT>
+
-
+
- + UpdateRequestBuilder + +
+
Implements
+-
+
- EntityIdentifiable<EntityT> +
Index
+
+
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+ +Accessors
+-
+
- entity +
Methods
+-
+
- add
Custom Headers
+ - add
Custom Query Parameters
+ - build +
- execute +
- execute
Request
+ - get
Payload
+ - ignore
Version Identifier
+ - ignored
Fields
+ - is
Empty Object
+ - prepare +
- relative
Url
+ - replace
Whole Entity With Put
+ - required
Fields
+ - set
Custom Service Path
+ - set
Ignored Fields
+ - set
Required Fields
+ - set
Version Identifier
+ - url +
- with
Custom Headers
+ - with
Custom Query Parameters
+ - with
Custom Service Path
+ - with
Custom Version Identifier
+
Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of UpdateRequestBuilder.
+Type parameters
+-
+
-
+
EntityT: Entity<EntityT>
+
+
Parameters
+-
+
-
+
_entityConstructor: Constructable<EntityT, unknown>
+++Constructor type of the entity to be updated
+
+ -
+
_entity: EntityT
+++Entity to be updated
+
+
Returns UpdateRequestBuilder<EntityT>
+
+ -
+
Properties
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ Readonly entitySerializer
+
+
+ Readonly extractODataEtag
+
+
+
+
+ Type declaration
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
json: Record<string, any>
+
+
Returns undefined | string
+
+ -
+
+ -
+
Readonly oDataUri
+
+
+ Readonly payloadManipulator
+
+
+
+
+ Type declaration
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
body: Record<string, any>
+
+
Returns Record<string, any>
+
+ -
+
+ -
+
requestConfig
+
+
+ Accessors
+entity
+-
+
+
-
+
-
+
+
Returns EntityT
+
+
Methods
+addCustomHeaders
+ -
+
+
-
+
-
+
+ ++++
Add custom headers to the request. Existing headers will be overwritten.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs denoting additional custom headers.
+
+
Returns UpdateRequestBuilder<EntityT>
+The request builder itself, to facilitate method chaining.
+
+ -
+
addCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++
Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs denoting additional custom query parameters to be set in the request
+
+
Returns UpdateRequestBuilder<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
build
+-
+
+
+
-
+
-
+
+
Returns ODataRequest<ODataUpdateRequestConfig<EntityT>>
+
+ -
+
+
Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+
+ -
+
Optional options: (DestinationCachingOptions & ResilienceOptions) | (CachingOptions & ResilienceOptions)
+
+
Returns Promise<ODataRequest<ODataUpdateRequestConfig<EntityT>>>
+
+ -
+
execute
+-
+
+
-
+
-
+
+ ++++
Executes the query.
+Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++Destination to execute the request against
+
+ -
+
Optional options: (DestinationAccessorOptions & DestinationCachingOptions & ResilienceOptions & VerifyJwtOptions) | (DestinationAccessorOptions & CachingOptions & ResilienceOptions & VerifyJwtOptions)
+++Options to employ when fetching destinations
+
+
Returns Promise<EntityT>
+A promise resolving to the entity once it was updated
+
+ -
+
Protected executeRequest
+ -
+
+
-
+
-
+
+ ++++
Executes the query.
+Parameters
+-
+
-
+
request: ODataRequest<ODataUpdateRequestConfig<EntityT>>
+++Request object to be executed
+
+
Returns Promise<EntityT>
+A promise resolving to the entity once it was updated
+
+ -
+
Protected getPayload
+ -
+
+
-
+
-
+
+
Returns Record<string, any>
+
+
ignoreVersionIdentifier
+ -
+
+
-
+
-
+
+ ++++
Instructs the request to force an overwrite of the entity by sending an 'If-Match: *' header instead of sending the ETag version identifier.
+Returns UpdateRequestBuilder<EntityT>
+this The request itself to ease chaining while executing the request
+
+
ignoredFields
+ -
+
+
+
-
+
-
+
+ ++++ +
Specifies entity fields to ignore by the update request.
+Parameters
+-
+
-
+
Rest ...fields: Selectable<EntityT>[]
+++Enumeration of the fields to be ignored
+
+
Returns UpdateRequestBuilder<EntityT>
+The entity itself, to facilitate method chaining
+
+ -
+
-
+
+
Parameters
+-
+
-
+
fields: Selectable<EntityT>[]
+
+
Returns UpdateRequestBuilder<EntityT>
+
+ -
+
Protected isEmptyObject
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
obj: any
+
+
Returns boolean
+
+ -
+
prepare
+-
+
+
-
+
-
+
+ + ++
Returns UpdateRequestBuilder<EntityT>
+the builder itself
+
+
relativeUrl
+ -
+
+
-
+
-
+
+ ++++
Create the relative url based on configuration of the given builder.
+Returns string
+The relative url for the request
+
+
replaceWholeEntityWithPut
+ -
+
+
-
+
-
+
+ ++++
Explicitly configure 'PUT' as the method of the update request. By default, only the properties that have changed compared to the last known remote state are sent using 'PATCH', while with 'PUT', the whole entity is sent.
+Returns UpdateRequestBuilder<EntityT>
+The entity itself, to facilitate method chaining
+
+
requiredFields
+ -
+
+
+
-
+
-
+
+ ++++ +
Specifies required entity keys for the update request.
+Parameters
+-
+
-
+
Rest ...fields: Selectable<EntityT>[]
+++Enumeration of the fields to be required
+
+
Returns UpdateRequestBuilder<EntityT>
+The entity itself, to facilitate method chaining
+
+ -
+
-
+
+
Parameters
+-
+
-
+
fields: Selectable<EntityT>[]
+
+
Returns UpdateRequestBuilder<EntityT>
+
+ -
+
setCustomServicePath
+ -
+
+
-
+
-
+
+ ++++
Replace the default service path with the given custom path. + In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/
+' and can be overwritten here. Parameters
+-
+
-
+
servicePath: string
+++Path to override the default with
+
+
Returns UpdateRequestBuilder<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
setIgnoredFields
+ -
+
+
+
-
+
-
+
+ ++++
Sets entity fields to ignore by the update request.
+Parameters
+-
+
-
+
Rest ...fields: Selectable<EntityT>[]
+++Enumeration of the fields to be ignored
+
+
Returns UpdateRequestBuilder<EntityT>
+The entity itself, to facilitate method chaining
+
+ -
+
-
+
+
Parameters
+-
+
-
+
fields: Selectable<EntityT>[]
+
+
Returns UpdateRequestBuilder<EntityT>
+
+ -
+
setRequiredFields
+ -
+
+
+
-
+
-
+
+ ++++
Sets required entity keys for the update request.
+Parameters
+-
+
-
+
Rest ...fields: Selectable<EntityT>[]
+++Enumeration of the fields to be required
+
+
Returns UpdateRequestBuilder<EntityT>
+The entity itself, to facilitate method chaining
+
+ -
+
-
+
+
Parameters
+-
+
-
+
fields: Selectable<EntityT>[]
+
+
Returns UpdateRequestBuilder<EntityT>
+
+ -
+
setVersionIdentifier
+ -
+
+
-
+
-
+
+ ++++
Sets ETag version identifier of the entity to update.
+Parameters
+-
+
-
+
etag: string
+++Custom ETag version identifier to be sent in the header of the request
+
+
Returns UpdateRequestBuilder<EntityT>
+The request itself to ease chaining while executing the request
+
+ -
+
url
+-
+
+
-
+
-
+
+ ++++
Create the url based on configuration of the given builder.
+Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++Destination to execute the request against
+
+ -
+
Optional options: (DestinationCachingOptions & ResilienceOptions) | (CachingOptions & ResilienceOptions)
+++Options to employ when fetching destinations.
+
+
Returns Promise<string>
+Promise resolving to the url for the request
+
+ -
+
withCustomHeaders
+ -
+
+
-
+
-
+
+ ++++ +
Add custom headers to the request.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs denoting additional custom headers
+
+
Returns UpdateRequestBuilder<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++ +
Add custom query parameters to the request.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs denoting additional custom query parameters to be set in the request
+
+
Returns UpdateRequestBuilder<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomServicePath
+ -
+
+
-
+
-
+
+ ++++ +
Replace the default service path with the given custom path. + In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/
+' and can be overwritten here. Parameters
+-
+
-
+
servicePath: string
+++Path to override the default with
+
+
Returns UpdateRequestBuilder<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomVersionIdentifier
+ -
+
+
-
+
-
+
+ ++++ +
Specifies a custom ETag version identifier of the entity to update.
+Parameters
+-
+
-
+
etag: string
+++Custom ETag version identifier to be sent in the header of the request
+
+
Returns UpdateRequestBuilder<EntityT>
+The request itself to ease chaining while executing the request
+
+ -
+
+
+
+
+
+ Class UpdateRequestBuilderBase<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_core.updaterequestbuilderv4.html b/docs/api/1.36.1/classes/sap_cloud_sdk_core.updaterequestbuilderv4.html
new file mode 100644
index 0000000000..cc62894536
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_core.updaterequestbuilderv4.html
@@ -0,0 +1,1307 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ Readonly entity
+
+
+
+
+
+ Readonly extractOData
+
+
+
+
+
+ Readonly o
+
+
+
+
+
+ Readonly payload
+
+
+
+
+
+ request
+
+
+
+
+
+
+
+
+
+
+
+
+ add
+
+
+
+ add
+
+
+
+
+
+
+ Protected execute
+
+
+
+ Protected get
+
+
+
+ ignore
+
+
+
+ ignored
+
+
+
+ Protected is
+
+
+
+
+
+
+ relative
+
+
+
+ replace
+
+
+
+ required
+
+
+
+ set
+
+
+
+ set
+
+
+
+ set
+
+
+
+ set
+
+
+
+
+
+
+ with
+
+
+
+ with
+
+
+
+ with
+
+
+
+ with
+
+
+
+
+
+
+
+
+ Abstract class to create OData query to update an entity containing methods shared for OData v2 and v4.
+Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity to be updated
+
+
Hierarchy
+-
+
-
+ MethodRequestBuilder<ODataUpdateRequestConfig<EntityT>>
+
-
+
-
+ UpdateRequestBuilderBase
+
-
+
- + UpdateRequestBuilder + +
- + UpdateRequestBuilderV4 + +
+
+ -
+ UpdateRequestBuilderBase
+
Implements
+-
+
- EntityIdentifiable<EntityT> +
Index
+
+
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+ +Accessors
+-
+
- entity +
Methods
+-
+
- add
Custom Headers
+ - add
Custom Query Parameters
+ - build +
- execute
Request
+ - get
Payload
+ - ignore
Version Identifier
+ - ignored
Fields
+ - is
Empty Object
+ - prepare +
- relative
Url
+ - replace
Whole Entity With Put
+ - required
Fields
+ - set
Custom Service Path
+ - set
Ignored Fields
+ - set
Required Fields
+ - set
Version Identifier
+ - url +
- with
Custom Headers
+ - with
Custom Query Parameters
+ - with
Custom Service Path
+ - with
Custom Version Identifier
+
Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of UpdateRequestBuilder.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
_entityConstructor: Constructable<EntityT, unknown>
+++Constructor type of the entity to be updated
+
+ -
+
_entity: EntityT
+++Entity to be updated
+
+ -
+
oDataUri: ODataUri
+++Collection of URI conversion methods
+
+ -
+
entitySerializer: EntitySerializer<any, any>
+++Entity serializer
+
+ -
+
extractODataEtag: (json: Record<string, any>) => undefined | string
+++Extractor for etag from payload
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
json: Record<string, any>
+
+
Returns undefined | string
+
+ -
+
+ -
+
+ -
+
-
+
payloadManipulator: (body: Record<string, any>) => Record<string, any>
+++Manipulator for the payload.
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
body: Record<string, any>
+
+
Returns Record<string, any>
+
+ -
+
+ -
+
+ -
+
Returns UpdateRequestBuilderBase<EntityT>
+
+ -
+
Properties
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ Readonly entitySerializer
+
+
+ Readonly extractODataEtag
+
+
+
+
+ Type declaration
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
json: Record<string, any>
+
+
Returns undefined | string
+
+ -
+
+ -
+
Readonly oDataUri
+
+
+ Readonly payloadManipulator
+
+
+
+
+ Type declaration
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
body: Record<string, any>
+
+
Returns Record<string, any>
+
+ -
+
+ -
+
requestConfig
+
+
+ Accessors
+entity
+-
+
+
-
+
-
+
+
Returns EntityT
+
+
Methods
+addCustomHeaders
+ -
+
+
-
+
-
+
+ ++++
Add custom headers to the request. Existing headers will be overwritten.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs denoting additional custom headers.
+
+
Returns UpdateRequestBuilderBase<EntityT>
+The request builder itself, to facilitate method chaining.
+
+ -
+
addCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++
Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs denoting additional custom query parameters to be set in the request
+
+
Returns UpdateRequestBuilderBase<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
build
+-
+
+
+
-
+
-
+
+
Returns ODataRequest<ODataUpdateRequestConfig<EntityT>>
+
+ -
+
+
Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+
+ -
+
Optional options: (DestinationCachingOptions & ResilienceOptions) | (CachingOptions & ResilienceOptions)
+
+
Returns Promise<ODataRequest<ODataUpdateRequestConfig<EntityT>>>
+
+ -
+
Protected executeRequest
+ -
+
+
-
+
-
+
+ ++++
Executes the query.
+Parameters
+-
+
-
+
request: ODataRequest<ODataUpdateRequestConfig<EntityT>>
+++Request object to be executed
+
+
Returns Promise<EntityT>
+A promise resolving to the entity once it was updated
+
+ -
+
Protected getPayload
+ -
+
+
-
+
-
+
+
Returns Record<string, any>
+
+
ignoreVersionIdentifier
+ -
+
+
-
+
-
+
+ ++++
Instructs the request to force an overwrite of the entity by sending an 'If-Match: *' header instead of sending the ETag version identifier.
+Returns UpdateRequestBuilderBase<EntityT>
+this The request itself to ease chaining while executing the request
+
+
ignoredFields
+ -
+
+
+
-
+
-
+
+ ++++ +
Specifies entity fields to ignore by the update request.
+Parameters
+-
+
-
+
Rest ...fields: Selectable<EntityT>[]
+++Enumeration of the fields to be ignored
+
+
Returns UpdateRequestBuilderBase<EntityT>
+The entity itself, to facilitate method chaining
+
+ -
+
-
+
+
Parameters
+-
+
-
+
fields: Selectable<EntityT>[]
+
+
Returns UpdateRequestBuilderBase<EntityT>
+
+ -
+
Protected isEmptyObject
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
obj: any
+
+
Returns boolean
+
+ -
+
prepare
+-
+
+
-
+
-
+
+ + ++
Returns UpdateRequestBuilderBase<EntityT>
+the builder itself
+
+
relativeUrl
+ -
+
+
-
+
-
+
+ ++++
Create the relative url based on configuration of the given builder.
+Returns string
+The relative url for the request
+
+
replaceWholeEntityWithPut
+ -
+
+
-
+
-
+
+ ++++
Explicitly configure 'PUT' as the method of the update request. By default, only the properties that have changed compared to the last known remote state are sent using 'PATCH', while with 'PUT', the whole entity is sent.
+Returns UpdateRequestBuilderBase<EntityT>
+The entity itself, to facilitate method chaining
+
+
requiredFields
+ -
+
+
+
-
+
-
+
+ ++++ +
Specifies required entity keys for the update request.
+Parameters
+-
+
-
+
Rest ...fields: Selectable<EntityT>[]
+++Enumeration of the fields to be required
+
+
Returns UpdateRequestBuilderBase<EntityT>
+The entity itself, to facilitate method chaining
+
+ -
+
-
+
+
Parameters
+-
+
-
+
fields: Selectable<EntityT>[]
+
+
Returns UpdateRequestBuilderBase<EntityT>
+
+ -
+
setCustomServicePath
+ -
+
+
-
+
-
+
+ ++++
Replace the default service path with the given custom path. + In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/
+' and can be overwritten here. Parameters
+-
+
-
+
servicePath: string
+++Path to override the default with
+
+
Returns UpdateRequestBuilderBase<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
setIgnoredFields
+ -
+
+
+
-
+
-
+
+ ++++
Sets entity fields to ignore by the update request.
+Parameters
+-
+
-
+
Rest ...fields: Selectable<EntityT>[]
+++Enumeration of the fields to be ignored
+
+
Returns UpdateRequestBuilderBase<EntityT>
+The entity itself, to facilitate method chaining
+
+ -
+
-
+
+
Parameters
+-
+
-
+
fields: Selectable<EntityT>[]
+
+
Returns UpdateRequestBuilderBase<EntityT>
+
+ -
+
setRequiredFields
+ -
+
+
+
-
+
-
+
+ ++++
Sets required entity keys for the update request.
+Parameters
+-
+
-
+
Rest ...fields: Selectable<EntityT>[]
+++Enumeration of the fields to be required
+
+
Returns UpdateRequestBuilderBase<EntityT>
+The entity itself, to facilitate method chaining
+
+ -
+
-
+
+
Parameters
+-
+
-
+
fields: Selectable<EntityT>[]
+
+
Returns UpdateRequestBuilderBase<EntityT>
+
+ -
+
setVersionIdentifier
+ -
+
+
-
+
-
+
+ ++++
Sets ETag version identifier of the entity to update.
+Parameters
+-
+
-
+
etag: string
+++Custom ETag version identifier to be sent in the header of the request
+
+
Returns UpdateRequestBuilderBase<EntityT>
+The request itself to ease chaining while executing the request
+
+ -
+
url
+-
+
+
-
+
-
+
+ ++++
Create the url based on configuration of the given builder.
+Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++Destination to execute the request against
+
+ -
+
Optional options: (DestinationCachingOptions & ResilienceOptions) | (CachingOptions & ResilienceOptions)
+++Options to employ when fetching destinations.
+
+
Returns Promise<string>
+Promise resolving to the url for the request
+
+ -
+
withCustomHeaders
+ -
+
+
-
+
-
+
+ ++++ +
Add custom headers to the request.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs denoting additional custom headers
+
+
Returns UpdateRequestBuilderBase<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++ +
Add custom query parameters to the request.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs denoting additional custom query parameters to be set in the request
+
+
Returns UpdateRequestBuilderBase<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomServicePath
+ -
+
+
-
+
-
+
+ ++++ +
Replace the default service path with the given custom path. + In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/
+' and can be overwritten here. Parameters
+-
+
-
+
servicePath: string
+++Path to override the default with
+
+
Returns UpdateRequestBuilderBase<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomVersionIdentifier
+ -
+
+
-
+
-
+
+ ++++ +
Specifies a custom ETag version identifier of the entity to update.
+Parameters
+-
+
-
+
etag: string
+++Custom ETag version identifier to be sent in the header of the request
+
+
Returns UpdateRequestBuilderBase<EntityT>
+The request itself to ease chaining while executing the request
+
+ -
+
+
+
+
+
+ Class UpdateRequestBuilderV4<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_util.errorwithcause.html b/docs/api/1.36.1/classes/sap_cloud_sdk_util.errorwithcause.html
new file mode 100644
index 0000000000..ac341a5d45
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_util.errorwithcause.html
@@ -0,0 +1,404 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Readonly _entity
+
+
+
+
+
+ Readonly entity
+
+
+
+
+
+ Readonly extractOData
+
+
+
+
+
+ Readonly o
+
+
+
+
+
+ Readonly payload
+
+
+
+
+
+ request
+
+
+
+
+
+
+
+
+
+
+
+
+ add
+
+
+
+ add
+
+
+
+
+
+
+
+
+
+ Protected execute
+
+
+
+ Protected get
+
+
+
+ ignore
+
+
+
+ ignored
+
+
+
+ Protected is
+
+
+
+
+
+
+ relative
+
+
+
+ replace
+
+
+
+ required
+
+
+
+ set
+
+
+
+ set
+
+
+
+ set
+
+
+
+ set
+
+
+
+
+
+
+ with
+
+
+
+ with
+
+
+
+ with
+
+
+
+ with
+
+
+
+
+
+
+
+
+ Create OData query to update an entity.
+Type parameters
+-
+
-
+
EntityT: EntityV4
+++++Type of the entity to be updated
+
+
Hierarchy
+-
+
-
+ UpdateRequestBuilderBase<EntityT>
+
-
+
- + UpdateRequestBuilderV4 + +
+
Index
+
+
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+ +Accessors
+-
+
- entity +
Methods
+-
+
- add
Custom Headers
+ - add
Custom Query Parameters
+ - build +
- execute +
- execute
Request
+ - get
Payload
+ - ignore
Version Identifier
+ - ignored
Fields
+ - is
Empty Object
+ - prepare +
- relative
Url
+ - replace
Whole Entity With Put
+ - required
Fields
+ - set
Custom Service Path
+ - set
Ignored Fields
+ - set
Required Fields
+ - set
Version Identifier
+ - url +
- with
Custom Headers
+ - with
Custom Query Parameters
+ - with
Custom Service Path
+ - with
Custom Version Identifier
+
Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of UpdateRequestBuilder.
+Type parameters
+-
+
-
+
EntityT: EntityV4<EntityT>
+
+
Parameters
+-
+
-
+
_entityConstructor: Constructable<EntityT, unknown>
+++Constructor type of the entity to be updated
+
+ -
+
_entity: EntityT
+++Entity to be updated
+
+
Returns UpdateRequestBuilderV4<EntityT>
+
+ -
+
Properties
+Readonly _entity
+ + +Readonly _entityConstructor
+
+
+ Readonly entitySerializer
+
+
+ Readonly extractODataEtag
+
+
+
+
+ Type declaration
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
json: Record<string, any>
+
+
Returns undefined | string
+
+ -
+
+ -
+
Readonly oDataUri
+
+
+ Readonly payloadManipulator
+
+
+
+
+ Type declaration
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
body: Record<string, any>
+
+
Returns Record<string, any>
+
+ -
+
+ -
+
requestConfig
+
+
+ Accessors
+entity
+-
+
+
-
+
-
+
+
Returns EntityT
+
+
Methods
+addCustomHeaders
+ -
+
+
-
+
-
+
+ ++++
Add custom headers to the request. Existing headers will be overwritten.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs denoting additional custom headers.
+
+
Returns UpdateRequestBuilderV4<EntityT>
+The request builder itself, to facilitate method chaining.
+
+ -
+
addCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++
Add custom query parameters to the request. If a query parameter with the given name already exists it is overwritten.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs denoting additional custom query parameters to be set in the request
+
+
Returns UpdateRequestBuilderV4<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
build
+-
+
+
+
-
+
-
+
+
Returns ODataRequest<ODataUpdateRequestConfig<EntityT>>
+
+ -
+
+
Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+
+ -
+
Optional options: (DestinationCachingOptions & ResilienceOptions) | (CachingOptions & ResilienceOptions)
+
+
Returns Promise<ODataRequest<ODataUpdateRequestConfig<EntityT>>>
+
+ -
+
execute
+-
+
+
-
+
-
+
+ ++++
Executes the query.
+Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++Destination to execute the request against
+
+ -
+
Optional options: (DestinationAccessorOptions & DestinationCachingOptions & ResilienceOptions & VerifyJwtOptions) | (DestinationAccessorOptions & CachingOptions & ResilienceOptions & VerifyJwtOptions)
+++Options to employ when fetching destinations
+
+
Returns Promise<EntityT>
+A promise resolving to the entity once it was updated
+
+ -
+
Protected executeRequest
+ -
+
+
-
+
-
+
+ ++++
Executes the query.
+Parameters
+-
+
-
+
request: ODataRequest<ODataUpdateRequestConfig<EntityT>>
+++Request object to be executed
+
+
Returns Promise<EntityT>
+A promise resolving to the entity once it was updated
+
+ -
+
Protected getPayload
+ -
+
+
-
+
-
+
+
Returns Record<string, any>
+
+
ignoreVersionIdentifier
+ -
+
+
-
+
-
+
+ ++++
Instructs the request to force an overwrite of the entity by sending an 'If-Match: *' header instead of sending the ETag version identifier.
+Returns UpdateRequestBuilderV4<EntityT>
+this The request itself to ease chaining while executing the request
+
+
ignoredFields
+ -
+
+
+
-
+
-
+
+ ++++ +
Specifies entity fields to ignore by the update request.
+Parameters
+-
+
-
+
Rest ...fields: Selectable<EntityT>[]
+++Enumeration of the fields to be ignored
+
+
Returns UpdateRequestBuilderV4<EntityT>
+The entity itself, to facilitate method chaining
+
+ -
+
-
+
+
Parameters
+-
+
-
+
fields: Selectable<EntityT>[]
+
+
Returns UpdateRequestBuilderV4<EntityT>
+
+ -
+
Protected isEmptyObject
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
obj: any
+
+
Returns boolean
+
+ -
+
prepare
+-
+
+
-
+
-
+
+ + ++
Returns UpdateRequestBuilderV4<EntityT>
+the builder itself
+
+
relativeUrl
+ -
+
+
-
+
-
+
+ ++++
Create the relative url based on configuration of the given builder.
+Returns string
+The relative url for the request
+
+
replaceWholeEntityWithPut
+ -
+
+
-
+
-
+
+ ++++
Explicitly configure 'PUT' as the method of the update request. By default, only the properties that have changed compared to the last known remote state are sent using 'PATCH', while with 'PUT', the whole entity is sent.
+Returns UpdateRequestBuilderV4<EntityT>
+The entity itself, to facilitate method chaining
+
+
requiredFields
+ -
+
+
+
-
+
-
+
+ ++++ +
Specifies required entity keys for the update request.
+Parameters
+-
+
-
+
Rest ...fields: Selectable<EntityT>[]
+++Enumeration of the fields to be required
+
+
Returns UpdateRequestBuilderV4<EntityT>
+The entity itself, to facilitate method chaining
+
+ -
+
-
+
+
Parameters
+-
+
-
+
fields: Selectable<EntityT>[]
+
+
Returns UpdateRequestBuilderV4<EntityT>
+
+ -
+
setCustomServicePath
+ -
+
+
-
+
-
+
+ ++++
Replace the default service path with the given custom path. + In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/
+' and can be overwritten here. Parameters
+-
+
-
+
servicePath: string
+++Path to override the default with
+
+
Returns UpdateRequestBuilderV4<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
setIgnoredFields
+ -
+
+
+
-
+
-
+
+ ++++
Sets entity fields to ignore by the update request.
+Parameters
+-
+
-
+
Rest ...fields: Selectable<EntityT>[]
+++Enumeration of the fields to be ignored
+
+
Returns UpdateRequestBuilderV4<EntityT>
+The entity itself, to facilitate method chaining
+
+ -
+
-
+
+
Parameters
+-
+
-
+
fields: Selectable<EntityT>[]
+
+
Returns UpdateRequestBuilderV4<EntityT>
+
+ -
+
setRequiredFields
+ -
+
+
+
-
+
-
+
+ ++++
Sets required entity keys for the update request.
+Parameters
+-
+
-
+
Rest ...fields: Selectable<EntityT>[]
+++Enumeration of the fields to be required
+
+
Returns UpdateRequestBuilderV4<EntityT>
+The entity itself, to facilitate method chaining
+
+ -
+
-
+
+
Parameters
+-
+
-
+
fields: Selectable<EntityT>[]
+
+
Returns UpdateRequestBuilderV4<EntityT>
+
+ -
+
setVersionIdentifier
+ -
+
+
-
+
-
+
+ ++++
Sets ETag version identifier of the entity to update.
+Parameters
+-
+
-
+
etag: string
+++Custom ETag version identifier to be sent in the header of the request
+
+
Returns UpdateRequestBuilderV4<EntityT>
+The request itself to ease chaining while executing the request
+
+ -
+
url
+-
+
+
-
+
-
+
+ ++++
Create the url based on configuration of the given builder.
+Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++Destination to execute the request against
+
+ -
+
Optional options: (DestinationCachingOptions & ResilienceOptions) | (CachingOptions & ResilienceOptions)
+++Options to employ when fetching destinations.
+
+
Returns Promise<string>
+Promise resolving to the url for the request
+
+ -
+
withCustomHeaders
+ -
+
+
-
+
-
+
+ ++++ +
Add custom headers to the request.
+Parameters
+-
+
-
+
headers: Record<string, string>
+++Key-value pairs denoting additional custom headers
+
+
Returns UpdateRequestBuilderV4<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomQueryParameters
+ -
+
+
-
+
-
+
+ ++++ +
Add custom query parameters to the request.
+Parameters
+-
+
-
+
queryParameters: Record<string, string>
+++Key-value pairs denoting additional custom query parameters to be set in the request
+
+
Returns UpdateRequestBuilderV4<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomServicePath
+ -
+
+
-
+
-
+
+ ++++ +
Replace the default service path with the given custom path. + In case of the S/4HANA apis the servicePath defaults to '/sap/opu/odata/sap/
+' and can be overwritten here. Parameters
+-
+
-
+
servicePath: string
+++Path to override the default with
+
+
Returns UpdateRequestBuilderV4<EntityT>
+The request builder itself, to facilitate method chaining
+
+ -
+
withCustomVersionIdentifier
+ -
+
+
-
+
-
+
+ ++++ +
Specifies a custom ETag version identifier of the entity to update.
+Parameters
+-
+
-
+
etag: string
+++Custom ETag version identifier to be sent in the header of the request
+
+
Returns UpdateRequestBuilderV4<EntityT>
+The request itself to ease chaining while executing the request
+
+ -
+
+
+
+
+
+ Class ErrorWithCause
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/classes/sap_cloud_sdk_util.uniquenamegenerator.html b/docs/api/1.36.1/classes/sap_cloud_sdk_util.uniquenamegenerator.html
new file mode 100644
index 0000000000..4f394203cf
--- /dev/null
+++ b/docs/api/1.36.1/classes/sap_cloud_sdk_util.uniquenamegenerator.html
@@ -0,0 +1,455 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Optional prepare
+
+
+
+
+
+
+
+
+ stack
+
+
+
+
+
+
+
+ root
+
+
+
+
+
+ capture
+
+
+
+
+
+
+
+
+ Represents an error that was caused by another error.
+Hierarchy
+-
+
-
+ Error
+
-
+
- + ErrorWithCause + +
+
Index
+
+
+
+
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Properties
+-
+
- cause +
- message +
- name +
- prepare
Stack Trace
+ - stack +
- stack
Trace Limit
+
Accessors
+-
+
- root
Cause
+
Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Create an instance of ErrorWithCause.
+Parameters
+-
+
-
+
message: string
+++Error message.
+
+ -
+
cause: Error
+++Original error, causing this error.
+
+
Returns ErrorWithCause
+
+ -
+
Properties
+Readonly cause
+ + +message
+ + +name
+ + +Optional prepareStackTrace
+
+
+
+
+
+
+
+ Optional override for formatting stack traces
+Optional stack
+ + +stackTraceLimit
+
+
+ Accessors
+rootCause
+ -
+
+
-
+
-
+
+ ++++
Root cause of the error. + If there are multiple errors caused one by another, the root cause is the first error that occurred. + In case there is no root cause.
+Returns Error
+
+
Methods
+captureStackTrace
+ -
+
+
-
+
-
+
+ ++++
Create .stack property on a target object
+Parameters
+-
+
-
+
targetObject: Object
+
+ -
+
Optional constructorOpt: Function
+
+
Returns void
+
+ -
+
+
+
+
+
+ Class UniqueNameGenerator
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/enums/sap_cloud_sdk_core.destinationorigin.html b/docs/api/1.36.1/enums/sap_cloud_sdk_core.destinationorigin.html
new file mode 100644
index 0000000000..015756bf3b
--- /dev/null
+++ b/docs/api/1.36.1/enums/sap_cloud_sdk_core.destinationorigin.html
@@ -0,0 +1,199 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ add
+
+
+
+ generate
+
+
+
+ generate
+
+
+
+ generate
+
+
+
+ generate
+
+
+
+
+
+
+
+
+ Holds state on already used names and provides new names if there are naming conflicts.
+Hierarchy
+-
+
- + UniqueNameGenerator + +
Index
+
+
+
+
+
+
+ Constructors
+-
+
- constructor +
Methods
+ +Constructors
+constructor
+-
+
+
-
+
-
+
+ ++++
Creates an instance of UniqueNameGenerator.
+Parameters
+-
+
-
+
Optional indexSeparator: string
+++The separator to be used when adding an index.
+
+ -
+
Optional usedNames: readonly string[]
+++Sets the already used names considered in the finding process.
+
+
Returns UniqueNameGenerator
+
+ -
+
Methods
+addToUsedNames
+ -
+
+
-
+
-
+
+ ++++
Adds the name(s) to the already used names.
+Parameters
+-
+
-
+
Rest ...names: string[]
+++Names to be added
+
+
Returns void
+
+ -
+
generateAndSaveUniqueName
+ -
+
+
-
+
-
+
+ ++++
Generate a unique name by appending an index seperated by the indexSeparator if necessary, e. g. if
+MyNameis already takenMyName_1will be found by default. + The generated name is added to the used names. + If the name is already unique nothing is appended.Parameters
+-
+
-
+
name: string
+++The name to get a unique name from.
+
+ -
+
Optional caseSensitive: boolean
+++Whether to check the already used names in a case sensitive manner.
+
+
Returns string
+A unique name
+
+ -
+
generateAndSaveUniqueNamesWithSuffixes
+ -
+
+
-
+
-
+
+ ++++
Generate unique names by appending an index seperated by the indexSeparator if necessary, while respecting the given suffixes. + If the name is already unique nothing is appended. + The generated names are added to the used names. + Each given suffix is appended to the unique name in the result. + The resulting names are also checked for uniqueness. + All names in the result have the same number suffix. + Example: if
+MyNameandMyName_1MySuffixis already taken,[MyName_2, MyName_2MySuffix]will be generated by default.Parameters
+-
+
-
+
name: string
+++The name to get a unique name from
+
+ -
+
suffixes: string[]
+++Additional name of suffixes to be considered for the finding process, as well as the output.
+
+ -
+
Optional caseSensitive: boolean
+++Whether to check the already used names in a case sensitive manner.
+
+
Returns string[]
+A list of unique names. The length of this array is one plus the number of suffixes provided. The first entry corresponds to the given name.
+
+ -
+
generateUniqueName
+ -
+
+
-
+
-
+
+ ++++
Generate a unique name by appending an index seperated by the indexSeparator if necessary, e. g. if
+MyNameis already takenMyName_1will be found by default. + If the name is already unique nothing is appended.Parameters
+-
+
-
+
name: string
+++The name to get a unique name from.
+
+ -
+
Optional caseSensitive: boolean
+++Whether to check the already used names in a case sensitive manner.
+
+
Returns string
+A unique name
+
+ -
+
generateUniqueNamesWithSuffixes
+ -
+
+
-
+
-
+
+ ++++
Generate unique names by appending an index seperated by the indexSeparator if necessary, while respecting the given suffixes. + If the name is already unique nothing is appended. + Each given suffix is appended to the unique name in the result. + The resulting names are also checked for uniqueness. + All names in the result have the same number suffix. + Example: if
+MyNameandMyName_1MySuffixis already taken,[MyName_2, MyName_2MySuffix]will be generated by default.Parameters
+-
+
-
+
name: string
+++The name to get a unique name from
+
+ -
+
suffixes: string[]
+++Additional name of suffixes to be considered for the finding process, as well as the output.
+
+ -
+
Optional caseSensitive: boolean
+++Whether to check the already used names in a case sensitive manner.
+
+
Returns string[]
+A list of unique names. The length of this array is one plus the number of suffixes provided. The first entry corresponds to the given name.
+
+ -
+
+
+
+
+
+ Enumeration DestinationOrigin
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/enums/sap_cloud_sdk_core.destinationtype.html b/docs/api/1.36.1/enums/sap_cloud_sdk_core.destinationtype.html
new file mode 100644
index 0000000000..330b65740c
--- /dev/null
+++ b/docs/api/1.36.1/enums/sap_cloud_sdk_core.destinationtype.html
@@ -0,0 +1,196 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Enumeration members
+-
+
- Provider +
- Subscriber +
Enumeration members
+Provider
+ + +Subscriber
+ + +
+
+
+
+
+ Enumeration DestinationType
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/enums/sap_cloud_sdk_core.httpmethod.html b/docs/api/1.36.1/enums/sap_cloud_sdk_core.httpmethod.html
new file mode 100644
index 0000000000..902be41cdd
--- /dev/null
+++ b/docs/api/1.36.1/enums/sap_cloud_sdk_core.httpmethod.html
@@ -0,0 +1,267 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ The destinations endpoint distinguished between destinations maintained on service level (instance) and account level (subaccount). + This enum is used as a switch in the fetchInstanceDestinations, fetchSubaccountDestinations and destinationServiceCache
+Index
+
+
+
+
+ Enumeration members
+-
+
- Instance +
- Subaccount +
Enumeration members
+Instance
+ + +Subaccount
+ + +
+
+
+
+
+ Enumeration HttpMethod
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/enums/sap_cloud_sdk_core.isolationstrategy.html b/docs/api/1.36.1/enums/sap_cloud_sdk_core.isolationstrategy.html
new file mode 100644
index 0000000000..8aeb0a5a7c
--- /dev/null
+++ b/docs/api/1.36.1/enums/sap_cloud_sdk_core.isolationstrategy.html
@@ -0,0 +1,223 @@
+
+
+
+
+
+
+
+
+
+
+ Enumeration IsolationStrategy
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/enums/sap_cloud_sdk_core.protocol-1.html b/docs/api/1.36.1/enums/sap_cloud_sdk_core.protocol-1.html
new file mode 100644
index 0000000000..cccd2c85d5
--- /dev/null
+++ b/docs/api/1.36.1/enums/sap_cloud_sdk_core.protocol-1.html
@@ -0,0 +1,188 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ No_
+
+
+
+
+
+
+
+
+ Tenant_
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Enumerator that selects the isolation type of destination in cache.
+Index
+
+
+
+
+ Enumeration members
+-
+
- No_
Isolation
+ - Tenant +
- Tenant_
User
+ - User +
Enumeration members
+No_Isolation
+
+
+ Tenant
+ + +Tenant_User
+
+
+ User
+ + +
+
+
+
+
+ Enumeration Protocol
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/enums/sap_cloud_sdk_core.proxystrategy.html b/docs/api/1.36.1/enums/sap_cloud_sdk_core.proxystrategy.html
new file mode 100644
index 0000000000..a91164767c
--- /dev/null
+++ b/docs/api/1.36.1/enums/sap_cloud_sdk_core.proxystrategy.html
@@ -0,0 +1,210 @@
+
+
+
+
+
+
+
+
+
+
+ Enumeration ProxyStrategy
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/index.html b/docs/api/1.36.1/index.html
new file mode 100644
index 0000000000..16b1879618
--- /dev/null
+++ b/docs/api/1.36.1/index.html
@@ -0,0 +1,145 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ INTERNET_
+
+
+
+
+
+ NO_
+
+
+
+
+
+ ON_
+
+
+
+
+
+
+
+
+
+
+ Enum representing the different strategies for proxying request. Possible situations are "NO_PROXY", use the connectivity service proxy for On-Premise connection or a usual web proxy. + See also ProxyConfiguration for more details.
+Index
+
+
+
+
+ Enumeration members
+-
+
- INTERNET_
PROXY
+ - NO_
PROXY
+ - ON_
PREMISE_ PROXY
+
Enumeration members
+INTERNET_PROXY
+
+
+ NO_PROXY
+
+
+ ON_PREMISE_PROXY
+
+
+
+
+
+
+ SAP Cloud SDK for JavaScript / TypeScript - v1.36.1
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.authandexchangetokens.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.authandexchangetokens.html
new file mode 100644
index 0000000000..5821599d39
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.authandexchangetokens.html
@@ -0,0 +1,197 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Version: 1.36.1
+ +The SAP Cloud SDK for JavaScript and TypeScript consists of multiple libraries to enable you to write side-by-side extensions on SAP Cloud Platform.
+You can find tutorials that showcase some of the typical use cases on developers.sap.com.
+ If you have questions, you can reach out to us on StackOverflow using the tag sap-cloud-sdk and on answers.sap.com using the tag SAP Cloud SDK.
+ Also, you can browse our release notes to check out what's new in each version.
More Helpful Links
+ + +
+
+
+
+
+ Interface AuthAndExchangeTokens
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.cachingoptions.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.cachingoptions.html
new file mode 100644
index 0000000000..1dc0d52c75
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.cachingoptions.html
@@ -0,0 +1,208 @@
+
+
+
+
+
+
+
+
+
+
+ Interface CachingOptions
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.clientcredentials.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.clientcredentials.html
new file mode 100644
index 0000000000..4333888ca0
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.clientcredentials.html
@@ -0,0 +1,197 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Optional isolation
+
+
+
+
+
+ Optional use
+
+
+
+
+
+
+ Hierarchy
+-
+
- + CachingOptions + +
Index
+
+
+
+
+ Properties
+-
+
- isolation
Strategy
+ - use
Cache
+
Properties
+Optional isolationStrategy
+
+
+
+
+
+
+ The isolation strategy used for caching destinations. For the available options, see IsolationStrategy. + By default, IsolationStrategy.Tenant is set.
+Optional useCache
+
+
+
+
+
+
+ A boolean value that indicates whether to read destinations from cache.
+
+
+
+
+
+ Interface ClientCredentials
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.completedecodedjwt.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.completedecodedjwt.html
new file mode 100644
index 0000000000..806fb4098b
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.completedecodedjwt.html
@@ -0,0 +1,447 @@
+
+
+
+
+
+
+
+
+
+
+ Interface CompleteDecodedJWT
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.complextypenamespace.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.complextypenamespace.html
new file mode 100644
index 0000000000..1f02a2bfb1
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.complextypenamespace.html
@@ -0,0 +1,191 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Optional family_
+
+
+
+
+
+ Optional given_
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Optional user_
+
+
+
+
+
+ Optional user_
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Interface to represent header and payload of a JWT.
+Hierarchy
+-
+
-
+ RegisteredJWTClaims
+
-
+
- + CompleteDecodedJWT + +
+
Index
+Properties
+Optional aud
+ + +Optional email
+ + +Optional exp
+ + +Optional family_name
+
+
+ Optional given_name
+
+
+ header
+ + +Optional iat
+ + +Optional iss
+ + +Optional jti
+ + +Optional nbf
+ + +payload
+ + +Optional scope
+ + +signature
+ + +Optional sub
+ + +Optional user_id
+
+
+ Optional user_name
+
+
+ Optional xs.user.attributes
+ + +Optional zdn
+ + +Optional zid
+ + +
+
+
+
+
+ Interface ComplexTypeNamespace<ComplexT>
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.decodedjwt.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.decodedjwt.html
new file mode 100644
index 0000000000..dc8078f79f
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.decodedjwt.html
@@ -0,0 +1,412 @@
+
+
+
+
+
+
+
+
+
+
+ Interface DecodedJWT
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.destination.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.destination.html
new file mode 100644
index 0000000000..5a1bb0a9cd
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.destination.html
@@ -0,0 +1,640 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Optional family_
+
+
+
+
+
+ Optional given_
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Optional user_
+
+
+
+
+
+ Optional user_
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Hierarchy
+-
+
-
+ RegisteredJWTClaims
+
-
+
- + DecodedJWT + +
+
Indexable
+ +Index
+Properties
+Optional aud
+ + +Optional email
+ + +Optional exp
+ + +Optional family_name
+
+
+ Optional given_name
+
+
+ Optional iat
+ + +Optional iss
+ + +Optional jti
+ + +Optional nbf
+ + +Optional scope
+ + +Optional sub
+ + +Optional user_id
+
+
+ Optional user_name
+
+
+ Optional xs.user.attributes
+ + +Optional zdn
+ + +Optional zid
+ + +
+
+
+
+
+ Interface Destination
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.destinationaccessoroptions.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.destinationaccessoroptions.html
new file mode 100644
index 0000000000..3e7431713f
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.destinationaccessoroptions.html
@@ -0,0 +1,230 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Optional auth
+
+
+
+
+
+
+
+
+
+
+
+ Optional client
+
+
+
+
+
+ Optional client
+
+
+
+
+
+ Optional cloud
+
+
+
+
+
+ Optional is
+
+
+
+
+
+ Optional is
+
+
+
+
+
+ Optional key
+
+
+
+
+
+ Optional key
+
+
+
+
+
+
+
+
+
+
+
+ Optional original
+
+
+
+
+
+
+
+
+ Optional proxy
+
+
+
+
+
+ Optional proxy
+
+
+
+
+
+ Optional sap
+
+
+
+
+
+ Optional system
+
+
+
+
+
+ Optional token
+
+
+
+
+
+ Optional token
+
+
+
+
+
+ Optional token
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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 Cloud Platform (via DestinationNameAndJwt). + 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.
+Hierarchy
+-
+
- + Destination + +
Index
+
+
+
+
+ Properties
+-
+
- auth
Tokens
+ - authentication +
- certificates +
- client
Id
+ - client
Secret
+ - cloud
Connector Location Id
+ - is
Test Destination
+ - is
Trusting All Certificates
+ - key
Store Name
+ - key
Store Password
+ - name +
- origin +
- original
Properties
+ - password +
- proxy
Configuration
+ - proxy
Type
+ - sap
Client
+ - system
User
+ - token
Service Password
+ - token
Service Url
+ - token
Service User
+ - type +
- url +
- username +
Properties
+Optional authTokens
+
+
+
+
+
+
+ Authentication tokens returned from destination service on SAP Cloud Platform, optional.
+Optional authentication
+ + + +Optional certificates
+ + +
+
+
+
+ Array of certificates used for authentication type ClientCertificateAuthentication.
+Optional clientId
+
+
+
+
+
+
+ Client Id used to retrieve access token for "OAuth2ClientCredentials" authentication.
+Optional clientSecret
+
+
+
+
+
+
+ Client Secret used to retrieve access token for "OAuth2ClientCredentials" authentication.
+Optional cloudConnectorLocationId
+
+
+
+
+
+
+ Location ID of the Cloud Connector to be used for connection to an On-Premise system. Optional. Corresponds to property "CloudConnectorLocationId" in the additional properties of a destination.
+Optional isTestDestination
+
+
+
+
+
+
+ Flag indicating whether the destination is for test purpose. Should be "undefined" or "false" for non-mocked destinations.
+Optional isTrustingAllCertificates
+
+
+
+
+
+
+ Flag indicating whether all certificates should be accepted when communicating with the destination. Should not be "true" in production.
+Optional keyStoreName
+
+
+
+
+
+
+ Name of the key store/certificate to be used for ClientCertificateAuthentication.
+Optional keyStorePassword
+
+
+
+
+
+
+ Password of the key store/certificate to be used for ClientCertificateAuthentication.
+Optional name
+ + +
+
+
+
+ Name of the destination retrieved from SAP Cloud Platform, optional.
+Optional origin
+ + +
+
+
+ Optional originalProperties
+
+
+
+
+
+
+ Further properties of the destination as defined in destination service on SAP Cloud Platform, possibly empty.
+Optional password
+ + +
+
+
+
+ Password to use for basic authentication, optional if other means of authentication shall be used.
+Optional proxyConfiguration
+
+
+
+
+
+
+ ProxyConfiguration for on-premise connectivity and http(s) web proxies. Is present if proxyType of the destination equals "OnPremise" or environment variables [http_proxy] or [https_proxy] are set See ProxyConfiguration.
+Optional proxyType
+
+
+
+
+
+
+ Proxy type to specify whether the target resides on-premise, optional, not used.
+Optional sapClient
+
+
+
+
+
+
+ Client to target in an SAP system, will be added as HTTP header sap-client if set, optional.
Optional systemUser
+
+
+
+
+
+
+ System user to be used for OAuth2SAMLBearerAssertion authentication type.
+Optional tokenServicePassword
+
+
+
+
+
+
+ Password for tokenServiceUser (if required).
+Optional tokenServiceUrl
+
+
+
+
+
+
+ URL to retrieve access token for "OAuth2ClientCredentials" authentication.
+Optional tokenServiceUser
+
+
+
+
+
+
+ User for basic authentication to OAuth server (if required).
+Optional type
+ + +
+
+
+
+ The type of the destination, defaults to 'HTTP'. The SAP Cloud SDK only understands destinations of type 'HTTP'.
+url
+ + +
+
+
+
+ Base URL for calls to this destination, mandatory.
+The URL needs to define at least scheme (protocol like http:// or https://) and host.
+ The path for requests against this destination will be appended to the path defined in the URL as a new path segment.
Optional username
+ + +
+
+
+
+ Username to use for basic authentication, optional if other means of authentication shall be used.
+
+
+
+
+
+ Interface DestinationAccessorOptions
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.destinationauthtoken.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.destinationauthtoken.html
new file mode 100644
index 0000000000..f955278225
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.destinationauthtoken.html
@@ -0,0 +1,257 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Optional selection
+
+
+
+
+
+ Optional user
+
+
+
+
+
+
+ Hierarchy
+-
+
- + DestinationAccessorOptions + +
Index
+
+
+
+
+ Properties
+-
+
- iss +
- selection
Strategy
+ - user
Jwt
+
Properties
+Optional iss
+ + +
+
+
+
+ This property is only considered in case no userJwt is provided.
+ It is meant for situations where you do not have a token e.g. background processes.
+ The value for iss is the issuer field of a JWT e.g. https://
ATTENTION: If this property is used, no validation of the provided subdomain value is done. This is differs from how the userJwt is handled.
+ So be careful that the used value is not manipulated and breaks the tenant isolation of your application.
Optional selectionStrategy
+
+
+
+
+
+
+ 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.
+Optional userJwt
+
+
+
+
+
+
+ The user token of the current request.
+
+
+
+
+
+ Interface DestinationAuthToken
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.destinationcachingoptions.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.destinationcachingoptions.html
new file mode 100644
index 0000000000..c351595b22
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.destinationcachingoptions.html
@@ -0,0 +1,217 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ expires
+
+
+
+
+
+ http_
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Represents authentication token returned from destination service.
+Hierarchy
+-
+
- + DestinationAuthToken + +
Index
+
+
+
+
+ Properties
+-
+
- error +
- expires
In
+ - http_
header
+ - type +
- value +
Properties
+error
+ + +expiresIn
+
+
+ http_header
+
+
+
+
+ Type declaration
+-
+
-
+
key: string
+
+ -
+
value: string
+
+
type
+ + +value
+ + +
+
+
+
+
+ Interface DestinationCachingOptions
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.destinationcertificate.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.destinationcertificate.html
new file mode 100644
index 0000000000..1b0418505e
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.destinationcertificate.html
@@ -0,0 +1,233 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Optional isolation
+
+
+
+
+
+ Optional use
+
+
+
+
+
+
+
+
+
+ Hierarchy
+-
+
- + DestinationCachingOptions + +
Index
+
+
+
+
+ Properties
+-
+
- isolation
Strategy
+ - use
Cache
+
Properties
+Optional isolationStrategy
+
+
+
+
+
+
+ The isolation strategy used for caching destinations. For the available options, see IsolationStrategy. + By default, IsolationStrategy.Tenant is set.
+Optional useCache
+
+
+
+
+
+
+ A boolean value that indicates whether to read destinations from cache.
+
+
+
+
+
+ Interface DestinationCertificate
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.destinationconfiguration.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.destinationconfiguration.html
new file mode 100644
index 0000000000..c6757af863
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.destinationconfiguration.html
@@ -0,0 +1,395 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Represents a certificate attached to a destination.
+Hierarchy
+-
+
- + DestinationCertificate + +
Index
+Properties
+content
+ + +
+
+
+
+ Content of the certificate as base64 encoded binary.
+name
+ + +
+
+
+
+ Name of the certificate file.
+type
+ + +
+
+
+
+ Type of the certificate.
+
+
+
+
+
+ Interface DestinationConfiguration
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.destinationforservicebindingsoptions.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.destinationforservicebindingsoptions.html
new file mode 100644
index 0000000000..2bdb39d5f5
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.destinationforservicebindingsoptions.html
@@ -0,0 +1,195 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Optional Proxy
+
+
+
+
+
+ Optional System
+
+
+
+
+
+ Optional Trust
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Optional client
+
+
+
+
+
+ Optional client
+
+
+
+
+
+ Optional sap-
+
+
+
+
+
+ Optional token
+
+
+
+
+
+ Optional token
+
+
+
+
+
+ Optional token
+
+
+
+
+
+
+
+
+
+
+ Configuration of a destination as it is available through the destination service.
+Hierarchy
+-
+
- + DestinationConfiguration + +
Indexable
+ +
+
+
+
+ Configuration of a destination as it is available through the destination service.
+Index
+
+
+
+
+ Properties
+-
+
- Authentication +
- Name +
- Password +
- Proxy
Type
+ - System
User
+ - Trust
All
+ - Type +
- URL +
- User +
- client
Id
+ - client
Secret
+ - sap-
client
+ - token
Service Pass
+ - token
ServiceURL
+ - token
Service Username
+
Properties
+Optional Authentication
+ + +Optional Name
+ + +Optional Password
+ + +Optional ProxyType
+
+
+ Optional SystemUser
+
+
+ Optional TrustAll
+
+
+ Optional Type
+ + +URL
+ + +Optional User
+ + +Optional clientId
+
+
+ Optional clientSecret
+
+
+ Optional sap-client
+
+
+ Optional tokenServicePass
+
+
+ Optional tokenServiceURL
+
+
+ Optional tokenServiceUsername
+
+
+
+
+
+
+
+ Interface DestinationForServiceBindingsOptions
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.destinationhttprequestconfig.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.destinationhttprequestconfig.html
new file mode 100644
index 0000000000..19079e7565
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.destinationhttprequestconfig.html
@@ -0,0 +1,225 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Optional transformation
+
+
+
+
+
+
+
+
+
+
+ Options to customize the behavior of destinationForServiceBinding.
+Hierarchy
+-
+
- + DestinationForServiceBindingsOptions + +
Index
+
+
+
+
+ Properties
+-
+
- transformation
Fn
+
Properties
+Optional transformationFn
+
+
+
+
+
+
+ Custom transformation function to control how a Destination is built from the given ServiceBinding.
+
+
+
+
+
+ Interface DestinationHttpRequestConfig
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.destinationjson.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.destinationjson.html
new file mode 100644
index 0000000000..ec0c812818
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.destinationjson.html
@@ -0,0 +1,227 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Optional http
+
+
+
+
+
+ Optional https
+
+
+
+
+
+
+ Hierarchy
+-
+
- + DestinationHttpRequestConfig + +
Index
+
+
+
+
+ Properties
+-
+
- baseURL +
- headers +
- http
Agent
+ - https
Agent
+
Properties
+baseURL
+ + +headers
+ + +Optional httpAgent
+
+
+ Optional httpsAgent
+
+
+
+
+
+
+
+ Interface DestinationJson
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.destinationnameandjwt.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.destinationnameandjwt.html
new file mode 100644
index 0000000000..068538d6c2
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.destinationnameandjwt.html
@@ -0,0 +1,220 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Optional auth
+
+
+
+
+
+
+
+
+ destination
+
+
+
+
+
+
+
+
+
+
+ Destination configuration alongside authtokens and certificates.
+Hierarchy
+-
+
- + DestinationJson + +
Indexable
+ +
+
+
+
+ Destination configuration alongside authtokens and certificates.
+Index
+
+
+
+
+ Properties
+ +Properties
+Optional authTokens
+
+
+ Optional certificates
+ + +destinationConfiguration
+
+
+
+
+
+
+
+ Interface DestinationNameAndJwt
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.destinationservicecredentials.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.destinationservicecredentials.html
new file mode 100644
index 0000000000..536a0c4a3b
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.destinationservicecredentials.html
@@ -0,0 +1,330 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ destination
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Declaration of a destination to be retrieved from an environment variable or from the destination service on SAP Cloud Platform.
+Use an object of this interface to specify which destination shall be used when executing a request. + The destination will be retrieved via its DestinationNameAndJwt.destinationName according to the following algorithm:
+-
+
- If a destination of this DestinationNameAndJwt.destinationName is defined in the environment variable
destinations(if available), it will be converted into a Destination and used for the request.
+ - Otherwise, the destination service on SAP Cloud Platform is queried for a destination with the given DestinationNameAndJwt.destinationName, using the access token provided as value of property jwt. +
Hierarchy
+-
+
- + DestinationNameAndJwt + +
Index
+
+
+
+
+ Properties
+-
+
- destination
Name
+ - jwt +
Properties
+destinationName
+
+
+
+
+
+
+ Name of the destination to retrieve, mandatory.
+Optional jwt
+ + +
+
+
+
+ An access token for the XSUAA service on SAP Cloud Platform, provided as a JSON Web Token, only mandatory when destination shall be retrieved from destination service on SAP Cloud Platform.
+
+
+
+
+
+ Interface DestinationServiceCredentials
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.entitydeserializer.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.entitydeserializer.html
new file mode 100644
index 0000000000..0b84152cf4
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.entitydeserializer.html
@@ -0,0 +1,263 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Credentials for the Destination service.
+Hierarchy
+-
+
- + DestinationServiceCredentials + +
Index
+
+
+
+
+ Properties
+-
+
- clientid +
- clientsecret +
- identityzone +
- instanceid +
- tenantid +
- tenantmode +
- uaadomain +
- uri +
- url +
- verificationkey +
- xsappname +
Properties
+clientid
+ + +clientsecret
+ + +identityzone
+ + +instanceid
+ + +tenantid
+ + +tenantmode
+ + +uaadomain
+ + +uri
+ + +url
+ + +verificationkey
+ + +xsappname
+ + +
+
+
+
+
+ Interface EntityDeserializer<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.entityserializer.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.entityserializer.html
new file mode 100644
index 0000000000..807390f35c
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.entityserializer.html
@@ -0,0 +1,304 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ deserialize
+
+
+
+
+
+ deserialize
+
+
+
+
+
+
+
+
+
+
+ Interface representing the return type of the builder function entityDeserializer
+Type parameters
+-
+
-
+
EntityT: EntityBase = any
+
+
Hierarchy
+-
+
- + EntityDeserializer + +
Index
+
+
+
+
+ Properties
+ +Properties
+deserializeComplexType
+
+
+
+
+ Type declaration
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
json: Record<string, any>
+
+ -
+
complexType: ComplexTypeNamespace<any>
+
+
Returns any
+
+ -
+
+ -
+
deserializeEntity
+
+
+
+
+ Type declaration
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
json: any
+
+ -
+
entityConstructor: Constructable<EntityT, unknown>
+
+ -
+
Optional requestHeader: any
+
+
Returns EntityT
+
+ -
+
+ -
+
+
+
+
+
+ Interface EntitySerializer<EntityT, ComplexTypeNamespaceT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.errorresponse.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.errorresponse.html
new file mode 100644
index 0000000000..e2adf5881e
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.errorresponse.html
@@ -0,0 +1,226 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ serialize
+
+
+
+
+
+ serialize
+
+
+
+
+
+ serialize
+
+
+
+
+
+
+
+
+
+
+ Interface representing the return type of the builder function entitySerializer.
+Type parameters
+-
+
-
+
EntityT: EntityBase = any
+
+ -
+
ComplexTypeNamespaceT: ComplexTypeNamespace<any> = any
+
+
Hierarchy
+-
+
- + EntitySerializer + +
Index
+
+
+
+
+ Properties
+ +Properties
+serializeComplexType
+
+
+
+
+ Type declaration
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
fieldValue: any
+
+ -
+
complexTypeNameSpace: ComplexTypeNamespaceT
+
+
Returns any
+
+ -
+
+ -
+
serializeEntity
+
+
+
+
+ Type declaration
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
entity: EntityT
+
+ -
+
entityConstructor: Constructable<EntityT, unknown>
+
+ -
+
Optional diff: boolean
+
+
Returns Record<string, any>
+
+ -
+
+ -
+
serializeEntityNonCustomFields
+
+
+
+
+ Type declaration
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
entity: EntityT
+
+ -
+
entityConstructor: Constructable<EntityT, unknown>
+
+
Returns Record<string, any>
+
+ -
+
+ -
+
+
+
+
+
+ Interface ErrorResponse
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.getfilter.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.getfilter.html
new file mode 100644
index 0000000000..eb04fd0389
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.getfilter.html
@@ -0,0 +1,198 @@
+
+
+
+
+
+
+
+
+
+
+ Interface GetFilter<EntityT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.httpagentconfig.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.httpagentconfig.html
new file mode 100644
index 0000000000..f35a15ea93
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.httpagentconfig.html
@@ -0,0 +1,190 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ get
+
+
+
+
+
+
+
+
+
+
+ Interface representing the return of the getFilter creator createGetFilter.
+Type parameters
+-
+
-
+
EntityT: EntityBase = any
+
+
Hierarchy
+-
+
- + GetFilter + +
Index
+
+
+
+
+ Properties
+-
+
- get
Filter
+
Properties
+getFilter
+
+
+
+
+
+
+
+ Interface HttpAgentConfig
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.httpreponse.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.httpreponse.html
new file mode 100644
index 0000000000..f572fc9921
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.httpreponse.html
@@ -0,0 +1,229 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ http
+
+
+
+
+
+
+
+
+
+
+ Interface for the http-agent within the Axios request config.
+Hierarchy
+-
+
- + HttpAgentConfig + +
Index
+
+
+
+
+ Properties
+-
+
- http
Agent
+
Properties
+httpAgent
+
+
+
+
+
+
+
+ Interface HttpReponse
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.httprequestconfig.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.httprequestconfig.html
new file mode 100644
index 0000000000..e9b4527de3
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.httprequestconfig.html
@@ -0,0 +1,316 @@
+
+
+
+
+
+
+
+
+
+
+ Interface HttpRequestConfig
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.httpresponse.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.httpresponse.html
new file mode 100644
index 0000000000..c71b3b39ff
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.httpresponse.html
@@ -0,0 +1,220 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Optional http
+
+
+
+
+
+ Optional https
+
+
+
+
+
+ Optional max
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ This interface is compatible with AxiosRequestConfig.
+Hierarchy
+-
+
- + HttpRequestConfig + +
Index
+
+
+
+
+ Properties
+-
+
- data +
- headers +
- http
Agent
+ - https
Agent
+ - max
Content Length
+ - method +
- params +
- proxy +
- timeout +
- url +
Properties
+Optional data
+ + +Optional headers
+ + +Optional httpAgent
+
+
+ Optional httpsAgent
+
+
+ Optional maxContentLength
+
+
+ method
+ + +Optional params
+ + +Optional proxy
+ + +Optional timeout
+ + +Optional url
+ + +
+
+
+
+
+ Interface HttpResponse
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.httpsagentconfig.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.httpsagentconfig.html
new file mode 100644
index 0000000000..1d1a020761
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.httpsagentconfig.html
@@ -0,0 +1,190 @@
+
+
+
+
+
+
+
+
+
+
+ Interface HttpsAgentConfig
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.jwtheader.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.jwtheader.html
new file mode 100644
index 0000000000..015235f9e7
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.jwtheader.html
@@ -0,0 +1,218 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ https
+
+
+
+
+
+
+
+
+
+
+ Interface for the https-agent within the Axios request config.
+Hierarchy
+-
+
- + HttpsAgentConfig + +
Index
+
+
+
+
+ Properties
+-
+
- https
Agent
+
Properties
+httpsAgent
+
+
+
+
+
+
+
+ Interface JWTHeader
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.jwtpayload.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.jwtpayload.html
new file mode 100644
index 0000000000..1d54c534a0
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.jwtpayload.html
@@ -0,0 +1,414 @@
+
+
+
+
+
+
+
+
+
+
+ Interface JWTPayload
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.odatauri.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.odatauri.html
new file mode 100644
index 0000000000..481025e426
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.odatauri.html
@@ -0,0 +1,420 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Optional family_
+
+
+
+
+
+ Optional given_
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Optional user_
+
+
+
+
+
+ Optional user_
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Interface to represent the payload of a JWT.
+Hierarchy
+-
+
-
+ RegisteredJWTClaims
+
-
+
- + JWTPayload + +
+
Indexable
+ +
+
+
+
+ Interface to represent the payload of a JWT.
+Index
+Properties
+Optional aud
+ + +Optional email
+ + +Optional exp
+ + +Optional family_name
+
+
+ Optional given_name
+
+
+ Optional iat
+ + +Optional iss
+ + +Optional jti
+ + +Optional nbf
+ + +Optional scope
+ + +Optional sub
+ + +Optional user_id
+
+
+ Optional user_name
+
+
+ Optional xs.user.attributes
+ + +Optional zdn
+ + +Optional zid
+ + +
+
+
+
+
+ Interface ODataUri
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.propertymetadata.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.propertymetadata.html
new file mode 100644
index 0000000000..e38c4d314c
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.propertymetadata.html
@@ -0,0 +1,233 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ convert
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+
+
+
+
+
+ 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.
+Hierarchy
+-
+
- + ODataUri + +
Index
+
+
+
+
+ Methods
+ +Methods
+convertToUriFormat
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
value: any
+
+ -
+
edmType: EdmTypeShared<VersionT>
+
+
Returns string
+
+ -
+
getEntityKeys
+ -
+
+
-
+
-
+
+
Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
entity: EntityT
+
+ -
+
entityConstructor: Constructable<EntityT, unknown>
+
+
Returns Record<string, any>
+
+ -
+
getExpand
+ -
+
+
-
+
-
+
+
Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
selects: Selectable<EntityT>[]
+
+ -
+
expands: Expandable<EntityT>[]
+
+ -
+
entityConstructor: Constructable<EntityT, unknown>
+
+
Returns Partial<{ expand: string }>
+
+ -
+
getFilter
+ -
+
+
-
+
-
+
+
Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
filter: Filterable<EntityT>
+
+ -
+
entityConstructor: Constructable<EntityT, unknown>
+
+
Returns Partial<{ filter: string }>
+
+ -
+
getOrderBy
+ -
+
+
-
+
-
+
+
Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
orderBy: Orderable<EntityT>[]
+
+
Returns Partial<{ orderby: string }>
+
+ -
+
getResourcePathForKeys
+ -
+
+
-
+
-
+
+
Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
keys: Record<string, FieldType>
+
+ -
+
entityConstructor: Constructable<EntityT, unknown>
+
+
Returns string
+
+ -
+
getSelect
+ -
+
+
-
+
-
+
+
Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
selects: Selectable<EntityT>[]
+
+
Returns Partial<{ select: string }>
+
+ -
+
+
+
+
+
+ Interface PropertyMetadata<ComplexT>
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.proxyconfiguration.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.proxyconfiguration.html
new file mode 100644
index 0000000000..fd082386e6
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.proxyconfiguration.html
@@ -0,0 +1,264 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Optional is
+
+
+
+
+
+
+
+
+ original
+
+
+
+
+
+
+
+
+
+ Type parameters
+-
+
-
+
ComplexT = any
+
+
Hierarchy
+-
+
- + PropertyMetadata + +
Index
+
+
+
+
+ Properties
+-
+
- is
Collection
+ - name +
- original
Name
+ - type +
Properties
+Optional isCollection
+
+
+ name
+ + +originalName
+
+
+ type
+ + +
+
+
+
+
+ Interface ProxyConfiguration
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.readresponse.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.readresponse.html
new file mode 100644
index 0000000000..56f8acb9a9
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.readresponse.html
@@ -0,0 +1,281 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 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 follow:
+-
+
- If the destination has proxy type "OnPremise" the connectivity service proxy is used. +
- Depending on the protocol in the destination URL the proxy environment variables
http_proxyandhttps_proxyare considered.
+
Valid form for the variable is http://user:password@host:port where everything besides the host is optional. + For user and password non alphanumeric characters need to be percent-encoded. + Note: The [no_proxy] environment variables contains a list of URLs for which no proxy will be used even if [http_proxy, https_proxy] are set. + Wildcards like *.some.domain.com are not supported while checking the no_proxy env.
+Hierarchy
+-
+
- + ProxyConfiguration + +
Index
+Properties
+Optional headers
+ + +
+
+
+
+ HTTP headers to be added to a request if tunneled through the proxy. + If the request is going to an OnPremise system via the connectivity proxy, the header contains the 'Proxy-Authorization' and + the 'SAP-Connectivity-Authentication' header if a JWT is present on the current request. + For web proxies only the 'Proxy-Authorization' enter the header fields if provided.
+host
+ + +
+
+
+
+ The host of the proxy.
+port
+ + +
+
+
+
+ The port of the proxy.
+protocol
+ + +
+
+
+
+ The protocol used by the proxy
+
+
+
+
+
+ Interface ReadResponse
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.registeredjwtclaimsbasic.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.registeredjwtclaimsbasic.html
new file mode 100644
index 0000000000..16d8d3a56b
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.registeredjwtclaimsbasic.html
@@ -0,0 +1,274 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ http
+
+
+
+
+
+ is
+
+
+
+
+
+
+
+
+
+ Hierarchy
+-
+
- + ReadResponse + +
Index
+Properties
+as
+ + +
+
+ Type declaration
+-
+
-
+
-
+
+
-
+
-
+
Type parameters
+-
+
-
+
T: EntityBase<T>
+
+
Parameters
+-
+
-
+
constructor: Constructable<T, unknown>
+
+
Returns T[]
+
+ -
+
+ -
+
body
+ + +httpCode
+
+
+ isSuccess
+
+
+
+
+ Type declaration
+-
+
-
+
-
+
+
-
+
-
+
Returns boolean
+
+
+ -
+
type
+ + +
+
+
+
+
+ Interface RegisteredJWTClaimsBasic
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.registeredjwtclaimstenant.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.registeredjwtclaimstenant.html
new file mode 100644
index 0000000000..e8e902f7a8
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.registeredjwtclaimstenant.html
@@ -0,0 +1,204 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Interface to represent the basic properties like issuer, audience etc.
+Hierarchy
+-
+
- + RegisteredJWTClaimsBasic + +
Index
+Properties
+Optional aud
+ + +Optional exp
+ + +Optional iat
+ + +Optional iss
+ + +Optional jti
+ + +Optional nbf
+ + +Optional sub
+ + +
+
+
+
+
+ Interface RegisteredJWTClaimsTenant
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.registeredjwtclaimsuser.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.registeredjwtclaimsuser.html
new file mode 100644
index 0000000000..dab9d8e914
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.registeredjwtclaimsuser.html
@@ -0,0 +1,274 @@
+
+
+
+
+
+
+
+
+
+
+ Interface RegisteredJWTClaimsUser
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.resilienceoptions.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.resilienceoptions.html
new file mode 100644
index 0000000000..6f5df3301b
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.resilienceoptions.html
@@ -0,0 +1,188 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Optional family_
+
+
+
+
+
+ Optional given_
+
+
+
+
+
+
+
+
+ Optional user_
+
+
+
+
+
+ Optional user_
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Keys in the JWT related to the user
+Hierarchy
+-
+
- + RegisteredJWTClaimsUser + +
Index
+
+
+
+
+ Properties
+-
+
- family_
name
+ - given_
name
+ - scope +
- user_
id
+ - user_
name
+ - xs.user.attributes +
Properties
+Optional email
+ + +Optional family_name
+
+
+ Optional given_name
+
+
+ Optional scope
+ + +Optional user_id
+
+
+ Optional user_name
+
+
+ Optional xs.user.attributes
+ + +
+
+
+
+
+ Interface ResilienceOptions
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.responsedata.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.responsedata.html
new file mode 100644
index 0000000000..acb8092328
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.responsedata.html
@@ -0,0 +1,197 @@
+
+
+
+
+
+
+
+
+
+
+ Interface ResponseData
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.responsedataaccessor.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.responsedataaccessor.html
new file mode 100644
index 0000000000..79330b5603
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.responsedataaccessor.html
@@ -0,0 +1,309 @@
+
+
+
+
+
+
+
+
+
+
+ Interface ResponseDataAccessor
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.scope.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.scope.html
new file mode 100644
index 0000000000..4eecfe4e99
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.scope.html
@@ -0,0 +1,190 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ get
+
+
+
+
+
+ get
+
+
+
+
+
+ get
+
+
+
+
+
+ is
+
+
+
+
+
+
+ Hierarchy
+-
+
- + ResponseDataAccessor + +
Index
+
+
+
+
+ Properties
+ +Properties
+getCollectionResult
+
+
+
+
+ Type declaration
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
data: any
+
+
Returns any[]
+
+ -
+
+ -
+
getLinkedCollectionResult
+
+
+
+
+ Type declaration
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
data: any
+
+
Returns any[]
+
+ -
+
+ -
+
getSingleResult
+
+
+
+
+ Type declaration
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
data: any
+
+
Returns Record<string, any>
+
+ -
+
+ -
+
isCollectionResult
+
+
+
+
+ Type declaration
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
data: any
+
+
Returns boolean
+
+ -
+
+ -
+
+
+
+
+
+ Interface Scope
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.selectableedmtypefield.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.selectableedmtypefield.html
new file mode 100644
index 0000000000..8b9fa164c5
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.selectableedmtypefield.html
@@ -0,0 +1,209 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Representation of the scope. A scope is assigned to a user via role-collection in cloud foundry.
+Hierarchy
+-
+
- + Scope + +
Index
+
+
+
+
+ Properties
+-
+
- name +
Properties
+name
+ + +
+
+
+
+
+ Interface SelectableEdmTypeField
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.service.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.service.html
new file mode 100644
index 0000000000..d3b65894d5
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.service.html
@@ -0,0 +1,229 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Interface denoting a selectable EdmTypeField.
+Hierarchy
+-
+
- + SelectableEdmTypeField + +
Implemented by
+-
+
- AnyField +
- BigNumberField +
- BinaryField +
- BooleanField +
- CollectionField +
- DateField +
- EnumField +
- NumberField +
- StringField +
Index
+
+
+
+
+ Properties
+-
+
- selectable +
Properties
+selectable
+ + +
+
+
+
+ This property denotes that this is a selectable edm type field.
+
+
+
+
+
+ Interface Service
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.servicebinding.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.servicebinding.html
new file mode 100644
index 0000000000..54a68605d8
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.servicebinding.html
@@ -0,0 +1,245 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Hierarchy
+-
+
- + Service + +
Indexable
+ +Index
+
+
+
+
+ Properties
+-
+
- credentials +
- label +
- name +
- tags +
Properties
+credentials
+ + +label
+ + +name
+ + +tags
+ + +
+
+
+
+
+ Interface ServiceBinding
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.servicecredentials.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.servicecredentials.html
new file mode 100644
index 0000000000..801d556f4a
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.servicecredentials.html
@@ -0,0 +1,213 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Represents the JSON object for a given service binding as obtained from the VCAP_SERVICE environment variable.
+ To see service bindings, run cf env <app-name> in the terminal. This will produce output like this:
{
+...
+ "VCAP_SERVICES": {
+ "s4-hana-cloud": [
+ {
+ "name": "...",
+ "type": "...".
+ ...
+ }
+ ]
+ }
+}
+
+In this example, the key "s4-hana-cloud" refers to an array of service bindings.
+Hierarchy
+-
+
- + ServiceBinding + +
Indexable
+ +
+
+
+
+ Represents the JSON object for a given service binding as obtained from the VCAP_SERVICE environment variable.
+ To see service bindings, run cf env <app-name> in the terminal. This will produce output like this:
{
+...
+ "VCAP_SERVICES": {
+ "s4-hana-cloud": [
+ {
+ "name": "...",
+ "type": "...".
+ ...
+ }
+ ]
+ }
+}
+
+In this example, the key "s4-hana-cloud" refers to an array of service bindings.
+Index
+Properties
+name
+ + +type
+ + +
+
+
+
+
+ Interface ServiceCredentials
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.tenant.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.tenant.html
new file mode 100644
index 0000000000..d38a9bc937
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.tenant.html
@@ -0,0 +1,204 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Unspecific representation of a service's credentials as read from VCAP_SERVICES (for Cloud Foundry) or mounted secrets (for K8S).
+Hierarchy
+-
+
- + ServiceCredentials + +
Indexable
+ +
+
+
+
+ Unspecific representation of a service's credentials as read from VCAP_SERVICES (for Cloud Foundry) or mounted secrets (for K8S).
+Index
+
+
+
+
+ Properties
+-
+
- clientid +
- clientsecret +
Properties
+clientid
+ + +clientsecret
+ + +
+
+
+
+
+ Interface Tenant
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.time.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.time.html
new file mode 100644
index 0000000000..e9bbde8d25
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.time.html
@@ -0,0 +1,211 @@
+
+
+
+
+
+
+
+
+
+
+ Interface Time
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.tokenkey.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.tokenkey.html
new file mode 100644
index 0000000000..f3b158181c
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.tokenkey.html
@@ -0,0 +1,310 @@
+
+
+
+
+
+
+
+
+
+
+ Interface TokenKey
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.uriconverter.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.uriconverter.html
new file mode 100644
index 0000000000..98bab4d0ee
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.uriconverter.html
@@ -0,0 +1,207 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ key
+
+
+
+
+
+ key
+
+
+
+
+
+ public
+
+
+
+
+
+ public
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Response element returned from the XSUAA service's /token_key endpoint. + Value holds the key that is used for verifying JWTs.
+Hierarchy
+-
+
- + TokenKey + +
Index
+
+
+
+
+ Properties
+-
+
- algorithm +
- key
Id
+ - key
Type
+ - public
Key Exponent
+ - public
Key Modulus
+ - use +
- value +
Properties
+algorithm
+ + +
+
+
+
+ Encryption algorithm, e.g. RSA256.
+keyId
+
+
+
+
+
+
+ ID of the key.
+keyType
+
+
+
+
+
+
+ Key type, e.g. RSA.
+publicKeyExponent
+
+
+
+
+
+
+ RSA key exponent.
+publicKeyModulus
+
+
+
+
+
+
+ RSA key modulus.
+use
+ + +
+
+
+
+ Public key use parameter - identifies intended use of the public key.
+value
+ + +
+
+
+
+ The actual key.
+
+
+
+
+
+ Interface UriConverter
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.verifyjwtoptions.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.verifyjwtoptions.html
new file mode 100644
index 0000000000..b58a4b6ad4
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.verifyjwtoptions.html
@@ -0,0 +1,190 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ convert
+
+
+
+
+
+
+
+
+ Interface defining the methods of the URI converter. + The concrete implementations are created in odata/v2/uri-conversion/uri-value-converter.ts and odata/v4/uri-conversion/uri-value-converter.ts
+Hierarchy
+-
+
- + UriConverter + +
Index
+
+
+
+
+ Methods
+ +Methods
+convertToUriFormat
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
value: any
+
+ -
+
edmType: EdmTypeShared<VersionT>
+
+
Returns string
+
+ -
+
+
+
+
+
+ Interface VerifyJwtOptions
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.writeresponse.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.writeresponse.html
new file mode 100644
index 0000000000..3087901c49
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.writeresponse.html
@@ -0,0 +1,225 @@
+
+
+
+
+
+
+
+
+
+
+ Interface WriteResponse
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.writeresponses.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.writeresponses.html
new file mode 100644
index 0000000000..caa99b2efd
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.writeresponses.html
@@ -0,0 +1,212 @@
+
+
+
+
+
+
+
+
+
+
+ Interface WriteResponses
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.xsuaaservicecredentials.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.xsuaaservicecredentials.html
new file mode 100644
index 0000000000..1e8e431cdb
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_core.xsuaaservicecredentials.html
@@ -0,0 +1,330 @@
+
+
+
+
+
+
+
+
+
+
+ Interface XsuaaServiceCredentials
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_test_util.gettestdestinationoptions.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_test_util.gettestdestinationoptions.html
new file mode 100644
index 0000000000..1cf6e9967e
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_test_util.gettestdestinationoptions.html
@@ -0,0 +1,218 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Credentials for the XSUAA service.
+Hierarchy
+-
+
- + XsuaaServiceCredentials + +
Index
+
+
+
+
+ Properties
+-
+
- clientid +
- clientsecret +
- identityzone +
- identityzoneid +
- sburl +
- tenantid +
- tenantmode +
- uaadomain +
- url +
- verificationkey +
- xsappname +
Properties
+clientid
+ + +clientsecret
+ + +identityzone
+ + +identityzoneid
+ + +sburl
+ + +tenantid
+ + +tenantmode
+ + +uaadomain
+ + +url
+ + +verificationkey
+ + +xsappname
+ + +
+
+
+
+
+ Interface GetTestDestinationOptions
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_util.loggeroptions.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_util.loggeroptions.html
new file mode 100644
index 0000000000..0ad3b16cf8
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_util.loggeroptions.html
@@ -0,0 +1,204 @@
+
+
+
+
+
+
+
+
+
+
+ Interface LoggerOptions
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/interfaces/sap_cloud_sdk_util.messagecontextobj.html b/docs/api/1.36.1/interfaces/sap_cloud_sdk_util.messagecontextobj.html
new file mode 100644
index 0000000000..259f1b4c2b
--- /dev/null
+++ b/docs/api/1.36.1/interfaces/sap_cloud_sdk_util.messagecontextobj.html
@@ -0,0 +1,199 @@
+
+
+
+
+
+
+
+
+
+
+ Interface MessageContextObj
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/modules.html b/docs/api/1.36.1/modules.html
new file mode 100644
index 0000000000..eb06213262
--- /dev/null
+++ b/docs/api/1.36.1/modules.html
@@ -0,0 +1,143 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Optional message
+
+
+
+
+
+
+
+
+
+
+ Log message context for a logger with additional custom data.
+Hierarchy
+-
+
- + MessageContextObj + +
Indexable
+ +
+
+
+
+ Log message context for a logger with additional custom data.
+Index
+
+
+
+
+ Properties
+-
+
- message
Context
+
Properties
+Optional messageContext
+
+
+
+
+
+
+ SAP Cloud SDK for JavaScript / TypeScript - v1.36.1
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/modules/sap_cloud_sdk_analytics.html b/docs/api/1.36.1/modules/sap_cloud_sdk_analytics.html
new file mode 100644
index 0000000000..74a665a3b1
--- /dev/null
+++ b/docs/api/1.36.1/modules/sap_cloud_sdk_analytics.html
@@ -0,0 +1,190 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Modules
+ +
+
+
+
+
+ Module @sap-cloud-sdk/analytics
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/modules/sap_cloud_sdk_core.html b/docs/api/1.36.1/modules/sap_cloud_sdk_core.html
new file mode 100644
index 0000000000..8958fe02dd
--- /dev/null
+++ b/docs/api/1.36.1/modules/sap_cloud_sdk_core.html
@@ -0,0 +1,11142 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ get
+
+
+
+
+
+
+
+
+
+ cloud-sdk-analytics
+ +This package contains the code we use for collecting usage data. + Please note that usage analytics is disabled by default, i.e. you need to explicitly opt-in for data to be collected. + For more information on how to opt-in and which data is collected, please refer to this document.
+Index
+
+
+
+
+ Functions
+ +Functions
+getProjectIdentifier
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
config: UsageAnalyticsProjectConfig
+
+ -
+
packageJson: PackageJson
+
+
Returns string
+
+ -
+
+
+
+
+
+ Module @sap-cloud-sdk/core
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/modules/sap_cloud_sdk_core.protocol.html b/docs/api/1.36.1/modules/sap_cloud_sdk_core.protocol.html
new file mode 100644
index 0000000000..4b8d293495
--- /dev/null
+++ b/docs/api/1.36.1/modules/sap_cloud_sdk_core.protocol.html
@@ -0,0 +1,169 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Action
+ Renames and exports ActionFunctionImportRequestBuilder
+
+
+
+ Action
+ Renames and exports FunctionImportParameter
+
+
+
+ Action
+ Renames and exports FunctionImportParameters
+
+
+
+ Create
+ Renames and exports CreateRequestBuilder
+
+
+
+ Custom
+ Renames and exports CustomField
+
+
+
+ Delete
+ Renames and exports DeleteRequestBuilder
+
+
+
+ Edm
+ Renames and exports EdmToPrimitive
+
+
+
+ Edm
+ Renames and exports EdmType
+
+
+
+ Entity
+ Renames and exports Entity
+
+
+
+ Function
+ Renames and exports FunctionImportRequestBuilder
+
+
+
+ Get
+ Renames and exports GetAllRequestBuilder
+
+
+
+ Get
+ Renames and exports GetByKeyRequestBuilder
+
+
+
+ Method
+ Renames and exports MethodRequestBuilder
+
+
+
+ OData
+ Renames and exports ODataBatchChangeSet
+
+
+
+ OData
+ Renames and exports ODataBatchRequestBuilder
+
+
+
+ OData
+ Renames and exports ODataFunctionImportRequestConfig
+
+
+
+ Update
+ Renames and exports UpdateRequestBuilder
+
+
+
+ deserialize
+ Renames and exports deserializeComplexType
+
+
+
+ deserialize
+ Renames and exports deserializeEntity
+
+
+
+ entity
+ Renames and exports entitySerializer
+
+
+
+ extractOData
+ Renames and exports extractODataEtag
+
+
+
+ get
+ Renames and exports getExpand
+
+
+
+ get
+ Renames and exports getSelect
+
+
+
+ o
+ Renames and exports oDataUri
+
+
+
+ response
+ Renames and exports responseDataAccessor
+
+
+
+ serialize
+ Renames and exports serializeEntity
+
+
+
+ serialize
+ Renames and exports serializeEntityNonCustomFields
+
+
+
+ serialize
+ Renames and exports serializeEntity
+
+
+
+ to
+ Renames and exports toBatchChangeSet
+
+
+
+ to
+ Renames and exports toBatchRetrieveBody
+
+
+
+
+
+ Authentication
+
+
+
+
+
+ Batch
+
+
+
+
+
+ Constructor
+
+
+
+
+
+ Deep
+
+
+
+
+
+ Destination
+
+
+
+
+
+ Destination
+
+
+
+
+
+ Destination
+
+
+
+
+
+ Destination
+
+
+
+
+
+ Edm
+
+
+
+
+
+ Edm
+
+
+
+
+
+ Edm
+
+
+
+
+
+ Edm
+
+
+
+
+
+ Edm
+
+
+
+
+
+ Edm
+
+
+
+
+
+ Edm
+
+
+
+
+
+ Edm
+
+
+
+
+
+ Edm
+
+
+
+
+
+ Entity
+
+
+
+
+
+ Exclusive
+
+
+
+
+
+ Exclusive
+
+
+
+
+
+ Execute
+
+
+
+
+
+
+
+
+ Field
+
+
+
+
+
+ Filter
+
+
+
+
+
+ Filter
+
+
+
+
+
+ Filter
+
+
+
+
+
+ Filter
+
+
+
+
+
+ Filter
+
+
+
+
+
+ Filter
+
+
+
+
+
+ Filter
+
+
+
+
+
+
+
+
+ Function
+
+
+
+
+
+ Http
+
+
+
+
+
+ Jwt
+
+
+
+
+
+ OData
+
+
+
+
+
+
+
+
+ Orderable
+
+
+
+
+
+
+
+
+ Request
+
+
+
+
+
+
+
+
+
+
+ Const Destination
+
+
+
+
+
+ Const Environment
+
+
+
+
+
+ Const circuit
+
+
+
+
+
+ Const client
+
+
+
+
+
+ Const content_
+
+
+
+
+
+ Const deserializers
+
+
+
+
+
+ Const destination
+
+
+
+
+
+ Const destination
+
+
+
+
+
+ Const entity
+
+
+
+
+
+ Const entity
+
+
+
+
+
+ Const entity
+
+
+
+
+
+ Const entity
+
+
+
+
+
+ Const filter
+
+
+
+
+
+ Const filter
+
+
+
+
+
+ Const http_
+
+
+
+
+
+ Const mapping
+
+
+
+
+
+ Const mapping
+
+
+
+
+
+ Const number
+
+
+
+
+
+ Const o
+
+
+
+
+
+ Const o
+
+
+
+
+
+ Const part_
+
+
+
+
+
+ Const response
+
+
+
+
+
+ Const serializers
+
+
+
+
+
+ Const verification
+
+
+
+
+
+
+
+ add
+
+
+
+ add
+
+
+
+ add
+
+
+
+ add
+
+
+
+ add
+
+
+
+
+
+
+ always
+
+
+
+ always
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ basic
+
+
+
+ build
+
+
+
+ build
+
+
+
+ build
+
+
+
+ build
+
+
+
+ build
+
+
+
+ build
+
+
+
+
+
+
+ check
+
+
+
+ client
+
+
+
+
+
+
+
+
+
+ create
+
+
+
+ create
+
+
+
+ create
+
+
+
+ custom
+
+
+
+
+
+
+ decode
+
+
+
+ decode
+
+
+
+
+
+
+ deserialize
+
+
+
+ Const deserialize
+
+
+
+ Const deserialize
+
+
+
+ Const deserialize
+
+
+
+ Const deserialize
+
+
+
+ destination
+
+
+
+ detect
+
+
+
+ ends
+
+
+
+ entity
+
+
+
+
+
+
+ Const execute
+
+
+
+ extract
+
+
+
+ extract
+
+
+
+ extract
+
+
+
+ extractOData
+
+
+
+ extractOData
+
+
+
+ fetch
+
+
+
+ fetch
+
+
+
+ fetch
+
+
+
+ fetch
+
+
+
+ filter
+
+
+
+ filter
+
+
+
+ filter
+
+
+
+
+
+
+ fractional
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ getOAuth2
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ get
+
+
+
+ has
+
+
+
+ has
+
+
+
+ header
+
+
+
+
+
+
+ index
+
+
+
+ is
+
+
+
+ is
+
+
+
+ is
+
+
+
+ is
+
+
+
+ is
+
+
+
+ is
+
+
+
+ is
+
+
+
+ is
+
+
+
+ is
+
+
+
+ is
+
+
+
+ is
+
+
+
+ is
+
+
+
+ is
+
+
+
+ is
+
+
+
+ issuer
+
+
+
+
+
+
+ matches
+
+
+
+ max
+
+
+
+ merge
+
+
+
+ min
+
+
+
+
+
+
+
+
+
+ Const non
+
+
+
+
+
+
+
+
+
+ parse
+
+
+
+ parse
+
+
+
+ parse
+
+
+
+ parse
+
+
+
+ parse
+
+
+
+ parse
+
+
+
+ prepend
+
+
+
+ proxy
+
+
+
+ proxy
+
+
+
+ read
+
+
+
+ refresh
+
+
+
+ remove
+
+
+
+ replace
+
+
+
+ resolve
+
+
+
+ retrieve
+
+
+
+
+
+
+ sanitize
+
+
+
+ search
+
+
+
+
+
+
+ seconds
+
+
+
+ serialize
+
+
+
+ serialize
+
+
+
+ Const serialize
+
+
+
+ Const serialize
+
+
+
+ Const serialize
+
+
+
+ Const serialize
+
+
+
+ Const serialize
+
+
+
+ serialize
+
+
+
+ service
+
+
+
+ split
+
+
+
+ split
+
+
+
+ split
+
+
+
+ starts
+
+
+
+ subscriber
+
+
+
+
+
+
+ substring
+
+
+
+ tenant
+
+
+
+ time
+
+
+
+ to
+
+
+
+ to
+
+
+
+ to
+
+
+
+ to
+
+
+
+ to
+
+
+
+ Const to
+
+
+
+ to
+
+
+
+ to
+
+
+
+ to
+
+
+
+ to
+
+
+
+ to
+
+
+
+ to
+
+
+
+ to
+
+
+
+ to
+
+
+
+ total
+
+
+
+
+
+
+ use
+
+
+
+ user
+
+
+
+ user
+
+
+
+ user
+
+
+
+ verify
+
+
+
+ verify
+
+
+
+ wrap
+
+
+
+
+
+
+
+
+
+
+
+ 
@sap-cloud-sdk/core
+ +This package contains the core functionality of the SAP Cloud SDK as well as the Cloud Platform abstractions.
+ +Installation
+ +$ npm install @sap-cloud-sdk/core
+Usage
+ +The core is the heart of the SAP Cloud SDK and contains the functionality that is essential to every project powered by the SDK. Any OData client built by the SAP Cloud SDK, be it the VDM or clients built by the generator are using the core. We recommend to install this in addition to your clients.
+Below is an example showing how you can build and execute your request with multiple filters by using an function called and.
import { and } from '@sap-cloud-sdk/core';
+import { BusinessPartner } from '@sap/cloud-sdk-vdm-business-partner-service';
+
+// Build your filters
+const firstNameFilter = BusinessPartner.FIRST_NAME.equals('firstName');
+const lastNameFilter = BusinessPartner.LAST_NAME.equals('lastName');
+
+// Execute your request with two filters
+BusinessPartner.requestBuilder()
+ .getAll()
+ .filter(and(firstNameFilter, lastNameFilter))
+ .execute(yourDestination);
+Documentation
+ +Getting started guide + API documentation
+ +Helpful Links
+ +-
+
- SAP Cloud SDK Documentation portal +
- Tutorials on developers.sap.com +
- SAP Cloud SDK on StackOverflow +
- SAP Cloud SDK on answers.sap.com +
- Release notes on help.sap.com +
- Release notes on Github +
- All versions of this documentation +
- Product page of the SAP Cloud SDK +
- SAP Cloud SDK Continuous Delivery Toolkit +
Index
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ References
+-
+
- Action
Function Import Request Builder Base
+ - Action
Import Parameter
+ - Action
Import Parameters
+ - Create
Request Builder V2
+ - Custom
Field V2
+ - Delete
Request Builder V2
+ - Edm
ToPrimitive V2
+ - Edm
Type V2
+ - Entity
V2
+ - Function
Import Request Builder V2
+ - Get
All Request Builder V2
+ - Get
ByKey Request Builder V2
+ - Method
Request Builder Base
+ - OData
Batch Change Set V2
+ - OData
Batch Request Builder V2
+ - OData
Function Import Request Config V2
+ - Update
Request Builder V2
+ - deserialize
Complex Type V2
+ - deserialize
Entity V2
+ - entity
Serializer V2
+ - extractOData
Etag V2
+ - get
Expand V2
+ - get
Select V2
+ - o
Data Uri V2
+ - response
Data Accessor V4
+ - serialize
Complex Type V2
+ - serialize
Entity Non Custom Fields V2
+ - serialize
Entity V2
+ - to
Batch Change Set V2
+ - to
Batch Retrieve Body V2
+
Namespaces
+-
+
- Protocol +
Enumerations
+ +Classes
+-
+
- Action
Function Import Request Builder
+ - Action
Import Request Builder
+ - All
Fields
+ - Any
Field
+ - Batch
Change Set
+ - Batch
Request Builder
+ - Batch
Response Deserializer
+ - Big
Number Field
+ - Binary
Field
+ - Binary
Field Base
+ - Boolean
Field
+ - Boolean
Field Base
+ - Boolean
Filter Function
+ - Cache +
- Collection
Field
+ - Complex
Type Any Property Field
+ - Complex
Type Big Number Property Field
+ - Complex
Type Binary Property Field
+ - Complex
Type Boolean Property Field
+ - Complex
Type Date Property Field
+ - Complex
Type Duration Property Field
+ - Complex
Type Enum Property Field
+ - Complex
Type Field
+ - Complex
Type Number Property Field
+ - Complex
Type String Property Field
+ - Complex
Type Time Property Field
+ - Count
Request Builder
+ - Create
Request Builder
+ - Create
Request Builder Base
+ - Create
Request Builder V4
+ - Custom
Field
+ - Custom
Field V4
+ - Date
Field
+ - Date
Field Base
+ - Delete
Request Builder
+ - Delete
Request Builder Base
+ - Delete
Request Builder V4
+ - Duration
Field
+ - Durtion
Field Base
+ - Edm
Type Field
+ - Entity +
- Entity
Base
+ - Entity
V4
+ - Enum
Field
+ - Field +
- Filter +
- Filter
Function
+ - Filter
Lambda Expression
+ - Filter
Link
+ - Filter
List
+ - Function
Import Parameter
+ - Function
Import Request Builder
+ - Function
Import Request Builder V4
+ - Get
All Request Builder
+ - Get
All Request Builder Base
+ - Get
All Request Builder V4
+ - Get
ByKey Request Builder
+ - Get
ByKey Request Builder Base
+ - Get
ByKey Request Builder V4
+ - Link +
- Method
Request Builder
+ - Number
Field
+ - Number
Field Base
+ - Number
Filter Function
+ - OData
Action Import Request Config
+ - OData
Batch Change Set
+ - OData
Batch Change Set V4
+ - OData
Batch Config
+ - OData
Batch Request Builder
+ - OData
Batch Request Builder V4
+ - OData
Batch Request Config
+ - OData
Create Request Config
+ - OData
Create Request Config Legacy
+ - OData
Delete Request Config
+ - OData
Delete Request Config Legacy
+ - OData
Function Import Request Config
+ - OData
Function Import Request Config Legacy
+ - OData
Function Import Request Config V4
+ - OData
Get All Request Config
+ - OData
Get All Request Config Legacy
+ - OData
Get ByKey Request Config
+ - OData
Get ByKey Request Config Legacy
+ - OData
Request
+ - OData
Update Request Config
+ - OData
Update Request Config Legacy
+ - One
ToMany Link
+ - One
ToOne Link
+ - Open
Api Request Builder
+ - Order +
- Order
Link
+ - Orderable
Filter Function
+ - String
Field
+ - String
Filter Function
+ - Time
Field
+ - Time
Field Base
+ - Update
Request Builder
+ - Update
Request Builder Base
+ - Update
Request Builder V4
+
Interfaces
+-
+
- Auth
And Exchange Tokens
+ - Caching
Options
+ - Client
Credentials
+ - Complete
DecodedJWT
+ - Complex
Type Namespace
+ - DecodedJWT +
- Destination +
- Destination
Accessor Options
+ - Destination
Auth Token
+ - Destination
Caching Options
+ - Destination
Certificate
+ - Destination
Configuration
+ - Destination
For Service Bindings Options
+ - Destination
Http Request Config
+ - Destination
Json
+ - Destination
Name And Jwt
+ - Destination
Service Credentials
+ - Entity
Deserializer
+ - Entity
Serializer
+ - Error
Response
+ - Get
Filter
+ - Http
Agent Config
+ - Http
Reponse
+ - Http
Request Config
+ - Http
Response
+ - Https
Agent Config
+ - JWTHeader +
- JWTPayload +
- OData
Uri
+ - Property
Metadata
+ - Proxy
Configuration
+ - Read
Response
+ - RegisteredJWTClaims
Basic
+ - RegisteredJWTClaims
Tenant
+ - RegisteredJWTClaims
User
+ - Resilience
Options
+ - Response
Data
+ - Response
Data Accessor
+ - Scope +
- Selectable
Edm Type Field
+ - Service +
- Service
Binding
+ - Service
Credentials
+ - Tenant +
- Time +
- Token
Key
+ - Uri
Converter
+ - Verify
Jwt Options
+ - Write
Response
+ - Write
Responses
+ - Xsuaa
Service Credentials
+
Type aliases
+-
+
- Authentication
Type
+ - Batch
Response
+ - Constructor
OrField
+ - Deep
Field Type
+ - Destination
Options
+ - Destination
Proxy Type
+ - Destination
Retrieval Options
+ - Destination
Selection Strategy
+ - Edm
ToPrimitive
+ - Edm
ToPrimitive V4
+ - Edm
Type
+ - Edm
Type Common
+ - Edm
Type Different Converters
+ - Edm
Type Same Converters
+ - Edm
Type Same Converters Uri
+ - Edm
Type Shared
+ - Edm
Type V4
+ - Entity
Builder Type
+ - Exclusive
Edm Type V2
+ - Exclusive
Edm Type V4
+ - Execute
Http Request Fn
+ - Expandable +
- Field
Type
+ - Filter
Function Parameter Type
+ - Filter
Function Primitive Parameter Type
+ - Filter
Function Return Type
+ - Filter
Function Return Type V4
+ - Filter
Lambda Operator
+ - Filter
Operator
+ - Filter
Operator ByType
+ - Filterable +
- Function
Import Parameters
+ - Http
Request
+ - Jwt
Key Mapping
+ - OData
Version Of
+ - Orderable +
- Orderable
Input
+ - RegisteredJWTClaims +
- Request
Method Type
+ - Selectable +
Variables
+-
+
- Destination
Selection Strategies
+ - Environment
Accessor
+ - circuit
Breaker Default Options
+ - client
Credentials Token Cache
+ - content_
transfer_ encoding_ line
+ - deserializers
Common
+ - destination
Cache
+ - destination
Service Cache
+ - entity
Deserializer V2
+ - entity
Deserializer V4
+ - entity
Serializer
+ - entity
Serializer V4
+ - filter
Functions
+ - filter
Functions V4
+ - http_
version
+ - mapping
Tenant Fields
+ - mapping
User Fields
+ - number
Return Type Mapping
+ - o
Data Uri
+ - o
Data Uri V4
+ - part_
content_ type_ line
+ - response
Data Accessor
+ - serializers
Commom
+ - verification
Key Cache
+
Functions
+-
+
- add
Authorization Header
+ - add
Destination ToRequest Config
+ - add
Proxy Configuration
+ - add
Proxy Configuration Internet
+ - add
Proxy Configuration OnPrem
+ - all +
- always
Provider
+ - always
Subscriber
+ - and +
- any +
- asc +
- audiences +
- basic
Header
+ - build
And Add Authorization Header
+ - build
Authorization Headers
+ - build
Axios Request Config
+ - build
Csrf Headers
+ - build
Headers For Destination
+ - build
Http Request
+ - ceiling +
- check
Mandatory Value
+ - client
Credentials Grant
+ - concat +
- contains +
- create
Complex Type
+ - create
Get Filter
+ - create
Get Resource Path For Keys
+ - custom
Attributes
+ - day +
- decode
Jwt
+ - decode
Jwt Complete
+ - desc +
- deserialize
Batch Response
+ - deserialize
Complex Type
+ - deserialize
Complex Type V4
+ - deserialize
Entity
+ - deserialize
Entity V4
+ - destination
For Service Binding
+ - detect
New Line Symbol
+ - ends
With
+ - entity
Deserializer
+ - execute +
- execute
Http Request
+ - extract
Client Credentials
+ - extract
Custom Fields
+ - extract
Etag From Header
+ - extractOData
Etag
+ - extractOData
Etag V4
+ - fetch
Destination
+ - fetch
Instance Destinations
+ - fetch
Subaccount Destinations
+ - fetch
Verification Keys
+ - filter
Function
+ - filter
Function V4
+ - filter
Nullish Values
+ - floor +
- fractional
Seconds
+ - get
Agent Config
+ - get
Auth Headers
+ - get
Axios Config With Defaults
+ - get
Axios Config With Defaults Without Method
+ - get
Collection Result
+ - get
Destination
+ - get
Destination Basic Credentials
+ - get
Destination ByName
+ - get
Destination From Destination Service
+ - get
Destination From Env ByName
+ - get
Destination Options
+ - get
Destination Service
+ - get
Destination Service Credentials
+ - get
Destination Service Credentials List
+ - get
Destination Service Uri
+ - get
Destinations
+ - get
Destinations From Env
+ - get
Edm Type
+ - get
Entity Constructor
+ - get
Entity Keys
+ - get
Environment Variable
+ - get
Expand
+ - get
Expand V4
+ - get
Grant Token Cache Key
+ - get
Header
+ - get
Header Value
+ - get
Headers
+ - get
Line
+ - get
Linked Collection Result
+ - getOAuth2
Client Credentials Token
+ - get
Order By
+ - get
Protocol OrDefault
+ - get
Query Parameters For Filter
+ - get
Query Parameters For Order By
+ - get
Query Parameters For Selection
+ - get
Resource Path For Keys
+ - get
Response Body
+ - get
Select
+ - get
Select V4
+ - get
Service
+ - get
Service Credentials List
+ - get
Service List
+ - get
Single Result
+ - get
Url Protocol
+ - get
Vcap Service
+ - get
Xsuaa Service Credentials
+ - has
Subsequence
+ - has
Subset
+ - header
For Client Credentials
+ - hour +
- index
Of
+ - is
Collection Result
+ - is
Complex Type Name Space
+ - is
Destination
+ - is
Destination Name And Jwt
+ - is
Edm Type
+ - is
Filter
+ - is
Filter Lambda Expression
+ - is
Filter Link
+ - is
Filter List
+ - is
Http Success Code
+ - is
Identical Tenant
+ - is
Navigation Property
+ - is
Of
+ - is
WithETag
+ - issuer
Url
+ - length +
- matches
Pattern
+ - max
Date Time
+ - merge
Headers
+ - min
Date Time
+ - minute +
- month +
- non
Enumerable
+ - now +
- or +
- parse
Batch Response
+ - parse
Destination
+ - parse
Entity Name From Metadata Uri
+ - parse
Http Code
+ - parse
Proxy Env
+ - parse
Response Data
+ - prepend
Dollar
+ - proxy
Agent
+ - proxy
Strategy
+ - read
Property With Warn
+ - refresh
Token Grant
+ - remove
Property OnCondition
+ - replace
Duplicate Keys
+ - resolve
Service
+ - retrieve
Jwt
+ - round +
- sanitize
Destination
+ - search
Service Binding For Destination
+ - second +
- seconds
ToTime
+ - serialize
Batch Request
+ - serialize
Change Set
+ - serialize
Complex Type
+ - serialize
Complex Type V4
+ - serialize
Entity
+ - serialize
Entity Non Custom Fields
+ - serialize
Entity Non Custom Fields V4
+ - serialize
Request
+ - service
Token
+ - split
Batch Response
+ - split
Change Set Response
+ - split
Response
+ - starts
With
+ - subscriber
First
+ - substring +
- substring
Of
+ - tenant
From Jwt
+ - time
ToSeconds
+ - to
Batch Change Set
+ - to
Batch Change Set V4
+ - to
Batch Retrieve Body
+ - to
Batch Retrieve Body V4
+ - to
Filterable List
+ - to
Guid
+ - to
Lower
+ - to
Pascal Case
+ - to
Property Format
+ - to
Sanitized Header Object
+ - to
Static Property Format
+ - to
Title Format
+ - to
Type Name Format
+ - to
Upper
+ - total
Offset Minutes
+ - trim +
- use
OrFetch Destination
+ - user
Approved Service Token
+ - user
From Jwt
+ - user
Token Grant
+ - verify
Jwt
+ - verify
Jwt With Key
+ - wrap
Jwt InHeader
+ - year +
References
+ActionFunctionImportRequestBuilderBase
+ Renames and exports ActionFunctionImportRequestBuilder
+ ActionImportParameter
+ Renames and exports FunctionImportParameter
+ ActionImportParameters
+ Renames and exports FunctionImportParameters
+ CreateRequestBuilderV2
+ Renames and exports CreateRequestBuilder
+ CustomFieldV2
+ Renames and exports CustomField
+ DeleteRequestBuilderV2
+ Renames and exports DeleteRequestBuilder
+ EdmToPrimitiveV2
+ Renames and exports EdmToPrimitive
+ EdmTypeV2
+ Renames and exports EdmType
+ EntityV2
+ Renames and exports Entity
+ FunctionImportRequestBuilderV2
+ Renames and exports FunctionImportRequestBuilder
+ GetAllRequestBuilderV2
+ Renames and exports GetAllRequestBuilder
+ GetByKeyRequestBuilderV2
+ Renames and exports GetByKeyRequestBuilder
+ MethodRequestBuilderBase
+ Renames and exports MethodRequestBuilder
+ ODataBatchChangeSetV2
+ Renames and exports ODataBatchChangeSet
+ ODataBatchRequestBuilderV2
+ Renames and exports ODataBatchRequestBuilder
+ ODataFunctionImportRequestConfigV2
+ Renames and exports ODataFunctionImportRequestConfig
+ UpdateRequestBuilderV2
+ Renames and exports UpdateRequestBuilder
+ deserializeComplexTypeV2
+ Renames and exports deserializeComplexType
+ deserializeEntityV2
+ Renames and exports deserializeEntity
+ entitySerializerV2
+ Renames and exports entitySerializer
+ extractODataEtagV2
+ Renames and exports extractODataEtag
+ getExpandV2
+ Renames and exports getExpand
+ getSelectV2
+ Renames and exports getSelect
+ oDataUriV2
+ Renames and exports oDataUri
+ responseDataAccessorV4
+ Renames and exports responseDataAccessor
+ serializeComplexTypeV2
+ Renames and exports serializeEntity
+ serializeEntityNonCustomFieldsV2
+ Renames and exports serializeEntityNonCustomFields
+ serializeEntityV2
+ Renames and exports serializeEntity
+ toBatchChangeSetV2
+ Renames and exports toBatchChangeSet
+ toBatchRetrieveBodyV2
+ Renames and exports toBatchRetrieveBody
+ Type aliases
+AuthenticationType
+
+
+ BatchResponse
+
+
+ ConstructorOrField
+
+
+
+
+
+
+ Union type to represent the parent of a field. This can either be an entity constructor or a complex type field.
+Type parameters
+-
+
-
+
EntityT: EntityBase
+
+ -
+
ComplexT = any
+
+
DeepFieldType
+
+
+
+
+
+ DestinationOptions
+
+
+ DestinationProxyType
+
+
+ DestinationRetrievalOptions
+
+
+
+
+
+
+ Options to use while fetching destinations. Encompasses both DestinationCachingOptions and ResilienceOptions interfaces.
+DestinationSelectionStrategy
+
+
+
+
+ Type declaration
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
allDestinations: AllDestinations
+
+ -
+
destinationName: string
+
+
Returns Destination | null
+
+ -
+
+ -
+
EdmToPrimitive
+
+
+ Type parameters
+-
+
-
+
T: EdmType
+
+
EdmToPrimitiveV4
+
+
+ Type parameters
+-
+
-
+
T: EdmTypeV4
+
+
EdmType
+
+
+
+
+
+
+ Allowed Edm types for OData v2.
+EdmTypeCommon
+
+
+ EdmTypeDifferentConverters
+
+
+ EdmTypeSameConverters
+
+
+ EdmTypeSameConvertersUri
+
+
+ EdmTypeShared
+
+
+ Type parameters
+-
+
-
+
VersionT: ODataVersion | "any"
+
+
EdmTypeV4
+
+
+
+
+
+
+ Allowed Edm types for OData v4.
+EntityBuilderType
+
+
+ Type parameters
+-
+
-
+
EntityT: EntityBase
+
+ -
+
EntityTypeT
+
+
ExclusiveEdmTypeV2
+
+
+ ExclusiveEdmTypeV4
+
+
+ ExecuteHttpRequestFn
+
+
+
+
+ Type declaration
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
request: HttpRequest
+
+
Returns Promise<HttpResponse>
+
+ -
+
+ -
+
Expandable
+ + +
+
+
+
+ Represents all expandables, i.e. everything that can be used in an .expand statement. Only relevant for OData v4 requests.
Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity to be selected on
+
+
FieldType
+
+
+
+
+
+
+ Union type to represent all possible types of a field.
+FilterFunctionParameterType
+
+
+
+
+
+
+ Type of a parameter of a filter function. This can either be a primitive type, a reference to a field or another filter function.
+Type parameters
+-
+
-
+
EntityT: EntityBase
+
+
FilterFunctionPrimitiveParameterType
+
+
+
+
+
+
+ Primitive type of a parameter of a filter function.
+FilterFunctionReturnType
+
+
+ FilterFunctionReturnTypeV4
+
+
+ FilterLambdaOperator
+
+
+
+
+
+
+ hidden
+FilterOperator
+
+
+ FilterOperatorByType
+
+
+ Type parameters
+-
+
-
+
FieldT: FieldType
+
+
Filterable
+ + +
+
+
+
+ A union of all types that can be used for filtering.
+Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity to be filtered on
+
+
FunctionImportParameters
+
+
+
+
+
+
+ Internal representation of all parameters of a function import as a map
+Type parameters
+-
+
-
+
ParametersT
+++++External represenation of all parameters
+
+
HttpRequest
+
+
+ JwtKeyMapping
+
+
+ Type parameters
+-
+
-
+
TypescriptKeys
+
+ -
+
JwtKeys
+
+
ODataVersionOf
+
+
+ Type parameters
+-
+
-
+
T: EntityBase
+
+
Orderable
+ + +
+
+
+
+ A union of all types that can be used for ordering.
+Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity to be ordered
+
+
OrderableInput
+
+
+
+
+
+
+ A union of all types that can be used as input for ordering.
+Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity to be ordered
+
+
RegisteredJWTClaims
+ + +
+
+
+
+ Interface to represent the registered claims of a JWT.
+RequestMethodType
+
+
+ Selectable
+ + +
+
+
+
+ Represents all selectables, i.e. everything that can be used in a .select statement.
Type parameters
+-
+
-
+
EntityT: EntityBase
+++++Type of the entity to be selected on
+
+
Variables
+Const DestinationSelectionStrategies
+
+
+
+
+
+
+ Selector of destination selection strategies. See alwaysProvider, alwaysSubscriber and subscriberFirst for more information available selection strategies.
+
+
+ Type declaration
+-
+
-
+
always
+Provider: typeof alwaysProvider
+ -
+
always
+Subscriber: typeof alwaysSubscriber
+ -
+
subscriber
+First: typeof subscriberFirst
+
Const EnvironmentAccessor
+
+
+
+
+
+
+
+ Type declaration
+-
+
-
+
get
+Destination Basic Credentials: typeof getDestinationBasicCredentials
+ -
+
get
+Destination Service Credentials: typeof getDestinationServiceCredentials
+ -
+
get
+Destination Service Credentials List: typeof getDestinationServiceCredentialsList
+ -
+
get
+Destination Service Uri: typeof getDestinationServiceUri
+ -
+
get
+Environment Variable: typeof getEnvironmentVariable
+ -
+
get
+Service Credentials List: typeof getServiceCredentialsList
+ -
+
get
+Service List: typeof getServiceList
+ -
+
get
+Vcap Service: typeof getVcapService
+ -
+
get
+Xsuaa Service Credentials: typeof getXsuaaServiceCredentials
+
Const circuitBreakerDefaultOptions
+
+
+
+
+ Type declaration
+-
+
-
+
error
+Threshold Percentage: number
+ -
+
reset
+Timeout: number
+ -
+
timeout: number
+
+
Const clientCredentialsTokenCache
+
+
+
+
+ Type declaration
+-
+
-
+
cache
+Retrieved Token: (url: any, credentials: ClientCredentials, token: ClientCredentialsResponse) => void -
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
url: any
+
+ -
+
credentials: ClientCredentials
+
+ -
+
token: ClientCredentialsResponse
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
-
+
clear: () => void
+-
+
-
+
-
+
+
-
+
-
+
Returns void
+
+
+ -
+
+ -
+
-
+
get
+Cache Instance: () => Cache<ClientCredentialsResponse> -
+
-
+
-
+
+
-
+
-
+
Returns Cache<ClientCredentialsResponse>
+
+
+ -
+
+ -
+
-
+
get
+Grant Token From Cache: (url: any, credentials: ClientCredentials) => ClientCredentialsResponse | undefined -
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
url: any
+
+ -
+
credentials: ClientCredentials
+
+
Returns ClientCredentialsResponse | undefined
+
+ -
+
+ -
+
+ -
+
Const content_transfer_encoding_line
+
+
+
+
+
+ Const deserializersCommon
+
+
+ Const destinationCache
+
+
+
+
+ Type declaration
+-
+
-
+
cache
+Retrieved Destination: (decodedJwt: Record<string, any>, destination: Destination, isolation: IsolationStrategy) => void -
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
decodedJwt: Record<string, any>
+
+ -
+
destination: Destination
+
+ -
+
isolation: IsolationStrategy
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
-
+
cache
+Retrieved Destinations: (decodedJwt: Record<string, any>, retrievedDestinations: DestinationsByType, isolation: IsolationStrategy) => void -
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
decodedJwt: Record<string, any>
+
+ -
+
retrievedDestinations: DestinationsByType
+
+ -
+
isolation: IsolationStrategy
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
-
+
clear: () => void
+-
+
-
+
-
+
+
-
+
-
+
Returns void
+
+
+ -
+
+ -
+
-
+
get
+Cache Instance: () => Cache<Destination> -
+
-
+
-
+
+
-
+
-
+
Returns Cache<Destination>
+
+
+ -
+
+ -
+
-
+
retrieve
+Destination From Cache: (decodedJwt: Record<string, any>, name: string, isolation: IsolationStrategy) => Destination | undefined -
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
decodedJwt: Record<string, any>
+
+ -
+
name: string
+
+ -
+
isolation: IsolationStrategy
+
+
Returns Destination | undefined
+
+ -
+
+ -
+
+ -
+
Const destinationServiceCache
+
+
+
+
+ Type declaration
+-
+
-
+
cache
+Retrieved Destinations: (destinationServiceUri: string, decodedJwt: DecodedJWT, destinations: Destination[], isolationStrategty?: IsolationStrategy) => void -
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
destinationServiceUri: string
+
+ -
+
decodedJwt: DecodedJWT
+
+ -
+
destinations: Destination[]
+
+ -
+
Optional isolationStrategty: IsolationStrategy
+
+
Returns void
+
+ -
+
+ -
+
+ -
+
-
+
clear: () => void
+-
+
-
+
-
+
+
-
+
-
+
Returns void
+
+
+ -
+
+ -
+
-
+
get
+Cache Instance: () => Cache<Destination[]> -
+
-
+
-
+
+
-
+
-
+
Returns Cache<Destination[]>
+
+
+ -
+
+ -
+
-
+
retrieve
+Destinations From Cache: (targetUrl: string, decodedJwt: DecodedJWT, isolationStrategty?: IsolationStrategy) => Destination[] | undefined -
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
targetUrl: string
+
+ -
+
decodedJwt: DecodedJWT
+
+ -
+
Optional isolationStrategty: IsolationStrategy
+
+
Returns Destination[] | undefined
+
+ -
+
+ -
+
+ -
+
Const entityDeserializerV2
+
+
+
+
+
+
+ Entity deserializer instance for v2 entities. + See EntityDeserializer for the provided methods.
+Const entityDeserializerV4
+
+
+
+
+
+
+ Entity deserializer instance for v4 entities. + See EntityDeserializer for the provided methods.
+Const entitySerializer
+
+
+
+
+
+
+ Entity serializer instance for v2 entities. + See EntitySerializer for the provided methods.
+Const entitySerializerV4
+
+
+
+
+
+
+ Entity serializer instance for v4 entities. + See EntitySerializer for the provided methods.
+Const filterFunctions
+
+
+
+
+
+
+ OData v2 specific filter functions
+
+
+ Type declaration
+-
+
-
+
ceiling: ceiling
+
+ -
+
concat: concat
+
+ -
+
day: day
+
+ -
+
ends
+With: endsWith
+ -
+
floor: floor
+
+ -
+
hour: hour
+
+ -
+
index
+Of: indexOf
+ -
+
is
+Of: isOf
+ -
+
length: length
+
+ -
+
minute: minute
+
+ -
+
month: month
+
+ -
+
replace: typeof replace
+
+ -
+
round: round
+
+ -
+
second: second
+
+ -
+
starts
+With: startsWith
+ -
+
substring: substring
+
+ -
+
substring
+Of: typeof substringOf
+ -
+
to
+Lower: toLower
+ -
+
to
+Upper: toUpper
+ -
+
trim: trim
+
+ -
+
year: year
+
+
Const filterFunctionsV4
+
+
+
+
+
+
+ OData v4 specific filter functions
+
+
+ Type declaration
+-
+
-
+
ceiling: ceiling
+
+ -
+
concat: concat
+
+ -
+
contains: typeof contains
+
+ -
+
day: day
+
+ -
+
ends
+With: endsWith
+ -
+
floor: floor
+
+ -
+
fractional
+Seconds: typeof fractionalSeconds
+ -
+
has
+Subsequence: typeof hasSubsequence
+ -
+
has
+Subset: typeof hasSubset
+ -
+
hour: hour
+
+ -
+
index
+Of: indexOf
+ -
+
is
+Of: isOf
+ -
+
length: length
+
+ -
+
matches
+Pattern: typeof matchesPattern
+ -
+
max
+Date Time: typeof maxDateTime
+ -
+
min
+Date Time: typeof minDateTime
+ -
+
minute: minute
+
+ -
+
month: month
+
+ -
+
now: typeof now
+
+ -
+
round: round
+
+ -
+
second: second
+
+ -
+
starts
+With: startsWith
+ -
+
substring: substring
+
+ -
+
to
+Lower: toLower
+ -
+
to
+Upper: toUpper
+ -
+
total
+Offset Minutes: typeof totalOffsetMinutes
+ -
+
trim: trim
+
+ -
+
year: year
+
+
Const http_version
+
+
+
+
+
+ Const mappingTenantFields
+
+
+
+
+
+
+ Mapping between key name in the Tenant and key name in decoded JWT and the
+Const mappingUserFields
+
+
+
+
+
+
+ Mapping between key name in the User and key name in decoded JWT and the
+Const numberReturnTypeMapping
+
+
+ Const oDataUri
+
+
+
+
+
+
+ Instance of the ODataUri conversion interface for OData v2.
+Const oDataUriV4
+
+
+
+
+
+
+ Instance of the ODataUri conversion interface for OData v4.
+Const part_content_type_line
+
+
+
+
+
+ Const responseDataAccessor
+
+
+ Const serializersCommom
+
+
+ Const verificationKeyCache
+
+
+ Functions
+addAuthorizationHeader
+ -
+
+
-
+
-
+
+ + ++
Type parameters
+-
+
-
+
RequestT: ODataRequestConfig<RequestT>
+
+
Parameters
+-
+
-
+
request: ODataRequest<RequestT>
+++an ODataRequest.
+
+ -
+
headers: Record<string, string>
+++The headers that should be added to.
+
+
Returns Promise<Record<string, string>>
+The provided headers with the new authorization headers.
+
+ -
+
addDestinationToRequestConfig
+ -
+
+
-
+
-
+
+ ++++
Builds a DestinationHttpRequestConfig for the given destination + and then merges it into the given request configuration. + Setting of the given request configuration take precedence over any destination related configuration.
+Type parameters
+-
+
-
+
T: HttpRequestConfig
+
+
Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++A destination or a destination name and a JWT.
+
+ -
+
requestConfig: T
+++Any object representing an HTTP request.
+
+
Returns Promise<T & DestinationHttpRequestConfig>
+The given request config merged with the config built for the given destination.
+
+ -
+
addProxyConfiguration
+ -
+
+
-
+
-
+
+ ++++
Given a destination and a JWT (required for subscriber destinations), this function will add a proxy configuration to a destination. + See also ProxyConfiguration.
+This function will reject if no connectivity service is bound, no XSUAA service with plan application is bound or the client credentials grant with the XSUAA service fails.
+ +Parameters
+-
+
-
+
destination: Destination
+++The destination to which the proxy configuration should be added.
+
+ -
+
Optional jwt: string
+++The JWT of the current user.
+
+
Returns Promise<Destination>
+A promise resolving to the destiation with the added proxy configuration.
+
+ -
+
addProxyConfigurationInternet
+ -
+
+
-
+
-
+
+ ++++
Adds the proxy configuration to a destination based on web proxies defined in environment variables. See ProxyConfiguration and proxyStrategy for details.
+Parameters
+-
+
-
+
destination: any
+++to which the proxy configuration is added.
+
+
Returns Destination
+Destination containing the configuration for web proxy.
+
+ -
+
addProxyConfigurationOnPrem
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
destination: Destination
+
+ -
+
Optional jwt: string
+
+
Returns Promise<Destination>
+
+ -
+
all
+-
+
+
-
+
-
+
+ ++++
Will return the entity if all elements of the multilink relation fulfill the condition.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+ -
+
LinkedEntityT: EntityBase<LinkedEntityT>
+
+
Parameters
+-
+
-
+
Rest ...filters: (Filterable<EntityT> | OneToManyLink<EntityT, LinkedEntityT>)[]
+++A filter condition like MyEntity.someMultiLink.someProperty.eq('value')
+
+
Returns FilterLambdaExpression<EntityT, FieldType>
+The lambda filter function to be considered in the query
+
+ -
+
alwaysProvider
+ -
+
+
-
+
-
+
+ ++++
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
+
+ -
+
alwaysSubscriber
+ -
+
+
-
+
-
+
+ ++++
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
+
+ -
+
and
+-
+
+
+
-
+
-
+
+ ++++
Create a FilterList by combining Filterables with logical
+and.Example:
+
+Entity.requestBuilder() + .getAll() + .filter(and(filterExp1, filterExp2)); +Note that the GetAllRequestBuilderV2.filter and GetAllRequestBuilderV4.filter method take a rest parameter and thereby an array of filter expressions that are then combined conjunctively. As a consequence following is equivalent to the example above:
+
+Entity.requestBuilder() + .getAll() + .filter(filterExp1, filterExp2); +Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+++Type of the entity to be filtered on
+
+
Parameters
+-
+
-
+
expressions: Filterable<EntityT>[]
+++Filterables to be combined with logical
+and
+
Returns FilterList<EntityT>
+The newly created FilterList
+
+ -
+
-
+
+
Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
Rest ...expressions: Filterable<EntityT>[]
+
+
Returns FilterList<EntityT>
+
+ -
+
any
+-
+
+
-
+
-
+
+ ++++
Will return the entity if at least one element of the multilink relation fulfills the condition.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+ -
+
LinkedEntityT: EntityBase<LinkedEntityT>
+
+
Parameters
+-
+
-
+
Rest ...filters: (Filterable<EntityT> | OneToManyLink<EntityT, LinkedEntityT>)[]
+++A filter condition like MyEntity.someMultiLink.someProperty.eq('value')
+
+
Returns FilterLambdaExpression<EntityT, FieldType>
+The lambda filter function to be considered in the query
+
+ -
+
asc
+-
+
+
-
+
-
+
+ ++++
Create new Order by
+orderBy._fieldNamein ascending order.Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+++Type of the entity to be ordered
+
+
Parameters
+-
+
-
+
orderBy: OrderableInput<EntityT>
+++Field or link to be ordered by
+
+
Returns Order<EntityT>
+New order
+
+ -
+
audiences
+-
+
+
-
+
-
+
+ ++++
Retrieve the audiences of a decoded JWT based on the audiences and scopes in the token.
+Parameters
+-
+
-
+
decodedToken: DecodedJWT
+++Token to retrieve the audiences from.
+
+
Returns Set<string>
+A set of audiences.
+
+ -
+
basicHeader
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
username: string
+
+ -
+
password: string
+
+
Returns string
+
+ -
+
buildAndAddAuthorizationHeader
+ -
+
+
-
+
-
+
+ + ++
Parameters
+-
+
-
+
destination: Destination
+++A destination.
+
+
Returns (headers: Record<string, any>) => Promise<Record<string, string>>
+The provided headers with the new authorization headers.
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
headers: Record<string, any>
+++The headers that should be added to.
+
+
Returns Promise<Record<string, string>>
+
+ -
+
+ -
+
+ -
+
buildAuthorizationHeaders
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
destination: Destination
+
+
Returns Promise<Record<string, string>>
+
+ -
+
buildAxiosRequestConfig
+ -
+
+
-
+
-
+
+ + ++
Type parameters
+-
+
-
+
T: HttpRequestConfig
+
+
Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++A destination or a destination name and a JWT.
+
+ -
+
Optional requestConfig: Partial<T>
+++Any object representing an HTTP request.
+
+
Returns Promise<AxiosRequestConfig>
+
+ -
+
buildCsrfHeaders
+ -
+
+
-
+
-
+
+ ++++
Get CSRF token and cookies for a destination and request configuration. The CSRF token and cookies will be retrieved based on the url of the destination and the custom configuration given by the
+requestConfig. + If there is a relative url in therequestConfigit will be appended to the destination's url, an absolute url overwrites the destination related url.Type parameters
+-
+
-
+
T: HttpRequestConfig
+
+
Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++The destination to get the headers from
+
+ -
+
requestConfig: Partial<T>
+++An http request configuration containing additional information about the request, like url or headers
+
+
Returns Promise<Record<string, any>>
+A promise to an object containing the CSRF related headers
+
+ -
+
buildHeadersForDestination
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
destination: Destination
+
+ -
+
Optional customHeaders: Record<string, any>
+
+
Returns Promise<Record<string, string>>
+
+ -
+
buildHttpRequest
+ -
+
+
-
+
-
+
+ ++++
Builds a DestinationHttpRequestConfig for the given destination. + If a destination name (and a JWT) are provided, it will try to resolve the destination.
+Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++A destination or a destination name and a JWT.
+
+ -
+
Optional customHeaders: Record<string, any>
+++Custom default headers for the resulting HTTP request.
+
+
Returns Promise<DestinationHttpRequestConfig>
+ +
+ -
+
ceiling
+-
+
+
-
+
-
+
+ ++++
Build a filter function to ceil a number. Evaluates to double or decimal, defaults to double.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
num: number | Field<EntityT> | NumberFilterFunction<EntityT>
+++The number to ceil. This can either be a number, a reference to a field or another filter function.
+
+ -
+
Optional returnType: "double" | "decimal"
+++The return type to use.
+
+
Returns NumberFilterFunction<EntityT>
+The newly created filter function
+
+ -
+
checkMandatoryValue
+ -
+
+
-
+
-
+
+ ++++ +
Checks if a given key is in the decoded JWT. If not an error is raised
+Type parameters
+-
+
-
+
TypeScriptKeys
+
+ -
+
JwtKeys
+
+
Parameters
+-
+
-
+
key: keyof TypeScriptKeys
+++The key of the representation in typescript
+
+ -
+
mapping: JwtKeyMapping<TypeScriptKeys, JwtKeys>
+++The mapping between the typescript keys and the JWT key
+
+ -
+
decodedJWT: DecodedJWT
+++Decoded token on which the check is done
+
+
Returns void
+
+ -
+
clientCredentialsGrant
+ -
+
+
-
+
-
+
+ ++++
Executes a client credentials grant request. + If the first parameter is an instance of XsuaaServiceCredentials, the response's access_token will be verified. + If the first parameter is an URI, the response will not be verified.
+Parameters
+-
+
-
+
tokenServiceUrlOrXsuaaServiceCerednetials: string | XsuaaServiceCredentials
+++The URL of the token service or the credentials of a XSUAA service instance.
+
+ -
+
clientCredentials: ClientCredentials
+++Client credentials for which to request a token
+
+ -
+
Optional options: ResilienceOptions
+++Options to use by retrieving access token
+
+ -
+
Optional customBody: Record<string, any>
+++Object containing value required for the body request
+
+
Returns Promise<ClientCredentialsResponse>
+A promise resolving to the response
+
+ -
+
concat
+-
+
+
-
+
-
+
+ ++++
Build a filter function to concatenate two strings. Evaluates to string.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
str1: string | Field<EntityT> | StringFilterFunction<EntityT>
+++The first string to concatenate. This can either be a string, a reference to a field or another filter function.
+
+ -
+
str2: string | Field<EntityT> | StringFilterFunction<EntityT>
+++The second string to concatenate. This can either be a string, a reference to a field or another filter function.
+
+
Returns StringFilterFunction<EntityT>
+The newly created filter function
+
+ -
+
contains
+-
+
+
-
+
-
+
+ ++++
Build a filter function to test whether a string is a substring of the other. Evaluates to boolean.
+Type parameters
+-
+
-
+
EntityT: EntityV4<EntityT>
+
+
Parameters
+-
+
-
+
substr: string | Field<EntityT> | StringFilterFunction<EntityT>
+++The substring to test for. This can either be a string, a reference to a field or another filter function.
+
+ -
+
str: string | Field<EntityT> | StringFilterFunction<EntityT>
+++The string to test. This can either be a string, a reference to a field or another filter function.
+
+
Returns BooleanFilterFunction<EntityT>
+The newly created filter function
+
+ -
+
createComplexType
+ -
+
+
-
+
-
+
+ + ++
Type parameters
+-
+
-
+
ComplexT
+
+
Parameters
+-
+
-
+
json: any
+++A raw json object to deserialize a complex type from.
+
+ -
+
converters: any
+++A list of rules on how to convert json to the respective type in JavaScript or TypeScript.
+
+
Returns ComplexT
+A deserialized complex type representation.
+
+ -
+
createGetFilter
+ -
+
+
-
+
-
+
+ ++++
Creates a getFilter function using the OData v2 or OData v4 URI converter. + The concrete filter getters are initiated in odata/v2/uri-conversion/odata-uri.ts and odata/v4/uri-conversion/odata-uri.ts.
+Parameters
+-
+
-
+
uriConverter: UriConverter
+++Uri converter for v2 or v4.
+
+
Returns GetFilter
+The filter getter. See interface GetFilter
+
+ -
+
createGetResourcePathForKeys
+ -
+
+
-
+
-
+
+ ++++
Creates a getResourcePathForKeys function using the OData v2 or OData v4 URI converter. + The concrete instances for v2 or v4 are initiated in odata/v2/uri-conversion/odata-uri.ts and odata/v4/uri-conversion/odata-uri.ts.
+Parameters
+-
+
-
+
uriConverter: UriConverter
+++Uri converter for v2 or v4.
+
+
Returns GetResourcePathForKeys
+The filter getter. See GetFilter
+
+ -
+
customAttributes
+ -
+
+
-
+
-
+
+ ++++
Extracts the custom attributes in the JWT
+Parameters
+-
+
-
+
decodedToken: DecodedJWT
+++Token to read the custom attributes
+
+
Returns Map<string, string[]>
+custom attributes added by the xsuaa to the issued JWT.
+
+ -
+
day
+-
+
+
-
+
-
+
+ ++++
Build a filter function to get the day of a date. Evaluates to int.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
date: moment.Moment | Field<EntityT>
+++The date to get the day for. This can either be a date (Moment) or a reference to a field.
+
+
Returns NumberFilterFunction<EntityT>
+The newly created filter function
+
+ -
+
decodeJwt
+ -
+
+
-
+
-
+
+ ++++
Decode JWT.
+Parameters
+-
+
-
+
token: string
+++JWT to be decoded
+
+
Returns DecodedJWT
+Decoded payload.
+
+ -
+
decodeJwtComplete
+ -
+
+
-
+
-
+
+ ++++
Decode JWT and return the complete decoded token.
+Parameters
+-
+
-
+
token: string
+++JWT to be decoded
+
+
Returns CompleteDecodedJWT
+Decoded token containing payload, header and signature.
+
+ -
+
desc
+-
+
+
-
+
-
+
+ ++++
Create new Order by
+orderBy._fieldNamein descending order.Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+++Type of the entity to be ordered
+
+
Parameters
+-
+
-
+
orderBy: OrderableInput<EntityT>
+++Field or link to be ordered by
+
+
Returns Order<EntityT>
+New order
+
+ -
+
deserializeBatchResponse
+ -
+
+
-
+
-
+
+ ++++
Deserialize the parsed batch response.
+Parameters
+-
+
-
+
parsedBatchResponse: (ResponseData[] | ResponseData)[]
+++Two dimensional list of parsed batch sub responses.
+
+ -
+
entityToConstructorMap: Record<string, Constructable<EntityBase>>
+++A map that holds the entity type to constructor mapping.
+
+ -
+
responseDataAccessor: ResponseDataAccessor
+++Response data access module.
+
+ -
+
deserializer: EntityDeserializer
+++Entity deserializer.
+
+
Returns (ErrorResponse | ReadResponse | WriteResponses)[]
+An array of parsed sub responses of the batch response.
+
+ -
+
Const deserializeComplexType
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
json: Record<string, any>
+
+ -
+
complexType: ComplexTypeNamespace<any>
+
+
Returns any
+
+ -
+
Const deserializeComplexTypeV4
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
json: Record<string, any>
+
+ -
+
complexType: ComplexTypeNamespace<any>
+
+
Returns any
+
+ -
+
Const deserializeEntity
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
json: any
+
+ -
+
entityConstructor: Constructable<any, unknown>
+
+ -
+
Optional requestHeader: any
+
+
Returns any
+
+ -
+
Const deserializeEntityV4
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
json: any
+
+ -
+
entityConstructor: Constructable<any, unknown>
+
+ -
+
Optional requestHeader: any
+
+
Returns any
+
+ -
+
destinationForServiceBinding
+ -
+
+
-
+
-
+
+ ++++
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.
+
+ -
+
Optional options: DestinationForServiceBindingsOptions
+++Options to customize the behavior of this function.
+
+
Returns Destination
+A destination.
+
+ -
+
detectNewLineSymbol
+ -
+
+
-
+
-
+
+ ++++
Detects the system dependent line break in a string.
+Parameters
+-
+
-
+
str: string
+++The string to check for line breaks. Should have at least two lines, otherwise an error will be thrown.
+
+
Returns string
+The system dependent line break
+
+ -
+
endsWith
+ -
+
+
-
+
-
+
+ ++++
Build a filter function to test whether a string ends with another. Evaluates to boolean.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
str: string | Field<EntityT> | StringFilterFunction<EntityT>
+++The string to test. This can either be a string, a reference to a field or another filter function.
+
+ -
+
suffix: string | Field<EntityT> | StringFilterFunction<EntityT>
+++The suffix to test for. This can either be a string, a reference to a field or another filter function.
+
+
Returns BooleanFilterFunction<EntityT>
+The newly created filter function
+
+ -
+
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
+Parameters
+-
+
-
+
edmToTs: EdmToTsTypeV2 | EdmToTsTypeV4
+++Converters emd input to ts values.
+
+ -
+
extractODataETag: ExtractODataETagType
+++Extractor for the Etag.
+
+ -
+
extractDataFromOneToManyLink: ExtractDataFromOneToManyLinkType
+++Extractor for data related to one to many links.
+
+
Returns EntityDeserializer
+a entity deserializer as defined by EntityDeserializer
+
+ -
+
execute
+-
+
+
-
+
-
+
+ ++++
Takes as paramter a function that expects an HttpRequest and returns a Promise of HttpResponse. + Returns a function that takes a destination and a request-config (extends HttpRequestConfig), builds an HttpRequest from them, and calls + the provided execute function.
+NOTE: If you simply want to execute a request without passing your own execute function, use executeHttpRequest instead!
+Parameters
+-
+
-
+
executeFn: ExecuteHttpRequestFn
+++A function that can execute an HttpRequestConfig.
+
+
Returns <T>(destination: Destination | DestinationNameAndJwt, requestConfig: T) => Promise<HttpResponse>
+A function expecting destination and a request.
+-
+
-
+
-
+
+
-
+
-
+
Type parameters
+-
+
-
+
T: HttpRequestConfig
+
+
Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+
+ -
+
requestConfig: T
+
+
Returns Promise<HttpResponse>
+
+ -
+
+ -
+
+ -
+
Const executeHttpRequest
+ -
+
+
-
+
-
+
+ ++++
Builds a DestinationHttpRequestConfig for the given destination, merges it into the given requestConfig + and executes it (using Axios).
+Type parameters
+-
+
-
+
T: HttpRequestConfig
+
+
Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++A destination or a destination name and a JWT.
+
+ -
+
requestConfig: T
+++Any object representing an HTTP request.
+
+
Returns Promise<HttpResponse>
+An HttpResponse.
+
+ -
+
extractClientCredentials
+ -
+
+
-
+
-
+
+ ++++
Extracts the credentials of a service into an instance of ClientCredentials.
+Parameters
+-
+
-
+
serviceCreds: ServiceCredentials
+++The credentials of a service as read from VCAP_SERVICES.
+
+
Returns ClientCredentials
+A ClientCredentials instance.
+
+ -
+
extractCustomFields
+ -
+
+
-
+
-
+
+ ++++
Extracts all custom fields from the JSON payload for a single entity. + In this context, a custom fields is every property that is not known in the corresponding entity class.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+ -
+
JsonT
+
+
Parameters
+-
+
-
+
json: Partial<JsonT>
+++The JSON payload.
+
+ -
+
entityConstructor: Constructable<EntityT>
+++The constructor function of the entity class.
+
+
Returns Record<string, any>
+An object containing the custom fields as key-value pairs.
+
+ -
+
extractEtagFromHeader
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
headers: any
+
+
Returns string | undefined
+
+ -
+
extractODataEtag
+ -
+
+
-
+
-
+
+ ++++
Extractor for the etag for OData v2 responses used in entityDeserializer.
+Parameters
+-
+
-
+
json: Record<string, any>
+++Response data from which the etag is extracted
+
+
Returns string | undefined
+The etag
+
+ -
+
extractODataEtagV4
+ -
+
+
-
+
-
+
+ ++++
Extractor for the etag for OData v4 responses used in entityDeserializer.
+Parameters
+-
+
-
+
json: Record<string, any>
+++Reponse data from which the etag is extracted
+
+
Returns string | undefined
+The etag
+
+ -
+
fetchDestination
+ -
+
+
-
+
-
+
+ ++++
Fetches a specific destination by name from the given URI, including authorization tokens. + For destinations with authenticationType OAuth2SAMLBearerAssertion, this call will trigger the OAuth2SAMLBearerFlow against the target destination. + In this pass the access token as string. + Fetches a specific destination with authenticationType OAuth2UserTokenExchange by name from the given URI, including authorization tokens.
+Parameters
+-
+
-
+
destinationServiceUri: string
+++The URI of the destination service
+
+ -
+
token: string | AuthAndExchangeTokens
+++The access token or AuthAndExchangeTokens if you want to include the X-user-token for OAuth2UserTokenExchange.
+
+ -
+
destinationName: string
+++The name of the desired destination
+
+ -
+
Optional options: ResilienceOptions & CachingOptions
+++Options to use by retrieving destinations
+
+
Returns Promise<Destination>
+A Promise resolving to the destination
+
+ -
+
fetchInstanceDestinations
+ -
+
+
-
+
-
+
+ ++++
Fetches all instance destinations from the given URI.
+Parameters
+-
+
-
+
destinationServiceUri: string
+++The URI of the destination service
+
+ -
+
jwt: string
+++The access token
+
+ -
+
Optional options: ResilienceOptions & CachingOptions
+++Options to use by retrieving destinations
+
+
Returns Promise<Destination[]>
+A promise resolving to a list of instance destinations
+
+ -
+
fetchSubaccountDestinations
+ -
+
+
-
+
-
+
+ ++++
Fetches all subaccount destinations from the given URI.
+Parameters
+-
+
-
+
destinationServiceUri: string
+++The URI of the destination service
+
+ -
+
jwt: string
+++The access token
+
+ -
+
Optional options: ResilienceOptions & CachingOptions
+++Options to use by retrieving destinations
+
+
Returns Promise<Destination[]>
+A promise resolving to a list of subaccount destinations
+
+ -
+
fetchVerificationKeys
+ -
+
+
+
-
+
-
+
+ ++++
Fetches verification keys from the XSUAA service for the given credentials.
+Parameters
+-
+
-
+
xsuaaCredentials: XsuaaServiceCredentials
+++Credentials of the XSUAA service instance.
+
+ -
+
Optional jku: string
+++Value of the jku property in the JWT header. If not provided the old legacy URL xsuaaCredentials.url/token_keys is used as a fallback which will not work for subscriber accounts created after 14th of April 2020.
+
+
Returns Promise<TokenKey[]>
+An array of TokenKeys.
+
+ -
+
-
+
+ ++++
Fetches verification keys from the XSUAA service for the given URL, with the given pair of credentials.
+Parameters
+-
+
-
+
url: string
+++URL of the XSUAA service instance.
+
+ -
+
clientId: string
+++Client ID of the XSUAA service instance.
+
+ -
+
clientSecret: string
+++Client secret of the XSUAA service instance.
+
+
Returns Promise<TokenKey[]>
+An array of TokenKeys.
+
+ -
+
filterFunction
+ -
+
+
+
+
-
+
-
+
+
Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
functionName: string
+
+ -
+
returnType: "boolean"
+
+ -
+
Rest ...parameters: FilterFunctionParameterType<EntityT>[]
+
+
Returns BooleanFilterFunction<EntityT>
+
+ -
+
-
+
+
Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
functionName: string
+
+ -
+
returnType: "int" | "double" | "decimal"
+
+ -
+
Rest ...parameters: FilterFunctionParameterType<EntityT>[]
+
+
Returns NumberFilterFunction<EntityT>
+
+ -
+
-
+
+
Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
functionName: string
+
+ -
+
returnType: "string"
+
+ -
+
Rest ...parameters: FilterFunctionParameterType<EntityT>[]
+
+
Returns StringFilterFunction<EntityT>
+
+ -
+
filterFunctionV4
+ -
+
+
+
+
+
+
+
+
+
-
+
-
+
+
Type parameters
+-
+
-
+
EntityT: EntityV4<EntityT>
+
+
Parameters
+-
+
-
+
functionName: string
+
+ -
+
returnType: "boolean"
+
+ -
+
Rest ...parameters: FilterFunctionParameterType<EntityT>[]
+
+
Returns BooleanFilterFunction<EntityT>
+
+ -
+
-
+
+
Type parameters
+-
+
-
+
EntityT: EntityV4<EntityT>
+
+
Parameters
+-
+
-
+
functionName: string
+
+ -
+
returnType: "int" | "double" | "decimal"
+
+ -
+
Rest ...parameters: FilterFunctionParameterType<EntityT>[]
+
+
Returns NumberFilterFunction<EntityT>
+
+ -
+
-
+
+
Type parameters
+-
+
-
+
EntityT: EntityV4<EntityT>
+
+
Parameters
+-
+
-
+
functionName: string
+
+ -
+
returnType: "string"
+
+ -
+
Rest ...parameters: FilterFunctionParameterType<EntityT>[]
+
+
Returns StringFilterFunction<EntityT>
+
+ -
+
-
+
+
Type parameters
+-
+
-
+
EntityT: EntityV4<EntityT>
+
+
Parameters
+-
+
-
+
functionName: string
+
+ -
+
returnType: "datetimeoffset"
+
+ -
+
Rest ...parameters: FilterFunctionParameterType<EntityT>[]
+
+
Returns DateFilterFunction<EntityT>
+
+ -
+
-
+
+
Type parameters
+-
+
-
+
EntityT: EntityV4<EntityT>
+
+
Parameters
+-
+
-
+
functionName: string
+
+ -
+
returnType: "boolean[]"
+
+ -
+
Rest ...parameters: FilterFunctionParameterType<EntityT>[]
+
+
Returns CollectionFilterFunction<EntityT, boolean>
+
+ -
+
-
+
+
Type parameters
+-
+
-
+
EntityT: EntityV4<EntityT>
+
+
Parameters
+-
+
-
+
functionName: string
+
+ -
+
returnType: "string[]"
+
+ -
+
Rest ...parameters: FilterFunctionParameterType<EntityT>[]
+
+
Returns CollectionFilterFunction<EntityT, string>
+
+ -
+
-
+
+
Type parameters
+-
+
-
+
EntityT: EntityV4<EntityT>
+
+
Parameters
+-
+
-
+
functionName: string
+
+ -
+
returnType: "int[]" | "double[]" | "decimal[]"
+
+ -
+
Rest ...parameters: FilterFunctionParameterType<EntityT>[]
+
+
Returns CollectionFilterFunction<EntityT, number>
+
+ -
+
-
+
+
Type parameters
+-
+
-
+
EntityT: EntityV4<EntityT>
+
+
Parameters
+-
+
-
+
functionName: string
+
+ -
+
returnType: "datetimeoffset[]"
+
+ -
+
Rest ...parameters: FilterFunctionParameterType<EntityT>[]
+
+
Returns CollectionFilterFunction<EntityT, moment.Moment>
+
+ -
+
filterNullishValues
+ -
+
+
-
+
-
+
+ + ++
Parameters
+-
+
-
+
headers: Record<string, any> = ...
+++A header object to be filtered.
+
+
Returns Record<string, any>
+-
+
- A filtered header object containing only headers with non-nullish values. +
+ -
+
floor
+-
+
+
-
+
-
+
+ ++++
Build a filter function to floor a number. Evaluates to double or decimal, defaults to double.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
num: number | Field<EntityT> | NumberFilterFunction<EntityT>
+++The number to floor. This can either be a number, a reference to a field or another filter function.
+
+ -
+
Optional returnType: "double" | "decimal"
+++The return type to use.
+
+
Returns NumberFilterFunction<EntityT>
+The newly created filter function
+
+ -
+
fractionalSeconds
+ -
+
+
-
+
-
+
+ ++++
Build a filter function to get the fractional seconds of a date. Evaluates to decimal.
+Type parameters
+-
+
-
+
EntityT: EntityV4<EntityT>
+
+
Parameters
+-
+
-
+
date: moment.Moment | Field<EntityT>
+++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
+
+ -
+
getAgentConfig
+ -
+
+
-
+
-
+
+ ++++
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: Destination
+++determining which kind of configuration is returned
+
+
Returns HttpAgentConfig | HttpsAgentConfig
+The http or http-agent configuration.
+
+ -
+
getAuthHeaders
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
destination: Destination
+
+ -
+
Optional customHeaders: Record<string, any>
+
+
Returns Promise<Record<string, string>>
+
+ -
+
getAxiosConfigWithDefaults
+ -
+
+
-
+
-
+
+ ++++
Builds an Axios config with default configuration i.e. no_proxy, default http and https agent and GET as request method.
+Returns HttpRequestConfig
+AxiosRequestConfig with default parameters
+
+
getAxiosConfigWithDefaultsWithoutMethod
+ -
+
+
-
+
-
+
+
Returns Omit<HttpRequestConfig, "method">
+
+
getCollectionResult
+ -
+
+
-
+
-
+
+ ++++
Extract the collection data from the response. + If the data does not contain a collection an empty array is returned.
+Parameters
+-
+
-
+
data: any
+++Response of the OData v4 service
+
+
Returns any[]
+any[] - Collection extracted from the response
+
+ -
+
getDestination
+ -
+
+
-
+
-
+
+ ++++
Builds a destination from one of three sources (in the given order):
+-
+
- from the environment variable "destinations" +
- from service bindings +
- from the destination service +
If you want to get a destination only from a specific source, use the corresponding function directly + (
+getDestinationFromEnvByName,destinationForServiceBinding,getDestinationFromDestinationService).Parameters
+-
+
-
+
name: string
+++The name of the destination to be retrieved.
+
+ -
+
Optional options: DestinationOptions
+++Configuration for how to retrieve destinations from the destination service.
+
+
Returns Promise<Destination | null>
+A promise returning the requested destination on success.
+
+
getDestinationBasicCredentials
+ -
+
+
-
+
-
+
+ ++++
Basic Credentials Getter from Destination service credentials needed for JWT generator.
+Returns BasicCredentials
+Basic credentials.
+
+
getDestinationByName
+ -
+
+
-
+
-
+
+ + ++
Parameters
+-
+
-
+
name: string
+++Name of the destination
+
+
Returns Destination | null
+The requested destination if existent, otherwise
+null
+ -
+
getDestinationFromDestinationService
+ -
+
+
-
+
-
+
+ ++++
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.
+If the destinations are read from the environment, the jwt will be ignored.
+Parameters
+-
+
-
+
name: string
+++The name of the destination to be retrieved.
+
+ -
+
options: DestinationOptions
+++Configuration for how to retrieve destinations from the destination service.
+
+
Returns Promise<Destination | null>
+A promise returning the requested destination on success.
+
+ -
+
getDestinationFromEnvByName
+ -
+
+
-
+
-
+
+ ++++
Get a destination from the environment variables by name. If there are multiple destinations with the same name the first one will be used. + This is discouraged for productive use! Use destination-accessor/useOrFetchDestination for fetching destinations + from the Cloud Foundry destination service.
+Parameters
+-
+
-
+
name: string
+++Name of the destination
+
+
Returns Destination | null
+The requested destination if existent, otherwise
+null
+ -
+
getDestinationOptions
+ -
+
+
-
+
-
+
+ + ++
Parameters
+-
+
-
+
name: string
+++The name of the destination to be retrieved.
+
+ -
+
Optional options: DestinationOptions
+++The options of the fetching query of the destination that include the JWT of the current request and the strategy for selecting a destination.
+
+
Returns Promise<Destination | null>
+A promise returning the requested destination on success.
+
+ -
+
getDestinationService
+ -
+
+
-
+
-
+
+ ++++ +
Get destination service if one is present.
+Returns Service
+Destination service
+
+
getDestinationServiceCredentials
+ -
+
+
-
+
-
+
+ ++++
First 'destination' credentials getter.
+Returns any
+The 'destination' credentials object or null if it does not exist.
+
+
getDestinationServiceCredentialsList
+ -
+
+
-
+
-
+
+ ++++
Destination credentials getter.
+Returns DestinationServiceCredentials[]
+A list of 'credentials' objects in 'destination' service.
+
+
getDestinationServiceUri
+ -
+
+
-
+
-
+
+ ++++
Destination URI getter + NOTICE: If there exist more than one destination/uri, the function + returns the first entry.
+Returns string | null
+The first existing uri in destination or null if not found.
+
+
getDestinations
+ -
+
+
-
+
-
+
+ + ++
Returns Destination[]
+A list of destinations
+
+
getDestinationsFromEnv
+ -
+
+
-
+
-
+
+ ++++
Get all destinations from the environment variable "destinations". + This is discouraged for productive use! Use useOrFetchDestination for fetching destinations from the Cloud Foundry destination service.
+Returns Destination[]
+A list of destinations
+
+
getEdmType
+ -
+
+
-
+
-
+
+ ++++
Convenience method to get the EdmTypeShared from the overloaded constructor. + The two scenarios are complexTypeNameOrEdmType = EdmTypeShared and edmTypeOrUndefined = undefined or complexTypeNameOrEdmType = string of complextype and edmTypeOrUndefined = EdmTypeShared.
+Type parameters
+-
+
-
+
T: ODataVersion
+
+
Parameters
+-
+
-
+
complexTypeNameOrEdmType: string | EdmTypeShared<T>
+++Either the name of the complex type or the EdmType
+
+ -
+
Optional edmTypeOrUndefined: EdmTypeShared<T>
+++Either the EdmType or undefined.
+
+
Returns EdmTypeShared<T>
+The EdmType resolved for the two arguments.
+
+ -
+
getEntityConstructor
+ -
+
+
-
+
-
+
+ ++++
Convenience method to get the entity constructor of the parent of a complex type.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+ -
+
ComplexT
+
+
Parameters
+-
+
-
+
fieldOf: ConstructorOrField<EntityT, ComplexT>
+++Either an entity constructor or another complex type field.
+
+
Returns Constructable<EntityT>
+The constructor of the transitive parent entity;
+
+ -
+
getEntityKeys
+ -
+
+
-
+
-
+
+ ++++
Helper function that maps an entity to its keys map with their original names.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
entity: EntityT
+++Entity to map
+
+ -
+
entityConstructor: Constructable<EntityT>
+++The constructor of the entity
+
+
Returns Record<string, any>
+object that includes all keys that represent given entity
+
+ -
+
getEnvironmentVariable
+ -
+
+
-
+
-
+
+ ++++
Environment variables accessor.
+Parameters
+-
+
-
+
name: string
+++Environment variable name.
+
+
Returns string | undefined | null
+Env variable value if defined. + null: If not defined.
+
+ -
+
getExpand
+ -
+
+
-
+
-
+
+ ++++
Get an object containing the given expand as a query parameter, or an empty object if none was given. + In this OData v2 expand, selected properties are automatically added to the expand.
+Type parameters
+-
+
-
+
EntityT: Entity<EntityT>
+++Type of the entity to expand on
+
+
Parameters
+-
+
-
+
Optional selects: Selectable<EntityT>[]
+++The selects which are expanded if necessary
+
+
Returns Partial<{ expand: string }>
+An object containing the query parameter or an empty object
+
+ -
+
getExpandV4
+ -
+
+
-
+
-
+
+ ++++
Get an object containing the given expand as a query parameter, or an empty object if none was given.
+Type parameters
+-
+
-
+
EntityT: EntityV4<EntityT>
+++Type of the entity to expand on
+
+
Parameters
+-
+
-
+
expands: Expandable<EntityT>[] | undefined
+++The expands to transform to a query parameter
+
+ -
+
entityConstructor: Constructable<EntityT>
+++Constructor type of the entity to expand on
+
+
Returns Partial<{ expand: string }>
+An object containing the query parameter or an empty object
+
+ -
+
getGrantTokenCacheKey
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
url: string
+
+ -
+
credentials: ClientCredentials
+
+
Returns string
+
+ -
+
getHeader
+ -
+
+
-
+
-
+
+ + ++
Parameters
+-
+
-
+
key: string
+++Name of the header to be found.
+
+ -
+
headers: Record<string, any> = ...
+++Header object to be searched for given key.
+
+
Returns Record<string, any>
+-
+
- An object containing the given key (and value) in its original case, as found in
headersor an empty object if not found.
+
+ -
+
getHeaderValue
+ -
+
+
-
+
-
+
+ + ++
Parameters
+-
+
-
+
key: string
+++Name of the header to be found.
+
+ -
+
headers: Record<string, any> = ...
+++Header object to be searched for given key.
+
+
Returns any | undefined
+The value of the header with the given key or undefined.
+
+ -
+
getHeaders
+ -
+
+
-
+
-
+
+ + ++
Parameters
+-
+
-
+
keys: string[]
+++Name of the header to be found.
+
+ -
+
headers: Record<string, any> = ...
+++Header object to be searched for given key.
+
+
Returns Record<string, any>
+-
+
- An object containing the given keys (and values) in its original case, as found in
headersor an empty object if not found.
+
+ -
+
getLine
+ -
+
+
-
+
-
+
+ + ++
Parameters
+-
+
-
+
request: MethodRequestBuilder
+ +
+
Returns string
+The seralized request as
+.
+ -
+
getLinkedCollectionResult
+ -
+
+
-
+
-
+
+ ++++
Extract the collection data from the one to many link response. + If the data does not contain a collection an empty array is returned.
+Parameters
+-
+
-
+
data: any
+++Response of the one to many link
+
+
Returns any[]
+any[] - Collection extracted from the response
+
+ -
+
getOAuth2ClientCredentialsToken
+ -
+
+
-
+
-
+
+ ++++
Retrieves an access token required for "OAuth2ClientCredentials" destination authentication type.
+Parameters
+-
+
-
+
destination: Destination
+++A destination having
+OAuth2ClientCredentialsauthentication type
+
Returns Promise<ClientCredentialsResponse>
+A promise returning the requested access token on success.
+
+ -
+
getOrderBy
+ -
+
+
-
+
-
+
+ ++++
Get an object containing the given order bys as query parameter, or an empty object if none was given.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+++Type of the entity to order
+
+
Parameters
+-
+
-
+
orderBy: Orderable<EntityT>[]
+++A list of orderables to get the query parameters for
+
+
Returns Partial<{ orderby: string }>
+An object containing the query parameter or an empty object
+
+ -
+
getProtocolOrDefault
+ -
+
+
-
+
-
+
+ ++++ +
Extracts the http protocol from the destination url. The default value is http if no protocol is given.
+Parameters
+-
+
-
+
destination: Destination
+++URL of this destination is parsed
+
+
Returns Protocol
+The protocol, either https or http.
+
+ -
+
getQueryParametersForFilter
+ -
+
+
-
+
-
+
+ + ++
Type parameters
+-
+
-
+
EntityT: Entity<EntityT>
+++Type of the entity to filter on
+
+
Parameters
+-
+
-
+
filter: Filterable<EntityT>
+++The filter to transform to a query parameter
+
+ -
+
entityConstructor: Constructable<EntityT>
+++Constructor type of the entity to filter on
+
+
Returns Partial<{ filter: string }>
+An object containing the query parameter or an empty object
+
+ -
+
getQueryParametersForOrderBy
+ -
+
+
-
+
-
+
+ + ++
Type parameters
+-
+
-
+
EntityT: Entity<EntityT>
+++Type of the entity to order
+
+
Parameters
+-
+
-
+
orderBy: Orderable<EntityT>[]
+++A list of orderables to get the query parameters for
+
+
Returns Partial<{ orderby: string }>
+An object containing the query parameter or an empty object
+
+ -
+
getQueryParametersForSelection
+ -
+
+
-
+
-
+
+ + ++
Type parameters
+-
+
-
+
EntityT: Entity<EntityT>
+++Type of the entity to get the selection for
+
+
Parameters
+-
+
-
+
Optional selects: Selectable<EntityT>[]
+++The list of selectables to be transformed to query parameters
+
+
Returns Partial<{ expand: string; select: string }>
+An object containing the query parameters or an empty object
+
+ -
+
getResourcePathForKeys
+ -
+
+
-
+
-
+
+ + ++
Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+++Type of the entity to get the resource path for
+
+
Parameters
+-
+
-
+
keys: Record<string, FieldType> | undefined
+++Key-value pairs where the key is the name of a key property of the given entity and the value is the respective value
+
+ -
+
entityConstructor: Constructable<EntityT>
+++Constructor type of the entity to get the resource path for
+
+
Returns string
+The path to the resource
+
+ -
+
getResponseBody
+ -
+
+
-
+
-
+
+ ++++
Get the response body from the string representation of a response.
+Parameters
+-
+
-
+
response: string
+++String representation of a response.
+
+
Returns string
+The response body as a one line string.
+
+ -
+
getSelect
+ -
+
+
-
+
-
+
+ ++++
Get an object containing the given Selectables as query parameter, or an empty object if none were given. + This retrieves where in addition to the selection (
+select) there is also an expansion (expand) needed.Type parameters
+-
+
-
+
EntityT: Entity<EntityT>
+++Type of the entity to get the selection for
+
+
Parameters
+-
+
-
+
Optional selects: Selectable<EntityT>[]
+++The list of selectables to be transformed to query parameters
+
+
Returns Partial<{ select: string }>
+An object containing the query parameters or an empty object
+
+ -
+
getSelectV4
+ -
+
+
-
+
-
+
+ ++++
Get an object containing the given Selectables as query parameter, or an empty object if none were given. + In OData v4 selected properties are not automatically expanded anymore and a manual expand needs to be performed.
+Type parameters
+-
+
-
+
EntityT: EntityV4<EntityT>
+++Type of the entity to get the selection for
+
+
Parameters
+-
+
-
+
Optional selects: Selectable<EntityT>[]
+++The list of selectables to be transformed to query parameters
+
+
Returns Partial<{ select: string }>
+An object containing the query parameters or an empty object
+
+ -
+
getService
+ -
+
+
-
+
-
+
+ ++++
Returns the first found instance for the given service type.
+Parameters
+-
+
-
+
service: string
+++The service type.
+
+
Returns Service | undefined
+The first found service.
+
+ -
+
getServiceCredentialsList
+ -
+
+
-
+
-
+
+ ++++
Credentials list getter for a given service.
+Parameters
+-
+
-
+
service: string
+++Service name
+
+
Returns any[]
+Fetched credentials objects of existing service in 'VCAP_SERVICES'.
+
+ -
+
getServiceList
+ -
+
+
-
+
-
+
+ ++++
Services getter for a given service.
+Parameters
+-
+
-
+
service: string
+++Service name.
+
+
Returns Service[]
+List of service bindings of the given type. Returns an empty array if no service binding exists for the given type.
+
+ -
+
getSingleResult
+ -
+
+
-
+
-
+
+ ++++
Extract the single entry data from the response. + If the data does not contain a single object an empty object is returned.
+Parameters
+-
+
-
+
data: any
+++Response of the OData v4 service
+
+
Returns Record<string, any>
+Record<string, any> - single object extracted from the response
+
+ -
+
getUrlProtocol
+ -
+
+
-
+
-
+
+ + ++
Parameters
+-
+
-
+
destination: Destination
+++URL of this destination is parsed
+
+
Returns Protocol | undefined
+The protocol either undefined if no :// is found or anything before the delimiter.
+
+ -
+
getVcapService
+ -
+
+
-
+
-
+
+ ++++
'VCAP_SERVICES' Getter from environment variables. + This function returns the VCAP_SERVICES as object or null if it is not defined (i.e. no services are bound to the application).
+Returns Record<string, any> | null
+'VCAP_SERVICES' found in environment variables or null if not defined. The key denotes the name ov the service and the value is the definition.
+
+
getXsuaaServiceCredentials
+ -
+
+
-
+
-
+
+ ++++
Takes a decoded JWT and uses the client_id and audience claims to determine the XSUAA service instance + that issued the JWT. Returns the credentials if a match is found, otherwise throws an error. + If no decoded JWT is specified, then returns the first existing XSUAA credential service plan "application".
+Parameters
+-
+
-
+
Optional token: DecodedJWT | string
+++Either an encoded or decoded JWT.
+
+
Returns XsuaaServiceCredentials
+The credentials for a match, otherwise null.
+
+ -
+
hasSubsequence
+ -
+
+
-
+
-
+
+ ++++
Build a filter function to test whether a set is a subsequence of the other, i. e. wheter the second parameter can be transformed into the first by removing items. Evaluates to boolean.
+Type parameters
+-
+
-
+
EntityT: EntityV4<EntityT>
+
+ -
+
ParamT: FilterFunctionPrimitiveParameterType
+
+ -
+
ReturnT: FieldType
+
+
Parameters
+-
+
-
+
subsequence: ParamT[] | Field<EntityT> | CollectionFilterFunction<EntityT, ReturnT>
+++The subsequence to test for. This can either be an array, a reference to a field or another filter function.
+
+ -
+
sequence: ParamT[] | Field<EntityT> | CollectionFilterFunction<EntityT, ReturnT>
+++The sequence to test. This can either be an array, a reference to a field or another filter function.
+
+
Returns BooleanFilterFunction<EntityT>
+The newly created filter function
+
+ -
+
hasSubset
+ -
+
+
-
+
-
+
+ ++++
Build a filter function to test whether a set is a subset of the other, i. e. wheter the second parameter can be transformed into the first by reordering and / or removing items. Evaluates to boolean.
+Type parameters
+-
+
-
+
EntityT: EntityV4<EntityT>
+
+ -
+
ParamT: FilterFunctionPrimitiveParameterType
+
+ -
+
ReturnT: FieldType
+
+
Parameters
+-
+
-
+
subset: ParamT[] | CollectionField<EntityT, any> | CollectionFilterFunction<EntityT, ReturnT>
+++The subset to test for. This can either be an array, a reference to a field or another filter function.
+
+ -
+
set: ParamT[] | CollectionField<EntityT, any> | CollectionFilterFunction<EntityT, ReturnT>
+++The set to test. This can either be an array, a reference to a field or another filter function.
+
+
Returns BooleanFilterFunction<EntityT>
+The newly created filter function
+
+ -
+
headerForClientCredentials
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
clientCredentials: ClientCredentials
+
+
Returns string
+
+ -
+
hour
+-
+
+
-
+
-
+
+ ++++
Build a filter function to get the hour of a date. Evaluates to int.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
date: moment.Moment | Field<EntityT>
+++The date to get the hour for. This can either be a date (Moment) or a reference to a field.
+
+
Returns NumberFilterFunction<EntityT>
+The newly created filter function
+
+ -
+
indexOf
+ -
+
+
-
+
-
+
+ ++++
Build a filter function to get the start index of a substring. Evaluates to int.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
str: string | Field<EntityT> | StringFilterFunction<EntityT>
+++The string to get the index from. This can either be a string, a reference to a field or another filter function.
+
+ -
+
substr: string | Field<EntityT> | 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 NumberFilterFunction<EntityT>
+The newly created filter function
+
+ -
+
isCollectionResult
+ -
+
+
-
+
-
+
+ ++++
Checks if the data contains a collection result.
+Parameters
+-
+
-
+
data: any
+++Response of the OData v4 service
+
+
Returns boolean
+boolean - true if the data is a collection result
+
+ -
+
isComplexTypeNameSpace
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
val: any
+
+
Returns val is ComplexTypeNamespace<any>
+
+ -
+
isDestination
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
destination: any
+
+
Returns destination is Destination
+
+ -
+
isDestinationNameAndJwt
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
destination: any
+
+
Returns destination is DestinationNameAndJwt
+
+ -
+
isEdmType
+ -
+
+
-
+
-
+
+ ++++
Check whether a value is an EdmType. This will yield positive results for every string starting with
+Edm..Parameters
+-
+
-
+
val: any
+++Value to test.
+
+
Returns val is EdmTypeShared<VersionT>
+Whether the given value is of type EdmTypeShared
+
+ -
+
isFilter
+ -
+
+
-
+
-
+
+
Type parameters
+-
+
-
+
T: EntityBase<T>
+
+ -
+
FieldT: FieldType
+
+
Parameters
+-
+
-
+
filterable: Filterable<T>
+
+
Returns filterable is Filter<T, FieldT>
+
+ -
+
isFilterLambdaExpression
+ -
+
+
-
+
-
+
+ ++++
hidden
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+ -
+
FieldT: FieldType
+
+
Parameters
+-
+
-
+
filterable: Filterable<EntityT>
+
+
Returns filterable is FilterLambdaExpression<EntityT, FieldT>
+
+ -
+
isFilterLink
+ -
+
+
-
+
-
+
+
Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+ -
+
LinkedT: EntityBase<LinkedT>
+
+
Parameters
+-
+
-
+
filterable: Filterable<EntityT>
+
+
Returns filterable is FilterLink<EntityT, LinkedT>
+
+ -
+
isFilterList
+ -
+
+
-
+
-
+
+
Type parameters
+-
+
-
+
T: EntityBase<T>
+
+
Parameters
+-
+
-
+
filterable: Filterable<T>
+
+
Returns filterable is FilterList<T>
+
+ -
+
isHttpSuccessCode
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
httpCode: any
+
+
Returns boolean
+
+ -
+
isIdenticalTenant
+ -
+
+
-
+
-
+
+ ++++
Compare two decoded JWTs based on their tenantIds.
+Parameters
+-
+
-
+
decodedUserToken: DecodedJWT
+++User JWT
+
+ -
+
decodedProviderToken: DecodedJWT
+++Provider JWT
+
+
Returns boolean
+Whether the tenant is identical.
+
+ -
+
isNavigationProperty
+ -
+
+
-
+
-
+
+ ++++
Checks if the property with name key of the entity is a navigation property.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
key: string
+++Name of the property.
+
+ -
+
entityConstructor: any
+++Constructor of the entity.
+
+
Returns boolean
+A boolean denoting whether an entity is a navigation property or not.
+
+ -
+
isOf
+ -
+
+
+
-
+
-
+
+ ++++
Build a filter function to test whether a selection is of a given type. Evaluates to boolean.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
type: string
+++The type to test for, e. g.
+API_BUSINESS_PARTNER.A_BusinessPartner.
+
Returns BooleanFilterFunction<EntityT>
+The newly created filter function
+
+ -
+
-
+
+ ++++
Build a filter function to test whether a field is of a given type. Evaluates to boolean.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
expression: Field<EntityT>
+++A reference to a field to test for type.
+
+ -
+
type: string
+++The type to test for, e. g.
+API_BUSINESS_PARTNER.A_BusinessPartner.
+
Returns BooleanFilterFunction<EntityT>
+The newly created filter function
+
+ -
+
isWithETag
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
config: any
+
+
Returns config is WithETag
+
+ -
+
issuerUrl
+ -
+
+
-
+
-
+
+ ++++
Get the issuer url of a decoded JWT.
+Parameters
+-
+
-
+
decodedToken: DecodedJWT
+++Token to read the issuer url from.
+
+
Returns string | undefined
+The issuer url if available.
+
+ -
+
length
+-
+
+
-
+
-
+
+ ++++
Build a filter function to get the length of a string. Evaluates to int.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
str: string | Field<EntityT> | 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
+
+ -
+
matchesPattern
+ -
+
+
-
+
-
+
+ ++++
Build a filter function to test whether a string matches a pattern. Evaluates to boolean.
+Type parameters
+-
+
-
+
EntityT: EntityV4<EntityT>
+
+
Parameters
+-
+
-
+
str: string | Field<EntityT> | 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
+
+ -
+
maxDateTime
+ -
+
+
-
+
-
+
+ ++++
Build a filter function to get the latest possible point in time. Evaluates to DateTimeOffset.
+Type parameters
+-
+
-
+
EntityT: EntityV4<EntityT>
+
+
Returns NumberFilterFunction<EntityT>
+The newly created filter function
+
+ -
+
mergeHeaders
+ -
+
+
-
+
-
+
+ + ++
Parameters
+-
+
-
+
headers: Record<string, any> = ...
+++A base header object that contains the headers that will be compared with
+customHeaders.
+ -
+
customHeaders: Record<string, any> = ...
+++A header object to be compared with headers. Only headers present in
+headerswill be compared.
+
Returns Record<string, any>
+-
+
- An object containing all keys from both the header objects, where headers present in the
customHeadersare replaced. Note that the case (upper / lower) used bycustomHeaderswill be used.
+
+ -
+
minDateTime
+ -
+
+
-
+
-
+
+ ++++
Build a filter function to get the earliest possible point in time. Evaluates to DateTimeOffset.
+Type parameters
+-
+
-
+
EntityT: EntityV4<EntityT>
+
+
Returns NumberFilterFunction<EntityT>
+The newly created filter function
+
+ -
+
minute
+-
+
+
-
+
-
+
+ ++++
Build a filter function to get the minute of a date. Evaluates to int.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
date: moment.Moment | Field<EntityT>
+++The date to get the minute for. This can either be a date (Moment) or a reference to a field.
+
+
Returns NumberFilterFunction<EntityT>
+The newly created filter function
+
+ -
+
month
+-
+
+
-
+
-
+
+ ++++
Build a filter function to get the month of a date. Evaluates to int.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
date: moment.Moment | Field<EntityT>
+++The date to get the month for. This can either be a date (Moment) or a reference to a field.
+
+
Returns NumberFilterFunction<EntityT>
+The newly created filter function
+
+ -
+
Const nonEnumerable
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
target: any
+
+ -
+
propertyKey: string
+
+
Returns void
+
+ -
+
now
+-
+
+
-
+
-
+
+ ++++
Build a filter function to get the current point in time. Evaluates to DateTimeOffset.
+Type parameters
+-
+
-
+
EntityT: EntityV4<EntityT>
+
+
Returns NumberFilterFunction<EntityT>
+The newly created filter function
+
+ -
+
or
+-
+
+
+
-
+
-
+
+ ++++
Create a FilterList by combining Filterables with logical
+or.Example:
+
+Entity.requestBuilder() + .getAll() + .filter(or(filterExp1, filterExp2)); +Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+++Type of the entity to be filtered on
+
+
Parameters
+-
+
-
+
expressions: Filterable<EntityT>[]
+++Filterables to be combined with logical
+or
+
Returns FilterList<EntityT>
+The newly created FilterList
+
+ -
+
-
+
+
Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
Rest ...expressions: Filterable<EntityT>[]
+
+
Returns FilterList<EntityT>
+
+ -
+
parseBatchResponse
+ -
+
+
-
+
-
+
+ ++++
Parse the complete batch HTTP response.
+Parameters
+-
+
-
+
batchResponse: HttpResponse
+++HTTP response of a batch request.
+
+
Returns (ResponseData | ResponseData[])[]
+An array of parsed sub responses of the batch response.
+
+ -
+
parseDestination
+ -
+
+
-
+
-
+
+ ++++
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.
+Parameters
+-
+
-
+
destinationJson: DestinationJson | DestinationConfiguration
+++A JSON object returned by the destination service.
+
+
Returns Destination
+An SDK compatible destination object.
+
+ -
+
parseEntityNameFromMetadataUri
+ -
+
+
-
+
-
+
+ ++++
Parse the entity name from the metadata uri. This should be the
+__metadataproperty of a single entity in the response.Parameters
+-
+
-
+
uri: string
+++The URI to parse the entity name from
+
+
Returns string
+The entity name.
+
+ -
+
parseHttpCode
+ -
+
+
-
+
-
+
+ ++++
Parse the HTTP code of response.
+Parameters
+-
+
-
+
response: string
+++String representation of the response.
+
+
Returns number
+The HTTP code.
+
+ -
+
parseProxyEnv
+ -
+
+
-
+
-
+
+ ++++
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.
+
+ -
+
parseResponseData
+ -
+
+
-
+
-
+
+ ++++
Parse the body and http code of a batch sub response.
+Parameters
+-
+
-
+
response: string
+++A batch sub response.
+
+
Returns ResponseData
+The parsed response.s
+
+ -
+
prependDollar
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
param: string
+
+
Returns string
+
+ -
+
proxyAgent
+ -
+
+
-
+
-
+
+ ++++
Builds the http(s)-agent config. Note that the proxy agent type like http or https is determined by the destination RUL protocol. + The protocol from the proxy is unrelated to this and in most cases http.
+Parameters
+-
+
-
+
destination: Destination
+++Destination containing the proxy configurations
+
+
Returns HttpAgentConfig | HttpsAgentConfig
+The http(s)-agent containing the proxy configuration
+
+ -
+
proxyStrategy
+ -
+
+
-
+
-
+
+ ++++
Determines the proxy strategy. If noProxy is set the ProxyConfiguration in the destination is omitted. + For onPremProxy or internetProxy the connectivy service or enviroment variables are checked to fill the ProxyConfiguration.
+Parameters
+-
+
-
+
destination: Destination
+++from which the proxy strategy is derived.
+
+
Returns ProxyStrategy
+ProxyStrategy possible values are noProxy, internetProxy or onPremProxy.
+
+ -
+
readPropertyWithWarn
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
decodedJwt: DecodedJWT
+
+ -
+
property: string
+
+
Returns any
+
+ -
+
refreshTokenGrant
+ -
+
+
-
+
-
+
+ ++++
Executes a refresh token grant request against the given URI. + If the first parameter is an instance of XsuaaServiceCredentials, the response's access_token will be verified. + If the first parameter is an URI, the response will not be verified.
+Parameters
+-
+
-
+
tokenServiceUrlOrXsuaaServiceCerednetials: string | XsuaaServiceCredentials
+++The URL of the token service or the credentials of a XSUAA service instance.
+
+ -
+
clientCredentials: ClientCredentials
+++The credentials (client_id, client_secret) if the target XSUAA service instance.
+
+ -
+
refreshToken: string
+++The refresh token that should be used to generate a new access token.
+
+ -
+
Optional options: ResilienceOptions
+++Options to use by retrieving access token.
+
+
Returns Promise<UserTokenResponse>
+A promise resolving to the response of the XSUAA service.
+
+ -
+
removePropertyOnCondition
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
condition: (objectEntry: [string, any]) => boolean
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
objectEntry: [string, any]
+
+
Returns boolean
+
+ -
+
+ -
+
+ -
+
-
+
body: Record<string, any>
+
+
Returns Record<string, any>
+
+ -
+
replaceDuplicateKeys
+ -
+
+
-
+
-
+
+ + ++
Parameters
+-
+
-
+
headers: Record<string, any> = ...
+++A base header object that contains the headers that will be compared with
+customHeaders.
+ -
+
customHeaders: Record<string, any> = ...
+++A header object to be compared with headers. Only headers present in
+headerswill be compared.
+
Returns Record<string, any>
+-
+
- An object containing all keys from the original
headersobject, where headers present in thecustomHeadersare replaced. Note that the case (upper / lower) used bycustomHeaderswill be used.
+
+ -
+
resolveService
+ -
+
+
-
+
-
+
+ ++++
Takes a string that represents the service type and resolves it by calling getService. + If the parameter is already an instance of Service, it is returned directly.
+Throws an error when no service can be found for the given type.
+Parameters
+-
+
-
+
service: string | Service
+++A string representing the service type or a Service instance.
+
+
Returns Service
+A Service instance.
+
+ -
+
retrieveJwt
+ -
+
+
-
+
-
+
+ ++++
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
+
+ -
+
round
+-
+
+
-
+
-
+
+ ++++
Build a filter function to round a number. Evaluates to double or decimal, defaults to double.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
num: number | Field<EntityT> | NumberFilterFunction<EntityT>
+++The number to round. This can either be a number, a reference to a field or another filter function.
+
+ -
+
Optional returnType: "double" | "decimal"
+++The return type to use.
+
+
Returns NumberFilterFunction<EntityT>
+The newly created filter function
+
+ -
+
sanitizeDestination
+ -
+
+
-
+
-
+
+ ++++
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.
+
+ -
+
searchServiceBindingForDestination
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
name: string
+
+
Returns Destination | undefined
+
+ -
+
second
+-
+
+
-
+
-
+
+ ++++
Build a filter function to get the second of a date. Evaluates to int.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
date: moment.Moment | Field<EntityT>
+++The date to get the second for. This can either be a date (moment.Moment) or a reference to a field.
+
+
Returns NumberFilterFunction<EntityT>
+The newly created filter function
+
+ -
+
secondsToTime
+ -
+
+
serializeBatchRequest
+ -
+
+
-
+
-
+
+ ++++
Serialize a batch request to string. This is used for the batch request payload when executing the request.
+Parameters
+-
+
-
+
request: BatchRequestBuilder
+++Batch request to serialize.
+
+ -
+
Optional options: BatchRequestSerializationOptions
+++Request serialization options.
+
+
Returns string
+String representation of the batch request.
+
+ -
+
serializeChangeSet
+ -
+
+
-
+
-
+
+ ++++
Serialize change set to string.
+Parameters
+-
+
-
+
changeSet: BatchChangeSet
+++Change set containing a collection of write operations.
+
+ -
+
Optional options: BatchRequestSerializationOptions
+++Request serialization options.
+
+
Returns string | undefined
+The serialized string representation of a change set.
+
+ -
+
Const serializeComplexType
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
fieldValue: any
+
+ -
+
complexTypeNameSpace: any
+
+
Returns any
+
+ -
+
Const serializeComplexTypeV4
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
fieldValue: any
+
+ -
+
complexTypeNameSpace: any
+
+
Returns any
+
+ -
+
Const serializeEntity
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
entity: any
+
+ -
+
entityConstructor: Constructable<any, unknown>
+
+ -
+
Optional diff: boolean
+
+
Returns Record<string, any>
+
+ -
+
Const serializeEntityNonCustomFields
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
entity: any
+
+ -
+
entityConstructor: Constructable<any, unknown>
+
+
Returns Record<string, any>
+
+ -
+
Const serializeEntityNonCustomFieldsV4
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
entity: any
+
+ -
+
entityConstructor: Constructable<any, unknown>
+
+
Returns Record<string, any>
+
+ -
+
serializeRequest
+ -
+
+
-
+
-
+
+ ++++
Serialize a multipart request to string.
+Parameters
+-
+
-
+
request: MethodRequestBuilder
+ +
+ -
+
Optional options: BatchRequestSerializationOptions
+++Request serialization options.
+
+
Returns string
+The serialized string representation of a multipart request, including the multipart headers.
+
+ -
+
serviceToken
+ -
+
+
-
+
-
+
+ ++++
Returns an access token that can be used to call the given service. The token is fetched via a client credentials grant with the credentials of the given service. + If multiple instances of the provided service exist, the first instance will be selected. + When a JWT is passed, the tenant of the JWT will be used when performing the grant. + When no JWT is passed, the grant will be performed using the provider tenant.
+Throws an error if there is no instance of the given service type or the XSUAA service, or if the request to the XSUAA service fails.
+Parameters
+-
+
-
+
service: string | Service
+++The type of the service or an instance of Service.
+
+ -
+
Optional options: CachingOptions & ResilienceOptions & { userJwt?: string | DecodedJWT }
+++Options to influence caching and resilience behavior (see CachingOptions and ResilienceOptions, respectively) and a JWT. By default, caching and usage of a circuit breaker are enabled.
+
+
Returns Promise<string>
+Access token.
+
+ -
+
splitBatchResponse
+ -
+
+
-
+
-
+
+ ++++
Split a batch response into an array of sub responses for the retrieve requests and changesets.
+Parameters
+-
+
-
+
response: HttpResponse
+++The raw HTTP response.
+
+
Returns string[]
+A list of sub responses represented as strings.
+
+ -
+
splitChangeSetResponse
+ -
+
+
-
+
-
+
+ ++++
Split a changeset (sub) response into an array of sub responses.
+Parameters
+-
+
-
+
changeSetResponse: string
+++The string representation of a change set response.
+
+
Returns string[]
+A list of sub responses represented as strings.
+
+ -
+
splitResponse
+ -
+
+
-
+
-
+
+ ++++
Split a string representation of a response into sub responses given its boundary.
+Parameters
+-
+
-
+
response: string
+++The string representation of the response to split.
+
+ -
+
boundary: string
+++The boundary to split by.
+
+
Returns string[]
+A list of sub responses represented as strings.
+
+ -
+
startsWith
+ -
+
+
-
+
-
+
+ ++++
Build a filter function to test whether a string starts with another. Evaluates to boolean.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
str: string | Field<EntityT> | StringFilterFunction<EntityT>
+++The string to test. This can either be a string, a reference to a field or another filter function.
+
+ -
+
prefix: string | Field<EntityT> | StringFilterFunction<EntityT>
+++The prefix to test for. This can either be a string, a reference to a field or another filter function.
+
+
Returns BooleanFilterFunction<EntityT>
+The newly created filter function
+
+ -
+
subscriberFirst
+ -
+
+
-
+
-
+
+ ++++
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
+
+ -
+
substring
+-
+
+
-
+
-
+
+ ++++
Build a filter function to get a substring starting from a designated position. Evaluates to string.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
str: string | Field<EntityT> | 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> | NumberFilterFunction<EntityT>
+++The starting position of the substring. This can be either a number, a reference to a field or another filter function.
+
+ -
+
Optional len: number | Field<EntityT> | 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
+
+ -
+
substringOf
+ -
+
+
-
+
-
+
+ ++++
Build a filter function to test whether a string is a substring of the other. Evaluates to boolean.
+Type parameters
+-
+
-
+
EntityT: Entity<EntityT>
+
+
Parameters
+-
+
-
+
substr: string | Field<EntityT> | StringFilterFunction<EntityT>
+++The substring to test for. This can either be a string, a reference to a field or another filter function.
+
+ -
+
str: string | Field<EntityT> | StringFilterFunction<EntityT>
+++The string to test. This can either be a string, a reference to a field or another filter function.
+
+
Returns BooleanFilterFunction<EntityT>
+The newly created filter function
+
+ -
+
tenantFromJwt
+ -
+
+
-
+
-
+
+ ++++ +
Creates a tenant object from the decoded JWT.
+Parameters
+-
+
-
+
decodedJWT: DecodedJWT
+++Decoded JWT token
+
+
Returns Tenant
+Representation of the tenant.
+
+ -
+
timeToSeconds
+ -
+
+
-
+
-
+
+ ++++
Converts the given time to seconds in positive numerical format.
+Parameters
+-
+
-
+
time: Time
+++Time to convert.
+
+
Returns number
+number Time in seconds.
+
+ -
+
toBatchChangeSet
+ -
+
+
-
+
-
+
+ + ++
Type parameters
+-
+
-
+
T: CreateRequestBuilder<Entity> | UpdateRequestBuilder<Entity> | DeleteRequestBuilder<Entity>
+
+
Parameters
+-
+
-
+
changeSet: BatchChangeSet<T>
+++Change set containing a collection of write operations.
+
+
Returns string | undefined
+The serialized string representation of a change set.
+
+ -
+
toBatchChangeSetV4
+ -
+
+
-
+
-
+
+ + ++
Type parameters
+-
+
-
+
T: CreateRequestBuilderV4<EntityV4> | UpdateRequestBuilderV4<EntityV4> | DeleteRequestBuilderV4<EntityV4>
+
+
Parameters
+-
+
-
+
changeSet: BatchChangeSet<T>
+++Change set containing a collection of write operations.
+
+
Returns string | undefined
+The serialized string representation of a change set.
+
+ -
+
toBatchRetrieveBody
+ -
+
+
-
+
-
+
+ + ++
Parameters
+-
+
-
+
request: GetAllRequestBuilder<Entity> | GetByKeyRequestBuilder<Entity>
+++The request builder of the retrieve request.
+
+
Returns string
+The request body.
+
+ -
+
toBatchRetrieveBodyV4
+ -
+
+
-
+
-
+
+ + ++
Parameters
+-
+
-
+
request: GetAllRequestBuilderV4<EntityV4> | GetByKeyRequestBuilderV4<EntityV4>
+++The request builder of the retrieve request.
+
+
Returns string
+The request body.
+
+ -
+
toFilterableList
+ -
+
+
-
+
-
+
+
Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+ -
+
LinkedEntityT: EntityBase<LinkedEntityT>
+
+
Parameters
+-
+
-
+
filters: (Filterable<EntityT> | OneToManyLink<EntityT, LinkedEntityT>)[]
+
+
Returns Filterable<EntityT>[]
+
+ -
+
Const toGuid
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
value: string
+
+
Returns string
+
+ -
+
toLower
+ -
+
+
-
+
-
+
+ ++++
Build a filter function to transform a string to lower case. Evaluates to string.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
str: string | Field<EntityT> | StringFilterFunction<EntityT>
+++The string to transform. This can either be a string, a reference to a field or another filter function.
+
+
Returns StringFilterFunction<EntityT>
+The newly created filter function
+
+ -
+
toPascalCase
+ -
+
+
-
+
-
+
+ + ++
Parameters
+-
+
-
+
str: string
+++The string to be transformed.
+
+
Returns string
+The transformed string.
+
+ -
+
toPropertyFormat
+ -
+
+
-
+
-
+
+ + ++
Parameters
+-
+
-
+
str: string
+++The string to be transformed.
+
+
Returns string
+The transformed string.
+
+ -
+
toSanitizedHeaderObject
+ -
+
+
-
+
-
+
+ + ++
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. +
+ -
+
toStaticPropertyFormat
+ -
+
+
-
+
-
+
+ + ++
Parameters
+-
+
-
+
str: string
+++The string to be transformed.
+
+
Returns string
+The transformed string.
+
+ -
+
toTitleFormat
+ -
+
+
-
+
-
+
+ + ++
Parameters
+-
+
-
+
str: string
+++The string to be transformed.
+
+
Returns string
+The transformed string.
+
+ -
+
toTypeNameFormat
+ -
+
+
-
+
-
+
+ + ++
Parameters
+-
+
-
+
str: string
+++The string to be transformed.
+
+
Returns string
+The transformed string.
+
+ -
+
toUpper
+ -
+
+
-
+
-
+
+ ++++
Build a filter function to transform a string to upper case. Evaluates to string.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
str: string | Field<EntityT> | StringFilterFunction<EntityT>
+++The string to transform. This can either be a string, a reference to a field or another filter function.
+
+
Returns StringFilterFunction<EntityT>
+The newly created filter function
+
+ -
+
totalOffsetMinutes
+ -
+
+
-
+
-
+
+ ++++
Build a filter function to get the signed number of minutes in the time zone offset. Evaluates to int.
+Type parameters
+-
+
-
+
EntityT: EntityV4<EntityT>
+
+
Parameters
+-
+
-
+
date: moment.Moment | Field<EntityT>
+++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
+
+ -
+
trim
+-
+
+
-
+
-
+
+ ++++
Build a filter function to trim whitespace from a string. Evaluates to string.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
str: string | Field<EntityT> | StringFilterFunction<EntityT>
+++The string to trim whitespace from. This can either be a string, a reference to a field or another filter function.
+
+
Returns StringFilterFunction<EntityT>
+The newly created filter function
+
+ -
+
useOrFetchDestination
+ -
+
+
-
+
-
+
+ ++++
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:
+-
+
- a binding to exactly one XSUAA service instance with service plan "application" +
- a binding to a destination service instance +
If either of the prerequisites is not met or one of the services returns an error, this function will either throw an error or return a promise that rejects.
+Parameters
+-
+
-
+
destination: Destination | DestinationNameAndJwt
+++A destination or the necessary parameters to fetch one.
+
+ -
+
Optional options: DestinationOptions
+++Caching options by fetching destination.
+
+
Returns Promise<Destination | null>
+A promise resolving to the requested destination on success.
+
+
userApprovedServiceToken
+ -
+
+
-
+
-
+
+ ++++
Returns a user approved access token that can be used to call the given service on behalf of the given user. The token is fetched via user token + refresh token grant. + This can be necessary for scenarios in which a token for a service is required, but the service needs + to know about the user on whose behalf the request is performed (for example to let the destination + service perform principal propagation with SAP S/4HANA Cloud).
+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
+-
+
-
+
userJwt: 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.
+
+ -
+
Optional options: ResilienceOptions
+++Options to influence resilience behavior (see ResilienceOptions). By default, usage of a circuit breaker is enabled.
+
+
Returns Promise<string>
+A user approved access token.
+
+ -
+
userFromJwt
+ -
+
+
-
+
-
+
+ ++++ +
Creates a user object from the decoded JWT.
+Parameters
+-
+
-
+
decodedJWT: DecodedJWT
+++Decoded JWT toeken
+
+
Returns User
+Representation of the user
+
+ -
+
userTokenGrant
+ -
+
+
-
+
-
+
+ ++++
Executes a user token grant request against the given URI.
+Parameters
+-
+
-
+
tokenServiceUrlOrXsuaaServiceCerednetials: string | XsuaaServiceCredentials
+++The URL of the token service or the credentials of a XSUAA service instance.
+
+ -
+
userJwt: string
+++The JWT of the user on whose behalf the request is executed.
+
+ -
+
clientId: string
+++The client_id of the target XSUAA service instance.
+
+ -
+
Optional options: ResilienceOptions
+++Options to use by retrieving access token
+
+
Returns Promise<UserTokenResponse>
+A promise resolving to the response of the XSUAA service.
+
+ -
+
verifyJwt
+ -
+
+
-
+
-
+
+ ++++
Verifies the given JWT and returns the decoded payload.
+Parameters
+-
+
-
+
token: string
+++JWT to be verified
+
+ -
+
Optional options: VerifyJwtOptions
+++Options to control certain aspects of JWT verification behavior.
+
+
Returns Promise<DecodedJWT>
+A Promise to the decoded and verified JWT.
+
+ -
+
verifyJwtWithKey
+ -
+
+
-
+
-
+
+ ++++
Verifies the given JWT with the given key and returns the decoded payload.
+Parameters
+-
+
-
+
token: string
+++JWT to be verified
+
+ -
+
key: string
+++Key to use for verification
+
+
Returns Promise<DecodedJWT>
+A Promise to the decoded and verified JWT.
+
+ -
+
wrapJwtInHeader
+ -
+
+
-
+
-
+
+ ++++
Wraps the access token in header's authorization.
+Parameters
+-
+
-
+
token: string
+++Token to attach in request header
+
+
Returns AxiosRequestConfig
+The request header that holds the access token
+
+ -
+
year
+-
+
+
-
+
-
+
+ ++++
Build a filter function to get the year of a date. Evaluates to int.
+Type parameters
+-
+
-
+
EntityT: EntityBase<EntityT>
+
+
Parameters
+-
+
-
+
date: moment.Moment | Field<EntityT>
+++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
+
+ -
+
+
+
+
+
+ Namespace Protocol
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/modules/sap_cloud_sdk_generator.html b/docs/api/1.36.1/modules/sap_cloud_sdk_generator.html
new file mode 100644
index 0000000000..3ac6f621c8
--- /dev/null
+++ b/docs/api/1.36.1/modules/sap_cloud_sdk_generator.html
@@ -0,0 +1,372 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Index
+
+
+
+
+ Functions
+-
+
- of +
Functions
+of
+-
+
+
+
+
+
+
+ Module @sap-cloud-sdk/generator
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/modules/sap_cloud_sdk_openapi_generator.html b/docs/api/1.36.1/modules/sap_cloud_sdk_openapi_generator.html
new file mode 100644
index 0000000000..2c648d5c01
--- /dev/null
+++ b/docs/api/1.36.1/modules/sap_cloud_sdk_openapi_generator.html
@@ -0,0 +1,284 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Const default
+
+
+
+
+
+
+
+
+
+
+ generate
+
+
+
+ generate
+
+
+
+ transpile
+
+
+
+ transpile
+
+
+
+
+
+
+
+
+
@sap-cloud-sdk/generator
+ +Generate your own service module using a service specification (.edmx file).
+ +Installation
+ +$ npm install @sap-cloud-sdk/generator
+Usage (CLI)
+ +The generator is primarily meant to be used on the command line:
+generate-odata-client --inputDir path/to/your/service-specification(s) --outputDir path/where/the/modules/are/stored
+Run generate-odata-client --help for further options.
Usage (programatically)
+ +You can also use the generator programmatically. You will have to provide the options anyways.
+import { generateProject } from '@sap-cloud-sdk/generator';
+
+// initialize generator options based on what you want to do
+const options: GeneratorOptions = initializeOptions();
+
+// creates a Project datastructure with all sourcefiles based on your options
+const project = generateProject(options);
+
+// here you can modify you project if you need to
+
+// save the files at the specified location
+project.save();
+
+// alternatively you can generate and save the project in one step with: generate(options)
+Documentation
+ +Getting started guide + API documentation
+ +Helpful Links
+ +-
+
- SAP Cloud SDK Documentation portal +
- Tutorials on developers.sap.com +
- SAP Cloud SDK on StackOverflow +
- SAP Cloud SDK on answers.sap.com +
- Release notes on help.sap.com +
- Release notes on Github +
- All versions of this documentation +
- Product page of the SAP Cloud SDK +
- SAP Cloud SDK Continuous Delivery Toolkit +
Index
+
+
+
+
+
+
+ Variables
+ +Functions
+ +Variables
+Const defaultValueProcessesJsGeneration
+
+
+ Functions
+generate
+-
+
+
-
+
-
+
+
Parameters
+-
+
-
+
options: GeneratorOptions
+
+
Returns Promise<void>
+
+ -
+
generateProject
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
options: GeneratorOptions
+
+
Returns Promise<Project | undefined>
+
+ -
+
generateSourcesForService
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
service: VdmServiceMetadata
+
+ -
+
project: Project
+
+ -
+
options: GeneratorOptions
+
+
Returns Promise<void>
+
+ -
+
transpileDirectories
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
directories: Directory[]
+
+
Returns Promise<void[]>
+
+ -
+
transpileDirectory
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
dir: Directory
+
+
Returns Promise<void>
+
+ -
+
+
+
+
+
+ Module @sap-cloud-sdk/openapi-generator
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/modules/sap_cloud_sdk_test_util.html b/docs/api/1.36.1/modules/sap_cloud_sdk_test_util.html
new file mode 100644
index 0000000000..108d2355bb
--- /dev/null
+++ b/docs/api/1.36.1/modules/sap_cloud_sdk_test_util.html
@@ -0,0 +1,487 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SAP Cloud SDK OpenAPI Client Generator (Beta)
+ +Generate custom JavaScript/TypeScript clients for services with OpenAPI specifications. + This generator is based on the OpenAPI Tools generator for OpenAPI and adds some additional code for convenience to better integrate with the SAP Cloud SDK.
+ +Prerequisites
+ +The official OpenAPI generator is Java based, therefore you need to have a Java runtime installed to use the SAP Cloud SDK OpenAPI generator.
+ +Installation
+ +$ npm install @sap-cloud-sdk/openapi-generator
+Usage (CLI)
+ + + + +generate-openapi-client autocomplete [SHELL]
+
+ display autocomplete installation instructions
+USAGE
+ $ generate-openapi-client autocomplete [SHELL]
+
+ARGUMENTS
+ SHELL shell type
+
+OPTIONS
+ -r, --refresh-cache Refresh cache (ignores displaying instructions)
+
+EXAMPLES
+ $ generate-openapi-client autocomplete
+ $ generate-openapi-client autocomplete bash
+ $ generate-openapi-client autocomplete zsh
+ $ generate-openapi-client autocomplete --refresh-cache
+See code: @oclif/plugin-autocomplete
+ +generate-openapi-client help [COMMAND]
+
+ display help for generate-openapi-client
+USAGE
+ $ generate-openapi-client help [COMMAND]
+
+ARGUMENTS
+ COMMAND command to show help for
+
+OPTIONS
+ --all see all commands in CLI
+See code: @oclif/plugin-help
+ + +Usage (programatically)
+ +import { generate } from '@sap-cloud-sdk/openapi-generator';
+
+// initialize generator options based on what you want to do
+// note that inputDir and outputDir are mandatory
+const options: GeneratorOptions = {
+ inputDir: 'path/to/inputDir',
+ outputDir: 'path/to/outputDir'
+};
+
+// generates the files and writes them to the outputDir
+await generate(options);
+Documentation
+ +Getting started guide + API documentation
+ +Helpful Links
+ +-
+
- SAP Cloud SDK Documentation portal +
- Tutorials on developers.sap.com +
- SAP Cloud SDK on StackOverflow +
- SAP Cloud SDK on answers.sap.com +
- Release notes on help.sap.com +
- Release notes on Github +
- All versions of this documentation +
- Product page of the SAP Cloud SDK +
- SAP Cloud SDK Continuous Delivery Toolkit +
Index
+
+
+
+
+ Functions
+-
+
- generate +
Functions
+generate
+-
+
+
-
+
-
+
+ + ++
Parameters
+-
+
-
+
options: GeneratorOptions
+++Options to configure generation.
+
+
Returns Promise<void>
+
+ -
+
+
+
+
+
+ Module @sap-cloud-sdk/test-util
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/1.36.1/modules/sap_cloud_sdk_util.html b/docs/api/1.36.1/modules/sap_cloud_sdk_util.html
new file mode 100644
index 0000000000..799b5898d6
--- /dev/null
+++ b/docs/api/1.36.1/modules/sap_cloud_sdk_util.html
@@ -0,0 +1,2608 @@
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ get
+
+
+
+ get
+
+
+
+ mock
+
+
+
+ mock
+
+
+
+ set
+
+
+
+ unmock
+
+
+
+ unmock
+
+
+
+
+
+
+
+
+
@sap-cloud-sdk/test-util
+ +Package that contains utility functions for testing, like loading credentials or creating test destinations.
+ +Installation
+ +$ npm install @sap-cloud-sdk/test-util
+Usage
+ +The test-util package makes writing tests for your SAP Cloud Platform application more convenient.
+For example, you can create a mock destination for your tests by using the function mockTestDestination.
import { mockTestDestination } from '@sap-cloud-sdk/util';
+mockTestDestination('mockDestinationName');
+You need to save your system information in local file systems.json:
{
+ "systems": [
+ {
+ "alias": "mockDestinationName",
+ "uri": "https://www.example.com"
+ }
+ ]
+}
+and credentials.json:
{
+ "credentials": [
+ {
+ "alias": "SYS_001",
+ "username": "username",
+ "password": "password"
+ }
+ ]
+}
+Documentation
+ +Getting started guide + API documentation
+ +Helpful Links
+ +-
+
- SAP Cloud SDK Documentation portal +
- Tutorials on developers.sap.com +
- SAP Cloud SDK on StackOverflow +
- SAP Cloud SDK on answers.sap.com +
- Release notes on help.sap.com +
- Release notes on Github +
- All versions of this documentation +
- Product page of the SAP Cloud SDK +
- SAP Cloud SDK Continuous Delivery Toolkit +
Index
+
+
+
+
+
+
+ Interfaces
+ +Functions
+ +Functions
+getTestDestinationByAlias
+ -
+
+
-
+
-
+
+ ++++
Loads a destination matching the provided alias stored in
+systems.jsonandcredentials.json. + By default, this function starts looking in the directory the test process has been started in (i.e. '.') + and traverses the file hierarchy upwards until it finds a systems.json and credentials.json file. + Alternatively, you can supply paths to the systems and the credentials file directly.Throws an error when no systems.json can be found, the alias does not match any of the available destinations, + the JSON is malformed or one of the supplied paths is invalid. + Does not throw an error when no credentials.json can be found, but will print a warning.
+Parameters
+-
+
-
+
alias: string
+++The alias identifying the destination
+
+ -
+
Optional options: GetTestDestinationOptions
+++References to the
+systems.jsonandcredentials.jsonfiles
+
Returns Destination
+An array of destinations
+
+ -
+
getTestDestinations
+ -
+
+
-
+
-
+
+ ++++
Loads all destinations stored in
+systems.jsonandcredentials.jsonfiles.By default, this functions starts looking in the directory the test process has been started in (i.e. '.') + and traverses the file hierarchy upwards until it finds a systems.json and credentials.json file. + Alternatively, you can supply paths to the systems and the credentials file directly.
+Throws an error when no systems.json can be found, the JSON is malformed or one of the supplied paths is invalid. + Does not throw an error when no credentials.json can be found, but will print a warning.
+Parameters
+-
+
-
+
Optional options: GetTestDestinationOptions
+++References to the
+systems.jsonandcredentials.jsonfiles
+
Returns Destination[]
+An array of destinations
+
+ -
+
mockAllTestDestinations
+ -
+
+
-
+
-
+
+ ++++
Add all destinations from the
+systems.jsonandcredentials.jsonfiles to thedestinationsenvironment variable.Throws an error if a destination with the same name as the given test destinations already exists.
+Parameters
+-
+
-
+
Optional options: GetTestDestinationOptions
+++References to the
+systems.jsonandcredentials.jsonfiles
+
Returns void
+
+ -
+
mockTestDestination
+ -
+
+
-
+
-
+
+ ++++
Add a destination with the given name from the
+systems.jsonandcredentials.jsonfiles to thedestinationsenvironment 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
+destinationsenvironment variable
+ -
+
Optional options: GetTestDestinationOptions
+++References to the
+systems.jsonandcredentials.jsonfiles
+
Returns void
+
+ -
+
setTestDestination
+ -
+
+
-
+
-
+
+ ++++
Set a given destination in the
+destinationsenvironment 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
+destinationsenvironment variable
+
Returns void
+
+ -
+
unmockAllTestDestinations
+ -
+
+
-
+
-
+
+ ++++
Removes all test destinations stored in
+systems.jsonandcredentials.jsonfiles or added through setTestDestination() from thedestinationsenvironment variable.This function should be called to invert the behavior of mockAllTestDestinations() and other add single mocked destination functions.
+Returns void
+
+
unmockTestDestination
+ -
+
+
-
+
-
+
+ ++++
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
+
+
Returns void
+
+ -
+
+
+
+
+
+ Module @sap-cloud-sdk/util
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/docs/api/versions.js b/docs/api/versions.js
index 5361ee15d6..66456c7818 100644
--- a/docs/api/versions.js
+++ b/docs/api/versions.js
@@ -1,4 +1,5 @@
export default [
+ "1.36.1",
"1.36.0",
"1.35.0",
"1.34.0",
diff --git a/docs/api/versions.json b/docs/api/versions.json
index 8fe3e8211a..3cfb175451 100644
--- a/docs/api/versions.json
+++ b/docs/api/versions.json
@@ -1,4 +1,5 @@
[
+ "1.36.1",
"1.36.0",
"1.35.0",
"1.34.0",
diff --git a/lerna.json b/lerna.json
index 70e4286b21..915c072aa1 100644
--- a/lerna.json
+++ b/lerna.json
@@ -1,5 +1,5 @@
{
"npmClient": "yarn",
"useWorkspaces": true,
- "version": "1.36.0"
+ "version": "1.36.1"
}
diff --git a/package.json b/package.json
index e23070b6a1..833f63a68e 100644
--- a/package.json
+++ b/package.json
@@ -1,6 +1,6 @@
{
"name": "sap-cloud-sdk",
- "version": "1.36.0",
+ "version": "1.36.1",
"private": true,
"sideEffects": false,
"description": "SAP Cloud SDK for JavaScript",
diff --git a/packages/analytics/package.json b/packages/analytics/package.json
index c6c03c20ce..692717cda0 100644
--- a/packages/analytics/package.json
+++ b/packages/analytics/package.json
@@ -1,6 +1,6 @@
{
"name": "@sap-cloud-sdk/analytics",
- "version": "1.36.0",
+ "version": "1.36.1",
"description": "SAP Cloud SDK Analytics Usage",
"homepage": "https://sap.github.io/cloud-sdk/docs/js/overview-cloud-sdk-for-javascript",
"license": "Apache-2.0",
@@ -31,7 +31,7 @@
"check:dependencies": "depcheck ."
},
"dependencies": {
- "@sap-cloud-sdk/util": "^1.36.0",
+ "@sap-cloud-sdk/util": "^1.36.1",
"axios": "^0.21.1"
},
"devDependencies": {
diff --git a/packages/core/package.json b/packages/core/package.json
index 352a8cbdb3..83b39b09ca 100644
--- a/packages/core/package.json
+++ b/packages/core/package.json
@@ -1,6 +1,6 @@
{
"name": "@sap-cloud-sdk/core",
- "version": "1.36.0",
+ "version": "1.36.1",
"description": "SAP Cloud SDK for JavaScript core",
"homepage": "https://sap.github.io/cloud-sdk/docs/js/overview-cloud-sdk-for-javascript",
"license": "Apache-2.0",
@@ -37,8 +37,8 @@
"check:dependencies": "depcheck ."
},
"dependencies": {
- "@sap-cloud-sdk/analytics": "^1.36.0",
- "@sap-cloud-sdk/util": "^1.36.0",
+ "@sap-cloud-sdk/analytics": "^1.36.1",
+ "@sap-cloud-sdk/util": "^1.36.1",
"@sap/xsenv": "^3.0.0",
"axios": "^0.21.1",
"bignumber.js": "^9.0.0",
@@ -51,7 +51,7 @@
"voca": "^1.4.0"
},
"devDependencies": {
- "@sap-cloud-sdk/test-util": "^1.36.0",
+ "@sap-cloud-sdk/test-util": "^1.36.1",
"@sinonjs/fake-timers": "^6.0.1",
"@types/sinonjs__fake-timers": "^6.0.0",
"nock": "^13.0.3"
diff --git a/packages/generator/package.json b/packages/generator/package.json
index 4f3cbca752..a678403cb0 100644
--- a/packages/generator/package.json
+++ b/packages/generator/package.json
@@ -1,6 +1,6 @@
{
"name": "@sap-cloud-sdk/generator",
- "version": "1.36.0",
+ "version": "1.36.1",
"description": "SAP Cloud SDK for JavaScript OData client generator",
"homepage": "https://sap.github.io/cloud-sdk/docs/js/overview-cloud-sdk-for-javascript",
"license": "Apache-2.0",
@@ -35,8 +35,8 @@
"check:dependencies": "depcheck ."
},
"dependencies": {
- "@sap-cloud-sdk/core": "^1.36.0",
- "@sap-cloud-sdk/util": "^1.36.0",
+ "@sap-cloud-sdk/core": "^1.36.1",
+ "@sap-cloud-sdk/util": "^1.36.1",
"@sap/edm-converters": "^1.0.21",
"@types/fs-extra": "^9.0.1",
"@types/glob": "^7.1.2",
diff --git a/packages/openapi-generator/package.json b/packages/openapi-generator/package.json
index 52b983da59..e52bc3f0cc 100644
--- a/packages/openapi-generator/package.json
+++ b/packages/openapi-generator/package.json
@@ -1,6 +1,6 @@
{
"name": "@sap-cloud-sdk/openapi-generator",
- "version": "1.36.0",
+ "version": "1.36.1",
"description": "SAP Cloud SDK for JavaScript OpenApi client generator",
"homepage": "https://sap.github.io/cloud-sdk/docs/js/overview-cloud-sdk-for-javascript",
"license": "Apache-2.0",
@@ -56,7 +56,7 @@
"@oclif/plugin-not-found": "^1.2.3",
"@oclif/plugin-warn-if-update-available": "^1.7.0",
"@openapitools/openapi-generator-cli": "^2.1.4",
- "@sap-cloud-sdk/util": "^1.36.0",
+ "@sap-cloud-sdk/util": "^1.36.1",
"@types/js-yaml": "^4.0.0",
"cli-ux": "^5.4.5",
"execa": "^5.0.0",
diff --git a/packages/test-util/package.json b/packages/test-util/package.json
index 330d36434c..627e92a780 100644
--- a/packages/test-util/package.json
+++ b/packages/test-util/package.json
@@ -1,6 +1,6 @@
{
"name": "@sap-cloud-sdk/test-util",
- "version": "1.36.0",
+ "version": "1.36.1",
"description": "SAP Cloud SDK for JavaScript test utilities",
"homepage": "https://sap.github.io/cloud-sdk/docs/js/overview-cloud-sdk-for-javascript",
"license": "Apache-2.0",
@@ -31,7 +31,7 @@
"check:dependencies": "depcheck ."
},
"dependencies": {
- "@sap-cloud-sdk/core": "^1.36.0",
- "@sap-cloud-sdk/util": "^1.36.0"
+ "@sap-cloud-sdk/core": "^1.36.1",
+ "@sap-cloud-sdk/util": "^1.36.1"
}
}
diff --git a/packages/util/package.json b/packages/util/package.json
index 73d81e76df..8765b61ae0 100644
--- a/packages/util/package.json
+++ b/packages/util/package.json
@@ -1,6 +1,6 @@
{
"name": "@sap-cloud-sdk/util",
- "version": "1.36.0",
+ "version": "1.36.1",
"description": "SAP Cloud SDK for JavaScript general utilities",
"homepage": "https://sap.github.io/cloud-sdk/docs/js/overview-cloud-sdk-for-javascript",
"license": "Apache-2.0",
diff --git a/test-packages/e2e-tests/package.json b/test-packages/e2e-tests/package.json
index 59a69e35e2..b43bc40a6c 100644
--- a/test-packages/e2e-tests/package.json
+++ b/test-packages/e2e-tests/package.json
@@ -1,6 +1,6 @@
{
"name": "@sap-cloud-sdk/e2e-tests",
- "version": "1.36.0",
+ "version": "1.36.1",
"description": "End to end tests of the SAP Cloud SDK for JavaScript",
"homepage": "https://sap.github.io/cloud-sdk/docs/js/overview-cloud-sdk-for-javascript",
"license": "Apache-2.0",
@@ -18,9 +18,9 @@
},
"devDependencies": {
"@apidevtools/swagger-parser": "^10.0.2",
- "@sap-cloud-sdk/core": "^1.36.0",
- "@sap-cloud-sdk/test-services": "^1.36.0",
- "@sap-cloud-sdk/test-services-e2e": "^1.36.0",
+ "@sap-cloud-sdk/core": "^1.36.1",
+ "@sap-cloud-sdk/test-services": "^1.36.1",
+ "@sap-cloud-sdk/test-services-e2e": "^1.36.1",
"@sap/cds": "^4.4.7",
"@sap/cds-dk": "^3.3.3",
"express": "^4.17.1",
diff --git a/test-packages/integration-tests/package.json b/test-packages/integration-tests/package.json
index 9211208961..0ede7b1b45 100644
--- a/test-packages/integration-tests/package.json
+++ b/test-packages/integration-tests/package.json
@@ -1,6 +1,6 @@
{
"name": "@sap-cloud-sdk/integration-tests",
- "version": "1.36.0",
+ "version": "1.36.1",
"description": "SAP Cloud SDK for JavaScript integration tests",
"homepage": "https://sap.github.io/cloud-sdk/docs/js/overview-cloud-sdk-for-javascript",
"license": "Apache-2.0",
@@ -14,11 +14,11 @@
"check:dependencies": "depcheck ."
},
"dependencies": {
- "@sap-cloud-sdk/analytics": "^1.36.0",
- "@sap-cloud-sdk/core": "^1.36.0",
- "@sap-cloud-sdk/test-services": "^1.36.0",
- "@sap-cloud-sdk/test-util": "^1.36.0",
- "@sap-cloud-sdk/util": "^1.36.0"
+ "@sap-cloud-sdk/analytics": "^1.36.1",
+ "@sap-cloud-sdk/core": "^1.36.1",
+ "@sap-cloud-sdk/test-services": "^1.36.1",
+ "@sap-cloud-sdk/test-util": "^1.36.1",
+ "@sap-cloud-sdk/util": "^1.36.1"
},
"devDependencies": {
"@sap/cloud-sdk-vdm-business-partner-service": "^1.23.0",
diff --git a/test-packages/test-services-e2e/package.json b/test-packages/test-services-e2e/package.json
index 8cc7ebc7db..650e9485ae 100644
--- a/test-packages/test-services-e2e/package.json
+++ b/test-packages/test-services-e2e/package.json
@@ -1,6 +1,6 @@
{
"name": "@sap-cloud-sdk/test-services-e2e",
- "version": "1.36.0",
+ "version": "1.36.1",
"description": "Custom Services for testing",
"files": [
"**/*.js",
@@ -19,7 +19,7 @@
},
"license": "Apache-2.0",
"dependencies": {
- "@sap-cloud-sdk/core": "^1.36.0",
+ "@sap-cloud-sdk/core": "^1.36.1",
"bignumber.js": "^9.0.1",
"moment": "^2.29.0"
}
diff --git a/test-packages/test-services/package.json b/test-packages/test-services/package.json
index ef7a2f9891..fa21fac5bd 100644
--- a/test-packages/test-services/package.json
+++ b/test-packages/test-services/package.json
@@ -1,6 +1,6 @@
{
"name": "@sap-cloud-sdk/test-services",
- "version": "1.36.0",
+ "version": "1.36.1",
"description": "Custom Services for testing",
"files": [
"**/*.js",
@@ -19,7 +19,7 @@
},
"license": "Apache-2.0",
"dependencies": {
- "@sap-cloud-sdk/core": "^1.36.0",
+ "@sap-cloud-sdk/core": "^1.36.1",
"bignumber.js": "^9.0.1",
"moment": "^2.29.0"
}
diff --git a/test-packages/type-tests/package.json b/test-packages/type-tests/package.json
index 062873839a..e075a0c1b1 100644
--- a/test-packages/type-tests/package.json
+++ b/test-packages/type-tests/package.json
@@ -1,6 +1,6 @@
{
"name": "@sap-cloud-sdk/type-tests",
- "version": "1.36.0",
+ "version": "1.36.1",
"description": "Tests to ensure correct types in the SAP Cloud SDK for JavaScript.",
"homepage": "https://sap.github.io/cloud-sdk/docs/js/overview-cloud-sdk-for-javascript",
"license": "Apache-2.0",
@@ -12,8 +12,8 @@
"check:dependencies": "echo Nothing to check here."
},
"dependencies": {
- "@sap-cloud-sdk/core": "^1.36.0",
- "@sap-cloud-sdk/test-services": "^1.36.0"
+ "@sap-cloud-sdk/core": "^1.36.1",
+ "@sap-cloud-sdk/test-services": "^1.36.1"
},
"devDependencies": {
"dtslint": "^4.0.0"
diff --git a/tsconfig.typedoc.json b/tsconfig.typedoc.json
index feb913d0a0..09adc5f07d 100644
--- a/tsconfig.typedoc.json
+++ b/tsconfig.typedoc.json
@@ -29,7 +29,7 @@
}
],
"typedocOptions": {
- "out": "docs/api/1.36.0",
+ "out": "docs/api/1.36.1",
"entryPoints": [
"packages/util/src/index.ts",
"packages/analytics/src/index.ts",
+
+
+
+
+
+
+
+
+
+
+
+ Log
+
+
+
+
+
+ Map
+
+
+
+
+
+ OData
+
+
+
+
+
+
+
+ Const VALUE_
+
+
+
+
+
+ Const cloud
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Const assoc
+
+
+
+ Const async
+
+
+
+ camel
+
+
+
+
+
+
+ code
+
+
+
+ create
+
+
+
+ disable
+
+
+
+ enable
+
+
+
+ encode
+
+
+
+
+
+
+ equal
+
+
+
+ equal
+
+
+
+ error
+
+
+
+ filter
+
+
+
+ filter
+
+
+
+ find
+
+
+
+
+
+
+
+
+
+
+
+
+ get
+
+
+
+ get
+
+
+
+
+
+
+ is
+
+
+
+ is
+
+
+
+
+
+
+ merge
+
+
+
+ merge
+
+
+
+ Const merge
+
+
+
+ mute
+
+
+
+
+
+
+ pascal
+
+
+
+
+
+
+ pick
+
+
+
+ pick
+
+
+
+ pick
+
+
+
+ property
+
+
+
+
+
+
+ Const rename
+
+
+
+ set
+
+
+
+ set
+
+
+
+ split
+
+
+
+ title
+
+
+
+ to
+
+
+
+
+
+
+ trim
+
+
+
+ trim
+
+
+
+
+
+
+ unmute
+
+
+
+ upper
+
+
+
+ variadic
+
+
+
+
+
+
+
+
+
+
+
+
@sap-cloud-sdk/util
+ +Package that contains general utility functions that we reuse multiple times in the SDK. + While primarily designed for internal usage, they might also be beneficial for consumers of the SDK.
+ +Installation
+ +$ npm install @sap-cloud-sdk/util
+Usage
+ +The util package collects useful tools that help build your SAP Cloud Platform application. + For example, the following code snippet changes the log level of the destination accessor of the SDK.
+import { setLogLevel } from '@sap-cloud-sdk/util';
+setLogLevel('debug', 'destination-accessor');
+Documentation
+ +Getting started guide + API documentation
+ +Helpful Links
+ +-
+
- SAP Cloud SDK Documentation portal +
- Tutorials on developers.sap.com +
- SAP Cloud SDK on StackOverflow +
- SAP Cloud SDK on answers.sap.com +
- Release notes on help.sap.com +
- Release notes on Github +
- All versions of this documentation +
- Product page of the SAP Cloud SDK +
- SAP Cloud SDK Continuous Delivery Toolkit +
Index
+
+
+
+
+
+
+
+
+
+
+
+
+ Classes
+ +Interfaces
+ +Type aliases
+-
+
- Log
Level
+ - Map
Type
+ - OData
Version
+
Variables
+-
+
- VALUE_
IS_ UNDEFINED
+ - cloud
Sdk Exception Logger
+ - kibana +
- local +
Functions
+-
+
- assoc +
- assoc
Some
+ - async
Pipe
+ - camel
Case
+ - caps +
- code
Block
+ - create
Logger
+ - disable
Exception Logger
+ - enable
Exception Logger
+ - encode
Base64
+ - equal +
- equal
Arrays
+ - equal
Objects
+ - error
With Cause
+ - filter
Duplicates
+ - filter
Duplicates Right
+ - find
Project Root
+ - first +
- flat +
- flatten +
- get
Global Log Level
+ - get
Logger
+ - identity +
- is
Error With Cause
+ - is
Nullish
+ - last +
- merge
Ignore Case
+ - merge
Left Ignore Case
+ - merge
Some
+ - mute
Loggers
+ - partition +
- pascal
Case
+ - pick +
- pick
Ignore Case
+ - pick
Non Nullish
+ - pick
Value Ignore Case
+ - property
Exists
+ - readJSON +
- rename
Keys
+ - set
Global Log Level
+ - set
Log Level
+ - split
InChunks
+ - title
Format
+ - to
Sanitized Object
+ - trim +
- trim
Left
+ - trim
Right
+ - unique +
- unmute
Loggers
+ - upper
Case Snake Case
+ - variadic
Argument ToArray
+ - zip +
Type aliases
+LogLevel
+
+
+
+
+
+
+ Npm log levels used for the SAP Cloud SDK logger.
+MapType
+
+
+
+
+
+ Type parameters
+-
+
-
+
T
+
+
ODataVersion
+
+
+
+
+
+
+ Denotes the OData version.
+Variables
+Const VALUE_IS_UNDEFINED
+
+
+ Const cloudSdkExceptionLogger
+
+
+
+
+
+
+ Default logger for the SAP Cloud SDK for unhandled exceptions.
+Const kibana
+ + +
+
+
+
+ Format for logging in Kibana.
+Const local
+ + +
+
+
+
+ Format for local logging.
+Functions
+Const 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.
+Type parameters
+-
+
-
+
T
+
+
Parameters
+-
+
-
+
key: string
+++key to be added
+
+ -
+
value: any
+++value to be added
+
+ -
+
obj: T
+++object the key value pair is added to.
+
+
Returns T & {}
+the object with the key value pair added
+
+ -
+
Const assocSome
+ -
+
+
-
+
-
+
+ ++++ +
Adds the value to the object if it is neither null nor undefined. + Note that this is different to JS idiomatic checks for truthy/falsy values, i.e. an empty string will result in key/value pairs beeing added.
+Type parameters
+-
+
-
+
T
+
+
Parameters
+-
+
-
+
key: string
+++The key to associate with the given value.
+
+ -
+
Optional value: any
+++The value to associate with the given key.
+
+
Returns (obj: T) => T
+A copy of the input object with the new key-value pair if the value is neither null nor undefined.
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
obj: T
+++The object on which to create the association.
+
+
Returns T
+
+ -
+
+ -
+
+ -
+
Const asyncPipe
+ -
+
+
-
+
-
+
+ ++++ +
Same as pipe but for asynchronous functions: + asynvPipe(finc1,func2,...funcN)(start) executes all functions in sequence awaiting the result and piping the response through in other words await funcN(... await func2(await func1(start))...)
+Parameters
+-
+
-
+
Rest ...fns: any[]
+++a list of asynchronous functions to be executed in sequence
+
+
Returns (start: any) => Promise<any>
+the reponse of the last function in the list.
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
start: any
+++start value for the first function in the list
+
+
Returns Promise<any>
+
+ -
+
+ -
+
+ -
+
camelCase
+ -
+
+
-
+
-
+
+ ++++
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.
+
+ -
+
caps
+-
+
+
-
+
-
+
+ ++++
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'
+
+ -
+
codeBlock
+ -
+
+
-
+
-
+
+ + ++
Parameters
+-
+
-
+
strings: TemplateStringsArray
+++Strings in the tagged template. In the example above that would be ['Code with ', ' and more code;'].
+
+ -
+
Rest ...args: any[]
+++Arguments in the tagged template. In the example above that would be the resolved value for
+arguments;
+
Returns string
+A string formatted as code block.
+
+ -
+
createLogger
+ -
+
+
-
+
-
+
+ ++++
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
+messageContextfor all messages from this logger: +const logger = createLogger('my-module');. Not setting any module identifier will retrieve the default logger. + Use this logger throughout your module. If the module is spread over multiple files, you can retrieve the logger instance by calling thecreateLoggerfunction with the respective module identifier. + There will always be only one instance of a logger per module identifier. + You can pass any custom data that you want to be logged in addition by passing an object instead. You can change the default logging level (INFO) using thelevelkey in the object. + In those cases, provide themessageContextas a key in the object:
+const logger = createLogger({ + messageContext: 'my-module', + myCustomKey: 'my-custom-data', + level: 'debug' +}); +You will find these information under the _custom_fields_ key in your Cloud Foundry logs.
+To retrieve a logger after its creation use getLogger. + If you want to change the log level of a logger use setLogLevel.
+Parameters
+-
+
-
+
Optional messageContext: string | (MessageContextObj & LoggerOptions)
+++Either a key for the message context of all messages produced by the logger or an object with additional keys to set in the message.
+
+
Returns Logger
+A newly created or an already existing logger for the given context.
+
+ -
+
disableExceptionLogger
+ -
+
+
-
+
-
+
+ ++++
Disable logging of exceptions. Enabled by default.
+Returns void
+
+
enableExceptionLogger
+ -
+
+
-
+
-
+
+ ++++
Enable logging of exceptions. Enabled by default.
+Returns void
+
+
encodeBase64
+ -
+
+
-
+
-
+
+ ++++
Encode a string to a base64 encoded string.
+Parameters
+-
+
-
+
str: string
+++String to encode.
+
+
Returns string
+Base64 encoded string.
+
+ -
+
equal
+-
+
+
-
+
-
+
+ ++++
hidden
+Type parameters
+-
+
-
+
T
+
+
Parameters
+-
+
-
+
item1: T
+
+ -
+
item2: T
+
+
Returns boolean
+
+ -
+
equalArrays
+ -
+
+
-
+
-
+
+ ++++
hidden
+Type parameters
+-
+
-
+
T
+
+
Parameters
+-
+
-
+
arr1: T[]
+
+ -
+
arr2: T[]
+
+
Returns boolean
+
+ -
+
equalObjects
+ -
+
+
-
+
-
+
+ ++++
hidden
+Parameters
+-
+
-
+
obj1: Record<string, any>
+
+ -
+
obj2: Record<string, any>
+
+
Returns boolean
+
+ -
+
errorWithCause
+ -
+
+
-
+
-
+
+ + ++
Parameters
+-
+
-
+
message: string
+++Error message.
+
+ -
+
cause: Error
+++Original error, causing the new error.
+
+
Returns Error
+A new error with the given cause.
+
+ -
+
filterDuplicates
+ -
+
+
-
+
-
+
+ ++++
Filter an array by removing duplicates and keeping the left most occurence. By default this compares by identity.
+Type parameters
+-
+
-
+
T
+
+
Parameters
+-
+
-
+
arr: T[]
+++Array to remove duplicates from.
+
+ -
+
Optional comparator: (left: T, right: T) => boolean
+++Optional comparator function, indicating whether two items are equal and therefore handled as duplicates. Defaults to identity.
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
left: T
+
+ -
+
right: T
+
+
Returns boolean
+
+ -
+
+ -
+
+ -
+
Returns T[]
+A filtered array containing no duplicates.
+
+ -
+
filterDuplicatesRight
+ -
+
+
-
+
-
+
+ ++++
Filter an array by removing duplicates and keeping the right most occurence. By default this compares by identity.
+Type parameters
+-
+
-
+
T
+
+
Parameters
+-
+
-
+
arr: T[]
+++Array to remove duplicates from.
+
+ -
+
Optional comparator: (left: T, right: T) => boolean
+++Optional comparator function, indicating whether two items are equal and therefore handled as duplicates. Defaults to identity.
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
left: T
+
+ -
+
right: T
+
+
Returns boolean
+
+ -
+
+ -
+
+ -
+
Returns T[]
+A filtered array containing no duplicates.
+
+ -
+
findProjectRoot
+ -
+
+
-
+
-
+
+
Parameters
+-
+
-
+
path: string
+
+ -
+
lastPath: string = ...
+
+
Returns string
+
+ -
+
first
+-
+
+
-
+
-
+
+ ++++
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
+
+ -
+
flat
+-
+
+
-
+
-
+
+ ++++
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.
+
+ -
+
Const flatten
+-
+
+
-
+
-
+
+ ++++
Flattens a array: [1,[2,[3,4]],5] will become [1,2,3,4,5]. + Non primitive values are copied by reference.
+Parameters
+-
+
-
+
input: any[]
+++Array to be flattened
+
+
Returns any[]
+The flattened array.
+
+ -
+
getGlobalLogLevel
+ -
+
+
-
+
-
+
+
Returns string | undefined
+
+
getLogger
+ -
+
+
-
+
-
+
+ ++++
Get logger for a given message context, if avilable.
+Parameters
+-
+
-
+
Optional messageContext: string
+++A key for the message context of all messages produced by the logger
+
+
Returns Logger | undefined
+The logger for the given messageContext if it was created before
+
+ -
+
Const identity
+-
+
+
-
+
-
+
+ ++++
Identity function
+Type parameters
+-
+
-
+
T
+
+
Parameters
+-
+
-
+
argument: T
+++Any object
+
+
Returns T
+the given argument without doing something
+
+ -
+
isErrorWithCause
+ -
+
+
-
+
-
+
+ ++++
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.
+
+ -
+
isNullish
+ -
+
+
-
+
-
+
+ ++++
Checks whether a value is either
+nullorundefined.Parameters
+-
+
-
+
val: any
+++Value to check
+
+
Returns val is undefined | null
+true for null or undefined, false otherwise.
+
+ -
+
last
+-
+
+
-
+
-
+
+ ++++
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
+
+ -
+
mergeIgnoreCase
+ -
+
+
-
+
-
+
+ ++++
Create an object by merging the
+rightobject into a shallow copy of theleftobject ignoring casing, but keeping the right casing. Keys present both objects will be present in the merged object.Type parameters
+-
+
-
+
LeftT: Record<string, any>
+
+ -
+
RightT: Record<string, any>
+
+
Parameters
+-
+
-
+
Optional left: LeftT
+++Object to merge.
+
+ -
+
Optional right: RightT
+++Object to merge. The casing of the keys of this object takes precedence.
+
+
Returns Partial<LeftT | RightT>
+-
+
- An object containing all keys from both objects, where entries present in the
rightobject are replaced. Note that the casing used byrightwill be used.
+
+ -
+
mergeLeftIgnoreCase
+ -
+
+
-
+
-
+
+ ++++
Create an object by merging the
+rightobject into a shallow copy of theleftobject ignoring casing, but keeping therightcasing. Only keys present in theleftobject will be present in the merged object.Type parameters
+-
+
-
+
LeftT: Record<string, any>
+
+ -
+
RightT: Record<string, any>
+
+
Parameters
+-
+
-
+
Optional left: LeftT
+++Object to merge into. They keys of this object will be present in the returned object.
+
+ -
+
Optional right: RightT
+++Object to merge. Only keys in
+leftwill be considered for merging.
+
Returns Record<string, any>
+-
+
- An object containing all keys from the
leftobject, where entries present in therightobject are replaced. Note that the casing used byrightwill be used.
+
+ -
+
Const mergeSome
+ -
+
+
-
+
-
+
+ ++++ +
Merges the two objects, if second object is neither null nor undefined. + If a key exists on a and b the value from b is taken
+Parameters
+-
+
-
+
a: Record<string, any>
+++The object to merge into.
+
+ -
+
Optional b: Record<string, any>
+++The object which to merge into a.
+
+
Returns Record<string, any>
+A copy of the merge(a, b) or a if b is undefined or null.
+
+ -
+
muteLoggers
+ -
+
+
-
+
-
+
+ ++++
Mute all logger output created by the SAP Cloud SDK Logger. This also applies to future loggers created. Useful for tests.
+Returns void
+
+
partition
+-
+
+
-
+
-
+
+ ++++
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.
+-
+
-
+
-
+
+
-
+
-
+
Parameters
+-
+
-
+
item: T
+
+
Returns boolean
+
+ -
+
+ -
+
+ -
+
Returns [T[], T[]]
+A two dimensional array containting 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.
+
+ -
+
pascalCase
+ -
+
+
-
+
-
+
+ ++++
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.
+
+ -
+
Const pick
+-
+
+
-
+
-
+
+ ++++
Create a shallow copy of the given object, that contains the given keys. + Non existing keys in the source object are ignored.
+Type parameters
+-
+
-
+
T
+
+
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.
+
+ -
+
pickIgnoreCase
+ -
+
+
-
+
-
+
+ ++++
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: Record<string, any>
+
+
Parameters
+-
+
-
+
Optional obj: T
+++Object to pick the given key from.
+
+ -
+
Rest ...keys: string[]
+++Keys of the pair to be picked.
+
+
Returns Partial<Pick<T, typeof keys[number]>>
+-
+
- An object containing the given key-value pairs in its original case or an empty object if none of them are found. +
+ -
+
pickNonNullish
+ -
+
+
-
+
-
+
+ ++++
Create a shallow copy of the given object, that contains all entries with non-nullish values.
+Type parameters
+-
+
-
+
T: Record<string, any>
+
+
Parameters
+-
+
-
+
Optional obj: T
+++An object to pick from.
+
+
Returns Partial<T>
+-
+
- A filtered object containing only keys with non-nullish values. +
+ -
+
pickValueIgnoreCase
+ -
+
+
-
+
-
+
+ ++++
Returns the value of an object based on the given key, independent of casing.
+Type parameters
+-
+
-
+
T: Record<string, any>
+
+
Parameters
+-
+
-
+
obj: T | undefined
+++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.
+
+ -
+
propertyExists
+ -
+
+
-
+
-
+
+ ++++
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.
+
+ -
+
readJSON
+-
+
+
-
+
-
+
+ ++++
Read a JSON file from the file system.
+Parameters
+-
+
-
+
path: PathLike
+++The path to the JSON file.
+
+
Returns {}
+An object parsed from the JSON file.
+-
+
-
+
[key: string]: any
+
+
+ -
+
Const 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".
+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.
+
+ -
+
setGlobalLogLevel
+ -
+
+
-
+
-
+
+ ++++
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
+
+
Returns void
+
+ -
+
setLogLevel
+ -
+
+
-
+
-
+
+ ++++
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-acessor').Parameters
+-
+
-
+
level: LogLevel | ""
+++level to set the logger to. Use an empty string '' as level to unset context level.
+
+ -
+
Optional messageContextOrLogger: string | Logger
+++Message context of the logger to change the log level for or the logger itself
+
+
Returns void
+
+ -
+
splitInChunks
+ -
+
+
-
+
-
+
+ ++++
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.
+
+ -
+
titleFormat
+ -
+
+
-
+
-
+
+ ++++
Convert a string to a human readable format, e.g. it transforms
+to_BusinessPartnertoTo Business Partner.Parameters
+-
+
-
+
str: string
+++The string to be transformed.
+
+
Returns string
+The transformed string.
+
+ -
+
toSanitizedObject
+ -
+
+
-
+
-
+
+ ++++
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. +
+ -
+
trim
+-
+
+
-
+
-
+
+ ++++
Remove whitespace from the left side of a string.
+Parameters
+-
+
-
+
string: string
+++String to trim.
+
+
Returns string
+String without outer whitespace.
+
+ -
+
trimLeft
+ -
+
+
-
+
-
+
+ ++++
Remove whitespace from the left side of a string.
+Parameters
+-
+
-
+
string: string
+++String to trim.
+
+
Returns string
+String without whitespace on the left side.
+
+ -
+
trimRight
+ -
+
+
-
+
-
+
+ ++++
Remove whitespace from the right side of a string.
+Parameters
+-
+
-
+
string: string
+++String to trim.
+
+
Returns string
+String without whitespace on the right side.
+
+ -
+
unique
+-
+
+
-
+
-
+
+ ++++
Remove all duplicates from array
+Type parameters
+-
+
-
+
T
+
+
Parameters
+-
+
-
+
arr: T[]
+++Array that might contain duplicates
+
+
Returns T[]
+Array of unique items
+
+ -
+
unmuteLoggers
+ -
+
+
-
+
-
+
+ ++++
Unmute all logger output created by the SAP Cloud SDK Logger. This also applies to future loggers created. Useful for tests.
+Returns void
+
+
upperCaseSnakeCase
+ -
+
+
-
+
-
+
+ ++++
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.
+
+ -
+
variadicArgumentToArray
+ -
+
+
-
+
-
+
+ ++++
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[]) + functiondoSomething(first: undefined | T | T[], ...rest: T[]) { + //implementation + } + This wrapper methods makes it easy build an array from the input.
+Type parameters
+-
+
-
+
T
+
+
Parameters
+-
+
-
+
firstOrArray: undefined | T | T[]
+++Either an array, the first element of the var args or undefined if no argument was given.
+
+ -
+
rest: T[]
+++Second to last element if var args were used, empty array if the frist argument is an array.
+
+
Returns T[]
+Array from the input or empty array if no input was given.
+
+ -
+
zip
+-
+
+
-
+
-
+
+ ++++
Merge two arrays by alternately adding inserting values from both arrays, starting from the left. + For example:
+zip([1, 2], [3, 4, 5, 6])=>[1, 3, 2, 4, 5, 6]Type parameters
+-
+
-
+
T
+
+
Parameters
+-
+
-
+
left: T[]
+++Array to start alternately merging from.
+
+ -
+
right: T[]
+++Second array to merge.
+
+
Returns T[]
+Zipped array.
+
+ -
+
Create OData request to execute a action or function import.
+