org.openapitools.client.api

Class PushProviderApi

java.lang.Object

org.openapitools.client.api.PushProviderApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2022-10-28T09:54:00.189-05:00[America/Chicago]")
 @Component(value="org.openapitools.client.api.PushProviderApi")
public class PushProviderApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
PushProviderApi()
PushProviderApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
<T> T	createPushProvider(java.lang.Class<?> T, PushProvider pushProvider) Create a Push Provider Creates a new push provider
PushProvider	createPushProvider(PushProvider pushProvider) Create a Push Provider Creates a new push provider
PagedList	createPushProviderWithPaginationInfo(PushProvider pushProvider) Create a Push Provider Creates a new push provider
void	deletePushProvider(java.lang.String pushProviderId) Delete a Push Provider Deletes a push provider by `pushProviderId`.
ApiClient	getApiClient()
PushProvider	getPushProvider(java.lang.String pushProviderId) Retrieve a Push Provider Retrieves a push provider by `pushProviderId`
PagedList	getPushProviderWithPaginationInfo(java.lang.String pushProviderId) Retrieve a Push Provider Retrieves a push provider by `pushProviderId`
java.util.List<PushProvider>	listPushProviders(ProviderType type) List all Push Providers Lists all push providers
PagedList	listPushProvidersWithPaginationInfo(ProviderType type) List all Push Providers Lists all push providers
<T> T	replacePushProvider(java.lang.Class<?> T, java.lang.String pushProviderId, PushProvider pushProvider) Replace a Push Provider Replaces a push provider by `pushProviderId`
PushProvider	replacePushProvider(java.lang.String pushProviderId, PushProvider pushProvider) Replace a Push Provider Replaces a push provider by `pushProviderId`
PagedList	replacePushProviderWithPaginationInfo(java.lang.String pushProviderId, PushProvider pushProvider) Replace a Push Provider Replaces a push provider by `pushProviderId`
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

PushProviderApi

public PushProviderApi()

PushProviderApi

@Autowired
public PushProviderApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createPushProvider

public PushProvider createPushProvider(PushProvider pushProvider)
                                throws org.springframework.web.client.RestClientException

Create a Push Provider Creates a new push provider

200 - OK

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

pushProvider - (required)

Returns:

PushProvider

Throws:

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

createPushProvider

public <T> T createPushProvider(java.lang.Class<?> T,
                                PushProvider pushProvider)
                         throws org.springframework.web.client.RestClientException

Create a Push Provider Creates a new push provider

200 - OK

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

pushProvider - (required)

Returns:

T instance

Throws:

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

createPushProviderWithPaginationInfo

public PagedList createPushProviderWithPaginationInfo(PushProvider pushProvider)
                                               throws org.springframework.web.client.RestClientException

Create a Push Provider Creates a new push provider

200 - OK

400 - Bad Request

403 - Forbidden

429 - Too Many Requests

Parameters:

pushProvider - (required)

Returns:

ResponseEntity<PushProvider>

Throws:

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

deletePushProvider

public void deletePushProvider(java.lang.String pushProviderId)
                        throws org.springframework.web.client.RestClientException

Delete a Push Provider Deletes a push provider by `pushProviderId`. If the push provider is currently being used in the org by a custom authenticator, the delete will not be allowed.

204 - No Content

403 - Forbidden

404 - Not Found

409 - Conflict

429 - Too Many Requests

Parameters:

pushProviderId - Id of the push provider (required)

Throws:

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

getPushProvider

public PushProvider getPushProvider(java.lang.String pushProviderId)
                             throws org.springframework.web.client.RestClientException

Retrieve a Push Provider Retrieves a push provider by `pushProviderId`

200 - OK

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

pushProviderId - Id of the push provider (required)

Returns:

PushProvider

Throws:

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

getPushProviderWithPaginationInfo

public PagedList getPushProviderWithPaginationInfo(java.lang.String pushProviderId)
                                            throws org.springframework.web.client.RestClientException

Retrieve a Push Provider Retrieves a push provider by `pushProviderId`

200 - OK

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

pushProviderId - Id of the push provider (required)

Returns:

ResponseEntity<PushProvider>

Throws:

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

listPushProviders

public java.util.List<PushProvider> listPushProviders(ProviderType type)
                                               throws org.springframework.web.client.RestClientException

List all Push Providers Lists all push providers

200 - OK

403 - Forbidden

429 - Too Many Requests

Parameters:

type - Filters push providers by `providerType` (optional)

Returns:

List<PushProvider>

Throws:

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

listPushProvidersWithPaginationInfo

public PagedList listPushProvidersWithPaginationInfo(ProviderType type)
                                              throws org.springframework.web.client.RestClientException

List all Push Providers Lists all push providers

200 - OK

403 - Forbidden

429 - Too Many Requests

Parameters:

type - Filters push providers by `providerType` (optional)

Returns:

ResponseEntity<List<PushProvider>>

Throws:

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

replacePushProvider

public PushProvider replacePushProvider(java.lang.String pushProviderId,
                                        PushProvider pushProvider)
                                 throws org.springframework.web.client.RestClientException

Replace a Push Provider Replaces a push provider by `pushProviderId`

200 - OK

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

pushProviderId - Id of the push provider (required)

pushProvider - (required)

Returns:

PushProvider

Throws:

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

replacePushProvider

public <T> T replacePushProvider(java.lang.Class<?> T,
                                 java.lang.String pushProviderId,
                                 PushProvider pushProvider)
                          throws org.springframework.web.client.RestClientException

Replace a Push Provider Replaces a push provider by `pushProviderId`

200 - OK

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

pushProviderId - Id of the push provider (required)

pushProvider - (required)

Returns:

T instance

Throws:

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

replacePushProviderWithPaginationInfo

public PagedList replacePushProviderWithPaginationInfo(java.lang.String pushProviderId,
                                                       PushProvider pushProvider)
                                                throws org.springframework.web.client.RestClientException

Replace a Push Provider Replaces a push provider by `pushProviderId`

200 - OK

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

pushProviderId - Id of the push provider (required)

pushProvider - (required)

Returns:

ResponseEntity<PushProvider>

Throws:

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