@contiva/sap-integration-suite-client
Version:
SAP Cloud Platform Integration API Client
1,040 lines (1,039 loc) • 114 kB
TypeScript
/** IntegrationRuntimeArtifact */
export interface ComSapHciApiIntegrationRuntimeArtifact {
Id?: string | null;
Version?: string | null;
Name?: string | null;
Type?: string | null;
DeployedBy?: string | null;
/**
* @format date-time
* @example "2017-04-13T15:51:04"
*/
DeployedOn?: string | null;
Status?: string | null;
ErrorInformation?: ComSapHciApiRuntimeArtifactErrorInformation;
}
/** IntegrationRuntimeArtifactPlaceholder */
export interface ComSapHciApiIntegrationRuntimeArtifactPlaceholder {
BinaryFile?: string | null;
}
/** IntegrationRuntimeArtifact_Request */
export interface ComSapHciApiIntegrationRuntimeArtifactRequest {
Id?: string | null;
Version?: string | null;
Name?: string | null;
Type?: string | null;
}
/** RuntimeArtifactErrorInformation */
export interface ComSapHciApiRuntimeArtifactErrorInformation {
Id?: string | null;
}
/** IntegrationDesigntimeArtifact */
export interface ComSapHciApiIntegrationDesigntimeArtifact {
Id?: string | null;
Version?: string | null;
PackageId?: string | null;
Name?: string | null;
Description?: string | null;
/** @format base64url */
ArtifactContent?: string | null;
/** Collection of Configuration */
Configurations?: {
results?: ComSapHciApiConfiguration[];
};
/** Collection of Resource */
Resources?: {
results?: ComSapHciApiResource[];
};
}
/** IntegrationDesigntimeArtifact (for creation) */
export interface ComSapHciApiIntegrationDesigntimeArtifactCreate {
Name?: string;
Id?: string;
PackageId?: string;
/**
* @format base64url
* @example "integration flow zip content in base64-encoded format"
*/
ArtifactContent?: string | null;
}
/** IntegrationDesigntimeArtifact (for update) */
export interface ComSapHciApiIntegrationDesigntimeArtifactUpdate {
Name?: string;
/**
* @format base64url
* @example "integration flow zip content in base64-encoded format"
*/
ArtifactContent?: string | null;
}
/** MessageMappingDesigntimeArtifact */
export interface ComSapHciApiMessageMappingDesigntimeArtifact {
Id?: string | null;
Version?: string | null;
PackageId?: string | null;
Name?: string | null;
Description?: string | null;
/** @format base64url */
ArtifactContent?: string | null;
/** Collection of Resource */
Resources?: {
results?: ComSapHciApiResource[];
};
}
/** MessageMappingDesigntimeArtifact (for creation) */
export interface ComSapHciApiMessageMappingDesigntimeArtifactCreate {
Name?: string;
Id?: string;
PackageId?: string;
Description?: string;
/**
* @format base64url
* @example "integration flow zip content in base64-encoded format"
*/
ArtifactContent?: string | null;
}
/** MessageMappingDesigntimeArtifact (for update) */
export interface ComSapHciApiMessageMappingDesigntimeArtifactUpdate {
Name?: string;
Description?: string;
/**
* @format base64url
* @example "integration flow zip content in base64-encoded format"
*/
ArtifactContent?: string | null;
}
/** BuildAndDeployStatus */
export interface ComSapHciApiBuildAndDeployStatus {
d: {
__metadata: {
id: string;
uri: string;
type: string;
};
TaskId: string;
Status: string;
};
}
/** Configuration */
export interface ComSapHciApiConfiguration {
ParameterKey?: string;
ParameterValue?: string;
DataType?: string;
}
/** Configuration (for update) */
export interface ComSapHciApiConfigurationUpdate {
/** @example "new value" */
ParameterValue?: string;
/** @example "xsd:integer" */
DataType?: string;
}
/** Resource */
export interface ComSapHciApiResource {
/** @example "file name" */
Name?: string;
/** @example "edmx/groovy/jar/js/mmap/opmap/wsdl/xsd/xslt" */
ResourceType?: string;
/** @example "" */
ReferencedResourceType?: string | null;
/**
* @format base64url
* @example "resource in base64 encoded format"
*/
ResourceContent?: string | null;
}
/** Resource (for create) */
export interface ComSapHciApiResourceCreate {
/** @example "file name" */
Name?: string;
/** @example "edmx/groovy/jar/js/mmap/opmap/wsdl/xsd/xslt" */
ResourceType?: string;
/** @example "" */
ReferencedResourceType?: string | null;
/**
* @format base64url
* @example "resource in base64 encoded format"
*/
ResourceContent?: string | null;
}
/** Resource (for update) */
export interface ComSapHciApiResourceUpdate {
/**
* @format base64url
* @example "resource in base64 encoded format"
*/
ResourceContent?: string;
}
/** ServiceEndpoint */
export interface ComSapHciApiServiceEndpoint {
/** @example "string" */
Name?: string | null;
Id?: string;
Title?: string;
Version?: string;
Summary?: string;
Description?: string;
/**
* @format date-time
* @example "2017-04-13T15:51:04Z"
*/
LastUpdated?: string | null;
/** @example "AS2, AS4, ODATAV2, SOAP" */
Protocol?: string;
EntryPoints?: ComSapHciApiEntryPoint[];
ApiDefinitions?: ComSapHciApiDefinition[];
}
/** EntryPoint */
export interface ComSapHciApiEntryPoint {
Name?: string;
Url?: string;
/** @example "string" */
Type?: string | null;
/** @example "string" */
AdditionalInformation?: string | null;
}
/** APIDefinition */
export interface ComSapHciApiDefinition {
Url?: string;
Name?: string;
}
/** CustomTagsConfiguration */
export interface ComSapHciApiCustomTagsConfiguration {
customTagsConfiguration: {
tagName: string;
isMandatory: boolean;
}[];
}
/** CustomTagsConfiguration (for creation) */
export interface ComSapHciApiCustomTagsConfigurationCreate {
/**
* @format base64url
* @example "JSON representation of custom tags definition in base64-encoded format"
*/
customTagsConfiguration?: string | null;
}
/** IntegrationPackage */
export interface ComSapHciApiIntegrationPackage {
Id?: string;
Name?: string;
/** @example "string" */
Description?: string | null;
ShortText?: string;
/** @example "string" */
Version?: string | null;
/** @example "string" */
Vendor?: string | null;
/** @example "string" */
Mode?: string | null;
/** @example "SAP Cloud Integration or SAP Process Orchestration or SuccessFactors Integration Center" */
SupportedPlatform?: string | null;
/** @example "string" */
ModifiedBy?: string | null;
/** @example "string" */
CreationDate?: string | null;
/** @example "string" */
ModifiedDate?: string | null;
/** @example "string" */
CreatedBy?: string | null;
/** @example "string" */
Products?: string | null;
/** @example "string" */
Keywords?: string | null;
/** @example "string" */
Countries?: string | null;
/** @example "string" */
Industries?: string | null;
/** @example "string" */
LineOfBusiness?: string | null;
IntegrationDesigntimeArtifacts?: ComSapHciApiIntegrationDesigntimeArtifact[];
}
/** IntegrationPackage (for create) */
export interface ComSapHciApiIntegrationPackageCreate {
/** @example "string" */
Id: string | null;
Name?: string;
/** @example "string" */
Description?: string | null;
ShortText?: string;
/** @example "string" */
Version?: string | null;
/** @example "SAP Cloud Integration or SAP Process Orchestration or SuccessFactors Integration Center" */
SupportedPlatform?: string | null;
/** @example "string" */
Products?: string | null;
/** @example "string" */
Keywords?: string | null;
/** @example "string" */
Countries?: string | null;
/** @example "string" */
Industries?: string | null;
/** @example "string" */
LineOfBusiness?: string | null;
}
/** IntegrationPackage (for update) */
export interface ComSapHciApiIntegrationPackageUpdate {
Name?: string;
/** @example "string" */
Description?: string | null;
ShortText?: string;
/** @example "string" */
Version?: string | null;
/** @example "string" */
Vendor?: string | null;
/** @example "string" */
Mode?: string | null;
/** @example "SAP Cloud Integration or SAP Process Orchestration or SuccessFactors Integration Center" */
SupportedPlatform?: string | null;
/** @example "string" */
Products?: string | null;
/** @example "string" */
Keywords?: string | null;
/** @example "string" */
Countries?: string | null;
/** @example "string" */
Industries?: string | null;
/** @example "string" */
LineOfBusiness?: string | null;
}
export interface ComSapHciApiSandboxError {
code?: string;
message?: 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;
}
/** Custom Tags (for update) */
export interface ComSapHciApiCustomTagsUpdate {
/** @example "new value" */
Value?: string;
}
/** ValueMappingDesigntimeArtifact */
export interface ComSapHciApiValueMappingDesigntimeArtifact {
Id?: string;
Version?: string;
PackageId?: string;
Name?: string;
Description?: string;
ArtifactContent?: string;
}
/** ValueMappingDesigntimeArtifact (for creation) */
export interface ComSapHciApiValueMappingDesigntimeArtifactCreate {
Name?: string;
Id?: string;
PackageId?: string;
Description?: string;
/**
* @format base64url
* @example "integration flow zip content in base64-encoded format"
*/
ArtifactContent?: string | null;
}
/** ValMapSchema */
export interface ComSapHciApiValMapSchema {
SrcAgency?: string;
SrcId?: string;
TgtAgency?: string;
TgtId?: string;
State?: string | null;
/** ValMaps */
DefaultValMaps?: {
results?: ComSapHciApiValMaps[];
};
/** ValMaps */
ValMaps?: {
results?: ComSapHciApiValMaps[];
};
}
/** ValMaps */
export interface ComSapHciApiValMaps {
Id?: string;
/** Value */
Value?: {
results?: ComSapHciApiValue[];
};
}
/** Value */
export interface ComSapHciApiValue {
SrcValue?: string;
TgtValue?: string;
}
/** IntegrationAdapterDesigntimeArtifact */
export interface ComSapHciApiIntegrationAdapterDesigntimeArtifact {
Id?: string | null;
Version?: string | null;
PackageId?: string | null;
Name?: string | null;
/**
* @format base64url
* @example "integration adapter esa file content in base64-encoded format"
*/
ArtifactContent?: string | null;
}
/** IntegrationAdapterDesigntimeArtifact (for import) */
export interface ComSapHciApiIntegrationAdapterDesigntimeArtifactImport {
PackageId?: string;
/**
* @format base64url
* @example "integration adapter esa file content in base64-encoded format"
*/
ArtifactContent?: string | null;
}
/** MDIDeltaToken */
export interface ComSapHciApiMDIDeltaToken {
d: {
__metadata: {
id: string;
uri: string;
type: string;
};
Operation: string;
Entity: string;
Version: string;
DeltaToken: string;
LastUpdateTimestamp: string;
};
}
/** ScriptCollectionDesigntimeArtifact */
export interface ComSapHciApiScriptCollectionDesigntimeArtifact {
Id?: string | null;
Version?: string | null;
PackageId?: string | null;
Name?: string | null;
Description?: string | null;
/** @format base64url */
ArtifactContent?: string | null;
/** Collection of Resource */
Resources?: {
results?: ComSapHciApiResource[];
};
}
/** ScriptCollectionDesigntimeArtifact (for creation) */
export interface ComSapHciApiScriptCollectionDesigntimeArtifactCreate {
Name?: string;
Id?: string;
PackageId?: string;
/**
* @format base64url
* @example "script collection zip content in base64-encoded format"
*/
ArtifactContent?: string | null;
}
/** Script collection resource (for create) */
export interface ComSapHciApiScriptCollectionDesigntimeArtifactResourceCreate {
/** @example "file name" */
Name?: string;
/** @example "groovy/jar/js/" */
ResourceType?: string;
/** @example "" */
ReferencedResourceType?: string | null;
/**
* @format base64url
* @example "resource in base64 encoded format"
*/
ResourceContent?: string | null;
}
/** ScriptCollectionDesigntimeArtifact (for update) */
export interface ComSapHciApiScriptCollectionDesigntimeArtifactUpdate {
Name?: string;
/**
* @format base64url
* @example "script collection zip content in base64-encoded format"
*/
ArtifactContent?: string | null;
}
/** ScriptCollectionDesigntimeArtifact (for update) */
export interface ComSapHciApiDesignGuidelineExecutionResultsSkip {
GudelineId?: string;
/** true = skip, false = revert */
IsGuidelineSkipped?: boolean;
SkipReason?: string;
}
/** DesignGuidlineExecutionResult */
export interface ComSapHciApiDesignGuidlineExecutionResult {
ExecutionId?: string | null;
ArtifactVersion?: string | null;
ExecutionStatus?: string | null;
ExecutionTime?: string | null;
}
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 Integration Content
* @version 1.0.0
* @baseUrl https://{Account Short Name}-tmn.{SSL Host}.{Landscapehost}/api/v1
* @externalDocs https://help.sap.com/docs/SAP_INTEGRATION_SUITE/51ab953548be4459bfe8539ecaeee98d/d1679a80543f46509a7329243b595bdb.html
*
* Integration content enables you to read, update, deploy, or undeploy integration artifacts (such as integration flows) on a tenant.
* This API is implemented based on OData version 2 specification.
* If you like to request the OData API on your tenant, you need to know how to find out the address of the HTTP call. For more information, see [HTTP Calls and URL Components](https://help.sap.com/docs/SAP_INTEGRATION_SUITE/51ab953548be4459bfe8539ecaeee98d/ca75e12fc5904d96a038aef6c00db5fc.html).
* If you face problems using the API, you can create a ticket. Check out for the right support component on this page: [Support Components](https://help.sap.com/docs/SAP_INTEGRATION_SUITE/51ab953548be4459bfe8539ecaeee98d/bd2d883ae8ee4e2696038be7741d93d7.html).
*/
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>>;
copyIntegrationPackage: {
/**
* @description You can use the following request to copy an integration package from 'Discover' to 'Design' section. If the package already exists, either the existing package can be overwritten or a new package with a suffix for name and Id can be created. <br>For further details, refer to the SAP Help Portal documentation [OData API: Integration Content](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/d1679a80543f46509a7329243b595bdb.html) and to the following SAP Community blog [Remote OData APIs for Integration Flows](https://blogs.sap.com/2018/07/06/cloud-integration-remote-odata-apis-for-integration-flows/).<br> In API sandbox, only read APIs can be tested. You need to configure an API endpoint for your account, where you have the required write permissions to create an integration package.
*
* @tags Integration Package - Discover
* @name CopyIntegrationPackageCreate
* @summary Copy an integration package.
* @request POST:/CopyIntegrationPackage
* @secure
*/
copyIntegrationPackageCreate: (query: {
/**
* Id of integration package - enclosed in single quotes <br>
* Example: ```'ERPtoSuccessFactorsEmployeeCentralEmployeeandOrganizationalData'```.<br>
* The Id can be found in the package URL.
*/
Id: string;
/**
* If the package already exists, it can be overwritten by the copied package, or a new package could be created with a new suffix, which needs to be provided by query parameter 'Suffix'.<br>
* OVERWRITE_MERGE - With this mode, the package will be copied and overwritten to an existing/already copied package from Discover, would keep the configurations (of externalized parameters) intact for the existing/already copied package's artifacts.
* @uniqueItems true
*/
ImportMode?: ("'CREATE_COPY'" | "'OVERWRITE'" | "'OVERWRITE_MERGE'")[];
/**
* Suffix is required, if a package with the same name already exists and an additional copy of the same package should be created. The entered value must be enclosed in single quotes.<br>
* Example: Entered Suffix ```'ABC'``` creates a new package, where ```.ABC``` is added to the name and to the artifacts Ids.<br>
* Note: Only relevant for query parameter 'ImportMode' ```'CREATE_COPY'```.
*/
Suffix?: string;
}, params?: RequestParams) => Promise<HttpResponse<{
d?: ComSapHciApiIntegrationPackage;
}, OdataError>>;
};
integrationPackages: {
/**
* @description You can use the following request to get all integration packages.
*
* @tags Integration Packages - Design
* @name IntegrationPackagesList
* @summary Get all integration packages.
* @request GET:/IntegrationPackages
* @secure
*/
integrationPackagesList: (query?: {
/**
* Custom Tag property defined in the tenant settings. You can provide multiple values.<br>
* Example1: ```Author=Fred```
* Example2: ```Author=Fred|John```
*/
Author?: string;
/**
* Custom Tag property defined in the tenant settings. You can provide multiple values.<br>
* Example1: ```LoB=Sales```
* Example2: ```LoB=Sales|Marketing```
*/
LoB?: string;
/**
* Show only the first n items.
* @min 0
*/
$top?: number;
/**
* Skip the first n items.
* @min 0
*/
$skip?: number;
}, params?: RequestParams) => Promise<HttpResponse<{
value?: ComSapHciApiIntegrationPackage[];
}, OdataError>>;
/**
* @description You can use the following request to create/import an integration package.<br> In API sandbox, only read APIs can be tested. You need to configure an API endpoint for your account, where you have the required write permissions to create integration package.
*
* @tags Integration Packages - Design
* @name IntegrationPackagesCreate
* @summary Create/Import new integration package.
* @request POST:/IntegrationPackages
* @secure
*/
integrationPackagesCreate: (IntegrationPackage: ComSapHciApiIntegrationPackageCreate, query?: {
/**
* You can use the Overwrite parameter to overwrite an existing package.
* @uniqueItems true
*/
Overwrite?: ("true" | "false")[];
}, params?: RequestParams) => Promise<HttpResponse<ComSapHciApiIntegrationPackage, OdataError>>;
};
integrationPackagesId: {
/**
* @description You can use the following request to get an integration packages by Id.
*
* @tags Integration Packages - Design
* @name IntegrationPackagesList
* @summary Get integration package by ID
* @request GET:/IntegrationPackages('{Id}')
* @secure
*/
integrationPackagesList: (id: string, params?: RequestParams) => Promise<HttpResponse<ComSapHciApiIntegrationPackage, OdataError>>;
/**
* @description You can use the following request to update an existing integration package.<br> In API sandbox, only read APIs can be tested. You need to configure an API endpoint for your account, where you have the required write permissions to update integration package.
*
* @tags Integration Packages - Design
* @name IntegrationPackagesUpdate
* @summary Update integration package.
* @request PUT:/IntegrationPackages('{Id}')
* @secure
*/
integrationPackagesUpdate: (id: string, IntegrationPackage: ComSapHciApiIntegrationPackageUpdate, params?: RequestParams) => Promise<HttpResponse<void, OdataError>>;
/**
* @description You can use the following request to delete an existing integration package.<br> In API sandbox, only read APIs can be tested. You need to configure an API endpoint for your account, where you have the required write permissions to delete integration package.
*
* @tags Integration Packages - Design
* @name IntegrationPackagesDelete
* @summary Delete integration package.
* @request DELETE:/IntegrationPackages('{Id}')
* @secure
*/
integrationPackagesDelete: (id: string, params?: RequestParams) => Promise<HttpResponse<void, OdataError>>;
/**
* @description You can use the following request to download an integration package of as .zip file. Download fails if the package contains one or more artifacts in draft state.
*
* @tags Integration Packages - Design
* @name ValueList
* @summary Download integration package by ID
* @request GET:/IntegrationPackages('{Id}')/$value
* @secure
*/
valueList: (id: string, params?: RequestParams) => Promise<HttpResponse<File, OdataError>>;
/**
* @description You can use the following request to get all integration flows of an integration package by package Id.
*
* @tags Integration Packages - Design
* @name IntegrationDesigntimeArtifactsList
* @summary Get all integration flows of a package.
* @request GET:/IntegrationPackages('{Id}')/IntegrationDesigntimeArtifacts
* @secure
*/
integrationDesigntimeArtifactsList: (id: string, params?: RequestParams) => Promise<HttpResponse<{
value?: ComSapHciApiIntegrationDesigntimeArtifact[];
}, OdataError>>;
/**
* @description You can use the following request to get an integration flow of an integration package by package Id, integration flow and integration flow version.
*
* @tags Integration Packages - Design
* @name IntegrationDesigntimeArtifactsIdVersionList
* @summary Get an integration flow of a package.
* @request GET:/IntegrationPackages('{Id}')/IntegrationDesigntimeArtifacts(Id='{ArtifactId}',Version='{ArtifactVersion}')
* @secure
*/
integrationDesigntimeArtifactsIdVersionList: (id: string, artifactId: string, artifactVersion: string, params?: RequestParams) => Promise<HttpResponse<ComSapHciApiIntegrationDesigntimeArtifact, OdataError>>;
/**
* @description You can use the following request to get all message mappings of an integration package by package Id.
*
* @tags Integration Packages - Design
* @name MessageMappingDesigntimeArtifactsList
* @summary Get all message mappings of an integration package.
* @request GET:/IntegrationPackages('{Id}')/MessageMappingDesigntimeArtifacts
* @secure
*/
messageMappingDesigntimeArtifactsList: (id: string, query?: {
/**
* Select properties to be returned.
* @uniqueItems true
*/
$select?: ("Id" | "Version" | "PackageId" | "Name" | "Description" | "ArtifactContent")[];
}, params?: RequestParams) => Promise<HttpResponse<{
value?: ComSapHciApiMessageMappingDesigntimeArtifact[];
}, OdataError>>;
/**
* @description Use the following request to get a message mapping of an integration package by package Id, message mapping Id, and message mapping version.
*
* @tags Integration Packages - Design
* @name MessageMappingDesigntimeArtifactsIdVersionList
* @summary Get message mapping of an integration package.
* @request GET:/IntegrationPackages('{Id}')/MessageMappingDesigntimeArtifacts(Id='{ArtifactId}',Version='{ArtifactVersion}')
* @secure
*/
messageMappingDesigntimeArtifactsIdVersionList: (id: string, artifactId: string, artifactVersion: string, query?: {
/**
* Select properties to be returned.
* @uniqueItems true
*/
$select?: ("Id" | "Version" | "PackageId" | "Name" | "Description" | "ArtifactContent")[];
}, params?: RequestParams) => Promise<HttpResponse<{
value?: ComSapHciApiMessageMappingDesigntimeArtifact[];
}, OdataError>>;
/**
* @description You can use the following request to get all value mappings of an integration package by package Id.
*
* @tags Integration Packages - Design
* @name ValueMappingDesigntimeArtifactsList
* @summary Get all value mappings of a package.
* @request GET:/IntegrationPackages('{Id}')/ValueMappingDesigntimeArtifacts
* @secure
*/
valueMappingDesigntimeArtifactsList: (id: string, params?: RequestParams) => Promise<HttpResponse<{
value?: ComSapHciApiValueMappingDesigntimeArtifact[];
}, OdataError>>;
/**
* @description You can use the following request to get a value mapping of an integration package by package Id, valuen mapping and value mapping version.
*
* @tags Integration Packages - Design
* @name ValueMappingDesigntimeArtifactsIdVersionList
* @summary Get a value mapping of a package.
* @request GET:/IntegrationPackages('{Id}')/ValueMappingDesigntimeArtifacts(Id='{ArtifactId}',Version='{ArtifactVersion}')
* @secure
*/
valueMappingDesigntimeArtifactsIdVersionList: (id: string, artifactId: string, artifactVersion: string, params?: RequestParams) => Promise<HttpResponse<ComSapHciApiValueMappingDesigntimeArtifact, OdataError>>;
/**
* @description You can use the following request to get all script collections of an integration package by package Id.
*
* @tags Integration Packages - Design
* @name ScriptCollectionDesigntimeArtifactsList
* @summary Get all script collections of a package.
* @request GET:/IntegrationPackages('{Id}')/ScriptCollectionDesigntimeArtifacts
* @secure
*/
scriptCollectionDesigntimeArtifactsList: (id: string, params?: RequestParams) => Promise<HttpResponse<{
value?: ComSapHciApiScriptCollectionDesigntimeArtifact[];
}, OdataError>>;
/**
* @description You can use the following request to get script collection of an integration package by package Id, script collection Id and script collection version.
*
* @tags Integration Packages - Design
* @name ScriptCollectionDesigntimeArtifactsIdVersionList
* @summary Get a script collection of a package.
* @request GET:/IntegrationPackages('{Id}')/ScriptCollectionDesigntimeArtifacts(Id='{ScriptCollectionArtifactID}',Version='{ArtifactVersion}')
* @secure
*/
scriptCollectionDesigntimeArtifactsIdVersionList: (id: string, artifactId: string, artifactVersion: string, scriptCollectionArtifactId: string, params?: RequestParams) => Promise<HttpResponse<ComSapHciApiScriptCollectionDesigntimeArtifact, OdataError>>;
/**
* @description You can use the following request to get custom tags of an integration package by package Id.
*
* @tags Integration Packages - Design
* @name CustomTagsList
* @summary Get Custom Tags of a package.
* @request GET:/IntegrationPackages('{Id}')/CustomTags
* @secure
*/
customTagsList: (id: string, query?: {
/**
* Show only the first n items.
* @min 0
*/
$top?: number;
/**
* Skip the first n items.
* @min 0
*/
$skip?: number;
/**
* Order items by property values, see [Orderby System Query Option](https://www.odata.org/documentation/odata-version-2-0/uri-conventions/)
* @uniqueItems true
*/
$orderby?: ("Name" | "Name desc")[];
}, params?: RequestParams) => Promise<HttpResponse<void, OdataError>>;
/**
* @description You can use the following request to update a Custom Tag.<br> In API sandbox, only read APIs can be tested. You need to configure an API endpoint for your account, where you have the required permissions to update Custom Tags.
*
* @tags Integration Packages - Design
* @name LinksCustomTagsUpdate
* @summary Update a Custom Tag.
* @request PUT:/IntegrationPackages('{Id}')/$links/CustomTags('{Name}')
* @secure
*/
linksCustomTagsUpdate: (id: string, name: string, Value: ComSapHciApiCustomTagsUpdate, params?: RequestParams) => Promise<HttpResponse<void, OdataError>>;
};
customTagConfigurationsCustomTags: {
/**
* @description You can use the following request to get all custom tags.
*
* @tags Custom Tags Configuration
* @name ValueList
* @summary Get all custom tags.
* @request GET:/CustomTagConfigurations('CustomTags')/$value
* @secure
*/
valueList: (params?: RequestParams) => Promise<HttpResponse<{
value?: ComSapHciApiCustomTagsConfiguration[];
}, OdataError>>;
};
customTagConfigurations: {
/**
* @description You can use the following request to create or upload custom tags configuration.<br> In API sandbox, only read APIs can be tested. You need to configure an API endpoint for your account, where you have the required write permissions to create integration flows.
*
* @tags Custom Tags Configuration
* @name CustomTagConfigurationsCreate
* @summary Create/upload custom tags configuration.
* @request POST:/CustomTagConfigurations
* @secure
*/
customTagConfigurationsCreate: (CustomTagConfiguration: ComSapHciApiCustomTagsConfigurationCreate, params?: RequestParams) => Promise<HttpResponse<void, OdataError>>;
};
integrationDesigntimeArtifacts: {
/**
* @description You can use the following request to create or upload an integration flow.<br>For further details, refer to the SAP Help Portal documentation [OData API: Integration Content](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/d1679a80543f46509a7329243b595bdb.html) and to the following SAP Community blog [Remote OData APIs for Integration Flows](https://blogs.sap.com/2018/07/06/cloud-integration-remote-odata-apis-for-integration-flows/).<br> In API sandbox, only read APIs can be tested. You need to configure an API endpoint for your account, where you have the required write permissions to create integration flows.
*
* @tags Integration Flow
* @name IntegrationDesigntimeArtifactsCreate
* @summary Create/upload an integration flow.
* @request POST:/IntegrationDesigntimeArtifacts
* @secure
*/
integrationDesigntimeArtifactsCreate: (IntegrationFlow: ComSapHciApiIntegrationDesigntimeArtifactCreate, params?: RequestParams) => Promise<HttpResponse<{
d?: ComSapHciApiIntegrationDesigntimeArtifact;
}, OdataError>>;
};
integrationDesigntimeArtifactsIdIdVersionVersion: {
/**
* @description You can use the following request to get an integration flow by Id and version.<br>For further details, refer to the SAP Help Portal documentation [OData API: Integration Content](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/d1679a80543f46509a7329243b595bdb.html) and to the following SAP Community blog [Remote OData APIs for Integration Flows](https://blogs.sap.com/2018/07/06/cloud-integration-remote-odata-apis-for-integration-flows/).<br> In API sandbox, the following integration flows with Id and version are available: * '__IntegrationFlow_FAILED_DEPLOYMENT__' with version '__1.0.0__' * '__IntegrationFlow_MessageStore_COMPLETED_PROCESSING__' with version '__1.0.0__' * '__IntegrationFlow_AdapterData_FAILED_PROCESSING__' with version '__1.0.0__' * '__IntegrationFlowWithConfiguration__' with version '__1.0.5__'
*
* @tags Integration Flow
* @name IntegrationDesigntimeArtifactsIdVersionList
* @summary Get an integration flow by Id and version.
* @request GET:/IntegrationDesigntimeArtifacts(Id='{Id}',Version='{Version}')
* @secure
*/
integrationDesigntimeArtifactsIdVersionList: (id: string, version: string, query?: {
/**
* Select properties to be returned.
* @uniqueItems true
*/
$select?: ("Name" | "Version" | "PackageId")[];
}, params?: RequestParams) => Promise<HttpResponse<{
d?: ComSapHciApiIntegrationDesigntimeArtifact;
}, OdataError>>;
/**
* @description You can use the following request to update an integration flow.<br> In API sandbox, only read APIs can be tested. You need to configure an API endpoint for your account, where you have the required write permissions to update integration flows.
*
* @tags Integration Flow
* @name IntegrationDesigntimeArtifactsIdVersionUpdate
* @summary Update an integration flow.
* @request PUT:/IntegrationDesigntimeArtifacts(Id='{Id}',Version='{Version}')
* @secure
*/
integrationDesigntimeArtifactsIdVersionUpdate: (id: string, version: string, IntegrationDesigntimeArtifact: ComSapHciApiIntegrationDesigntimeArtifactUpdate, params?: RequestParams) => Promise<HttpResponse<void, OdataError>>;
/**
* @description You can use the following request to delete an integration flow.<br>For further details, refer to the SAP Help Portal documentation [OData API: Integration Content](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/d1679a80543f46509a7329243b595bdb.html) and to the following SAP Community blog [Remote OData APIs for Integration Flows](https://blogs.sap.com/2018/07/06/cloud-integration-remote-odata-apis-for-integration-flows/).<br> In API sandbox, only read APIs can be tested. You need to configure an API endpoint for your account, where you have the required write permissions to delete integration flows.
*
* @tags Integration Flow
* @name IntegrationDesigntimeArtifactsIdVersionDelete
* @summary Delete an integration flow.
* @request DELETE:/IntegrationDesigntimeArtifacts(Id='{Id}',Version='{Version}')
* @secure
*/
integrationDesigntimeArtifactsIdVersionDelete: (id: string, version: string, params?: RequestParams) => Promise<HttpResponse<void, OdataError>>;
/**
* @description You can use the following request to download an integration flow as zip file. Integration flows of configure-only packages cannot be downloaded.<br>For further details, refer to the SAP Help Portal documentation [OData API: Integration Content](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/d1679a80543f46509a7329243b595bdb.html) and to the following SAP Community blog [Remote OData APIs for Integration Flows](https://blogs.sap.com/2018/07/06/cloud-integration-remote-odata-apis-for-integration-flows/).<br> In API sandbox the following integration flows with Id and version are available: * '__IntegrationFlow_FAILED_DEPLOYMENT__' with version '__1.0.0__' * '__IntegrationFlow_MessageStore_COMPLETED_PROCESSING__' with version '__1.0.0__' * '__IntegrationFlow_AdapterData_FAILED_PROCESSING__' with version '__1.0.0__' * '__IntegrationFlowWithConfiguration__' with version '__1.0.5__'
*
* @tags Integration Flow
* @name ValueList
* @summary Download an integration flow as zip file.
* @request GET:/IntegrationDesigntimeArtifacts(Id='{Id}',Version='{Version}')/$value
* @secure
*/
valueList: (id: string, version: string, params?: RequestParams) => Promise<HttpResponse<ArrayBuffer, OdataError>>;
/**
* @description You can use the following request to get the configuration parameters (key/value pairs) of an integration artifact by Id and version.<br>For further details, refer to the SAP Help Portal documentation [OData API: Integration Content](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/d1679a80543f46509a7329243b595bdb.html) and to the following SAP Community blog [Remote OData APIs for Integration Flows](https://blogs.sap.com/2018/07/06/cloud-integration-remote-odata-apis-for-integration-flows/).<br> In API sandbox, the following integration flow contains configuration parameters: '__IntegrationFlowWithConfiguration__' with version '__1.0.5__'
*
* @tags Configurations of Integration Flow
* @name ConfigurationsList
* @summary Get configurations of an integration flow by Id and version.
* @request GET:/IntegrationDesigntimeArtifacts(Id='{Id}',Version='{Version}')/Configurations
* @secure
*/
configurationsList: (id: string, version: string, query?: {
/**
* Returns a subset of the entries, which matches the filter condition.<br>
* Supported operators: ```eq``` and ```ne```<br>
* Supported string functions: ```substringof```, ```startswith``` and ```endswith```.<br>
* Example: ```substringof('Receiver_',ParameterKey) eq true```
*/
$filter?: string;
/**
* Select properties to be returned.
* @uniqueItems true
*/
$select?: ("ParameterKey" | "ParameterValue" | "DataType")[];
/**
* Order items by property values.
* @uniqueItems true
*/
$orderby?: ("ParameterKey" | "ParameterKey desc")[];
/**
* Response format can be JSON or XML.
* @uniqueItems true
* @default "json"
*/
$format?: ("json" | "xml")[];
}, params?: RequestParams) => Promise<HttpResponse<{
d?: {
results?: ComSapHciApiConfiguration[];
};
}, OdataError>>;
/**
* @description You can use the following request to get the number of configuration parameters (key/value pairs) for an integration artifact by Id and version.<br>For further details, refer to the SAP Help Portal documentation [OData API: Integration Content](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/d1679a80543f46509a7329243b595bdb.html) and to the following SAP Community blog [Remote OData APIs for Integration Flows](https://blogs.sap.com/2018/07/06/cloud-integration-remote-odata-apis-for-integration-flows/).<br> In API sandbox, the following integration flow contains configuration parameters: '__IntegrationFlowWithConfiguration__' with version '__1.0.5__'
*
* @tags Configurations of Integration Flow
* @name ConfigurationsCountList
* @summary Get number of configuration parameters.
* @request GET:/IntegrationDesigntimeArtifacts(Id='{Id}',Version='{Version}')/Configurations/$count
* @secure
*/
configurationsCountList: (id: string, version: string, query?: {
/**
* Returns a subset of the entries, which matches the filter condition.<br>
* Supported operators: ```eq``` and ```ne```<br>
* Supported string functions: ```substringof```, ```startswith``` and ```endswith```.<br>
* Example: ```substringof('Receiver_',ParameterKey) eq true```
*/
$filter?: string;
}, params?: RequestParams) => Promise<HttpResponse<void, OdataError>>;
/**
* @description You can use the following request to update the value for a configuration parameters of an integration flow.<br>For further details, refer to the SAP Help Portal documentation [OData API: Integration Content](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/d1679a80543f46509a7329243b595bdb.html) and to the following SAP Community blog [Remote OData APIs for Integration Flows](https://blogs.sap.com/2018/07/06/cloud-integration-remote-odata-apis-for-integration-flows/).<br> In API sandbox, only read APIs can be tested. You need to configure an API endpoint for your account, where you have the required write permissions for integration flows.You need to configure an API endpoint for your account, where you have the required write permissions to update configuration parameters of an integration flow.
*
* @tags Configurations of Integration Flow
* @name LinksConfigurationsUpdate
* @summary Update configuration parameter of an integration flow.
* @request PUT:/IntegrationDesigntimeArtifacts(Id='{Id}',Version='{Version}')/$links/Configurations('{ParameterKey}')
* @secure
*/
linksConfigurationsUpdate: (id: string, version: string, parameterKey: string, ConfigurationParameter: ComSapHciApiConfigurationUpdate, params?: RequestParams) => Promise<HttpResponse<void, OdataError>>;
/**
* @description You can use the following request to get all resources of an integration flow.<br>For further details, refer to the SAP Help Portal documentation [OData API: Integration Content](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/d1679a80543f46509a7329243b595bdb.html) and to the following SAP Community blog [Remote OData APIs for Integration Flows](https://blogs.sap.com/2018/07/06/cloud-integration-remote-odata-apis-for-integration-flows/).
*
* @tags Resources of Integration Flow
* @name ResourcesList
* @summary Get all resources of an integration flow.
* @request GET:/IntegrationDesigntimeArtifacts(Id='{Id}',Version='{Version}')/Resources
* @secure
*/
resourcesList: (id: string, version: string, query?: {
/**
* Returns a subset of the entries, which matches the filter condition.<br>
* Supported operators: ```eq``` and ```ne```<br>
* Supported string functions: ```substringof```, ```startswith``` and ```endswith```.<br>
* Example: ```substringof('wsdl',Name) eq true```
*/
$filter?: string;
/**
* Select properties to be returned.
* @uniqueItems true
*/
$select?: ("Name" | "ResourceType" | "ReferencedResourceType")[];
/**
* Order items by property values.
* @uniqueItems true
*/
$orderby?: ("Name" | "Name desc" | "ResourceType" | "ResourceType desc" | "Name,ResourceType" | "Name desc,ResourceType desc")[];
/**
* Response format can be JSON or XML.
* @uniqueItems true
* @default "json"
*/
$format?: ("json" | "xml")[];
}, params?: RequestParams) => Promise<HttpResponse<{
/** Collection of Resource */
d?: {
results?: ComSapHciApiResource[];
};
}, OdataError>>;
/**
* @description You can use the following request to add a resource to an integration flow.<br>For further details, refer to the SAP Help Portal documentation [OData API: Integration Content](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/d1679a80543f46509a7329243b595bdb.html) and to the following SAP Community blog [Remote OData APIs for Integration Flows](https://blogs.sap.com/2018/07/06/cloud-integration-remote-odata-apis-for-integration-flows/).<br> In API sandbox, only read APIs can be tested. You need to configure an API endpoint for your account, where you have the required write permissions to update integration flows.
*
* @tags Resources of Integration Flow
* @name ResourcesCreate
* @summary Add a Resource to an integration flow.
* @request POST:/IntegrationDesigntimeArtifacts(Id='{Id}',Version='{Version}')/Resources
* @secure
*/
resourcesCreate: (id: string, version: string, Resource: ComSapHciApiResourceCreate, params?: RequestParams) => Promise<HttpResponse<{
d?: ComSapHciApiResource;
}, OdataError>>;
/**
* @description You can use the following request to get the number of all resources for an integration flow.<br>For further details, refer to the SAP Help Portal documentation [OData API: Integration Content](https://help.sap.com/viewer/368c481cd6954bdfa5d0435479fd4eaf/Cloud/en-US/d1679a80543f46509a7329243b595bdb.html) and to the following SAP Community blog [Remote OData APIs for Integration Flows](https://blogs.sap.com/2018/07/06/cloud-integration-remote-odata-apis-for-integration-flows/).
*
* @tags Resources of Integration Flow
* @name ResourcesCountList
* @summary Get number of resource.
* @request GET:/IntegrationDesigntimeArtifacts(Id='{Id}',Version='{Version}')/Resources/$count
* @secure
*/
resourcesCountList: (id: string, version: string, query?: {
/**
* Returns a subset of the entries, which matches the filter condition.<br>
* Supported operators: ```eq``` and ```ne```<br>
* Supported string functions: ```substringof```, ```startswith``` and ```endswith```.<br>
* Example: ```substringof('wsdl',Name) eq true```
*/
$filter?: string;
}, params?: RequestParams) => Promise<HttpResponse<void, OdataError>>;
/**