org.openapitools.client.api

Class InlineHookApi

java.lang.Object

org.openapitools.client.api.InlineHookApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-01-18T04:14:02.238-06:00[America/Chicago]")
 @Component(value="org.openapitools.client.api.InlineHookApi")
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`
PagedList	activateInlineHookWithPaginationInfo(String inlineHookId) Activate an Inline Hook Activates the inline hook by `inlineHookId`
<T> T	createInlineHook(Class<?> T, InlineHook inlineHook) Create an Inline Hook Creates an inline hook
InlineHook	createInlineHook(InlineHook inlineHook) Create an Inline Hook Creates an inline hook
PagedList	createInlineHookWithPaginationInfo(InlineHook inlineHook) Create an Inline Hook Creates an inline hook
InlineHook	deactivateInlineHook(String inlineHookId) Deactivate an Inline Hook Deactivates the inline hook by `inlineHookId`
PagedList	deactivateInlineHookWithPaginationInfo(String inlineHookId) Deactivate an Inline Hook Deactivates the inline hook by `inlineHookId`
void	deleteInlineHook(String inlineHookId) Delete an Inline Hook Deletes an inline hook by `inlineHookId`.
<T> T	executeInlineHook(Class<?> T, 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) Execute an Inline Hook Executes the inline hook by `inlineHookId` using the request body as the input.
PagedList	executeInlineHookWithPaginationInfo(String inlineHookId, Object payloadData) 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`
PagedList	getInlineHookWithPaginationInfo(String inlineHookId) Retrieve an Inline Hook Retrieves an inline hook by `inlineHookId`
List<InlineHook>	listInlineHooks(String type) List all Inline Hooks Lists all inline hooks
PagedList	listInlineHooksWithPaginationInfo(String type) List all Inline Hooks Lists all inline hooks
<T> T	replaceInlineHook(Class<?> T, String inlineHookId, InlineHook inlineHook) Replace an Inline Hook Replaces an inline hook by `inlineHookId`
InlineHook	replaceInlineHook(String inlineHookId, InlineHook inlineHook) Replace an Inline Hook Replaces an inline hook by `inlineHookId`
PagedList	replaceInlineHookWithPaginationInfo(String inlineHookId, InlineHook inlineHook) 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

@Autowired
public InlineHookApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

activateInlineHook

public InlineHook activateInlineHook(String inlineHookId)
                              throws org.springframework.web.client.RestClientException

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

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

inlineHookId - (required)

Returns:

InlineHook

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

activateInlineHookWithPaginationInfo

public PagedList activateInlineHookWithPaginationInfo(String inlineHookId)
                                               throws org.springframework.web.client.RestClientException

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

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

inlineHookId - (required)

Returns:

ResponseEntity<InlineHook>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

createInlineHook

public InlineHook createInlineHook(InlineHook inlineHook)
                            throws org.springframework.web.client.RestClientException

Create an Inline Hook Creates an inline hook

200 - Success

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

inlineHook - (required)

Returns:

InlineHook

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

createInlineHook

public <T> T createInlineHook(Class<?> T,
                              InlineHook inlineHook)
                       throws org.springframework.web.client.RestClientException

Create an Inline Hook Creates an inline hook

200 - Success

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

inlineHook - (required)

Returns:

T instance

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

createInlineHookWithPaginationInfo

public PagedList createInlineHookWithPaginationInfo(InlineHook inlineHook)
                                             throws org.springframework.web.client.RestClientException

Create an Inline Hook Creates an inline hook

200 - Success

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

inlineHook - (required)

Returns:

ResponseEntity<InlineHook>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

deactivateInlineHook

public InlineHook deactivateInlineHook(String inlineHookId)
                                throws org.springframework.web.client.RestClientException

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

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

inlineHookId - (required)

Returns:

InlineHook

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

deactivateInlineHookWithPaginationInfo

public PagedList deactivateInlineHookWithPaginationInfo(String inlineHookId)
                                                 throws org.springframework.web.client.RestClientException

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

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

inlineHookId - (required)

Returns:

ResponseEntity<InlineHook>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

deleteInlineHook

public void deleteInlineHook(String inlineHookId)
                      throws org.springframework.web.client.RestClientException

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.

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

inlineHookId - (required)

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

executeInlineHook

public InlineHookResponse executeInlineHook(String inlineHookId,
                                            Object payloadData)
                                     throws org.springframework.web.client.RestClientException

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.

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

inlineHookId - (required)

payloadData - (required)

Returns:

InlineHookResponse

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

executeInlineHook

public <T> T executeInlineHook(Class<?> T,
                               String inlineHookId,
                               Object payloadData)
                        throws org.springframework.web.client.RestClientException

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.

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

inlineHookId - (required)

payloadData - (required)

Returns:

T instance

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

executeInlineHookWithPaginationInfo

public PagedList executeInlineHookWithPaginationInfo(String inlineHookId,
                                                     Object payloadData)
                                              throws org.springframework.web.client.RestClientException

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.

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

inlineHookId - (required)

payloadData - (required)

Returns:

ResponseEntity<InlineHookResponse>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getInlineHook

public InlineHook getInlineHook(String inlineHookId)
                         throws org.springframework.web.client.RestClientException

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

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

inlineHookId - (required)

Returns:

InlineHook

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getInlineHookWithPaginationInfo

public PagedList getInlineHookWithPaginationInfo(String inlineHookId)
                                          throws org.springframework.web.client.RestClientException

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

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

inlineHookId - (required)

Returns:

ResponseEntity<InlineHook>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listInlineHooks

public List<InlineHook> listInlineHooks(String type)
                                 throws org.springframework.web.client.RestClientException

List all Inline Hooks Lists all inline hooks

200 - Success

403 - Forbidden

429 - Too Many Requests

Parameters:

type - (optional)

Returns:

List<InlineHook>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listInlineHooksWithPaginationInfo

public PagedList listInlineHooksWithPaginationInfo(String type)
                                            throws org.springframework.web.client.RestClientException

List all Inline Hooks Lists all inline hooks

200 - Success

403 - Forbidden

429 - Too Many Requests

Parameters:

type - (optional)

Returns:

ResponseEntity<List<InlineHook>>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

replaceInlineHook

public InlineHook replaceInlineHook(String inlineHookId,
                                    InlineHook inlineHook)
                             throws org.springframework.web.client.RestClientException

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

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

inlineHookId - (required)

inlineHook - (required)

Returns:

InlineHook

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

replaceInlineHook

public <T> T replaceInlineHook(Class<?> T,
                               String inlineHookId,
                               InlineHook inlineHook)
                        throws org.springframework.web.client.RestClientException

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

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

inlineHookId - (required)

inlineHook - (required)

Returns:

T instance

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

replaceInlineHookWithPaginationInfo

public PagedList replaceInlineHookWithPaginationInfo(String inlineHookId,
                                                     InlineHook inlineHook)
                                              throws org.springframework.web.client.RestClientException

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

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

inlineHookId - (required)

inlineHook - (required)

Returns:

ResponseEntity<InlineHook>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API