api/app.softwork.cikraft.api

Package-level declarations

Types

data class Auth(val accessToken: String, val tokenType: Auth.TokenType, val expiresIn: Int, val scope: String, val jti: String)

BuildAndDeployStatus

@Serializable

data class BuildAndDeployStatus(val metadata: Metadata? = null, val taskId: String, val status: BuildAndDeployStatus.Status)

Configuration

@Serializable

data class Configuration(val parameterKey: String, val parameterValue: String, val dataType: String)

Deferred

@Serializable

data class Deferred(val deferred: Deferred.DeferredUri)

IntegrationFlow

@Serializable

data class IntegrationFlow(val metadata: Metadata? = null, val id: String, val version: String, val packageId: String, val name: String, val description: String, val sender: String? = null, val receiver: String? = null, val createdBy: String? = null, val createdAt: Long? = null, val modifiedBy: String? = null, val modifiedAt: Long? = null, val artifactContent: String? = null, val configurations: Deferred? = null, val resources: Deferred? = null, val designGuidelineExecutionResults: Deferred? = null)

IntegrationPackage

@Serializable

data class IntegrationPackage(val metadata: Metadata? = null, val id: String, val name: String, val resourceId: String? = null, val description: String? = null, val shortText: String, val version: String? = null, val vendor: String? = null, val partnerContent: Boolean? = null, val updateAvailable: Boolean? = null, val mode: String? = null, val supportedPlatform: String? = null, val createdBy: String? = null, val creationDate: String? = null, val modifiedBy: String? = null, val modifiedDate: String? = null, val products: String? = null, val keywords: String? = null, val countries: String? = null, val industries: String? = null, val lineOfBusiness: String? = null, val packageContent: String? = null, val integrationDesigntimeArtifacts: Deferred? = null, val valueMappingDesigntimeArtifacts: Deferred? = null, val messageMappingDesigntimeArtifacts: Deferred? = null, val scriptCollectionDesigntimeArtifacts: Deferred? = null, val customTags: Deferred? = null)

LifeCycle

@Serializable

data class LifeCycle(val metadata: Metadata, val changedAt: String? = null, val changedBy: String? = null, val createdAt: String? = null, val createdBy: String? = null)

Metadata

@Serializable

data class Metadata(val type: String? = null, val id: String? = null, val uri: String? = null, val contentType: String? = null, val mediaSrc: String? = null, val editMedia: String? = null)

OAuth2Token

@Serializable

data class OAuth2Token(val accessToken: String, val tokenType: String, val expiresIn: Long? = null, val refreshToken: String? = null, val scope: String? = null, val expired: Boolean = false, val jti: String? = null)

OdataError

@Serializable

data class OdataError(val error: OdataError.ErrorDetails) : Throwable

Platform

@Serializable

enum Platform : Enum<Platform>

Resource

@Serializable

data class Resource(val name: String, val resourceType: String, val referencedResourceType: String, val resourceContent: String)

ResponseWrapper

@Serializable

data class ResponseWrapper<T : Any>(val d: T)

ResultsWrapper

@Serializable

data class ResultsWrapper<T : Any>(val results: List<T>)

Functions

createIntegrationFlow

suspend fun HttpClient.createIntegrationFlow(integrationFlow: IntegrationFlow.New): IntegrationFlow

createIntegrationPackage

suspend fun HttpClient.createIntegrationPackage(integrationPackage: IntegrationPackage.New, builder: suspend HttpRequestBuilder.() -> Unit = {}): IntegrationPackage

deleteIntegrationFlow

suspend fun HttpClient.deleteIntegrationFlow(id: String, version: String = "Active")

deleteIntegrationPackage

suspend fun HttpClient.deleteIntegrationPackage(id: String, builder: suspend HttpRequestBuilder.() -> Unit = {})

deployIntegrationFlow

suspend fun HttpClient.deployIntegrationFlow(id: String, version: String = "Active", builder: suspend HttpRequestBuilder.() -> Unit = {}): String?

getAllIntegrationFlows

suspend fun HttpClient.getAllIntegrationFlows(packageID: String): List<IntegrationFlow>

getBodyOrNull

suspend fun <T : Any> HttpResponse.getBodyOrNull(bodySerializer: KSerializer<T>): T?

getBodyOrThrow

suspend fun <T : Any> HttpResponse.getBodyOrThrow(bodySerializer: KSerializer<T>): T

getBuildAndDeployStatus

suspend fun HttpClient.getBuildAndDeployStatus(taskId: String, builder: suspend HttpRequestBuilder.() -> Unit = {}): BuildAndDeployStatus

getCSRFToken

suspend fun HttpClient.getCSRFToken(): String

getIntegrationFlow

suspend fun HttpClient.getIntegrationFlow(id: String, version: String = "Active"): IntegrationFlow?

getIntegrationFlowAsZip

suspend fun HttpClient.getIntegrationFlowAsZip(id: String, version: String = "Active"): Source

getIntegrationPackage

suspend fun HttpClient.getIntegrationPackage(id: String, builder: suspend HttpRequestBuilder.() -> Unit = {}): IntegrationPackage?

getIntegrationPackages

suspend fun HttpClient.getIntegrationPackages(builder: suspend HttpRequestBuilder.() -> Unit = {}): List<IntegrationPackage>

getOauthToken

suspend fun HttpClient.getOauthToken(clientId: String, clientSecret: String, authServer: String, builder: suspend HttpRequestBuilder.() -> Unit = {}): String

getRuntimeToken

suspend fun HttpClient.getRuntimeToken(tokenUrl: String, clientId: String, clientSecret: String, builder: HttpRequestBuilder.() -> Unit = {}): OAuth2Token

sapciAuth

fun <T : HttpClientEngineConfig> HttpClientConfig<T>.sapciAuth(clientId: String, clientSecret: String, authServer: String)

sapciSerialization

fun Configuration.sapciSerialization()

setupRuntimeAuth

fun <T : HttpClientEngineConfig> HttpClientConfig<T>.setupRuntimeAuth(tokenUrl: String, clientId: String, clientSecret: String)

setupSapCIApiClient

fun <T : HttpClientEngineConfig> HttpClientConfig<T>.setupSapCIApiClient(clientId: String, clientSecret: String, apiServer: String, authServer: String)

undeployIntegrationFlow

suspend fun HttpClient.undeployIntegrationFlow(id: String, builder: suspend HttpRequestBuilder.() -> Unit = {})