Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Labs

Package version

Interface representing a Labs.

Hierarchy

  • Labs

Implemented by

Index

Methods

createOrUpdate

delete

  • delete(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, options?: LabsDeleteOptionalParams): Promise<void>
  • 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.

    Parameters

    • billingAccountName: string

      Billing account name.

    • billingProfileName: string

      Billing profile name.

    • invoiceSectionName: string

      Invoice section name.

    • Optional options: LabsDeleteOptionalParams

      The options parameters.

    Returns Promise<void>

generateInviteCode

get

  • Get the details for a specific lab associated with the provided billing account name, billing profile name, and invoice section name.

    Parameters

    • billingAccountName: string

      Billing account name.

    • billingProfileName: string

      Billing profile name.

    • invoiceSectionName: string

      Invoice section name.

    • Optional options: LabsGetOptionalParams

      The options parameters.

    Returns Promise<LabsGetResponse>

list

  • list(billingAccountName: string, billingProfileName: string, invoiceSectionName: string, options?: LabsListOptionalParams): PagedAsyncIterableIterator<LabDetails>
  • Get the details for a specific lab associated with the provided billing account name, billing profile name, and invoice section name.

    Parameters

    • billingAccountName: string

      Billing account name.

    • billingProfileName: string

      Billing profile name.

    • invoiceSectionName: string

      Invoice section name.

    • Optional options: LabsListOptionalParams

      The options parameters.

    Returns PagedAsyncIterableIterator<LabDetails>

listAll

  • Get a list of labs associated with the provided billing account name and billing profile name.

    Parameters

    • billingAccountName: string

      Billing account name.

    • billingProfileName: string

      Billing profile name.

    • Optional options: LabsListAllOptionalParams

      The options parameters.

    Returns PagedAsyncIterableIterator<LabDetails>

Generated using TypeDoc