Parameters

public struct Parameters : Sendable

Groups the supported query parameters for a generated Request.

  • Fields to return for included related types.

    Declaration

    Swift

    public let fields: [FieldParameter]?

  • Attributes, relationships, and IDs by which to filter

    Declaration

    Swift

    public let filters: [FilterParameter]?

  • Attributes, relationships, and IDs to check for existence

    Declaration

    Swift

    public let exists: [ExistParameter]?

  • Relationship data to include in the response

    Declaration

    Swift

    public let includes: [IncludeParameter]?

  • Attributes by which to sort

    Declaration

    Swift

    public let sorts: [SortParameter]?

  • Number of resources to return

    Declaration

    Swift

    public let limits: [LimitParameter]?

  • Number of resources to return

    Declaration

    Swift

    public let limit: Int?

  • Custom query items used by endpoints whose parameter names are not covered by the standard helpers.

    Declaration

    Swift

    public let customs: [String : String]?

  • Creates a parameter container for a generated endpoint helper.

    Declaration

    Swift

    public init(fields: [FieldParameter]? = nil,
            filters: [FilterParameter]? = nil,
            exists: [ExistParameter]? = nil,
            includes: [IncludeParameter]? = nil,
            sorts: [SortParameter]? = nil,
            limits: [LimitParameter]? = nil,
            limit: Int? = nil,
            customs: [String: String]? = nil)

    Parameters

    fields

    Fields to return for included related types.
    filters

    Attributes, relationships, and IDs by which to filter
    exists

    Attributes, relationships, and IDs to check for existence
    includes

    Relationship data to include in the response
    sorts

    Attributes by which to sort
    limits

    Number of resources to return
    limit

    Number of resources to return
    customs

    Custom query items to append directly to the request URL.