Class ActionFunctionImportRequestBuilder<ParametersT, ReturnT>
Type parameters
ParametersT
+Type of the function import parameters
+ReturnT
+Type of the function import return value
+
Hierarchy
- MethodRequestBuilder<ODataFunctionImportRequestConfig<ParametersT> | ODataActionImportRequestConfig<ParametersT>>
- ActionFunctionImportRequestBuilder
Index
Constructors
Protected 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 function import.
+
Returns ActionFunctionImportRequestBuilder<ParametersT, ReturnT>
Properties
request
Readonly response
Type declaration
Parameters
data: any
Returns ReturnT
Methods
add
- +
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.
+
add
- +
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
+
add
- +
Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. +If the custom request configuration contains disallowed keys, those will be ignored.
+Parameters
requestConfiguration: Record<string, string>
Key-value pairs denoting additional custom request configuration options to be set in the request.
+
Returns ActionFunctionImportRequestBuilder<ParametersT, ReturnT>
The request builder itself, to facilitate method chaining.
+
append
- +
Append the given path to the URL. +This can be used for querying navigation properties of an entity. +To execute a request with an appended path use
+executeRawto avoid errors during deserialization. When using this, theexecutemethod is omitted from the return type.Parameters
Rest ...path: string[]
Path to be appended.
+
Returns Omit<ActionFunctionImportRequestBuilder<ParametersT, ReturnT>, "execute">
The request builder itself without "execute" function, to facilitate method chaining.
+
build
Returns ODataRequest<ODataFunctionImportRequestConfig<ParametersT> | ODataActionImportRequestConfig<ParametersT>>
Parameters
destination: Destination | DestinationNameAndJwt
Optional options: DestinationOptions
Returns Promise<ODataRequest<ODataFunctionImportRequestConfig<ParametersT> | ODataActionImportRequestConfig<ParametersT>>>
execute
- +
Execute request
+Parameters
destination: Destination | DestinationNameAndJwt
Destination to execute the request against
+Optional options: DestinationOptions
Options to employ when fetching destinations
+
Returns Promise<ReturnT>
A promise resolving to the requested return type
+
execute
- +
Execute request and return an HttpResponse.
+Parameters
destination: Destination | DestinationNameAndJwt
Destination to execute the request against
+Optional options: DestinationOptions
Options to employ when fetching destinations
+
Returns Promise<HttpResponse>
A promise resolving to an HttpResponse.
+
relative
- +
Create the relative URL based on configuration of the given builder.
+Returns string
The relative URL for the request
+
set
- +
Replace the default service path with the given custom path. +In case of the SAP S/4HANA APIs the servicePath defaults to
+/sap/opu/odata/sap/<SERVICE_NAME>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
+
skip
- +
Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.
+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: DestinationRetrievalOptions
Options to employ when fetching destinations.
+
Returns Promise<string>
Promise resolving to the URL for the request
+
with
Parameters
headers: Record<string, string>
Key-value pairs denoting additional custom headers.
+
Returns ActionFunctionImportRequestBuilder<ParametersT, ReturnT>
The request builder itself, to facilitate method chaining.
+
with
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.
+
with
Parameters
servicePath: string
Path to override the default with.
+
Returns ActionFunctionImportRequestBuilder<ParametersT, ReturnT>
The request builder itself, to facilitate method chaining.
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class ActionImportRequestBuilder<ParametersT, ReturnT>
+
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
request
Readonly response
Type declaration
Parameters
data: any
Returns ReturnT
Methods
add
- +
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.
+
add
- +
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
+
add
- +
Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. +If the custom request configuration contains disallowed keys, those will be ignored.
+Parameters
requestConfiguration: Record<string, string>
Key-value pairs denoting additional custom request configuration options to be set in the request.
+
Returns ActionImportRequestBuilder<ParametersT, ReturnT>
The request builder itself, to facilitate method chaining.
+
append
- +
Append the given path to the URL. +This can be used for querying navigation properties of an entity. +To execute a request with an appended path use
+executeRawto avoid errors during deserialization. When using this, theexecutemethod is omitted from the return type.Parameters
Rest ...path: string[]
Path to be appended.
+
Returns Omit<ActionImportRequestBuilder<ParametersT, ReturnT>, "execute">
The request builder itself without "execute" function, to facilitate method chaining.
+
build
Returns ODataRequest<ODataFunctionImportRequestConfig<ParametersT> | ODataActionImportRequestConfig<ParametersT>>
Parameters
destination: Destination | DestinationNameAndJwt
Optional options: DestinationOptions
Returns Promise<ODataRequest<ODataFunctionImportRequestConfig<ParametersT> | ODataActionImportRequestConfig<ParametersT>>>
execute
- +
Execute request
+Parameters
destination: Destination | DestinationNameAndJwt
Destination to execute the request against
+Optional options: DestinationOptions
Options to employ when fetching destinations
+
Returns Promise<ReturnT>
A promise resolving to the requested return type
+
execute
- +
Execute request and return an HttpResponse.
+Parameters
destination: Destination | DestinationNameAndJwt
Destination to execute the request against
+Optional options: DestinationOptions
Options to employ when fetching destinations
+
Returns Promise<HttpResponse>
A promise resolving to an HttpResponse.
+
relative
- +
Create the relative URL based on configuration of the given builder.
+Returns string
The relative URL for the request
+
set
- +
Replace the default service path with the given custom path. +In case of the SAP S/4HANA APIs the servicePath defaults to
+/sap/opu/odata/sap/<SERVICE_NAME>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
+
skip
- +
Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.
+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: DestinationRetrievalOptions
Options to employ when fetching destinations.
+
Returns Promise<string>
Promise resolving to the URL for the request
+
with
Parameters
headers: Record<string, string>
Key-value pairs denoting additional custom headers.
+
Returns ActionImportRequestBuilder<ParametersT, ReturnT>
The request builder itself, to facilitate method chaining.
+
with
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.
+
with
Parameters
servicePath: string
Path to override the default with.
+
Returns ActionImportRequestBuilder<ParametersT, ReturnT>
The request builder itself, to facilitate method chaining.
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class AllFields<EntityT>
Type parameters
EntityT: EntityBase
Hierarchy
- AllFields
Index
Constructors
Properties
Constructors
constructor
Type parameters
EntityT: EntityBase<EntityT>
Parameters
_fieldName: string
_entityConstructor: Constructable<EntityT, unknown>
Returns AllFields<EntityT>
Properties
_entity
_field
Readonly selectable
Class AnyField<EntityT>
Type parameters
EntityT: EntityBase
+Type of the entity the field belongs to
+
Hierarchy
- AnyFieldBase<EntityT, true>
- AnyField
Index
Constructors
Properties
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.
+_fieldOf: ConstructorOrField<EntityT, any>
Constructor type of the entity the field belongs to.
+edmType: any
Type of the field according to the metadata description.
+Optional fieldOptions: FieldOptions<false, true>
Optional settings for this field.
+
Returns AnyField<EntityT>
Properties
Readonly _entity
Readonly _entity
Readonly _field
Readonly _field
Readonly _field
Readonly edm
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
+
field
- +
Path to the field to be used in filter and order by queries.
+Returns string
Path to the field to be used in filter and order by queries.
+
not
- +
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
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class BatchChangeSet<RequestT>
+
Representation of a batch change set, which holds a collection of write operations.
+Type parameters
RequestT: MethodRequestBuilder = any
Hierarchy
- BatchChangeSet
Implemented by
Index
Constructors
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 sub requests. Defaults to an auto generated value.
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Returns BatchChangeSet<RequestT>
Properties
Readonly boundary
Readonly requests
Class BatchRequestBuilder
+
Create a batch request to invoke multiple requests as a batch. The batch request builder accepts retrieve requests, i. e. getAll and getByKey requests and change sets, which in turn can contain create, update or delete requests. +The retrieve and change sets will be executed in order, while the order within a change set can vary.
+Hierarchy
Index
Constructors
Properties
Methods
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 default
Readonly entity
request
Readonly requests
Methods
add
- +
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.
+
add
- +
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
+
add
- +
Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. +If the custom request configuration contains disallowed keys, those will be ignored.
+Parameters
requestConfiguration: Record<string, string>
Key-value pairs denoting additional custom request configuration options to be set in the request.
+
Returns BatchRequestBuilder
The request builder itself, to facilitate method chaining.
+
append
- +
Append the given path to the URL. +This can be used for querying navigation properties of an entity. +To execute a request with an appended path use
+executeRawto avoid errors during deserialization. When using this, theexecutemethod is omitted from the return type.Parameters
Rest ...path: string[]
Path to be appended.
+
Returns Omit<BatchRequestBuilder, "execute">
The request builder itself without "execute" function, to facilitate method chaining.
+
build
Returns ODataRequest<ODataBatchRequestConfig>
Parameters
destination: Destination | DestinationNameAndJwt
Optional options: DestinationRetrievalOptions
Returns Promise<ODataRequest<ODataBatchRequestConfig>>
execute
- +
Execute request and return an HttpResponse.
+Parameters
destination: Destination | DestinationNameAndJwt
Destination to execute the request against
+Optional options: DestinationOptions
Options to employ when fetching destinations
+
Returns Promise<HttpResponse>
A promise resolving to an HttpResponse.
+
relative
- +
Create the relative URL based on configuration of the given builder.
+Returns string
The relative URL for the request
+
set
- +
Replace the default service path with the given custom path. +In case of the SAP S/4HANA APIs the servicePath defaults to
+/sap/opu/odata/sap/<SERVICE_NAME>and can be overwritten here.Parameters
servicePath: string
Path to override the default with
+
Returns BatchRequestBuilder
The request builder itself, to facilitate method chaining
+
skip
- +
Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.
+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: DestinationRetrievalOptions
Options to employ when fetching destinations.
+
Returns Promise<string>
Promise resolving to the URL for the request
+
with
Parameters
headers: Record<string, string>
Key-value pairs denoting additional custom headers.
+
Returns BatchRequestBuilder
The request builder itself, to facilitate method chaining.
+
with
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.
+
with
Parameters
servicePath: string
Path to override the default with.
+
Returns BatchRequestBuilder
The request builder itself, to facilitate method chaining.
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
with
Parameters
subRequestPathType: BatchSubRequestPathType
Returns BatchRequestBuilder
Class BatchResponseDeserializer
+
Represents the state needed to deserialize a parsed batch response using OData version specific deserialization data access.
+Hierarchy
- BatchResponseDeserializer
Index
Constructors
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
deserialize
- +
Deserialize the parsed batch response.
+Parameters
parsedBatchResponse: (ResponseData | ResponseData[])[]
Two dimensional list of parsed batch sub responses.
+
Returns (ReadResponse | WriteResponses | ErrorResponse)[]
An array of parsed sub responses of the batch response.
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class BigNumberField<EntityT>
Type parameters
EntityT: EntityBase
+Type of the entity the field belongs to
+
Hierarchy
- BigNumberFieldBase<EntityT, true>
- BigNumberField
Index
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.
+_fieldOf: ConstructorOrField<EntityT, any>
Constructor type of the entity the field belongs to.
+edmType: EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4
Type of the field according to the metadata description.
+Optional fieldOptions: FieldOptions<false, true>
Optional settings for this field.
+
Returns BigNumberField<EntityT>
Properties
Readonly _entity
Readonly _entity
Readonly _field
Readonly _field
Readonly _field
Readonly edm
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
+
field
- +
Path to the field to be used in filter and order by queries.
+Returns string
Path to the field to be used in filter and order by queries.
+
greater
- +
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
+
greater
- +
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
+
less
- +
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
+
less
- +
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
+
not
- +
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
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class BinaryField<EntityT>
Type parameters
EntityT: EntityBase
+Type of the entity the field belongs to
+
Hierarchy
- BinaryFieldBase<EntityT, true>
- BinaryField
Index
Constructors
Properties
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.
+_fieldOf: ConstructorOrField<EntityT, any>
Constructor type of the entity the field belongs to.
+edmType: EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4
Type of the field according to the metadata description.
+Optional fieldOptions: FieldOptions<false, true>
Optional settings for this field.
+
Returns BinaryField<EntityT>
Properties
Readonly _entity
Readonly _entity
Readonly _field
Readonly _field
Readonly _field
Readonly edm
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
+
field
- +
Path to the field to be used in filter and order by queries.
+Returns string
Path to the field to be used in filter and order by queries.
+
not
- +
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
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class BinaryFieldBase<EntityT, SelectableT>
Type parameters
EntityT: EntityBase
+Type of the entity the field belongs to
+SelectableT: boolean = false
Hierarchy
- EdmTypeField<EntityT, string, false, SelectableT>
- BinaryFieldBase
Index
Constructors
Properties
Methods
Constructors
constructor
- +
Creates an instance of EdmTypeField.
+Type parameters
EntityT: EntityBase<EntityT>
SelectableT: boolean = false
Parameters
fieldName: string
Actual name of the field used in the OData request.
+_fieldOf: ConstructorOrField<EntityT, any>
Constructor type of the entity the field belongs to.
+edmType: EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4
Type of the field according to the metadata description.
+Optional fieldOptions: FieldOptions<false, SelectableT>
Optional settings for this field.
+
Returns BinaryFieldBase<EntityT, SelectableT>
Properties
Readonly _entity
Readonly _entity
Readonly _field
Readonly _field
Readonly _field
Readonly edm
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
+
field
- +
Path to the field to be used in filter and order by queries.
+Returns string
Path to the field to be used in filter and order by queries.
+
not
- +
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
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class BooleanField<EntityT>
Type parameters
EntityT: EntityBase
+Type of the entity the field belongs to
+
Hierarchy
- BooleanFieldBase<EntityT, true>
- BooleanField
Index
Constructors
Properties
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.
+_fieldOf: ConstructorOrField<EntityT, any>
Constructor type of the entity the field belongs to.
+edmType: EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4
Type of the field according to the metadata description.
+Optional fieldOptions: FieldOptions<false, true>
Optional settings for this field.
+
Returns BooleanField<EntityT>
Properties
Readonly _entity
Readonly _entity
Readonly _field
Readonly _field
Readonly _field
Readonly edm
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
+
field
- +
Path to the field to be used in filter and order by queries.
+Returns string
Path to the field to be used in filter and order by queries.
+
not
- +
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
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class BooleanFieldBase<EntityT, SelectableT>
Type parameters
EntityT: EntityBase
+Type of the entity the field belongs to
+SelectableT: boolean = false
Hierarchy
- EdmTypeField<EntityT, boolean, false, SelectableT>
- BooleanFieldBase
Index
Constructors
Properties
Methods
Constructors
constructor
- +
Creates an instance of EdmTypeField.
+Type parameters
EntityT: EntityBase<EntityT>
SelectableT: boolean = false
Parameters
fieldName: string
Actual name of the field used in the OData request.
+_fieldOf: ConstructorOrField<EntityT, any>
Constructor type of the entity the field belongs to.
+edmType: EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4
Type of the field according to the metadata description.
+Optional fieldOptions: FieldOptions<false, SelectableT>
Optional settings for this field.
+
Returns BooleanFieldBase<EntityT, SelectableT>
Properties
Readonly _entity
Readonly _entity
Readonly _field
Readonly _field
Readonly _field
Readonly edm
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
+
field
- +
Path to the field to be used in filter and order by queries.
+Returns string
Path to the field to be used in filter and order by queries.
+
not
- +
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
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class BooleanFilterFunction<EntityT>
+
Representation of a filter function, that returns a value of type boolean.
+Type parameters
EntityT: EntityBase
Hierarchy
- FilterFunction<EntityT, boolean>
- BooleanFilterFunction
Index
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 edm
Readonly function
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
+
not
- +
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
+
to
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
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class Cache<T>
+
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
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
+undefinedotherwise.
has
- +
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
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Returns void
Class CollectionField<EntityT, CollectionFieldT, NullableT, SelectableT>
+
Represents a field of an entity or a complex type, that can have a collection as value.
+Type parameters
EntityT: EntityBase
+Type of the entity the field belongs to.
+CollectionFieldT: EdmTypeShared<"any"> | Record<string, any> = any
+Type of of elements of the collection. This can either be an EDM type or complex type.
+NullableT: boolean = false
+Boolean type that represents whether the field is nullable.
+SelectableT: boolean = false
+Boolean type that represents whether the field is selectable.
+
Hierarchy
- Field<EntityT, NullableT, SelectableT>
- CollectionField
Index
Constructors
Properties
Methods
Constructors
constructor
- +
Creates an instance of CollectionField.
+Type parameters
EntityT: EntityBase<EntityT>
CollectionFieldT: Record<string, any> | EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4 = any
NullableT: boolean = false
SelectableT: boolean = false
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: CollectionFieldType<CollectionFieldT>
+Edm type of the field according to the metadata description.
+Optional fieldOptions: FieldOptions<NullableT, SelectableT>
+Optional settings for this field.
+
Returns CollectionField<EntityT, CollectionFieldT, NullableT, SelectableT>
Properties
Readonly _entity
Readonly _entity
Readonly _field
Readonly _field
Readonly _field
Readonly _field
Methods
field
- +
Gets the path to the complex type property represented by this.
+Returns string
The path to the complex type property.
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class ComplexTypeAnyPropertyField<EntityT, ComplexT>
Type parameters
EntityT: EntityBase
+Type of the entity the field belongs to
+ComplexT = any
Hierarchy
- AnyFieldBase<EntityT>
- ComplexTypeAnyPropertyField
Index
Constructors
Properties
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<ODataVersionOf<EntityT>>
+Type of the field according to the metadata description
+
Returns ComplexTypeAnyPropertyField<EntityT, ComplexT>
Properties
Readonly _entity
Readonly _entity
Readonly _field
Readonly _field
Readonly _field
Readonly edm
Readonly field
+
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
+
field
- +
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.
+
not
- +
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
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class ComplexTypeBigNumberPropertyField<EntityT, ComplexT>
Type parameters
EntityT: EntityBase
+Type of the entity the field belongs to
+ComplexT = any
Hierarchy
- BigNumberFieldBase<EntityT>
- ComplexTypeBigNumberPropertyField
Index
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<ODataVersionOf<EntityT>>
+Type of the field according to the metadata description
+
Returns ComplexTypeBigNumberPropertyField<EntityT, ComplexT>
- +
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
+entityConstructor: Constructable<EntityT, unknown>
Constructor type of the entity the field belongs to
+parentTypeName: string
Name of the parent complex type
+edmType: EdmTypeShared<ODataVersionOf<EntityT>>
+Type of the field according to the metadata description
+
Returns ComplexTypeBigNumberPropertyField<EntityT, ComplexT>
Properties
Readonly _entity
Readonly _entity
Readonly _field
Readonly _field
Readonly _field
Readonly edm
Readonly field
+
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
+
field
- +
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.
+
greater
- +
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
+
greater
- +
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
+
less
- +
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
+
less
- +
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
+
not
- +
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
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class ComplexTypeBinaryPropertyField<EntityT, ComplexT>
Type parameters
EntityT: EntityBase
+Type of the entity the field belongs to
+ComplexT = any
Hierarchy
- BinaryFieldBase<EntityT>
- ComplexTypeBinaryPropertyField
Index
Constructors
Properties
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<ODataVersionOf<EntityT>>
+Type of the field according to the metadata description
+
Returns ComplexTypeBinaryPropertyField<EntityT, ComplexT>
- +
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
+entityConstructor: Constructable<EntityT, unknown>
Constructor type of the entity the field belongs to
+parentTypeName: string
Name of the parent complex type
+edmType: EdmTypeShared<ODataVersionOf<EntityT>>
+Type of the field according to the metadata description
+
Returns ComplexTypeBinaryPropertyField<EntityT, ComplexT>
Properties
Readonly _entity
Readonly _entity
Readonly _field
Readonly _field
Readonly _field
Readonly edm
Readonly field
+
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
+
field
- +
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.
+
not
- +
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
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class ComplexTypeBooleanPropertyField<EntityT, ComplexT>
Type parameters
EntityT: EntityBase
+Type of the entity the field belongs to
+ComplexT = any
Hierarchy
- BooleanFieldBase<EntityT>
- ComplexTypeBooleanPropertyField
Index
Constructors
Properties
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<ODataVersionOf<EntityT>>
+Type of the field according to the metadata description
+
Returns ComplexTypeBooleanPropertyField<EntityT, ComplexT>
- +
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
+entityConstructor: Constructable<EntityT, unknown>
Constructor type of the entity the field belongs to
+parentTypeName: string
Name of the parent complex type
+edmType: EdmTypeShared<ODataVersionOf<EntityT>>
+Type of the field according to the metadata description
+
Returns ComplexTypeBooleanPropertyField<EntityT, ComplexT>
Properties
Readonly _entity
Readonly _entity
Readonly _field
Readonly _field
Readonly _field
Readonly edm
Readonly field
+
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
+
field
- +
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.
+
not
- +
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
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class ComplexTypeDatePropertyField<EntityT, ComplexT>
Type parameters
EntityT: EntityBase
+Type of the entity the field belongs to
+ComplexT = any
Hierarchy
- DateFieldBase<EntityT>
- ComplexTypeDatePropertyField
Index
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<ODataVersionOf<EntityT>>
+Type of the field according to the metadata description
+
Returns ComplexTypeDatePropertyField<EntityT, ComplexT>
- +
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
+entityConstructor: Constructable<EntityT, unknown>
Constructor type of the entity the field belongs to
+parentTypeName: string
Name of the parent complex type
+edmType: EdmTypeShared<ODataVersionOf<EntityT>>
+Type of the field according to the metadata description
+
Returns ComplexTypeDatePropertyField<EntityT, ComplexT>
Properties
Readonly _entity
Readonly _entity
Readonly _field
Readonly _field
Readonly _field
Readonly edm
Readonly field
+
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
+
field
- +
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.
+
greater
- +
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
+
greater
- +
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
+
less
- +
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
+
less
- +
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
+
not
- +
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
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class ComplexTypeDurationPropertyField<EntityT, ComplexT>
Type parameters
EntityT: EntityBase
+Type of the entity the field belongs to
+ComplexT = any
Hierarchy
- DurtionFieldBase<EntityT>
- ComplexTypeDurationPropertyField
Index
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<ODataVersionOf<EntityT>>
+Type of the field according to the metadata description
+
Returns ComplexTypeDurationPropertyField<EntityT, ComplexT>
- +
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
+entityConstructor: Constructable<EntityT, unknown>
Constructor type of the entity the field belongs to
+parentTypeName: string
Name of the parent complex type
+edmType: EdmTypeShared<ODataVersionOf<EntityT>>
+Type of the field according to the metadata description
+
Returns ComplexTypeDurationPropertyField<EntityT, ComplexT>
Properties
Readonly _entity
Readonly _entity
Readonly _field
Readonly _field
Readonly _field
Readonly edm
Readonly field
+
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
+
field
- +
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.
+
greater
- +
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
+
greater
- +
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
+
less
- +
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
+
less
- +
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
+
not
- +
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
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class ComplexTypeEnumPropertyField<EntityT, ComplexT>
Type parameters
EntityT: EntityBase
+Type of the entity the field belongs to
+ComplexT = any
Hierarchy
- EnumFieldBase<EntityT>
- ComplexTypeEnumPropertyField
Index
Constructors
Properties
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 _entity
Readonly _field
Readonly _field
Readonly _field
Readonly edm
Readonly field
+
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
+
field
- +
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.
+
not
- +
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
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class ComplexTypeField<EntityT, ComplexT, NullableT, SelectableT>
+
Represents a complex type property of an entity or a complex type.
+ComplexTypeFields are used as static properties of entities and are generated from the metadata, i.e. for each property of
+an OData entity, that has a complex type, there exists one static instance of ComplexTypeField (or rather one of its subclasses) in the corresponding generated class file.
+ComplexTypeFields are used to represent the domain of complex or custom structures that can be used in select, filter and order by functions.
+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
+Type of complex type represented by this field.
+NullableT: boolean = false
+Boolean type that represents whether the field is nullable.
+SelectableT: boolean = false
+Boolean type that represents whether the field is selectable.
+
Hierarchy
- Field<EntityT, NullableT, SelectableT>
- ComplexTypeField
Index
Constructors
Properties
Methods
Constructors
constructor
Type parameters
EntityT: EntityBase<EntityT>
ComplexT = any
NullableT: boolean = false
SelectableT: boolean = false
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, NullableT, SelectableT>
Type parameters
EntityT: EntityBase<EntityT>
ComplexT = any
NullableT: boolean = false
SelectableT: boolean = false
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.
+
Returns ComplexTypeField<EntityT, ComplexT, NullableT, SelectableT>
- +
Creates an instance of ComplexTypeField.
+Type parameters
EntityT: EntityBase<EntityT>
ComplexT = any
NullableT: boolean = false
SelectableT: boolean = false
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.
+complexType: ComplexTypeNamespace<ComplexT>
The complex type of the complex type property represented by this.
+Optional fieldOptions: FieldOptions<NullableT, SelectableT>
Optional settings for this field.
+
Returns ComplexTypeField<EntityT, ComplexT, NullableT, SelectableT>
Properties
Readonly _complex
+
The complex type of the complex type property represented by this.
+Readonly _entity
Readonly _entity
Readonly _field
Readonly _field
Readonly field
Methods
field
- +
Gets the path to the complex type property represented by this.
+Returns string
The path to the complex type property.
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class ComplexTypeNumberPropertyField<EntityT, ComplexT>
Type parameters
EntityT: EntityBase
+Type of the entity the field belongs to
+ComplexT = any
Hierarchy
- NumberFieldBase<EntityT>
- ComplexTypeNumberPropertyField
Index
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<ODataVersionOf<EntityT>>
+Type of the field according to the metadata description
+
Returns ComplexTypeNumberPropertyField<EntityT, ComplexT>
- +
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
+entityConstructor: Constructable<EntityT, unknown>
Constructor type of the entity the field belongs to
+parentTypeName: string
Name of the parent complex type
+edmType: EdmTypeShared<ODataVersionOf<EntityT>>
+Type of the field according to the metadata description
+
Returns ComplexTypeNumberPropertyField<EntityT, ComplexT>
Properties
Readonly _entity
Readonly _entity
Readonly _field
Readonly _field
Readonly _field
Readonly edm
Readonly field
+
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
+
field
- +
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.
+
greater
- +
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
+
greater
- +
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
+
less
- +
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
+
less
- +
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
+
not
- +
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
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class ComplexTypeStringPropertyField<EntityT, ComplexT>
Type parameters
EntityT: EntityBase
+Type of the entity the field belongs to
+ComplexT = any
Hierarchy
- StringFieldBase<EntityT>
- ComplexTypeStringPropertyField
Index
Constructors
Properties
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<ODataVersionOf<EntityT>>
+Type of the field according to the metadata description
+
Returns ComplexTypeStringPropertyField<EntityT, ComplexT>
- +
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
+entityConstructor: Constructable<EntityT, unknown>
Constructor type of the entity the field belongs to
+parentTypeName: string
Name of the parent complex type
+edmType: EdmTypeShared<ODataVersionOf<EntityT>>
+Type of the field according to the metadata description
+
Returns ComplexTypeStringPropertyField<EntityT, ComplexT>
Properties
Readonly _entity
Readonly _entity
Readonly _field
Readonly _field
Readonly _field
Readonly edm
Readonly field
+
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
+
field
- +
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.
+
not
- +
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
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class ComplexTypeTimePropertyField<EntityT, ComplexT>
Type parameters
EntityT: EntityBase
+Type of the entity the field belongs to
+ComplexT = any
Hierarchy
- TimeFieldBase<EntityT>
- ComplexTypeTimePropertyField
Index
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<ODataVersionOf<EntityT>>
+Type of the field according to the metadata description
+
Returns ComplexTypeTimePropertyField<EntityT, ComplexT>
- +
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
+entityConstructor: Constructable<EntityT, unknown>
Constructor type of the entity the field belongs to
+parentTypeName: string
Name of the parent complex type
+edmType: EdmTypeShared<ODataVersionOf<EntityT>>
+Type of the field according to the metadata description
+
Returns ComplexTypeTimePropertyField<EntityT, ComplexT>
Properties
Readonly _entity
Readonly _entity
Readonly _field
Readonly _field
Readonly _field
Readonly edm
Readonly field
+
The constructor of the entity or the complex type this field belongs to
+Methods
equals
field
- +
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.
+
greater
greater
less
less
not
Class CountRequestBuilder<EntityT>
+
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
- +
Creates an instance of CountRequestBuilder.
+Type parameters
EntityT: EntityBase<EntityT>
Parameters
getAllRequest: GetAllRequestBuilderBase<EntityT>
Returns CountRequestBuilder<EntityT>
Properties
Readonly get
request
Methods
add
- +
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.
+
add
- +
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
+
add
- +
Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. +If the custom request configuration contains disallowed keys, those will be ignored.
+Parameters
requestConfiguration: Record<string, string>
Key-value pairs denoting additional custom request configuration options to be set in the request.
+
Returns CountRequestBuilder<EntityT>
The request builder itself, to facilitate method chaining.
+
append
- +
Append the given path to the URL. +This can be used for querying navigation properties of an entity. +To execute a request with an appended path use
+executeRawto avoid errors during deserialization. When using this, theexecutemethod is omitted from the return type.Parameters
Rest ...path: string[]
Path to be appended.
+
Returns Omit<CountRequestBuilder<EntityT>, "execute">
The request builder itself without "execute" function, to facilitate method chaining.
+
build
Returns ODataRequest<ODataCountRequestConfig<EntityT>>
Parameters
destination: Destination | DestinationNameAndJwt
Optional options: DestinationOptions
Returns Promise<ODataRequest<ODataCountRequestConfig<EntityT>>>
execute
- +
Execute request.
+Parameters
destination: Destination | DestinationNameAndJwt
Destination to execute the request against
+Optional options: DestinationOptions
Options to employ when fetching destinations
+
Returns Promise<number>
A promise resolving to the number of entities
+
execute
- +
Execute request and return an HttpResponse.
+Parameters
destination: Destination | DestinationNameAndJwt
Destination to execute the request against
+Optional options: DestinationOptions
Options to employ when fetching destinations
+
Returns Promise<HttpResponse>
A promise resolving to an HttpResponse.
+
relative
- +
Create the relative URL based on configuration of the given builder.
+Returns string
The relative URL for the request
+
set
- +
Replace the default service path with the given custom path. +In case of the SAP S/4HANA APIs the servicePath defaults to
+/sap/opu/odata/sap/<SERVICE_NAME>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
+
skip
- +
Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.
+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: DestinationRetrievalOptions
Options to employ when fetching destinations.
+
Returns Promise<string>
Promise resolving to the URL for the request
+
with
Parameters
headers: Record<string, string>
Key-value pairs denoting additional custom headers.
+
Returns CountRequestBuilder<EntityT>
The request builder itself, to facilitate method chaining.
+
with
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.
+
with
Parameters
servicePath: string
Path to override the default with.
+
Returns CountRequestBuilder<EntityT>
The request builder itself, to facilitate method chaining.
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class CreateRequestBuilder<EntityT>
+
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
Properties
Accessors
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 _entity
Readonly deserializer
Readonly odata
request
Readonly response
Readonly serializer
Accessors
entity
Returns EntityT
Methods
add
- +
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.
+
add
- +
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
+
add
- +
Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. +If the custom request configuration contains disallowed keys, those will be ignored.
+Parameters
requestConfiguration: Record<string, string>
Key-value pairs denoting additional custom request configuration options to be set in the request.
+
Returns CreateRequestBuilder<EntityT>
The request builder itself, to facilitate method chaining.
+
append
- +
Append the given path to the URL. +This can be used for querying navigation properties of an entity. +To execute a request with an appended path use
+executeRawto avoid errors during deserialization. When using this, theexecutemethod is omitted from the return type.Parameters
Rest ...path: string[]
Path to be appended.
+
Returns Omit<CreateRequestBuilder<EntityT>, "execute">
The request builder itself without "execute" function, to facilitate method chaining.
+
as
- +
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: DestinationOptions
Returns Promise<ODataRequest<ODataCreateRequestConfig<EntityT>>>
execute
- +
Execute query.
+Parameters
destination: Destination | DestinationNameAndJwt
Destination to execute the request against
+Optional options: DestinationOptions
Options to employ when fetching destinations
+
Returns Promise<EntityT>
A promise resolving to the created entity
+
execute
- +
Execute request and return an HttpResponse.
+Parameters
destination: Destination | DestinationNameAndJwt
Destination to execute the request against
+Optional options: DestinationOptions
Options to employ when fetching destinations
+
Returns Promise<HttpResponse>
A promise resolving to an HttpResponse.
+
prepare
Returns CreateRequestBuilder<EntityT>
the builder itself
+
relative
- +
Create the relative URL based on configuration of the given builder.
+Returns string
The relative URL for the request
+
set
- +
Replace the default service path with the given custom path. +In case of the SAP S/4HANA APIs the servicePath defaults to
+/sap/opu/odata/sap/<SERVICE_NAME>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
+
skip
- +
Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.
+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: DestinationRetrievalOptions
Options to employ when fetching destinations.
+
Returns Promise<string>
Promise resolving to the URL for the request
+
with
Parameters
headers: Record<string, string>
Key-value pairs denoting additional custom headers.
+
Returns CreateRequestBuilder<EntityT>
The request builder itself, to facilitate method chaining.
+
with
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.
+
with
Parameters
servicePath: string
Path to override the default with.
+
Returns CreateRequestBuilder<EntityT>
The request builder itself, to facilitate method chaining.
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class CreateRequestBuilderBase<EntityT>
+
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
Implements
- EntityIdentifiable<EntityT>
Index
Constructors
Properties
Accessors
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 _entity
Readonly deserializer
Readonly odata
request
Readonly response
Readonly serializer
Accessors
entity
Returns EntityT
Methods
add
- +
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.
+
add
- +
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
+
add
- +
Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. +If the custom request configuration contains disallowed keys, those will be ignored.
+Parameters
requestConfiguration: Record<string, string>
Key-value pairs denoting additional custom request configuration options to be set in the request.
+
Returns CreateRequestBuilderBase<EntityT>
The request builder itself, to facilitate method chaining.
+
append
- +
Append the given path to the URL. +This can be used for querying navigation properties of an entity. +To execute a request with an appended path use
+executeRawto avoid errors during deserialization. When using this, theexecutemethod is omitted from the return type.Parameters
Rest ...path: string[]
Path to be appended.
+
Returns Omit<CreateRequestBuilderBase<EntityT>, "execute">
The request builder itself without "execute" function, to facilitate method chaining.
+
as
- +
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: DestinationOptions
Returns Promise<ODataRequest<ODataCreateRequestConfig<EntityT>>>
execute
- +
Execute query.
+Parameters
destination: Destination | DestinationNameAndJwt
Destination to execute the request against
+Optional options: DestinationOptions
Options to employ when fetching destinations
+
Returns Promise<EntityT>
A promise resolving to the created entity
+
execute
- +
Execute request and return an HttpResponse.
+Parameters
destination: Destination | DestinationNameAndJwt
Destination to execute the request against
+Optional options: DestinationOptions
Options to employ when fetching destinations
+
Returns Promise<HttpResponse>
A promise resolving to an HttpResponse.
+
prepare
Returns CreateRequestBuilderBase<EntityT>
the builder itself
+
relative
- +
Create the relative URL based on configuration of the given builder.
+Returns string
The relative URL for the request
+
set
- +
Replace the default service path with the given custom path. +In case of the SAP S/4HANA APIs the servicePath defaults to
+/sap/opu/odata/sap/<SERVICE_NAME>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
+
skip
- +
Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.
+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: DestinationRetrievalOptions
Options to employ when fetching destinations.
+
Returns Promise<string>
Promise resolving to the URL for the request
+
with
Parameters
headers: Record<string, string>
Key-value pairs denoting additional custom headers.
+
Returns CreateRequestBuilderBase<EntityT>
The request builder itself, to facilitate method chaining.
+
with
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.
+
with
Parameters
servicePath: string
Path to override the default with.
+
Returns CreateRequestBuilderBase<EntityT>
The request builder itself, to facilitate method chaining.
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class CreateRequestBuilderV4<EntityT>
+
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
Properties
Accessors
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 _entity
Readonly deserializer
Readonly odata
request
Readonly response
Readonly serializer
Accessors
entity
Returns EntityT
Methods
add
- +
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.
+
add
- +
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
+
add
- +
Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. +If the custom request configuration contains disallowed keys, those will be ignored.
+Parameters
requestConfiguration: Record<string, string>
Key-value pairs denoting additional custom request configuration options to be set in the request.
+
Returns CreateRequestBuilderV4<EntityT>
The request builder itself, to facilitate method chaining.
+
append
- +
Append the given path to the URL. +This can be used for querying navigation properties of an entity. +To execute a request with an appended path use
+executeRawto avoid errors during deserialization. When using this, theexecutemethod is omitted from the return type.Parameters
Rest ...path: string[]
Path to be appended.
+
Returns Omit<CreateRequestBuilderV4<EntityT>, "execute">
The request builder itself without "execute" function, to facilitate method chaining.
+
as
- +
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: DestinationOptions
Returns Promise<ODataRequest<ODataCreateRequestConfig<EntityT>>>
execute
- +
Execute query.
+Parameters
destination: Destination | DestinationNameAndJwt
Destination to execute the request against
+Optional options: DestinationOptions
Options to employ when fetching destinations
+
Returns Promise<EntityT>
A promise resolving to the created entity
+
execute
- +
Execute request and return an HttpResponse.
+Parameters
destination: Destination | DestinationNameAndJwt
Destination to execute the request against
+Optional options: DestinationOptions
Options to employ when fetching destinations
+
Returns Promise<HttpResponse>
A promise resolving to an HttpResponse.
+
prepare
Returns CreateRequestBuilderV4<EntityT>
the builder itself
+
relative
- +
Create the relative URL based on configuration of the given builder.
+Returns string
The relative URL for the request
+
set
- +
Replace the default service path with the given custom path. +In case of the SAP S/4HANA APIs the servicePath defaults to
+/sap/opu/odata/sap/<SERVICE_NAME>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
+
skip
- +
Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.
+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: DestinationRetrievalOptions
Options to employ when fetching destinations.
+
Returns Promise<string>
Promise resolving to the URL for the request
+
with
Parameters
headers: Record<string, string>
Key-value pairs denoting additional custom headers.
+
Returns CreateRequestBuilderV4<EntityT>
The request builder itself, to facilitate method chaining.
+
with
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.
+
with
Parameters
servicePath: string
Path to override the default with.
+
Returns CreateRequestBuilderV4<EntityT>
The request builder itself, to facilitate method chaining.
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class CustomField<EntityT, NullableT>
Type parameters
EntityT: Entity
NullableT: boolean = false
Hierarchy
- CustomFieldBase<EntityT, NullableT>
- CustomField
Index
Constructors
constructor
Type parameters
EntityT: Entity<EntityT>
NullableT: boolean = false
Parameters
fieldName: string
entityConstructor: Constructable<EntityT, unknown>
Optional isNullable: NullableT
Returns CustomField<EntityT, NullableT>
Properties
Readonly _entity
Readonly _entity
Readonly _field
Readonly _field
Protected field
Methods
edm
Returns EdmTypeField<EntityT, "Edm.Binary", NullableT, true>
edm
Returns EdmTypeField<EntityT, "Edm.Boolean", NullableT, true>
edm
Returns OrderableEdmTypeField<EntityT, "Edm.Byte", NullableT, true>
edm
Returns OrderableEdmTypeField<EntityT, "Edm.DateTime", NullableT, true>
edm
Returns OrderableEdmTypeField<EntityT, "Edm.DateTimeOffset", NullableT, true>
edm
Returns EdmTypeField<EntityT, "Edm.Decimal", NullableT, true>
edm
Returns OrderableEdmTypeField<EntityT, "Edm.Double", NullableT, true>
edm
Returns EdmTypeField<EntityT, "Edm.Guid", NullableT, true>
edm
Returns OrderableEdmTypeField<EntityT, "Edm.Int16", NullableT, true>
edm
Returns OrderableEdmTypeField<EntityT, "Edm.Int32", NullableT, true>
edm
Returns OrderableEdmTypeField<EntityT, "Edm.Int64", NullableT, true>
edmSByte
Returns OrderableEdmTypeField<EntityT, "Edm.SByte", NullableT, true>
edm
Returns OrderableEdmTypeField<EntityT, "Edm.Single", NullableT, true>
edm
Returns EdmTypeField<EntityT, "Edm.String", NullableT, true>
edm
Returns OrderableEdmTypeField<EntityT, "Edm.Time", NullableT, true>
field
- +
Path to the field to be used in filter and order by queries.
+Returns string
Path to the field to be used in filter and order by queries.
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class CustomFieldV4<EntityT, NullableT>
Type parameters
EntityT: EntityV4
NullableT: boolean = false
Hierarchy
- CustomFieldBase<EntityT, NullableT>
- CustomFieldV4
Index
Constructors
constructor
Type parameters
EntityT: EntityV4<EntityT>
NullableT: boolean = false
Parameters
fieldName: string
entityConstructor: Constructable<EntityT, unknown>
Optional isNullable: NullableT
Returns CustomFieldV4<EntityT, NullableT>
Properties
Readonly _entity
Readonly _entity
Readonly _field
Readonly _field
Protected field
Methods
edm
Returns EdmTypeField<EntityT, "Edm.Binary", NullableT, true>
edm
Returns EdmTypeField<EntityT, "Edm.Boolean", NullableT, true>
edm
Returns OrderableEdmTypeField<EntityT, "Edm.Byte", NullableT, true>
edm
Returns OrderableEdmTypeField<EntityT, "Edm.Date", NullableT, true>
edm
Returns OrderableEdmTypeField<EntityT, "Edm.DateTimeOffset", NullableT, true>
edm
Returns EdmTypeField<EntityT, "Edm.Decimal", NullableT, true>
edm
Returns OrderableEdmTypeField<EntityT, "Edm.Double", NullableT, true>
edm
Returns OrderableEdmTypeField<EntityT, "Edm.Duration", NullableT, true>
edm
Returns EdmTypeField<EntityT, "Edm.Guid", NullableT, true>
edm
Returns OrderableEdmTypeField<EntityT, "Edm.Int16", NullableT, true>
edm
Returns OrderableEdmTypeField<EntityT, "Edm.Int32", NullableT, true>
edm
Returns OrderableEdmTypeField<EntityT, "Edm.Int64", NullableT, true>
edmSByte
Returns OrderableEdmTypeField<EntityT, "Edm.SByte", NullableT, true>
edm
Returns OrderableEdmTypeField<EntityT, "Edm.Single", NullableT, true>
edm
Returns EdmTypeField<EntityT, "Edm.String", NullableT, true>
edm
Returns OrderableEdmTypeField<EntityT, "Edm.TimeOfDay", NullableT, true>
field
- +
Path to the field to be used in filter and order by queries.
+Returns string
Path to the field to be used in filter and order by queries.
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class DateField<EntityT>
Type parameters
EntityT: EntityBase
+Type of the entity the field belongs to
+
Hierarchy
- DateFieldBase<EntityT, true>
- DateField
Index
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.
+_fieldOf: ConstructorOrField<EntityT, any>
Constructor type of the entity the field belongs to.
+edmType: EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4
Type of the field according to the metadata description.
+Optional fieldOptions: FieldOptions<false, true>
Optional settings for this field.
+
Returns DateField<EntityT>
Properties
Readonly _entity
Readonly _entity
Readonly _field
Readonly _field
Readonly _field
Readonly edm
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
+
field
- +
Path to the field to be used in filter and order by queries.
+Returns string
Path to the field to be used in filter and order by queries.
+
greater
- +
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
+
greater
- +
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
+
less
- +
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
+
less
- +
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
+
not
- +
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
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class DateFieldBase<EntityT, SelectableT>
Type parameters
EntityT: EntityBase
+Type of the entity the field belongs to
+SelectableT: boolean = false
Hierarchy
- EdmTypeField<EntityT, moment.Moment, false, SelectableT>
- DateFieldBase
Index
Constructors
constructor
- +
Creates an instance of EdmTypeField.
+Type parameters
EntityT: EntityBase<EntityT>
SelectableT: boolean = false
Parameters
fieldName: string
Actual name of the field used in the OData request.
+_fieldOf: ConstructorOrField<EntityT, any>
Constructor type of the entity the field belongs to.
+edmType: EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4
Type of the field according to the metadata description.
+Optional fieldOptions: FieldOptions<false, SelectableT>
Optional settings for this field.
+
Returns DateFieldBase<EntityT, SelectableT>
Properties
Readonly _entity
Readonly _entity
Readonly _field
Readonly _field
Readonly _field
Readonly edm
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
+
field
- +
Path to the field to be used in filter and order by queries.
+Returns string
Path to the field to be used in filter and order by queries.
+
greater
- +
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
+
greater
- +
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
+
less
- +
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
+
less
- +
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
+
not
- +
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
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class DeleteRequestBuilder<EntityT>
+
Create OData query to delete an entity.
+Type parameters
EntityT: Entity
+Type of the entity to be deleted
+
Hierarchy
- DeleteRequestBuilderBase<EntityT>
- DeleteRequestBuilder
Index
Constructors
Properties
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 _entity
request
Methods
add
- +
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.
+
add
- +
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
+
add
- +
Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. +If the custom request configuration contains disallowed keys, those will be ignored.
+Parameters
requestConfiguration: Record<string, string>
Key-value pairs denoting additional custom request configuration options to be set in the request.
+
Returns DeleteRequestBuilder<EntityT>
The request builder itself, to facilitate method chaining.
+
append
- +
Append the given path to the URL. +This can be used for querying navigation properties of an entity. +To execute a request with an appended path use
+executeRawto avoid errors during deserialization. When using this, theexecutemethod is omitted from the return type.Parameters
Rest ...path: string[]
Path to be appended.
+
Returns Omit<DeleteRequestBuilder<EntityT>, "execute">
The request builder itself without "execute" function, to facilitate method chaining.
+
build
Returns ODataRequest<ODataDeleteRequestConfig<EntityT>>
Parameters
destination: Destination | DestinationNameAndJwt
Optional options: DestinationOptions
Returns Promise<ODataRequest<ODataDeleteRequestConfig<EntityT>>>
execute
- +
Execute query.
+Parameters
destination: Destination | DestinationNameAndJwt
Destination to execute the request against
+Optional options: DestinationOptions
Options to employ when fetching destinations
+
Returns Promise<void>
A promise resolving once the entity was deleted
+
execute
- +
Execute request and return an HttpResponse.
+Parameters
destination: Destination | DestinationNameAndJwt
Destination to execute the request against
+Optional options: DestinationOptions
Options to employ when fetching destinations
+
Returns Promise<HttpResponse>
A promise resolving to an HttpResponse.
+
ignore
- +
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
+
relative
- +
Create the relative URL based on configuration of the given builder.
+Returns string
The relative URL for the request
+
set
- +
Replace the default service path with the given custom path. +In case of the SAP S/4HANA APIs the servicePath defaults to
+/sap/opu/odata/sap/<SERVICE_NAME>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
+
set
- +
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
+
skip
- +
Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.
+Returns DeleteRequestBuilder<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: DestinationRetrievalOptions
Options to employ when fetching destinations.
+
Returns Promise<string>
Promise resolving to the URL for the request
+
with
Parameters
headers: Record<string, string>
Key-value pairs denoting additional custom headers.
+
Returns DeleteRequestBuilder<EntityT>
The request builder itself, to facilitate method chaining.
+
with
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.
+
with
Parameters
servicePath: string
Path to override the default with.
+
Returns DeleteRequestBuilder<EntityT>
The request builder itself, to facilitate method chaining.
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class DeleteRequestBuilderBase<EntityT>
+
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
Implements
- EntityIdentifiable<EntityT>
Index
Constructors
Properties
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 _entity
request
Methods
add
- +
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.
+
add
- +
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
+
add
- +
Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. +If the custom request configuration contains disallowed keys, those will be ignored.
+Parameters
requestConfiguration: Record<string, string>
Key-value pairs denoting additional custom request configuration options to be set in the request.
+
Returns DeleteRequestBuilderBase<EntityT>
The request builder itself, to facilitate method chaining.
+
append
- +
Append the given path to the URL. +This can be used for querying navigation properties of an entity. +To execute a request with an appended path use
+executeRawto avoid errors during deserialization. When using this, theexecutemethod is omitted from the return type.Parameters
Rest ...path: string[]
Path to be appended.
+
Returns Omit<DeleteRequestBuilderBase<EntityT>, "execute">
The request builder itself without "execute" function, to facilitate method chaining.
+
build
Returns ODataRequest<ODataDeleteRequestConfig<EntityT>>
Parameters
destination: Destination | DestinationNameAndJwt
Optional options: DestinationOptions
Returns Promise<ODataRequest<ODataDeleteRequestConfig<EntityT>>>
execute
- +
Execute query.
+Parameters
destination: Destination | DestinationNameAndJwt
Destination to execute the request against
+Optional options: DestinationOptions
Options to employ when fetching destinations
+
Returns Promise<void>
A promise resolving once the entity was deleted
+
execute
- +
Execute request and return an HttpResponse.
+Parameters
destination: Destination | DestinationNameAndJwt
Destination to execute the request against
+Optional options: DestinationOptions
Options to employ when fetching destinations
+
Returns Promise<HttpResponse>
A promise resolving to an HttpResponse.
+
ignore
- +
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
+
relative
- +
Create the relative URL based on configuration of the given builder.
+Returns string
The relative URL for the request
+
set
- +
Replace the default service path with the given custom path. +In case of the SAP S/4HANA APIs the servicePath defaults to
+/sap/opu/odata/sap/<SERVICE_NAME>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 set
Parameters
eTag: string
Returns DeleteRequestBuilderBase<EntityT>
skip
- +
Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.
+Returns DeleteRequestBuilderBase<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: DestinationRetrievalOptions
Options to employ when fetching destinations.
+
Returns Promise<string>
Promise resolving to the URL for the request
+
with
Parameters
headers: Record<string, string>
Key-value pairs denoting additional custom headers.
+
Returns DeleteRequestBuilderBase<EntityT>
The request builder itself, to facilitate method chaining.
+
with
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.
+
with
Parameters
servicePath: string
Path to override the default with.
+
Returns DeleteRequestBuilderBase<EntityT>
The request builder itself, to facilitate method chaining.
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class DeleteRequestBuilderV4<EntityT>
+
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
Properties
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 _entity
request
Methods
add
- +
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.
+
add
- +
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
+
add
- +
Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. +If the custom request configuration contains disallowed keys, those will be ignored.
+Parameters
requestConfiguration: Record<string, string>
Key-value pairs denoting additional custom request configuration options to be set in the request.
+
Returns DeleteRequestBuilderV4<EntityT>
The request builder itself, to facilitate method chaining.
+
append
- +
Append the given path to the URL. +This can be used for querying navigation properties of an entity. +To execute a request with an appended path use
+executeRawto avoid errors during deserialization. When using this, theexecutemethod is omitted from the return type.Parameters
Rest ...path: string[]
Path to be appended.
+
Returns Omit<DeleteRequestBuilderV4<EntityT>, "execute">
The request builder itself without "execute" function, to facilitate method chaining.
+
build
Returns ODataRequest<ODataDeleteRequestConfig<EntityT>>
Parameters
destination: Destination | DestinationNameAndJwt
Optional options: DestinationOptions
Returns Promise<ODataRequest<ODataDeleteRequestConfig<EntityT>>>
execute
- +
Execute query.
+Parameters
destination: Destination | DestinationNameAndJwt
Destination to execute the request against
+Optional options: DestinationOptions
Options to employ when fetching destinations
+
Returns Promise<void>
A promise resolving once the entity was deleted
+
execute
- +
Execute request and return an HttpResponse.
+Parameters
destination: Destination | DestinationNameAndJwt
Destination to execute the request against
+Optional options: DestinationOptions
Options to employ when fetching destinations
+
Returns Promise<HttpResponse>
A promise resolving to an HttpResponse.
+
ignore
- +
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
+
relative
- +
Create the relative URL based on configuration of the given builder.
+Returns string
The relative URL for the request
+
set
- +
Replace the default service path with the given custom path. +In case of the SAP S/4HANA APIs the servicePath defaults to
+/sap/opu/odata/sap/<SERVICE_NAME>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
+
set
- +
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.
+
skip
- +
Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.
+Returns DeleteRequestBuilderV4<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: DestinationRetrievalOptions
Options to employ when fetching destinations.
+
Returns Promise<string>
Promise resolving to the URL for the request
+
with
Parameters
headers: Record<string, string>
Key-value pairs denoting additional custom headers.
+
Returns DeleteRequestBuilderV4<EntityT>
The request builder itself, to facilitate method chaining.
+
with
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.
+
with
Parameters
servicePath: string
Path to override the default with.
+
Returns DeleteRequestBuilderV4<EntityT>
The request builder itself, to facilitate method chaining.
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class DurationField<EntityT>
Type parameters
EntityT: EntityBase
+Type of the entity the field belongs to
+
Hierarchy
- DurtionFieldBase<EntityT, true>
- DurationField
Index
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.
+_fieldOf: ConstructorOrField<EntityT, any>
Constructor type of the entity the field belongs to.
+edmType: EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4
Type of the field according to the metadata description.
+Optional fieldOptions: FieldOptions<false, true>
Optional settings for this field.
+
Returns DurationField<EntityT>
Properties
Readonly _entity
Readonly _entity
Readonly _field
Readonly _field
Readonly _field
Readonly edm
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
+
field
- +
Path to the field to be used in filter and order by queries.
+Returns string
Path to the field to be used in filter and order by queries.
+
greater
- +
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
+
greater
- +
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
+
less
- +
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
+
less
- +
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
+
not
- +
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
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class DurtionFieldBase<EntityT, SelectableT>
Type parameters
EntityT: EntityBase
+Type of the entity the field belongs to
+SelectableT: boolean = false
Hierarchy
- EdmTypeField<EntityT, moment.Duration, false, SelectableT>
- DurtionFieldBase
Index
Constructors
constructor
- +
Creates an instance of EdmTypeField.
+Type parameters
EntityT: EntityBase<EntityT>
SelectableT: boolean = false
Parameters
fieldName: string
Actual name of the field used in the OData request.
+_fieldOf: ConstructorOrField<EntityT, any>
Constructor type of the entity the field belongs to.
+edmType: EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4
Type of the field according to the metadata description.
+Optional fieldOptions: FieldOptions<false, SelectableT>
Optional settings for this field.
+
Returns DurtionFieldBase<EntityT, SelectableT>
Properties
Readonly _entity
Readonly _entity
Readonly _field
Readonly _field
Readonly _field
Readonly edm
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
+
field
- +
Path to the field to be used in filter and order by queries.
+Returns string
Path to the field to be used in filter and order by queries.
+
greater
- +
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
+
greater
- +
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
+
less
- +
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
+
less
- +
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
+
not
- +
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
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class EdmTypeField<EntityT, EdmOrFieldT, NullableT, SelectableT>
+
Represents a property of an OData entity with an EDM type.
+EdmTypeFields are used as static properties of entities or EDM typed fields of complex type fields. They are generated from the OData metadata, i.e. for each property of
+an OData entity, that has an EDM type, there is one static instance of EdmTypeField (or rather one of its subclasses) in the corresponding generated class file.
+EdmTypeFields are used to represent the domain of more or less primitive values that can be used in select, filter and order by functions.
+For example, when constructing a query on the BusinessPartner entity, an instance of EdmTypeField<BusinessPartner, string>
+can be supplied as argument to the select function, e.g. BusinessPartner.FIRST_NAME.
See also: Selectable
+Type parameters
EntityT: EntityBase
+Type of the entity the field belongs to
+EdmOrFieldT: EdmTypeShared<"any"> | FieldType
+EDM type of the field. Deprecated: Field type of the field.
+NullableT: boolean = false
+Boolean type that represents whether the field is nullable.
+SelectableT: boolean = false
+Boolean type that represents whether the field is selectable.
+
Hierarchy
- Field<EntityT, NullableT, SelectableT>
Index
Constructors
Properties
Methods
Constructors
constructor
- +
Creates an instance of EdmTypeField.
+Type parameters
EntityT: EntityBase<EntityT>
EdmOrFieldT: undefined | null | string | number | boolean | Moment | Time | Duration | BigNumber
NullableT: boolean = false
SelectableT: boolean = false
Parameters
fieldName: string
+Actual name of the field used in the OData request.
+_fieldOf: ConstructorOrField<EntityT, any>
+Constructor type of the entity the field belongs to.
+edmType: EdmTypeForEdmOrFieldType<EdmOrFieldT>
+Type of the field according to the metadata description.
+Optional fieldOptions: FieldOptions<NullableT, SelectableT>
+Optional settings for this field.
+
Returns EdmTypeField<EntityT, EdmOrFieldT, NullableT, SelectableT>
Properties
Readonly _entity
Readonly _entity
Readonly _field
Readonly _field
Readonly _field
Readonly edm
Methods
equals
- +
Creates an instance of Filter for this field and the given value using the operator 'eq', i.e.
+==.Parameters
value: NullableFieldType<EdmOrFieldT extends EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4 ? NonNullableFieldTypeByEdmType<EdmOrFieldT> : EdmOrFieldT, NullableT>
Value to be used in the filter
+
Returns Filter<EntityT, NullableFieldType<EdmOrFieldT extends EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4 ? NonNullableFieldTypeByEdmType<EdmOrFieldT> : EdmOrFieldT, NullableT>>
The resulting filter
+
field
- +
Path to the field to be used in filter and order by queries.
+Returns string
Path to the field to be used in filter and order by queries.
+
not
- +
Creates an instance of Filter for this field and the given value using the operator 'ne', i.e.
+!=.Parameters
value: NullableFieldType<EdmOrFieldT extends EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4 ? NonNullableFieldTypeByEdmType<EdmOrFieldT> : EdmOrFieldT, NullableT>
Value to be used in the filter
+
Returns Filter<EntityT, NullableFieldType<EdmOrFieldT extends EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4 ? NonNullableFieldTypeByEdmType<EdmOrFieldT> : EdmOrFieldT, NullableT>>
The resulting filter
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class Entity
+
Super class for all representations of OData v2 entity types.
+Hierarchy
- EntityBase
- Entity
Index
Constructors
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
Or Initialize Remote State - set
Version Identifier - custom
Field Selector - entity
Builder
Constructors
constructor
Returns Entity
Properties
Protected _custom
+
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 _o
Protected _version
+
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 remote
+
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 _default
Static _entity
Static _service
Accessors
version
- +
ETag version identifier accessor.
+Returns string
The ETag version identifier of the retrieved entity, returns
+undefinedif not retrieved.
Methods
Protected as
- +
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 get
Parameters
Optional visitedEntities: EntityBase[]
List of entities to check in case of circular dependencies.
+
Returns any
Entity with all defined entity fields
+
Protected get
Parameters
key: string
Optional visitedEntities: EntityBase[]
Returns any
get
- +
Custom field value getter.
+Parameters
fieldName: string
The name of the custom field
+
Returns any
The value of the corresponding custom field
+
get
- +
Returns a map that contains all entity custom fields.
+Returns Record<string, any>
A map of all defined custom fields in the entity
+
get
- +
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.
+
get
- +
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
+
get
- +
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
+
has
- +
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
+
initialize
Parameters
customFields: Record<string, any>
Extracted custom fields from a retrieved entity.
+
Returns Entity
The entity itself, to facilitate method chaining.
+
Protected is
- +
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 is
Type parameters
EntityT: EntityBase<EntityT>
Parameters
entity: EntityT
Optional visitedEntities: EntityBase[]
Returns boolean
set
- +
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
+
set
- +
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
+
set
Parameters
Optional state: Record<string, any>
State to be set as remote state.
+
Returns Entity
The entity itself, to facilitate method chaining
+
set
- +
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.
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Static Protected custom
Type parameters
EntityT: Entity<EntityT>
NullableT: boolean = false
Parameters
fieldName: string
entityConstructor: Constructable<EntityT, unknown>
Optional isNullable: NullableT
Returns CustomField<EntityT, NullableT>
Static Protected entity
Type parameters
EntityT: EntityBase<EntityT>
EntityTypeT
Parameters
entityConstructor: Constructable<EntityT, EntityTypeT>
Returns EntityBuilderType<EntityT, EntityTypeT>
Class EntityBase
+
Super class for all representations of OData entity types.
+Hierarchy
Index
Constructors
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
Or Initialize Remote State - set
Version Identifier - entity
Builder
Constructors
constructor
Returns EntityBase
Properties
Protected _custom
+
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 _o
Protected _version
+
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 remote
+
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 _default
Static _entity
Static _service
Accessors
version
- +
ETag version identifier accessor.
+Returns string
The ETag version identifier of the retrieved entity, returns
+undefinedif not retrieved.
Methods
Protected as
- +
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 get
Parameters
Optional visitedEntities: EntityBase[]
List of entities to check in case of circular dependencies.
+
Returns any
Entity with all defined entity fields
+
Protected get
Parameters
key: string
Optional visitedEntities: EntityBase[]
Returns any
get
- +
Custom field value getter.
+Parameters
fieldName: string
The name of the custom field
+
Returns any
The value of the corresponding custom field
+
get
- +
Returns a map that contains all entity custom fields.
+Returns Record<string, any>
A map of all defined custom fields in the entity
+
get
- +
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.
+
get
- +
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
+
get
- +
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
+
has
- +
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
+
initialize
Parameters
customFields: Record<string, any>
Extracted custom fields from a retrieved entity.
+
Returns EntityBase
The entity itself, to facilitate method chaining.
+
Protected is
- +
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 is
Type parameters
EntityT: EntityBase<EntityT>
Parameters
entity: EntityT
Optional visitedEntities: EntityBase[]
Returns boolean
set
- +
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
+
set
- +
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
+
set
Parameters
Optional state: Record<string, any>
State to be set as remote state.
+
Returns EntityBase
The entity itself, to facilitate method chaining
+
set
- +
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.
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Static Protected entity
Type parameters
EntityT: EntityBase<EntityT>
EntityTypeT
Parameters
entityConstructor: Constructable<EntityT, EntityTypeT>
Returns EntityBuilderType<EntityT, EntityTypeT>
Class EntityV4
+
Super class for all representations of OData v4 entity types.
+Hierarchy
- EntityBase
- EntityV4
Index
Constructors
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
Or Initialize Remote State - set
Version Identifier - custom
Field Selector - entity
Builder
Constructors
constructor
Returns EntityV4
Properties
Protected _custom
+
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 _o
Protected _version
+
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 remote
+
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 _default
Static _entity
Static _service
Accessors
version
- +
ETag version identifier accessor.
+Returns string
The ETag version identifier of the retrieved entity, returns
+undefinedif not retrieved.
Methods
Protected as
- +
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 get
Parameters
Optional visitedEntities: EntityBase[]
List of entities to check in case of circular dependencies.
+
Returns any
Entity with all defined entity fields
+
Protected get
Parameters
key: string
Optional visitedEntities: EntityBase[]
Returns any
get
- +
Custom field value getter.
+Parameters
fieldName: string
The name of the custom field
+
Returns any
The value of the corresponding custom field
+
get
- +
Returns a map that contains all entity custom fields.
+Returns Record<string, any>
A map of all defined custom fields in the entity
+
get
- +
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.
+
get
- +
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
+
get
- +
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
+
has
- +
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
+
initialize
Parameters
customFields: Record<string, any>
Extracted custom fields from a retrieved entity.
+
Returns EntityV4
The entity itself, to facilitate method chaining.
+
Protected is
- +
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 is
Type parameters
EntityT: EntityBase<EntityT>
Parameters
entity: EntityT
Optional visitedEntities: EntityBase[]
Returns boolean
set
- +
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
+
set
- +
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
+
set
Parameters
Optional state: Record<string, any>
State to be set as remote state.
+
Returns EntityV4
The entity itself, to facilitate method chaining
+
set
- +
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.
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Static Protected custom
Type parameters
EntityT: EntityV4<EntityT>
NullableT: boolean = false
Parameters
fieldName: string
entityConstructor: Constructable<EntityT, unknown>
Optional isNullable: NullableT
Returns CustomFieldV4<EntityT, NullableT>
Static Protected entity
Type parameters
EntityT: EntityBase<EntityT>
EntityTypeT
Parameters
entityConstructor: Constructable<EntityT, EntityTypeT>
Returns EntityBuilderType<EntityT, EntityTypeT>
Class EnumField<EntityT, EnumT, NullableT, SelectableT>
+
Represents a property with an enum value.
+Type parameters
EntityT: EntityBase
+Type of the entity the field belongs to.
+EnumT: string = string
+Enum type that contains all valid enum entries for this field.
+NullableT: boolean = false
+Boolean type that represents whether the field is nullable.
+SelectableT: boolean = false
+Boolean type that represents whether the field is selectable.
+
Hierarchy
- Field<EntityT, NullableT, SelectableT>
- EnumField
Index
Constructors
Properties
Methods
Constructors
constructor
- +
Creates an instance of EnumField.
+Type parameters
EntityT: EntityBase<EntityT>
EnumT: string = string
NullableT: boolean = false
SelectableT: boolean = false
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.
+Optional enumType: Record<string, EnumT>
+Enum type of the field according to the metadata description.
+Optional fieldOptions: FieldOptions<NullableT, SelectableT>
+Optional settings for this field.
+
Returns EnumField<EntityT, EnumT, NullableT, SelectableT>
Properties
Readonly _entity
Readonly _entity
Readonly _field
Readonly _field
Readonly _field
Readonly edm
Optional Readonly enum
Methods
equals
- +
Creates an instance of Filter for this field and the given value using the operator 'eq', i.e.
+==.Parameters
value: `${EnumT}`
Value to be used in the filter
+
Returns Filter<EntityT, string>
The resulting filter
+
field
- +
Gets the path to the complex type property represented by this.
+Returns string
The path to the complex type property.
+
not
- +
Creates an instance of Filter for this field and the given value using the operator 'ne', i.e.
+!=.Parameters
value: `${EnumT}`
Value to be used in the filter
+
Returns Filter<EntityT, string>
The resulting filter
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class Field<EntityT, NullableT, SelectableT>
+
Abstract representation a property of an OData entity.
+Fields are used as static properties of entities or properties of ComplexTypeFields and are generated from the metadata, i.e. for each property of
+an OData entity, there exists one static instance of Field (or rather one of its subclasses) in the corresponding generated class file.
+Fields are used to represent the domain of values that can be used in select, filter and order by functions.
See also: Selectable, EdmTypeField, ComplexTypeField
+Type parameters
EntityT: EntityBase
+Type of the entity the field belongs to.
+NullableT: boolean = false
+Boolean type that represents whether the field is nullable.
+SelectableT: boolean = false
+Boolean type that represents whether the field is selectable.
+
Hierarchy
Implements
- EntityIdentifiable<EntityT>
Index
Constructors
constructor
- +
Creates an instance of Field.
+Type parameters
EntityT: EntityBase<EntityT>
NullableT: boolean = false
SelectableT: boolean = false
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
+Optional fieldOptions: FieldOptions<NullableT, SelectableT>
+Optional settings for this field.
+
Returns Field<EntityT, NullableT, SelectableT>
Properties
Readonly _entity
Readonly _entity
Readonly _field
Readonly _field
Methods
field
- +
Path to the field to be used in filter and order by queries.
+Returns string
Path to the field to be used in filter and order by queries.
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class FieldBuilder<FieldOfT>
+
Field builder to orchestrate the creation of the different kinds of fields.
+Type parameters
FieldOfT: ConstructorOrField<any>
+Type of the entity or complex type field this field belongs to.
+
Hierarchy
- FieldBuilder
Index
Constructors
Properties
Methods
Constructors
constructor
- +
Creates an instance of
+FieldBuilder.Type parameters
FieldOfT: ConstructorOrField<any, any>
Parameters
fieldOf: FieldOfT
+Entity or complex type field, for which the field builder shall create fields.
+
Returns FieldBuilder<FieldOfT>
Properties
field
Methods
build
- +
Build a field for a property with a collection type. +The type of the field can either be an EDM type or a complex type. +Fields of entities are selectable; fields of complex types are not selectable.
+Type parameters
CollectionFieldT: Record<string, any> | EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4
NullableT: boolean
Parameters
fieldName: string
Name of the field.
+collectionFieldType: CollectionFieldType<CollectionFieldT>
Type of the collection. Can either be an EDM type or complex type (not complex type field).
+isNullable: NullableT
Whether the field is nullable.
+
Returns CollectionField<EntityTypeFromFieldOf<FieldOfT>, CollectionFieldT, NullableT, IsSelectableField<FieldOfT>>
A collection field with the given collection type.
+
build
- +
Build a field for a property with a complex type. +Fields of entities are selectable; fields of complex types are not selectable.
+Type parameters
ComplexTypeFieldT: ComplexTypeField<EntityTypeFromFieldOf<FieldOfT>, any, NullableT, IsSelectableField<FieldOfT>, ComplexTypeFieldT>
ComplexT
NullableT: boolean
Parameters
fieldName: string
Name of the field.
+complexTypeFieldCtor: ComplexTypeFieldConstructor<ComplexTypeFieldT, EntityTypeFromFieldOf<FieldOfT>, ComplexT, NullableT, IsSelectableField<FieldOfT>>
Constructor of the complex type field.
+isNullable: NullableT
Whether the field is nullable.
+
Returns ComplexTypeFieldT
A complex type field of the given type.
+
build
Type parameters
EdmT: OrderableEdmType
NullableT: boolean
Parameters
fieldName: string
edmType: EdmT
isNullable: NullableT
Returns OrderableEdmTypeField<EntityTypeFromFieldOf<FieldOfT>, EdmT, NullableT, IsSelectableField<FieldOfT>>
Type parameters
EdmT: "Edm.String" | "Edm.Boolean" | "Edm.Guid" | "Edm.Binary" | "Edm.Any" | "Edm.Enum"
NullableT: boolean
Parameters
fieldName: string
edmType: EdmT
isNullable: NullableT
Returns EdmTypeField<EntityTypeFromFieldOf<FieldOfT>, EdmT, NullableT, IsSelectableField<FieldOfT>>
build
- +
Build a field for a property with a enum type.
+Type parameters
EnumT: string
NullableT: boolean
Parameters
fieldName: string
Name of the field.
+enumType: Record<string, EnumT>
Enum type of this field.
+isNullable: NullableT
Whether the field is nullable.
+
Returns EnumField<EntityTypeFromFieldOf<FieldOfT>, EnumT, NullableT, IsSelectableField<FieldOfT>>
A collection field with the given collection type.
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class Filter<EntityT, FieldT>
+
Represents a filter expression to narrow the data on a GetAllRequestBuilder request for multiple entities that match the specified criteria.
+A filter refers to the field of an entity and restricts the request based on an operator and a value. Entity.FIELD_NAME.operator(value)
Example: Product.NAME.equals('cloud-sdk') creates a filter for the entity Product that matches in case the field NAME equals 'cloud-sdk'.
See also: 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
Properties
Constructors
constructor
- +
Creates an instance of Filter.
+Type parameters
EntityT: EntityBase<EntityT>
FieldT: FieldType | FieldType[]
Parameters
field: string | FilterFunction<EntityT, FieldT>
+Name of the field of the entity to be filtered on or a filter function
+operator: FilterOperator
+Function to be used for matching
+value: FieldT
+Value to be used by the operator
+Optional edmType: EdmTypeShared<ODataVersionOf<EntityT>>
+EDM type 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 _entity
+
Constructor type of the entity to be filtered.
+_field
Optional edm
field
operator
value
Class FilterFunction<EntityT, ReturnT>
+
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
Index
Constructors
constructor
- +
Creates an instance of FilterFunction.
+Type parameters
EntityT: EntityBase<EntityT>
ReturnT: FieldType | FieldType[]
Parameters
functionName: string
+Name of the function.
+parameters: FilterFunctionParameterType<EntityT>[]
+Representation of the parameters passed to the filter function.
+edmType: EdmTypeShared<ODataVersionOf<EntityT>>
+EDM type of the return type of the filter function.
+
Returns FilterFunction<EntityT, ReturnT>
Properties
Readonly edm
Readonly function
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
+
not
- +
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
+
to
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
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class FilterLambdaExpression<EntityT>
+
+
hidden
+Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Type parameters
EntityT: EntityBase
Hierarchy
- FilterLambdaExpression
Index
Constructors
Properties
Constructors
constructor
Type parameters
EntityT: EntityBase<EntityT>
Parameters
filters: FilterList<EntityT>
lambdaOperator: FilterLambdaOperator
Returns FilterLambdaExpression<EntityT>
Properties
filters
lambda
Class FilterLink<EntityT, LinkedEntityT>
+
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
Properties
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, any>[]
+List of filterables for the linked entity.
+
Returns FilterLink<EntityT, LinkedEntityT>
Properties
Readonly _entity
+
Entity type of the entity tp be filtered.
+Readonly _entity
+
Constructor type of the entity to be filtered.
+Readonly _linked
+
+
Linked entity to be filtered by.
+Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
filters
link
Class FilterList<EntityT>
+
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
- +
Creates an instance of FilterList.
+Type parameters
EntityT: EntityBase<EntityT>
Parameters
Optional andFilters: Filterable<EntityT, any>[]
+Filters to be combined by logical conjunction (
+and)Optional orFilters: Filterable<EntityT, any>[]
+Filters to be combined by logical disjunction (
+or)
Returns FilterList<EntityT>
Properties
Readonly _entity
+
Entity type of the entity tp be filtered.
+Readonly _entity
+
Constructor type of the entity to be filtered.
+and
or
Methods
flatten
Returns FilterList<EntityT>
Flattened filter list.
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class FunctionImportParameter<ValueT>
+
Internal representation of function import parameters. It adds metadata to the value.
+Type parameters
ValueT
+Type of the value
+
Hierarchy
- FunctionImportParameter
Index
Constructors
Properties
Constructors
constructor
- +
Creates an instance of FunctionImportParameter.
+Type parameters
ValueT
Parameters
originalName: string
+The original name of the parameter in the OData service.
+edmType: EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4
+Original EDM type.
+value: ValueT
+Value to be used as parameter.
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Returns FunctionImportParameter<ValueT>
Properties
edm
original
value
Class FunctionImportRequestBuilder<ParametersT, ReturnT>
+
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
request
Readonly response
Type declaration
Parameters
data: any
Returns ReturnT
Methods
add
- +
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.
+
add
- +
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
+
add
- +
Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. +If the custom request configuration contains disallowed keys, those will be ignored.
+Parameters
requestConfiguration: Record<string, string>
Key-value pairs denoting additional custom request configuration options to be set in the request.
+
Returns FunctionImportRequestBuilder<ParametersT, ReturnT>
The request builder itself, to facilitate method chaining.
+
append
- +
Append the given path to the URL. +This can be used for querying navigation properties of an entity. +To execute a request with an appended path use
+executeRawto avoid errors during deserialization. When using this, theexecutemethod is omitted from the return type.Parameters
Rest ...path: string[]
Path to be appended.
+
Returns Omit<FunctionImportRequestBuilder<ParametersT, ReturnT>, "execute">
The request builder itself without "execute" function, to facilitate method chaining.
+
build
Returns ODataRequest<ODataFunctionImportRequestConfig<ParametersT> | ODataActionImportRequestConfig<ParametersT>>
Parameters
destination: Destination | DestinationNameAndJwt
Optional options: DestinationOptions
Returns Promise<ODataRequest<ODataFunctionImportRequestConfig<ParametersT> | ODataActionImportRequestConfig<ParametersT>>>
execute
- +
Execute request
+Parameters
destination: Destination | DestinationNameAndJwt
Destination to execute the request against
+Optional options: DestinationOptions
Options to employ when fetching destinations
+
Returns Promise<ReturnT>
A promise resolving to the requested return type
+
execute
- +
Execute request and return an HttpResponse.
+Parameters
destination: Destination | DestinationNameAndJwt
Destination to execute the request against
+Optional options: DestinationOptions
Options to employ when fetching destinations
+
Returns Promise<HttpResponse>
A promise resolving to an HttpResponse.
+
relative
- +
Create the relative URL based on configuration of the given builder.
+Returns string
The relative URL for the request
+
set
- +
Replace the default service path with the given custom path. +In case of the SAP S/4HANA APIs the servicePath defaults to
+/sap/opu/odata/sap/<SERVICE_NAME>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
+
skip
- +
Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.
+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: DestinationRetrievalOptions
Options to employ when fetching destinations.
+
Returns Promise<string>
Promise resolving to the URL for the request
+
with
Parameters
headers: Record<string, string>
Key-value pairs denoting additional custom headers.
+
Returns FunctionImportRequestBuilder<ParametersT, ReturnT>
The request builder itself, to facilitate method chaining.
+
with
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.
+
with
Parameters
servicePath: string
Path to override the default with.
+
Returns FunctionImportRequestBuilder<ParametersT, ReturnT>
The request builder itself, to facilitate method chaining.
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class FunctionImportRequestBuilderV4<ParametersT, ReturnT>
+
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
request
Readonly response
Type declaration
Parameters
data: any
Returns ReturnT
Methods
add
- +
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.
+
add
- +
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
+
add
- +
Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. +If the custom request configuration contains disallowed keys, those will be ignored.
+Parameters
requestConfiguration: Record<string, string>
Key-value pairs denoting additional custom request configuration options to be set in the request.
+
Returns FunctionImportRequestBuilderV4<ParametersT, ReturnT>
The request builder itself, to facilitate method chaining.
+
append
- +
Append the given path to the URL. +This can be used for querying navigation properties of an entity. +To execute a request with an appended path use
+executeRawto avoid errors during deserialization. When using this, theexecutemethod is omitted from the return type.Parameters
Rest ...path: string[]
Path to be appended.
+
Returns Omit<FunctionImportRequestBuilderV4<ParametersT, ReturnT>, "execute">
The request builder itself without "execute" function, to facilitate method chaining.
+
build
Returns ODataRequest<ODataFunctionImportRequestConfig<ParametersT> | ODataActionImportRequestConfig<ParametersT>>
Parameters
destination: Destination | DestinationNameAndJwt
Optional options: DestinationOptions
Returns Promise<ODataRequest<ODataFunctionImportRequestConfig<ParametersT> | ODataActionImportRequestConfig<ParametersT>>>
execute
- +
Execute request
+Parameters
destination: Destination | DestinationNameAndJwt
Destination to execute the request against
+Optional options: DestinationOptions
Options to employ when fetching destinations
+
Returns Promise<ReturnT>
A promise resolving to the requested return type
+
execute
- +
Execute request and return an HttpResponse.
+Parameters
destination: Destination | DestinationNameAndJwt
Destination to execute the request against
+Optional options: DestinationOptions
Options to employ when fetching destinations
+
Returns Promise<HttpResponse>
A promise resolving to an HttpResponse.
+
relative
- +
Create the relative URL based on configuration of the given builder.
+Returns string
The relative URL for the request
+
set
- +
Replace the default service path with the given custom path. +In case of the SAP S/4HANA APIs the servicePath defaults to
+/sap/opu/odata/sap/<SERVICE_NAME>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
+
skip
- +
Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.
+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: DestinationRetrievalOptions
Options to employ when fetching destinations.
+
Returns Promise<string>
Promise resolving to the URL for the request
+
with
Parameters
headers: Record<string, string>
Key-value pairs denoting additional custom headers.
+
Returns FunctionImportRequestBuilderV4<ParametersT, ReturnT>
The request builder itself, to facilitate method chaining.
+
with
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.
+
with
Parameters
servicePath: string
Path to override the default with.
+
Returns FunctionImportRequestBuilderV4<ParametersT, ReturnT>
The request builder itself, to facilitate method chaining.
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class GetAllRequestBuilder<EntityT>
Type parameters
EntityT: Entity
Hierarchy
- GetAllRequestBuilderBase<EntityT>
- GetAllRequestBuilder
Implements
- EntityIdentifiable<EntityT>
Index
Constructors
Properties
Methods
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 _entity
Readonly data
Readonly entity
request
Methods
add
- +
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.
+
add
- +
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
+
add
- +
Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. +If the custom request configuration contains disallowed keys, those will be ignored.
+Parameters
requestConfiguration: Record<string, string>
Key-value pairs denoting additional custom request configuration options to be set in the request.
+
Returns GetAllRequestBuilder<EntityT>
The request builder itself, to facilitate method chaining.
+
append
- +
Append the given path to the URL. +This can be used for querying navigation properties of an entity. +To execute a request with an appended path use
+executeRawto avoid errors during deserialization. When using this, theexecutemethod is omitted from the return type.Parameters
Rest ...path: string[]
Path to be appended.
+
Returns Omit<GetAllRequestBuilder<EntityT>, "execute">
The request builder itself without "execute" function, to facilitate method chaining.
+
build
Returns ODataRequest<ODataGetAllRequestConfig<EntityT>>
Parameters
destination: Destination | DestinationNameAndJwt
Optional options: DestinationOptions
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: DestinationOptions
Options to employ when fetching destinations
+
Returns Promise<EntityT[]>
A promise resolving to the requested entities
+
execute
- +
Execute request and return an HttpResponse.
+Parameters
destination: Destination | DestinationNameAndJwt
Destination to execute the request against
+Optional options: DestinationOptions
Options to employ when fetching destinations
+
Returns Promise<HttpResponse>
A promise resolving to an HttpResponse.
+
filter
- +
Add filter statements to the request.
+Parameters
expressions: Filterable<EntityT, any>[]
Filter expressions to restrict the response
+
Returns GetAllRequestBuilder<EntityT>
The request builder itself, to facilitate method chaining
+ Parameters
Rest ...expressions: Filterable<EntityT, any>[]
Returns GetAllRequestBuilder<EntityT>
order
- +
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>
relative
- +
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>
set
- +
Replace the default service path with the given custom path. +In case of the SAP S/4HANA APIs the servicePath defaults to
+/sap/opu/odata/sap/<SERVICE_NAME>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
+
skip
- +
Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.
+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: DestinationRetrievalOptions
Options to employ when fetching destinations.
+
Returns Promise<string>
Promise resolving to the URL for the request
+
with
Parameters
headers: Record<string, string>
Key-value pairs denoting additional custom headers.
+
Returns GetAllRequestBuilder<EntityT>
The request builder itself, to facilitate method chaining.
+
with
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.
+
with
Parameters
servicePath: string
Path to override the default with.
+
Returns GetAllRequestBuilder<EntityT>
The request builder itself, to facilitate method chaining.
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class GetAllRequestBuilderBase<EntityT>
+
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
Index
Constructors
Properties
Methods
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 _entity
Readonly data
Readonly entity
request
Methods
add
- +
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.
+
add
- +
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
+
add
- +
Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. +If the custom request configuration contains disallowed keys, those will be ignored.
+Parameters
requestConfiguration: Record<string, string>
Key-value pairs denoting additional custom request configuration options to be set in the request.
+
Returns GetAllRequestBuilderBase<EntityT>
The request builder itself, to facilitate method chaining.
+
append
- +
Append the given path to the URL. +This can be used for querying navigation properties of an entity. +To execute a request with an appended path use
+executeRawto avoid errors during deserialization. When using this, theexecutemethod is omitted from the return type.Parameters
Rest ...path: string[]
Path to be appended.
+
Returns Omit<GetAllRequestBuilderBase<EntityT>, "execute">
The request builder itself without "execute" function, to facilitate method chaining.
+
build
Returns ODataRequest<ODataGetAllRequestConfig<EntityT>>
Parameters
destination: Destination | DestinationNameAndJwt
Optional options: DestinationOptions
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: DestinationOptions
Options to employ when fetching destinations
+
Returns Promise<EntityT[]>
A promise resolving to the requested entities
+
execute
- +
Execute request and return an HttpResponse.
+Parameters
destination: Destination | DestinationNameAndJwt
Destination to execute the request against
+Optional options: DestinationOptions
Options to employ when fetching destinations
+
Returns Promise<HttpResponse>
A promise resolving to an HttpResponse.
+
order
- +
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>
relative
- +
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>
set
- +
Replace the default service path with the given custom path. +In case of the SAP S/4HANA APIs the servicePath defaults to
+/sap/opu/odata/sap/<SERVICE_NAME>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
+
skip
- +
Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.
+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: DestinationRetrievalOptions
Options to employ when fetching destinations.
+
Returns Promise<string>
Promise resolving to the URL for the request
+
with
Parameters
headers: Record<string, string>
Key-value pairs denoting additional custom headers.
+
Returns GetAllRequestBuilderBase<EntityT>
The request builder itself, to facilitate method chaining.
+
with
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.
+
with
Parameters
servicePath: string
Path to override the default with.
+
Returns GetAllRequestBuilderBase<EntityT>
The request builder itself, to facilitate method chaining.
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class GetAllRequestBuilderV4<EntityT>
Type parameters
EntityT: EntityV4
Hierarchy
- GetAllRequestBuilderBase<EntityT>
- GetAllRequestBuilderV4
Implements
- EntityIdentifiable<EntityT>
Index
Constructors
Properties
Methods
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 _entity
Readonly data
Readonly entity
request
Methods
add
- +
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.
+
add
- +
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
+
add
- +
Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. +If the custom request configuration contains disallowed keys, those will be ignored.
+Parameters
requestConfiguration: Record<string, string>
Key-value pairs denoting additional custom request configuration options to be set in the request.
+
Returns GetAllRequestBuilderV4<EntityT>
The request builder itself, to facilitate method chaining.
+
append
- +
Append the given path to the URL. +This can be used for querying navigation properties of an entity. +To execute a request with an appended path use
+executeRawto avoid errors during deserialization. When using this, theexecutemethod is omitted from the return type.Parameters
Rest ...path: string[]
Path to be appended.
+
Returns Omit<GetAllRequestBuilderV4<EntityT>, "execute">
The request builder itself without "execute" function, to facilitate method chaining.
+
build
Returns ODataRequest<ODataGetAllRequestConfig<EntityT>>
Parameters
destination: Destination | DestinationNameAndJwt
Optional options: DestinationOptions
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: DestinationOptions
Options to employ when fetching destinations
+
Returns Promise<EntityT[]>
A promise resolving to the requested entities
+
execute
- +
Execute request and return an HttpResponse.
+Parameters
destination: Destination | DestinationNameAndJwt
Destination to execute the request against
+Optional options: DestinationOptions
Options to employ when fetching destinations
+
Returns Promise<HttpResponse>
A promise resolving to an HttpResponse.
+
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: Filterable<EntityT, any>[]
Filter expressions to restrict the response
+
Returns GetAllRequestBuilderV4<EntityT>
The request builder itself, to facilitate method chaining
+
order
- +
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>
relative
- +
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>
set
- +
Replace the default service path with the given custom path. +In case of the SAP S/4HANA APIs the servicePath defaults to
+/sap/opu/odata/sap/<SERVICE_NAME>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
+
skip
- +
Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.
+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: DestinationRetrievalOptions
Options to employ when fetching destinations.
+
Returns Promise<string>
Promise resolving to the URL for the request
+
with
Parameters
headers: Record<string, string>
Key-value pairs denoting additional custom headers.
+
Returns GetAllRequestBuilderV4<EntityT>
The request builder itself, to facilitate method chaining.
+
with
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.
+
with
Parameters
servicePath: string
Path to override the default with.
+
Returns GetAllRequestBuilderV4<EntityT>
The request builder itself, to facilitate method chaining.
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class GetByKeyRequestBuilder<EntityT>
+
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
Properties
Methods
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 _entity
Readonly data
Readonly entity
request
Methods
add
- +
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.
+
add
- +
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
+
add
- +
Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. +If the custom request configuration contains disallowed keys, those will be ignored.
+Parameters
requestConfiguration: Record<string, string>
Key-value pairs denoting additional custom request configuration options to be set in the request.
+
Returns GetByKeyRequestBuilder<EntityT>
The request builder itself, to facilitate method chaining.
+
append
- +
Append the given path to the URL. +This can be used for querying navigation properties of an entity. +To execute a request with an appended path use
+executeRawto avoid errors during deserialization. When using this, theexecutemethod is omitted from the return type.Parameters
Rest ...path: string[]
Path to be appended.
+
Returns Omit<GetByKeyRequestBuilder<EntityT>, "execute">
The request builder itself without "execute" function, to facilitate method chaining.
+
build
Returns ODataRequest<ODataGetByKeyRequestConfig<EntityT>>
Parameters
destination: Destination | DestinationNameAndJwt
Optional options: DestinationOptions
Returns Promise<ODataRequest<ODataGetByKeyRequestConfig<EntityT>>>
execute
- +
Execute request.
+Parameters
destination: Destination | DestinationNameAndJwt
Destination to execute the request against
+Optional options: DestinationOptions
Options to employ when fetching destinations
+
Returns Promise<EntityT>
A promise resolving to the requested entity
+
execute
- +
Execute request and return an HttpResponse.
+Parameters
destination: Destination | DestinationNameAndJwt
Destination to execute the request against
+Optional options: DestinationOptions
Options to employ when fetching destinations
+
Returns Promise<HttpResponse>
A promise resolving to an HttpResponse.
+
relative
- +
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>
set
- +
Replace the default service path with the given custom path. +In case of the SAP S/4HANA APIs the servicePath defaults to
+/sap/opu/odata/sap/<SERVICE_NAME>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
+
skip
- +
Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.
+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: DestinationRetrievalOptions
Options to employ when fetching destinations.
+
Returns Promise<string>
Promise resolving to the URL for the request
+
with
Parameters
headers: Record<string, string>
Key-value pairs denoting additional custom headers.
+
Returns GetByKeyRequestBuilder<EntityT>
The request builder itself, to facilitate method chaining.
+
with
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.
+
with
Parameters
servicePath: string
Path to override the default with.
+
Returns GetByKeyRequestBuilder<EntityT>
The request builder itself, to facilitate method chaining.
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class GetByKeyRequestBuilderBase<EntityT>
+
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
Index
Constructors
Properties
Methods
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 _entity
Readonly data
Readonly entity
request
Methods
add
- +
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.
+
add
- +
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
+
add
- +
Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. +If the custom request configuration contains disallowed keys, those will be ignored.
+Parameters
requestConfiguration: Record<string, string>
Key-value pairs denoting additional custom request configuration options to be set in the request.
+
Returns GetByKeyRequestBuilderBase<EntityT>
The request builder itself, to facilitate method chaining.
+
append
- +
Append the given path to the URL. +This can be used for querying navigation properties of an entity. +To execute a request with an appended path use
+executeRawto avoid errors during deserialization. When using this, theexecutemethod is omitted from the return type.Parameters
Rest ...path: string[]
Path to be appended.
+
Returns Omit<GetByKeyRequestBuilderBase<EntityT>, "execute">
The request builder itself without "execute" function, to facilitate method chaining.
+
build
Returns ODataRequest<ODataGetByKeyRequestConfig<EntityT>>
Parameters
destination: Destination | DestinationNameAndJwt
Optional options: DestinationOptions
Returns Promise<ODataRequest<ODataGetByKeyRequestConfig<EntityT>>>
execute
- +
Execute request.
+Parameters
destination: Destination | DestinationNameAndJwt
Destination to execute the request against
+Optional options: DestinationOptions
Options to employ when fetching destinations
+
Returns Promise<EntityT>
A promise resolving to the requested entity
+
execute
- +
Execute request and return an HttpResponse.
+Parameters
destination: Destination | DestinationNameAndJwt
Destination to execute the request against
+Optional options: DestinationOptions
Options to employ when fetching destinations
+
Returns Promise<HttpResponse>
A promise resolving to an HttpResponse.
+
relative
- +
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>
set
- +
Replace the default service path with the given custom path. +In case of the SAP S/4HANA APIs the servicePath defaults to
+/sap/opu/odata/sap/<SERVICE_NAME>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
+
skip
- +
Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.
+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: DestinationRetrievalOptions
Options to employ when fetching destinations.
+
Returns Promise<string>
Promise resolving to the URL for the request
+
with
Parameters
headers: Record<string, string>
Key-value pairs denoting additional custom headers.
+
Returns GetByKeyRequestBuilderBase<EntityT>
The request builder itself, to facilitate method chaining.
+
with
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.
+
with
Parameters
servicePath: string
Path to override the default with.
+
Returns GetByKeyRequestBuilderBase<EntityT>
The request builder itself, to facilitate method chaining.
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class GetByKeyRequestBuilderV4<EntityT>
+
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
Properties
Methods
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 _entity
Readonly data
Readonly entity
request
Methods
add
- +
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.
+
add
- +
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
+
add
- +
Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. +If the custom request configuration contains disallowed keys, those will be ignored.
+Parameters
requestConfiguration: Record<string, string>
Key-value pairs denoting additional custom request configuration options to be set in the request.
+
Returns GetByKeyRequestBuilderV4<EntityT>
The request builder itself, to facilitate method chaining.
+
append
- +
Append the given path to the URL. +This can be used for querying navigation properties of an entity. +To execute a request with an appended path use
+executeRawto avoid errors during deserialization. When using this, theexecutemethod is omitted from the return type.Parameters
Rest ...path: string[]
Path to be appended.
+
Returns Omit<GetByKeyRequestBuilderV4<EntityT>, "execute">
The request builder itself without "execute" function, to facilitate method chaining.
+
build
Returns ODataRequest<ODataGetByKeyRequestConfig<EntityT>>
Parameters
destination: Destination | DestinationNameAndJwt
Optional options: DestinationOptions
Returns Promise<ODataRequest<ODataGetByKeyRequestConfig<EntityT>>>
execute
- +
Execute request.
+Parameters
destination: Destination | DestinationNameAndJwt
Destination to execute the request against
+Optional options: DestinationOptions
Options to employ when fetching destinations
+
Returns Promise<EntityT>
A promise resolving to the requested entity
+
execute
- +
Execute request and return an HttpResponse.
+Parameters
destination: Destination | DestinationNameAndJwt
Destination to execute the request against
+Optional options: DestinationOptions
Options to employ when fetching destinations
+
Returns Promise<HttpResponse>
A promise resolving to an HttpResponse.
+
expand
Parameters
expands: Expandable<EntityT>[]
Returns GetByKeyRequestBuilderV4<EntityT>
Parameters
Rest ...expands: Expandable<EntityT>[]
Returns GetByKeyRequestBuilderV4<EntityT>
relative
- +
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>
set
- +
Replace the default service path with the given custom path. +In case of the SAP S/4HANA APIs the servicePath defaults to
+/sap/opu/odata/sap/<SERVICE_NAME>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
+
skip
- +
Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.
+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: DestinationRetrievalOptions
Options to employ when fetching destinations.
+
Returns Promise<string>
Promise resolving to the URL for the request
+
with
Parameters
headers: Record<string, string>
Key-value pairs denoting additional custom headers.
+
Returns GetByKeyRequestBuilderV4<EntityT>
The request builder itself, to facilitate method chaining.
+
with
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.
+
with
Parameters
servicePath: string
Path to override the default with.
+
Returns GetByKeyRequestBuilderV4<EntityT>
The request builder itself, to facilitate method chaining.
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class Link<EntityT, LinkedEntityT>
+
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 is a Link, 1:0..1 is a OneToOneLink +OData v4 entity: 1:N is a OneToManyLink, 1:0..1 is a 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
Implements
- EntityIdentifiable<EntityT>
Index
Constructors
Properties
Accessors
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 _entity
_expand
Readonly _field
Readonly _linked
_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
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class MethodRequestBuilder<RequestConfigT>
+
Base class for all request builders.
+Type parameters
RequestConfigT: ODataRequestConfig = any
Hierarchy
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
request
Methods
add
- +
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.
+
add
- +
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
+
add
- +
Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. +If the custom request configuration contains disallowed keys, those will be ignored.
+Parameters
requestConfiguration: Record<string, string>
Key-value pairs denoting additional custom request configuration options to be set in the request.
+
Returns MethodRequestBuilder<RequestConfigT>
The request builder itself, to facilitate method chaining.
+
append
- +
Append the given path to the URL. +This can be used for querying navigation properties of an entity. +To execute a request with an appended path use
+executeRawto avoid errors during deserialization. When using this, theexecutemethod is omitted from the return type.Parameters
Rest ...path: string[]
Path to be appended.
+
Returns Omit<MethodRequestBuilder<RequestConfigT>, "execute">
The request builder itself without "execute" function, to facilitate method chaining.
+
build
Returns ODataRequest<RequestConfigT>
Parameters
destination: Destination | DestinationNameAndJwt
Optional options: DestinationOptions
Returns Promise<ODataRequest<RequestConfigT>>
relative
- +
Create the relative URL based on configuration of the given builder.
+Returns string
The relative URL for the request
+
set
- +
Replace the default service path with the given custom path. +In case of the SAP S/4HANA APIs the servicePath defaults to
+/sap/opu/odata/sap/<SERVICE_NAME>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
+
skip
- +
Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.
+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: DestinationRetrievalOptions
Options to employ when fetching destinations.
+
Returns Promise<string>
Promise resolving to the URL for the request
+
with
Parameters
headers: Record<string, string>
Key-value pairs denoting additional custom headers.
+
Returns MethodRequestBuilder<RequestConfigT>
The request builder itself, to facilitate method chaining.
+
with
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.
+
with
Parameters
servicePath: string
Path to override the default with.
+
Returns MethodRequestBuilder<RequestConfigT>
The request builder itself, to facilitate method chaining.
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class NumberField<EntityT>
Type parameters
EntityT: EntityBase
+Type of the entity the field belongs to
+
Hierarchy
- NumberFieldBase<EntityT, true>
- NumberField
Index
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.
+_fieldOf: ConstructorOrField<EntityT, any>
Constructor type of the entity the field belongs to.
+edmType: EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4
Type of the field according to the metadata description.
+Optional fieldOptions: FieldOptions<false, true>
Optional settings for this field.
+
Returns NumberField<EntityT>
Properties
Readonly _entity
Readonly _entity
Readonly _field
Readonly _field
Readonly _field
Readonly edm
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
+
field
- +
Path to the field to be used in filter and order by queries.
+Returns string
Path to the field to be used in filter and order by queries.
+
greater
- +
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
+
greater
- +
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
+
less
- +
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
+
less
- +
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
+
not
- +
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
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class NumberFieldBase<EntityT, SelectableT>
Type parameters
EntityT: EntityBase
+Type of the entity the field belongs to
+SelectableT: boolean = false
Hierarchy
- EdmTypeField<EntityT, number, false, SelectableT>
- NumberFieldBase
Index
Constructors
constructor
- +
Creates an instance of EdmTypeField.
+Type parameters
EntityT: EntityBase<EntityT>
SelectableT: boolean = false
Parameters
fieldName: string
Actual name of the field used in the OData request.
+_fieldOf: ConstructorOrField<EntityT, any>
Constructor type of the entity the field belongs to.
+edmType: EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4
Type of the field according to the metadata description.
+Optional fieldOptions: FieldOptions<false, SelectableT>
Optional settings for this field.
+
Returns NumberFieldBase<EntityT, SelectableT>
Properties
Readonly _entity
Readonly _entity
Readonly _field
Readonly _field
Readonly _field
Readonly edm
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
+
field
- +
Path to the field to be used in filter and order by queries.
+Returns string
Path to the field to be used in filter and order by queries.
+
greater
- +
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
+
greater
- +
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
+
less
- +
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
+
less
- +
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
+
not
- +
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
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class NumberFilterFunction<EntityT>
+
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
Properties
Methods
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.Int32" | "Edm.Double"
+Type of the returned numeric value. This influences the formatting of the returned value.
+
Returns NumberFilterFunction<EntityT>
Properties
Readonly edm
Readonly function
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
+
greater
- +
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
+
greater
- +
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
+
less
- +
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
+
less
- +
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
+
not
- +
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
+
to
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
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class ODataActionImportRequestConfig<ParametersT>
Type parameters
ParametersT
Hierarchy
- ODataRequestConfig
- ODataActionImportRequestConfig
Index
Constructors
Properties
Accessors
Methods
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 action
custom
Readonly default
Readonly default
method
payload
Accessors
appended
Returns string[]
content
Returns any
custom
Returns Record<string, string>
Parameters
headers: Record<string, string>
Returns void
custom
Returns Record<string, string>
Parameters
queryParameters: Record<string, string>
Returns void
custom
Returns Record<string, string>
Parameters
requestConfiguration: Record<string, string>
Returns void
fetch
Returns boolean
Parameters
fetchCsrfToken: boolean
Returns void
Methods
add
- +
Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.
+Parameters
headers: Record<string, string>
Key-value pairs where the key is the name of a header property and the value is the respective value
+
Returns void
add
- +
Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.
+Parameters
queryParameters: Record<string, string>
Key-value pairs where the key is the name of a query parameter and the value is the respective value
+
Returns void
add
- +
Add custom request configuration to the request.
+Parameters
requestConfiguration: Record<string, string>
Key-value pairs where the key is the name of a request configuration and the value is the respective value
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Returns void
append
Parameters
Rest ...path: string[]
Returns void
Protected prepend
Parameters
params: Record<string, any>
Returns Record<string, any>
query
Returns Record<string, any>
resource
Returns string
Class ODataBatchChangeSet<RequestT>
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
change
Returns string
Class ODataBatchChangeSetV4<RequestT>
Type parameters
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
change
Returns string
Class ODataBatchConfig
Hierarchy
- ODataBatchRequestConfig
- ODataBatchConfig
Index
Constructors
Properties
Accessors
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
custom
Readonly default
Readonly default
method
payload
sub
Static Readonly content_
Accessors
appended
Returns string[]
batch
Returns string
content
Returns any
custom
Returns Record<string, string>
Parameters
headers: Record<string, string>
Returns void
custom
Returns Record<string, string>
Parameters
queryParameters: Record<string, string>
Returns void
custom
Returns Record<string, string>
Parameters
requestConfiguration: Record<string, string>
Returns void
fetch
Returns boolean
Parameters
fetchCsrfToken: boolean
Returns void
Methods
add
- +
Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.
+Parameters
headers: Record<string, string>
Key-value pairs where the key is the name of a header property and the value is the respective value
+
Returns void
add
- +
Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.
+Parameters
queryParameters: Record<string, string>
Key-value pairs where the key is the name of a query parameter and the value is the respective value
+
Returns void
add
- +
Add custom request configuration to the request.
+Parameters
requestConfiguration: Record<string, string>
Key-value pairs where the key is the name of a request configuration and the value is the respective value
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Returns void
append
Parameters
Rest ...path: string[]
Returns void
Protected prepend
Parameters
params: Record<string, any>
Returns Record<string, any>
query
Returns Record<string, any>
resource
Returns string
with
Parameters
subRequestPathType: BatchSubRequestPathType
Returns void
Class ODataBatchRequestBuilder
+
Create a batch request to invoke multiple requests as a batch. The batch request builder accepts retrieve requests, i. e. getAll and getByKey requests and change sets, which in turn can contain create, update or delete requests. +The retrieve and change sets will be executed in order, while the order within a change set can vary.
+Hierarchy
- BatchRequestBuilder
- ODataBatchRequestBuilder
Index
Constructors
Properties
Methods
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 default
Readonly entity
request
Readonly requests
Methods
add
- +
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.
+
add
- +
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
+
add
- +
Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. +If the custom request configuration contains disallowed keys, those will be ignored.
+Parameters
requestConfiguration: Record<string, string>
Key-value pairs denoting additional custom request configuration options to be set in the request.
+
Returns ODataBatchRequestBuilder
The request builder itself, to facilitate method chaining.
+
append
- +
Append the given path to the URL. +This can be used for querying navigation properties of an entity. +To execute a request with an appended path use
+executeRawto avoid errors during deserialization. When using this, theexecutemethod is omitted from the return type.Parameters
Rest ...path: string[]
Path to be appended.
+
Returns Omit<ODataBatchRequestBuilder, "execute">
The request builder itself without "execute" function, to facilitate method chaining.
+
build
Returns ODataRequest<ODataBatchRequestConfig>
Parameters
destination: Destination | DestinationNameAndJwt
Optional options: DestinationRetrievalOptions
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: DestinationOptions
Options to employ when fetching destinations.
+
Returns Promise<BatchResponse[]>
Promise resolving to the requested data.
+
execute
- +
Execute request and return an HttpResponse.
+Parameters
destination: Destination | DestinationNameAndJwt
Destination to execute the request against
+Optional options: DestinationOptions
Options to employ when fetching destinations
+
Returns Promise<HttpResponse>
A promise resolving to an HttpResponse.
+
relative
- +
Create the relative URL based on configuration of the given builder.
+Returns string
The relative URL for the request
+
set
- +
Replace the default service path with the given custom path. +In case of the SAP S/4HANA APIs the servicePath defaults to
+/sap/opu/odata/sap/<SERVICE_NAME>and can be overwritten here.Parameters
servicePath: string
Path to override the default with
+
Returns ODataBatchRequestBuilder
The request builder itself, to facilitate method chaining
+
skip
- +
Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.
+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: DestinationRetrievalOptions
Options to employ when fetching destinations.
+
Returns Promise<string>
Promise resolving to the URL for the request
+
with
Parameters
headers: Record<string, string>
Key-value pairs denoting additional custom headers.
+
Returns ODataBatchRequestBuilder
The request builder itself, to facilitate method chaining.
+
with
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.
+
with
Parameters
servicePath: string
Path to override the default with.
+
Returns ODataBatchRequestBuilder
The request builder itself, to facilitate method chaining.
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
with
Parameters
subRequestPathType: BatchSubRequestPathType
Returns ODataBatchRequestBuilder
Class ODataBatchRequestBuilderV4
+
Create a batch request to invoke multiple requests as a batch. The batch request builder accepts retrieve requests, i. e. getAll and getByKey requests and change sets, which in turn can contain create, update or delete requests. +The retrieve and change sets will be executed in order, while the order within a change set can vary.
+Hierarchy
- BatchRequestBuilder
- ODataBatchRequestBuilderV4
Index
Constructors
Properties
Methods
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 default
Readonly entity
request
Readonly requests
Methods
add
- +
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.
+
add
- +
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
+
add
- +
Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. +If the custom request configuration contains disallowed keys, those will be ignored.
+Parameters
requestConfiguration: Record<string, string>
Key-value pairs denoting additional custom request configuration options to be set in the request.
+
Returns ODataBatchRequestBuilderV4
The request builder itself, to facilitate method chaining.
+
append
- +
Append the given path to the URL. +This can be used for querying navigation properties of an entity. +To execute a request with an appended path use
+executeRawto avoid errors during deserialization. When using this, theexecutemethod is omitted from the return type.Parameters
Rest ...path: string[]
Path to be appended.
+
Returns Omit<ODataBatchRequestBuilderV4, "execute">
The request builder itself without "execute" function, to facilitate method chaining.
+
build
Returns ODataRequest<ODataBatchRequestConfig>
Parameters
destination: Destination | DestinationNameAndJwt
Optional options: DestinationRetrievalOptions
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: DestinationOptions
Options to employ when fetching destinations.
+
Returns Promise<BatchResponse[]>
Promise resolving to the requested data.
+
execute
- +
Execute request and return an HttpResponse.
+Parameters
destination: Destination | DestinationNameAndJwt
Destination to execute the request against
+Optional options: DestinationOptions
Options to employ when fetching destinations
+
Returns Promise<HttpResponse>
A promise resolving to an HttpResponse.
+
relative
- +
Create the relative URL based on configuration of the given builder.
+Returns string
The relative URL for the request
+
set
- +
Replace the default service path with the given custom path. +In case of the SAP S/4HANA APIs the servicePath defaults to
+/sap/opu/odata/sap/<SERVICE_NAME>and can be overwritten here.Parameters
servicePath: string
Path to override the default with
+
Returns ODataBatchRequestBuilderV4
The request builder itself, to facilitate method chaining
+
skip
- +
Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.
+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: DestinationRetrievalOptions
Options to employ when fetching destinations.
+
Returns Promise<string>
Promise resolving to the URL for the request
+
with
Parameters
headers: Record<string, string>
Key-value pairs denoting additional custom headers.
+
Returns ODataBatchRequestBuilderV4
The request builder itself, to facilitate method chaining.
+
with
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.
+
with
Parameters
servicePath: string
Path to override the default with.
+
Returns ODataBatchRequestBuilderV4
The request builder itself, to facilitate method chaining.
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
with
Parameters
subRequestPathType: BatchSubRequestPathType
Returns ODataBatchRequestBuilderV4
Class ODataBatchRequestConfig
Hierarchy
- ODataRequestConfig
- ODataBatchRequestConfig
Index
Constructors
Properties
Accessors
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
custom
Readonly default
Readonly default
method
payload
sub
Static Readonly content_
Accessors
appended
Returns string[]
batch
Returns string
content
Returns any
custom
Returns Record<string, string>
Parameters
headers: Record<string, string>
Returns void
custom
Returns Record<string, string>
Parameters
queryParameters: Record<string, string>
Returns void
custom
Returns Record<string, string>
Parameters
requestConfiguration: Record<string, string>
Returns void
fetch
Returns boolean
Parameters
fetchCsrfToken: boolean
Returns void
Methods
add
- +
Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.
+Parameters
headers: Record<string, string>
Key-value pairs where the key is the name of a header property and the value is the respective value
+
Returns void
add
- +
Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.
+Parameters
queryParameters: Record<string, string>
Key-value pairs where the key is the name of a query parameter and the value is the respective value
+
Returns void
add
- +
Add custom request configuration to the request.
+Parameters
requestConfiguration: Record<string, string>
Key-value pairs where the key is the name of a request configuration and the value is the respective value
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Returns void
append
Parameters
Rest ...path: string[]
Returns void
Protected prepend
Parameters
params: Record<string, any>
Returns Record<string, any>
query
Returns Record<string, any>
resource
Returns string
with
Parameters
subRequestPathType: BatchSubRequestPathType
Returns void
Class ODataCreateRequestConfig<EntityT>
+
OData create request configuration for an entity type.
+Type parameters
EntityT: EntityBase
+Type of the entity to setup a request for
+
Hierarchy
- ODataRequestConfig
- ODataCreateRequestConfig
Index
Constructors
Properties
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 _entity
child
+
Field that links the parent entity class to the child entity class.
+custom
Readonly default
Readonly default
method
parent
+
Keys of the parent of the entity to create. Defined only when attempting to create child entities.
+payload
Accessors
appended
Returns string[]
content
Returns any
custom
Returns Record<string, string>
Parameters
headers: Record<string, string>
Returns void
custom
Returns Record<string, string>
Parameters
queryParameters: Record<string, string>
Returns void
custom
Returns Record<string, string>
Parameters
requestConfiguration: Record<string, string>
Returns void
fetch
Returns boolean
Parameters
fetchCsrfToken: boolean
Returns void
Methods
add
- +
Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.
+Parameters
headers: Record<string, string>
Key-value pairs where the key is the name of a header property and the value is the respective value
+
Returns void
add
- +
Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.
+Parameters
queryParameters: Record<string, string>
Key-value pairs where the key is the name of a query parameter and the value is the respective value
+
Returns void
add
- +
Add custom request configuration to the request.
+Parameters
requestConfiguration: Record<string, string>
Key-value pairs where the key is the name of a request configuration and the value is the respective value
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Returns void
append
Parameters
Rest ...path: string[]
Returns void
Protected prepend
Parameters
params: Record<string, any>
Returns Record<string, any>
query
Returns Record<string, any>
resource
Returns string
Protected resource
Returns string
Class ODataCreateRequestConfigLegacy<EntityT>
Type parameters
EntityT: EntityBase
+Type of the entity to setup a request for
+
Hierarchy
- ODataCreateRequestConfig<EntityT>
- ODataCreateRequestConfigLegacy
Index
Constructors
Properties
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 _entity
child
+
Field that links the parent entity class to the child entity class.
+custom
Readonly default
Readonly default
method
parent
+
Keys of the parent of the entity to create. Defined only when attempting to create child entities.
+payload
Accessors
appended
Returns string[]
content
Returns any
custom
Returns Record<string, string>
Parameters
headers: Record<string, string>
Returns void
custom
Returns Record<string, string>
Parameters
queryParameters: Record<string, string>
Returns void
custom
Returns Record<string, string>
Parameters
requestConfiguration: Record<string, string>
Returns void
fetch
Returns boolean
Parameters
fetchCsrfToken: boolean
Returns void
Methods
add
- +
Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.
+Parameters
headers: Record<string, string>
Key-value pairs where the key is the name of a header property and the value is the respective value
+
Returns void
add
- +
Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.
+Parameters
queryParameters: Record<string, string>
Key-value pairs where the key is the name of a query parameter and the value is the respective value
+
Returns void
add
- +
Add custom request configuration to the request.
+Parameters
requestConfiguration: Record<string, string>
Key-value pairs where the key is the name of a request configuration and the value is the respective value
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Returns void
append
Parameters
Rest ...path: string[]
Returns void
Protected prepend
Parameters
params: Record<string, any>
Returns Record<string, any>
query
Returns Record<string, any>
resource
Returns string
Protected resource
Returns string
Class ODataDeleteRequestConfig<EntityT>
+
OData delete request configuration for an entity type.
+Type parameters
EntityT: EntityBase
+Type of the entity to setup a request for
+
Hierarchy
- ODataRequestConfig
- ODataDeleteRequestConfig
Implements
- WithKeys
- WithETag
Index
Constructors
Properties
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
custom
Readonly default
Readonly default
e
Readonly entity
keys
method
payload
version
Accessors
appended
Returns string[]
content
Returns any
custom
Returns Record<string, string>
Parameters
headers: Record<string, string>
Returns void
custom
Returns Record<string, string>
Parameters
queryParameters: Record<string, string>
Returns void
custom
Returns Record<string, string>
Parameters
requestConfiguration: Record<string, string>
Returns void
fetch
Returns boolean
Parameters
fetchCsrfToken: boolean
Returns void
Methods
add
- +
Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.
+Parameters
headers: Record<string, string>
Key-value pairs where the key is the name of a header property and the value is the respective value
+
Returns void
add
- +
Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.
+Parameters
queryParameters: Record<string, string>
Key-value pairs where the key is the name of a query parameter and the value is the respective value
+
Returns void
add
- +
Add custom request configuration to the request.
+Parameters
requestConfiguration: Record<string, string>
Key-value pairs where the key is the name of a request configuration and the value is the respective value
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Returns void
append
Parameters
Rest ...path: string[]
Returns void
Protected prepend
Parameters
params: Record<string, any>
Returns Record<string, any>
query
Returns Record<string, any>
resource
Returns string
Class ODataDeleteRequestConfigLegacy<EntityT>
Type parameters
EntityT: EntityBase
+Type of the entity to setup a request for
+
Hierarchy
- ODataDeleteRequestConfig<EntityT>
- ODataDeleteRequestConfigLegacy
Index
Constructors
Properties
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
custom
Readonly default
Readonly default
e
Readonly entity
keys
method
payload
version
Accessors
appended
Returns string[]
content
Returns any
custom
Returns Record<string, string>
Parameters
headers: Record<string, string>
Returns void
custom
Returns Record<string, string>
Parameters
queryParameters: Record<string, string>
Returns void
custom
Returns Record<string, string>
Parameters
requestConfiguration: Record<string, string>
Returns void
fetch
Returns boolean
Parameters
fetchCsrfToken: boolean
Returns void
Methods
add
- +
Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.
+Parameters
headers: Record<string, string>
Key-value pairs where the key is the name of a header property and the value is the respective value
+
Returns void
add
- +
Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.
+Parameters
queryParameters: Record<string, string>
Key-value pairs where the key is the name of a query parameter and the value is the respective value
+
Returns void
add
- +
Add custom request configuration to the request.
+Parameters
requestConfiguration: Record<string, string>
Key-value pairs where the key is the name of a request configuration and the value is the respective value
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Returns void
append
Parameters
Rest ...path: string[]
Returns void
Protected prepend
Parameters
params: Record<string, any>
Returns Record<string, any>
query
Returns Record<string, any>
resource
Returns string
Class ODataFunctionImportRequestConfig<ParametersT>
Type parameters
ParametersT
Hierarchy
- ODataFunctionImportRequestConfigBase<ParametersT>
- ODataFunctionImportRequestConfig
Index
Constructors
Properties
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
custom
Readonly default
Readonly default
Readonly function
method
Protected o
parameters
payload
Accessors
appended
Returns string[]
content
Returns any
custom
Returns Record<string, string>
Parameters
headers: Record<string, string>
Returns void
custom
Returns Record<string, string>
Parameters
queryParameters: Record<string, string>
Returns void
custom
Returns Record<string, string>
Parameters
requestConfiguration: Record<string, string>
Returns void
fetch
Returns boolean
Parameters
fetchCsrfToken: boolean
Returns void
Methods
add
- +
Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.
+Parameters
headers: Record<string, string>
Key-value pairs where the key is the name of a header property and the value is the respective value
+
Returns void
add
- +
Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.
+Parameters
queryParameters: Record<string, string>
Key-value pairs where the key is the name of a query parameter and the value is the respective value
+
Returns void
add
- +
Add custom request configuration to the request.
+Parameters
requestConfiguration: Record<string, string>
Key-value pairs where the key is the name of a request configuration and the value is the respective value
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Returns void
append
Parameters
Rest ...path: string[]
Returns void
Protected prepend
Parameters
params: Record<string, any>
Returns Record<string, any>
query
Returns Record<string, any>
resource
Returns string
Class ODataFunctionImportRequestConfigLegacy<ParametersT>
Type parameters
ParametersT
+Type of the original parameters object
+
Hierarchy
- ODataFunctionImportRequestConfig<ParametersT>
- ODataFunctionImportRequestConfigLegacy
Index
Constructors
Properties
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
custom
Readonly default
Readonly default
Readonly function
method
Protected o
parameters
payload
Accessors
appended
Returns string[]
content
Returns any
custom
Returns Record<string, string>
Parameters
headers: Record<string, string>
Returns void
custom
Returns Record<string, string>
Parameters
queryParameters: Record<string, string>
Returns void
custom
Returns Record<string, string>
Parameters
requestConfiguration: Record<string, string>
Returns void
fetch
Returns boolean
Parameters
fetchCsrfToken: boolean
Returns void
Methods
add
- +
Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.
+Parameters
headers: Record<string, string>
Key-value pairs where the key is the name of a header property and the value is the respective value
+
Returns void
add
- +
Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.
+Parameters
queryParameters: Record<string, string>
Key-value pairs where the key is the name of a query parameter and the value is the respective value
+
Returns void
add
- +
Add custom request configuration to the request.
+Parameters
requestConfiguration: Record<string, string>
Key-value pairs where the key is the name of a request configuration and the value is the respective value
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Returns void
append
Parameters
Rest ...path: string[]
Returns void
Protected prepend
Parameters
params: Record<string, any>
Returns Record<string, any>
query
Returns Record<string, any>
resource
Returns string
Class ODataFunctionImportRequestConfigV4<ParametersT>
Type parameters
ParametersT
Hierarchy
- ODataFunctionImportRequestConfigBase<ParametersT>
- ODataFunctionImportRequestConfigV4
Index
Constructors
Properties
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
custom
Readonly default
Readonly default
Readonly function
method
Protected o
parameters
payload
Accessors
appended
Returns string[]
content
Returns any
custom
Returns Record<string, string>
Parameters
headers: Record<string, string>
Returns void
custom
Returns Record<string, string>
Parameters
queryParameters: Record<string, string>
Returns void
custom
Returns Record<string, string>
Parameters
requestConfiguration: Record<string, string>
Returns void
fetch
Returns boolean
Parameters
fetchCsrfToken: boolean
Returns void
Methods
add
- +
Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.
+Parameters
headers: Record<string, string>
Key-value pairs where the key is the name of a header property and the value is the respective value
+
Returns void
add
- +
Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.
+Parameters
queryParameters: Record<string, string>
Key-value pairs where the key is the name of a query parameter and the value is the respective value
+
Returns void
add
- +
Add custom request configuration to the request.
+Parameters
requestConfiguration: Record<string, string>
Key-value pairs where the key is the name of a request configuration and the value is the respective value
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Returns void
append
Parameters
Rest ...path: string[]
Returns void
Protected prepend
Parameters
params: Record<string, any>
Returns Record<string, any>
query
Returns Record<string, any>
resource
Returns string
Class ODataGetAllRequestConfig<EntityT>
+
OData getAll request configuration for an entity type.
+Type parameters
EntityT: EntityBase
+Type of the entity to setup a request for
+
Hierarchy
- ODataRequestConfig
- ODataGetAllRequestConfig
Implements
- WithGetAllRestrictions<EntityT>
Index
Constructors
Properties
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
custom
Readonly default
Readonly default
Readonly entity
expands
filter
method
order
payload
selects
skip
top
Accessors
appended
Returns string[]
content
Returns any
custom
Returns Record<string, string>
Parameters
headers: Record<string, string>
Returns void
custom
Returns Record<string, string>
Parameters
queryParameters: Record<string, string>
Returns void
custom
Returns Record<string, string>
Parameters
requestConfiguration: Record<string, string>
Returns void
fetch
Returns boolean
Parameters
fetchCsrfToken: boolean
Returns void
Methods
add
- +
Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.
+Parameters
headers: Record<string, string>
Key-value pairs where the key is the name of a header property and the value is the respective value
+
Returns void
add
- +
Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.
+Parameters
queryParameters: Record<string, string>
Key-value pairs where the key is the name of a query parameter and the value is the respective value
+
Returns void
add
- +
Add custom request configuration to the request.
+Parameters
requestConfiguration: Record<string, string>
Key-value pairs where the key is the name of a request configuration and the value is the respective value
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Returns void
append
Parameters
Rest ...path: string[]
Returns void
Protected prepend
Parameters
params: Record<string, any>
Returns Record<string, any>
query
Returns Record<string, any>
resource
Returns string
Class ODataGetAllRequestConfigLegacy<EntityT>
Type parameters
EntityT: EntityBase
+Type of the entity to setup a request for
+
Hierarchy
- ODataGetAllRequestConfig<EntityT>
- ODataGetAllRequestConfigLegacy
Index
Constructors
Properties
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
custom
Readonly default
Readonly default
Readonly entity
expands
filter
method
order
payload
selects
skip
top
Accessors
appended
Returns string[]
content
Returns any
custom
Returns Record<string, string>
Parameters
headers: Record<string, string>
Returns void
custom
Returns Record<string, string>
Parameters
queryParameters: Record<string, string>
Returns void
custom
Returns Record<string, string>
Parameters
requestConfiguration: Record<string, string>
Returns void
fetch
Returns boolean
Parameters
fetchCsrfToken: boolean
Returns void
Methods
add
- +
Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.
+Parameters
headers: Record<string, string>
Key-value pairs where the key is the name of a header property and the value is the respective value
+
Returns void
add
- +
Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.
+Parameters
queryParameters: Record<string, string>
Key-value pairs where the key is the name of a query parameter and the value is the respective value
+
Returns void
add
- +
Add custom request configuration to the request.
+Parameters
requestConfiguration: Record<string, string>
Key-value pairs where the key is the name of a request configuration and the value is the respective value
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Returns void
append
Parameters
Rest ...path: string[]
Returns void
Protected prepend
Parameters
params: Record<string, any>
Returns Record<string, any>
query
Returns Record<string, any>
resource
Returns string
Class ODataGetByKeyRequestConfig<EntityT>
+
OData getByKey request configuration for an entity type.
+Type parameters
EntityT: EntityBase
+Type of the entity to setup a request for
+
Hierarchy
- ODataRequestConfig
- ODataGetByKeyRequestConfig
Implements
- WithKeys
- WithSelection<EntityT>
Index
Constructors
Properties
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
custom
Readonly default
Readonly default
Readonly entity
expands
keys
method
payload
selects
Accessors
appended
Returns string[]
content
Returns any
custom
Returns Record<string, string>
Parameters
headers: Record<string, string>
Returns void
custom
Returns Record<string, string>
Parameters
queryParameters: Record<string, string>
Returns void
custom
Returns Record<string, string>
Parameters
requestConfiguration: Record<string, string>
Returns void
fetch
Returns boolean
Parameters
fetchCsrfToken: boolean
Returns void
Methods
add
- +
Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.
+Parameters
headers: Record<string, string>
Key-value pairs where the key is the name of a header property and the value is the respective value
+
Returns void
add
- +
Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.
+Parameters
queryParameters: Record<string, string>
Key-value pairs where the key is the name of a query parameter and the value is the respective value
+
Returns void
add
- +
Add custom request configuration to the request.
+Parameters
requestConfiguration: Record<string, string>
Key-value pairs where the key is the name of a request configuration and the value is the respective value
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Returns void
append
Parameters
Rest ...path: string[]
Returns void
Protected prepend
Parameters
params: Record<string, any>
Returns Record<string, any>
query
Returns Record<string, any>
resource
Returns string
Class ODataGetByKeyRequestConfigLegacy<EntityT>
Type parameters
EntityT: EntityBase
+Type of the entity to setup a request for
+
Hierarchy
- ODataGetByKeyRequestConfig<EntityT>
- ODataGetByKeyRequestConfigLegacy
Index
Constructors
Properties
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
custom
Readonly default
Readonly default
Readonly entity
expands
keys
method
payload
selects
Accessors
appended
Returns string[]
content
Returns any
custom
Returns Record<string, string>
Parameters
headers: Record<string, string>
Returns void
custom
Returns Record<string, string>
Parameters
queryParameters: Record<string, string>
Returns void
custom
Returns Record<string, string>
Parameters
requestConfiguration: Record<string, string>
Returns void
fetch
Returns boolean
Parameters
fetchCsrfToken: boolean
Returns void
Methods
add
- +
Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.
+Parameters
headers: Record<string, string>
Key-value pairs where the key is the name of a header property and the value is the respective value
+
Returns void
add
- +
Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.
+Parameters
queryParameters: Record<string, string>
Key-value pairs where the key is the name of a query parameter and the value is the respective value
+
Returns void
add
- +
Add custom request configuration to the request.
+Parameters
requestConfiguration: Record<string, string>
Key-value pairs where the key is the name of a request configuration and the value is the respective value
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Returns void
append
Parameters
Rest ...path: string[]
Returns void
Protected prepend
Parameters
params: Record<string, any>
Returns Record<string, any>
query
Returns Record<string, any>
resource
Returns string
Class ODataRequest<RequestConfigT>
+
OData request configuration for an entity type.
+Type parameters
RequestConfigT: ODataRequestConfig
Hierarchy
- ODataRequest
Index
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 void
Methods
custom
- +
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
+
default
- +
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
+
e
- +
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
+
needs
- +
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
+
relative
- +
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.
+
relative
- +
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.
+
relative
- +
Constructs a URL relative to the destination.
+Parameters
Optional includeServicePath: boolean
Whether or not to include the service path in the URL.
+Optional includeQueryParameters: boolean
Whether or not to include the query parameters in the URL.
+
Returns string
The relative URL for the request.
+
resource
- +
Returns the URL to a specific OData .resource, i.e. the entity collection.
+Returns string
The URL of the resource
+
service
- +
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.
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class ODataUpdateRequestConfig<EntityT>
+
OData update request configuration for an entity type.
+Type parameters
EntityT: EntityBase
+Type of the entity to setup a request for
+
Hierarchy
- ODataRequestConfig
- ODataUpdateRequestConfig
Implements
- WithKeys
- WithETag
Index
Constructors
Properties
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 _entity
custom
Readonly default
Readonly default
e
keys
method
payload
version
Accessors
appended
Returns string[]
content
Returns any
custom
Returns Record<string, string>
Parameters
headers: Record<string, string>
Returns void
custom
Returns Record<string, string>
Parameters
queryParameters: Record<string, string>
Returns void
custom
Returns Record<string, string>
Parameters
requestConfiguration: Record<string, string>
Returns void
fetch
Returns boolean
Parameters
fetchCsrfToken: boolean
Returns void
Methods
add
- +
Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.
+Parameters
headers: Record<string, string>
Key-value pairs where the key is the name of a header property and the value is the respective value
+
Returns void
add
- +
Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.
+Parameters
queryParameters: Record<string, string>
Key-value pairs where the key is the name of a query parameter and the value is the respective value
+
Returns void
add
- +
Add custom request configuration to the request.
+Parameters
requestConfiguration: Record<string, string>
Key-value pairs where the key is the name of a request configuration and the value is the respective value
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Returns void
append
Parameters
Rest ...path: string[]
Returns void
Protected prepend
Parameters
params: Record<string, any>
Returns Record<string, any>
query
Returns Record<string, any>
resource
Returns string
update
Returns void
Class ODataUpdateRequestConfigLegacy<EntityT>
Type parameters
EntityT: EntityBase
+Type of the entity to setup a request for
+
Hierarchy
- ODataUpdateRequestConfig<EntityT>
- ODataUpdateRequestConfigLegacy
Index
Constructors
Properties
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 _entity
custom
Readonly default
Readonly default
e
keys
method
payload
version
Accessors
appended
Returns string[]
content
Returns any
custom
Returns Record<string, string>
Parameters
headers: Record<string, string>
Returns void
custom
Returns Record<string, string>
Parameters
queryParameters: Record<string, string>
Returns void
custom
Returns Record<string, string>
Parameters
requestConfiguration: Record<string, string>
Returns void
fetch
Returns boolean
Parameters
fetchCsrfToken: boolean
Returns void
Methods
add
- +
Add custom headers to the request. This is useful in case you want to provide your own authorization headers for example.
+Parameters
headers: Record<string, string>
Key-value pairs where the key is the name of a header property and the value is the respective value
+
Returns void
add
- +
Add custom query parameters to the request. This is useful in case your OData service allows non-standard query parameters.
+Parameters
queryParameters: Record<string, string>
Key-value pairs where the key is the name of a query parameter and the value is the respective value
+
Returns void
add
- +
Add custom request configuration to the request.
+Parameters
requestConfiguration: Record<string, string>
Key-value pairs where the key is the name of a request configuration and the value is the respective value
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Returns void
append
Parameters
Rest ...path: string[]
Returns void
Protected prepend
Parameters
params: Record<string, any>
Returns Record<string, any>
query
Returns Record<string, any>
resource
Returns string
update
Returns void
Class OneToManyLink<EntityT, LinkedEntityT>
Type parameters
EntityT: EntityBase
LinkedEntityT: EntityBase
Hierarchy
- Link<EntityT, LinkedEntityT>
- OneToManyLink
Index
Constructors
Properties
Accessors
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 _entity
_expand
Readonly _field
_filters
Readonly _linked
_order
_selects
+
List of selectables on the linked entity.
+_skip
_top
Accessors
selects
Returns Selectable<LinkedEntityT>[]
Methods
clone
- +
Create a new link based on a given link.
+Returns OneToManyLink<EntityT, LinkedEntityT>
Newly created link
+
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: Filterable<LinkedEntityT, any>[]
Returns OneToManyLink<EntityT, LinkedEntityT>
Newly created
+FilterLink.
order
- +
Add order-by statements to the request.
+-
+
- @param orderBy - OrderBy statements to order the response by. +
Parameters
Rest ...orderBy: Orderable<LinkedEntityT>[]
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
- +
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
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class OneToOneLink<EntityT, LinkedEntityT>
+
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
Properties
Accessors
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 _entity
_expand
Readonly _field
Readonly _linked
_selects
+
List of selectables on the linked entity.
+filters
+
Filterables to apply to the given entity based on the linked entity.
+order
+
List of criteria of the linked entity to order the given entity by with descending priority.
+Accessors
selects
Returns Selectable<LinkedEntityT>[]
Methods
clone
- +
Create a new link based on a given link.
+Returns OneToOneLink<EntityT, LinkedEntityT>
Newly created link
+
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, any>[]
Filters based on the linked entity.
+
Returns FilterLink<EntityT, LinkedEntityT>
Newly created FilterLink.
+
order
- +
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
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class OpenApiRequestBuilder<ResponseT>
+
Request builder for OpenAPI requests.
+Type parameters
ResponseT = any
+Type of the response for the request.
+
Hierarchy
- OpenApiRequestBuilder
Index
Constructors
Properties
Methods
Constructors
constructor
- +
Create an instance of
+OpenApiRequestBuilder.Type parameters
ResponseT = any
Parameters
method: Method
+HTTP method of the request to be built.
+pathPattern: string
+Path for the request containing path parameter references as in the OpenAPI specification.
+Optional parameters: OpenApiRequestParameters
+Query parameters and or body to pass to the request.
+
Returns OpenApiRequestBuilder<ResponseT>
Properties
method
Methods
add
- +
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<ResponseT>
The request builder itself, to facilitate method chaining.
+
add
- +
Add custom request configuration to the request. Typically, this is used when specifying response type for downloading files. +If the custom request configuration contains keys in this list defaultDisallowedKeys, they will be removed.
+Parameters
requestConfiguration: Record<string, string>
Key-value pairs denoting additional custom request configuration options to be set in the request.
+
Returns OpenApiRequestBuilder<ResponseT>
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.
+Optional destinationOptions: DestinationOptions
Options to employ when fetching destinations.
+
Returns Promise<ResponseT>
A promise resolving to the requested return type.
+
execute
- +
Execute request and get a raw HttpResponse, 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.
+Optional destinationOptions: DestinationOptions
Options to employ when fetching destinations.
+
Returns Promise<HttpResponse>
A promise resolving to an HttpResponse.
+
skip
- +
Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.
+Returns OpenApiRequestBuilder<ResponseT>
The request builder itself, to facilitate method chaining.
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class Order<EntityT>
+
OData queries take this to determine the order of results.
+Type parameters
EntityT: EntityBase
+-
+
+
Hierarchy
- Order
Implements
- EntityIdentifiable<EntityT>
Index
Constructors
Properties
Constructors
constructor
- +
Creates an instance of Order.
+Type parameters
EntityT: EntityBase<EntityT>
Parameters
_fieldName: string
+Field to order by
+Optional orderType: OrderType
+Type of ordering, can be 'asc' for ascending or 'desc' for descending
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Returns Order<EntityT>
Properties
Readonly _entity
Readonly _entity
_field
order
Class OrderLink<EntityT, LinkedEntityT>
+
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
Properties
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
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Returns OrderLink<EntityT, LinkedEntityT>
Properties
Readonly entity
link
Readonly linked
order
Class OrderableEdmTypeField<EntityT, EdmT, NullableT, SelectableT>
+
EdmTypeField, that represents a property with an EDM type, that can be compared with greaterThan, greaterOrEqual, lessThan and lessOrEqual.
Type parameters
EntityT: EntityBase
+Type of the entity the field belongs to
+EdmT: EdmTypeShared<"any">
+EDM type of the field.
+NullableT: boolean = false
+Boolean type that represents whether the field is nullable.
+SelectableT: boolean = false
+Boolean type that represents whether the field is selectable.
+
Hierarchy
- EdmTypeField<EntityT, EdmT, NullableT, SelectableT>
- OrderableEdmTypeField
Index
Constructors
constructor
- +
Creates an instance of EdmTypeField.
+Type parameters
EntityT: EntityBase<EntityT>
EdmT: EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4
NullableT: boolean = false
SelectableT: boolean = false
Parameters
fieldName: string
Actual name of the field used in the OData request.
+_fieldOf: ConstructorOrField<EntityT, any>
Constructor type of the entity the field belongs to.
+edmType: EdmTypeForEdmOrFieldType<EdmT>
Type of the field according to the metadata description.
+Optional fieldOptions: FieldOptions<NullableT, SelectableT>
Optional settings for this field.
+
Returns OrderableEdmTypeField<EntityT, EdmT, NullableT, SelectableT>
Properties
Readonly _entity
Readonly _entity
Readonly _field
Readonly _field
Readonly _field
Readonly edm
Methods
equals
- +
Creates an instance of Filter for this field and the given value using the operator 'eq', i.e.
+==.Parameters
value: NullableFieldType<EdmT extends EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4 ? NonNullableFieldTypeByEdmType<EdmT> : EdmT, NullableT>
Value to be used in the filter
+
Returns Filter<EntityT, NullableFieldType<EdmT extends EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4 ? NonNullableFieldTypeByEdmType<EdmT> : EdmT, NullableT>>
The resulting filter
+
field
- +
Path to the field to be used in filter and order by queries.
+Returns string
Path to the field to be used in filter and order by queries.
+
greater
- +
Creates an instance of Filter for this field and the given value using the operator 'ge', i.e.
+>=.Parameters
value: NullableFieldType<EdmT extends EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4 ? NonNullableFieldTypeByEdmType<EdmT> : EdmT, NullableT>
Value to be used in the filter
+
Returns Filter<EntityT, NullableFieldType<EdmT extends EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4 ? NonNullableFieldTypeByEdmType<EdmT> : EdmT, NullableT>>
The resulting filter
+
greater
- +
Creates an instance of Filter for this field and the given value using the operator 'gt', i.e.
+>.Parameters
value: NullableFieldType<EdmT extends EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4 ? NonNullableFieldTypeByEdmType<EdmT> : EdmT, NullableT>
Value to be used in the filter
+
Returns Filter<EntityT, NullableFieldType<EdmT extends EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4 ? NonNullableFieldTypeByEdmType<EdmT> : EdmT, NullableT>>
The resulting filter
+
less
- +
Creates an instance of Filter for this field and the given value using the operator 'le', i.e.
+<=.Parameters
value: NullableFieldType<EdmT extends EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4 ? NonNullableFieldTypeByEdmType<EdmT> : EdmT, NullableT>
Value to be used in the filter
+
Returns Filter<EntityT, NullableFieldType<EdmT extends EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4 ? NonNullableFieldTypeByEdmType<EdmT> : EdmT, NullableT>>
The resulting filter
+
less
- +
Creates an instance of Filter for this field and the given value using the operator 'lt', i.e.
+<.Parameters
value: NullableFieldType<EdmT extends EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4 ? NonNullableFieldTypeByEdmType<EdmT> : EdmT, NullableT>
Value to be used in the filter
+
Returns Filter<EntityT, NullableFieldType<EdmT extends EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4 ? NonNullableFieldTypeByEdmType<EdmT> : EdmT, NullableT>>
The resulting filter
+
not
- +
Creates an instance of Filter for this field and the given value using the operator 'ne', i.e.
+!=.Parameters
value: NullableFieldType<EdmT extends EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4 ? NonNullableFieldTypeByEdmType<EdmT> : EdmT, NullableT>
Value to be used in the filter
+
Returns Filter<EntityT, NullableFieldType<EdmT extends EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4 ? NonNullableFieldTypeByEdmType<EdmT> : EdmT, NullableT>>
The resulting filter
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class OrderableFilterFunction<EntityT, ReturnT>
+
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
Index
Constructors
Properties
Methods
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<ODataVersionOf<EntityT>>
+Type of the returned numeric value. This influences the formatting of the returned value.
+
Returns OrderableFilterFunction<EntityT, ReturnT>
Properties
Readonly edm
Readonly function
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
+
greater
- +
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
+
greater
- +
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
+
less
- +
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
+
less
- +
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
+
not
- +
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
+
to
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
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class StringField<EntityT>
Type parameters
EntityT: EntityBase
+Type of the entity the field belongs to
+
Hierarchy
- StringFieldBase<EntityT, true>
- StringField
Index
Constructors
Properties
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.
+_fieldOf: ConstructorOrField<EntityT, any>
Constructor type of the entity the field belongs to.
+edmType: EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4
Type of the field according to the metadata description.
+Optional fieldOptions: FieldOptions<false, true>
Optional settings for this field.
+
Returns StringField<EntityT>
Properties
Readonly _entity
Readonly _entity
Readonly _field
Readonly _field
Readonly _field
Readonly edm
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
+
field
- +
Path to the field to be used in filter and order by queries.
+Returns string
Path to the field to be used in filter and order by queries.
+
not
- +
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
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class StringFilterFunction<EntityT>
+
Representation of a filter function, that returns a value of type string.
+Type parameters
EntityT: EntityBase
Hierarchy
- FilterFunction<EntityT, string>
- StringFilterFunction
Index
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 edm
Readonly function
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
+
not
- +
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
+
to
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
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class TimeField<EntityT>
Type parameters
EntityT: EntityBase
+Type of the entity the field belongs to
+
Hierarchy
- TimeFieldBase<EntityT, true>
- TimeField
Index
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.
+_fieldOf: ConstructorOrField<EntityT, any>
Constructor type of the entity the field belongs to.
+edmType: EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4
Type of the field according to the metadata description.
+Optional fieldOptions: FieldOptions<false, true>
Optional settings for this field.
+
Returns TimeField<EntityT>
Properties
Readonly _entity
Readonly _entity
Readonly _field
Readonly _field
Readonly _field
Readonly edm
Methods
equals
field
- +
Path to the field to be used in filter and order by queries.
+Returns string
Path to the field to be used in filter and order by queries.
+
greater
greater
less
less
not
Class TimeFieldBase<EntityT, SelectableT>
Type parameters
EntityT: EntityBase
+Type of the entity the field belongs to
+SelectableT: boolean = false
Hierarchy
- EdmTypeField<EntityT, Time, false, SelectableT>
- TimeFieldBase
Index
Constructors
constructor
- +
Creates an instance of EdmTypeField.
+Type parameters
EntityT: EntityBase<EntityT>
SelectableT: boolean = false
Parameters
fieldName: string
Actual name of the field used in the OData request.
+_fieldOf: ConstructorOrField<EntityT, any>
Constructor type of the entity the field belongs to.
+edmType: EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4
Type of the field according to the metadata description.
+Optional fieldOptions: FieldOptions<false, SelectableT>
Optional settings for this field.
+
Returns TimeFieldBase<EntityT, SelectableT>
Properties
Readonly _entity
Readonly _entity
Readonly _field
Readonly _field
Readonly _field
Readonly edm
Methods
equals
field
- +
Path to the field to be used in filter and order by queries.
+Returns string
Path to the field to be used in filter and order by queries.
+
greater
greater
less
less
not
Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class UnaryFilter<EntityT>
Type parameters
EntityT: EntityBase
Hierarchy
- UnaryFilter
Index
Constructors
Properties
Constructors
constructor
Type parameters
EntityT: EntityBase<EntityT>
Parameters
singleOperand: Filterable<EntityT, any>
operator: "not"
Returns UnaryFilter<EntityT>
Properties
operator
single
Class UpdateRequestBuilder<EntityT>
+
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
Properties
Accessors
Methods
- add
Custom Headers - add
Custom Query Parameters - add
Custom Request Configuration - append
Path - build
- execute
- execute
Raw - execute
Request - execute
Request Raw - 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 - skip
Csrf Token Fetching - 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 _entity
Readonly entity
Readonly extractOData
Type declaration
Parameters
json: Record<string, any>
Returns undefined | string
Readonly o
Readonly payload
Type declaration
Parameters
body: Record<string, any>
Returns Record<string, any>
request
Accessors
entity
Returns EntityT
Methods
add
- +
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.
+
add
- +
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
+
add
- +
Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. +If the custom request configuration contains disallowed keys, those will be ignored.
+Parameters
requestConfiguration: Record<string, string>
Key-value pairs denoting additional custom request configuration options to be set in the request.
+
Returns UpdateRequestBuilder<EntityT>
The request builder itself, to facilitate method chaining.
+
append
- +
Append the given path to the URL. +This can be used for querying navigation properties of an entity. +To execute a request with an appended path use
+executeRawto avoid errors during deserialization. When using this, theexecutemethod is omitted from the return type.Parameters
Rest ...path: string[]
Path to be appended.
+
Returns Omit<UpdateRequestBuilder<EntityT>, "execute">
The request builder itself without "execute" function, to facilitate method chaining.
+
build
Returns ODataRequest<ODataUpdateRequestConfig<EntityT>>
Parameters
destination: Destination | DestinationNameAndJwt
Optional options: DestinationOptions
Returns Promise<ODataRequest<ODataUpdateRequestConfig<EntityT>>>
execute
- +
Executes the query.
+Parameters
destination: Destination | DestinationNameAndJwt
Destination to execute the request against
+Optional options: DestinationOptions
Options to employ when fetching destinations
+
Returns Promise<EntityT>
A promise resolving to the entity once it was updated
+
execute
- +
Execute request and return an HttpResponse. The request is only executed if some properties of the entity are modified.
+Parameters
destination: Destination | DestinationNameAndJwt
Destination to execute the request against
+Optional options: DestinationOptions
Options to employ when fetching destinations
+
Returns Promise<undefined | HttpResponse>
A promise resolving to an HttpResponse when the request is executed or
+undefinedotherwise.
Protected execute
- +
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 execute
Parameters
request: ODataRequest<ODataUpdateRequestConfig<EntityT>>
Returns Promise<HttpResponse>
Protected get
Returns Record<string, any>
ignore
- +
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>
The request itself to ease chaining while executing the request.
+
ignored
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 is
Parameters
obj: any
Returns boolean
prepare
Returns UpdateRequestBuilder<EntityT>
the builder itself
+
relative
- +
Create the relative URL based on configuration of the given builder.
+Returns string
The relative URL for the request
+
replace
- +
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.
+
required
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>
set
- +
Replace the default service path with the given custom path. +In case of the SAP S/4HANA APIs the servicePath defaults to
+/sap/opu/odata/sap/<SERVICE_NAME>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
+
set
- +
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>
set
- +
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>
set
- +
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.
+
skip
- +
Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.
+Returns UpdateRequestBuilder<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: DestinationRetrievalOptions
Options to employ when fetching destinations.
+
Returns Promise<string>
Promise resolving to the URL for the request
+
with
Parameters
headers: Record<string, string>
Key-value pairs denoting additional custom headers.
+
Returns UpdateRequestBuilder<EntityT>
The request builder itself, to facilitate method chaining.
+
with
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.
+
with
Parameters
servicePath: string
Path to override the default with.
+
Returns UpdateRequestBuilder<EntityT>
The request builder itself, to facilitate method chaining.
+
with
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.
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class UpdateRequestBuilderBase<EntityT>
+
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
Implements
- EntityIdentifiable<EntityT>
Index
Constructors
Properties
Accessors
Methods
- add
Custom Headers - add
Custom Query Parameters - add
Custom Request Configuration - append
Path - build
- execute
Request - execute
Request Raw - 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 - skip
Csrf Token Fetching - 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 _entity
Readonly entity
Readonly extractOData
Type declaration
Parameters
json: Record<string, any>
Returns undefined | string
Readonly o
Readonly payload
Type declaration
Parameters
body: Record<string, any>
Returns Record<string, any>
request
Accessors
entity
Returns EntityT
Methods
add
- +
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.
+
add
- +
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
+
add
- +
Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. +If the custom request configuration contains disallowed keys, those will be ignored.
+Parameters
requestConfiguration: Record<string, string>
Key-value pairs denoting additional custom request configuration options to be set in the request.
+
Returns UpdateRequestBuilderBase<EntityT>
The request builder itself, to facilitate method chaining.
+
append
- +
Append the given path to the URL. +This can be used for querying navigation properties of an entity. +To execute a request with an appended path use
+executeRawto avoid errors during deserialization. When using this, theexecutemethod is omitted from the return type.Parameters
Rest ...path: string[]
Path to be appended.
+
Returns Omit<UpdateRequestBuilderBase<EntityT>, "execute">
The request builder itself without "execute" function, to facilitate method chaining.
+
build
Returns ODataRequest<ODataUpdateRequestConfig<EntityT>>
Parameters
destination: Destination | DestinationNameAndJwt
Optional options: DestinationOptions
Returns Promise<ODataRequest<ODataUpdateRequestConfig<EntityT>>>
Protected execute
- +
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 execute
Parameters
request: ODataRequest<ODataUpdateRequestConfig<EntityT>>
Returns Promise<HttpResponse>
Protected get
Returns Record<string, any>
ignore
- +
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>
The request itself to ease chaining while executing the request.
+
ignored
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 is
Parameters
obj: any
Returns boolean
prepare
Returns UpdateRequestBuilderBase<EntityT>
the builder itself
+
relative
- +
Create the relative URL based on configuration of the given builder.
+Returns string
The relative URL for the request
+
replace
- +
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.
+
required
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>
set
- +
Replace the default service path with the given custom path. +In case of the SAP S/4HANA APIs the servicePath defaults to
+/sap/opu/odata/sap/<SERVICE_NAME>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
+
set
- +
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>
set
- +
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>
set
- +
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.
+
skip
- +
Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.
+Returns UpdateRequestBuilderBase<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: DestinationRetrievalOptions
Options to employ when fetching destinations.
+
Returns Promise<string>
Promise resolving to the URL for the request
+
with
Parameters
headers: Record<string, string>
Key-value pairs denoting additional custom headers.
+
Returns UpdateRequestBuilderBase<EntityT>
The request builder itself, to facilitate method chaining.
+
with
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.
+
with
Parameters
servicePath: string
Path to override the default with.
+
Returns UpdateRequestBuilderBase<EntityT>
The request builder itself, to facilitate method chaining.
+
with
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.
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class UpdateRequestBuilderV4<EntityT>
Type parameters
EntityT: EntityV4
Hierarchy
- UpdateRequestBuilderBase<EntityT>
- UpdateRequestBuilderV4
Index
Constructors
Properties
Accessors
Methods
- add
Custom Headers - add
Custom Query Parameters - add
Custom Request Configuration - append
Path - build
- execute
- execute
Raw - execute
Request - execute
Request Raw - 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 - skip
Csrf Token Fetching - 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 _entity
Readonly entity
Readonly extractOData
Type declaration
Parameters
json: Record<string, any>
Returns undefined | string
Readonly o
Readonly payload
Type declaration
Parameters
body: Record<string, any>
Returns Record<string, any>
request
Accessors
entity
Returns EntityT
Methods
add
- +
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.
+
add
- +
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
+
add
- +
Add a custom request configuration to the request. Typically, this is used when specifying a response type for downloading files. +If the custom request configuration contains disallowed keys, those will be ignored.
+Parameters
requestConfiguration: Record<string, string>
Key-value pairs denoting additional custom request configuration options to be set in the request.
+
Returns UpdateRequestBuilderV4<EntityT>
The request builder itself, to facilitate method chaining.
+
append
- +
Append the given path to the URL. +This can be used for querying navigation properties of an entity. +To execute a request with an appended path use
+executeRawto avoid errors during deserialization. When using this, theexecutemethod is omitted from the return type.Parameters
Rest ...path: string[]
Path to be appended.
+
Returns Omit<UpdateRequestBuilderV4<EntityT>, "execute">
The request builder itself without "execute" function, to facilitate method chaining.
+
build
Returns ODataRequest<ODataUpdateRequestConfig<EntityT>>
Parameters
destination: Destination | DestinationNameAndJwt
Optional options: DestinationOptions
Returns Promise<ODataRequest<ODataUpdateRequestConfig<EntityT>>>
execute
- +
Executes the query.
+Parameters
destination: Destination | DestinationNameAndJwt
Destination to execute the request against
+Optional options: DestinationOptions
Options to employ when fetching destinations
+
Returns Promise<EntityT>
A promise resolving to the entity once it was updated
+
execute
- +
Execute request and return an HttpResponse.
+Parameters
destination: Destination | DestinationNameAndJwt
Destination to execute the request against
+Optional options: DestinationOptions
Options to employ when fetching destinations
+
Returns Promise<HttpResponse>
A promise resolving to an HttpResponse.
+
Protected execute
- +
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 execute
Parameters
request: ODataRequest<ODataUpdateRequestConfig<EntityT>>
Returns Promise<HttpResponse>
Protected get
Returns Record<string, any>
ignore
- +
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>
The request itself to ease chaining while executing the request.
+
ignored
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 is
Parameters
obj: any
Returns boolean
prepare
Returns UpdateRequestBuilderV4<EntityT>
the builder itself
+
relative
- +
Create the relative URL based on configuration of the given builder.
+Returns string
The relative URL for the request
+
replace
- +
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.
+
required
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>
set
- +
Replace the default service path with the given custom path. +In case of the SAP S/4HANA APIs the servicePath defaults to
+/sap/opu/odata/sap/<SERVICE_NAME>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
+
set
- +
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>
set
- +
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>
set
- +
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.
+
skip
- +
Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.
+Returns UpdateRequestBuilderV4<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: DestinationRetrievalOptions
Options to employ when fetching destinations.
+
Returns Promise<string>
Promise resolving to the URL for the request
+
with
Parameters
headers: Record<string, string>
Key-value pairs denoting additional custom headers.
+
Returns UpdateRequestBuilderV4<EntityT>
The request builder itself, to facilitate method chaining.
+
with
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.
+
with
Parameters
servicePath: string
Path to override the default with.
+
Returns UpdateRequestBuilderV4<EntityT>
The request builder itself, to facilitate method chaining.
+
with
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.
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Class ErrorWithCause
+
Represents an error that was caused by another error.
+Hierarchy
- Error
- ErrorWithCause
Index
Constructors
Properties
Accessors
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 stack
Static Optional prepare
Type declaration
- +
Optional override for formatting stack traces
+Parameters
err: Error
stackTraces: CallSite[]
Returns any
Static stack
Accessors
root
- +
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
Static capture
- +
Create .stack property on a target object
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Parameters
targetObject: Object
Optional constructorOpt: Function
Returns void
Class UniqueNameGenerator
+
Holds state on already used names and provides new names if there are naming conflicts.
+Hierarchy
- UniqueNameGenerator
Index
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
add
- +
Adds the name(s) to the already used names.
+Parameters
Rest ...names: string[]
Names to be added
+
Returns void
generate
- +
Generate a unique name by appending an index separated by the
+indexSeparatorif necessary, e. g. ifMyNameis 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.
+
generate
- +
Generate unique names by appending an index separated by the
+indexSeparatorif 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: ifMyNameandMyName_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.
+
generate
- +
Generate a unique name by appending an index separated by the
+indexSeparatorif necessary, e. g. ifMyNameis 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.
+
generate
- +
Generate unique names by appending an index separated by the
+indexSeparatorif 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: ifMyNameandMyName_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.
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Enumeration DestinationOrigin
Enumeration DestinationType
+
+
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
+Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Index
Enumeration members
Enumeration members
Instance
Subaccount
Enumeration HttpMethod
\ No newline at end of file
diff --git a/docs/api/1.49.0/enums/sap_cloud_sdk_core.IsolationStrategy.html b/docs/api/1.49.0/enums/sap_cloud_sdk_core.IsolationStrategy.html
new file mode 100644
index 0000000000..93e8a7c413
--- /dev/null
+++ b/docs/api/1.49.0/enums/sap_cloud_sdk_core.IsolationStrategy.html
@@ -0,0 +1,5 @@
+
+
Enumeration IsolationStrategy
\ No newline at end of file
diff --git a/docs/api/1.49.0/enums/sap_cloud_sdk_core.Protocol-1.html b/docs/api/1.49.0/enums/sap_cloud_sdk_core.Protocol-1.html
new file mode 100644
index 0000000000..c359ed15af
--- /dev/null
+++ b/docs/api/1.49.0/enums/sap_cloud_sdk_core.Protocol-1.html
@@ -0,0 +1,3 @@
+
Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Enumeration Protocol
Enumeration ProxyStrategy
+
+
Enum representing the different strategies for proxies on requests. 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.
+Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Index
Enumeration members
Enumeration members
INTERNET_
NO_
ON_
SAP Cloud SDK for JavaScript / TypeScript - v1.49.0
+
+
+
Version: 1.49.0
+ +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
+ +-
+
- All versions of this documentation +
- Product page of the SAP Cloud SDK +
- SAP Cloud SDK Continuous Delivery Toolkit +
- Example Applications using the SAP Cloud SDK +
- SAP Cloud SDK community page +
- Community Call for SAP Cloud SDK +
Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Interface AuthAndExchangeTokens
Interface CachingOptions
Hierarchy
- CachingOptions
Index
Properties
Properties
Optional isolation
+
The isolation strategy used for caching destinations. For the available options, see IsolationStrategy. +By default, IsolationStrategy.Tenant is set.
+Optional use
+
+
A boolean value that indicates whether to read destinations from cache.
+Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Interface ClientCredentials
Interface CompleteDecodedJWT
Hierarchy
- RegisteredJWTClaims
- CompleteDecodedJWT
Index
Properties
Optional aud
Optional email
Optional exp
Optional family_
Optional given_
header
Optional iat
Optional iss
Optional jti
Optional nbf
payload
Optional scope
signature
Optional sub
Optional user_
Optional user_
Optional xs.user.attributes
Optional zdn
Optional zid
Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Interface ComplexTypeNamespace<ComplexT>
Interface DecodedJWT
Hierarchy
- RegisteredJWTClaims
- DecodedJWT
Indexable
Index
Properties
Optional aud
Optional email
Optional exp
Optional family_
Optional given_
Optional iat
Optional iss
Optional jti
Optional nbf
Optional scope
Optional sub
Optional user_
Optional user_
Optional xs.user.attributes
Optional zdn
Optional zid
Interface Destination
+
A resolved destination containing information needed to execute requests, such as the system URL.
+You can create a destination as a local object when supplying all necessary information, or it could be retrieved from the destination service on SAP 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 - headers
- is
Test Destination - is
Trusting All Certificates - key
Store Name - key
Store Password - name
- origin
- original
Properties - password
- proxy
Configuration - proxy
Type - query
Parameters - sap
Client - system
User - token
Service Password - token
Service Url - token
Service User - type
- url
- username
Properties
Optional auth
+
Authentication tokens returned from destination service on SAP Cloud Platform.
+Optional authentication
Optional certificates
+
Array of certificates used for authentication type ClientCertificateAuthentication.
+Optional client
+
Client Id used to retrieve access token for "OAuth2ClientCredentials", "OAuth2UserTokenExchange" and "OAuth2JWTBearer" authentication.
+Optional client
+
Client Secret used to retrieve access token for "OAuth2ClientCredentials", "OAuth2UserTokenExchange" and "OAuth2JWTBearer" authentication.
+Optional cloud
+
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 headers
+
Additional headers to be used for calls against the destination, originally defined by URL.headers.<header-name>.
+The keys of this object denote the names of the headers and the values their values.
Optional is
+
Flag indicating whether the destination is for test purpose. Should be "undefined" or "false" for non-mocked destinations.
+Optional is
+
Flag indicating whether all certificates should be accepted when communicating with the destination. Should not be "true" in production.
+Optional key
+
Name of the key store/certificate to be used for ClientCertificateAuthentication.
+Optional key
+
Password of the key store/certificate to be used for ClientCertificateAuthentication.
+Optional name
+
Name of the destination retrieved from SAP Cloud Platform.
+Optional origin
Optional original
+
Further properties of the destination as defined in destination service on SAP Cloud Platform, possibly empty.
+Type declaration
[key: string]: any
Optional password
+
Password to use for basic authentication, optional if other means of authentication shall be used.
+Optional proxy
+
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 proxy
+
Proxy type to specify whether the target resides on-premise (not used).
+Optional query
+
Additional query parameters to be used for calls against the destination, originally defined by URL.queries.<query-parameter-name>.
+The keys of this object denote the names of the query parameters and the values their values.
Optional sap
+
Client to target in an SAP system, will be added as HTTP header sap-client if set.
Optional system
+
System user to be used for OAuth2SAMLBearerAssertion authentication type.
+Optional token
+
Password for tokenServiceUser (if required).
+Optional token
+
URL to retrieve access token for "OAuth2ClientCredentials", "OAuth2UserTokenExchange" and "OAuth2JWTBearer" authentication.
+Optional token
+
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.
+The URL has to define the protocol, like http:// or https://, and a host.
+The path for requests against this destination will be appended to the path defined in the URL as a new path segment.
Optional username
+
+
Username to use for basic authentication, optional if other means of authentication shall be used.
+Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Interface DestinationAccessorOptions
Hierarchy
- DestinationAccessorOptions
Index
Properties
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 selection
+
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 user
+
+
The user token of the current request.
+Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Interface DestinationAuthToken
\ No newline at end of file
diff --git a/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.DestinationCachingOptions.html b/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.DestinationCachingOptions.html
new file mode 100644
index 0000000000..4e74a38082
--- /dev/null
+++ b/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.DestinationCachingOptions.html
@@ -0,0 +1,9 @@
+
+
Interface DestinationCachingOptions
Hierarchy
- DestinationCachingOptions
Index
Properties
Properties
Optional isolation
+
The isolation strategy used for caching destinations. For the available options, see IsolationStrategy. +By default, IsolationStrategy.Tenant is set.
+Optional use
+
+
A boolean value that indicates whether to read destinations from cache.
+Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Interface DestinationCertificate
+
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.
+Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Interface DestinationConfiguration
+
+
Configuration of a destination as it is available through the destination service.
+Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Hierarchy
- DestinationConfiguration
Indexable
Index
Properties
Optional Authentication
Optional Name
Optional Password
Optional Proxy
Optional System
Optional Trust
Optional Type
URL
Optional User
Optional client
Optional client
Optional sap-
Optional token
Optional token
Optional token
Interface DestinationForServiceBindingsOptions
+
Options to customize the behavior of destinationForServiceBinding.
+Hierarchy
- DestinationForServiceBindingsOptions
Index
Methods
Methods
Optional transformation
- +
Custom transformation function to control how a Destination is built from the given ServiceBinding.
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Parameters
serviceBinding: ServiceBinding
Returns Destination
Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Interface DestinationHttpRequestConfig
\ No newline at end of file
diff --git a/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.DestinationJson.html b/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.DestinationJson.html
new file mode 100644
index 0000000000..15d984d796
--- /dev/null
+++ b/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.DestinationJson.html
@@ -0,0 +1,5 @@
+
+
Interface DestinationJson
\ No newline at end of file
diff --git a/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.DestinationNameAndJwt.html b/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.DestinationNameAndJwt.html
new file mode 100644
index 0000000000..ab5bce7dd0
--- /dev/null
+++ b/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.DestinationNameAndJwt.html
@@ -0,0 +1,15 @@
+
+
Interface DestinationNameAndJwt
+
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
Properties
destination
+
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.
+Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Interface EntityDeserializer<EntityT>
+
+
Interface representing the return type of the builder function entityDeserializer
+Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Type parameters
EntityT: EntityBase = any
Hierarchy
- EntityDeserializer
Index
Methods
deserialize
Parameters
json: Record<string, any>
complexType: ComplexTypeNamespace<any>
Returns any
deserialize
Parameters
json: any
entityConstructor: Constructable<EntityT, unknown>
Optional requestHeader: any
Returns EntityT
Interface EntitySerializer<EntityT, ComplexTypeNamespaceT>
+
+
Interface representing the return type of the builder function entitySerializer.
+Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Type parameters
EntityT: EntityBase = any
ComplexTypeNamespaceT: ComplexTypeNamespace<any> = any
Hierarchy
- EntitySerializer
Index
Methods
serialize
Parameters
fieldValue: any
complexTypeNameSpace: ComplexTypeNamespaceT
Returns any
serialize
Parameters
entity: EntityT
entityConstructor: Constructable<EntityT, unknown>
Optional diff: boolean
Returns Record<string, any>
serialize
Parameters
entity: EntityT
entityConstructor: Constructable<EntityT, unknown>
Returns Record<string, any>
Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Interface ErrorResponse
\ No newline at end of file
diff --git a/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.FieldOptions.html b/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.FieldOptions.html
new file mode 100644
index 0000000000..417dc7819d
--- /dev/null
+++ b/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.FieldOptions.html
@@ -0,0 +1,9 @@
+
+
Interface FieldOptions<NullableT, SelectableT>
+
Optional settings for fields.
+Type parameters
NullableT: boolean = false
SelectableT: boolean = false
Hierarchy
- FieldOptions
Index
Properties
Properties
Optional is
+
Whether the value of the field can be null.
Optional is
+
+
Whether the field can be reference in a .select statement.
Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Interface GetFilter<EntityT>
+
+
Interface representing the return of the getFilter creator createGetFilter.
+Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Type parameters
EntityT: EntityBase = any
Hierarchy
- GetFilter
Index
Properties
Properties
get
Interface HttpAgentConfig
\ No newline at end of file
diff --git a/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.HttpReponse.html b/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.HttpReponse.html
new file mode 100644
index 0000000000..5b21317ce6
--- /dev/null
+++ b/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.HttpReponse.html
@@ -0,0 +1,4 @@
+
+
Interface HttpReponse
\ No newline at end of file
diff --git a/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.HttpRequestConfig.html b/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.HttpRequestConfig.html
new file mode 100644
index 0000000000..c28175eb4c
--- /dev/null
+++ b/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.HttpRequestConfig.html
@@ -0,0 +1,5 @@
+
+
Interface HttpRequestConfig
+
+
This interface is compatible with AxiosRequestConfig.
+Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Hierarchy
- HttpRequestConfig
Indexable
Index
Properties
Optional data
Optional headers
Optional http
Optional https
Optional max
method
Optional params
Optional proxy
Optional timeout
Optional url
Interface HttpRequestOptions
Hierarchy
- HttpRequestOptions
Index
Properties
Properties
Optional fetch
+
+
A boolean value that indicates whether to fetch the csrf token for a non-get request.
+For a get request, the csrf token is not fetched and this option is ignored.
+By default, the value is false.
Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Interface HttpResponse
\ No newline at end of file
diff --git a/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.HttpsAgentConfig.html b/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.HttpsAgentConfig.html
new file mode 100644
index 0000000000..319ea1d0f1
--- /dev/null
+++ b/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.HttpsAgentConfig.html
@@ -0,0 +1,5 @@
+
+
Interface HttpsAgentConfig
\ No newline at end of file
diff --git a/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.JWTHeader.html b/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.JWTHeader.html
new file mode 100644
index 0000000000..c8a94da8e2
--- /dev/null
+++ b/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.JWTHeader.html
@@ -0,0 +1,5 @@
+
+
Interface JWTHeader
Interface JWTPayload
Hierarchy
- RegisteredJWTClaims
- JWTPayload
Indexable
Index
Properties
Optional aud
Optional email
Optional exp
Optional family_
Optional given_
Optional iat
Optional iss
Optional jti
Optional nbf
Optional scope
Optional sub
Optional user_
Optional user_
Optional xs.user.attributes
Optional zdn
Optional zid
Interface JwtPair
\ No newline at end of file
diff --git a/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.ODataUri.html b/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.ODataUri.html
new file mode 100644
index 0000000000..1a4fd41c7f
--- /dev/null
+++ b/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.ODataUri.html
@@ -0,0 +1,6 @@
+
+
Interface ODataUri
+
+
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.
+Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Hierarchy
- ODataUri
Index
Methods
convert
Parameters
value: any
edmType: EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4
Returns string
get
Type parameters
EntityT: EntityBase<EntityT>
Parameters
entity: EntityT
entityConstructor: Constructable<EntityT, unknown>
Returns Record<string, any>
get
Type parameters
EntityT: EntityBase<EntityT>
Parameters
selects: Selectable<EntityT>[]
expands: Expandable<EntityT>[]
entityConstructor: Constructable<EntityT, unknown>
Returns Partial<{ expand: string }>
get
Type parameters
EntityT: EntityBase<EntityT>
Parameters
filter: Filterable<EntityT, any>
entityConstructor: Constructable<EntityT, unknown>
Returns Partial<{ filter: string }>
get
Type parameters
EntityT: EntityBase<EntityT>
Parameters
orderBy: Orderable<EntityT>[]
Returns Partial<{ orderby: string }>
get
Type parameters
EntityT: EntityBase<EntityT>
Parameters
keys: Record<string, FieldType>
entityConstructor: Constructable<EntityT, unknown>
Returns string
get
Type parameters
EntityT: EntityBase<EntityT>
Parameters
selects: Selectable<EntityT>[]
Returns Partial<{ select: string }>
Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Interface PropertyMetadata<ComplexT>
\ No newline at end of file
diff --git a/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.ProxyConfiguration.html b/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.ProxyConfiguration.html
new file mode 100644
index 0000000000..31e5a5b6ad
--- /dev/null
+++ b/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.ProxyConfiguration.html
@@ -0,0 +1,25 @@
+
+
Interface ProxyConfiguration
+
Proxy settings for connecting to an on-premise destination via connectivity proxy or web proxies.
+The ProxyConfiguration is undefined in most cases. The logic for setting it is as 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
+Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Interface ProxyConfigurationHeaders
\ No newline at end of file
diff --git a/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.ReadResponse.html b/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.ReadResponse.html
new file mode 100644
index 0000000000..c11ae843d9
--- /dev/null
+++ b/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.ReadResponse.html
@@ -0,0 +1,3 @@
+
Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Interface ReadResponse
\ No newline at end of file
diff --git a/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.RegisteredJWTClaimsBasic.html b/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.RegisteredJWTClaimsBasic.html
new file mode 100644
index 0000000000..9055e1880b
--- /dev/null
+++ b/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.RegisteredJWTClaimsBasic.html
@@ -0,0 +1,5 @@
+
+
Interface RegisteredJWTClaimsBasic
\ No newline at end of file
diff --git a/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.RegisteredJWTClaimsTenant.html b/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.RegisteredJWTClaimsTenant.html
new file mode 100644
index 0000000000..3826eccb22
--- /dev/null
+++ b/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.RegisteredJWTClaimsTenant.html
@@ -0,0 +1,5 @@
+
+
Interface RegisteredJWTClaimsTenant
Interface RegisteredJWTClaimsUser
\ No newline at end of file
diff --git a/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.ResilienceOptions.html b/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.ResilienceOptions.html
new file mode 100644
index 0000000000..1e2db17d30
--- /dev/null
+++ b/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.ResilienceOptions.html
@@ -0,0 +1,5 @@
+
+
Interface ResilienceOptions
\ No newline at end of file
diff --git a/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.ResponseData.html b/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.ResponseData.html
new file mode 100644
index 0000000000..0e10a3e291
--- /dev/null
+++ b/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.ResponseData.html
@@ -0,0 +1,3 @@
+
Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Interface ResponseData
Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Interface ResponseDataAccessor
\ No newline at end of file
diff --git a/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.Scope.html b/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.Scope.html
new file mode 100644
index 0000000000..868c6fb550
--- /dev/null
+++ b/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.Scope.html
@@ -0,0 +1,5 @@
+
+
Interface Scope
\ No newline at end of file
diff --git a/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.SelectableEdmTypeField.html b/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.SelectableEdmTypeField.html
new file mode 100644
index 0000000000..87fe6a1491
--- /dev/null
+++ b/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.SelectableEdmTypeField.html
@@ -0,0 +1,7 @@
+
+
Interface SelectableEdmTypeField
\ No newline at end of file
diff --git a/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.Service.html b/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.Service.html
new file mode 100644
index 0000000000..d905b35340
--- /dev/null
+++ b/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.Service.html
@@ -0,0 +1,3 @@
+
Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Interface Service
Interface ServiceBinding
+
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.
+Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Hierarchy
- ServiceBinding
Indexable
Index
Properties
name
type
Interface Tenant
\ No newline at end of file
diff --git a/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.Time.html b/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.Time.html
new file mode 100644
index 0000000000..ce3d23e731
--- /dev/null
+++ b/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.Time.html
@@ -0,0 +1,3 @@
+
Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Interface Time
Interface TokenKey
+
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
+
Encryption algorithm, e.g. RSA256.
+key
+
ID of the key.
+key
+
Key type, e.g. RSA.
+public
+
RSA key exponent.
+public
+
RSA key modulus.
+use
+
Public key use parameter - identifies intended use of the public key.
+value
+
+
The actual key.
+Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Interface UriConverter
+
+
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
+Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Hierarchy
- UriConverter
Index
Methods
Methods
convert
Parameters
value: any
edmType: EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4
Returns string
Interface User
+
+
Representation of the user i.e. authenticated persona. The authentication is done by the XSUAA.
+Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Hierarchy
- UserData
- User
Index
Properties
Methods
Properties
custom
Optional email
Optional family
Optional given
id
scopes
user
Methods
has
Parameters
scope: Scope
Returns boolean
Interface VerifyJwtOptions
\ No newline at end of file
diff --git a/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.WriteResponse.html b/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.WriteResponse.html
new file mode 100644
index 0000000000..4e27adfecf
--- /dev/null
+++ b/docs/api/1.49.0/interfaces/sap_cloud_sdk_core.WriteResponse.html
@@ -0,0 +1,3 @@
+
Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Interface WriteResponse
Hierarchy
- WriteResponse
Index
Properties
Optional body
http
Optional type
Methods
Optional as
Type parameters
T: EntityBase<T>
Parameters
constructor: Constructable<T, unknown>
Returns T
Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Interface WriteResponses
\ No newline at end of file
diff --git a/docs/api/1.49.0/interfaces/sap_cloud_sdk_openapi_generator.GeneratorOptions.html b/docs/api/1.49.0/interfaces/sap_cloud_sdk_openapi_generator.GeneratorOptions.html
new file mode 100644
index 0000000000..46588fa52f
--- /dev/null
+++ b/docs/api/1.49.0/interfaces/sap_cloud_sdk_openapi_generator.GeneratorOptions.html
@@ -0,0 +1,6 @@
+
+
Interface GeneratorOptions
+
+
Options that can be used to configure the generation when using the generator programmatically. +The options match the CLI options.
+Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Hierarchy
- GeneratorOptions
Index
Properties
Optional clear
Optional config
Optional include
input
Optional metadata
Optional options
output
Optional overwrite
Optional package
Optional package
Optional readme
Optional skip
Optional transpile
Optional ts
Optional verbose
Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Interface GetTestDestinationOptions
\ No newline at end of file
diff --git a/docs/api/1.49.0/interfaces/sap_cloud_sdk_util.LoggerOptions.html b/docs/api/1.49.0/interfaces/sap_cloud_sdk_util.LoggerOptions.html
new file mode 100644
index 0000000000..3578ce1a11
--- /dev/null
+++ b/docs/api/1.49.0/interfaces/sap_cloud_sdk_util.LoggerOptions.html
@@ -0,0 +1,5 @@
+
+
Interface LoggerOptions
\ No newline at end of file
diff --git a/docs/api/1.49.0/interfaces/sap_cloud_sdk_util.MessageContextObj.html b/docs/api/1.49.0/interfaces/sap_cloud_sdk_util.MessageContextObj.html
new file mode 100644
index 0000000000..3fc1634d00
--- /dev/null
+++ b/docs/api/1.49.0/interfaces/sap_cloud_sdk_util.MessageContextObj.html
@@ -0,0 +1,5 @@
+
+
Interface MessageContextObj
\ No newline at end of file
diff --git a/docs/api/1.49.0/modules.html b/docs/api/1.49.0/modules.html
new file mode 100644
index 0000000000..4a742f0f1d
--- /dev/null
+++ b/docs/api/1.49.0/modules.html
@@ -0,0 +1,3 @@
+
Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
SAP Cloud SDK for JavaScript / TypeScript - v1.49.0
\ No newline at end of file
diff --git a/docs/api/1.49.0/modules/sap_cloud_sdk_analytics.html b/docs/api/1.49.0/modules/sap_cloud_sdk_analytics.html
new file mode 100644
index 0000000000..34210c124d
--- /dev/null
+++ b/docs/api/1.49.0/modules/sap_cloud_sdk_analytics.html
@@ -0,0 +1,58 @@
+
+
Module @sap-cloud-sdk/analytics
+
+
+
+ +
+ + + + +
+
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.
+ + + + +Support
+ +The recommended way to get in touch with us is to create an issue in our github repository.
+Select the issue category Bug, Feature or Question depending on the nature of your request.
+We try to provide fixes, features and answers as soon as possible.
We also monitor questions on StackOverflow and ansers.sap.com but prefer issues on github.
+ + +Contribute
+ +If you would like to contribute to the SAP Cloud SDK, please make yourself familiar with our contributing guidelines and follow the given instructions.
+ + +Links
+ + ++ +
-
+
- SAP Cloud SDK Documentation portal +
- SAP Cloud SDK Documentation portal - Getting started guide +
- SAP Cloud SDK Documentation portal - API documentation +
+ + + + +
License
+ +The SAP Cloud SDK is released under the Apache License Version 2.0.
+ +Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Index
Functions
Functions
get
Parameters
config: UsageAnalyticsProjectConfig
packageJson: PackageJson
Returns string
Namespace Protocol
Module @sap-cloud-sdk/core
+
+
+
+ +
+ + + + +
@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);
+For more detailed overview visit our OData client documentation.
+ + + + +Support
+ +The recommended way to get in touch with us is to create an issue in our github repository.
+Select the issue category Bug, Feature or Question depending on the nature of your request.
+We try to provide fixes, features and answers as soon as possible.
We also monitor questions on StackOverflow and ansers.sap.com but prefer issues on github.
+ + +Contribute
+ +If you would like to contribute to the SAP Cloud SDK, please make yourself familiar with our contributing guidelines and follow the given instructions.
+ + +Links
+ + ++ +
-
+
- SAP Cloud SDK Documentation portal +
- SAP Cloud SDK Documentation portal - Getting started guide +
- SAP Cloud SDK Documentation portal - API documentation +
+ + + + +
License
+ +The SAP Cloud SDK is released under the Apache License Version 2.0.
+ +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
To Primitive V2 - Edm
Type V2 - Entity
V2 - Function
Import Request Builder V2 - Get
All Request Builder V2 - Get
By Key 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
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
- Field
Builder - 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
By Key Request Builder - Get
By Key Request Builder Base - Get
By Key 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 By Key Request Config - OData
Get By Key Request Config Legacy - OData
Request - OData
Update Request Config - OData
Update Request Config Legacy - One
To Many Link - One
To One Link - Open
Api Request Builder - Order
- Order
Link - Orderable
Edm Type Field - Orderable
Filter Function - String
Field - String
Filter Function - Time
Field - Time
Field Base - Unary
Filter - 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 - Entity
Deserializer - Entity
Serializer - Error
Response - Field
Options - Get
Filter - Http
Agent Config - Http
Reponse - Http
Request Config - Http
Request Options - Http
Response - Https
Agent Config - JWTHeader
- JWTPayload
- Jwt
Pair - OData
Uri - Property
Metadata - Proxy
Configuration - Proxy
Configuration Headers - Read
Response - RegisteredJWTClaims
Basic - RegisteredJWTClaims
Tenant - RegisteredJWTClaims
User - Resilience
Options - Response
Data - Response
Data Accessor - Scope
- Selectable
Edm Type Field - Service
- Service
Binding - Tenant
- Time
- Token
Key - Uri
Converter - User
- Verify
Jwt Options - Write
Response - Write
Responses
Type aliases
- Authentication
Type - Batch
Response - Collection
Field Type - Constructor
Or Field - Deep
Field Type - Destination
Options - Destination
Proxy Type - Destination
Retrieval Options - Destination
Selection Strategy - Destination
Service Credentials - Edm
To Primitive - Edm
To Primitive V4 - Edm
Type - Edm
Type Common - Edm
Type Different Converters - Edm
Type For Edm Or Field Type - Edm
Type Same Converters - Edm
Type Same Converters Uri - Edm
Type Shared - Edm
Type V4 - Entity
Builder Type - Enum
Type - Exclusive
Edm Type V2 - Exclusive
Edm Type V4 - Execute
Http Request Fn - Expandable
- Field
Type - Field
Type By Edm 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 By Type - Filterable
- Function
Import Parameters - Http
Request - Is
Orderable Field - Is
Selectable Field - Jwt
Key Mapping - Method
- OData
Version Of - Orderable
- Orderable
Edm Type - Orderable
Input - RegisteredJWTClaims
- Request
Method Type - Selectable
- Service
Credentials - Xsuaa
Service Credentials
Variables
- Destination
Selection Strategies - Environment
Accessor - circuit
Breaker Default Options - client
Credentials Token Cache - content_
transfer_ encoding_ line - default
Disallowed Keys - 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 - serializers
Common - verification
Key Cache
Functions
- add
Authorization Header - add
Destination To Request Config - add
Proxy Configuration - add
Proxy Configuration Internet - add
Proxy Configuration On Prem - 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
Custom Request Config - 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 By Name - get
Destination From Destination Service - get
Destination From Env By Name - 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
Field Options - 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 Or Default - 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
Boolean Filter Function - 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
Orderable Edm Type - is
Unary Filter - is
User Token - is
WithETag - issuer
Url - jwt
Bearer Token - jwt
Bearer Token Grant - length
- matches
Pattern - max
Date Time - merge
Headers - min
Date Time - minute
- month
- no
Destination Error Message - non
Enumerable - not
- 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
Host And Port - proxy
Strategy - read
Property With Warn - refresh
Token Grant - replace
Duplicate Keys - resolve
Service - retrieve
Jwt - round
- sanitize
Destination - search
Service Binding For Destination - second
- seconds
To Time - 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 - should
Handle Csrf Token - split
Batch Response - split
Change Set Response - split
Response - starts
With - subscriber
First - substring
- substring
Of - tenant
From Jwt - throw
Error When Return Type Is Union Type - time
To Seconds - 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
- url
And Agent - use
Or Fetch Destination - user
Approved Service Token - user
From Jwt - user
Token Grant - verify
Jwt - verify
Jwt With Key - wrap
Jwt In Header - year
References
Action
Renames and re-exports ActionFunctionImportRequestBuilderAction
Renames and re-exports FunctionImportParameterAction
Renames and re-exports FunctionImportParametersCreate
Renames and re-exports CreateRequestBuilderCustom
Renames and re-exports CustomFieldDelete
Renames and re-exports DeleteRequestBuilderEdm
Renames and re-exports EdmToPrimitiveEdm
Renames and re-exports EdmTypeEntity
Renames and re-exports EntityFunction
Renames and re-exports FunctionImportRequestBuilderGet
Renames and re-exports GetAllRequestBuilderGet
Renames and re-exports GetByKeyRequestBuilderMethod
Renames and re-exports MethodRequestBuilderOData
Renames and re-exports ODataBatchChangeSetOData
Renames and re-exports ODataBatchRequestBuilderOData
Renames and re-exports ODataFunctionImportRequestConfigUpdate
Renames and re-exports UpdateRequestBuilderdeserialize
Renames and re-exports deserializeComplexTypedeserialize
Renames and re-exports deserializeEntityentity
Renames and re-exports entitySerializerextractOData
Renames and re-exports extractODataEtagget
Renames and re-exports getExpandget
Renames and re-exports getSelecto
Renames and re-exports oDataUriresponse
Renames and re-exports responseDataAccessorserialize
Renames and re-exports serializeEntityserialize
Renames and re-exports serializeEntityNonCustomFieldsserialize
Renames and re-exports serializeEntityto
Renames and re-exports toBatchChangeSetto
Renames and re-exports toBatchRetrieveBodyType aliases
Authentication
Batch
Collection
+
Convenience type to reflect the type of the instances of a collection field. +The actual type of the elements for complex type collections is ComplexTypeNamespace.
+Type parameters
CollectionFieldT: EdmTypeShared<"any"> | Record<string, any>
Type of of elements of the collection. This can either be an EDM type or complex type.
+
Constructor
+
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
Deep
Destination
Destination
Destination
+
Options to use while fetching destinations. Encompasses both DestinationCachingOptions and ResilienceOptions interfaces.
+Destination
Type declaration
Parameters
allDestinations: AllDestinations
destinationName: string
Returns Destination | null
Destination
+
Credentials for the Destination service.
+Edm
Type parameters
T: EdmType
Edm
Type parameters
T: EdmTypeV4
Edm
+
Allowed Edm types for OData v2.
+Edm
Edm
Edm
+
Convenience type to support legacy EdmTypeField with field type as generic parameter.
+This will become obsolete in the next major version update.
Type parameters
EdmOrFieldT: EdmTypeShared<"any"> | FieldType
Edm
Edm
Edm
Type parameters
VersionT: ODataVersion | "any"
Edm
+
Allowed Edm types for OData v4.
+Entity
Type parameters
EntityT: EntityBase
EntityTypeT
Enum
+
Convenient type to reflect all the values of a string based enum as a union type.
+Type parameters
T: string
String based enum type
+
Exclusive
Exclusive
Execute
Type parameters
ReturnT
Type declaration
Parameters
request: HttpRequest
Returns Promise<ReturnT>
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
+
Field
+
Union type to represent all possible types of a field.
+Field
+
Convenience type that maps the given EDM type to a FieldType. It also considers whether the field is nullable.
+Type parameters
EdmOrFieldT: EdmTypeShared<"any"> | FieldType
EDM type of the field. Deprecated: Field type of the field.
+NullableT: boolean
Boolean type that represents whether the field is nullable.
+
Filter
+
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
Filter
+
Primitive type of a parameter of a filter function.
+Filter
Filter
Filter
+
hidden
+Filter
Filter
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
+LinkedEntityT: EntityBase = any
Function
+
Internal representation of all parameters of a function import as a map
+Type parameters
ParametersT
External representation of all parameters
+
Http
Is
+
Convenience type to determine whether a field should be orderable. If the given EdmT is of type OrderableEdmTypes, it is orderable.
Type parameters
EdmT: EdmTypeShared<"any">
EDM type of the field.
+
Is
+
Convenience type to determine whether a field should be selectable. If the given FieldOfT is the type of an entity, it is selectable.
Type parameters
FieldOfT: ConstructorOrField<any>
Type of the entity or complex type field this field belongs to.
+
Jwt
Type parameters
InterfaceT
JwtKeysT
Method
+
HTTP Methods supported by the http-client.
+OData
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
+
Orderable
+
EDM types that can be compared with greaterThan, greaterOrEqual, lessThan and lessOrEqual.
Orderable
+
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
Request
Selectable
Type parameters
EntityT: EntityBase
Service
+
Unspecific representation of a service's credentials as read from VCAP_SERVICES (for Cloud Foundry) or mounted secrets (for K8S).
+Xsuaa
+
Credentials for the XSUAA service.
+Variables
Destination
+
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
Environment
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
circuit
Type declaration
error
Threshold Percentage: number reset
Timeout: number timeout: number
volume
Threshold: number
client
Type declaration
cache
Retrieved Token:function Parameters
url: any
credentialsOrClientId: string | ClientCredentials
token: ClientCredentialsResponse
Returns void
clear:function
Returns void
get
Cache Instance:function Returns Cache<ClientCredentialsResponse>
get
Grant Token From Cache:function Parameters
url: any
credentialsOrClientId: string | ClientCredentials
Returns undefined | ClientCredentialsResponse
content_
default
+
A list of request config keys that are not allowed to be customized by default.
+deserializers
destination
Type declaration
cache
Retrieved Destination:function Parameters
decodedJwt: Record<string, any>
destination: Destination
isolation: IsolationStrategy
Returns void
cache
Retrieved Destinations:function Parameters
decodedJwt: Record<string, any>
retrievedDestinations: DestinationsByType
isolation: IsolationStrategy
Returns void
clear:function
Returns void
get
Cache Instance:function Returns Cache<Destination>
retrieve
Destination From Cache:function Parameters
decodedJwt: Record<string, any>
name: string
isolation: IsolationStrategy
Returns undefined | Destination
destination
Type declaration
cache
Retrieved Destinations:function Parameters
destinationServiceUri: string
decodedJwt: JwtPayload
destinations: Destination[]
Optional isolationStrategy: IsolationStrategy
Returns void
clear:function
Returns void
get
Cache Instance:function Returns Cache<Destination[]>
retrieve
Destinations From Cache:function Parameters
targetUrl: string
decodedJwt: JwtPayload
Optional isolationStrategy: IsolationStrategy
Returns undefined | Destination[]
entity
+
Entity deserializer instance for v2 entities. +See EntityDeserializer for the provided methods.
+entity
+
Entity deserializer instance for v4 entities. +See EntityDeserializer for the provided methods.
+entity
+
Entity serializer instance for v2 entities. +See EntitySerializer for the provided methods.
+entity
+
Entity serializer instance for v4 entities. +See EntitySerializer for the provided methods.
+filter
+
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
filter
+
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
http_
mapping
+
Mapping between key name in the Tenant and key name in decoded JWT.
+mapping
+
Mapping between key name in the User and key name in decoded JWT and the
+number
o
+
Instance of the ODataUri conversion interface for OData v2.
+o
+
Instance of the ODataUri conversion interface for OData v4.
+part_
response
serializers
serializers
verification
Functions
add
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.
+
add
- +
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
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.
+
add
- +
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 destination with the added proxy configuration.
+
add
- +
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.
+
add
Parameters
destination: Destination
jwt: undefined | string | JwtPair
Returns Promise<Destination>
all
- +
Will return the entity if all elements of the one-to-many link relation fulfill the condition.
+Type parameters
EntityT: EntityBase<EntityT>
LinkedEntityT: EntityBase<LinkedEntityT>
Parameters
Rest ...filters: Filterable<EntityT, LinkedEntityT>[]
A filter condition like MyEntity.someMultiLink.someProperty.eq('value')
+
Returns FilterLambdaExpression<EntityT>
The lambda filter function to be considered in the query
+
always
- +
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.
always
- +
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
- +
Combine Filterables with logical
+andto create a FilterList.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 filter on.
+
Parameters
expressions: Filterable<EntityT, any>[]
Filterables to be combined with logical
+and.
Returns FilterList<EntityT>
The newly created FilterList.
+ Type parameters
EntityT: EntityBase<EntityT>
Parameters
Rest ...expressions: Filterable<EntityT, any>[]
Returns FilterList<EntityT>
any
- +
Will return the entity if at least one element of the one-to-many link relation fulfills the condition.
+Type parameters
EntityT: EntityBase<EntityT>
LinkedEntityT: EntityBase<LinkedEntityT>
Parameters
Rest ...filters: Filterable<EntityT, LinkedEntityT>[]
A filter condition like MyEntity.someMultiLink.someProperty.eq('value')
+
Returns FilterLambdaExpression<EntityT>
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: JwtPayload
Token to retrieve the audiences from.
+
Returns Set<string>
A set of audiences.
+
basic
Parameters
username: string
password: string
Returns string
build
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>>
The provided headers with the new authorization headers.
+
build
Parameters
destination: Destination
Returns Promise<Record<string, string>>
build
Type parameters
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>
build
- +
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
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
+
build
Parameters
destination: Destination
Optional customHeaders: Record<string, any>
Returns Promise<Record<string, string>>
build
- +
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, boolean, boolean> | 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
+
check
- +
Checks if a given key is present in the decoded JWT. If not, an error is thrown.
+Type parameters
InterfaceT
JwtKeysT
Parameters
key: keyof InterfaceT
The key of the representation in typescript
+mapping: JwtKeyMapping<InterfaceT, JwtKeysT>
The mapping between the typescript keys and the JWT key
+jwtPayload: JwtPayload
JWT payload to check fo the given key.
+
Returns void
client
Parameters
tokenServiceUrlOrXsuaaServiceCredentials: 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, boolean, boolean> | 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, boolean, boolean> | 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, boolean, boolean> | 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, boolean, boolean> | 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
+
create
Type parameters
ComplexT
Parameters
json: any
A raw json object to deserialize a complex type from.
+converters: {}
A list of rules on how to convert json to the respective type in JavaScript or TypeScript.
+[converter: string]: CallableFunction
Returns ComplexT
A deserialized complex type representation.
+
create
- +
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
+
create
- +
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
+
custom
- +
Extracts the custom attributes from the JWT.
+Parameters
jwtPayload: JwtPayload
Token payload to read the custom attributes from.
+
Returns Map<string, string[]>
Custom attributes added by the XSUAA service 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 | Field<EntityT, boolean, boolean>
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
+
decode
- +
Decode JWT.
+Parameters
token: string
JWT to be decoded
+
Returns JwtPayload
Decoded payload.
+
decode
- +
Decode JWT and return the complete decoded token.
+Parameters
token: string
JWT to be decoded.
+
Returns Jwt
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
+
deserialize
- +
Deserialize the parsed batch response.
+Parameters
parsedBatchResponse: (ResponseData | ResponseData[])[]
Two dimensional list of parsed batch sub responses.
+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 (ErrorResponse | ReadResponse | WriteResponses)[]
An array of parsed sub responses of the batch response.
+
Const deserialize
Parameters
json: Record<string, any>
complexType: ComplexTypeNamespace<any>
Returns any
Const deserialize
Parameters
json: Record<string, any>
complexType: ComplexTypeNamespace<any>
Returns any
Const deserialize
Parameters
json: any
entityConstructor: Constructable<any, unknown>
Optional requestHeader: any
Returns any
Const deserialize
Parameters
json: any
entityConstructor: Constructable<any, unknown>
Optional requestHeader: any
Returns any
destination
- +
Tries to build a destination from a service binding with the given name. +Throws an error if no services are bound at all, no service with the given name can be found, or the service type is not supported. +The last error can be circumvent by using the second parameter to provide a custom function that transforms a service binding to a destination.
+Parameters
serviceInstanceName: string
The name of the service.
+Optional options: DestinationForServiceBindingsOptions
Options to customize the behavior of this function.
+
Returns Destination
A destination.
+
detect
- +
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
+
ends
- +
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, boolean, boolean> | 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, boolean, boolean> | 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
+
entity
- +
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<any> | EdmToTsTypeV4<any>
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 parameter 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.
+Type parameters
ReturnT
Parameters
executeFn: ExecuteHttpRequestFn<ReturnT>
A function that can execute an HttpRequestConfig.
+
Returns <T>(destination: Destination | DestinationNameAndJwt, requestConfig: T, options?: HttpRequestOptions) => Promise<ReturnT>
A function expecting destination and a request.
+- +
Takes as parameter 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.
+Type parameters
Parameters
destination: Destination | DestinationNameAndJwt
requestConfig: T
Optional options: HttpRequestOptions
Returns Promise<ReturnT>
A function expecting destination and a request.
+
execute
- +
Builds a DestinationHttpRequestConfig for the given destination, merges it into the given requestConfig +and executes it (using Axios).
+Type parameters
Parameters
destination: Destination | DestinationNameAndJwt
A destination or a destination name and a JWT.
+requestConfig: T
Any object representing an HTTP request.
+Optional options: HttpRequestOptions
An HttpRequestOptions of the http request for configuring e.g., csrf token delegation. By default, the SDK will not fetch the csrf token.
+
Returns Promise<HttpResponse>
A promise resolving to an HttpResponse.
+
extract
- +
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.
+
extract
- +
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, unknown>
The constructor function of the entity class.
+
Returns Record<string, any>
An object containing the custom fields as key-value pairs.
+
extract
Parameters
headers: any
Returns string | undefined
extractOData
- +
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.
+
extractOData
- +
Extractor for the ETag for OData v4 responses used in entityDeserializer.
+Parameters
json: Record<string, any>
Response data from which the ETag is extracted.
+
Returns string | undefined
The ETag.
+
fetch
- +
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
+
fetch
- +
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
+
fetch
- +
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
+
fetch
- +
Deprecated since v1.49.0. Use
+fetchVerificationKeys(url: string)instead. Credentials are ignored. +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.
+ - +
Deprecated since v1.49.0. Use
+fetchVerificationKeys(url: string)instead. Credentials are ignored. +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 token keys.
+ - +
Fetches verification keys from the XSUAA service for the given URL.
+Parameters
url: string
URL of the XSUAA service instance.
+
Returns Promise<TokenKey[]>
An array of token keys.
+
filter
- +
Filter disallowed keys from a given custom request config object.
+Parameters
customRequestConfig: Record<string, string>
a given custom request config object to be filtered
+Optional disallowedKeys: string[]
A list of keys that are not allowed to be customized.
+
Returns Record<string, string>
Filtered custom request config object.
+
filter
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>
filter
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>
filter
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, boolean, boolean> | 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
+
fractional
- +
Build a filter function to get the fractional seconds of a date. Evaluates to decimal.
+Type parameters
EntityT: EntityV4<EntityT>
Parameters
date: Moment | Field<EntityT, boolean, boolean>
The date to get the fractional seconds for. This can either be a date (Moment) or a reference to a field.
+
Returns NumberFilterFunction<EntityT>
The newly created filter function
+
get
- +
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.
+
get
Parameters
destination: Destination
Optional customHeaders: Record<string, any>
Returns Promise<Record<string, string>>
get
- +
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
+
get
Returns Omit<HttpRequestConfig, "method">
get
- +
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[]
Collection extracted from the response.
+
get
- +
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.
+
get
- +
Basic Credentials Getter from Destination service credentials needed for JWT generator.
+Returns BasicCredentials
Basic credentials.
+
get
Parameters
name: string
Name of the destination
+
Returns Destination | null
The requested destination if existent, otherwise
+null
get
- +
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.
+
get
- +
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
get
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.
+
get
- +
Get destination service if one is present.
+Returns Service
Destination service
+
get
- +
First 'destination' credentials getter.
+Returns any
The 'destination' credentials object or
+null, if it does not exist.
get
- +
Destination credentials getter.
+Returns DestinationServiceCredentials[]
A list of 'credentials' objects in 'destination' service.
+
get
- +
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.
get
Returns Destination[]
A list of destinations
+
get
- +
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
+
get
- +
Convenience method to get the EdmTypeShared from the overloaded constructor. +The two scenarios are:
+-
+
complexTypeNameOrEdmTypeis of typeEdmTypeSharedandedmTypeOrUndefinedisundefined
+complexTypeNameOrEdmTypeis of typestringandedmTypeOrUndefinedis of typeEdmTypeShared
+
Type parameters
VersionT: "any" | ODataVersion
Parameters
complexTypeNameOrEdmType: string | EdmTypeShared<VersionT>
Either the name of the complex type or the EDM type.
+Optional edmTypeOrUndefined: EdmTypeShared<VersionT>
Either the EDM type or
+undefined.
Returns EdmTypeShared<VersionT>
The EDM type resolved for the two arguments.
+
get
- +
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;
+
get
- +
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, unknown>
The constructor of the entity
+
Returns Record<string, any>
object that includes all keys that represent given entity
+
get
- +
Environment variables accessor.
+Parameters
name: string
Environment variable name.
+
Returns string | undefined | null
Env variable value if defined. + null: If not defined.
+
get
- +
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
+
get
- +
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: undefined | Expandable<EntityT>[]
The expands to transform to a query parameter
+entityConstructor: Constructable<EntityT, unknown>
Constructor type of the entity to expand on
+
Returns Partial<{ expand: string }>
An object containing the query parameter or an empty object
+
get
- +
Get field options merged with default values. +The given options take precedence.
+Type parameters
NullableT: boolean = false
SelectableT: boolean = false
Parameters
Optional fieldOptions: FieldOptions<NullableT, SelectableT>
Given options.
+
Returns Required<FieldOptions<NullableT, SelectableT>>
Given options merged with default values.
+
get
Parameters
url: string
credentialsOrClientId: string | ClientCredentials
Returns string
get
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.
+
get
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.
get
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.
+
get
Parameters
request: MethodRequestBuilder<any>
Returns string
The serialized request as
+<HTTP method> <URL> <HTTP version>.
get
- +
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[]
Collection extracted from the response.
+
getOAuth2
Parameters
destination: Destination
A destination having
+OAuth2ClientCredentialsauthentication type
Returns Promise<ClientCredentialsResponse>
A promise returning the requested access token on success.
+
get
- +
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
+
get
- +
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.
+
get
Type parameters
EntityT: Entity<EntityT>
Type of the entity to filter on
+
Parameters
filter: Filterable<EntityT, any>
The filter to transform to a query parameter
+entityConstructor: Constructable<EntityT, unknown>
Constructor type of the entity to filter on
+
Returns Partial<{ filter: string }>
An object containing the query parameter or an empty object
+
get
get
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
+
get
Type parameters
EntityT: EntityBase<EntityT>
Type of the entity to get the resource path for
+
Parameters
keys: undefined | 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
+entityConstructor: Constructable<EntityT, unknown>
Constructor type of the entity to get the resource path for
+
Returns string
The path to the resource
+
get
- +
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.
+
get
- +
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
+
get
- +
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
+
get
- +
Returns the first found instance for the given service type.
+Parameters
service: string
The service type.
+
Returns Service | undefined
The first found service.
+
get
- +
Credentials list getter for a given service.
+Parameters
service: string
Service name
+
Returns any[]
Fetched credentials objects of existing service in 'VCAP_SERVICES'.
+
get
- +
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.
+
get
- +
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>
A single object extracted from the response.
+
get
Parameters
destination: Destination
URL of this destination is parsed
+
Returns Protocol | undefined
The protocol either
+undefinedif no://is found or anything before the delimiter.
get
- +
'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.
get
- +
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: string | JwtPayload
Either an encoded or decoded JWT.
+
Returns XsuaaServiceCredentials
The credentials for a match, otherwise
+null.
has
- +
Build a filter function to test whether a set is a subsequence of the other, i. e. whether 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, boolean, boolean> | 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, boolean, boolean> | 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
+
has
- +
Build a filter function to test whether a set is a subset of the other, i. e. whether 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, boolean, boolean> | 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, boolean, boolean> | 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
+
header
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 | Field<EntityT, boolean, boolean>
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
+
index
- +
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, boolean, boolean> | StringFilterFunction<EntityT>
The string to get the index from. This can either be a string, a reference to a field or another filter function.
+substr: string | Field<EntityT, boolean, boolean> | StringFilterFunction<EntityT>
The substring to get the index for. This can either be a string, a reference to a field or another filter function.
+
Returns NumberFilterFunction<EntityT>
The newly created filter function
+
is
Type parameters
EntityT: EntityBase<EntityT>
Parameters
filterable: Filterable<EntityT, any>
Returns filterable is BooleanFilterFunction<EntityT>
is
- +
Checks if the data contains a collection result.
+Parameters
data: any
Response of the OData v4 service
+
Returns boolean
+true, if the data is a collection result
is
Parameters
val: any
Returns val is ComplexTypeNamespace<any>
is
Parameters
destination: any
Returns destination is Destination
is
Parameters
destination: any
Returns destination is DestinationNameAndJwt
is
- +
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 EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4
Whether the given value is of type EdmTypeShared
+
is
Type parameters
T: EntityBase<T>
FieldT: FieldType
Parameters
filterable: Filterable<T, any>
Returns filterable is Filter<T, FieldT>
is
- +
hidden
+Type parameters
EntityT: EntityBase<EntityT>
Parameters
filterable: Filterable<EntityT, any>
Returns filterable is FilterLambdaExpression<EntityT>
is
Type parameters
EntityT: EntityBase<EntityT>
LinkedT: EntityBase<LinkedT>
Parameters
filterable: Filterable<EntityT, any>
Returns filterable is FilterLink<EntityT, LinkedT>
is
Type parameters
T: EntityBase<T>
Parameters
filterable: Filterable<T, any>
Returns filterable is FilterList<T>
is
Parameters
httpCode: number
Returns boolean
is
- +
Compare two decoded JWTs based on their
+tenantIds.Parameters
userTokenPayload: JwtPayload
User JWT payload.
+providerTokenPayload: JwtPayload
Provider JWT payload.
+
Returns boolean
Whether the tenant is identical.
+
is
- +
Checks if the property with name key of the entity is a navigation property.
+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.
+
is
- +
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, boolean, boolean>
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
+
is
- +
Convenience function to check whether a given EDM type is of type OrderableEdmType.
+Parameters
edmType: EdmTypeCommon | ExclusiveEdmTypeV2 | ExclusiveEdmTypeV4
Literal EDM type string to check.
+
Returns boolean
Whether the given
+edmTypeis of type OrderableEdmType.
is
Type parameters
T: EntityBase<T>
Parameters
filterable: Filterable<T, any>
Returns filterable is UnaryFilter<T>
is
is
Parameters
config: any
Returns config is WithETag
issuer
- +
Get the issuer URL of a decoded JWT.
+Parameters
decodedToken: JwtPayload
Token to read the issuer URL from.
+
Returns string | undefined
The issuer URL if available.
+
jwt
- +
Returns a jwt bearer token that can be used to call the given service. +The token is fetched via a JWT bearer token grant using the user token + client credentials.
+Throws an error if there is no instance of the given service type or the XSUAA service, or if the request to the XSUAA service fails.
+Parameters
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 jwt bearer token.
+
jwt
Parameters
tokenServiceUrlOrXsuaaServiceCredentials: string | XsuaaServiceCredentials
The URL of the token service or the credentials of a XSUAA service instance.
+clientCredentials: ClientCredentials
The credentials (client_id, client_secret) of the target XSUAA service instance.
+userJwt: string
The JWT of the user on whose behalf the request is executed.
+Optional options: ResilienceOptions
Options to use by retrieving access token.
+
Returns Promise<ClientCredentialsResponse>
A promise resolving to the response of the XSUAA service.
+
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, boolean, boolean> | StringFilterFunction<EntityT>
The string to compute the length for. This can either be a string, a reference to a field or another filter function.
+
Returns NumberFilterFunction<EntityT>
The newly created filter function
+
matches
- +
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, boolean, boolean> | StringFilterFunction<EntityT>
The string to get the index from. This can either be a string, a reference to a field or another filter function.
+regex: string
The pattern to test against. This should be a regular expression as a string.
+
Returns BooleanFilterFunction<EntityT>
The newly created filter function
+
max
- +
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
+
merge
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.
+
min
- +
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 | Field<EntityT, boolean, boolean>
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 | Field<EntityT, boolean, boolean>
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
+
no
Parameters
destination: Destination | DestinationNameAndJwt
Returns string
Const non
Parameters
target: any
propertyKey: string
Returns void
not
- +
Negate a filter.
+Type parameters
EntityT: EntityBase<EntityT>
Parameters
filter: Filterable<EntityT, any>
The filter to negate.
+
Returns UnaryFilter<EntityT>
The negated filter.
+
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
- +
Combine Filterables with logical
+orto create a FilterList.Example:
+
+Entity.requestBuilder()
.getAll()
.filter(or(filterExp1, filterExp2)); +Type parameters
EntityT: EntityBase<EntityT>
Type of the entity filter on.
+
Parameters
expressions: Filterable<EntityT, any>[]
Filterables to be combined with logical
+or
Returns FilterList<EntityT>
The newly created FilterList
+ Type parameters
EntityT: EntityBase<EntityT>
Parameters
Rest ...expressions: Filterable<EntityT, any>[]
Returns FilterList<EntityT>
parse
- +
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.
+
parse
- +
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.
+
parse
- +
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.
+
parse
- +
Parse the HTTP code of response.
+Parameters
response: string
String representation of the response.
+
Returns number
The HTTP code.
+
parse
- +
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
+undefinedif the parsing failed.
parse
- +
Parse the body and http code of a batch sub response.
+Parameters
response: string
A batch sub response.
+
Returns ResponseData
The parsed response.s
+
prepend
Parameters
param: string
Returns string
proxy
- +
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. +All additional options are forwarded to tls.connect and net.connect see https://github.com/TooTallNate/node-https-proxy-agent#new-httpsproxyagentobject-options
+Parameters
destination: Destination
Destination containing the proxy configurations
+Optional options: AgentOptions
Additional options for the agent
+
Returns HttpAgentConfig | HttpsAgentConfig
The http(s)-agent containing the proxy configuration
+
proxy
Returns HostAndPort
proxy
- +
Determines the proxy strategy. If noProxy is set the ProxyConfiguration in the destination is omitted. +For onPremProxy or internetProxy the connectivity service or environment 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.
+
read
Parameters
jwtPayload: JwtPayload
property: string
Returns any
refresh
Parameters
tokenServiceUrlOrXsuaaServiceCredentials: string | XsuaaServiceCredentials
The URL of the token service or the credentials of a XSUAA service instance.
+clientCredentials: ClientCredentials
The credentials (client_id, client_secret) of 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.
+
replace
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.
+
resolve
- +
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
Returns Service
A Service instance.
+
retrieve
- +
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, boolean, boolean> | 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
+
sanitize
- +
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.
+
search
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 | Field<EntityT, boolean, boolean>
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
+
seconds
serialize
- +
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.
+
serialize
- +
Serialize change set to string.
+Parameters
changeSet: BatchChangeSet<any>
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 serialize
Parameters
fieldValue: any
complexTypeNameSpace: any
Returns any
Const serialize
Parameters
fieldValue: any
complexTypeNameSpace: any
Returns any
Const serialize
Parameters
entity: any
entityConstructor: Constructable<any, unknown>
Optional diff: boolean
Returns Record<string, any>
Const serialize
Parameters
entity: any
entityConstructor: Constructable<any, unknown>
Returns Record<string, any>
Const serialize
Parameters
entity: any
entityConstructor: Constructable<any, unknown>
Returns Record<string, any>
serialize
- +
Serialize a multipart request to string.
+Parameters
request: MethodRequestBuilder<any>
Optional options: BatchRequestSerializationOptions
Request serialization options.
+
Returns string
The serialized string representation of a multipart request, including the multipart headers.
+
service
- +
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 | JwtPayload; xsuaaCredentials?: XsuaaServiceCredentials }
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.
+
should
Parameters
requestConfig: HttpRequestConfig
options: HttpRequestOptions
Returns boolean
split
- +
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.
+
split
- +
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.
+
split
- +
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.
+
starts
- +
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, boolean, boolean> | 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, boolean, boolean> | 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
+
subscriber
- +
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
+nullif 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, boolean, boolean> | StringFilterFunction<EntityT>
The string to get a substring from. This can either be a string, a reference to a field or another filter function.
+pos: number | Field<EntityT, boolean, boolean> | NumberFilterFunction<EntityT>
The starting position of the substring. This can be either a number, a reference to a field or another filter function.
+Optional len: number | Field<EntityT, boolean, boolean> | NumberFilterFunction<EntityT>
The length of the substring. This can be either a number, a reference to a field or another filter function.
+
Returns StringFilterFunction<EntityT>
The newly created filter function
+
substring
- +
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, boolean, boolean> | 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, boolean, boolean> | 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
+
tenant
- +
Creates a tenant object from the JWT payload. +Throws an error if the property
+idis not present in the payload.Parameters
jwtPayload: JwtPayload
Token payload to get the tenant information from.
+
Returns Tenant
Representation of the tenant.
+
throw
Parameters
data: any
functionActionName: string
Returns never
time
- +
Converts the given time to seconds in positive numerical format.
+Parameters
time: Time
Time to convert.
+
Returns number
number Time in seconds.
+
to
Type parameters
Parameters
changeSet: BatchChangeSet<T>
Change set containing a collection of write operations.
+
Returns string | undefined
The serialized string representation of a change set.
+
to
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.
+
to
Parameters
request: GetAllRequestBuilder<Entity> | GetByKeyRequestBuilder<Entity>
The request builder of the retrieve request.
+
Returns string
The request body.
+
to
Parameters
request: GetAllRequestBuilderV4<EntityV4> | GetByKeyRequestBuilderV4<EntityV4>
The request builder of the retrieve request.
+
Returns string
The request body.
+
to
Type parameters
EntityT: EntityBase<EntityT>
LinkedEntityT: EntityBase<LinkedEntityT>
Parameters
filters: Filterable<EntityT, LinkedEntityT>[]
Returns Filterable<EntityT>[]
Const to
Parameters
value: string
Returns string
to
- +
Build a filter function to transform a string to lower case. Evaluates to string.
+Type parameters
EntityT: EntityBase<EntityT>
Parameters
str: string | Field<EntityT, boolean, boolean> | 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
+
to
Parameters
str: string
The string to be transformed.
+
Returns string
The transformed string.
+
to
Parameters
str: string
The string to be transformed.
+
Returns string
The transformed string.
+
to
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. +
to
Parameters
str: string
The string to be transformed.
+
Returns string
The transformed string.
+
to
Parameters
str: string
The string to be transformed.
+
Returns string
The transformed string.
+
to
Parameters
str: string
The string to be transformed.
+
Returns string
The transformed string.
+
to
- +
Build a filter function to transform a string to upper case. Evaluates to string.
+Type parameters
EntityT: EntityBase<EntityT>
Parameters
str: string | Field<EntityT, boolean, boolean> | 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
+
total
- +
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 | Field<EntityT, boolean, boolean>
The date to get the offset minutes for. This can either be a date (Moment) or a reference to a field.
+
Returns NumberFilterFunction<EntityT>
The newly created filter function
+
trim
- +
Build a filter function to trim whitespace from a string. Evaluates to string.
+Type parameters
EntityT: EntityBase<EntityT>
Parameters
str: string | Field<EntityT, boolean, boolean> | 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
+
url
- +
Builds part of the request config containing the URL and if needed proxy agents or normal http agents. +Considers the
+no_proxyenvironment variable together with thetargetUri.Parameters
targetUri: string
Used as baseURL in request config.
+
Returns Pick<HttpRequestConfig, "baseURL" | "httpAgent" | "httpsAgent" | "proxy">
HttpRequestConfig containing baseUrl and http(s) agents.
+
use
- +
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.
+
user
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.
+
user
- +
Creates a user object from the decoded JWT. +Throws an error if no
+idoruserNameproperty is present on the JWT payload.Parameters
jwtPayload: JwtPayload
Token payload to get the user from.
+
Returns User
Representation of the user.
+
user
Parameters
tokenServiceUrlOrXsuaaServiceCredentials: 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.
+
verify
- +
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<JwtPayload>
A Promise to the decoded and verified JWT.
+
verify
- +
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<JwtPayload>
A Promise to the decoded and verified JWT.
+
wrap
- +
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 | Field<EntityT, boolean, boolean>
The date to get the year for. This can either be a date (Moment) or a reference to a field.
+
Returns NumberFilterFunction<EntityT>
The newly created filter function
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Module @sap-cloud-sdk/generator
+
+
+
+ +
+ + + + +
+
@sap-cloud-sdk/generator
+ +This packages contains the generator to create 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 { generate } from '@sap-cloud-sdk/generator';
// initialize generator options based on what you want to do
const options: GeneratorOptions = initializeOptions();
// generate the client using the provided options
generate(options);
+For more detailed overview visit our generator documentation.
+ + + + +Support
+ +The recommended way to get in touch with us is to create an issue in our github repository.
+Select the issue category Bug, Feature or Question depending on the nature of your request.
+We try to provide fixes, features and answers as soon as possible.
We also monitor questions on StackOverflow and ansers.sap.com but prefer issues on github.
+ + +Contribute
+ +If you would like to contribute to the SAP Cloud SDK, please make yourself familiar with our contributing guidelines and follow the given instructions.
+ + +Links
+ + ++ +
-
+
- SAP Cloud SDK Documentation portal +
- SAP Cloud SDK Documentation portal - Getting started guide +
- SAP Cloud SDK Documentation portal - API documentation +
+ + + + +
License
+ +The SAP Cloud SDK is released under the Apache License Version 2.0.
+ +Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Index
Variables
default
Functions
generate
Parameters
options: GeneratorOptions
Returns Promise<void>
generate
Parameters
options: GeneratorOptions
Returns Promise<Project | undefined>
generate
Parameters
service: VdmServiceMetadata
project: Project
options: GeneratorOptions
Returns Promise<void>
transpile
Parameters
directories: Directory[]
Returns Promise<void[]>
Module @sap-cloud-sdk/openapi-generator
+
+
+
+
+
+ +
+ + + + +
@sap-cloud-sdk/openapi-generator
+ +This package contains the generator to create your own service module using a OpenAPI specification. +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.
+ + +Installation
+ +$ npm install @sap-cloud-sdk/openapi-generator
+Usage (CLI)
+ + + + + + +generate-openapi-client --input <input> --outputDir <outputDirectory>
+
+Generate OpenAPI client(s), that use the connectivity features of the SAP Cloud SDK for JavaScript/TypeScript.
+USAGE
$ generate-openapi-client --input <input> --outputDir <outputDirectory>
OPTIONS
-c, --config=<path/to/config.json>
Set the path to a file containing the options for generation instead of setting the options on the command line.
When combining the `config` option with other options on the command line, the command line options take precedence.
If a directory is passed, a `config.json` file is read from this directory.
-i, --input=<path/to/input>
(required) Specify the path to the directory or file containing the OpenAPI service definition(s) to generate
clients for. Accepts Swagger and OpenAPI definitions as YAML and JSON files. Throws an error if the path does not
exist.
-o, --outputDir=<path/to/output>
(required) Specify the path to the directory to generate the client(s) in. Each client is generated into a
subdirectory within the given output directory. Creates the directory if it does not exist. Customize subdirectory
naming through `--optionsPerService`.
-t, --transpile
Transpile the generated TypeScript code. When enabled a default `tsconfig.json` will be generated and used. It emits
`.js`, `.js.map`, `.d.ts` and `.d.ts.map` files. To configure transpilation set `--tsconfig`.
--clearOutputDir
Remove all files in the output directory before generation. Be cautious when using this option, as it really removes
EVERYTHING in the output directory.
--include=<glob/to/include>
Include files matching the given glob into the root of each generated client directory.
--optionsPerService=<path/to/options-per-service.json>
Set the path to a file containing the options per service. The configuration allows to set a `directoryName` and
`packageName` for every service, identified by the path to the original file. It also makes sure that names do not
change between generator runs. If a directory is passed, a `options-per-service.json` file is read/created in this
directory.
--overwrite
Allow to overwrite files, that already exist. This is useful, when running the generation regularly.
--packageJson
When enabled, a `package.json`, that specifies dependencies and scripts for transpilation and documentation
generation is generated.
--skipValidation
By default, the generation fails, when there are duplicate or invalid names for operations and/or path parameters
after transforming them to camel case. Set this to true to enable unique and valid name generation. The names will
then be generated by appending numbers and prepending prefixes.
--tsConfig=<path/to/tsconfig.json>
Replace the default `tsconfig.json` by passing a path to a custom config. By default, a `tsconfig.json` is only
generated, when transpilation is enabled (`--transpile`). If a directory is passed, a `tsconfig.json` file is read
from this directory.
--verbose
Turn on verbose logging.
EXAMPLES
// generate TypeScript clients from OpenAPI definitions in a directory
$ openapi-generator --input ./my-specs --outputDir ./clients
// generate a JavaScript client from a OpenAPI definition file
$ openapi-generator --input ./my-spec.yaml --outputDir ./client --transpile
+See code: dist/cli/index.ts
+ + + + + +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);
+For more detailed overview visit our generator documentation.
+ + + + +Support
+ +The recommended way to get in touch with us is to create an issue in our github repository.
+Select the issue category Bug, Feature or Question depending on the nature of your request.
+We try to provide fixes, features and answers as soon as possible.
We also monitor questions on StackOverflow and ansers.sap.com but prefer issues on github.
+ + +Contribute
+ +If you would like to contribute to the SAP Cloud SDK, please make yourself familiar with our contributing guidelines and follow the given instructions.
+ + +Links
+ + ++ +
-
+
- SAP Cloud SDK Documentation portal +
- SAP Cloud SDK Documentation portal - Getting started guide +
- SAP Cloud SDK Documentation portal - API documentation +
+ + + + +
License
+ +The SAP Cloud SDK is released under the Apache License Version 2.0.
+ +Index
Interfaces
Functions
Functions
generate
- +
Main entry point for the OpenAPI client generation. +Generates models and API files.
+Parameters
options: GeneratorOptions
Options to configure generation.
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Returns Promise<void>
Module @sap-cloud-sdk/test-util
+
+
+
+ +
+ + + + +
@sap-cloud-sdk/test-util
+ +This package 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"
}
]
}
+Support
+ +The recommended way to get in touch with us is to create an issue in our github repository.
+Select the issue category Bug, Feature or Question depending on the nature of your request.
+We try to provide fixes, features and answers as soon as possible.
We also monitor questions on StackOverflow and ansers.sap.com but prefer issues on github.
+ + +Contribute
+ +If you would like to contribute to the SAP Cloud SDK, please make yourself familiar with our contributing guidelines and follow the given instructions.
+ + +Links
+ + ++ +
-
+
- SAP Cloud SDK Documentation portal +
- SAP Cloud SDK Documentation portal - Getting started guide +
- SAP Cloud SDK Documentation portal - API documentation +
+ + + + +
License
+ +The SAP Cloud SDK is released under the Apache License Version 2.0.
+ +Index
Functions
get
- +
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
+
get
- +
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
+
mock
- +
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
mock
- +
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 variableOptional options: GetTestDestinationOptions
References to the
+systems.jsonandcredentials.jsonfiles
Returns void
set
- +
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
unmock
- +
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
unmock
- +
Removes a destination with the given name from the destinations environment variable. If the given destination name is not found calling this function has no effect. +This function should be called to invert the behavior of mockTestDestination() and setTestDestination().
+Parameters
name: string
Name of the mocked destination to remove
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Returns void
Module @sap-cloud-sdk/util
+
+
+
+ +
+ + + + +
@sap-cloud-sdk/util
+ +This package 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');
+Support
+ +The recommended way to get in touch with us is to create an issue in our github repository.
+Select the issue category Bug, Feature or Question depending on the nature of your request.
+We try to provide fixes, features and answers as soon as possible.
We also monitor questions on StackOverflow and ansers.sap.com but prefer issues on github.
+ + +Contribute
+ +If you would like to contribute to the SAP Cloud SDK, please make yourself familiar with our contributing guidelines and follow the given instructions.
+ + +Links
+ + ++ +
-
+
- SAP Cloud SDK Documentation portal +
- SAP Cloud SDK Documentation portal - Getting started guide +
- SAP Cloud SDK Documentation portal - API documentation +
+ + + + +
License
+ +The SAP Cloud SDK is released under the Apache License Version 2.0.
+ +Index
Classes
Interfaces
Type aliases
Variables
Functions
- assoc
- assoc
Some - async
Pipe - camel
Case - caps
- check
Url Exists - code
Block - create
Logger - disable
Exception Logger - documentation
Block - enable
Exception Logger - encode
Base64 - equal
- equal
Arrays - equal
Objects - error
With Cause - exclude
- filter
Duplicates - filter
Duplicates Right - find
Project Root - finish
All - first
- flat
- flatten
- format
Json - get
Global Log Level - get
Logger - identity
- is
Error With Cause - is
Nullish - kebab
Case - 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
- remove
File Extension - rename
Keys - set
Global Log Level - set
Log Level - split
In Chunks - title
Format - to
Sanitized Object - trim
- trim
Left - trim
Right - unique
- unmute
Loggers - upper
Case Snake Case - variadic
Argument To Array - zip
Type aliases
Log
+
Npm log levels used for the SAP Cloud SDK logger.
+Map
Type parameters
T
OData
+
Denotes the OData version.
+Variables
VALUE_
cloud
+
Default logger for the SAP Cloud SDK for unhandled exceptions.
+kibana
+
Format for logging in Kibana.
+local
+
Format for local logging.
+unixEOL
+
Within all files generated by the SDK we use the unix style end of line delimiter.
+We do not consider if the generator is executed on windows or unix systems.
+It will always be \n to have consistent clients between operating systems.
webEOL
+
For request payloads, etc., it is convention to use the \r\n new line.
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 assoc
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
+nullnorundefined.Parameters
obj: T
The object on which to create the association.
+
Returns T
Const async
- +
Same as pipe but for asynchronous functions: +
+asyncPipe(func1, func2, ...funcN)(start)executes all functions in sequence awaiting the result and piping the response through in other wordsawait funcN(... await func2(await func1(start))...).Parameters
Rest ...fns: CallableFunction[]
A list of asynchronous functions to be executed in sequence.
+
Returns (start: any) => Promise<any>
The return value of the last function in the list.
+Parameters
start: any
Start value for the first function in the list.
+
Returns Promise<any>
camel
- +
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'
+
check
- +
Checks whether a URL is existing via a head request.
+Parameters
url: string
URL to be checked
+
Returns Promise<number>
promise - resolves if the URL exists
+
code
Parameters
strings: TemplateStringsArray
Strings in the tagged template. In the example above that would be ['Code with ', ' and more code;'].
+Rest ...args: any[]
Arguments in the tagged template. In the example above that would be the resolved value for
+arguments;
Returns string
A string formatted as code block.
+
create
- +
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.
+
disable
- +
Disable logging of exceptions. Enabled by default.
+Returns void
documentation
Parameters
strings: TemplateStringsArray
Strings in the tagged template. In the example above that would be ['Docs with ', ' and more content;'].
+Rest ...args: string[]
Arguments in the tagged template. In the example above that would be the resolved value for
+arguments;
Returns string
A string formatted as documentation block.
+
enable
- +
Enable logging of exceptions. Enabled by default.
+Returns void
encode
- +
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
equal
- +
hidden
+Type parameters
T
Parameters
arr1: T[]
arr2: T[]
Returns boolean
equal
- +
hidden
+Parameters
obj1: Record<string, any>
obj2: Record<string, any>
Returns boolean
error
Parameters
message: string
Error message.
+cause: Error
Original error, causing the new error.
+
Returns Error
A new error with the given cause.
+
Const exclude
- +
Create a shallow copy of the given object, that does not contain the given keys. +Non existing keys in the source object are ignored.
+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.
+
filter
- +
Filter an array by removing duplicates and keeping the left most occurrence. By default this compares by identity.
+Type parameters
T
Parameters
arr: T[]
Array to remove duplicates from.
+comparator: (left: 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.
+
filter
- +
Filter an array by removing duplicates and keeping the right most occurrence. By default this compares by identity.
+Type parameters
T
Parameters
arr: T[]
Array to remove duplicates from.
+comparator: (left: 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.
+
find
Parameters
path: string
lastPath: string = ...
Returns string
finish
- +
Await all promises and resolve if non of them failed. +Reject if at least one of them was rejected, but only once all of them are finished. +Throws an error consisting of a list of reasons.
+Parameters
promises: Promise<any>[]
Promises to settle.
+Optional errorMessage: string
Message to use as introductory text of the error if an error occurs.
+
Returns Promise<void>
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.
+
format
- +
Convert a JSON object to a string using formatting in line with the prettier with indentation and new line at the end.
+Parameters
json: any
Object to be stringified
+
Returns string
The JSON object as string.
+
get
Returns string | undefined
get
- +
Get logger for a given message context, if available.
+Parameters
Optional messageContext: string
A key for the message context of all messages produced by the logger
+
Returns Logger | undefined
The logger for the given messageContext if it was created before
+
Const identity
- +
Identity function
+Type parameters
T
Parameters
argument: T
Any object
+
Returns T
the given argument without doing something
+
is
- +
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.
+
is
- +
Checks whether a value is either
+nullorundefined.Parameters
val: any
Value to check.
+
Returns val is undefined | null
+truefornullorundefined,falseotherwise.
kebab
- +
Convert a string to kebab case. This format is used e. g. for file names.
+Parameters
str: string
The string to be transformed.
+
Returns string
The transformed string.
+
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.
merge
- +
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 Record<string, any>
-
+
- An object containing all keys from both objects, where entries present in the
rightobject are replaced. Note that the casing used byrightwill be used.
+
merge
- +
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 merge
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)oraifbisundefinedornull.
mute
- +
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 containing two arrays, where the first one includes all items where the given condition was met and the second one includes all items where it was not met.
+
pascal
- +
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.
+
pick
- +
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. +
pick
- +
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. +
pick
- +
Returns the value of an object based on the given key, independent of casing.
+Type parameters
T: Record<string, any>
Parameters
obj: undefined | T
Object to be searched for the given key.
+key: string
Key of the value to pick.
+
Returns any | undefined
The value of for the given key or
+undefined, if not available.
property
- +
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
+trueif the property chain leads to a truthy value,falseotherwise.
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
remove
- +
Remove file extension from a string, e.g. remove 'test.jpg' would return 'test'
+Parameters
fileName: string
File name to remove the file extension from.
+
Returns string
File name without extension.
+
Const rename
- +
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.
+
set
- +
Change the global log level of the container which will set default level for all active loggers. +E. g., to set the global log level call
+setGlobalLogLevel('debug').Parameters
level: LogLevel
The log level to set the global log level to.
+
Returns void
set
- +
Change the log level of a logger based on its message context. +E. g., to set the log level for the destination accessor module of the SDK to debug, simply call
+setLogLevel('debug', 'destination-accessor').Parameters
level: "" | LogLevel
level to set the logger to. Use an empty string '' as level to unset context level.
+Optional messageContextOrLogger: string | Logger
Message context of the logger to change the log level for or the logger itself
+
Returns void
split
- +
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.
+
title
- +
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.
+
to
- +
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.
+
trim
- +
Remove whitespace from the left side of a string.
+Parameters
string: string
String to trim.
+
Returns string
String without whitespace on the left side.
+
trim
- +
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 an array.
+Type parameters
T
Parameters
arr: T[]
Array that might contain duplicates.
+
Returns T[]
Array of unique items.
+
unmute
- +
Unmute all logger output created by the SAP Cloud SDK Logger. This also applies to future loggers created. Useful for tests.
+Returns void
upper
- +
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.
+
variadic
- +
We want to provide methods which accept a variable single number of elements and arrays. +The overloaded signature to achieve this is:
+
+function doSomething(array: T[])
function doSomething(...varArgs: T[])
function doSomething(first: undefined | T | T[], ...rest: T[]) {
//implementation
} +This wrapper methods makes it easy build an array from the input.
+Type parameters
T
Parameters
firstOrArray: undefined | T | T[]
Either an array, the first element of the var args or
+undefined, if no argument was given.rest: T[]
Second to last element, if var args were used, empty array, if the first argument is an array.
+
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])results in[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.
++Copyright Ⓒ 2021 SAP SE or an SAP affiliate company. All rights reserved.
Create OData request to execute a action or function import.
+