Package org.openapitools.client.api

Class PrincipalRateLimitApi

java.lang.Object

org.openapitools.client.api.PrincipalRateLimitApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-04-19T09:13:44.263607-05:00[America/Chicago]")
@Component("org.openapitools.client.api.PrincipalRateLimitApi")
public class PrincipalRateLimitApi
extends Object

Constructor Summary

Constructors

Constructor	Description
PrincipalRateLimitApi()
PrincipalRateLimitApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
<T> T	createPrincipalRateLimitEntity(Class<?> T, PrincipalRateLimitEntity entity)	Create a Principal Rate Limit Creates a new Principal Rate Limit entity.
PrincipalRateLimitEntity	createPrincipalRateLimitEntity(PrincipalRateLimitEntity entity)	Create a Principal Rate Limit Creates a new Principal Rate Limit entity.
org.springframework.http.ResponseEntity<PrincipalRateLimitEntity>	createPrincipalRateLimitEntityWithHttpInfo(PrincipalRateLimitEntity entity)	Create a Principal Rate Limit Creates a new Principal Rate Limit entity.
PagedList	createPrincipalRateLimitEntityWithPaginationInfo(PrincipalRateLimitEntity entity)	Create a Principal Rate Limit Creates a new Principal Rate Limit entity.
ApiClient	getApiClient()
PrincipalRateLimitEntity	getPrincipalRateLimitEntity(String principalRateLimitId)	Retrieve a Principal Rate Limit Retrieves a Principal Rate Limit entity by `principalRateLimitId`
org.springframework.http.ResponseEntity<PrincipalRateLimitEntity>	getPrincipalRateLimitEntityWithHttpInfo(String principalRateLimitId)	Retrieve a Principal Rate Limit Retrieves a Principal Rate Limit entity by `principalRateLimitId`
PagedList	getPrincipalRateLimitEntityWithPaginationInfo(String principalRateLimitId)	Retrieve a Principal Rate Limit Retrieves a Principal Rate Limit entity by `principalRateLimitId`
List<PrincipalRateLimitEntity>	listPrincipalRateLimitEntities(String filter, String after, Integer limit)	List all Principal Rate Limits Lists all Principal Rate Limit entities considering the provided parameters
org.springframework.http.ResponseEntity<List<PrincipalRateLimitEntity>>	listPrincipalRateLimitEntitiesWithHttpInfo(String filter, String after, Integer limit)	List all Principal Rate Limits Lists all Principal Rate Limit entities considering the provided parameters
PagedList	listPrincipalRateLimitEntitiesWithPaginationInfo(String filter, String after, Integer limit)	List all Principal Rate Limits Lists all Principal Rate Limit entities considering the provided parameters
<T> T	replacePrincipalRateLimitEntity(Class<?> T, String principalRateLimitId, PrincipalRateLimitEntity entity)	Replace a Principal Rate Limit Replaces a principal rate limit entity by `principalRateLimitId`
PrincipalRateLimitEntity	replacePrincipalRateLimitEntity(String principalRateLimitId, PrincipalRateLimitEntity entity)	Replace a Principal Rate Limit Replaces a principal rate limit entity by `principalRateLimitId`
org.springframework.http.ResponseEntity<PrincipalRateLimitEntity>	replacePrincipalRateLimitEntityWithHttpInfo(String principalRateLimitId, PrincipalRateLimitEntity entity)	Replace a Principal Rate Limit Replaces a principal rate limit entity by `principalRateLimitId`
PagedList	replacePrincipalRateLimitEntityWithPaginationInfo(String principalRateLimitId, PrincipalRateLimitEntity entity)	Replace a Principal Rate Limit Replaces a principal rate limit entity by `principalRateLimitId`
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Details

PrincipalRateLimitApi

public PrincipalRateLimitApi()

PrincipalRateLimitApi

@Autowired
public PrincipalRateLimitApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createPrincipalRateLimitEntity

public PrincipalRateLimitEntity createPrincipalRateLimitEntity(PrincipalRateLimitEntity entity)
                                                        throws org.springframework.web.client.RestClientException

Create a Principal Rate Limit Creates a new Principal Rate Limit entity. In the current release, we only allow one Principal Rate Limit entity per org and principal.

201 - Created

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

entity - (required)

Returns:

PrincipalRateLimitEntity

Throws:

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

createPrincipalRateLimitEntity

public <T> T createPrincipalRateLimitEntity(Class<?> T,
 PrincipalRateLimitEntity entity)
                                     throws org.springframework.web.client.RestClientException

Create a Principal Rate Limit Creates a new Principal Rate Limit entity. In the current release, we only allow one Principal Rate Limit entity per org and principal.

201 - Created

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

entity - (required)

Returns:

T instance

Throws:

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

createPrincipalRateLimitEntityWithHttpInfo

public org.springframework.http.ResponseEntity<PrincipalRateLimitEntity> createPrincipalRateLimitEntityWithHttpInfo(PrincipalRateLimitEntity entity)
                                                                                                             throws org.springframework.web.client.RestClientException

Create a Principal Rate Limit Creates a new Principal Rate Limit entity. In the current release, we only allow one Principal Rate Limit entity per org and principal.

201 - Created

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

entity - (required)

Returns:

ResponseEntity<PrincipalRateLimitEntity>

Throws:

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

createPrincipalRateLimitEntityWithPaginationInfo

public PagedList createPrincipalRateLimitEntityWithPaginationInfo(PrincipalRateLimitEntity entity)
                                                           throws org.springframework.web.client.RestClientException

Create a Principal Rate Limit Creates a new Principal Rate Limit entity. In the current release, we only allow one Principal Rate Limit entity per org and principal.

201 - Created

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

entity - (required)

Returns:

ResponseEntity<PrincipalRateLimitEntity>

Throws:

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

getPrincipalRateLimitEntity

public PrincipalRateLimitEntity getPrincipalRateLimitEntity(String principalRateLimitId)
                                                     throws org.springframework.web.client.RestClientException

Retrieve a Principal Rate Limit Retrieves a Principal Rate Limit entity by `principalRateLimitId`

200 - OK

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

principalRateLimitId - id of the Principal Rate Limit (required)

Returns:

PrincipalRateLimitEntity

Throws:

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

getPrincipalRateLimitEntityWithHttpInfo

public org.springframework.http.ResponseEntity<PrincipalRateLimitEntity> getPrincipalRateLimitEntityWithHttpInfo(String principalRateLimitId)
                                                                                                          throws org.springframework.web.client.RestClientException

Retrieve a Principal Rate Limit Retrieves a Principal Rate Limit entity by `principalRateLimitId`

200 - OK

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

principalRateLimitId - id of the Principal Rate Limit (required)

Returns:

ResponseEntity<PrincipalRateLimitEntity>

Throws:

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

getPrincipalRateLimitEntityWithPaginationInfo

public PagedList getPrincipalRateLimitEntityWithPaginationInfo(String principalRateLimitId)
                                                        throws org.springframework.web.client.RestClientException

Retrieve a Principal Rate Limit Retrieves a Principal Rate Limit entity by `principalRateLimitId`

200 - OK

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

principalRateLimitId - id of the Principal Rate Limit (required)

Returns:

ResponseEntity<PrincipalRateLimitEntity>

Throws:

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

listPrincipalRateLimitEntities

public List<PrincipalRateLimitEntity> listPrincipalRateLimitEntities(String filter,
 String after,
 Integer limit)
                                                              throws org.springframework.web.client.RestClientException

List all Principal Rate Limits Lists all Principal Rate Limit entities considering the provided parameters

200 - OK

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

filter - (optional)

after - (optional)

limit - (optional, default to 20)

Returns:

List<PrincipalRateLimitEntity>

Throws:

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

listPrincipalRateLimitEntitiesWithHttpInfo

public org.springframework.http.ResponseEntity<List<PrincipalRateLimitEntity>> listPrincipalRateLimitEntitiesWithHttpInfo(String filter,
 String after,
 Integer limit)
                                                                                                                   throws org.springframework.web.client.RestClientException

List all Principal Rate Limits Lists all Principal Rate Limit entities considering the provided parameters

200 - OK

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

filter - (optional)

after - (optional)

limit - (optional, default to 20)

Returns:

ResponseEntity<List<PrincipalRateLimitEntity>>

Throws:

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

listPrincipalRateLimitEntitiesWithPaginationInfo

public PagedList listPrincipalRateLimitEntitiesWithPaginationInfo(String filter,
 String after,
 Integer limit)
                                                           throws org.springframework.web.client.RestClientException

List all Principal Rate Limits Lists all Principal Rate Limit entities considering the provided parameters

200 - OK

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

filter - (optional)

after - (optional)

limit - (optional, default to 20)

Returns:

ResponseEntity<List<PrincipalRateLimitEntity>>

Throws:

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

replacePrincipalRateLimitEntity

public PrincipalRateLimitEntity replacePrincipalRateLimitEntity(String principalRateLimitId,
 PrincipalRateLimitEntity entity)
                                                         throws org.springframework.web.client.RestClientException

Replace a Principal Rate Limit Replaces a principal rate limit entity by `principalRateLimitId`

200 - OK

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

principalRateLimitId - id of the Principal Rate Limit (required)

entity - (required)

Returns:

PrincipalRateLimitEntity

Throws:

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

replacePrincipalRateLimitEntity

public <T> T replacePrincipalRateLimitEntity(Class<?> T,
 String principalRateLimitId,
 PrincipalRateLimitEntity entity)
                                      throws org.springframework.web.client.RestClientException

Replace a Principal Rate Limit Replaces a principal rate limit entity by `principalRateLimitId`

200 - OK

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

principalRateLimitId - id of the Principal Rate Limit (required)

entity - (required)

Returns:

T instance

Throws:

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

replacePrincipalRateLimitEntityWithHttpInfo

public org.springframework.http.ResponseEntity<PrincipalRateLimitEntity> replacePrincipalRateLimitEntityWithHttpInfo(String principalRateLimitId,
 PrincipalRateLimitEntity entity)
                                                                                                              throws org.springframework.web.client.RestClientException

Replace a Principal Rate Limit Replaces a principal rate limit entity by `principalRateLimitId`

200 - OK

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

principalRateLimitId - id of the Principal Rate Limit (required)

entity - (required)

Returns:

ResponseEntity<PrincipalRateLimitEntity>

Throws:

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

replacePrincipalRateLimitEntityWithPaginationInfo

public PagedList replacePrincipalRateLimitEntityWithPaginationInfo(String principalRateLimitId,
 PrincipalRateLimitEntity entity)
                                                            throws org.springframework.web.client.RestClientException

Replace a Principal Rate Limit Replaces a principal rate limit entity by `principalRateLimitId`

200 - OK

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

principalRateLimitId - id of the Principal Rate Limit (required)

entity - (required)

Returns:

ResponseEntity<PrincipalRateLimitEntity>

Throws:

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