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

package com.azure.resourcemanager.education.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.util.Context;
import com.azure.resourcemanager.education.fluent.models.LabDetailsInner;
import com.azure.resourcemanager.education.models.InviteCodeGenerateRequest;

/** An instance of this class provides access to all the operations defined in LabsClient. */
public interface LabsClient {
    /**
     * Get a list of labs associated with the provided billing account name and billing profile name.
     *
     * @param billingAccountName Billing account name.
     * @param billingProfileName Billing profile name.
     * @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 a list of labs associated with the provided billing account name and billing profile name as paginated
     *     response with {@link PagedIterable}.
     */
    @ServiceMethod(returns = ReturnType.COLLECTION)
    PagedIterable<LabDetailsInner> listAll(String billingAccountName, String billingProfileName);

    /**
     * Get a list of labs associated with the provided billing account name and billing profile name.
     *
     * @param billingAccountName Billing account name.
     * @param billingProfileName Billing profile name.
     * @param includeBudget May be used to include budget information.
     * @param includeDeleted May be used to show deleted items.
     * @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 a list of labs associated with the provided billing account name and billing profile name as paginated
     *     response with {@link PagedIterable}.
     */
    @ServiceMethod(returns = ReturnType.COLLECTION)
    PagedIterable<LabDetailsInner> listAll(
        String billingAccountName,
        String billingProfileName,
        Boolean includeBudget,
        Boolean includeDeleted,
        Context context);

    /**
     * Get the details for a specific lab associated with the provided billing account name, billing profile name, and
     * invoice section name.
     *
     * @param billingAccountName Billing account name.
     * @param billingProfileName Billing profile name.
     * @param invoiceSectionName Invoice section name.
     * @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 details for a specific lab associated with the provided billing account name, billing profile name,
     *     and invoice section name as paginated response with {@link PagedIterable}.
     */
    @ServiceMethod(returns = ReturnType.COLLECTION)
    PagedIterable<LabDetailsInner> list(
        String billingAccountName, String billingProfileName, String invoiceSectionName);

    /**
     * Get the details for a specific lab associated with the provided billing account name, billing profile name, and
     * invoice section name.
     *
     * @param billingAccountName Billing account name.
     * @param billingProfileName Billing profile name.
     * @param invoiceSectionName Invoice section name.
     * @param includeBudget May be used to include budget information.
     * @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 details for a specific lab associated with the provided billing account name, billing profile name,
     *     and invoice section name as paginated response with {@link PagedIterable}.
     */
    @ServiceMethod(returns = ReturnType.COLLECTION)
    PagedIterable<LabDetailsInner> list(
        String billingAccountName,
        String billingProfileName,
        String invoiceSectionName,
        Boolean includeBudget,
        Context context);

    /**
     * Get the details for a specific lab associated with the provided billing account name, billing profile name, and
     * invoice section name.
     *
     * @param billingAccountName Billing account name.
     * @param billingProfileName Billing profile name.
     * @param invoiceSectionName Invoice section name.
     * @param includeBudget May be used to include budget information.
     * @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 details for a specific lab associated with the provided billing account name, billing profile name,
     *     and invoice section name along with {@link Response}.
     */
    @ServiceMethod(returns = ReturnType.SINGLE)
    Response<LabDetailsInner> getWithResponse(
        String billingAccountName,
        String billingProfileName,
        String invoiceSectionName,
        Boolean includeBudget,
        Context context);

    /**
     * Get the details for a specific lab associated with the provided billing account name, billing profile name, and
     * invoice section name.
     *
     * @param billingAccountName Billing account name.
     * @param billingProfileName Billing profile name.
     * @param invoiceSectionName Invoice section name.
     * @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 details for a specific lab associated with the provided billing account name, billing profile name,
     *     and invoice section name.
     */
    @ServiceMethod(returns = ReturnType.SINGLE)
    LabDetailsInner get(String billingAccountName, String billingProfileName, String invoiceSectionName);

    /**
     * Delete a specific lab associated with the provided billing account name, billing profile name, and invoice
     * section name. Note all students must be removed from the lab in order to delete the lab.
     *
     * @param billingAccountName Billing account name.
     * @param billingProfileName Billing profile name.
     * @param invoiceSectionName Invoice section name.
     * @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 Response}.
     */
    @ServiceMethod(returns = ReturnType.SINGLE)
    Response<Void> deleteWithResponse(
        String billingAccountName, String billingProfileName, String invoiceSectionName, Context context);

    /**
     * Delete a specific lab associated with the provided billing account name, billing profile name, and invoice
     * section name. Note all students must be removed from the lab in order to delete the lab.
     *
     * @param billingAccountName Billing account name.
     * @param billingProfileName Billing profile name.
     * @param invoiceSectionName Invoice section name.
     * @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 billingAccountName, String billingProfileName, String invoiceSectionName);

    /**
     * Create a new lab or update a previously created lab.
     *
     * @param billingAccountName Billing account name.
     * @param billingProfileName Billing profile name.
     * @param invoiceSectionName Invoice section name.
     * @param parameters Request parameters that are provided to create lab resource.
     * @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 lab details along with {@link Response}.
     */
    @ServiceMethod(returns = ReturnType.SINGLE)
    Response<LabDetailsInner> createOrUpdateWithResponse(
        String billingAccountName,
        String billingProfileName,
        String invoiceSectionName,
        LabDetailsInner parameters,
        Context context);

    /**
     * Create a new lab or update a previously created lab.
     *
     * @param billingAccountName Billing account name.
     * @param billingProfileName Billing profile name.
     * @param invoiceSectionName Invoice section name.
     * @param parameters Request parameters that are provided to create lab resource.
     * @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 lab details.
     */
    @ServiceMethod(returns = ReturnType.SINGLE)
    LabDetailsInner createOrUpdate(
        String billingAccountName, String billingProfileName, String invoiceSectionName, LabDetailsInner parameters);

    /**
     * Generate invite code for a lab.
     *
     * @param billingAccountName Billing account name.
     * @param billingProfileName Billing profile name.
     * @param invoiceSectionName Invoice section name.
     * @param parameters Request parameters that are provided to generate invite code.
     * @param onlyUpdateStudentCountParameter set this flag to true if you want to update student count without
     *     generating a new invite code.
     * @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 lab details along with {@link Response}.
     */
    @ServiceMethod(returns = ReturnType.SINGLE)
    Response<LabDetailsInner> generateInviteCodeWithResponse(
        String billingAccountName,
        String billingProfileName,
        String invoiceSectionName,
        InviteCodeGenerateRequest parameters,
        Boolean onlyUpdateStudentCountParameter,
        Context context);

    /**
     * Generate invite code for a lab.
     *
     * @param billingAccountName Billing account name.
     * @param billingProfileName Billing profile name.
     * @param invoiceSectionName Invoice section name.
     * @param parameters Request parameters that are provided to generate invite code.
     * @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 lab details.
     */
    @ServiceMethod(returns = ReturnType.SINGLE)
    LabDetailsInner generateInviteCode(
        String billingAccountName,
        String billingProfileName,
        String invoiceSectionName,
        InviteCodeGenerateRequest parameters);
}
