Interface InvestmentAttestation.Builder

All Superinterfaces:
Buildable, CopyableBuilder<InvestmentAttestation.Builder,InvestmentAttestation>, SdkBuilder<InvestmentAttestation.Builder,InvestmentAttestation>, SdkPojo
Enclosing class:
InvestmentAttestation
@Mutable @NotThreadSafe public static interface InvestmentAttestation.Builder extends SdkPojo, CopyableBuilder<InvestmentAttestation.Builder,InvestmentAttestation>

  • Method Details

    • attestationId

      InvestmentAttestation.Builder attestationId(String attestationId)

      The identifier of the attestation. This value is returned by CreateContractualInvestmentAttestation and is used to cancel the attestation with CancelContractualInvestmentAttestation. This value is 1–36 characters.

      Parameters:
      attestationId - The identifier of the attestation. This value is returned by CreateContractualInvestmentAttestation and is used to cancel the attestation with CancelContractualInvestmentAttestation. This value is 1–36 characters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • investmentName

      InvestmentAttestation.Builder investmentName(String investmentName)

      The name of the investment summary that contains the attested outcome. This value is 1–400 characters.

      Parameters:
      investmentName - The name of the investment summary that contains the attested outcome. This value is 1–400 characters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • outcomeDescription

      InvestmentAttestation.Builder outcomeDescription(String outcomeDescription)

      The description of the attested outcome. This value is 1–2048 characters.

      Parameters:
      outcomeDescription - The description of the attested outcome. This value is 1–2048 characters.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • investmentSummaryId

      InvestmentAttestation.Builder investmentSummaryId(String investmentSummaryId)

      The identifier of the investment summary that was attested, as returned by ListContractualInvestmentSummaries.

      Parameters:
      investmentSummaryId - The identifier of the investment summary that was attested, as returned by ListContractualInvestmentSummaries.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • investmentId

      InvestmentAttestation.Builder investmentId(String investmentId)

      The identifier of the investment that was attested, as returned by ListContractualInvestments.

      Parameters:
      investmentId - The identifier of the investment that was attested, as returned by ListContractualInvestments.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attestedAt

      InvestmentAttestation.Builder attestedAt(Instant attestedAt)

      The date on which the attestation was submitted.

      Parameters:
      attestedAt - The date on which the attestation was submitted.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • updatedAt

      InvestmentAttestation.Builder updatedAt(Instant updatedAt)

      The date on which the attestation was last updated.

      Parameters:
      updatedAt - The date on which the attestation was last updated.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attestationStatus

      InvestmentAttestation.Builder attestationStatus(String attestationStatus)

      The current status of the attestation. Valid values are PENDING_REVIEW, PENDING_C_LEVEL_APPROVAL, PENDING_CANCELLATION, REJECTED, CANCELLED, and DISBURSED. The values DISBURSED, REJECTED, and CANCELLED are terminal. The other values indicate the attestation is still in progress.

      Parameters:
      attestationStatus - The current status of the attestation. Valid values are PENDING_REVIEW, PENDING_C_LEVEL_APPROVAL, PENDING_CANCELLATION, REJECTED, CANCELLED, and DISBURSED. The values DISBURSED, REJECTED, and CANCELLED are terminal. The other values indicate the attestation is still in progress.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • attestationStatus

      InvestmentAttestation.Builder attestationStatus(InvestmentAttestationStatus attestationStatus)

      The current status of the attestation. Valid values are PENDING_REVIEW, PENDING_C_LEVEL_APPROVAL, PENDING_CANCELLATION, REJECTED, CANCELLED, and DISBURSED. The values DISBURSED, REJECTED, and CANCELLED are terminal. The other values indicate the attestation is still in progress.

      Parameters:
      attestationStatus - The current status of the attestation. Valid values are PENDING_REVIEW, PENDING_C_LEVEL_APPROVAL, PENDING_CANCELLATION, REJECTED, CANCELLED, and DISBURSED. The values DISBURSED, REJECTED, and CANCELLED are terminal. The other values indicate the attestation is still in progress.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • investmentDisbursedAt

      InvestmentAttestation.Builder investmentDisbursedAt(Instant investmentDisbursedAt)

      The start date on which the investment is disbursed to the investment accounts. This is not the same as the time of disbursement, but reflects the date you submitted with the attestation.

      Parameters:
      investmentDisbursedAt - The start date on which the investment is disbursed to the investment accounts. This is not the same as the time of disbursement, but reflects the date you submitted with the attestation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attestedValue

      InvestmentAttestation.Builder attestedValue(Amount attestedValue)

      The monetary value attested.

      Parameters:
      attestedValue - The monetary value attested.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • attestedValue

      default InvestmentAttestation.Builder attestedValue(Consumer<Amount.Builder> attestedValue)

      The monetary value attested.

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

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

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

    • investmentDistributions

      InvestmentAttestation.Builder investmentDistributions(Collection<InvestmentDistribution> investmentDistributions)

      The distribution of the attested investment across the eligible investment accounts. The list contains at most 200 distributions.

      Parameters:
      investmentDistributions - The distribution of the attested investment across the eligible investment accounts. The list contains at most 200 distributions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • investmentDistributions

      InvestmentAttestation.Builder investmentDistributions(InvestmentDistribution... investmentDistributions)

      The distribution of the attested investment across the eligible investment accounts. The list contains at most 200 distributions.

      Parameters:
      investmentDistributions - The distribution of the attested investment across the eligible investment accounts. The list contains at most 200 distributions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • investmentDistributions

      InvestmentAttestation.Builder investmentDistributions(Consumer<InvestmentDistribution.Builder>... investmentDistributions)

      The distribution of the attested investment across the eligible investment accounts. The list contains at most 200 distributions.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to investmentDistributions(List<InvestmentDistribution>).

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

    • rejectionReasons

      InvestmentAttestation.Builder rejectionReasons(Collection<String> rejectionReasons)

      The reasons the attestation was rejected. This value is present only when attestationStatus is REJECTED. The list contains at most 30 reasons.

      Parameters:
      rejectionReasons - The reasons the attestation was rejected. This value is present only when attestationStatus is REJECTED. The list contains at most 30 reasons.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • rejectionReasons

      InvestmentAttestation.Builder rejectionReasons(String... rejectionReasons)

      The reasons the attestation was rejected. This value is present only when attestationStatus is REJECTED. The list contains at most 30 reasons.

      Parameters:
      rejectionReasons - The reasons the attestation was rejected. This value is present only when attestationStatus is REJECTED. The list contains at most 30 reasons.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • isCancellable

      InvestmentAttestation.Builder isCancellable(Boolean isCancellable)

      Indicates whether the attestation can be canceled with CancelContractualInvestmentAttestation.

      Parameters:
      isCancellable - Indicates whether the attestation can be canceled with CancelContractualInvestmentAttestation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.