org.openapitools.client.api

Class InlineHookApi

java.lang.Object

org.openapitools.client.api.InlineHookApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-06-29T14:11:29.890-05:00[America/Chicago]")
public class InlineHookApi
extends Object

Constructor Summary

Constructors

Constructor and Description
InlineHookApi()
InlineHookApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
InlineHook	activateInlineHook(String inlineHookId) Activate an Inline Hook Activates the inline hook by `inlineHookId`
InlineHook	activateInlineHook(String inlineHookId, Map<String,String> additionalHeaders) Activate an Inline Hook Activates the inline hook by `inlineHookId`
InlineHook	createInlineHook(InlineHook inlineHook) Create an Inline Hook Creates an inline hook
InlineHook	createInlineHook(InlineHook inlineHook, Map<String,String> additionalHeaders) Create an Inline Hook Creates an inline hook
InlineHook	deactivateInlineHook(String inlineHookId) Deactivate an Inline Hook Deactivates the inline hook by `inlineHookId`
InlineHook	deactivateInlineHook(String inlineHookId, Map<String,String> additionalHeaders) Deactivate an Inline Hook Deactivates the inline hook by `inlineHookId`
void	deleteInlineHook(String inlineHookId) Delete an Inline Hook Deletes an inline hook by `inlineHookId`.
void	deleteInlineHook(String inlineHookId, Map<String,String> additionalHeaders) Delete an Inline Hook Deletes an inline hook by `inlineHookId`.
InlineHookResponse	executeInlineHook(String inlineHookId, Object payloadData) Execute an Inline Hook Executes the inline hook by `inlineHookId` using the request body as the input.
InlineHookResponse	executeInlineHook(String inlineHookId, Object payloadData, Map<String,String> additionalHeaders) Execute an Inline Hook Executes the inline hook by `inlineHookId` using the request body as the input.
ApiClient	getApiClient()
InlineHook	getInlineHook(String inlineHookId) Retrieve an Inline Hook Retrieves an inline hook by `inlineHookId`
InlineHook	getInlineHook(String inlineHookId, Map<String,String> additionalHeaders) Retrieve an Inline Hook Retrieves an inline hook by `inlineHookId`
protected static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
List<InlineHook>	listInlineHooks(String type) List all Inline Hooks Lists all inline hooks
List<InlineHook>	listInlineHooks(String type, Map<String,String> additionalHeaders) List all Inline Hooks Lists all inline hooks
InlineHook	replaceInlineHook(String inlineHookId, InlineHook inlineHook) Replace an Inline Hook Replaces an inline hook by `inlineHookId`
InlineHook	replaceInlineHook(String inlineHookId, InlineHook inlineHook, Map<String,String> additionalHeaders) Replace an Inline Hook Replaces an inline hook by `inlineHookId`
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

InlineHookApi

public InlineHookApi()

InlineHookApi

public InlineHookApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

activateInlineHook

public InlineHook activateInlineHook(String inlineHookId)
                              throws ApiException

Activate an Inline Hook Activates the inline hook by `inlineHookId`

Parameters:

inlineHookId - `id` of the Inline Hook (required)

Returns:

InlineHook

Throws:

ApiException - if fails to make API call

activateInlineHook

public InlineHook activateInlineHook(String inlineHookId,
                                     Map<String,String> additionalHeaders)
                              throws ApiException

Activate an Inline Hook Activates the inline hook by `inlineHookId`

Parameters:

inlineHookId - `id` of the Inline Hook (required)

additionalHeaders - additionalHeaders for this call

Returns:

InlineHook

Throws:

ApiException - if fails to make API call

createInlineHook

public InlineHook createInlineHook(InlineHook inlineHook)
                            throws ApiException

Create an Inline Hook Creates an inline hook

Parameters:

inlineHook - (required)

Returns:

InlineHook

Throws:

ApiException - if fails to make API call

createInlineHook

public InlineHook createInlineHook(InlineHook inlineHook,
                                   Map<String,String> additionalHeaders)
                            throws ApiException

Create an Inline Hook Creates an inline hook

Parameters:

inlineHook - (required)

additionalHeaders - additionalHeaders for this call

Returns:

InlineHook

Throws:

ApiException - if fails to make API call

deactivateInlineHook

public InlineHook deactivateInlineHook(String inlineHookId)
                                throws ApiException

Deactivate an Inline Hook Deactivates the inline hook by `inlineHookId`

Parameters:

inlineHookId - `id` of the Inline Hook (required)

Returns:

InlineHook

Throws:

ApiException - if fails to make API call

deactivateInlineHook

public InlineHook deactivateInlineHook(String inlineHookId,
                                       Map<String,String> additionalHeaders)
                                throws ApiException

Deactivate an Inline Hook Deactivates the inline hook by `inlineHookId`

Parameters:

inlineHookId - `id` of the Inline Hook (required)

additionalHeaders - additionalHeaders for this call

Returns:

InlineHook

Throws:

ApiException - if fails to make API call

deleteInlineHook

public void deleteInlineHook(String inlineHookId)
                      throws ApiException

Delete an Inline Hook Deletes an inline hook by `inlineHookId`. Once deleted, the Inline Hook is unrecoverable. As a safety precaution, only Inline Hooks with a status of INACTIVE are eligible for deletion.

Parameters:

inlineHookId - `id` of the Inline Hook (required)

Throws:

ApiException - if fails to make API call

deleteInlineHook

public void deleteInlineHook(String inlineHookId,
                             Map<String,String> additionalHeaders)
                      throws ApiException

Delete an Inline Hook Deletes an inline hook by `inlineHookId`. Once deleted, the Inline Hook is unrecoverable. As a safety precaution, only Inline Hooks with a status of INACTIVE are eligible for deletion.

Parameters:

inlineHookId - `id` of the Inline Hook (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

executeInlineHook

public InlineHookResponse executeInlineHook(String inlineHookId,
                                            Object payloadData)
                                     throws ApiException

Execute an Inline Hook Executes the inline hook by `inlineHookId` using the request body as the input. This will send the provided data through the Channel and return a response if it matches the correct data contract. This execution endpoint should only be used for testing purposes.

Parameters:

inlineHookId - `id` of the Inline Hook (required)

payloadData - (required)

Returns:

InlineHookResponse

Throws:

ApiException - if fails to make API call

executeInlineHook

public InlineHookResponse executeInlineHook(String inlineHookId,
                                            Object payloadData,
                                            Map<String,String> additionalHeaders)
                                     throws ApiException

Execute an Inline Hook Executes the inline hook by `inlineHookId` using the request body as the input. This will send the provided data through the Channel and return a response if it matches the correct data contract. This execution endpoint should only be used for testing purposes.

Parameters:

inlineHookId - `id` of the Inline Hook (required)

payloadData - (required)

additionalHeaders - additionalHeaders for this call

Returns:

InlineHookResponse

Throws:

ApiException - if fails to make API call

getInlineHook

public InlineHook getInlineHook(String inlineHookId)
                         throws ApiException

Retrieve an Inline Hook Retrieves an inline hook by `inlineHookId`

Parameters:

inlineHookId - `id` of the Inline Hook (required)

Returns:

InlineHook

Throws:

ApiException - if fails to make API call

getInlineHook

public InlineHook getInlineHook(String inlineHookId,
                                Map<String,String> additionalHeaders)
                         throws ApiException

Retrieve an Inline Hook Retrieves an inline hook by `inlineHookId`

Parameters:

inlineHookId - `id` of the Inline Hook (required)

additionalHeaders - additionalHeaders for this call

Returns:

InlineHook

Throws:

ApiException - if fails to make API call

listInlineHooks

public List<InlineHook> listInlineHooks(String type)
                                 throws ApiException

List all Inline Hooks Lists all inline hooks

Parameters:

type - (optional)

Returns:

List<InlineHook>

Throws:

ApiException - if fails to make API call

listInlineHooks

public List<InlineHook> listInlineHooks(String type,
                                        Map<String,String> additionalHeaders)
                                 throws ApiException

List all Inline Hooks Lists all inline hooks

Parameters:

type - (optional)

additionalHeaders - additionalHeaders for this call

Returns:

List<InlineHook>

Throws:

ApiException - if fails to make API call

replaceInlineHook

public InlineHook replaceInlineHook(String inlineHookId,
                                    InlineHook inlineHook)
                             throws ApiException

Replace an Inline Hook Replaces an inline hook by `inlineHookId`

Parameters:

inlineHookId - `id` of the Inline Hook (required)

inlineHook - (required)

Returns:

InlineHook

Throws:

ApiException - if fails to make API call

replaceInlineHook

public InlineHook replaceInlineHook(String inlineHookId,
                                    InlineHook inlineHook,
                                    Map<String,String> additionalHeaders)
                             throws ApiException

Replace an Inline Hook Replaces an inline hook by `inlineHookId`

Parameters:

inlineHookId - `id` of the Inline Hook (required)

inlineHook - (required)

additionalHeaders - additionalHeaders for this call

Returns:

InlineHook

Throws:

ApiException - if fails to make API call

getObjectMapper

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