MonthService

public struct MonthService

Provides access to month operations

  • Returns a list of plan months.

    Declaration

    Swift

    public func months(
    planId: String,
    lastKnowledgeOfServer: ServerKnowledge?
) async throws -> ([MonthSummary], ServerKnowledge)

    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 last knowledge of the server

  • month(planId:month:) Asynchronous

    Returns a specific month for a plan.

    Declaration

    Swift

    public 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