org.openapitools.client.api

Class HookKeyApi

java.lang.Object

org.openapitools.client.api.HookKeyApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-02-10T11:07:35.698-06:00[America/Chicago]")
 @Component(value="org.openapitools.client.api.HookKeyApi")
public class HookKeyApi
extends Object

Constructor Summary

Constructors

Constructor and Description
HookKeyApi()
HookKeyApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
<T> T	createHookKey(Class<?> T, KeyRequest keyRequest) Create a key Creates a key
HookKey	createHookKey(KeyRequest keyRequest) Create a key Creates a key
PagedList	createHookKeyWithPaginationInfo(KeyRequest keyRequest) Create a key Creates a key
void	deleteHookKey(String hookKeyId) Delete a key Deletes a key by `hookKeyId`.
ApiClient	getApiClient()
HookKey	getHookKey(String hookKeyId) Retrieve a key Retrieves a key by `hookKeyId`
PagedList	getHookKeyWithPaginationInfo(String hookKeyId) Retrieve a key Retrieves a key by `hookKeyId`
JsonWebKey	getPublicKey(String keyId) Retrieve a public key Retrieves a public key by `keyId`
PagedList	getPublicKeyWithPaginationInfo(String keyId) Retrieve a public key Retrieves a public key by `keyId`
List<HookKey>	listHookKeys() List all keys Lists all keys
PagedList	listHookKeysWithPaginationInfo() List all keys Lists all keys
<T> T	replaceHookKey(Class<?> T, String hookKeyId, KeyRequest keyRequest) Replace a key Replace a key by `hookKeyId`
HookKey	replaceHookKey(String hookKeyId, KeyRequest keyRequest) Replace a key Replace a key by `hookKeyId`
PagedList	replaceHookKeyWithPaginationInfo(String hookKeyId, KeyRequest keyRequest) Replace a key Replace a key by `hookKeyId`
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

HookKeyApi

public HookKeyApi()

HookKeyApi

@Autowired
public HookKeyApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createHookKey

public HookKey createHookKey(KeyRequest keyRequest)
                      throws org.springframework.web.client.RestClientException

Create a key Creates a key

200 - Success

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

keyRequest - (required)

Returns:

HookKey

Throws:

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

createHookKey

public <T> T createHookKey(Class<?> T,
                           KeyRequest keyRequest)
                    throws org.springframework.web.client.RestClientException

Create a key Creates a key

200 - Success

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

keyRequest - (required)

Returns:

T instance

Throws:

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

createHookKeyWithPaginationInfo

public PagedList createHookKeyWithPaginationInfo(KeyRequest keyRequest)
                                          throws org.springframework.web.client.RestClientException

Create a key Creates a key

200 - Success

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

keyRequest - (required)

Returns:

ResponseEntity<HookKey>

Throws:

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

deleteHookKey

public void deleteHookKey(String hookKeyId)
                   throws org.springframework.web.client.RestClientException

Delete a key Deletes a key by `hookKeyId`. Once deleted, the Hook Key is unrecoverable. As a safety precaution, unused keys are eligible for deletion.

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

hookKeyId - (required)

Throws:

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

getHookKey

public HookKey getHookKey(String hookKeyId)
                   throws org.springframework.web.client.RestClientException

Retrieve a key Retrieves a key by `hookKeyId`

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

hookKeyId - (required)

Returns:

HookKey

Throws:

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

getHookKeyWithPaginationInfo

public PagedList getHookKeyWithPaginationInfo(String hookKeyId)
                                       throws org.springframework.web.client.RestClientException

Retrieve a key Retrieves a key by `hookKeyId`

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

hookKeyId - (required)

Returns:

ResponseEntity<HookKey>

Throws:

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

getPublicKey

public JsonWebKey getPublicKey(String keyId)
                        throws org.springframework.web.client.RestClientException

Retrieve a public key Retrieves a public key by `keyId`

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

keyId - (required)

Returns:

JsonWebKey

Throws:

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

getPublicKeyWithPaginationInfo

public PagedList getPublicKeyWithPaginationInfo(String keyId)
                                         throws org.springframework.web.client.RestClientException

Retrieve a public key Retrieves a public key by `keyId`

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

keyId - (required)

Returns:

ResponseEntity<JsonWebKey>

Throws:

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

listHookKeys

public List<HookKey> listHookKeys()
                           throws org.springframework.web.client.RestClientException

List all keys Lists all keys

200 - Success

403 - Forbidden

429 - Too Many Requests

Returns:

List<HookKey>

Throws:

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

listHookKeysWithPaginationInfo

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

List all keys Lists all keys

200 - Success

403 - Forbidden

429 - Too Many Requests

Returns:

ResponseEntity<List<HookKey>>

Throws:

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

replaceHookKey

public HookKey replaceHookKey(String hookKeyId,
                              KeyRequest keyRequest)
                       throws org.springframework.web.client.RestClientException

Replace a key Replace a key by `hookKeyId`

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

hookKeyId - (required)

keyRequest - (required)

Returns:

HookKey

Throws:

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

replaceHookKey

public <T> T replaceHookKey(Class<?> T,
                            String hookKeyId,
                            KeyRequest keyRequest)
                     throws org.springframework.web.client.RestClientException

Replace a key Replace a key by `hookKeyId`

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

hookKeyId - (required)

keyRequest - (required)

Returns:

T instance

Throws:

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

replaceHookKeyWithPaginationInfo

public PagedList replaceHookKeyWithPaginationInfo(String hookKeyId,
                                                  KeyRequest keyRequest)
                                           throws org.springframework.web.client.RestClientException

Replace a key Replace a key by `hookKeyId`

200 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

hookKeyId - (required)

keyRequest - (required)

Returns:

ResponseEntity<HookKey>

Throws:

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