// 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.models;

import com.azure.core.http.rest.PagedIterable;
import com.azure.core.http.rest.Response;
import com.azure.core.util.Context;
import java.util.List;

/** Resource collection API of Profiles. */
public interface Profiles {
    /**
     * 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}.
     */
    Response<ProfileResourceFormat> 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.
     */
    ProfileResourceFormat 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.
     */
    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.
     */
    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}.
     */
    PagedIterable<ProfileResourceFormat> 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}.
     */
    PagedIterable<ProfileResourceFormat> 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}.
     */
    Response<List<KpiDefinition>> 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.
     */
    List<KpiDefinition> getEnrichingKpis(String resourceGroupName, String hubName, String profileName);

    /**
     * Gets information about the specified profile.
     *
     * @param id the resource ID.
     * @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}.
     */
    ProfileResourceFormat getById(String id);

    /**
     * Gets information about the specified profile.
     *
     * @param id the resource ID.
     * @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}.
     */
    Response<ProfileResourceFormat> getByIdWithResponse(String id, String localeCode, Context context);

    /**
     * Deletes a profile within a hub.
     *
     * @param id the resource ID.
     * @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.
     */
    void deleteById(String id);

    /**
     * Deletes a profile within a hub.
     *
     * @param id the resource ID.
     * @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.
     */
    void deleteByIdWithResponse(String id, String localeCode, Context context);

    /**
     * Begins definition for a new ProfileResourceFormat resource.
     *
     * @param name resource name.
     * @return the first stage of the new ProfileResourceFormat definition.
     */
    ProfileResourceFormat.DefinitionStages.Blank define(String name);
}
