PBCycle

No description

type PBCycle {
actualValues: PBCycleDefaultValues!
budget: Int
budgetAsMoney: Money
createdAt: ISO8601DateTime!
creator: Party
currency: Currency
currentPhase: Phase!
currentRoles: [Role!]
defaultValues: PBCycleDefaultValues!
description: String
disabled: Boolean!
endDate: ISO8601Date
id: ID!
image: String
joinCodes: [PBCycleJoinCode!]
maxBallotProposals: Int!
maxDuration: Int!
maxProposals: Int!
maxSeats: Int!
participants: [Party!]
participantsCount: Int
pbCycleType: PBCycleType!
perSeatPrice: Int!
phases: [Phase!]!
price: Int!
proposals(filters: ProposalsFiltersInput): [Proposal!]
ready: Boolean!
remainingDaysLeft: Int
seatsAvailable: Int!
startDate: ISO8601Date!
theme: String
totalDays: Int
updatedAt: ISO8601DateTime!
}

Fields#

actualValues (PBCycleDefaultValues!)#

Default values for PB Cycle.

budget (Int)#

DEPRECATED Deprecated in favor of `budgetAsMoney`. Use the new field to retrieve the value.

The total budget available to implement in this Pb Cycle.

budgetAsMoney (Money)#

The total budget available to implement in this Pb Cycle.

createdAt (ISO8601DateTime!)#

Retrieves the PB Cycle creation date

creator (Party)#

The party who created the PB Cycle. This field have two possible returns depending on the context and the object data:

  • Return the PartyType when PB Cycle contains a creator value and the requesting user is authenticated and is a member of the PB Cycle.

  • Return null when PB Cycle does not contains a creator value and the requesting user is unauthenticated or is not a member of the PB Cycle.

currency (Currency)#

The currency assigned to PB Cycle that will be used for all monetary values, including proposals cost.

currentPhase (Phase!)#

Retrieves the PB Cycle current phase.

currentRoles ([Role!])#

Retrieves the assigned roles for current user in the PB Cycle.

defaultValues (PBCycleDefaultValues!)#

Default values for PB Cycle.

description (String)#

The PB Cycle full description.

disabled (Boolean!)#

Indicates if the PB Cycle has been disabled by admin. When a PB Cycle is disabled users can not perform actions on it anymore.

endDate (ISO8601Date)#

The PB Cycle end date which corresponds to the last phase end date. Notice this value can be null if the last phase end date has been stablished as null.

id (ID!)#

The PB Cycle identifier

image (String)#

PB Cycle image or logo

joinCodes ([PBCycleJoinCode!])#

All the join codes of the PB Cycle that still haven't expired yet.

maxBallotProposals (Int!)#

The maximum number of proposals that can be added to a PB Cycle ballot. Proposals added to the ballot will be available to be voted by participants.

maxDuration (Int!)#

The total number of days this PB Cycle can be active before to raise the do phase.

maxProposals (Int!)#

The maximum number of proposals that can be created for PB Cycles.

maxSeats (Int!)#

The maximum number of allowed seats that can be occupied by parties in the PB Cycle.

participants ([Party!])#

The PB Cycle participants information.

participantsCount (Int)#

The total number of participants in the PB Cycle.

pbCycleType (PBCycleType!)#

The PB Cycle type for this PB Cycle.

perSeatPrice (Int!)#

The price that PB admin must pay to add new seats to the PB Cycle.

phases ([Phase!]!)#

Retrieves all PB Cycle phases.

price (Int!)#

The price user payed to create this PB Cycle.

proposals ([Proposal!])#

Return all proposals created for this PB Cycle.

Allow to pass filtering arguments.

ready (Boolean!)#

Indicates if a PB Cycle has every base value needed to be ready.

remainingDaysLeft (Int)#

DEPRECATED This field can be removed in the future because we are not considering only _days_ for duration.

seatsAvailable (Int!)#

Number of seats available to be occupied by participants.

startDate (ISO8601Date!)#

The PB Cycle start date. This value is taken directly from the start date of the first phase.

theme (String)#

The PB cycle theme. It can be taken also as the title of the PB Cycle.

totalDays (Int)#

DEPRECATED This field can be removed in the future because we are not considering only _days_ for duration.

updatedAt (ISO8601DateTime!)#