GenerateBenefitUtilizationSummariesReportOperations interface

Interface representing a GenerateBenefitUtilizationSummariesReport operations.

Properties

beginGenerateByBillingAccount
beginGenerateByBillingAccountAndWait
beginGenerateByBillingProfile
beginGenerateByBillingProfileAndWait
beginGenerateByReservationId
beginGenerateByReservationIdAndWait
beginGenerateByReservationOrderId
beginGenerateByReservationOrderIdAndWait
beginGenerateBySavingsPlanId
beginGenerateBySavingsPlanIdAndWait
beginGenerateBySavingsPlanOrderId
beginGenerateBySavingsPlanOrderIdAndWait
generateByBillingAccount

Triggers generation of a benefit utilization summaries report for the provided billing account. This API supports only enrollment accounts.

generateByBillingProfile

Triggers generation of a benefit utilization summaries report for the provided billing account and billing profile.

generateByReservationId

Triggers generation of a benefit utilization summaries report for the provided reservation.

generateByReservationOrderId

Triggers generation of a benefit utilization summaries report for the provided reservation order.

generateBySavingsPlanId

Triggers generation of a benefit utilization summaries report for the provided savings plan.

generateBySavingsPlanOrderId

Triggers generation of a benefit utilization summaries report for the provided savings plan order.

Property Details

beginGenerateByBillingAccount

Warning

This API is now deprecated.

use generateByBillingAccount instead

beginGenerateByBillingAccount: (billingAccountId: string, benefitUtilizationSummariesRequest: BenefitUtilizationSummariesRequest, options?: GenerateBenefitUtilizationSummariesReportGenerateByBillingAccountOptionalParams) => Promise<SimplePollerLike<OperationState<BenefitUtilizationSummariesOperationStatus>, BenefitUtilizationSummariesOperationStatus>>

Property Value

(billingAccountId: string, benefitUtilizationSummariesRequest: BenefitUtilizationSummariesRequest, options?: GenerateBenefitUtilizationSummariesReportGenerateByBillingAccountOptionalParams) => Promise<SimplePollerLike<OperationState<BenefitUtilizationSummariesOperationStatus>, BenefitUtilizationSummariesOperationStatus>>

beginGenerateByBillingAccountAndWait

Warning

This API is now deprecated.

use generateByBillingAccount instead

beginGenerateByBillingAccountAndWait: (billingAccountId: string, benefitUtilizationSummariesRequest: BenefitUtilizationSummariesRequest, options?: GenerateBenefitUtilizationSummariesReportGenerateByBillingAccountOptionalParams) => Promise<BenefitUtilizationSummariesOperationStatus>

Property Value

(billingAccountId: string, benefitUtilizationSummariesRequest: BenefitUtilizationSummariesRequest, options?: GenerateBenefitUtilizationSummariesReportGenerateByBillingAccountOptionalParams) => Promise<BenefitUtilizationSummariesOperationStatus>

beginGenerateByBillingProfile

Warning

This API is now deprecated.

use generateByBillingProfile instead

beginGenerateByBillingProfile: (billingAccountId: string, billingProfileId: string, benefitUtilizationSummariesRequest: BenefitUtilizationSummariesRequest, options?: GenerateBenefitUtilizationSummariesReportGenerateByBillingProfileOptionalParams) => Promise<SimplePollerLike<OperationState<BenefitUtilizationSummariesOperationStatus>, BenefitUtilizationSummariesOperationStatus>>

Property Value

(billingAccountId: string, billingProfileId: string, benefitUtilizationSummariesRequest: BenefitUtilizationSummariesRequest, options?: GenerateBenefitUtilizationSummariesReportGenerateByBillingProfileOptionalParams) => Promise<SimplePollerLike<OperationState<BenefitUtilizationSummariesOperationStatus>, BenefitUtilizationSummariesOperationStatus>>

beginGenerateByBillingProfileAndWait

Warning

This API is now deprecated.

use generateByBillingProfile instead

beginGenerateByBillingProfileAndWait: (billingAccountId: string, billingProfileId: string, benefitUtilizationSummariesRequest: BenefitUtilizationSummariesRequest, options?: GenerateBenefitUtilizationSummariesReportGenerateByBillingProfileOptionalParams) => Promise<BenefitUtilizationSummariesOperationStatus>

Property Value

(billingAccountId: string, billingProfileId: string, benefitUtilizationSummariesRequest: BenefitUtilizationSummariesRequest, options?: GenerateBenefitUtilizationSummariesReportGenerateByBillingProfileOptionalParams) => Promise<BenefitUtilizationSummariesOperationStatus>

beginGenerateByReservationId

Warning

This API is now deprecated.

use generateByReservationId instead

beginGenerateByReservationId: (reservationOrderId: string, reservationId: string, benefitUtilizationSummariesRequest: BenefitUtilizationSummariesRequest, options?: GenerateBenefitUtilizationSummariesReportGenerateByReservationIdOptionalParams) => Promise<SimplePollerLike<OperationState<BenefitUtilizationSummariesOperationStatus>, BenefitUtilizationSummariesOperationStatus>>

Property Value

(reservationOrderId: string, reservationId: string, benefitUtilizationSummariesRequest: BenefitUtilizationSummariesRequest, options?: GenerateBenefitUtilizationSummariesReportGenerateByReservationIdOptionalParams) => Promise<SimplePollerLike<OperationState<BenefitUtilizationSummariesOperationStatus>, BenefitUtilizationSummariesOperationStatus>>

beginGenerateByReservationIdAndWait

Warning

This API is now deprecated.

use generateByReservationId instead

beginGenerateByReservationIdAndWait: (reservationOrderId: string, reservationId: string, benefitUtilizationSummariesRequest: BenefitUtilizationSummariesRequest, options?: GenerateBenefitUtilizationSummariesReportGenerateByReservationIdOptionalParams) => Promise<BenefitUtilizationSummariesOperationStatus>

Property Value

(reservationOrderId: string, reservationId: string, benefitUtilizationSummariesRequest: BenefitUtilizationSummariesRequest, options?: GenerateBenefitUtilizationSummariesReportGenerateByReservationIdOptionalParams) => Promise<BenefitUtilizationSummariesOperationStatus>

beginGenerateByReservationOrderId

Warning

This API is now deprecated.

use generateByReservationOrderId instead

beginGenerateByReservationOrderId: (reservationOrderId: string, benefitUtilizationSummariesRequest: BenefitUtilizationSummariesRequest, options?: GenerateBenefitUtilizationSummariesReportGenerateByReservationOrderIdOptionalParams) => Promise<SimplePollerLike<OperationState<BenefitUtilizationSummariesOperationStatus>, BenefitUtilizationSummariesOperationStatus>>

Property Value

(reservationOrderId: string, benefitUtilizationSummariesRequest: BenefitUtilizationSummariesRequest, options?: GenerateBenefitUtilizationSummariesReportGenerateByReservationOrderIdOptionalParams) => Promise<SimplePollerLike<OperationState<BenefitUtilizationSummariesOperationStatus>, BenefitUtilizationSummariesOperationStatus>>

beginGenerateByReservationOrderIdAndWait

Warning

This API is now deprecated.

use generateByReservationOrderId instead

beginGenerateByReservationOrderIdAndWait: (reservationOrderId: string, benefitUtilizationSummariesRequest: BenefitUtilizationSummariesRequest, options?: GenerateBenefitUtilizationSummariesReportGenerateByReservationOrderIdOptionalParams) => Promise<BenefitUtilizationSummariesOperationStatus>

Property Value

(reservationOrderId: string, benefitUtilizationSummariesRequest: BenefitUtilizationSummariesRequest, options?: GenerateBenefitUtilizationSummariesReportGenerateByReservationOrderIdOptionalParams) => Promise<BenefitUtilizationSummariesOperationStatus>

beginGenerateBySavingsPlanId

Warning

This API is now deprecated.

use generateBySavingsPlanId instead

beginGenerateBySavingsPlanId: (savingsPlanOrderId: string, savingsPlanId: string, benefitUtilizationSummariesRequest: BenefitUtilizationSummariesRequest, options?: GenerateBenefitUtilizationSummariesReportGenerateBySavingsPlanIdOptionalParams) => Promise<SimplePollerLike<OperationState<BenefitUtilizationSummariesOperationStatus>, BenefitUtilizationSummariesOperationStatus>>

Property Value

(savingsPlanOrderId: string, savingsPlanId: string, benefitUtilizationSummariesRequest: BenefitUtilizationSummariesRequest, options?: GenerateBenefitUtilizationSummariesReportGenerateBySavingsPlanIdOptionalParams) => Promise<SimplePollerLike<OperationState<BenefitUtilizationSummariesOperationStatus>, BenefitUtilizationSummariesOperationStatus>>

beginGenerateBySavingsPlanIdAndWait

Warning

This API is now deprecated.

use generateBySavingsPlanId instead

beginGenerateBySavingsPlanIdAndWait: (savingsPlanOrderId: string, savingsPlanId: string, benefitUtilizationSummariesRequest: BenefitUtilizationSummariesRequest, options?: GenerateBenefitUtilizationSummariesReportGenerateBySavingsPlanIdOptionalParams) => Promise<BenefitUtilizationSummariesOperationStatus>

Property Value

(savingsPlanOrderId: string, savingsPlanId: string, benefitUtilizationSummariesRequest: BenefitUtilizationSummariesRequest, options?: GenerateBenefitUtilizationSummariesReportGenerateBySavingsPlanIdOptionalParams) => Promise<BenefitUtilizationSummariesOperationStatus>

beginGenerateBySavingsPlanOrderId

Warning

This API is now deprecated.

use generateBySavingsPlanOrderId instead

beginGenerateBySavingsPlanOrderId: (savingsPlanOrderId: string, benefitUtilizationSummariesRequest: BenefitUtilizationSummariesRequest, options?: GenerateBenefitUtilizationSummariesReportGenerateBySavingsPlanOrderIdOptionalParams) => Promise<SimplePollerLike<OperationState<BenefitUtilizationSummariesOperationStatus>, BenefitUtilizationSummariesOperationStatus>>

Property Value

(savingsPlanOrderId: string, benefitUtilizationSummariesRequest: BenefitUtilizationSummariesRequest, options?: GenerateBenefitUtilizationSummariesReportGenerateBySavingsPlanOrderIdOptionalParams) => Promise<SimplePollerLike<OperationState<BenefitUtilizationSummariesOperationStatus>, BenefitUtilizationSummariesOperationStatus>>

beginGenerateBySavingsPlanOrderIdAndWait

Warning

This API is now deprecated.

use generateBySavingsPlanOrderId instead

beginGenerateBySavingsPlanOrderIdAndWait: (savingsPlanOrderId: string, benefitUtilizationSummariesRequest: BenefitUtilizationSummariesRequest, options?: GenerateBenefitUtilizationSummariesReportGenerateBySavingsPlanOrderIdOptionalParams) => Promise<BenefitUtilizationSummariesOperationStatus>

Property Value

(savingsPlanOrderId: string, benefitUtilizationSummariesRequest: BenefitUtilizationSummariesRequest, options?: GenerateBenefitUtilizationSummariesReportGenerateBySavingsPlanOrderIdOptionalParams) => Promise<BenefitUtilizationSummariesOperationStatus>

generateByBillingAccount

Triggers generation of a benefit utilization summaries report for the provided billing account. This API supports only enrollment accounts.

generateByBillingAccount: (billingAccountId: string, benefitUtilizationSummariesRequest: BenefitUtilizationSummariesRequest, options?: GenerateBenefitUtilizationSummariesReportGenerateByBillingAccountOptionalParams) => PollerLike<OperationState<BenefitUtilizationSummariesOperationStatus>, BenefitUtilizationSummariesOperationStatus>

Property Value

(billingAccountId: string, benefitUtilizationSummariesRequest: BenefitUtilizationSummariesRequest, options?: GenerateBenefitUtilizationSummariesReportGenerateByBillingAccountOptionalParams) => PollerLike<OperationState<BenefitUtilizationSummariesOperationStatus>, BenefitUtilizationSummariesOperationStatus>

generateByBillingProfile

Triggers generation of a benefit utilization summaries report for the provided billing account and billing profile.

generateByBillingProfile: (billingAccountId: string, billingProfileId: string, benefitUtilizationSummariesRequest: BenefitUtilizationSummariesRequest, options?: GenerateBenefitUtilizationSummariesReportGenerateByBillingProfileOptionalParams) => PollerLike<OperationState<BenefitUtilizationSummariesOperationStatus>, BenefitUtilizationSummariesOperationStatus>

Property Value

(billingAccountId: string, billingProfileId: string, benefitUtilizationSummariesRequest: BenefitUtilizationSummariesRequest, options?: GenerateBenefitUtilizationSummariesReportGenerateByBillingProfileOptionalParams) => PollerLike<OperationState<BenefitUtilizationSummariesOperationStatus>, BenefitUtilizationSummariesOperationStatus>

generateByReservationId

Triggers generation of a benefit utilization summaries report for the provided reservation.

generateByReservationId: (reservationOrderId: string, reservationId: string, benefitUtilizationSummariesRequest: BenefitUtilizationSummariesRequest, options?: GenerateBenefitUtilizationSummariesReportGenerateByReservationIdOptionalParams) => PollerLike<OperationState<BenefitUtilizationSummariesOperationStatus>, BenefitUtilizationSummariesOperationStatus>

Property Value

(reservationOrderId: string, reservationId: string, benefitUtilizationSummariesRequest: BenefitUtilizationSummariesRequest, options?: GenerateBenefitUtilizationSummariesReportGenerateByReservationIdOptionalParams) => PollerLike<OperationState<BenefitUtilizationSummariesOperationStatus>, BenefitUtilizationSummariesOperationStatus>

generateByReservationOrderId

Triggers generation of a benefit utilization summaries report for the provided reservation order.

generateByReservationOrderId: (reservationOrderId: string, benefitUtilizationSummariesRequest: BenefitUtilizationSummariesRequest, options?: GenerateBenefitUtilizationSummariesReportGenerateByReservationOrderIdOptionalParams) => PollerLike<OperationState<BenefitUtilizationSummariesOperationStatus>, BenefitUtilizationSummariesOperationStatus>

Property Value

(reservationOrderId: string, benefitUtilizationSummariesRequest: BenefitUtilizationSummariesRequest, options?: GenerateBenefitUtilizationSummariesReportGenerateByReservationOrderIdOptionalParams) => PollerLike<OperationState<BenefitUtilizationSummariesOperationStatus>, BenefitUtilizationSummariesOperationStatus>

generateBySavingsPlanId

Triggers generation of a benefit utilization summaries report for the provided savings plan.

generateBySavingsPlanId: (savingsPlanOrderId: string, savingsPlanId: string, benefitUtilizationSummariesRequest: BenefitUtilizationSummariesRequest, options?: GenerateBenefitUtilizationSummariesReportGenerateBySavingsPlanIdOptionalParams) => PollerLike<OperationState<BenefitUtilizationSummariesOperationStatus>, BenefitUtilizationSummariesOperationStatus>

Property Value

(savingsPlanOrderId: string, savingsPlanId: string, benefitUtilizationSummariesRequest: BenefitUtilizationSummariesRequest, options?: GenerateBenefitUtilizationSummariesReportGenerateBySavingsPlanIdOptionalParams) => PollerLike<OperationState<BenefitUtilizationSummariesOperationStatus>, BenefitUtilizationSummariesOperationStatus>

generateBySavingsPlanOrderId

Triggers generation of a benefit utilization summaries report for the provided savings plan order.

generateBySavingsPlanOrderId: (savingsPlanOrderId: string, benefitUtilizationSummariesRequest: BenefitUtilizationSummariesRequest, options?: GenerateBenefitUtilizationSummariesReportGenerateBySavingsPlanOrderIdOptionalParams) => PollerLike<OperationState<BenefitUtilizationSummariesOperationStatus>, BenefitUtilizationSummariesOperationStatus>

Property Value

(savingsPlanOrderId: string, benefitUtilizationSummariesRequest: BenefitUtilizationSummariesRequest, options?: GenerateBenefitUtilizationSummariesReportGenerateBySavingsPlanOrderIdOptionalParams) => PollerLike<OperationState<BenefitUtilizationSummariesOperationStatus>, BenefitUtilizationSummariesOperationStatus>