// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// Code generated by Microsoft (R) AutoRest Code Generator.

package com.azure.resourcemanager.customerinsights.fluent;

import com.azure.core.annotation.ReturnType;
import com.azure.core.annotation.ServiceMethod;
import com.azure.core.http.rest.PagedIterable;
import com.azure.core.http.rest.Response;
import com.azure.core.management.polling.PollResult;
import com.azure.core.util.Context;
import com.azure.core.util.polling.SyncPoller;
import com.azure.resourcemanager.customerinsights.fluent.models.KpiDefinitionInner;
import com.azure.resourcemanager.customerinsights.fluent.models.ProfileResourceFormatInner;
import java.util.List;

/** An instance of this class provides access to all the operations defined in ProfilesClient. */
public interface ProfilesClient {
    /**
     * Creates a profile within a Hub, or updates an existing profile.
     *
     * @param resourceGroupName The name of the resource group.
     * @param hubName The name of the hub.
     * @param profileName The name of the profile.
     * @param parameters Parameters supplied to the create/delete Profile type operation.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return the {@link SyncPoller} for polling of the profile resource format.
     */
    @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
    SyncPoller<PollResult<ProfileResourceFormatInner>, ProfileResourceFormatInner> beginCreateOrUpdate(
        String resourceGroupName, String hubName, String profileName, ProfileResourceFormatInner parameters);

    /**
     * Creates a profile within a Hub, or updates an existing profile.
     *
     * @param resourceGroupName The name of the resource group.
     * @param hubName The name of the hub.
     * @param profileName The name of the profile.
     * @param parameters Parameters supplied to the create/delete Profile type operation.
     * @param context The context to associate with this operation.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return the {@link SyncPoller} for polling of the profile resource format.
     */
    @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
    SyncPoller<PollResult<ProfileResourceFormatInner>, ProfileResourceFormatInner> beginCreateOrUpdate(
        String resourceGroupName,
        String hubName,
        String profileName,
        ProfileResourceFormatInner parameters,
        Context context);

    /**
     * Creates a profile within a Hub, or updates an existing profile.
     *
     * @param resourceGroupName The name of the resource group.
     * @param hubName The name of the hub.
     * @param profileName The name of the profile.
     * @param parameters Parameters supplied to the create/delete Profile type operation.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return the profile resource format.
     */
    @ServiceMethod(returns = ReturnType.SINGLE)
    ProfileResourceFormatInner createOrUpdate(
        String resourceGroupName, String hubName, String profileName, ProfileResourceFormatInner parameters);

    /**
     * Creates a profile within a Hub, or updates an existing profile.
     *
     * @param resourceGroupName The name of the resource group.
     * @param hubName The name of the hub.
     * @param profileName The name of the profile.
     * @param parameters Parameters supplied to the create/delete Profile type operation.
     * @param context The context to associate with this operation.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return the profile resource format.
     */
    @ServiceMethod(returns = ReturnType.SINGLE)
    ProfileResourceFormatInner createOrUpdate(
        String resourceGroupName,
        String hubName,
        String profileName,
        ProfileResourceFormatInner parameters,
        Context context);

    /**
     * Gets information about the specified profile.
     *
     * @param resourceGroupName The name of the resource group.
     * @param hubName The name of the hub.
     * @param profileName The name of the profile.
     * @param localeCode Locale of profile to retrieve, default is en-us.
     * @param context The context to associate with this operation.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return information about the specified profile along with {@link Response}.
     */
    @ServiceMethod(returns = ReturnType.SINGLE)
    Response<ProfileResourceFormatInner> getWithResponse(
        String resourceGroupName, String hubName, String profileName, String localeCode, Context context);

    /**
     * Gets information about the specified profile.
     *
     * @param resourceGroupName The name of the resource group.
     * @param hubName The name of the hub.
     * @param profileName The name of the profile.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return information about the specified profile.
     */
    @ServiceMethod(returns = ReturnType.SINGLE)
    ProfileResourceFormatInner get(String resourceGroupName, String hubName, String profileName);

    /**
     * Deletes a profile within a hub.
     *
     * @param resourceGroupName The name of the resource group.
     * @param hubName The name of the hub.
     * @param profileName The name of the profile.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return the {@link SyncPoller} for polling of long-running operation.
     */
    @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
    SyncPoller<PollResult<Void>, Void> beginDelete(String resourceGroupName, String hubName, String profileName);

    /**
     * Deletes a profile within a hub.
     *
     * @param resourceGroupName The name of the resource group.
     * @param hubName The name of the hub.
     * @param profileName The name of the profile.
     * @param localeCode Locale of profile to retrieve, default is en-us.
     * @param context The context to associate with this operation.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return the {@link SyncPoller} for polling of long-running operation.
     */
    @ServiceMethod(returns = ReturnType.LONG_RUNNING_OPERATION)
    SyncPoller<PollResult<Void>, Void> beginDelete(
        String resourceGroupName, String hubName, String profileName, String localeCode, Context context);

    /**
     * Deletes a profile within a hub.
     *
     * @param resourceGroupName The name of the resource group.
     * @param hubName The name of the hub.
     * @param profileName The name of the profile.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     */
    @ServiceMethod(returns = ReturnType.SINGLE)
    void delete(String resourceGroupName, String hubName, String profileName);

    /**
     * Deletes a profile within a hub.
     *
     * @param resourceGroupName The name of the resource group.
     * @param hubName The name of the hub.
     * @param profileName The name of the profile.
     * @param localeCode Locale of profile to retrieve, default is en-us.
     * @param context The context to associate with this operation.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     */
    @ServiceMethod(returns = ReturnType.SINGLE)
    void delete(String resourceGroupName, String hubName, String profileName, String localeCode, Context context);

    /**
     * Gets all profile in the hub.
     *
     * @param resourceGroupName The name of the resource group.
     * @param hubName The name of the hub.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return all profile in the hub as paginated response with {@link PagedIterable}.
     */
    @ServiceMethod(returns = ReturnType.COLLECTION)
    PagedIterable<ProfileResourceFormatInner> listByHub(String resourceGroupName, String hubName);

    /**
     * Gets all profile in the hub.
     *
     * @param resourceGroupName The name of the resource group.
     * @param hubName The name of the hub.
     * @param localeCode Locale of profile to retrieve, default is en-us.
     * @param context The context to associate with this operation.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return all profile in the hub as paginated response with {@link PagedIterable}.
     */
    @ServiceMethod(returns = ReturnType.COLLECTION)
    PagedIterable<ProfileResourceFormatInner> listByHub(
        String resourceGroupName, String hubName, String localeCode, Context context);

    /**
     * Gets the KPIs that enrich the profile Type identified by the supplied name. Enrichment happens through
     * participants of the Interaction on an Interaction KPI and through Relationships for Profile KPIs.
     *
     * @param resourceGroupName The name of the resource group.
     * @param hubName The name of the hub.
     * @param profileName The name of the profile.
     * @param context The context to associate with this operation.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return the KPIs that enrich the profile Type identified by the supplied name along with {@link Response}.
     */
    @ServiceMethod(returns = ReturnType.SINGLE)
    Response<List<KpiDefinitionInner>> getEnrichingKpisWithResponse(
        String resourceGroupName, String hubName, String profileName, Context context);

    /**
     * Gets the KPIs that enrich the profile Type identified by the supplied name. Enrichment happens through
     * participants of the Interaction on an Interaction KPI and through Relationships for Profile KPIs.
     *
     * @param resourceGroupName The name of the resource group.
     * @param hubName The name of the hub.
     * @param profileName The name of the profile.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return the KPIs that enrich the profile Type identified by the supplied name.
     */
    @ServiceMethod(returns = ReturnType.SINGLE)
    List<KpiDefinitionInner> getEnrichingKpis(String resourceGroupName, String hubName, String profileName);
}
