org.openapitools.client.api

Class CaptchaApi

java.lang.Object

org.openapitools.client.api.CaptchaApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-07-14T17:07:26.321-05:00[America/Chicago]")
public class CaptchaApi
extends Object

Constructor Summary

Constructors

Constructor and Description
CaptchaApi()
CaptchaApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
CAPTCHAInstance	createCaptchaInstance(CAPTCHAInstance instance) Create a CAPTCHA instance Creates a new CAPTCHA instance.
CAPTCHAInstance	createCaptchaInstance(CAPTCHAInstance instance, Map<String,String> additionalHeaders) Create a CAPTCHA instance Creates a new CAPTCHA instance.
void	deleteCaptchaInstance(String captchaId) Delete a CAPTCHA Instance Deletes a specified CAPTCHA instance > **Note:** If your CAPTCHA instance is still associated with your org, the request fails.
void	deleteCaptchaInstance(String captchaId, Map<String,String> additionalHeaders) Delete a CAPTCHA Instance Deletes a specified CAPTCHA instance > **Note:** If your CAPTCHA instance is still associated with your org, the request fails.
void	deleteOrgCaptchaSettings() Delete the Org-wide CAPTCHA Settings Deletes the CAPTCHA settings object for your organization
void	deleteOrgCaptchaSettings(Map<String,String> additionalHeaders) Delete the Org-wide CAPTCHA Settings Deletes the CAPTCHA settings object for your organization
ApiClient	getApiClient()
CAPTCHAInstance	getCaptchaInstance(String captchaId) Retrieve a CAPTCHA Instance Retrieves the properties of a specified CAPTCHA instance
CAPTCHAInstance	getCaptchaInstance(String captchaId, Map<String,String> additionalHeaders) Retrieve a CAPTCHA Instance Retrieves the properties of a specified CAPTCHA instance
protected static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
OrgCAPTCHASettings	getOrgCaptchaSettings() Retrieve the Org-wide CAPTCHA Settings Retrieves the CAPTCHA settings object for your organization.
OrgCAPTCHASettings	getOrgCaptchaSettings(Map<String,String> additionalHeaders) Retrieve the Org-wide CAPTCHA Settings Retrieves the CAPTCHA settings object for your organization.
List<CAPTCHAInstance>	listCaptchaInstances() List all CAPTCHA Instances Lists all CAPTCHA instances with pagination support.
List<CAPTCHAInstance>	listCaptchaInstances(Map<String,String> additionalHeaders) List all CAPTCHA Instances Lists all CAPTCHA instances with pagination support.
CAPTCHAInstance	replaceCaptchaInstance(String captchaId, CAPTCHAInstance instance) Replace a CAPTCHA Instance Replaces the properties for a specified CAPTCHA instance
CAPTCHAInstance	replaceCaptchaInstance(String captchaId, CAPTCHAInstance instance, Map<String,String> additionalHeaders) Replace a CAPTCHA Instance Replaces the properties for a specified CAPTCHA instance
OrgCAPTCHASettings	replacesOrgCaptchaSettings(OrgCAPTCHASettings orgCAPTCHASettings) Replace the Org-wide CAPTCHA Settings Replaces the CAPTCHA settings object for your organization.
OrgCAPTCHASettings	replacesOrgCaptchaSettings(OrgCAPTCHASettings orgCAPTCHASettings, Map<String,String> additionalHeaders) Replace the Org-wide CAPTCHA Settings Replaces the CAPTCHA settings object for your organization.
void	setApiClient(ApiClient apiClient)
CAPTCHAInstance	updateCaptchaInstance(String captchaId, CAPTCHAInstance instance) Update a CAPTCHA Instance Partially updates the properties of a specified CAPTCHA instance
CAPTCHAInstance	updateCaptchaInstance(String captchaId, CAPTCHAInstance instance, Map<String,String> additionalHeaders) Update a CAPTCHA Instance Partially updates the properties of a specified CAPTCHA instance

Methods inherited from class java.lang.Object

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

Constructor Detail

CaptchaApi

public CaptchaApi()

CaptchaApi

public CaptchaApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createCaptchaInstance

public CAPTCHAInstance createCaptchaInstance(CAPTCHAInstance instance)
                                      throws ApiException

Create a CAPTCHA instance Creates a new CAPTCHA instance. Currently, an org can only configure a single CAPTCHA instance.

Parameters:

instance - (required)

Returns:

CAPTCHAInstance

Throws:

ApiException - if fails to make API call

createCaptchaInstance

public CAPTCHAInstance createCaptchaInstance(CAPTCHAInstance instance,
                                             Map<String,String> additionalHeaders)
                                      throws ApiException

Create a CAPTCHA instance Creates a new CAPTCHA instance. Currently, an org can only configure a single CAPTCHA instance.

Parameters:

instance - (required)

additionalHeaders - additionalHeaders for this call

Returns:

CAPTCHAInstance

Throws:

ApiException - if fails to make API call

deleteCaptchaInstance

public void deleteCaptchaInstance(String captchaId)
                           throws ApiException

Delete a CAPTCHA Instance Deletes a specified CAPTCHA instance > **Note:** If your CAPTCHA instance is still associated with your org, the request fails. You must first update your Org-wide CAPTCHA settings to remove the CAPTCHA instance.

Parameters:

captchaId - The unique key used to identify your CAPTCHA instance (required)

Throws:

ApiException - if fails to make API call

deleteCaptchaInstance

public void deleteCaptchaInstance(String captchaId,
                                  Map<String,String> additionalHeaders)
                           throws ApiException

Delete a CAPTCHA Instance Deletes a specified CAPTCHA instance > **Note:** If your CAPTCHA instance is still associated with your org, the request fails. You must first update your Org-wide CAPTCHA settings to remove the CAPTCHA instance.

Parameters:

captchaId - The unique key used to identify your CAPTCHA instance (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

deleteOrgCaptchaSettings

public void deleteOrgCaptchaSettings()
                              throws ApiException

Delete the Org-wide CAPTCHA Settings Deletes the CAPTCHA settings object for your organization

Throws:

ApiException - if fails to make API call

deleteOrgCaptchaSettings

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

Delete the Org-wide CAPTCHA Settings Deletes the CAPTCHA settings object for your organization

Parameters:

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

getCaptchaInstance

public CAPTCHAInstance getCaptchaInstance(String captchaId)
                                   throws ApiException

Retrieve a CAPTCHA Instance Retrieves the properties of a specified CAPTCHA instance

Parameters:

captchaId - The unique key used to identify your CAPTCHA instance (required)

Returns:

CAPTCHAInstance

Throws:

ApiException - if fails to make API call

getCaptchaInstance

public CAPTCHAInstance getCaptchaInstance(String captchaId,
                                          Map<String,String> additionalHeaders)
                                   throws ApiException

Retrieve a CAPTCHA Instance Retrieves the properties of a specified CAPTCHA instance

Parameters:

captchaId - The unique key used to identify your CAPTCHA instance (required)

additionalHeaders - additionalHeaders for this call

Returns:

CAPTCHAInstance

Throws:

ApiException - if fails to make API call

getOrgCaptchaSettings

public OrgCAPTCHASettings getOrgCaptchaSettings()
                                         throws ApiException

Retrieve the Org-wide CAPTCHA Settings Retrieves the CAPTCHA settings object for your organization. > **Note**: If the current organization hasn't configured CAPTCHA Settings, the request returns an empty object.

Returns:

OrgCAPTCHASettings

Throws:

ApiException - if fails to make API call

getOrgCaptchaSettings

public OrgCAPTCHASettings getOrgCaptchaSettings(Map<String,String> additionalHeaders)
                                         throws ApiException

Retrieve the Org-wide CAPTCHA Settings Retrieves the CAPTCHA settings object for your organization. > **Note**: If the current organization hasn't configured CAPTCHA Settings, the request returns an empty object.

Parameters:

additionalHeaders - additionalHeaders for this call

Returns:

OrgCAPTCHASettings

Throws:

ApiException - if fails to make API call

listCaptchaInstances

public List<CAPTCHAInstance> listCaptchaInstances()
                                           throws ApiException

List all CAPTCHA Instances Lists all CAPTCHA instances with pagination support. A subset of CAPTCHA instances can be returned that match a supported filter expression or query.

Returns:

List<CAPTCHAInstance>

Throws:

ApiException - if fails to make API call

listCaptchaInstances

public List<CAPTCHAInstance> listCaptchaInstances(Map<String,String> additionalHeaders)
                                           throws ApiException

List all CAPTCHA Instances Lists all CAPTCHA instances with pagination support. A subset of CAPTCHA instances can be returned that match a supported filter expression or query.

Parameters:

additionalHeaders - additionalHeaders for this call

Returns:

List<CAPTCHAInstance>

Throws:

ApiException - if fails to make API call

replaceCaptchaInstance

public CAPTCHAInstance replaceCaptchaInstance(String captchaId,
                                              CAPTCHAInstance instance)
                                       throws ApiException

Replace a CAPTCHA Instance Replaces the properties for a specified CAPTCHA instance

Parameters:

captchaId - The unique key used to identify your CAPTCHA instance (required)

instance - (required)

Returns:

CAPTCHAInstance

Throws:

ApiException - if fails to make API call

replaceCaptchaInstance

public CAPTCHAInstance replaceCaptchaInstance(String captchaId,
                                              CAPTCHAInstance instance,
                                              Map<String,String> additionalHeaders)
                                       throws ApiException

Replace a CAPTCHA Instance Replaces the properties for a specified CAPTCHA instance

Parameters:

captchaId - The unique key used to identify your CAPTCHA instance (required)

instance - (required)

additionalHeaders - additionalHeaders for this call

Returns:

CAPTCHAInstance

Throws:

ApiException - if fails to make API call

replacesOrgCaptchaSettings

public OrgCAPTCHASettings replacesOrgCaptchaSettings(OrgCAPTCHASettings orgCAPTCHASettings)
                                              throws ApiException

Replace the Org-wide CAPTCHA Settings Replaces the CAPTCHA settings object for your organization. > **Note**: You can disable CAPTCHA for your organization by setting `captchaId` and `enabledPages` to `null`.

Parameters:

orgCAPTCHASettings - (required)

Returns:

OrgCAPTCHASettings

Throws:

ApiException - if fails to make API call

replacesOrgCaptchaSettings

public OrgCAPTCHASettings replacesOrgCaptchaSettings(OrgCAPTCHASettings orgCAPTCHASettings,
                                                     Map<String,String> additionalHeaders)
                                              throws ApiException

Replace the Org-wide CAPTCHA Settings Replaces the CAPTCHA settings object for your organization. > **Note**: You can disable CAPTCHA for your organization by setting `captchaId` and `enabledPages` to `null`.

Parameters:

orgCAPTCHASettings - (required)

additionalHeaders - additionalHeaders for this call

Returns:

OrgCAPTCHASettings

Throws:

ApiException - if fails to make API call

updateCaptchaInstance

public CAPTCHAInstance updateCaptchaInstance(String captchaId,
                                             CAPTCHAInstance instance)
                                      throws ApiException

Update a CAPTCHA Instance Partially updates the properties of a specified CAPTCHA instance

Parameters:

captchaId - The unique key used to identify your CAPTCHA instance (required)

instance - (required)

Returns:

CAPTCHAInstance

Throws:

ApiException - if fails to make API call

updateCaptchaInstance

public CAPTCHAInstance updateCaptchaInstance(String captchaId,
                                             CAPTCHAInstance instance,
                                             Map<String,String> additionalHeaders)
                                      throws ApiException

Update a CAPTCHA Instance Partially updates the properties of a specified CAPTCHA instance

Parameters:

captchaId - The unique key used to identify your CAPTCHA instance (required)

instance - (required)

additionalHeaders - additionalHeaders for this call

Returns:

CAPTCHAInstance

Throws:

ApiException - if fails to make API call

getObjectMapper

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