MonthServiceType

public protocol MonthServiceType : Sendable

Provides access to month operations

  • months(planId:lastKnowledgeOfServer:) Default implementation, asynchronous

    Returns a list of plan months.

    Default Implementation

    Returns a list of plan months, with optional parameters defaulted.

    Declaration

    Swift

    func months(
        planId: String,
        lastKnowledgeOfServer: ServerKnowledge?
    ) async throws -> MonthsResponse

    Parameters

    planId

    The id of the plan (last_used can also be used to specify the last used plan)

    lastKnowledgeOfServer

    If provided, only entities that have changed since lastKnowledgeOfServer will be included.

    Return Value

    A list of months and the knowledge of the server

  • month(planId:month:) Asynchronous

    Returns a specific month for a plan.

    Declaration

    Swift

    func month(planId: String, month: String) async throws -> MonthDetail

    Parameters

    planId

    The id of the plan (last_used can also be used to specify the last used plan)

    month

    The plan month in ISO format (e.g. 2016-12-01) (current can also be used to specify the current calendar month (UTC))

    Return Value

    A single month