org.openapitools.client.api

Class UiSchemaApi

java.lang.Object

org.openapitools.client.api.UiSchemaApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-07-14T17:07:26.321-05:00[America/Chicago]")
public class UiSchemaApi
extends Object

Constructor Summary

Constructors

Constructor and Description
UiSchemaApi()
UiSchemaApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
UISchemasResponseObject	createUISchema(CreateUISchema uischemabody) Create a UI Schema Creates an input for an enrollment form
UISchemasResponseObject	createUISchema(CreateUISchema uischemabody, Map<String,String> additionalHeaders) Create a UI Schema Creates an input for an enrollment form
void	deleteUISchemas(String id) Delete a UI Schema Deletes a UI Schema by `id`
void	deleteUISchemas(String id, Map<String,String> additionalHeaders) Delete a UI Schema Deletes a UI Schema by `id`
ApiClient	getApiClient()
protected static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
UISchemasResponseObject	getUISchema(String id) Retrieve a UI Schema Retrieves a UI Schema by `id`
UISchemasResponseObject	getUISchema(String id, Map<String,String> additionalHeaders) Retrieve a UI Schema Retrieves a UI Schema by `id`
List<UISchemasResponseObject>	listUISchemas() List all UI Schemas Lists all UI Schemas in your org
List<UISchemasResponseObject>	listUISchemas(Map<String,String> additionalHeaders) List all UI Schemas Lists all UI Schemas in your org
UISchemasResponseObject	replaceUISchemas(String id, UpdateUISchema updateUISchemaBody) Replace a UI Schema Replaces a UI Schema by `id`
UISchemasResponseObject	replaceUISchemas(String id, UpdateUISchema updateUISchemaBody, Map<String,String> additionalHeaders) Replace a UI Schema Replaces a UI Schema by `id`
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

UiSchemaApi

public UiSchemaApi()

UiSchemaApi

public UiSchemaApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createUISchema

public UISchemasResponseObject createUISchema(CreateUISchema uischemabody)
                                       throws ApiException

Create a UI Schema Creates an input for an enrollment form

Parameters:

uischemabody - (required)

Returns:

UISchemasResponseObject

Throws:

ApiException - if fails to make API call

createUISchema

public UISchemasResponseObject createUISchema(CreateUISchema uischemabody,
                                              Map<String,String> additionalHeaders)
                                       throws ApiException

Create a UI Schema Creates an input for an enrollment form

Parameters:

uischemabody - (required)

additionalHeaders - additionalHeaders for this call

Returns:

UISchemasResponseObject

Throws:

ApiException - if fails to make API call

deleteUISchemas

public void deleteUISchemas(String id)
                     throws ApiException

Delete a UI Schema Deletes a UI Schema by `id`

Parameters:

id - The unique ID of the UI Schema (required)

Throws:

ApiException - if fails to make API call

deleteUISchemas

public void deleteUISchemas(String id,
                            Map<String,String> additionalHeaders)
                     throws ApiException

Delete a UI Schema Deletes a UI Schema by `id`

Parameters:

id - The unique ID of the UI Schema (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

getUISchema

public UISchemasResponseObject getUISchema(String id)
                                    throws ApiException

Retrieve a UI Schema Retrieves a UI Schema by `id`

Parameters:

id - The unique ID of the UI Schema (required)

Returns:

UISchemasResponseObject

Throws:

ApiException - if fails to make API call

getUISchema

public UISchemasResponseObject getUISchema(String id,
                                           Map<String,String> additionalHeaders)
                                    throws ApiException

Retrieve a UI Schema Retrieves a UI Schema by `id`

Parameters:

id - The unique ID of the UI Schema (required)

additionalHeaders - additionalHeaders for this call

Returns:

UISchemasResponseObject

Throws:

ApiException - if fails to make API call

listUISchemas

public List<UISchemasResponseObject> listUISchemas()
                                            throws ApiException

List all UI Schemas Lists all UI Schemas in your org

Returns:

List<UISchemasResponseObject>

Throws:

ApiException - if fails to make API call

listUISchemas

public List<UISchemasResponseObject> listUISchemas(Map<String,String> additionalHeaders)
                                            throws ApiException

List all UI Schemas Lists all UI Schemas in your org

Parameters:

additionalHeaders - additionalHeaders for this call

Returns:

List<UISchemasResponseObject>

Throws:

ApiException - if fails to make API call

replaceUISchemas

public UISchemasResponseObject replaceUISchemas(String id,
                                                UpdateUISchema updateUISchemaBody)
                                         throws ApiException

Replace a UI Schema Replaces a UI Schema by `id`

Parameters:

id - The unique ID of the UI Schema (required)

updateUISchemaBody - (required)

Returns:

UISchemasResponseObject

Throws:

ApiException - if fails to make API call

replaceUISchemas

public UISchemasResponseObject replaceUISchemas(String id,
                                                UpdateUISchema updateUISchemaBody,
                                                Map<String,String> additionalHeaders)
                                         throws ApiException

Replace a UI Schema Replaces a UI Schema by `id`

Parameters:

id - The unique ID of the UI Schema (required)

updateUISchemaBody - (required)

additionalHeaders - additionalHeaders for this call

Returns:

UISchemasResponseObject

Throws:

ApiException - if fails to make API call

getObjectMapper

protected static com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()