AccountsQuery

public struct AccountsQuery : Sendable

Accounts request model.

  • External id for list entity.

    Declaration

    Swift

    public let externalId: String?

  • Email address for list entity.

    Declaration

    Swift

    public let emailAddress: String?

  • Phone number for list entity.

    Declaration

    Swift

    public let phoneNumber: String?

  • Start date for list entity.

    Declaration

    Swift

    public let startDate: String?

  • End date for list entity.

    Declaration

    Swift

    public let endDate: String?

  • The number of items per page.

    Declaration

    Swift

    public var limit: Int?

  • Start after offset amount of items.

    Declaration

    Swift

    public var offset: Int?

  • The UUID of parent account.

    Declaration

    Swift

    public let parentAccountUuid: String?

  • The account stage.

    Declaration

    Swift

    public let stage: AccountStage?

  • The account status.

    Declaration

    Swift

    public let status: AccountStatus?

  • The account type.

    Declaration

    Swift

    public let type: AccountType?

  • Incentives query model constructor.

    Declaration

    Swift

    public init(
    externalId: String? = nil,
    emailAddress: String? = nil,
    phoneNumber: String? = nil,
    startDate: String? = nil,
    endDate: String? = nil,
    limit: Int? = nil,
    offset: Int? = nil,
    parentAccountUuid: String? = nil,
    stage: AccountStage? = nil,
    status: AccountStatus? = nil,
    type: AccountType? = nil
)

    Parameters

    externalId

    External id for list entity.
    emailAddress

    Email address for list entity.
    phoneNumber

    Phone number for list entity.
    startDate

    Start date for list entity.
    endDate

    End date for list entity.
    limit

    The number of items per page.
    offset

    Start after offset amount of items.
    parentAccountUuid

    The UUID of parent account.
    stage

    The account stage.
    status

    The account status.
    type

    The account type.