Class CreateEngagementInvitationRequest

    • Method Detail

      • catalog

        public final String catalog()

        Specifies the catalog related to the engagement. Accepted values are AWS and Sandbox, which determine the environment in which the engagement is managed.

        Returns:
        Specifies the catalog related to the engagement. Accepted values are AWS and Sandbox, which determine the environment in which the engagement is managed.
      • clientToken

        public final String clientToken()

        Specifies a unique, client-generated UUID to ensure that the request is handled exactly once. This token helps prevent duplicate invitation creations.

        Returns:
        Specifies a unique, client-generated UUID to ensure that the request is handled exactly once. This token helps prevent duplicate invitation creations.
      • engagementIdentifier

        public final String engagementIdentifier()

        The unique identifier of the Engagement associated with the invitation. This parameter ensures the invitation is created within the correct Engagement context.

        Returns:
        The unique identifier of the Engagement associated with the invitation. This parameter ensures the invitation is created within the correct Engagement context.
      • invitation

        public final Invitation invitation()

        The Invitation object all information necessary to initiate an engagement invitation to a partner. It contains a personalized message from the sender, the invitation's receiver, and a payload. The Payload can be the OpportunityInvitation, which includes detailed structures for sender contacts, partner responsibilities, customer information, and project details.

        Returns:
        The Invitation object all information necessary to initiate an engagement invitation to a partner. It contains a personalized message from the sender, the invitation's receiver, and a payload. The Payload can be the OpportunityInvitation, which includes detailed structures for sender contacts, partner responsibilities, customer information, and project details.
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object