Package app.ductape.sdk.api

Class ApiService

java.lang.Object

app.ductape.sdk.api.ApiService

Direct Known Subclasses:

ActionsService

public class ApiService
extends Object

App-action runtime façade: parity with TS ductape.api.run / .dispatch.

Constructor Summary

Constructors

Constructor	Description
ApiService(EnvType env, RequestContext auth)
ApiService(EnvType env, RequestContext auth, JobsService jobsService)
ApiService(RequestContext auth)
ApiService(RequestContext auth, ProductsService productsService, ProcessorApiService processorApiService, JobsService jobsService)

Method Summary

Modifier and Type	Method	Description
RequestContext	auth()
Map<String,Object>	dispatch(Map<String,Object> options)	TS actions.dispatch(data): schedule an action to run as a job.
Map<String,Object>	importApp(byte[] file, ImportService.DocType type, String version, String appId, boolean updateIfExists, boolean adminImport)	TS ductape.api.import: uploads Postman/OpenAPI collections for an app.
Map<String,Object>	run(Map<String,Object> options)	TS actions.run(data): immediate execution via the Ductape Processor.
void	setImportService(ImportService importService)	Wires the import service used by importApp(byte[], app.ductape.sdk.imports.ImportService.DocType, java.lang.String, java.lang.String, boolean, boolean).
void	setRuntimeDefaults(RuntimeDefaults runtimeDefaults)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ApiService

public ApiService(RequestContext auth)

ApiService

public ApiService(EnvType env,
 RequestContext auth)

ApiService

public ApiService(EnvType env,
 RequestContext auth,
 JobsService jobsService)

ApiService

public ApiService(RequestContext auth,
 ProductsService productsService,
 ProcessorApiService processorApiService,
 JobsService jobsService)

Method Details

auth

public RequestContext auth()

setRuntimeDefaults

public void setRuntimeDefaults(RuntimeDefaults runtimeDefaults)

setImportService

public void setImportService(ImportService importService)

Wires the import service used by importApp(byte[], app.ductape.sdk.imports.ImportService.DocType, java.lang.String, java.lang.String, boolean, boolean).

importApp

public Map<String,Object> importApp(byte[] file,
 ImportService.DocType type,
 String version,
 String appId,
 boolean updateIfExists,
 boolean adminImport)

TS ductape.api.import: uploads Postman/OpenAPI collections for an app. appId is required (pass appTag resolution via app().fetch first when needed).

run

public Map<String,Object> run(Map<String,Object> options)

TS actions.run(data): immediate execution via the Ductape Processor.

dispatch

public Map<String,Object> dispatch(Map<String,Object> options)

TS actions.dispatch(data): schedule an action to run as a job.