org.openapitools.client.api

Class EventHookApi

java.lang.Object

org.openapitools.client.api.EventHookApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-01-18T04:14:02.238-06:00[America/Chicago]")
 @Component(value="org.openapitools.client.api.EventHookApi")
public class EventHookApi
extends Object

Constructor Summary

Constructors

Constructor and Description
EventHookApi()
EventHookApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
EventHook	activateEventHook(String eventHookId) Activate an Event Hook Activates an event hook
PagedList	activateEventHookWithPaginationInfo(String eventHookId) Activate an Event Hook Activates an event hook
<T> T	createEventHook(Class<?> T, EventHook eventHook) Create an Event Hook Creates an event hook
EventHook	createEventHook(EventHook eventHook) Create an Event Hook Creates an event hook
PagedList	createEventHookWithPaginationInfo(EventHook eventHook) Create an Event Hook Creates an event hook
EventHook	deactivateEventHook(String eventHookId) Deactivate an Event Hook Deactivates an event hook
PagedList	deactivateEventHookWithPaginationInfo(String eventHookId) Deactivate an Event Hook Deactivates an event hook
void	deleteEventHook(String eventHookId) Delete an Event Hook Deletes an event hook
ApiClient	getApiClient()
EventHook	getEventHook(String eventHookId) Retrieve an Event Hook Retrieves an event hook
PagedList	getEventHookWithPaginationInfo(String eventHookId) Retrieve an Event Hook Retrieves an event hook
List<EventHook>	listEventHooks() List all Event Hooks Lists all event hooks
PagedList	listEventHooksWithPaginationInfo() List all Event Hooks Lists all event hooks
<T> T	replaceEventHook(Class<?> T, String eventHookId, EventHook eventHook) Replace an Event Hook Replaces an event hook
EventHook	replaceEventHook(String eventHookId, EventHook eventHook) Replace an Event Hook Replaces an event hook
PagedList	replaceEventHookWithPaginationInfo(String eventHookId, EventHook eventHook) Replace an Event Hook Replaces an event hook
void	setApiClient(ApiClient apiClient)
EventHook	verifyEventHook(String eventHookId) Verify an Event Hook Verifies an event hook
PagedList	verifyEventHookWithPaginationInfo(String eventHookId) Verify an Event Hook Verifies an event hook

Methods inherited from class java.lang.Object

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

Constructor Detail

EventHookApi

public EventHookApi()

EventHookApi

@Autowired
public EventHookApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

activateEventHook

public EventHook activateEventHook(String eventHookId)
                            throws org.springframework.web.client.RestClientException

Activate an Event Hook Activates an event hook

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

eventHookId - (required)

Returns:

EventHook

Throws:

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

activateEventHookWithPaginationInfo

public PagedList activateEventHookWithPaginationInfo(String eventHookId)
                                              throws org.springframework.web.client.RestClientException

Activate an Event Hook Activates an event hook

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

eventHookId - (required)

Returns:

ResponseEntity<EventHook>

Throws:

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

createEventHook

public EventHook createEventHook(EventHook eventHook)
                          throws org.springframework.web.client.RestClientException

Create an Event Hook Creates an event hook

200 - Success

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

eventHook - (required)

Returns:

EventHook

Throws:

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

createEventHook

public <T> T createEventHook(Class<?> T,
                             EventHook eventHook)
                      throws org.springframework.web.client.RestClientException

Create an Event Hook Creates an event hook

200 - Success

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

eventHook - (required)

Returns:

T instance

Throws:

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

createEventHookWithPaginationInfo

public PagedList createEventHookWithPaginationInfo(EventHook eventHook)
                                            throws org.springframework.web.client.RestClientException

Create an Event Hook Creates an event hook

200 - Success

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

eventHook - (required)

Returns:

ResponseEntity<EventHook>

Throws:

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

deactivateEventHook

public EventHook deactivateEventHook(String eventHookId)
                              throws org.springframework.web.client.RestClientException

Deactivate an Event Hook Deactivates an event hook

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

eventHookId - (required)

Returns:

EventHook

Throws:

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

deactivateEventHookWithPaginationInfo

public PagedList deactivateEventHookWithPaginationInfo(String eventHookId)
                                                throws org.springframework.web.client.RestClientException

Deactivate an Event Hook Deactivates an event hook

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

eventHookId - (required)

Returns:

ResponseEntity<EventHook>

Throws:

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

deleteEventHook

public void deleteEventHook(String eventHookId)
                     throws org.springframework.web.client.RestClientException

Delete an Event Hook Deletes an event hook

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

eventHookId - (required)

Throws:

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

getEventHook

public EventHook getEventHook(String eventHookId)
                       throws org.springframework.web.client.RestClientException

Retrieve an Event Hook Retrieves an event hook

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

eventHookId - (required)

Returns:

EventHook

Throws:

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

getEventHookWithPaginationInfo

public PagedList getEventHookWithPaginationInfo(String eventHookId)
                                         throws org.springframework.web.client.RestClientException

Retrieve an Event Hook Retrieves an event hook

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

eventHookId - (required)

Returns:

ResponseEntity<EventHook>

Throws:

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

listEventHooks

public List<EventHook> listEventHooks()
                               throws org.springframework.web.client.RestClientException

List all Event Hooks Lists all event hooks

200 - Success

403 - Forbidden

429 - Too Many Requests

Returns:

List<EventHook>

Throws:

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

listEventHooksWithPaginationInfo

public PagedList listEventHooksWithPaginationInfo()
                                           throws org.springframework.web.client.RestClientException

List all Event Hooks Lists all event hooks

200 - Success

403 - Forbidden

429 - Too Many Requests

Returns:

ResponseEntity<List<EventHook>>

Throws:

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

replaceEventHook

public EventHook replaceEventHook(String eventHookId,
                                  EventHook eventHook)
                           throws org.springframework.web.client.RestClientException

Replace an Event Hook Replaces an event hook

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

eventHookId - (required)

eventHook - (required)

Returns:

EventHook

Throws:

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

replaceEventHook

public <T> T replaceEventHook(Class<?> T,
                              String eventHookId,
                              EventHook eventHook)
                       throws org.springframework.web.client.RestClientException

Replace an Event Hook Replaces an event hook

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

eventHookId - (required)

eventHook - (required)

Returns:

T instance

Throws:

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

replaceEventHookWithPaginationInfo

public PagedList replaceEventHookWithPaginationInfo(String eventHookId,
                                                    EventHook eventHook)
                                             throws org.springframework.web.client.RestClientException

Replace an Event Hook Replaces an event hook

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

eventHookId - (required)

eventHook - (required)

Returns:

ResponseEntity<EventHook>

Throws:

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

verifyEventHook

public EventHook verifyEventHook(String eventHookId)
                          throws org.springframework.web.client.RestClientException

Verify an Event Hook Verifies an event hook

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

eventHookId - (required)

Returns:

EventHook

Throws:

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

verifyEventHookWithPaginationInfo

public PagedList verifyEventHookWithPaginationInfo(String eventHookId)
                                            throws org.springframework.web.client.RestClientException

Verify an Event Hook Verifies an event hook

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

eventHookId - (required)

Returns:

ResponseEntity<EventHook>

Throws:

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