org.openapitools.client.api

Class PushProviderApi

java.lang.Object

org.openapitools.client.api.PushProviderApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-07-14T23:40:43.026Z[Etc/UTC]")
public class PushProviderApi
extends Object

Constructor Summary

Constructors

Constructor and Description
PushProviderApi()
PushProviderApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
PushProvider	createPushProvider(PushProvider pushProvider) Create a Push Provider Creates a new push provider
PushProvider	createPushProvider(PushProvider pushProvider, Map<String,String> additionalHeaders) Create a Push Provider Creates a new push provider
void	deletePushProvider(String pushProviderId) Delete a Push Provider Deletes a push provider by `pushProviderId`.
void	deletePushProvider(String pushProviderId, Map<String,String> additionalHeaders) Delete a Push Provider Deletes a push provider by `pushProviderId`.
ApiClient	getApiClient()
protected static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
PushProvider	getPushProvider(String pushProviderId) Retrieve a Push Provider Retrieves a push provider by `pushProviderId`
PushProvider	getPushProvider(String pushProviderId, Map<String,String> additionalHeaders) Retrieve a Push Provider Retrieves a push provider by `pushProviderId`
List<PushProvider>	listPushProviders(ProviderType type) List all Push Providers Lists all push providers
List<PushProvider>	listPushProviders(ProviderType type, Map<String,String> additionalHeaders) List all Push Providers Lists all push providers
PushProvider	replacePushProvider(String pushProviderId, PushProvider pushProvider) Replace a Push Provider Replaces a push provider by `pushProviderId`
PushProvider	replacePushProvider(String pushProviderId, PushProvider pushProvider, Map<String,String> additionalHeaders) 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

public PushProviderApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createPushProvider

public PushProvider createPushProvider(PushProvider pushProvider)
                                throws ApiException

Create a Push Provider Creates a new push provider

Parameters:

pushProvider - (required)

Returns:

PushProvider

Throws:

ApiException - if fails to make API call

createPushProvider

public PushProvider createPushProvider(PushProvider pushProvider,
                                       Map<String,String> additionalHeaders)
                                throws ApiException

Create a Push Provider Creates a new push provider

Parameters:

pushProvider - (required)

additionalHeaders - additionalHeaders for this call

Returns:

PushProvider

Throws:

ApiException - if fails to make API call

deletePushProvider

public void deletePushProvider(String pushProviderId)
                        throws ApiException

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.

Parameters:

pushProviderId - Id of the push provider (required)

Throws:

ApiException - if fails to make API call

deletePushProvider

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

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.

Parameters:

pushProviderId - Id of the push provider (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

getPushProvider

public PushProvider getPushProvider(String pushProviderId)
                             throws ApiException

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

Parameters:

pushProviderId - Id of the push provider (required)

Returns:

PushProvider

Throws:

ApiException - if fails to make API call

getPushProvider

public PushProvider getPushProvider(String pushProviderId,
                                    Map<String,String> additionalHeaders)
                             throws ApiException

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

Parameters:

pushProviderId - Id of the push provider (required)

additionalHeaders - additionalHeaders for this call

Returns:

PushProvider

Throws:

ApiException - if fails to make API call

listPushProviders

public List<PushProvider> listPushProviders(ProviderType type)
                                     throws ApiException

List all Push Providers Lists all push providers

Parameters:

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

Returns:

List<PushProvider>

Throws:

ApiException - if fails to make API call

listPushProviders

public List<PushProvider> listPushProviders(ProviderType type,
                                            Map<String,String> additionalHeaders)
                                     throws ApiException

List all Push Providers Lists all push providers

Parameters:

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

additionalHeaders - additionalHeaders for this call

Returns:

List<PushProvider>

Throws:

ApiException - if fails to make API call

replacePushProvider

public PushProvider replacePushProvider(String pushProviderId,
                                        PushProvider pushProvider)
                                 throws ApiException

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

Parameters:

pushProviderId - Id of the push provider (required)

pushProvider - (required)

Returns:

PushProvider

Throws:

ApiException - if fails to make API call

replacePushProvider

public PushProvider replacePushProvider(String pushProviderId,
                                        PushProvider pushProvider,
                                        Map<String,String> additionalHeaders)
                                 throws ApiException

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

Parameters:

pushProviderId - Id of the push provider (required)

pushProvider - (required)

additionalHeaders - additionalHeaders for this call

Returns:

PushProvider

Throws:

ApiException - if fails to make API call

getObjectMapper

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