Class IntegrationsApi


  • public class IntegrationsApi
    extends java.lang.Object
    • Constructor Detail

      • IntegrationsApi

        public IntegrationsApi()
      • IntegrationsApi

        public IntegrationsApi​(ApiClient apiClient)
    • Method Detail

      • getApiClient

        public ApiClient getApiClient()
      • setApiClient

        public void setApiClient​(ApiClient apiClient)
      • getHostIndex

        public int getHostIndex()
      • setHostIndex

        public void setHostIndex​(int hostIndex)
      • getCustomBaseUrl

        public java.lang.String getCustomBaseUrl()
      • setCustomBaseUrl

        public void setCustomBaseUrl​(java.lang.String customBaseUrl)
      • createIntegrationCall

        public okhttp3.Call createIntegrationCall​(java.util.UUID productId,
                                                  CreateIntegrationModel createIntegrationModel,
                                                  ApiCallback _callback)
                                           throws ApiException
        Build call for createIntegration
        Parameters:
        productId - The identifier of the Product. (required)
        createIntegrationModel - (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details
        Status Code Description Response Headers
        201 When the creation was successful. -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -
      • createIntegration

        public IntegrationModel createIntegration​(java.util.UUID productId,
                                                  CreateIntegrationModel createIntegrationModel)
                                           throws ApiException
        Create Integration This endpoint creates a new Integration in a specified Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint. The Parameters dictionary differs for each IntegrationType: - Datadog - `apikey`: Required. Datadog API key. - `site`: Datadog site. Available values: `Us`, `Eu`, `Us1Fed`, `Us3`, `Us5`. Default: `Us`. - Slack Connecting the Slack integration through the Public Management API will not post messages with the ConfigCat Feature Flags Slack app but with an incoming webhook. - `incoming_webhook.url`: Required. The [incoming webhook URL](https://api.slack.com/messaging/webhooks) where the integration should post messages. - Amplitude - `apiKey`: Required. Amplitude API Key. - `secretKey`: Required. Amplitude Secret Key. - Mixpanel - `serviceAccountUserName`: Required. Mixpanel Service Account Username. - `serviceAccountSecret`: Required. Mixpanel Service Account Secret. - `projectId`: Required. Mixpanel Project ID. - `server`: Mixpanel Server. Available values: `StandardServer`, `EUResidencyServer`. Default: `StandardServer`. - Twilio Segment - `writeKey`: Required. Twilio Segment Write Key. - `server`: Twilio Segment Server. Available values: `Us`, `Eu`. Default: `Us`. - PubNub (work in progress)
        Parameters:
        productId - The identifier of the Product. (required)
        createIntegrationModel - (required)
        Returns:
        IntegrationModel
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details
        Status Code Description Response Headers
        201 When the creation was successful. -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -
      • createIntegrationWithHttpInfo

        public ApiResponse<IntegrationModel> createIntegrationWithHttpInfo​(java.util.UUID productId,
                                                                           CreateIntegrationModel createIntegrationModel)
                                                                    throws ApiException
        Create Integration This endpoint creates a new Integration in a specified Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint. The Parameters dictionary differs for each IntegrationType: - Datadog - `apikey`: Required. Datadog API key. - `site`: Datadog site. Available values: `Us`, `Eu`, `Us1Fed`, `Us3`, `Us5`. Default: `Us`. - Slack Connecting the Slack integration through the Public Management API will not post messages with the ConfigCat Feature Flags Slack app but with an incoming webhook. - `incoming_webhook.url`: Required. The [incoming webhook URL](https://api.slack.com/messaging/webhooks) where the integration should post messages. - Amplitude - `apiKey`: Required. Amplitude API Key. - `secretKey`: Required. Amplitude Secret Key. - Mixpanel - `serviceAccountUserName`: Required. Mixpanel Service Account Username. - `serviceAccountSecret`: Required. Mixpanel Service Account Secret. - `projectId`: Required. Mixpanel Project ID. - `server`: Mixpanel Server. Available values: `StandardServer`, `EUResidencyServer`. Default: `StandardServer`. - Twilio Segment - `writeKey`: Required. Twilio Segment Write Key. - `server`: Twilio Segment Server. Available values: `Us`, `Eu`. Default: `Us`. - PubNub (work in progress)
        Parameters:
        productId - The identifier of the Product. (required)
        createIntegrationModel - (required)
        Returns:
        ApiResponse<IntegrationModel>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details
        Status Code Description Response Headers
        201 When the creation was successful. -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -
      • createIntegrationAsync

        public okhttp3.Call createIntegrationAsync​(java.util.UUID productId,
                                                   CreateIntegrationModel createIntegrationModel,
                                                   ApiCallback<IntegrationModel> _callback)
                                            throws ApiException
        Create Integration (asynchronously) This endpoint creates a new Integration in a specified Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint. The Parameters dictionary differs for each IntegrationType: - Datadog - `apikey`: Required. Datadog API key. - `site`: Datadog site. Available values: `Us`, `Eu`, `Us1Fed`, `Us3`, `Us5`. Default: `Us`. - Slack Connecting the Slack integration through the Public Management API will not post messages with the ConfigCat Feature Flags Slack app but with an incoming webhook. - `incoming_webhook.url`: Required. The [incoming webhook URL](https://api.slack.com/messaging/webhooks) where the integration should post messages. - Amplitude - `apiKey`: Required. Amplitude API Key. - `secretKey`: Required. Amplitude Secret Key. - Mixpanel - `serviceAccountUserName`: Required. Mixpanel Service Account Username. - `serviceAccountSecret`: Required. Mixpanel Service Account Secret. - `projectId`: Required. Mixpanel Project ID. - `server`: Mixpanel Server. Available values: `StandardServer`, `EUResidencyServer`. Default: `StandardServer`. - Twilio Segment - `writeKey`: Required. Twilio Segment Write Key. - `server`: Twilio Segment Server. Available values: `Us`, `Eu`. Default: `Us`. - PubNub (work in progress)
        Parameters:
        productId - The identifier of the Product. (required)
        createIntegrationModel - (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details
        Status Code Description Response Headers
        201 When the creation was successful. -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -
      • deleteIntegrationCall

        public okhttp3.Call deleteIntegrationCall​(java.util.UUID integrationId,
                                                  ApiCallback _callback)
                                           throws ApiException
        Build call for deleteIntegration
        Parameters:
        integrationId - The identifier of the Integration. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details
        Status Code Description Response Headers
        204 When the delete was successful. -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -
      • deleteIntegration

        public void deleteIntegration​(java.util.UUID integrationId)
                               throws ApiException
        Delete Integration This endpoint removes a Integration identified by the `integrationId` parameter.
        Parameters:
        integrationId - The identifier of the Integration. (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details
        Status Code Description Response Headers
        204 When the delete was successful. -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -
      • deleteIntegrationWithHttpInfo

        public ApiResponse<java.lang.Void> deleteIntegrationWithHttpInfo​(java.util.UUID integrationId)
                                                                  throws ApiException
        Delete Integration This endpoint removes a Integration identified by the `integrationId` parameter.
        Parameters:
        integrationId - The identifier of the Integration. (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details
        Status Code Description Response Headers
        204 When the delete was successful. -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -
      • deleteIntegrationAsync

        public okhttp3.Call deleteIntegrationAsync​(java.util.UUID integrationId,
                                                   ApiCallback<java.lang.Void> _callback)
                                            throws ApiException
        Delete Integration (asynchronously) This endpoint removes a Integration identified by the `integrationId` parameter.
        Parameters:
        integrationId - The identifier of the Integration. (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details
        Status Code Description Response Headers
        204 When the delete was successful. -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -
      • getIntegrationCall

        public okhttp3.Call getIntegrationCall​(java.util.UUID integrationId,
                                               ApiCallback _callback)
                                        throws ApiException
        Build call for getIntegration
        Parameters:
        integrationId - The identifier of the Integration. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details
        Status Code Description Response Headers
        200 When everything is ok, the integration data returned. -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -
      • getIntegration

        public IntegrationModel getIntegration​(java.util.UUID integrationId)
                                        throws ApiException
        Get Integration This endpoint returns the metadata of an Integration identified by the `integrationId`.
        Parameters:
        integrationId - The identifier of the Integration. (required)
        Returns:
        IntegrationModel
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details
        Status Code Description Response Headers
        200 When everything is ok, the integration data returned. -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -
      • getIntegrationWithHttpInfo

        public ApiResponse<IntegrationModel> getIntegrationWithHttpInfo​(java.util.UUID integrationId)
                                                                 throws ApiException
        Get Integration This endpoint returns the metadata of an Integration identified by the `integrationId`.
        Parameters:
        integrationId - The identifier of the Integration. (required)
        Returns:
        ApiResponse<IntegrationModel>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details
        Status Code Description Response Headers
        200 When everything is ok, the integration data returned. -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -
      • getIntegrationAsync

        public okhttp3.Call getIntegrationAsync​(java.util.UUID integrationId,
                                                ApiCallback<IntegrationModel> _callback)
                                         throws ApiException
        Get Integration (asynchronously) This endpoint returns the metadata of an Integration identified by the `integrationId`.
        Parameters:
        integrationId - The identifier of the Integration. (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details
        Status Code Description Response Headers
        200 When everything is ok, the integration data returned. -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -
      • getIntegrationsCall

        public okhttp3.Call getIntegrationsCall​(java.util.UUID productId,
                                                ApiCallback _callback)
                                         throws ApiException
        Build call for getIntegrations
        Parameters:
        productId - The identifier of the Product. (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details
        Status Code Description Response Headers
        200 -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -
      • getIntegrations

        public IntegrationsModel getIntegrations​(java.util.UUID productId)
                                          throws ApiException
        List Integrations This endpoint returns the list of the Integrations that belongs to the given Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.
        Parameters:
        productId - The identifier of the Product. (required)
        Returns:
        IntegrationsModel
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details
        Status Code Description Response Headers
        200 -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -
      • getIntegrationsWithHttpInfo

        public ApiResponse<IntegrationsModel> getIntegrationsWithHttpInfo​(java.util.UUID productId)
                                                                   throws ApiException
        List Integrations This endpoint returns the list of the Integrations that belongs to the given Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.
        Parameters:
        productId - The identifier of the Product. (required)
        Returns:
        ApiResponse<IntegrationsModel>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details
        Status Code Description Response Headers
        200 -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -
      • getIntegrationsAsync

        public okhttp3.Call getIntegrationsAsync​(java.util.UUID productId,
                                                 ApiCallback<IntegrationsModel> _callback)
                                          throws ApiException
        List Integrations (asynchronously) This endpoint returns the list of the Integrations that belongs to the given Product identified by the `productId` parameter, which can be obtained from the [List Products](#operation/get-products) endpoint.
        Parameters:
        productId - The identifier of the Product. (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details
        Status Code Description Response Headers
        200 -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -
      • updateIntegrationCall

        public okhttp3.Call updateIntegrationCall​(java.util.UUID integrationId,
                                                  ModifyIntegrationRequest modifyIntegrationRequest,
                                                  ApiCallback _callback)
                                           throws ApiException
        Build call for updateIntegration
        Parameters:
        integrationId - The identifier of the Integration. (required)
        modifyIntegrationRequest - (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details
        Status Code Description Response Headers
        200 -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -
      • updateIntegration

        public IntegrationModel updateIntegration​(java.util.UUID integrationId,
                                                  ModifyIntegrationRequest modifyIntegrationRequest)
                                           throws ApiException
        Update Integration This endpoint updates a Config identified by the `integrationId` parameter. The Parameters dictionary differs for each IntegrationType: - Datadog - `apikey`: Required. Datadog API key. - `site`: Datadog site. Available values: `Us`, `Eu`, `Us1Fed`, `Us3`, `Us5`. Default: `Us`. - Slack Connecting the Slack integration through the Public Management API will not post messages with the ConfigCat Feature Flags Slack app but with an incoming webhook. - `incoming_webhook.url`: Required. The [incoming webhook URL](https://api.slack.com/messaging/webhooks) where the integration should post messages. - Amplitude - `apiKey`: Required. Amplitude API Key. - `secretKey`: Required. Amplitude Secret Key. - Mixpanel - `serviceAccountUserName`: Required. Mixpanel Service Account Username. - `serviceAccountSecret`: Required. Mixpanel Service Account Secret. - `projectId`: Required. Mixpanel Project ID. - `server`: Mixpanel Server. Available values: `StandardServer`, `EUResidencyServer`. Default: `StandardServer`. - Twilio Segment - `writeKey`: Required. Twilio Segment Write Key. - `server`: Twilio Segment Server. Available values: `Us`, `Eu`. Default: `Us`. - PubNub (work in progress)
        Parameters:
        integrationId - The identifier of the Integration. (required)
        modifyIntegrationRequest - (required)
        Returns:
        IntegrationModel
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details
        Status Code Description Response Headers
        200 -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -
      • updateIntegrationWithHttpInfo

        public ApiResponse<IntegrationModel> updateIntegrationWithHttpInfo​(java.util.UUID integrationId,
                                                                           ModifyIntegrationRequest modifyIntegrationRequest)
                                                                    throws ApiException
        Update Integration This endpoint updates a Config identified by the `integrationId` parameter. The Parameters dictionary differs for each IntegrationType: - Datadog - `apikey`: Required. Datadog API key. - `site`: Datadog site. Available values: `Us`, `Eu`, `Us1Fed`, `Us3`, `Us5`. Default: `Us`. - Slack Connecting the Slack integration through the Public Management API will not post messages with the ConfigCat Feature Flags Slack app but with an incoming webhook. - `incoming_webhook.url`: Required. The [incoming webhook URL](https://api.slack.com/messaging/webhooks) where the integration should post messages. - Amplitude - `apiKey`: Required. Amplitude API Key. - `secretKey`: Required. Amplitude Secret Key. - Mixpanel - `serviceAccountUserName`: Required. Mixpanel Service Account Username. - `serviceAccountSecret`: Required. Mixpanel Service Account Secret. - `projectId`: Required. Mixpanel Project ID. - `server`: Mixpanel Server. Available values: `StandardServer`, `EUResidencyServer`. Default: `StandardServer`. - Twilio Segment - `writeKey`: Required. Twilio Segment Write Key. - `server`: Twilio Segment Server. Available values: `Us`, `Eu`. Default: `Us`. - PubNub (work in progress)
        Parameters:
        integrationId - The identifier of the Integration. (required)
        modifyIntegrationRequest - (required)
        Returns:
        ApiResponse<IntegrationModel>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details
        Status Code Description Response Headers
        200 -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -
      • updateIntegrationAsync

        public okhttp3.Call updateIntegrationAsync​(java.util.UUID integrationId,
                                                   ModifyIntegrationRequest modifyIntegrationRequest,
                                                   ApiCallback<IntegrationModel> _callback)
                                            throws ApiException
        Update Integration (asynchronously) This endpoint updates a Config identified by the `integrationId` parameter. The Parameters dictionary differs for each IntegrationType: - Datadog - `apikey`: Required. Datadog API key. - `site`: Datadog site. Available values: `Us`, `Eu`, `Us1Fed`, `Us3`, `Us5`. Default: `Us`. - Slack Connecting the Slack integration through the Public Management API will not post messages with the ConfigCat Feature Flags Slack app but with an incoming webhook. - `incoming_webhook.url`: Required. The [incoming webhook URL](https://api.slack.com/messaging/webhooks) where the integration should post messages. - Amplitude - `apiKey`: Required. Amplitude API Key. - `secretKey`: Required. Amplitude Secret Key. - Mixpanel - `serviceAccountUserName`: Required. Mixpanel Service Account Username. - `serviceAccountSecret`: Required. Mixpanel Service Account Secret. - `projectId`: Required. Mixpanel Project ID. - `server`: Mixpanel Server. Available values: `StandardServer`, `EUResidencyServer`. Default: `StandardServer`. - Twilio Segment - `writeKey`: Required. Twilio Segment Write Key. - `server`: Twilio Segment Server. Available values: `Us`, `Eu`. Default: `Us`. - PubNub (work in progress)
        Parameters:
        integrationId - The identifier of the Integration. (required)
        modifyIntegrationRequest - (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details
        Status Code Description Response Headers
        200 -
        400 Bad request. -
        404 Not found. -
        429 Too many requests. In case of the request rate exceeds the rate limits. -