Package com.merge.api.resources.crm.opportunities.requests

Class OpportunitiesListRequest

  • public final class OpportunitiesListRequest
extends java.lang.Object

    • Method Detail

      • getAccountId

        public java.util.Optional<java.lang.String> getAccountId()
        Returns:
        If provided, will only return opportunities with this account.

      • getCreatedAfter

        public java.util.Optional<java.time.OffsetDateTime> getCreatedAfter()
        Returns:
        If provided, will only return objects created after this datetime.

      • getCreatedBefore

        public java.util.Optional<java.time.OffsetDateTime> getCreatedBefore()
        Returns:
        If provided, will only return objects created before this datetime.

      • getCursor

        public java.util.Optional<java.lang.String> getCursor()
        Returns:
        The pagination cursor value.

      • getExpand

        public java.util.Optional<OpportunitiesListRequestExpand> getExpand()
        Returns:
        Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.

      • getIncludeDeletedData

        public java.util.Optional<java.lang.Boolean> getIncludeDeletedData()
        Returns:
        Indicates whether or not this object has been deleted in the third party platform. Full coverage deletion detection is a premium add-on. Native deletion detection is offered for free with limited coverage. Learn more.

      • getIncludeRemoteData

        public java.util.Optional<java.lang.Boolean> getIncludeRemoteData()
        Returns:
        Whether to include the original data Merge fetched from the third-party to produce these models.

      • getIncludeRemoteFields

        public java.util.Optional<java.lang.Boolean> getIncludeRemoteFields()
        Returns:
        Whether to include all remote fields, including fields that Merge did not map to common models, in a normalized format.

      • getIncludeShellData

        public java.util.Optional<java.lang.Boolean> getIncludeShellData()
        Returns:
        Whether to include shell records. Shell records are empty records (they may contain some metadata but all other fields are null).

      • getModifiedAfter

        public java.util.Optional<java.time.OffsetDateTime> getModifiedAfter()
        Returns:
        If provided, only objects synced by Merge after this date time will be returned.

      • getModifiedBefore

        public java.util.Optional<java.time.OffsetDateTime> getModifiedBefore()
        Returns:
        If provided, only objects synced by Merge before this date time will be returned.

      • getOwnerId

        public java.util.Optional<java.lang.String> getOwnerId()
        Returns:
        If provided, will only return opportunities with this owner.

      • getPageSize

        public java.util.Optional<java.lang.Integer> getPageSize()
        Returns:
        Number of results to return per page.

      • getRemoteCreatedAfter

        public java.util.Optional<java.time.OffsetDateTime> getRemoteCreatedAfter()
        Returns:
        If provided, will only return opportunities created in the third party platform after this datetime.

      • getRemoteFields

        public java.util.Optional<java.lang.String> getRemoteFields()
        Returns:
        Deprecated. Use show_enum_origins.

      • getRemoteId

        public java.util.Optional<java.lang.String> getRemoteId()
        Returns:
        The API provider's ID for the given object.

      • getShowEnumOrigins

        public java.util.Optional<java.lang.String> getShowEnumOrigins()
        Returns:
        A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. Learn more

      • getStageId

        public java.util.Optional<java.lang.String> getStageId()
        Returns:
        If provided, will only return opportunities with this stage.

      • getStatus

        public java.util.Optional<OpportunitiesListRequestStatus> getStatus()
        Returns:
        If provided, will only return opportunities with this status. Options: ('OPEN', 'WON', 'LOST')
        • OPEN - OPEN
        • WON - WON
        • LOST - LOST

      • equals

        public boolean equals​(java.lang.Object other)
        Overrides:
        equals in class java.lang.Object

      • getAdditionalProperties

        public java.util.Map<java.lang.String,​java.lang.Object> getAdditionalProperties()

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class java.lang.Object

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object