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

package com.azure.resourcemanager.voiceservices.models;

import com.azure.core.management.Region;
import com.azure.core.management.SystemData;
import com.azure.core.util.Context;
import com.azure.resourcemanager.voiceservices.fluent.models.CommunicationsGatewayInner;
import java.util.List;
import java.util.Map;

/** An immutable client-side representation of CommunicationsGateway. */
public interface CommunicationsGateway {
    /**
     * Gets the id property: Fully qualified resource Id for the resource.
     *
     * @return the id value.
     */
    String id();

    /**
     * Gets the name property: The name of the resource.
     *
     * @return the name value.
     */
    String name();

    /**
     * Gets the type property: The type of the resource.
     *
     * @return the type value.
     */
    String type();

    /**
     * Gets the location property: The geo-location where the resource lives.
     *
     * @return the location value.
     */
    String location();

    /**
     * Gets the tags property: Resource tags.
     *
     * @return the tags value.
     */
    Map<String, String> tags();

    /**
     * Gets the systemData property: Azure Resource Manager metadata containing createdBy and modifiedBy information.
     *
     * @return the systemData value.
     */
    SystemData systemData();

    /**
     * Gets the provisioningState property: Resource provisioning state.
     *
     * @return the provisioningState value.
     */
    ProvisioningState provisioningState();

    /**
     * Gets the status property: The current status of the deployment.
     *
     * @return the status value.
     */
    Status status();

    /**
     * Gets the serviceLocations property: The regions in which to deploy the resources needed for Teams Calling.
     *
     * @return the serviceLocations value.
     */
    List<ServiceRegionProperties> serviceLocations();

    /**
     * Gets the connectivity property: How to connect back to the operator network, e.g. MAPS.
     *
     * @return the connectivity value.
     */
    Connectivity connectivity();

    /**
     * Gets the codecs property: Voice codecs to support.
     *
     * @return the codecs value.
     */
    List<TeamsCodecs> codecs();

    /**
     * Gets the e911Type property: How to handle 911 calls.
     *
     * @return the e911Type value.
     */
    E911Type e911Type();

    /**
     * Gets the platforms property: What platforms to support.
     *
     * @return the platforms value.
     */
    List<CommunicationsPlatform> platforms();

    /**
     * Gets the apiBridge property: Details of API bridge functionality, if required.
     *
     * @return the apiBridge value.
     */
    Object apiBridge();

    /**
     * Gets the autoGeneratedDomainNameLabelScope property: The scope at which the auto-generated domain name can be
     * re-used.
     *
     * @return the autoGeneratedDomainNameLabelScope value.
     */
    AutoGeneratedDomainNameLabelScope autoGeneratedDomainNameLabelScope();

    /**
     * Gets the autoGeneratedDomainNameLabel property: The autogenerated label used as part of the FQDNs for accessing
     * the Communications Gateway.
     *
     * @return the autoGeneratedDomainNameLabel value.
     */
    String autoGeneratedDomainNameLabel();

    /**
     * Gets the teamsVoicemailPilotNumber property: This number is used in Teams Phone Mobile scenarios for access to
     * the voicemail IVR from the native dialer.
     *
     * @return the teamsVoicemailPilotNumber value.
     */
    String teamsVoicemailPilotNumber();

    /**
     * Gets the onPremMcpEnabled property: Whether an on-premises Mobile Control Point is in use.
     *
     * @return the onPremMcpEnabled value.
     */
    Boolean onPremMcpEnabled();

    /**
     * Gets the emergencyDialStrings property: A list of dial strings used for emergency calling.
     *
     * @return the emergencyDialStrings value.
     */
    List<String> emergencyDialStrings();

    /**
     * Gets the region of the resource.
     *
     * @return the region of the resource.
     */
    Region region();

    /**
     * Gets the name of the resource region.
     *
     * @return the name of the resource region.
     */
    String regionName();

    /**
     * Gets the name of the resource group.
     *
     * @return the name of the resource group.
     */
    String resourceGroupName();

    /**
     * Gets the inner com.azure.resourcemanager.voiceservices.fluent.models.CommunicationsGatewayInner object.
     *
     * @return the inner object.
     */
    CommunicationsGatewayInner innerModel();

    /** The entirety of the CommunicationsGateway definition. */
    interface Definition
        extends DefinitionStages.Blank,
            DefinitionStages.WithLocation,
            DefinitionStages.WithResourceGroup,
            DefinitionStages.WithCreate {
    }
    /** The CommunicationsGateway definition stages. */
    interface DefinitionStages {
        /** The first stage of the CommunicationsGateway definition. */
        interface Blank extends WithLocation {
        }
        /** The stage of the CommunicationsGateway definition allowing to specify location. */
        interface WithLocation {
            /**
             * Specifies the region for the resource.
             *
             * @param location The geo-location where the resource lives.
             * @return the next definition stage.
             */
            WithResourceGroup withRegion(Region location);

            /**
             * Specifies the region for the resource.
             *
             * @param location The geo-location where the resource lives.
             * @return the next definition stage.
             */
            WithResourceGroup withRegion(String location);
        }
        /** The stage of the CommunicationsGateway definition allowing to specify parent resource. */
        interface WithResourceGroup {
            /**
             * Specifies resourceGroupName.
             *
             * @param resourceGroupName The name of the resource group. The name is case insensitive.
             * @return the next definition stage.
             */
            WithCreate withExistingResourceGroup(String resourceGroupName);
        }
        /**
         * The stage of the CommunicationsGateway definition which contains all the minimum required properties for the
         * resource to be created, but also allows for any other optional properties to be specified.
         */
        interface WithCreate
            extends DefinitionStages.WithTags,
                DefinitionStages.WithServiceLocations,
                DefinitionStages.WithConnectivity,
                DefinitionStages.WithCodecs,
                DefinitionStages.WithE911Type,
                DefinitionStages.WithPlatforms,
                DefinitionStages.WithApiBridge,
                DefinitionStages.WithAutoGeneratedDomainNameLabelScope,
                DefinitionStages.WithTeamsVoicemailPilotNumber,
                DefinitionStages.WithOnPremMcpEnabled,
                DefinitionStages.WithEmergencyDialStrings {
            /**
             * Executes the create request.
             *
             * @return the created resource.
             */
            CommunicationsGateway create();

            /**
             * Executes the create request.
             *
             * @param context The context to associate with this operation.
             * @return the created resource.
             */
            CommunicationsGateway create(Context context);
        }
        /** The stage of the CommunicationsGateway definition allowing to specify tags. */
        interface WithTags {
            /**
             * Specifies the tags property: Resource tags..
             *
             * @param tags Resource tags.
             * @return the next definition stage.
             */
            WithCreate withTags(Map<String, String> tags);
        }
        /** The stage of the CommunicationsGateway definition allowing to specify serviceLocations. */
        interface WithServiceLocations {
            /**
             * Specifies the serviceLocations property: The regions in which to deploy the resources needed for Teams
             * Calling.
             *
             * @param serviceLocations The regions in which to deploy the resources needed for Teams Calling.
             * @return the next definition stage.
             */
            WithCreate withServiceLocations(List<ServiceRegionProperties> serviceLocations);
        }
        /** The stage of the CommunicationsGateway definition allowing to specify connectivity. */
        interface WithConnectivity {
            /**
             * Specifies the connectivity property: How to connect back to the operator network, e.g. MAPS.
             *
             * @param connectivity How to connect back to the operator network, e.g. MAPS.
             * @return the next definition stage.
             */
            WithCreate withConnectivity(Connectivity connectivity);
        }
        /** The stage of the CommunicationsGateway definition allowing to specify codecs. */
        interface WithCodecs {
            /**
             * Specifies the codecs property: Voice codecs to support.
             *
             * @param codecs Voice codecs to support.
             * @return the next definition stage.
             */
            WithCreate withCodecs(List<TeamsCodecs> codecs);
        }
        /** The stage of the CommunicationsGateway definition allowing to specify e911Type. */
        interface WithE911Type {
            /**
             * Specifies the e911Type property: How to handle 911 calls.
             *
             * @param e911Type How to handle 911 calls.
             * @return the next definition stage.
             */
            WithCreate withE911Type(E911Type e911Type);
        }
        /** The stage of the CommunicationsGateway definition allowing to specify platforms. */
        interface WithPlatforms {
            /**
             * Specifies the platforms property: What platforms to support.
             *
             * @param platforms What platforms to support.
             * @return the next definition stage.
             */
            WithCreate withPlatforms(List<CommunicationsPlatform> platforms);
        }
        /** The stage of the CommunicationsGateway definition allowing to specify apiBridge. */
        interface WithApiBridge {
            /**
             * Specifies the apiBridge property: Details of API bridge functionality, if required.
             *
             * @param apiBridge Details of API bridge functionality, if required.
             * @return the next definition stage.
             */
            WithCreate withApiBridge(Object apiBridge);
        }
        /** The stage of the CommunicationsGateway definition allowing to specify autoGeneratedDomainNameLabelScope. */
        interface WithAutoGeneratedDomainNameLabelScope {
            /**
             * Specifies the autoGeneratedDomainNameLabelScope property: The scope at which the auto-generated domain
             * name can be re-used.
             *
             * @param autoGeneratedDomainNameLabelScope The scope at which the auto-generated domain name can be
             *     re-used.
             * @return the next definition stage.
             */
            WithCreate withAutoGeneratedDomainNameLabelScope(
                AutoGeneratedDomainNameLabelScope autoGeneratedDomainNameLabelScope);
        }
        /** The stage of the CommunicationsGateway definition allowing to specify teamsVoicemailPilotNumber. */
        interface WithTeamsVoicemailPilotNumber {
            /**
             * Specifies the teamsVoicemailPilotNumber property: This number is used in Teams Phone Mobile scenarios for
             * access to the voicemail IVR from the native dialer..
             *
             * @param teamsVoicemailPilotNumber This number is used in Teams Phone Mobile scenarios for access to the
             *     voicemail IVR from the native dialer.
             * @return the next definition stage.
             */
            WithCreate withTeamsVoicemailPilotNumber(String teamsVoicemailPilotNumber);
        }
        /** The stage of the CommunicationsGateway definition allowing to specify onPremMcpEnabled. */
        interface WithOnPremMcpEnabled {
            /**
             * Specifies the onPremMcpEnabled property: Whether an on-premises Mobile Control Point is in use..
             *
             * @param onPremMcpEnabled Whether an on-premises Mobile Control Point is in use.
             * @return the next definition stage.
             */
            WithCreate withOnPremMcpEnabled(Boolean onPremMcpEnabled);
        }
        /** The stage of the CommunicationsGateway definition allowing to specify emergencyDialStrings. */
        interface WithEmergencyDialStrings {
            /**
             * Specifies the emergencyDialStrings property: A list of dial strings used for emergency calling..
             *
             * @param emergencyDialStrings A list of dial strings used for emergency calling.
             * @return the next definition stage.
             */
            WithCreate withEmergencyDialStrings(List<String> emergencyDialStrings);
        }
    }
    /**
     * Begins update for the CommunicationsGateway resource.
     *
     * @return the stage of resource update.
     */
    CommunicationsGateway.Update update();

    /** The template for CommunicationsGateway update. */
    interface Update extends UpdateStages.WithTags {
        /**
         * Executes the update request.
         *
         * @return the updated resource.
         */
        CommunicationsGateway apply();

        /**
         * Executes the update request.
         *
         * @param context The context to associate with this operation.
         * @return the updated resource.
         */
        CommunicationsGateway apply(Context context);
    }
    /** The CommunicationsGateway update stages. */
    interface UpdateStages {
        /** The stage of the CommunicationsGateway update allowing to specify tags. */
        interface WithTags {
            /**
             * Specifies the tags property: Resource tags..
             *
             * @param tags Resource tags.
             * @return the next definition stage.
             */
            Update withTags(Map<String, String> tags);
        }
    }
    /**
     * Refreshes the resource to sync with Azure.
     *
     * @return the refreshed resource.
     */
    CommunicationsGateway refresh();

    /**
     * Refreshes the resource to sync with Azure.
     *
     * @param context The context to associate with this operation.
     * @return the refreshed resource.
     */
    CommunicationsGateway refresh(Context context);
}
