Interface CreateBillEstimateResponse.Builder

  • Method Details

    • id

      The unique identifier of your newly created Bill estimate.

      Parameters:
      id - The unique identifier of your newly created Bill estimate.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • name

      The name of your newly created Bill estimate.

      Parameters:
      name - The name of your newly created Bill estimate.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • status

      The status of your newly created Bill estimate. Bill estimate creation can take anywhere between 8 to 12 hours. The status will allow you to identify when the Bill estimate is complete or has failed.

      Parameters:
      status - The status of your newly created Bill estimate. Bill estimate creation can take anywhere between 8 to 12 hours. The status will allow you to identify when the Bill estimate is complete or has failed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • status

      The status of your newly created Bill estimate. Bill estimate creation can take anywhere between 8 to 12 hours. The status will allow you to identify when the Bill estimate is complete or has failed.

      Parameters:
      status - The status of your newly created Bill estimate. Bill estimate creation can take anywhere between 8 to 12 hours. The status will allow you to identify when the Bill estimate is complete or has failed.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • failureMessage

      CreateBillEstimateResponse.Builder failureMessage(String failureMessage)

      This attribute provides the reason if a Bill estimate result generation fails.

      Parameters:
      failureMessage - This attribute provides the reason if a Bill estimate result generation fails.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • billInterval

      The bill month start and end timestamp that was used to create the Bill estimate. This is set to the last complete anniversary bill month start and end timestamp.

      Parameters:
      billInterval - The bill month start and end timestamp that was used to create the Bill estimate. This is set to the last complete anniversary bill month start and end timestamp.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • billInterval

      The bill month start and end timestamp that was used to create the Bill estimate. This is set to the last complete anniversary bill month start and end timestamp.

      This is a convenience method that creates an instance of the BillInterval.Builder avoiding the need to create one manually via BillInterval.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to billInterval(BillInterval).

      Parameters:
      billInterval - a consumer that will call methods on BillInterval.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • costSummary

      Returns summary-level cost information once a Bill estimate is successfully generated. This summary includes: 1) the total cost difference, showing the pre-tax cost change for the consolidated billing family between the completed anniversary bill and the estimated bill, and 2) total cost differences per service, detailing the pre-tax cost of each service, comparing the completed anniversary bill to the estimated bill on a per-service basis.

      Parameters:
      costSummary - Returns summary-level cost information once a Bill estimate is successfully generated. This summary includes: 1) the total cost difference, showing the pre-tax cost change for the consolidated billing family between the completed anniversary bill and the estimated bill, and 2) total cost differences per service, detailing the pre-tax cost of each service, comparing the completed anniversary bill to the estimated bill on a per-service basis.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • costSummary

      Returns summary-level cost information once a Bill estimate is successfully generated. This summary includes: 1) the total cost difference, showing the pre-tax cost change for the consolidated billing family between the completed anniversary bill and the estimated bill, and 2) total cost differences per service, detailing the pre-tax cost of each service, comparing the completed anniversary bill to the estimated bill on a per-service basis.

      This is a convenience method that creates an instance of the BillEstimateCostSummary.Builder avoiding the need to create one manually via BillEstimateCostSummary.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to costSummary(BillEstimateCostSummary).

      Parameters:
      costSummary - a consumer that will call methods on BillEstimateCostSummary.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • createdAt

      The timestamp of when the Bill estimate create process was started (not when it successfully completed or failed).

      Parameters:
      createdAt - The timestamp of when the Bill estimate create process was started (not when it successfully completed or failed).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • expiresAt

      The timestamp of when the Bill estimate will expire. A Bill estimate becomes inaccessible after expiration.

      Parameters:
      expiresAt - The timestamp of when the Bill estimate will expire. A Bill estimate becomes inaccessible after expiration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.