org.openapitools.client.api

Class CaptchaApi

java.lang.Object

org.openapitools.client.api.CaptchaApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-01-18T04:14:02.238-06:00[America/Chicago]")
 @Component(value="org.openapitools.client.api.CaptchaApi")
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.
<T> T	createCaptchaInstance(Class<?> T, CAPTCHAInstance instance) Create a CAPTCHA instance Creates a new CAPTCHA instance.
PagedList	createCaptchaInstanceWithPaginationInfo(CAPTCHAInstance instance) Create a CAPTCHA instance Creates a new CAPTCHA instance.
void	deleteCaptchaInstance(String captchaId) Delete a CAPTCHA Instance Deletes a CAPTCHA instance by `captchaId`.
ApiClient	getApiClient()
CAPTCHAInstance	getCaptchaInstance(String captchaId) Retrieve a CAPTCHA Instance Retrieves a CAPTCHA instance by `captchaId`
PagedList	getCaptchaInstanceWithPaginationInfo(String captchaId) Retrieve a CAPTCHA Instance Retrieves a CAPTCHA instance by `captchaId`
List<CAPTCHAInstance>	listCaptchaInstances() List all CAPTCHA instances Lists all CAPTCHA instances with pagination support.
PagedList	listCaptchaInstancesWithPaginationInfo() List all CAPTCHA instances Lists all CAPTCHA instances with pagination support.
<T> T	replaceCaptchaInstance(Class<?> T, String captchaId, CAPTCHAInstance instance) Replace a CAPTCHA instance Replaces a CAPTCHA instance by `captchaId`
CAPTCHAInstance	replaceCaptchaInstance(String captchaId, CAPTCHAInstance instance) Replace a CAPTCHA instance Replaces a CAPTCHA instance by `captchaId`
PagedList	replaceCaptchaInstanceWithPaginationInfo(String captchaId, CAPTCHAInstance instance) Replace a CAPTCHA instance Replaces a CAPTCHA instance by `captchaId`
void	setApiClient(ApiClient apiClient)
<T> T	updateCaptchaInstance(Class<?> T, String captchaId, CAPTCHAInstance instance) Update a CAPTCHA instance Partially updates a CAPTCHA instance by `captchaId`
CAPTCHAInstance	updateCaptchaInstance(String captchaId, CAPTCHAInstance instance) Update a CAPTCHA instance Partially updates a CAPTCHA instance by `captchaId`
PagedList	updateCaptchaInstanceWithPaginationInfo(String captchaId, CAPTCHAInstance instance) Update a CAPTCHA instance Partially updates a CAPTCHA instance by `captchaId`

Methods inherited from class java.lang.Object

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

Constructor Detail

CaptchaApi

public CaptchaApi()

CaptchaApi

@Autowired
public CaptchaApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createCaptchaInstance

public CAPTCHAInstance createCaptchaInstance(CAPTCHAInstance instance)
                                      throws org.springframework.web.client.RestClientException

Create a CAPTCHA instance Creates a new CAPTCHA instance. In the current release, we only allow one CAPTCHA instance per org.

201 - Created

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

instance - (required)

Returns:

CAPTCHAInstance

Throws:

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

createCaptchaInstance

public <T> T createCaptchaInstance(Class<?> T,
                                   CAPTCHAInstance instance)
                            throws org.springframework.web.client.RestClientException

Create a CAPTCHA instance Creates a new CAPTCHA instance. In the current release, we only allow one CAPTCHA instance per org.

201 - Created

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

instance - (required)

Returns:

T instance

Throws:

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

createCaptchaInstanceWithPaginationInfo

public PagedList createCaptchaInstanceWithPaginationInfo(CAPTCHAInstance instance)
                                                  throws org.springframework.web.client.RestClientException

Create a CAPTCHA instance Creates a new CAPTCHA instance. In the current release, we only allow one CAPTCHA instance per org.

201 - Created

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

instance - (required)

Returns:

ResponseEntity<CAPTCHAInstance>

Throws:

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

deleteCaptchaInstance

public void deleteCaptchaInstance(String captchaId)
                           throws org.springframework.web.client.RestClientException

Delete a CAPTCHA Instance Deletes a CAPTCHA instance by `captchaId`. If the CAPTCHA instance is currently being used in the org, the delete will not be allowed.

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

captchaId - id of the CAPTCHA (required)

Throws:

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

getCaptchaInstance

public CAPTCHAInstance getCaptchaInstance(String captchaId)
                                   throws org.springframework.web.client.RestClientException

Retrieve a CAPTCHA Instance Retrieves a CAPTCHA instance by `captchaId`

200 - OK

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

captchaId - id of the CAPTCHA (required)

Returns:

CAPTCHAInstance

Throws:

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

getCaptchaInstanceWithPaginationInfo

public PagedList getCaptchaInstanceWithPaginationInfo(String captchaId)
                                               throws org.springframework.web.client.RestClientException

Retrieve a CAPTCHA Instance Retrieves a CAPTCHA instance by `captchaId`

200 - OK

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

captchaId - id of the CAPTCHA (required)

Returns:

ResponseEntity<CAPTCHAInstance>

Throws:

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

listCaptchaInstances

public List<CAPTCHAInstance> listCaptchaInstances()
                                           throws org.springframework.web.client.RestClientException

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.

200 - OK

403 - Forbidden

429 - Too Many Requests

Returns:

List<CAPTCHAInstance>

Throws:

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

listCaptchaInstancesWithPaginationInfo

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

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.

200 - OK

403 - Forbidden

429 - Too Many Requests

Returns:

ResponseEntity<List<CAPTCHAInstance>>

Throws:

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

replaceCaptchaInstance

public CAPTCHAInstance replaceCaptchaInstance(String captchaId,
                                              CAPTCHAInstance instance)
                                       throws org.springframework.web.client.RestClientException

Replace a CAPTCHA instance Replaces a CAPTCHA instance by `captchaId`

200 - OK

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

captchaId - id of the CAPTCHA (required)

instance - (required)

Returns:

CAPTCHAInstance

Throws:

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

replaceCaptchaInstance

public <T> T replaceCaptchaInstance(Class<?> T,
                                    String captchaId,
                                    CAPTCHAInstance instance)
                             throws org.springframework.web.client.RestClientException

Replace a CAPTCHA instance Replaces a CAPTCHA instance by `captchaId`

200 - OK

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

captchaId - id of the CAPTCHA (required)

instance - (required)

Returns:

T instance

Throws:

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

replaceCaptchaInstanceWithPaginationInfo

public PagedList replaceCaptchaInstanceWithPaginationInfo(String captchaId,
                                                          CAPTCHAInstance instance)
                                                   throws org.springframework.web.client.RestClientException

Replace a CAPTCHA instance Replaces a CAPTCHA instance by `captchaId`

200 - OK

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

captchaId - id of the CAPTCHA (required)

instance - (required)

Returns:

ResponseEntity<CAPTCHAInstance>

Throws:

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

updateCaptchaInstance

public CAPTCHAInstance updateCaptchaInstance(String captchaId,
                                             CAPTCHAInstance instance)
                                      throws org.springframework.web.client.RestClientException

Update a CAPTCHA instance Partially updates a CAPTCHA instance by `captchaId`

200 - OK

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

captchaId - id of the CAPTCHA (required)

instance - (required)

Returns:

CAPTCHAInstance

Throws:

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

updateCaptchaInstance

public <T> T updateCaptchaInstance(Class<?> T,
                                   String captchaId,
                                   CAPTCHAInstance instance)
                            throws org.springframework.web.client.RestClientException

Update a CAPTCHA instance Partially updates a CAPTCHA instance by `captchaId`

200 - OK

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

captchaId - id of the CAPTCHA (required)

instance - (required)

Returns:

T instance

Throws:

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

updateCaptchaInstanceWithPaginationInfo

public PagedList updateCaptchaInstanceWithPaginationInfo(String captchaId,
                                                         CAPTCHAInstance instance)
                                                  throws org.springframework.web.client.RestClientException

Update a CAPTCHA instance Partially updates a CAPTCHA instance by `captchaId`

200 - OK

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

captchaId - id of the CAPTCHA (required)

instance - (required)

Returns:

ResponseEntity<CAPTCHAInstance>

Throws:

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