org.openapitools.client.api

Class ApiServiceIntegrationsApi

java.lang.Object

org.openapitools.client.api.ApiServiceIntegrationsApi

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

Constructor Summary

Constructors

Constructor and Description
ApiServiceIntegrationsApi()
ApiServiceIntegrationsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
APIServiceIntegrationInstanceSecret	activateApiServiceIntegrationInstanceSecret(String apiServiceId, String secretId) Activate an API Service Integration instance Secret Activates an API Service Integration instance Secret by `secretId`
APIServiceIntegrationInstanceSecret	activateApiServiceIntegrationInstanceSecret(String apiServiceId, String secretId, Map<String,String> additionalHeaders) Activate an API Service Integration instance Secret Activates an API Service Integration instance Secret by `secretId`
PostAPIServiceIntegrationInstance	createApiServiceIntegrationInstance(PostAPIServiceIntegrationInstanceRequest postAPIServiceIntegrationInstanceRequest) Create an API Service Integration instance Creates and authorizes an API Service Integration instance
PostAPIServiceIntegrationInstance	createApiServiceIntegrationInstance(PostAPIServiceIntegrationInstanceRequest postAPIServiceIntegrationInstanceRequest, Map<String,String> additionalHeaders) Create an API Service Integration instance Creates and authorizes an API Service Integration instance
APIServiceIntegrationInstanceSecret	createApiServiceIntegrationInstanceSecret(String apiServiceId) Create an API Service Integration instance Secret Creates an API Service Integration instance Secret object with a new active client secret.
APIServiceIntegrationInstanceSecret	createApiServiceIntegrationInstanceSecret(String apiServiceId, Map<String,String> additionalHeaders) Create an API Service Integration instance Secret Creates an API Service Integration instance Secret object with a new active client secret.
APIServiceIntegrationInstanceSecret	deactivateApiServiceIntegrationInstanceSecret(String apiServiceId, String secretId) Deactivate an API Service Integration instance Secret Deactivates an API Service Integration instance Secret by `secretId`
APIServiceIntegrationInstanceSecret	deactivateApiServiceIntegrationInstanceSecret(String apiServiceId, String secretId, Map<String,String> additionalHeaders) Deactivate an API Service Integration instance Secret Deactivates an API Service Integration instance Secret by `secretId`
void	deleteApiServiceIntegrationInstance(String apiServiceId) Delete an API Service Integration instance Deletes an API Service Integration instance by `id`.
void	deleteApiServiceIntegrationInstance(String apiServiceId, Map<String,String> additionalHeaders) Delete an API Service Integration instance Deletes an API Service Integration instance by `id`.
void	deleteApiServiceIntegrationInstanceSecret(String apiServiceId, String secretId) Delete an API Service Integration instance Secret Deletes an API Service Integration instance Secret by `secretId`.
void	deleteApiServiceIntegrationInstanceSecret(String apiServiceId, String secretId, Map<String,String> additionalHeaders) Delete an API Service Integration instance Secret Deletes an API Service Integration instance Secret by `secretId`.
ApiClient	getApiClient()
APIServiceIntegrationInstance	getApiServiceIntegrationInstance(String apiServiceId) Retrieve an API Service Integration instance Retrieves an API Service Integration instance by `id`
APIServiceIntegrationInstance	getApiServiceIntegrationInstance(String apiServiceId, Map<String,String> additionalHeaders) Retrieve an API Service Integration instance Retrieves an API Service Integration instance by `id`
protected static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
List<APIServiceIntegrationInstance>	listApiServiceIntegrationInstances(String after) List all API Service Integration instances Lists all API Service Integration instances with a pagination option
List<APIServiceIntegrationInstance>	listApiServiceIntegrationInstances(String after, Map<String,String> additionalHeaders) List all API Service Integration instances Lists all API Service Integration instances with a pagination option
List<APIServiceIntegrationInstanceSecret>	listApiServiceIntegrationInstanceSecrets(String apiServiceId) List all API Service Integration instance Secrets Lists all client secrets for an API Service Integration instance by `apiServiceId`
List<APIServiceIntegrationInstanceSecret>	listApiServiceIntegrationInstanceSecrets(String apiServiceId, Map<String,String> additionalHeaders) List all API Service Integration instance Secrets Lists all client secrets for an API Service Integration instance by `apiServiceId`
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

ApiServiceIntegrationsApi

public ApiServiceIntegrationsApi()

ApiServiceIntegrationsApi

public ApiServiceIntegrationsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

activateApiServiceIntegrationInstanceSecret

public APIServiceIntegrationInstanceSecret activateApiServiceIntegrationInstanceSecret(String apiServiceId,
                                                                                       String secretId)
                                                                                throws ApiException

Activate an API Service Integration instance Secret Activates an API Service Integration instance Secret by `secretId`

Parameters:

apiServiceId - `id` of the API Service Integration instance (required)

secretId - `id` of the API Service Integration instance Secret (required)

Returns:

APIServiceIntegrationInstanceSecret

Throws:

ApiException - if fails to make API call

activateApiServiceIntegrationInstanceSecret

public APIServiceIntegrationInstanceSecret activateApiServiceIntegrationInstanceSecret(String apiServiceId,
                                                                                       String secretId,
                                                                                       Map<String,String> additionalHeaders)
                                                                                throws ApiException

Activate an API Service Integration instance Secret Activates an API Service Integration instance Secret by `secretId`

Parameters:

apiServiceId - `id` of the API Service Integration instance (required)

secretId - `id` of the API Service Integration instance Secret (required)

additionalHeaders - additionalHeaders for this call

Returns:

APIServiceIntegrationInstanceSecret

Throws:

ApiException - if fails to make API call

createApiServiceIntegrationInstance

public PostAPIServiceIntegrationInstance createApiServiceIntegrationInstance(PostAPIServiceIntegrationInstanceRequest postAPIServiceIntegrationInstanceRequest)
                                                                      throws ApiException

Create an API Service Integration instance Creates and authorizes an API Service Integration instance

Parameters:

postAPIServiceIntegrationInstanceRequest - (required)

Returns:

PostAPIServiceIntegrationInstance

Throws:

ApiException - if fails to make API call

createApiServiceIntegrationInstance

public PostAPIServiceIntegrationInstance createApiServiceIntegrationInstance(PostAPIServiceIntegrationInstanceRequest postAPIServiceIntegrationInstanceRequest,
                                                                             Map<String,String> additionalHeaders)
                                                                      throws ApiException

Create an API Service Integration instance Creates and authorizes an API Service Integration instance

Parameters:

postAPIServiceIntegrationInstanceRequest - (required)

additionalHeaders - additionalHeaders for this call

Returns:

PostAPIServiceIntegrationInstance

Throws:

ApiException - if fails to make API call

createApiServiceIntegrationInstanceSecret

public APIServiceIntegrationInstanceSecret createApiServiceIntegrationInstanceSecret(String apiServiceId)
                                                                              throws ApiException

Create an API Service Integration instance Secret Creates an API Service Integration instance Secret object with a new active client secret. You can create up to two Secret objects. An error is returned if you attempt to create more than two Secret objects.

Parameters:

apiServiceId - `id` of the API Service Integration instance (required)

Returns:

APIServiceIntegrationInstanceSecret

Throws:

ApiException - if fails to make API call

createApiServiceIntegrationInstanceSecret

public APIServiceIntegrationInstanceSecret createApiServiceIntegrationInstanceSecret(String apiServiceId,
                                                                                     Map<String,String> additionalHeaders)
                                                                              throws ApiException

Create an API Service Integration instance Secret Creates an API Service Integration instance Secret object with a new active client secret. You can create up to two Secret objects. An error is returned if you attempt to create more than two Secret objects.

Parameters:

apiServiceId - `id` of the API Service Integration instance (required)

additionalHeaders - additionalHeaders for this call

Returns:

APIServiceIntegrationInstanceSecret

Throws:

ApiException - if fails to make API call

deactivateApiServiceIntegrationInstanceSecret

public APIServiceIntegrationInstanceSecret deactivateApiServiceIntegrationInstanceSecret(String apiServiceId,
                                                                                         String secretId)
                                                                                  throws ApiException

Deactivate an API Service Integration instance Secret Deactivates an API Service Integration instance Secret by `secretId`

Parameters:

apiServiceId - `id` of the API Service Integration instance (required)

secretId - `id` of the API Service Integration instance Secret (required)

Returns:

APIServiceIntegrationInstanceSecret

Throws:

ApiException - if fails to make API call

deactivateApiServiceIntegrationInstanceSecret

public APIServiceIntegrationInstanceSecret deactivateApiServiceIntegrationInstanceSecret(String apiServiceId,
                                                                                         String secretId,
                                                                                         Map<String,String> additionalHeaders)
                                                                                  throws ApiException

Deactivate an API Service Integration instance Secret Deactivates an API Service Integration instance Secret by `secretId`

Parameters:

apiServiceId - `id` of the API Service Integration instance (required)

secretId - `id` of the API Service Integration instance Secret (required)

additionalHeaders - additionalHeaders for this call

Returns:

APIServiceIntegrationInstanceSecret

Throws:

ApiException - if fails to make API call

deleteApiServiceIntegrationInstance

public void deleteApiServiceIntegrationInstance(String apiServiceId)
                                         throws ApiException

Delete an API Service Integration instance Deletes an API Service Integration instance by `id`. This operation also revokes access to scopes that were previously granted to this API Service Integration instance.

Parameters:

apiServiceId - `id` of the API Service Integration instance (required)

Throws:

ApiException - if fails to make API call

deleteApiServiceIntegrationInstance

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

Delete an API Service Integration instance Deletes an API Service Integration instance by `id`. This operation also revokes access to scopes that were previously granted to this API Service Integration instance.

Parameters:

apiServiceId - `id` of the API Service Integration instance (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

deleteApiServiceIntegrationInstanceSecret

public void deleteApiServiceIntegrationInstanceSecret(String apiServiceId,
                                                      String secretId)
                                               throws ApiException

Delete an API Service Integration instance Secret Deletes an API Service Integration instance Secret by `secretId`. You can only delete an inactive Secret.

Parameters:

apiServiceId - `id` of the API Service Integration instance (required)

secretId - `id` of the API Service Integration instance Secret (required)

Throws:

ApiException - if fails to make API call

deleteApiServiceIntegrationInstanceSecret

public void deleteApiServiceIntegrationInstanceSecret(String apiServiceId,
                                                      String secretId,
                                                      Map<String,String> additionalHeaders)
                                               throws ApiException

Delete an API Service Integration instance Secret Deletes an API Service Integration instance Secret by `secretId`. You can only delete an inactive Secret.

Parameters:

apiServiceId - `id` of the API Service Integration instance (required)

secretId - `id` of the API Service Integration instance Secret (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

getApiServiceIntegrationInstance

public APIServiceIntegrationInstance getApiServiceIntegrationInstance(String apiServiceId)
                                                               throws ApiException

Retrieve an API Service Integration instance Retrieves an API Service Integration instance by `id`

Parameters:

apiServiceId - `id` of the API Service Integration instance (required)

Returns:

APIServiceIntegrationInstance

Throws:

ApiException - if fails to make API call

getApiServiceIntegrationInstance

public APIServiceIntegrationInstance getApiServiceIntegrationInstance(String apiServiceId,
                                                                      Map<String,String> additionalHeaders)
                                                               throws ApiException

Retrieve an API Service Integration instance Retrieves an API Service Integration instance by `id`

Parameters:

apiServiceId - `id` of the API Service Integration instance (required)

additionalHeaders - additionalHeaders for this call

Returns:

APIServiceIntegrationInstance

Throws:

ApiException - if fails to make API call

listApiServiceIntegrationInstanceSecrets

public List<APIServiceIntegrationInstanceSecret> listApiServiceIntegrationInstanceSecrets(String apiServiceId)
                                                                                   throws ApiException

List all API Service Integration instance Secrets Lists all client secrets for an API Service Integration instance by `apiServiceId`

Parameters:

apiServiceId - `id` of the API Service Integration instance (required)

Returns:

List<APIServiceIntegrationInstanceSecret>

Throws:

ApiException - if fails to make API call

listApiServiceIntegrationInstanceSecrets

public List<APIServiceIntegrationInstanceSecret> listApiServiceIntegrationInstanceSecrets(String apiServiceId,
                                                                                          Map<String,String> additionalHeaders)
                                                                                   throws ApiException

List all API Service Integration instance Secrets Lists all client secrets for an API Service Integration instance by `apiServiceId`

Parameters:

apiServiceId - `id` of the API Service Integration instance (required)

additionalHeaders - additionalHeaders for this call

Returns:

List<APIServiceIntegrationInstanceSecret>

Throws:

ApiException - if fails to make API call

listApiServiceIntegrationInstances

public List<APIServiceIntegrationInstance> listApiServiceIntegrationInstances(String after)
                                                                       throws ApiException

List all API Service Integration instances Lists all API Service Integration instances with a pagination option

Parameters:

after - The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](/#pagination) for more information. (optional)

Returns:

List<APIServiceIntegrationInstance>

Throws:

ApiException - if fails to make API call

listApiServiceIntegrationInstances

public List<APIServiceIntegrationInstance> listApiServiceIntegrationInstances(String after,
                                                                              Map<String,String> additionalHeaders)
                                                                       throws ApiException

List all API Service Integration instances Lists all API Service Integration instances with a pagination option

Parameters:

after - The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](/#pagination) for more information. (optional)

additionalHeaders - additionalHeaders for this call

Returns:

List<APIServiceIntegrationInstance>

Throws:

ApiException - if fails to make API call

getObjectMapper

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