Package org.openapitools.client.api

Class HookKeyApi

java.lang.Object
org.openapitools.client.api.HookKeyApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2023-06-14T14:39:12.692995-05:00[America/Chicago]") public class HookKeyApi extends Object

  • Constructor Details

    • HookKeyApi

      public HookKeyApi()

    • HookKeyApi

      public HookKeyApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • createHookKey

      public HookKey createHookKey(KeyRequest keyRequest) throws ApiException
      Create a key Creates a key
      Parameters:
      keyRequest - (required)
      Returns:
      HookKey
      Throws:
      ApiException - if fails to make API call

    • createHookKey

      public HookKey createHookKey(KeyRequest keyRequest, Map<String,String> additionalHeaders) throws ApiException
      Create a key Creates a key
      Parameters:
      keyRequest - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      HookKey
      Throws:
      ApiException - if fails to make API call

    • deleteHookKey

      public void deleteHookKey(String hookKeyId) throws ApiException
      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.
      Parameters:
      hookKeyId - `id` of the Hook Key (required)
      Throws:
      ApiException - if fails to make API call

    • deleteHookKey

      public void deleteHookKey(String hookKeyId, Map<String,String> additionalHeaders) throws ApiException
      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.
      Parameters:
      hookKeyId - `id` of the Hook Key (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • getHookKey

      public HookKey getHookKey(String hookKeyId) throws ApiException
      Retrieve a key Retrieves a key by `hookKeyId`
      Parameters:
      hookKeyId - `id` of the Hook Key (required)
      Returns:
      HookKey
      Throws:
      ApiException - if fails to make API call

    • getHookKey

      public HookKey getHookKey(String hookKeyId, Map<String,String> additionalHeaders) throws ApiException
      Retrieve a key Retrieves a key by `hookKeyId`
      Parameters:
      hookKeyId - `id` of the Hook Key (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      HookKey
      Throws:
      ApiException - if fails to make API call

    • getPublicKey

      public JsonWebKey getPublicKey(String publicKeyId) throws ApiException
      Retrieve a public key Retrieves a public key by `keyId`
      Parameters:
      publicKeyId - `id` of the Public Key (required)
      Returns:
      JsonWebKey
      Throws:
      ApiException - if fails to make API call

    • getPublicKey

      public JsonWebKey getPublicKey(String publicKeyId, Map<String,String> additionalHeaders) throws ApiException
      Retrieve a public key Retrieves a public key by `keyId`
      Parameters:
      publicKeyId - `id` of the Public Key (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      JsonWebKey
      Throws:
      ApiException - if fails to make API call

    • listHookKeys

      public List<HookKey> listHookKeys() throws ApiException
      List all keys Lists all keys
      Returns:
      List<HookKey>
      Throws:
      ApiException - if fails to make API call

    • listHookKeys

      public List<HookKey> listHookKeys(Map<String,String> additionalHeaders) throws ApiException
      List all keys Lists all keys
      Parameters:
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<HookKey>
      Throws:
      ApiException - if fails to make API call

    • replaceHookKey

      public HookKey replaceHookKey(String hookKeyId, KeyRequest keyRequest) throws ApiException
      Replace a key Replaces a key by `hookKeyId`
      Parameters:
      hookKeyId - `id` of the Hook Key (required)
      keyRequest - (required)
      Returns:
      HookKey
      Throws:
      ApiException - if fails to make API call

    • replaceHookKey

      public HookKey replaceHookKey(String hookKeyId, KeyRequest keyRequest, Map<String,String> additionalHeaders) throws ApiException
      Replace a key Replaces a key by `hookKeyId`
      Parameters:
      hookKeyId - `id` of the Hook Key (required)
      keyRequest - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      HookKey
      Throws:
      ApiException - if fails to make API call

    • getObjectMapper

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