@contiva/sap-integration-suite-client
Version:
SAP Cloud Platform Integration API Client
703 lines (702 loc) • 31.4 kB
TypeScript
/** MessageStoreEntry */
export interface ComSapHciApiMessageStoreEntry {
Id?: string | null;
MessageGuid?: string | null;
MessageStoreId?: string | null;
/**
* @format date-time
* @example "2020-04-13T15:51:04Z"
*/
Timestamp?: string | null;
HasAttachments?: boolean;
/** Attachments of MessageStoreEntries */
Attachments?: {
results?: ComSapHciApiMessageStoreEntryAttachment[];
};
/** Properties of MessageStoreEntries */
Properties?: {
results?: ComSapHciApiMessageStoreEntryProperty[];
};
}
/** MessageStoreEntryProperty */
export interface ComSapHciApiMessageStoreEntryProperty {
MessageId?: string | null;
Name?: string | null;
Value?: string | null;
}
/** MessageStoreEntryAttachmentProperty */
export interface ComSapHciApiMessageStoreEntryAttachmentProperty {
AttachmentId?: string | null;
Name?: string | null;
Value?: string | null;
}
/** MessageStoreEntryAttachment */
export interface ComSapHciApiMessageStoreEntryAttachment {
Id?: string | null;
Name?: string | null;
ContentType?: string | null;
Properties?: ComSapHciApiMessageStoreEntryAttachmentProperty[];
}
/** JmsBroker */
export interface ComSapHciApiJmsBroker {
Key?: string;
/**
* @format int64
* @example "42"
*/
Capacity?: number | string | null;
/**
* @format int64
* @example "42"
*/
MaxCapacity?: number | string | null;
/** @format int32 */
IsTransactedSessionsHigh?: number | null;
/** @format int32 */
IsConsumersHigh?: number | null;
/** @format int32 */
IsProducersHigh?: number | null;
/**
* @format int64
* @example "42"
*/
MaxQueueNumber?: number | string | null;
/**
* @format int64
* @example "42"
*/
QueueNumber?: number | string | null;
/**
* @format int64
* @example "42"
*/
CapacityOk?: number | string | null;
/**
* @format int64
* @example "42"
*/
CapacityWarning?: number | string | null;
/**
* @format int64
* @example "42"
*/
CapacityError?: number | string | null;
}
/** JmsBrokerQueueStates */
export interface ComSapHciApiJmsBrokerQueueStates {
Key?: string;
/**
* @format int64
* @example "42"
*/
Capacity?: number | string | null;
/**
* @format int64
* @example "42"
*/
MaxCapacity?: number | string | null;
/** @format int32 */
IsTransactedSessionsHigh?: number | null;
/** @format int32 */
IsConsumersHigh?: number | null;
/** @format int32 */
IsProducersHigh?: number | null;
/**
* @format int64
* @example "42"
*/
MaxQueueNumber?: number | string | null;
/**
* @format int64
* @example "42"
*/
QueueNumber?: number | string | null;
/**
* @format int64
* @example "42"
*/
CapacityOk?: number | string | null;
/**
* @format int64
* @example "42"
*/
CapacityWarning?: number | string | null;
/**
* @format int64
* @example "42"
*/
CapacityError?: number | string | null;
QueueStates?: {
Name?: string;
/**
* @format int64
* @example "0"
*/
State?: number | string | null;
};
}
/** NumberRanges */
export interface ComSapHciApiNumberRanges {
Name?: string;
Description?: string;
MaxValue?: string;
MinValue?: string;
Rotate?: string;
CurrentValue?: string;
FieldLength?: string;
DeployedBy?: string;
/**
* @format date-time
* @example "2021-04-13T15:51:04"
*/
DeployedOn?: string;
}
/** NumberRanges-create */
export interface ComSapHciApiNumberRangesPut {
Name?: string;
Description?: string;
MaxValue?: string;
MinValue?: string;
Rotate?: string;
CurrentValue?: string;
FieldLength?: string;
}
export interface OdataError {
error: OdataErrorMain;
}
export interface OdataErrorMain {
code: string;
message: {
lang: string;
value: string;
};
}
export interface OdataErrorDetail {
code: string;
message: string;
target?: string;
}
/** DataStores */
export interface ComSapHciApiDataStores {
DataStoreName?: string;
IntegrationFlow?: string;
Type?: string;
Visibility?: string;
/**
* @format int64
* @example "42"
*/
NumberOfMessages?: number;
/**
* @format int64
* @example "42"
*/
NumberOfOverdueMessages?: number;
}
/** DataStoreEntries */
export interface ComSapHciApiDataStoreEntries {
Id?: string;
DataStoreName?: string;
IntegrationFlow?: string;
Type?: string;
Status?: string;
Messageid?: string;
/**
* @format date-time
* @example "2021-04-13T15:51:04"
*/
DueAt?: string;
/**
* @format date-time
* @example "20121-04-13T15:51:04"
*/
CreatedAt?: string;
/**
* @format date-time
* @example "2021-04-13T15:51:04"
*/
RetainUntil?: string;
}
/** Variables */
export interface ComSapHciApiVariables {
VariableName?: string;
IntegrationFlow?: string;
Visibility?: string;
/**
* @format date-time
* @example "20121-04-13T15:51:04"
*/
UpdatedAt?: string;
/**
* @format date-time
* @example "2021-04-13T15:51:04"
*/
RetainUntil?: string;
}
export type QueryParamsType = Record<string | number, any>;
export type ResponseFormat = keyof Omit<Body, "body" | "bodyUsed">;
export interface FullRequestParams extends Omit<RequestInit, "body"> {
/** set parameter to `true` for call `securityWorker` for this request */
secure?: boolean;
/** request path */
path: string;
/** content type of request body */
type?: ContentType;
/** query params */
query?: QueryParamsType;
/** format of response (i.e. response.json() -> format: "json") */
format?: ResponseFormat;
/** request body */
body?: unknown;
/** base url */
baseUrl?: string;
/** request cancellation token */
cancelToken?: CancelToken;
}
export type RequestParams = Omit<FullRequestParams, "body" | "method" | "query" | "path">;
export interface ApiConfig<SecurityDataType = unknown> {
baseUrl?: string;
baseApiParams?: Omit<RequestParams, "baseUrl" | "cancelToken" | "signal">;
securityWorker?: (securityData: SecurityDataType | null) => Promise<RequestParams | void> | RequestParams | void;
customFetch?: typeof fetch;
}
export interface HttpResponse<D extends unknown, E extends unknown = unknown> extends Response {
data: D;
error: E;
}
type CancelToken = Symbol | string | number;
export declare enum ContentType {
Json = "application/json",
FormData = "multipart/form-data",
UrlEncoded = "application/x-www-form-urlencoded",
Text = "text/plain"
}
export declare class HttpClient<SecurityDataType = unknown> {
baseUrl: string;
private securityData;
private securityWorker?;
private abortControllers;
private customFetch;
private baseApiParams;
constructor(apiConfig?: ApiConfig<SecurityDataType>);
setSecurityData: (data: SecurityDataType | null) => void;
protected encodeQueryParam(key: string, value: any): string;
protected addQueryParam(query: QueryParamsType, key: string): string;
protected addArrayQueryParam(query: QueryParamsType, key: string): any;
protected toQueryString(rawQuery?: QueryParamsType): string;
protected addQueryParams(rawQuery?: QueryParamsType): string;
private contentFormatters;
protected mergeRequestParams(params1: RequestParams, params2?: RequestParams): RequestParams;
protected createAbortSignal: (cancelToken: CancelToken) => AbortSignal | undefined;
abortRequest: (cancelToken: CancelToken) => void;
request: <T = any, E = any>({ body, secure, path, type, query, format, baseUrl, cancelToken, ...params }: FullRequestParams) => Promise<HttpResponse<T, E>>;
}
/**
* @title Message Stores
* @version 1.0.0
* @baseUrl https://{Account Short Name}-tmn.{SSL Host}.{landscapehost}/api/v1
* @externalDocs https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/1aab5e9482f545539a7caae3e9887e4e.html
*
* Message store enables you get data for processed messages. You can access the stored message and analyze it at a later point in time. An integration flow stores messages in a message store through the Persist step for 90 days.
* Additionally, you can get information on the JMS resources available on the tenant as well as on those actually used by your integration flows.
* This API is implemented based on OData version 2 specification.
*/
export declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
/**
* @description You can use the following request to get the CSRF token for this session, which is required for write access via POST, PUT and DELETE operations. Copy the received X-CSRF-Token from the response header.<br> **In API sandbox this request is not relevant!**
*
* @tags CSRF Token Handling
* @name GetRoot
* @summary Get CSRF token.
* @request GET:/
* @secure
*/
getRoot: (params?: RequestParams) => Promise<HttpResponse<void, OdataError>>;
messageProcessingLogsMessageGuid: {
/**
* @description You can use the following request to get message store entries for the specified message Guid.<br> In API sandbox the integration flow '__Integration Flow with MessageStore - COMPLETED PROCESSING__' creates the corresponding message processing logs with message store entries.
*
* @tags Entries
* @name MessageStoreEntriesList
* @summary Get message store entries by message Guid.
* @request GET:/MessageProcessingLogs('{MessageGuid}')/MessageStoreEntries
* @secure
*/
messageStoreEntriesList: (messageGuid: string, params?: RequestParams) => Promise<HttpResponse<{
d?: {
results?: ComSapHciApiMessageStoreEntry[];
};
}, OdataError>>;
};
messageStoreEntriesMessageStoreEntryId: {
/**
* @description You can use the following request to get entry from message store for a specific entry Id.<br> In API sandbox the integration flow '__Integration Flow with MessageStore COMPLETED PROCESSING__' creates the corresponding message processing logs with message store entries.
*
* @tags Entries
* @name MessageStoreEntriesList
* @summary Get message store entry by Id.
* @request GET:/MessageStoreEntries('{MessageStoreEntryId}')
* @secure
*/
messageStoreEntriesList: (messageStoreEntryId: string, params?: RequestParams) => Promise<HttpResponse<{
d?: ComSapHciApiMessageStoreEntry;
}, OdataError>>;
/**
* @description You can use the following request to get message payload from message store for a specific entry Id.<br> In API sandbox the integration flow '__Integration Flow with MessageStore - COMPLETED PROCESSING__' creates the corresponding message processing logs with message store entries.
*
* @tags Entries
* @name ValueList
* @summary Get message payload from message store by entry Id.
* @request GET:/MessageStoreEntries('{MessageStoreEntryId}')/$value
* @secure
*/
valueList: (messageStoreEntryId: string, params?: RequestParams) => Promise<HttpResponse<void, OdataError>>;
/**
* @description You can use the following request to get all attachments from the message store entry with specified entry Id.<br> In API sandbox the integration flow '__Integration Flow with MessageStore COMPLETED PROCESSING__' creates the corresponding message processing logs with message store entries and attachments.
*
* @tags Entry Attachments
* @name AttachmentsList
* @summary Get attachments from message store by entry Id.
* @request GET:/MessageStoreEntries('{MessageStoreEntryId}')/Attachments
* @secure
*/
attachmentsList: (messageStoreEntryId: string, params?: RequestParams) => Promise<HttpResponse<{
d?: {
results?: ComSapHciApiMessageStoreEntryAttachment[];
};
}, OdataError>>;
/**
* @description You can use the following request to get all properties of message store entry for the specified entry Id.<br> In API sandbox the integration flow '__Integration Flow with MessageStore - COMPLETED PROCESSING__' creates the corresponding message processing logs with message store entries and properties.
*
* @tags Entry Properties
* @name PropertiesList
* @summary Get all properties of message store by entry Id
* @request GET:/MessageStoreEntries('{MessageStoreEntryId}')/Properties
* @secure
*/
propertiesList: (messageStoreEntryId: string, params?: RequestParams) => Promise<HttpResponse<{
d?: {
results?: ComSapHciApiMessageStoreEntryProperty[];
};
}, OdataError>>;
};
messageStoreEntryAttachmentsMessageStoreEntryAttachmentId: {
/**
* @description You can use the following request to get the attachment of a message store entry with specified attachment Id.<br> In API sandbox the integration flow '__Integration Flow with MessageStore - COMPLETED PROCESSING__' creates the corresponding message processing logs with message store entries and attachments.
*
* @tags Entry Attachments
* @name MessageStoreEntryAttachmentsList
* @summary Get attachment from message store by attachment Id.
* @request GET:/MessageStoreEntryAttachments('{MessageStoreEntryAttachmentId}')
* @secure
*/
messageStoreEntryAttachmentsList: (messageStoreEntryAttachmentId: string, params?: RequestParams) => Promise<HttpResponse<{
d?: ComSapHciApiMessageStoreEntryAttachment;
}, OdataError>>;
/**
* @description You can use the following request to get the attachment content of a message store entry with specified Id.<br> In API sandbox the integration flow '__Integration Flow with MessageStore - COMPLETED PROCESSING__' creates the corresponding message processing logs with message store entries and attachments.
*
* @tags Entry Attachments
* @name ValueList
* @summary Get attachment content from message store by attachment Id.
* @request GET:/MessageStoreEntryAttachments('{MessageStoreEntryAttachmentId}')/$value
* @secure
*/
valueList: (messageStoreEntryAttachmentId: string, params?: RequestParams) => Promise<HttpResponse<void, OdataError>>;
/**
* @description You can use the following request to get attachment properties of a message store entry for specified attachment Id.<br> In API sandbox the integration flow '__Integration Flow with MessageStore - COMPLETED PROCESSING__' creates the corresponding message processing logs with message store entries and attachments.
*
* @tags Entry Attachment Properties
* @name PropertiesList
* @summary Get attachment properties from message store by attachment Id.
* @request GET:/MessageStoreEntryAttachments('{MessageStoreEntryAttachmentId}')/Properties
* @secure
*/
propertiesList: (messageStoreEntryAttachmentId: string, params?: RequestParams) => Promise<HttpResponse<{
d?: {
results?: ComSapHciApiMessageStoreEntryAttachmentProperty[];
};
}, OdataError>>;
};
messageStoreEntryAttachmentPropertiesAttachmentIdMessageStoreEntryAttachmentIdNameName: {
/**
* @description You can use the following request to get attachment properties of a message store entry for specified attachment Id and property name.<br> In API sandbox the integration flow '__Integration Flow with MessageStore - COMPLETED PROCESSING__' creates the corresponding message processing logs with message store entries and attachments.
*
* @tags Entry Attachment Properties
* @name MessageStoreEntryAttachmentPropertiesAttachmentIdNameList
* @summary Get attachment properties from message store by attachment Id and property name.
* @request GET:/MessageStoreEntryAttachmentProperties(AttachmentId='{MessageStoreEntryAttachmentId}',Name='{Name}')
* @secure
*/
messageStoreEntryAttachmentPropertiesAttachmentIdNameList: (messageStoreEntryAttachmentId: string, name: string, params?: RequestParams) => Promise<HttpResponse<{
d?: ComSapHciApiMessageStoreEntryAttachmentProperty;
}, OdataError>>;
};
messageStoreEntryPropertiesMessageIdMessageStoreEntryIdNamePropertyName: {
/**
* @description You can use the following request to get property of message store entry for the specified entry Id and property name.<br> In API sandbox the integration flow '__Integration Flow with MessageStore - COMPLETED PROCESSING__' creates the corresponding message processing logs with message store entries and properties.
*
* @tags Entry Properties
* @name MessageStoreEntryPropertiesMessageIdNameList
* @summary Get property from message store by entry Id and property name.
* @request GET:/MessageStoreEntryProperties(MessageId='{MessageStoreEntryID}',Name='{PropertyName}')
* @secure
*/
messageStoreEntryPropertiesMessageIdNameList: (messageStoreEntryId: string, propertyName: string, params?: RequestParams) => Promise<HttpResponse<{
d?: ComSapHciApiMessageStoreEntryProperty;
}, OdataError>>;
};
jmsBrokersBroker1: {
/**
* @description You can use the following request to get information on the JMS resources available on the tenant as well as on those actually used by your integration flows.<br> Additional information about response values for some attributes: * __IsTransactedSessionsHigh__: __0__ - enough transactions available __1__ - number of transactions exceeding the allowed limit * __IsConsumerHigh__: __0__ - enough consumer available __1__ - number of consumers exceeding the allowed limits * __IsProducersHigh__: __0__ - enough producers available __1__ - number of producers exceeding the allowed limit
*
* @tags JMS Resources
* @name JmsBrokersBroker1List
* @summary Get available resources of JMS queues.
* @request GET:/JmsBrokers('Broker1')
* @secure
*/
jmsBrokersBroker1List: (query?: {
/**
* Expand related entities.
* @uniqueItems true
*/
$expand?: ("QueueStates" | "InactiveQueues")[];
}, params?: RequestParams) => Promise<HttpResponse<ComSapHciApiJmsBrokerQueueStates, OdataError>>;
};
numberRanges: {
/**
* @description You can use the following request to get the Number Range Objects available on the tenant.<br> There are two Number Ranges defined in API sandbox: '__NumberRange1__' and '__NumberRange2__'
*
* @tags Number Ranges
* @name NumberRangesList
* @summary Get available Number Ranges.
* @request GET:/NumberRanges
* @secure
*/
numberRangesList: (params?: RequestParams) => Promise<HttpResponse<{
d?: {
results?: ComSapHciApiNumberRanges[];
};
}, OdataError>>;
/**
* @description You can use the following request to add a Number Range Object.<br> In API sandbox only read APIs could be tested. You need to configure an API endpoint for your account, where you have the required write permissions to update integration flows.
*
* @tags Number Ranges
* @name NumberRangesCreate
* @summary Add a Number Range Object.
* @request POST:/NumberRanges
* @secure
*/
numberRangesCreate: (NumberRanges: ComSapHciApiNumberRangesPut, params?: RequestParams) => Promise<HttpResponse<void, OdataError>>;
};
numberRangesObjectName: {
/**
* @description You can use the following request to get the Number Range Object by a name.<br> There are two Number Ranges defined in API sandbox: '__NumberRange1__' and '__NumberRange2__'
*
* @tags Number Ranges
* @name NumberRangesList
* @summary Get specific Number Range by it's name'.
* @request GET:/NumberRanges('{objectName}')
* @secure
*/
numberRangesList: (objectName: string, params?: RequestParams) => Promise<HttpResponse<ComSapHciApiNumberRanges, OdataError>>;
/**
* @description You can use the following request to update a Number Range Object.<br> In API sandbox only read APIs could be tested. You need to configure an API endpoint for your account, where you have the required write permissions to update integration flows.
*
* @tags Number Ranges
* @name NumberRangesUpdate
* @summary Update a Number Range Object.
* @request PUT:/NumberRanges('{objectName}')
* @secure
*/
numberRangesUpdate: (objectName: string, NumberRanges: ComSapHciApiNumberRangesPut, params?: RequestParams) => Promise<HttpResponse<void, OdataError>>;
/**
* @description You can use the following request to delete a Number Range Object.<br> In API sandbox only read APIs could be tested. You need to configure an API endpoint for your account, where you have the required write permissions to update integration flows.
*
* @tags Number Ranges
* @name NumberRangesDelete
* @summary Delete a Number Range Object.
* @request DELETE:/NumberRanges('{objectName}')
* @secure
*/
numberRangesDelete: (objectName: string, params?: RequestParams) => Promise<HttpResponse<void, OdataError>>;
};
dataStores: {
/**
* @description You can use the following request to get the Data Stores available on the tenant.<br>
*
* @tags Data Stores
* @name DataStoresList
* @summary Get available Data Stores.
* @request GET:/DataStores
* @secure
*/
dataStoresList: (query?: {
/**
* If this parameter is ```true``` only Data Stores with overdue messages are shown. If it is ```false``` or not available all Data Stores are shown.
* @uniqueItems true
*/
overdueonly?: ("true" | "false")[];
}, params?: RequestParams) => Promise<HttpResponse<{
d?: {
results?: ComSapHciApiDataStores[];
};
}, OdataError>>;
};
dataStoresDataStoreNameDataStoreNameIntegrationFlowIntegrationFlowIdTypeType: {
/**
* @description You can use the following request to get the Data Store by a name.<br>
*
* @tags Data Stores
* @name DataStoresDataStoreNameIntegrationFlowTypeList
* @summary Get specific Data Store by it's name'.
* @request GET:/DataStores(DataStoreName='{DataStoreName}',IntegrationFlow='{IntegrationFlowId}',Type='{Type}')
* @secure
*/
dataStoresDataStoreNameIntegrationFlowTypeList: (dataStoreName: string, integrationFlowId: string, type: string[], params?: RequestParams) => Promise<HttpResponse<ComSapHciApiDataStores, OdataError>>;
/**
* @description You can use the following request to delete a Data Store.<br> In API sandbox only read APIs could be tested. You need to configure an API endpoint for your account, where you have the required write permissions to delete Data Stores.
*
* @tags Data Stores
* @name DataStoresDataStoreNameIntegrationFlowTypeDelete
* @summary Delete a Data Store.
* @request DELETE:/DataStores(DataStoreName='{DataStoreName}',IntegrationFlow='{IntegrationFlowId}',Type='{Type}')
* @secure
*/
dataStoresDataStoreNameIntegrationFlowTypeDelete: (dataStoreName: string, integrationFlowId: string, type: string[], params?: RequestParams) => Promise<HttpResponse<void, OdataError>>;
/**
* @description You can use the following request to get al Data Store entries for a specific Data Store available on the tenant.<br>
*
* @tags Data Stores
* @name EntriesList
* @summary Get all Data Store entries for a specific Data Store.
* @request GET:/DataStores(DataStoreName='{DataStoreName}',IntegrationFlow='{IntegrationFlowId}',Type='{Type}')/Entries
* @secure
*/
entriesList: (dataStoreName: string, integrationFlowId: string, type: string[], query?: {
/**
* If this parameter is ```true``` only Data Store entries with overdue messages are shown. If it is ```false``` or not available all Data Store entries are shown.
* @uniqueItems true
*/
overdueonly?: ("true" | "false")[];
/**
* Shows all Data Store Entries with the mpl id
* @uniqueItems true
*/
messageid?: string[];
}, params?: RequestParams) => Promise<HttpResponse<{
d?: {
results?: ComSapHciApiDataStoreEntries[];
};
}, OdataError>>;
};
dataStoreEntries: {
/**
* @description You can use the following request to get all Data Store entries available on the tenant.<br>
*
* @tags Data Stores
* @name DataStoreEntriesList
* @summary Get all Data Store entries.
* @request GET:/DataStoreEntries
* @secure
*/
dataStoreEntriesList: (query?: {
/**
* If this parameter is ```true``` only Data Store entries with overdue messages are shown. If it is ```false``` or not available all Data Store entries are shown.
* @uniqueItems true
*/
overdueonly?: ("true" | "false")[];
/**
* Shows all Data Store Entries with the mpl id
* @uniqueItems true
*/
messageid?: string[];
}, params?: RequestParams) => Promise<HttpResponse<{
d?: {
results?: ComSapHciApiDataStoreEntries[];
};
}, OdataError>>;
};
dataStoreEntriesIdIdDataStoreNameDataStoreNameIntegrationFlowIntegrationFlowIdTypeType: {
/**
* @description You can use the following request to get a Data Store entry.<br>
*
* @tags Data Stores
* @name DataStoreEntriesIdDataStoreNameIntegrationFlowTypeList
* @summary Get specific Data Store entry by it's Id'.
* @request GET:/DataStoreEntries(Id='{Id}',DataStoreName='{DataStoreName}',IntegrationFlow='{IntegrationFlowId}',Type='{Type}')
* @secure
*/
dataStoreEntriesIdDataStoreNameIntegrationFlowTypeList: (id: string, dataStoreName: string, integrationFlowId: string, type: string[], params?: RequestParams) => Promise<HttpResponse<ComSapHciApiDataStores, OdataError>>;
/**
* @description You can use the following request to delete a Data Store entry.<br> In API sandbox only read APIs could be tested. You need to configure an API endpoint for your account, where you have the required write permissions to delete Data Stores.
*
* @tags Data Stores
* @name DataStoreEntriesIdDataStoreNameIntegrationFlowTypeDelete
* @summary Delete a Data Store entry.
* @request DELETE:/DataStoreEntries(Id='{Id}',DataStoreName='{DataStoreName}',IntegrationFlow='{IntegrationFlowId}',Type='{Type}')
* @secure
*/
dataStoreEntriesIdDataStoreNameIntegrationFlowTypeDelete: (id: string, dataStoreName: string, integrationFlowId: string, type: string[], params?: RequestParams) => Promise<HttpResponse<void, OdataError>>;
/**
* @description You can use the following request to download a Data Store entry content.<br>
*
* @tags Data Stores
* @name ValueList
* @summary Download content of a specific Data Store entry by it's Id'.
* @request GET:/DataStoreEntries(Id='{Id}',DataStoreName='{DataStoreName}',IntegrationFlow='{IntegrationFlowId}',Type='{Type}')/$value
* @secure
*/
valueList: (id: string, dataStoreName: string, integrationFlowId: string, type: string[], params?: RequestParams) => Promise<HttpResponse<void, OdataError>>;
};
variables: {
/**
* @description You can use the following request to get all Variables entries available on the tenant.<br>
*
* @tags Variables
* @name VariablesList
* @summary Get all Variables entries.
* @request GET:/Variables
* @secure
*/
variablesList: (params?: RequestParams) => Promise<HttpResponse<{
d?: {
results?: ComSapHciApiVariables[];
};
}, OdataError>>;
};
variablesVariableNameVariableNameIntegrationFlowIntegrationFlowId: {
/**
* @description You can use the following request to get the Variable by a name.<br>
*
* @tags Variables
* @name VariablesVariableNameIntegrationFlowList
* @summary Get specific Variable by it's name'.
* @request GET:/Variables(VariableName='{VariableName}',IntegrationFlow='{IntegrationFlowId}')
* @secure
*/
variablesVariableNameIntegrationFlowList: (variableName: string, integrationFlowId: string, params?: RequestParams) => Promise<HttpResponse<ComSapHciApiVariables, OdataError>>;
/**
* @description You can use the following request to delete a Variable.<br> In API sandbox only read APIs could be tested. You need to configure an API endpoint for your account, where you have the required write permissions to delete Variables.
*
* @tags Variables
* @name VariablesVariableNameIntegrationFlowDelete
* @summary Delete a Variable.
* @request DELETE:/Variables(VariableName='{VariableName}',IntegrationFlow='{IntegrationFlowId}')
* @secure
*/
variablesVariableNameIntegrationFlowDelete: (variableName: string, integrationFlowId: string, params?: RequestParams) => Promise<HttpResponse<void, OdataError>>;
/**
* @description You can use the following request to get the content of a Variable by a name.<br>
*
* @tags Variables
* @name ValueList
* @summary Downlaod Variable's content by it's name'.
* @request GET:/Variables(VariableName='{VariableName}',IntegrationFlow='{IntegrationFlowId}')/$value
* @secure
*/
valueList: (variableName: string, integrationFlowId: string, params?: RequestParams) => Promise<HttpResponse<void, OdataError>>;
};
}
export {};